Get Order Cancellations

Get Order Cancellations

get

Retrieves all cancellation records associated with an order. Returns an OrderCancellation object containing the overall cancellation status and individual bag cancellation records, including any associated refunds and error details. Returns HTTP 204 No Content if no cancellations exist for the order.

Path parameters

order_idinteger · int64Required

ID of the order to retrieve cancellation records for

Example: 11111

Header parameters

X-Violet-TokenstringRequired

API token for authentication

X-Violet-App-SecretstringRequired

Application secret key

X-Violet-App-Idinteger · int32Required

Application ID

Example: 10000

Responses

200

success

application/json

Cancellation record for an order.

order_idinteger · int64Read-onlyOptional

The ID of the order this cancellation relates to.

app_idinteger · int32Read-onlyOptional

The ID of the app that originated this order.

statusstring · enumRead-onlyOptional

Status of the overall cancellation.

Possible values:

messagestringRead-onlyOptional

Description of the outcome of the order cancellation request.

204

no content

application/json

404

not found

application/json

500

internal server error

application/json

get

/orders/{order_id}/cancellations

HTTPcURLJavaScriptPython

GET /v1/orders/{order_id}/cancellations HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Accept: */*

{
  "order_id": 10000,
  "app_id": 10000,
  "status": "CANCELED",
  "cancelled_bags": [
    {
      "order_id": 10000,
      "bag_id": 11111,
      "merchant_id": 22222,
      "external_order_id": "7438192837181",
      "status": "CANCELED",
      "originated_by": "VIOLET",
      "date_cancelled": "2024-10-24T14:00:39.000+00:00",
      "refund": {
        "id": 99999,
        "order_id": 10000,
        "bag_id": 11111,
        "merchant_id": 22222,
        "app_id": 10000,
        "transaction_id": 44444,
        "amount": 9900,
        "reason": "Order canceled",
        "refund_currency": "USD",
        "status": "COMPLETED",
        "skus": [
          {
            "id": 55555,
            "bag_id": 11111,
            "quantity_refunded": 1,
            "external_id": "41818918453315",
            "order_sku_id": 8014657
          },
          {
            "id": 55556,
            "bag_id": 77777,
            "quantity_refunded": 1,
            "external_id": "41832890171459",
            "order_sku_id": 77777
          }
        ],
        "date_created": "2024-10-24T14:00:35+0000",
        "date_last_modified": "2024-10-24T14:00:35+0000",
        "external_id": "943916482627",
        "errors": []
      }
    }
  ],
  "message": "All external orders were cancelled."
}