eBay Post-Order APIVersion 2

Get a Cancellation

GET /post-order/v2/cancellation/{cancelId}

This method retrieves the details of a specific cancellation.

The response from this call depends on the value set for the fieldgroups query parameter. If the value of fieldgroups is set to SUMMARY, the response payload is identical to the payload retrieved in the GET /post-order/v2/cancellation/search call. If you set the value of fieldgroups to FULL, the response includes a history of each cancellation request and the list of each line item in the order.

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/post-order/v2/cancellation/{cancelId}?
  fieldgroups=GetCancelFieldGroup

URI parameters

Parameter Type Required? Meaning
cancelId string Required Supply in this path parameter the unique eBay-assigned ID of the cancellation request to retrieve.
fieldgroups string Optional The value set in this query parameter controls the level of detail that is returned in the response.

Applicable values:
  • FULL – Returns basic information about the specified cancellation, plus additional available information about line items in the order and a history of each cancellation request activity.
  • SUMMARY – Returns basic information about the specified cancellation. This is equivalent to the information returned by the GET /post-order/v2/cancellation/search call.
Default: FULL

Applicable values are from GetCancelFieldGroup.


HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.



Authorization

This call uses standard authorization tokens. See Making a Call for details.

Payload model

This call has no request payload.


Output

See also Samples.

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

The following lists all fields that could be included in the response.

Supported response formats: application/json, application/xml

For more information:
- See GetCancelDetailResponse for a description of the response structure
- See the following table for descriptions of each of the data elements returned
- See the Samples for an example of the response format

{ /* GetCancelDetailResponse */
"cancelDetail":
    { /* CancelDetail */
    "activityHistories": [
        { /* CancelActivityHistory */
        "actionDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            },
        "activityParty": token,
        "activityType": token,
        "stateFrom": token,
        "stateTo": token
        }
        /* More CancelActivityHistory nodes here */
      ],
    "buyerLoginName": string,
    "buyerResponseDueDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "cancelCloseDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "cancelCloseReason": token,
    "cancelId": string,
    "cancelReason": token,
    "cancelRequestDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "cancelState": token,
    "cancelStatus": token,
    "legacyOrderId": string,
    "marketplaceId": token,
    "moneyMovementInfo": [
        { /* can:MoneyMovementDetailType */
        "actualAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "value": number
            },
        "creationDate":
            { /* DateTime */
            "formattedValue": string,
            "value": datetime
            },
        "moneyMovementType": token,
        "requestedAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "value": number
            },
        "status": token
        }
        /* More can:MoneyMovementDetailType nodes here */
      ],
    "partialOrderType": token,
    "paymentStatus": token,
    "payoutRecoupInfo":
        { /* PayoutRecoupInfo */
        "amountToRecoup":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": number,
            "currency": string,
            "value": number
            },
        "payoutId": integer
        },
    "requestorType": token,
    "requestRefundAmount":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": number,
        "currency": string,
        "value": number
        },
    "sellerLoginName": string,
    "sellerResponseDueDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        },
    "shipmentDate":
        { /* DateTime */
        "formattedValue": string,
        "value": datetime
        }
    }
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
cancelDetail CancelDetail Always Contains information about a canceled order. If the value of the fieldgroups query parameter is set to FULL, the response also contains a record of all activity performed on the cancellation request plus the identifiers for each line item in the order.
cancelDetail.activityHistories array of CancelActivityHistory Always A complete list of the activity associated with this cancellation request.
cancelDetail.activityHistories
  .actionDate
DateTime Always The timestamp for the action that occurred with the cancellation request.
cancelDetail.activityHistories
  .actionDate.formattedValue
string Conditionally Reserved for future use.
cancelDetail.activityHistories
  .actionDate.value
datetime Conditionally The date and time defining the start or end of an action or event.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2020-08-20T00:00:00.000Z
cancelDetail.activityHistories
  .activityParty
token Always The party who performed the action on the cancellation request, either the buyer or the seller.

