Cancellations Overview

Cancellations can be done at any time by sending a POST request to our /api/order_cancelled endpoint. Cancellations are supported on both an order and line item basis. If the line_item array is omitted then the entire order will be cancelled, otherwise, only the specified product warranties will be affected. Once cancelled, the refund will be factored into the next invoice.

Cancelling a specific warranty

HTTP method: POST

Authentication: Private Bearer Token

Staging Endpoint: https://partner-staging.getmulberry.com/api/order_cancelled

Production Endpoint: https://partner.getmulberry.com/api/order_cancelled

{
  "cancelled_date": "2018-09-04",
  "order_id": "7689dde5c0f64fffa7ad217432f6f73",
  "line_items": [{
      "product_id": "123456"
  }]
}

Parameter	Definition	Required	Type
cancelled_date	Date of the cancellation	yes	`date`
order_id	Unique order ID from your ecommerce platform	yes	`string`
line_items	List of `product_id` to cancel the warranties of	no	`array`
product_id	SKU of the product that you'd like to cancel the warranty of	no	`string`

Cancelling an entire order

HTTP method: POST

Authentication: Private Bearer Token

Staging Endpoint: https://partner-staging.getmulberry.com/api/order_cancelled

Production Endpoint: https://partner.getmulberry.com/api/order_cancelled

{
  "cancelled_date": "2018-09-04",
  "order_id": "7689dde5c0f64fffa7ad217432f6f73"
}

Parameter	Definition	Required	Type
cancelled_date	The date of the cancellation	Yes	`string`
order_id	The unique order ID from your ecommerce platform	Yes	`string`