Marketplace Platform

Fail Order

PreviousComplete Order NextDelete Order

About SoftwareOne

Codes of Conduct

Privacy Statement

Terms & Conditions

SoftwareOne is a trademark of SoftwareOne, Inc. "The Software Licensing Experts" is a service mark of SoftwareOne, Inc. VAR assist is a trademark of SoftwareOne, Inc. "It pays to partner" is a service mark of SoftwareOne, Incorporated.

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

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

Success

Body

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

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

{
  "id": "text",
  "href": "text",
  "notes": "text",
  "lines": [],
  "subscriptions": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "startDate": "2024-12-21T11:56:00.851Z",
      "terminationDate": "2024-12-21T11:56:00.851Z",
      "autoRenew": false,
      "commitmentDate": "2024-12-21T11:56:00.851Z",
      "lines": []
    }
  ],
  "termsAndConditions": []
}