Query Order

Sets order status to querying, effectively returning it back to client for update.

post

Path parameters

idstringrequired

Id of order to be queried

Body

application/jsontext/jsonapplication/*+json

idstringoptional

auditobjectoptional

$metaobjectoptional

hrefstringread-onlyoptional

typeobjectoptional

statusobjectoptional

notesstring | nullableoptional

statusNotesobjectoptional

templateobjectoptional

listingobjectoptional

authorizationobjectoptional

agreementobjectoptional

assigneeobjectoptional

externalIdsobjectoptional

priceobjectoptional

linesany[]optional

subscriptionsobject[]optional

parametersobjectoptional

errorobjectoptional

productobjectoptional

clientobjectoptional

licenseeobjectoptional

buyerobjectoptional

sellerobjectoptional

vendorobjectoptional

termsAndConditionsany[]optional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.platform.softwareone.com/public/v1/commerce/orders/{id}/query' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "audit": {},
    "$meta": {},
    "type": {},
    "status": {},
    "notes": "text",
    "statusNotes": {},
    "template": {},
    "listing": {},
    "authorization": {},
    "agreement": {},
    "assignee": {},
    "externalIds": {},
    "price": {},
    "lines": [],
    "subscriptions": [
      {
        "id": "text",
        "audit": {},
        "$meta": {},
        "name": "text",
        "startDate": "2025-04-07T14:45:32.987Z",
        "terminationDate": "2025-04-07T14:45:32.987Z",
        "externalIds": {},
        "agreement": {},
        "terms": {},
        "product": {},
        "autoRenew": true,
        "status": {},
        "commitmentDate": "2025-04-07T14:45:32.987Z",
        "parameters": {},
        "price": {},
        "lines": []
      }
    ],
    "parameters": {},
    "error": {},
    "product": {},
    "client": {},
    "licensee": {},
    "buyer": {},
    "seller": {},
    "vendor": {},
    "termsAndConditions": []
  }'

application/jsontext/jsonapplication/*+json

200

403

404

500

200

{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "type": {},
  "status": {},
  "notes": "text",
  "statusNotes": {},
  "template": {},
  "listing": {},
  "authorization": {},
  "agreement": {},
  "assignee": {},
  "externalIds": {},
  "price": {},
  "lines": [],
  "subscriptions": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "name": "text",
      "startDate": "2025-04-07T14:45:32.987Z",
      "terminationDate": "2025-04-07T14:45:32.987Z",
      "externalIds": {},
      "agreement": {},
      "terms": {},
      "product": {},
      "autoRenew": true,
      "status": {},
      "commitmentDate": "2025-04-07T14:45:32.987Z",
      "parameters": {},
      "price": {},
      "lines": []
    }
  ],
  "parameters": {},
  "error": {},
  "product": {},
  "client": {},
  "licensee": {},
  "buyer": {},
  "seller": {},
  "vendor": {},
  "termsAndConditions": []
}

Success