List Orders

Lists all orders that the user has access to.

get
Responses
200
OK
application/json
get
GET /public/v1/commerce/orders HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]",
        "completed": "[Circular Reference]",
        "deleted": "[Circular Reference]",
        "failed": "[Circular Reference]",
        "processing": "[Circular Reference]",
        "querying": "[Circular Reference]",
        "quoted": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "type": "Purchase",
      "status": "New",
      "notes": "text",
      "comments": "text",
      "statusNotes": {
        "id": "text",
        "message": "text",
        "parameters": null
      },
      "template": {
        "id": "text",
        "name": "text"
      },
      "listing": {
        "id": "text"
      },
      "authorization": {
        "id": "text",
        "name": "text",
        "currency": "text"
      },
      "agreement": {
        "id": "text",
        "icon": "text",
        "status": "New",
        "name": "text"
      },
      "assignee": {
        "id": "text",
        "name": "text",
        "icon": "text"
      },
      "externalIds": {
        "client": "text",
        "operations": "text",
        "vendor": "text"
      },
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "defaultMarkup": 1,
        "PPx1": 1,
        "SPx1": 1,
        "SPxY": 1,
        "SPxM": 1,
        "PPxY": 1,
        "PPxM": 1
      },
      "lines": [
        {
          "id": "text",
          "oldQuantity": 1,
          "quantity": 1,
          "price": {
            "currency": "text",
            "markup": 1,
            "margin": 1,
            "unitSP": 1,
            "unitPP": 1,
            "PPx1": 1,
            "SPx1": 1,
            "SPxY": 1,
            "SPxM": 1,
            "PPxY": 1,
            "PPxM": 1
          },
          "item": "[Circular Reference]",
          "subscription": "[Circular Reference]"
        }
      ],
      "subscriptions": [
        {
          "id": "text",
          "audit": "[Circular Reference]",
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "startDate": "2025-07-03T00:28:59.416Z",
          "terminationDate": "2025-07-03T00:28:59.416Z",
          "externalIds": {
            "client": "text",
            "operations": "text",
            "vendor": "text"
          },
          "terms": {
            "period": "1m",
            "commitment": "1m"
          },
          "product": {
            "id": "text",
            "name": "text",
            "externalIds": {
              "operations": "text"
            },
            "icon": "text",
            "status": "text"
          },
          "autoRenew": true,
          "status": "Draft",
          "commitmentDate": "2025-07-03T00:28:59.416Z",
          "parameters": {
            "fulfillment": [
              {
                "id": "text",
                "externalId": "text",
                "name": "text",
                "type": "SingleLineText",
                "phase": "Configuration",
                "error": {
                  "id": "text",
                  "message": "text",
                  "parameters": null
                },
                "constraints": {
                  "required": true,
                  "hidden": true,
                  "readonly": true
                },
                "displayValue": "text",
                "value": null
              }
            ]
          },
          "agreement": {
            "id": "text",
            "icon": "text",
            "status": "New",
            "name": "text"
          },
          "price": {
            "currency": "text",
            "markup": 1,
            "margin": 1,
            "SPxY": 1,
            "SPxM": 1,
            "PPxY": 1,
            "PPxM": 1,
            "defaultMarkup": 1,
            "defaultMargin": 1
          },
          "lines": [
            "[Circular Reference]"
          ],
          "template": {
            "id": "text",
            "name": "text"
          }
        }
      ],
      "parameters": {
        "ordering": [
          {
            "id": "text",
            "externalId": "text",
            "name": "text",
            "type": "SingleLineText",
            "phase": "Configuration",
            "error": {
              "id": "text",
              "message": "text",
              "parameters": null
            },
            "constraints": {
              "required": true,
              "hidden": true,
              "readonly": true
            },
            "displayValue": "text",
            "value": null
          }
        ],
        "fulfillment": [
          {
            "id": "text",
            "externalId": "text",
            "name": "text",
            "type": "SingleLineText",
            "phase": "Configuration",
            "error": {
              "id": "text",
              "message": "text",
              "parameters": null
            },
            "constraints": {
              "required": true,
              "hidden": true,
              "readonly": true
            },
            "displayValue": "text",
            "value": null
          }
        ]
      },
      "error": {
        "id": "text",
        "message": "text",
        "parameters": null
      },
      "product": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "operations": "text"
        },
        "icon": "text",
        "status": "text"
      },
      "client": {
        "id": "text",
        "icon": "text",
        "type": "Client",
        "status": "Active",
        "name": "text"
      },
      "licensee": {
        "id": "text",
        "icon": "text",
        "name": "text",
        "externalId": "text"
      },
      "buyer": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "seller": {
        "id": "text",
        "icon": "text",
        "externalId": "text",
        "name": "text",
        "erpLink": "[Circular Reference]"
      },
      "vendor": {
        "id": "text",
        "icon": "text",
        "type": "Client",
        "status": "Active",
        "name": "text"
      },
      "billTo": {
        "id": "text",
        "icon": "text",
        "name": "text"
      },
      "pricingPolicy": {
        "id": "text",
        "name": "text",
        "client": "[Circular Reference]",
        "products": [
          "[Circular Reference]"
        ]
      },
      "termsAndConditions": [
        {
          "id": "text",
          "audit": "[Circular Reference]",
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "description": "text",
          "displayOrder": 1,
          "status": "text",
          "product": {
            "id": "text",
            "name": "text",
            "externalIds": {
              "operations": "text"
            },
            "icon": "text",
            "status": "text"
          },
          "accepted": "2025-07-03T00:28:59.416Z",
          "acceptedBy": {
            "id": "text",
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "name": "text",
            "firstName": "text",
            "lastName": "text",
            "email": "text",
            "icon": "text"
          }
        }
      ],
      "certificates": [
        {
          "id": "text",
          "name": "text"
        }
      ]
    }
  ]
}

Last updated

Was this helpful?