eBay · Schema

CancelStatus

This type contains information about any requests that have been made to cancel an order.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
cancelledDate string The date and time the order was cancelled, if applicable. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-
cancelRequests array This array contains details of one or more buyer requests to cancel the order.

For the getOrders call: This array is returned but is always empty.
For the getOrder call: This
cancelState string The state of the order with regard to cancellation. This field is always returned, and if there are no cancellation requests, a value of NONE_REQUESTED is returned. For implementation hel
View JSON Schema on GitHub

JSON Schema

ebay-cancelstatus-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CancelStatus",
  "title": "CancelStatus",
  "type": "object",
  "properties": {
    "cancelledDate": {
      "type": "string",
      "description": "The date and time the order was cancelled, if applicable. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. <br><br><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>"
    },
    "cancelRequests": {
      "type": "array",
      "description": "This array contains details of one or more buyer requests to cancel the order. <br><br><b>For the getOrders call:</b>  This array is returned but is always empty.<br><b>For the getOrder call:</b> This array is returned fully populated with information about any cancellation requests.",
      "items": {
        "$ref": "#/components/schemas/CancelRequest"
      }
    },
    "cancelState": {
      "type": "string",
      "description": "The state of the order with regard to cancellation. This field is always returned, and if there are no cancellation requests, a value of <code>NONE_REQUESTED</code> is returned.  For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:CancelStateEnum'>eBay API documentation</a>"
    }
  },
  "description": "This type contains information about any requests that have been made to cancel an order."
}