Update Order

Updates order. Not every property can be updated. For example it's impossible to change state of the order, or assign it to another agreement.

PUThttps://api.platform.softwareone.com/public/v1/commerce/orders/{id}

Path parameters

id*string

Id of order to update

Body

application/jsontext/jsonapplication/*+json

Update details of order

idstring

auditobject

$metaobject

hrefstring

typeobject

statusobject

notesnullable string

statusNotesobject

templateobject

listingobject

authorizationobject

agreementobject

assigneeobject

externalIdsobject

priceobject

linesarray

subscriptionsarray of OrderSubscription (object)

parametersobject

errorobject

productobject

clientobject

licenseeobject

buyerobject

sellerobject

vendorobject

termsAndConditionsarray

Response

200403404500

Success

Body

application/json

idstring

auditobject

$metaobject

hrefstring

typeobject

statusobject

notesnullable string

statusNotesobject

templateobject

listingobject

authorizationobject

agreementobject

assigneeobject

externalIdsobject

priceobject

linesarray

subscriptionsarray of OrderSubscription (object)

parametersobject

errorobject

productobject

clientobject

licenseeobject

buyerobject

sellerobject

vendorobject

termsAndConditionsarray

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.platform.softwareone.com/public/v1/commerce/orders/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200403404

{
  "id": "text",
  "href": "text",
  "notes": "text",
  "lines": [],
  "subscriptions": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "startDate": "2025-01-23T20:46:16.557Z",
      "terminationDate": "2025-01-23T20:46:16.557Z",
      "autoRenew": false,
      "commitmentDate": "2025-01-23T20:46:16.557Z",
      "lines": []
    }
  ],
  "termsAndConditions": []
}