Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Fulfillment Cancellations

Creates a cancellation

Cancels all or part of a previously created fulfillment order.

post/fulfillment-cancellations

Request body

fulfillmentOrderIdstring required

The unique identifier of the fulfillment order associated with the fulfillment cancellation.

upstreamIdstring

The unique identifier of the upstream order.

reasonstring

The reason for the cancellation.

Example request

{
  "fulfillmentOrderId": "6645940010",
  "upstreamId": "6645940010",
  "reason": "requested_by_customer",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "fulfillmentOrderItemUpstreamId": "99341140336",
      "quantity": 1
    }
  ]
}

Response

201 Created

idstring

The unique identifier of the fulfillment cancellation

createdTimestring date-time

The time at which the fulfillment cancellation was created.

fulfillmentOrderIdstring

The unique identifier of the fulfillment order associated with the fulfillment cancellation.

upstreamIdstring

The unique identifier of the upstream order.

reasonstring

The reason for the cancellation.

state'pending' | 'accepted' | 'rejected'

An enumeration indicating the state of the fulfillment cancellation.

livemodeboolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example response

{
  "id": "ret_5823594809",
  "createdTime": "2018-04-25T20:36:00Z",
  "fulfillmentOrderId": "ord_6645940010",
  "upstreamId": "ord_6645940010",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "fulfillmentOrderItemUpstreamId": "99341140336",
      "inventoryItemId": "5823594809",
      "quantity": 1,
      "quantityAccepted": 1,
      "state": "accepted"
    }
  ],
  "reason": "requested_by_customer",
  "state": "pending"
}