Sign in
Batch

Update a batch of orders by internal ID, or unique property values

Update a batch of orders using their internal IDs or unique property values.

post/crm/objects/2026-03/orders/batch/update

Request body

Example request

{
  "inputs": [
    {
      "idProperty": "my_unique_property_name"
    }
  ]
}

Response

successful operation

completedAtstring date-time required

The timestamp when the batch processing was completed, in ISO 8601 format.

linksobject

An object containing relevant links related to the batch request.

requestedAtstring date-time

The timestamp when the batch request was initially made, in ISO 8601 format.

startedAtstring date-time required

The timestamp when the batch processing began, in ISO 8601 format.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"

Changes

Changed in 3 of the 14 revisions of this API.24

  • e0403341222c21See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dc2fdad57f7f2See the full diff
    • ○

      api operation id post-/crm/objects/2026-03/orders/batch/update_/crm/objects/2026-03/orders/batch/update removed and replaced with post-/crm/objects/2026-03/orders/batch/update

      api-operation-id-removed

    • ○

      added the success response with the status

      response-success-status-added

    This revision also has 129 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 62586336cea21See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 73 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 14 revisions, 1 has no diff computed and 2 have a changelog that could not be searched.