Cancellations
A Cancellation (or 'cancels' for short) represents a request to cancel all or part of a purchase order.
Relationships
- Order • Cancellations belong to Orders.
- Cancel Lines • Cancellations can have many Cancel Lines.
Operations
Click on an Operation to view requirements, options, & examples.
| POST | /v1/brands/{brand_id}/cancels/ | Create a new Cancellation |
|---|---|---|
| GET | /v1/brands/{brand_id}/cancels/ | Get a list of Cancellations |
| GET | /v1/brands/{brand_id}/cancels/{id}/ | Get a single Cancellation |
| PUT | /v1/brands/{brand_id}/cancels/{id}/acknowledge/ | Acknowledge receipt |
Cancellation Properties
| id | A static id assigned by RevCascade. Can be used as the primary key in the url of other Cancel endpoints. |
|---|---|
| order_id |
The RevCascade Order Id to which the cancellation applies. |
| reason |
The reason why all (or part) of the order is being canceled. Examples:
|
| canceled_at |
The timestamp when the cancellation was received by RevCascade. |
| cancel_lines |
An array or Cancellation Line Items. {
"id": "10000",
"variant": {
"id": "100084",
"brand": {
"id": "501",
"name": "Marla Cielo",
},
"name": "Contemporary Nightstand",
"description": "Black"
"identifier": "1234",
"upc": "123456789456",
"attributes": [{
// subset of attributes omitted for brevity
}]
},
"quantity": 1,
}
id - RevCascade's static identifier for the Order Line. variant - The exact item that is being canceled. quantity - The number of items being canceled. |
Examples
| POST | /v1/brands/{brand_id}/cancels/ | Create a new Cancellation |
|---|
| Input Parameters - All fields required unless otherwise marked. | |
| order_id | The RevCascade order_id. |
|---|---|
| reason_id |
The id of the reason why all (or part) of the order is being canceled.
|
| cancel_lines |
An array of objects representing the items that are in the cancellation request. Please send one Cancel Line per unique item. "cancel_lines": [{
"variant": {
"id": 1000065,
"identifier": "GBD34315",
"upc": "123456789012",
}
"quantity": 1
}]
variant - an object that identifies the exact item that sold.
quantity - The number of items to be canceled. Please note... Either an 'id', 'identifier', or a 'upc' is required in the variant object when creating an order line. However, if multiple are passed, 'id' will take priority over 'identifier' and 'upc'. |
| GET | /v1/brands/cancels/ | Get a list of Cancellations |
|---|
| Optional Query String Parameters | |
| is_acknowledged |
Boolean filter that returns orders based on whether or not they have been acknowleged.
1 - show only only cancellations that have been acknowledged. 0 - show cancellations that have not been acknowledged. |
|---|---|
| canceled_at_{operator} |
Filter cancellations received by RevCascade before or after an epoch timestamp in UTC.
Please substitute {operator} with "lt" (less than),"lte" (less than or equal), "gt" (greater than), or "gte" (greater than or equal). |
| limit | Customize the number of results return (max 250). Requests that return more records than the limit will be paginated. |
|
Get all new cancellations that have been not yet been acknowledged. GET https://api.revcascade.com/v1/brands/500/cancels/?is_acknowledged=1 |
|
| GET | /v1/brands/{brand_id}/cancels/{id}/ | Get a single Cancellation. |
|---|
|
Get a single cancellation by its ID. GET https://api.revcascade.com/v1/brands/500/cancels/123645/ |
| PUT | /v1/brands/{brand_id}/cancels/{id}/acknowledge/ | Acknowledge receipt |
|---|
|
Acknowledge receipt of a new cancellation. GET https://api.revcascade.com/v1/brands/500/cancels/123645/acknowledge/ |
