Overview
Login
- Access
Merchants
- Merchant
- Configuration
- Explore
Catalog
- Offers
- SKUs
- Categories
- Collections
- Currencies
Orders & Checkout
- Carts
- Cart Items
- Cart Customer
- Cart Discounts
- Cart Shipping
- Cart Pricing
- Cart Payment
- Cart Completion
- Orders
- Order Refunds
- Order Cancellations
- Transfers
Events
- Webhooks
- Webhook Events
- Wekbhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
- Connection
Relay
- Shipping
Ecom Syncs
- Offers
Get Order Cancellations
curl --request GET \
--url https://sandbox-api.violet.io/v1/orders/{order_id}/cancellations{
"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.000Z",
"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."
}Path Parameters
Response
Cancellation record for an order.
The ID of the order this cancellation relates to.
The ID of the app that originated this order.
Status of the overall cancellation.
CANCELED, PARTIALLY_CANCELED, CANCELLATION_FAILURE Bags within the order that were cancelled.
The ID of the order this cancellation relates to.
The ID of the bag this cancellation relates to.
The ID of the merchant this cancellation relates to.
The ID of the order in the external commerce platform this cancellation relates to.
1 - 64Status of the bag cancellation.
CANCELED, CANCELLATION_FAILURE Who is responsible for cancelling the order.
CHANNEL, MERCHANT, VIOLET Date and time that the order was cancelled.
Order Refund
ID of the Order being refunded
ID of the merchant making the refund
ID of the App that created the Order
ID of the Transaction being refunded
ID of the Transaction in the Payment Gateway
Amount being refunded. In Cents
ID of the Bag being refunded
Amount being taken back from the associated transfer to the merchant. In Cents
Amount being taken back from the associated transfer to the developer. In Cents
Amount in fractional currency unit (e.g. cents) being taken back from the associated transfer to the merchant, in platform currency.
Amount in fractional currency unit (e.g. cents) being taken back from the associated transfer to the developer, in platform currency.
Reason for refund
Reason code for refund
OTHER, CUSTOMER, INVENTORY, FRAUD, DECLINED Currency set for this refund by the external ecom platform
Currency used by the platform account for the payment provider that processed this Refund
Status of the Refund
PROCESSING, COMPLETED, CANCELED, PARTIALLY_COMPLETED, FAILED, EXTERNAL SKUs the refund applies to
Id of the Refund associated with Refund Order Sku
Id of the Order Sku associated with Refund Order Sku
ID of the Bag being refunded
Quantity of the this item refunded by this refund.
Variant Id in external Ecom platform
Date of creation
Date of last update
ID of the refund on the external commerce platform. This value will only be populated if the external commerce platform supports refund ID's.
List of errors associated to this refund during processing. This value will only be populated if there are errors during processing
Error message describing the issue in the underlying system.
ID of the Refund this Error is associated to
Unique identifier for the object.
Unique error code corresponding to this error.
Indicates whether the error has been resolved. Defaults to false.
Time at which this error was resolved. In ISO-8601 format. By default, this value is null and only applies to
Time at which the object was created. In ISO-8601 format.
Details of any refunded shipping amounts.
Shipping amount, inclusive of any taxes, that was refunded in cents. If no value is provided the full shipping amount will be refunded.
x > 0Tax amount that was refunded in cents.
x > 0Is the shipping refund a full refund of the total shipping amount.
An optional reason for any discrepancies in the shipping amount that was refunded.
Tax amount being refunded. In Cents.
x > 0Errors, if any, that occurred when attempting to cancel the external order.
Unique ID of the error.
ID of the parent Order this error occurred in.
ID of the parent Bag this error occurred in.
ID of the entity that caused the error. See the entity_type property to determine which entity this ID is associated with.
Type of entity that caused the error. See the entity_id property to determine which entity of this type is related to the error.
ORDER, BAG, SKU Type of error, indicates which action was being taken when the error occurred.
EXTERNAL_CREATE_CART, EXTERNAL_ADD_ITEM, EXTERNAL_UPDATE_ITEM, EXTERNAL_REMOVE_ITEM, EXTERNAL_ADD_CUSTOMER, EXTERNAL_ADD_ADDRESSES, EXTERNAL_ADD_SHIPPING_ADDRESS, EXTERNAL_ADD_BILLING_ADDRESS, EXTERNAL_GET_SHIPPING_METHODS, EXTERNAL_SET_SHIPPING_METHOD, EXTERNAL_SET_PAYMENT_METHOD, EXTERNAL_PRICE_CART, EXTERNAL_SUBMIT_CART, INTERNAL_ADD_ITEM, EXTERNAL_DELETE_CART, EXTERNAL_CANCEL_ORDER, EXTERNAL_WRITE_ORDER, EXTERNAL_MARK_ORDER_AS_PAID, EXTERNAL_ADD_DISCOUNT_CODE, EXTERNAL_REMOVE_DISCOUNT_CODE, EXTERNAL_DELETE_ORDER, EXTERNAL_REFUND_ORDER A string message providing more details about the error.
255Date the error was first created in Violet.
The external commerce platform the error occurred in.
OTHER, SHOPIFY, MAGENTO, MAGENTO_ONE, WOOCOMMERCE, BIGCOMMERCE, LIGHTSPEED, ECWID, YAAS, SPREECOMMERCE, DEMANDWARE, VOLUSION, PRESTASHOP, THREEDCART, SYLIUS, WIX, SWELL, MIVA, WEBSPHERE, ORACLECC, SAPCC, SQUARESPACE, SHOPWARE, COMMERCETOOLS, MEDUSA, ABICART, SPRYKER, MYSTORE, CENTRA, XCART, VTEX, KIBO, SALEOR, VENDO, CHORD, DIGITALRIVER, SQUARE, AMAZON, BIGCARTEL, CUSTOM Description of the outcome of the order cancellation request.
Was this page helpful?
curl --request GET \
--url https://sandbox-api.violet.io/v1/orders/{order_id}/cancellations{
"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.000Z",
"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."
}