Applicable values: See PartyEnum
cancelDetail.activityHistories
  .activityType
token Always The type of event or action that occurred with the cancellation request.

Applicable values: See CancelActivityTypeEnum
cancelDetail.activityHistories
  .stateFrom
token Always Indicates the state of the cancellation request prior to the performed action (defined in the activityType field).

Applicable values: See CancelStateEnum
cancelDetail.activityHistories
  .stateTo
token Always The state of the cancellation process following this event or action. Depending on the activityType, the state of the cancellation process might not change, so in such cases this value can be the same as the value of stateFrom.

Applicable values: See CancelStateEnum
cancelDetail.buyerLoginName string Conditionally The eBay-assigned username of the account that represents the buyer in the transaction.
cancelDetail
  .buyerResponseDueDate
DateTime Conditionally A timestamp that indicates the time by which the buyer is required to respond to an active cancellation request. This container is not returned if the cancellation request does not currently require a response from the buyer.
cancelDetail
  .buyerResponseDueDate
  .formattedValue
string Conditionally Reserved for future use.
cancelDetail
  .buyerResponseDueDate.value
datetime Conditionally The date and time defining the start or end of an action or event.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2020-08-20T00:00:00.000Z
cancelDetail.cancelCloseDate DateTime Conditionally A timestamp that indicates when the cancellation request was closed. This field is only applicable and returned when the cancellation request is closed (regardless of outcome).
cancelDetail.cancelCloseDate
  .formattedValue
string Conditionally Reserved for future use.
cancelDetail.cancelCloseDate
  .value
datetime Conditionally The date and time defining the start or end of an action or event.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2020-08-20T00:00:00.000Z
cancelDetail.cancelCloseReason token Conditionally The reason why the cancel request was closed. This field is only applicable and returned if the cancellation request was closed or if the buyer attempted to close the cancellation request.

Applicable values: See CancelCloseReasonEnum
cancelDetail.cancelId string Always A unique eBay-assigned ID for an order cancellation. All data in the cancelDetail container refers to this specific order cancellation.
cancelDetail.cancelReason token Conditionally The reason why the user (either the buyer or seller, as defined in the requestorType field) initiated the cancellation request.

Applicable values: See CancelReasonEnum
cancelDetail.cancelRequestDate DateTime Always A timestamp that indicates when the cancellation request was created.
cancelDetail.cancelRequestDate
  .formattedValue
string Conditionally Reserved for future use.
cancelDetail.cancelRequestDate
  .value
datetime Conditionally The date and time defining the start or end of an action or event.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2020-08-20T00:00:00.000Z
cancelDetail.cancelState token Always The current stage or condition of the cancellation process.

This value, combined with the value of the cancelStatus field, can help you determine upcoming cancellation events and the appropriate actions you can take.

Applicable values: See CancelStateEnum
cancelDetail.cancelStatus token Always The last action taken by one of the parties associated with the cancellation.

This value, combined with the value of the cancelState field, can help you determine upcoming events and the appropriate actions you can take on the cancellation.

Applicable values: See CancelStatusEnum
cancelDetail.legacyOrderId string Always A unique eBay-assigned ID for the order being canceled or considered for cancellation.

Note: This is the value of the OrderId field that's returned by a Trading API GetOrders call.

cancelDetail.marketplaceId token Always A unique eBay-assigned ID for the eBay marketplace where the cancellation was created.

Applicable values: See MarketplaceIdEnum
cancelDetail.moneyMovementInfo array of can:MoneyMovementDetailType Conditionally This container consists of detailed information on a money movement transaction. A moneyMovementInfo container is returned for each separate money movement transaction.
cancelDetail.moneyMovementInfo
  .actualAmount
