Fail Order

Fails the order. Status changes to failed. State of the agreement doesn't change except the status.

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

Path parameters

id*string

Id of order to be failed

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

JavaScriptCurlPython

const response = await fetch('https://api.platform.softwareone.com/public/v1/commerce/orders/{id}/fail', {
    method: 'POST',
    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": "2024-11-15T01:55:48.186Z",
      "terminationDate": "2024-11-15T01:55:48.186Z",
      "autoRenew": false,
      "commitmentDate": "2024-11-15T01:55:48.186Z",
      "lines": []
    }
  ],
  "termsAndConditions": []
}