Skip to main content
PATCH
/
v1
/
orders
/
{orderId}
Update single order
curl --request PATCH \
  --url https://prod01.copilot.fabric.inc/data-subscription/v1/orders/{orderId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order": {
    "scheduledDate": "2019-01-01T00:00:00.000Z",
    "status": "SCHEDULED",
    "lineItems": [
      {
        "Item": {
          "quantity": 1,
          "weight": 10,
          "weightUnit": "lb"
        },
        "customAttributes": {
          "storeId": "60cb07fc20387b000821c5c3",
          "associateId": 1,
          "trackingUrl": "609436d21baded0008945b05"
        }
      }
    ]
  }
}
'
{
  "responseStatus": "OK",
  "message": "Request processed successfully",
  "data": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orderId
string
required

Order ID General object ID

Example:

"606f01f441b8fc0008529916"

Body

application/json

Details to update order

order
object

Order details to be updated

Response

Request processed successfully

Order details after updating order

responseStatus
string

Brief response status

Example:

"OK"

message
string

Full response message

Example:

"Request processed successfully"

data
object

Order details