Amount Conditionally This dollar value is the actual amount of the monetary transaction. The actualAmount field will only show up if the monetary transaction was confirmed to be successful (moneyMovementStatusType values shows as 'SUCCESS'. Until then, expected amount of the monetary transaction can be seen in the requestedAmount field.
cancelDetail.moneyMovementInfo
  .actualAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
cancelDetail.moneyMovementInfo
  .actualAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
cancelDetail.moneyMovementInfo
  .actualAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
cancelDetail.moneyMovementInfo
  .actualAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
cancelDetail.moneyMovementInfo
  .creationDate
DateTime Conditionally This timestamp indicates the date and time when the monetary transaction occurred.
cancelDetail.moneyMovementInfo
  .creationDate.formattedValue
string Conditionally Reserved for future use.
cancelDetail.moneyMovementInfo
  .creationDate.value
datetime Conditionally The date and time defining the start or end of an action or event.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2020-08-20T00:00:00.000Z
cancelDetail.moneyMovementInfo
  .moneyMovementType
token Always Indicates the type of monetary transaction that is either in the process of being executed or has already executed.

Monetary transactions include a seller's partial or full refund to the buyer or the seller receiving the Final Value Fee refund from eBay.

Applicable values: See can:MoneyMovementTypeEnum
cancelDetail.moneyMovementInfo
  .requestedAmount
Amount Always This monetary amount is the expected value of the transaction.

This field is returned regardless of the value shown in the moneyMovementStatusType field. The actualAmount field displays only when the monetary transaction was confirmed to be successful (moneyMovementStatusType equals SUCCESS.
cancelDetail.moneyMovementInfo
  .requestedAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
cancelDetail.moneyMovementInfo
  .requestedAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
cancelDetail.moneyMovementInfo
  .requestedAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
cancelDetail.moneyMovementInfo
  .requestedAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
cancelDetail.moneyMovementInfo
  .status
token Conditionally Indicates the success or failure of the monetary transaction type noted in the moneyMovementType field.

Applicable values: See can:MoneyMovementStatusEnum
cancelDetail.partialOrderType token Conditionally This value indicates whether the cancellation is for either a full or partial order.

Currently, only full orders are eligible for cancellation.

Applicable values: See PartialOrderTypeEnum
cancelDetail.paymentStatus token Always The current status of the buyer's payment for the order that is being canceled or considered for cancellation.

Applicable values: See PaymentStatusEnum
cancelDetail.payoutRecoupInfo PayoutRecoupInfo Conditionally Defines the monetary amount of a payout.

Payout amount data includes the sale price in the original currency with it's currency code, and any currency conversion information (as necessary), which includes the current currency code.
cancelDetail.payoutRecoupInfo
  .amountToRecoup
Amount Conditionally The monetary amount of the payout (paid by the payment system to the buyer) to recoup from the seller.
cancelDetail.payoutRecoupInfo
  .amountToRecoup
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
cancelDetail.payoutRecoupInfo
  .amountToRecoup
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
cancelDetail.payoutRecoupInfo
  .amountToRecoup.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
cancelDetail.payoutRecoupInfo
  .amountToRecoup.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
cancelDetail.payoutRecoupInfo
  .payoutId
integer Conditionally An unique eBay-assigned ID that identifies the payout to the buyer.
cancelDetail.requestorType token Always The reason why the user (either the buyer or the seller, as defined in the requestorType field) initiated the cancellation request.

Applicable values: See PartyEnum
cancelDetail
  .requestRefundAmount
Amount Conditionally The amount of the refund that the buyer is expecting to receive if the order is successfully canceled.

The monetary amount indicated here is typically the full amount that the buyer paid for the order, including the item price and shipping fees.

The information returned also includes any currency conversion information (as necessary), the current currency code, the value in the original currency, and the original currency's code.
cancelDetail
  .requestRefundAmount
  .convertedFromCurrency
string Conditionally This field indicates the currency involved in a monetary transaction before a price conversion was performed. Generally, this is the currency used by the buyer. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
cancelDetail
  .requestRefundAmount
  .convertedFromValue
number Conditionally This value is the dollar amount of the currency involved in a monetary transaction before a price conversion was performed. This field is only applicable if a price conversion was necessary, and a price conversion is generally necessary if the buyer and seller are using different forms of currency.
cancelDetail
  .requestRefundAmount.currency
string Conditionally This field indicates the currency involved in a monetary transaction. Generally, this is the currency used by the listing site's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
cancelDetail
  .requestRefundAmount.value
number Conditionally The dollar value of the currency specified in the currency field. The value of currency defaults to the standard currency used by the country of the listing site.
cancelDetail.sellerLoginName string Conditionally The eBay-assigned username of the account that represents the seller in the transaction.
cancelDetail
  .sellerResponseDueDate
DateTime Conditionally A timestamp that indicates the time by which the seller is required to respond to an active cancellation request.

This container is not returned if the cancellation request does not currently require a response from the seller.
cancelDetail
  .sellerResponseDueDate
  .formattedValue
string Conditionally Reserved for future use.
cancelDetail
  .sellerResponseDueDate.value
datetime Conditionally The date and time defining the start or end of an action or event.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2020-08-20T00:00:00.000Z
cancelDetail.shipmentDate DateTime Conditionally A timestamp that indicates the time when the seller shipped the order (or a line item within the order) that the buyer is attempting to cancel.

Once a seller ships one or more line items within an order, the order is no longer eligible for cancellation. This container is only applicable and returned if the seller shipped one or more line items in order, thus making it impossible for the cancel request to be granted.
cancelDetail.shipmentDate
  .formattedValue
string Conditionally Reserved for future use.
cancelDetail.shipmentDate
  .value
datetime Conditionally The date and time defining the start or end of an action or event.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2020-08-20T00:00:00.000Z



Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Get cancellation details

Retrieves the details of a specified cancellation request.

Description

This call returns the full details of a specified cancellation request, including the full history of the cancellation request and the line items in the order.

Input

The cancelId value is passed in as a path parameter at the end of the URI. The user uses the fieldgroups query parameter and sets its value to FULL to retrieve full details on the cancellation request, including the full history of the cancellation request and the line items in the order.

URL format. See also the non-wrapped version of this URL.

GET https://api.ebay.com/post-order/v2/cancellation/5000001071?
   fieldgroups=FULL

Output

This cancellation request (identified in the cancelId field) has just been created by the seller on behalf of the buyer, which is indicated by the value in the activityHistories.activityType field. When a seller cancels an order on behalf of a buyer, the seller gives the cancellation reason as BUYER_CANCEL_OR_ADDRESS_ISSUE, which is indicated in the cancelDetail.cancelReason field. This cancellation reason given by the seller will ensure that the seller's account does not receive a seller defect. The cancelStateFrom and cancelStatetateTo values indicate that the seller has just initiated the cancellation request, and the next step is for the buyer to be refunded.

JSON format.
{
  "cancelDetail": {
    "cancelId": "5000001071",
    "marketplaceId": "EBAY_US",
    "legacyOrderId": "170006494376-8756205007",
    "requestorType": "SELLER",
    "cancelReason": "BUYER_CANCEL_OR_ADDRESS_ISSUE",
    "cancelState": "REFUND_PENDING",
    "cancelStatus": "CANCEL_PENDING",
    "paymentStatus": "PAYPAL_PAID",
    "requestRefundAmount": {
      "value": 2.46,
      "currency": "USD"
    },
    "cancelRequestDate": {
      "value": "2014-08-22T23:29:11.000Z",
    },
    "lineItems": [
      {
        "itemId": "170006494376",
        "transactionId": "8756205007"
      }
    ],
    "activityHistories": [
      {
        "activityType": "SELLER_CREATE_CANCEL",
        "activityParty": "SELLER",
        "actionDate": {
          "value": "2014-08-22T23:29:07.000Z",
        },
        "cancelStateFrom": "INITIAL",
        "cancelStatetateTo": "REFUND_PENDING"
      }
    ]
  }
}



Change History

Change Date Description