Note: Currently, only an entire order can be cancelled; the cancellation of individual line items in the order is not supported.
For an order to be eligible for cancellation, all of the line items in the order must be eligible for cancellation.
", "operationId": "checkCancellationEligibility", "requestBody": { "description": "Request object for the checkEligibility method.", "content": { "application/xml": { "schema": { "description": "Request object for the checkEligibility method.", "$ref": "#/components/schemas/OrderEligibilityCheckInfo" } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/OrderEligibilityResult" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/post-order/v2/cancellation/{cancelId}": { "get": { "tags": [ "Cancellation" ], "summary": "Get Cancellation", "description": "This method retrieves the details of a specific cancellation request.SUMMARY, the response payload is identical to the payload retrieved in the GET /post-order/v2/cancellation/search method. 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.FULL. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/post-order/post-order/types/can:GetCancelFieldGroup",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/GetCancelDetailResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/post-order/v2/cancellation": {
"post": {
"tags": [
"Cancellation"
],
"summary": "Create Cancellation Request",
"description": "This method initiates an order cancellation on behalf of a seller and, if needed, you can also create an order cancellation on behalf of a buyer.Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including this method. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload. The buyer use-case for this method provides a way for you to programmatically test your cancellation flows in the Sandbox, as buyers in a production environment normally request order cancellations via the eBay web flows.
Tip: Call POST /post-order/v2/cancellation/check_eligibility before calling this method to ensure the order being considered is eligible to be cancelled.
Orders are eligible for cancellation based on various criteria, such as the cancellation cutoff period for the eBay marketplace on which the order was placed. As an example, the cutoff for EBAY_US is 1 hour after purchase, after which the order becomes ineligible for cancellation. If the order is not eligible for cancellation, you can notify the buyer or seller so they don't proceed with a cancellation request.
When a buyer cancels an order after purchase, it is up to the seller to either reject or approve it the request by calling POST /post-order/v2/cancellation/{cancelId}/reject or POST /post-order/v2/cancellation/{cancelId}/approve methods, respectively.
Sellers can call POST /post-order/v2/cancellation to directly cancel the order.
Sellers may cancel an order if they run out of stock on an item and are unable to fulfill the order for up to 30 days after the sale. While the POST /post-order/v2/cancellation/check_eligibility method can be used to check for order cancellation eligibility, the POST /post-order/v2/cancellation method also returns eligibility information in the response. If the order's cancellation eligibility has changed, examine the failureReason field for why the cancellation failed.
Note: Sellers may cancel an order up to 30 days after the sale. However, if a seller has run out of stock on an item and cannot fulfill the order, a cancellation can result in a defect on the seller's account. Also, note there is no negative effect on the seller's account if the seller is cancelling the order at the request of the buyer.
Note: Currently, an entire eligible order can be cancelled, but not individual order line items. For the order to be eligible for cancellation, all of its order line items must be eligible.
", "operationId": "createCancellationRequest", "requestBody": { "description": "Request object for the CreateCancelRequest method.", "content": { "application/xml": { "schema": { "description": "Request object for the CreateCancelRequest method.", "$ref": "#/components/schemas/CreateCancelRequest" } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CreateCancelResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/post-order/v2/cancellation/{cancelId}/confirm": { "post": { "tags": [ "Cancellation" ], "summary": "Confirm Cancellation Refund", "description": "Note: This call has been deprecated and will be decommissioned on March 2, 2026.This is a buyer-side method that you can use to indicate that the buyer received a refund for the specified order cancellation.
In the case of an unpaid order, this method can also be used by the buyer to acknowledge the order has been cancelled and that the cancellation request has been closed.
", "operationId": "confirm", "parameters": [ { "name": "cancelId", "in": "path", "description": "The unique eBay-assigned identifier of the cancellation request for which to confirm refund. The cancellation ID value is passed in as part of the call URI.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request object for the ConfirmRefundRequest method.", "content": { "application/xml": { "schema": { "description": "Request object for the ConfirmRefundRequest method.", "$ref": "#/components/schemas/ConfirmRefundRequest" } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "type": "object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [] } ] } }, "/post-order/v2/cancellation/search": { "get": { "tags": [ "Cancellation" ], "summary": "Search Cancellations", "description": "Use this method to search for and retrieve one or more order cancellations.2015-05-15T03:00:00.000Z.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "creation_date_range_to",
"in": "query",
"description": "Use creation_date_range_to in conjunction with the creation_date_range_from query parameter. See creation_date_range_to for details on how to set this parameter. Note: Note that order ID values change as an order goes from the unpaid to the paid state, and order IDs in both states are supported with this parameter.", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "This parameter specifies the maximum number of order cancellations to return per page of data. If this query parameter is not used, its value defaults to 10 (order cancellations per page)
Default: 10
Maximum: 500
Minimum: 1
Combine offset with the limit query parameter to control how many and which items are returned in the response. For example, if you supply an offset value of 0 and a limit value of 10, the first page of the response will contain the first 10 items from the results set. If the offset value is 10 and the limit value is 20, the first page of the response will contain items 11-30 from the results set.
Default: 0
", "required": false, "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "Use this query parameter to filter the order cancellation results based on who inititated the order cancellation request. The supported values areBUYER and SELLER, and both value are case-sensitive (e.g. all CAPS are required). SELLER For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/post-order/post-order/types/zbase:UserRoleFilterEnum",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "This query parameter allows a user to sort cancellation requests in the response by CANCEL_ID or by CANCEL_REQUEST_DATE, in ascending or descending order. One of these two enumeration values must be used as the sort value, and will be preceding by either a + (plus sign) to sort in ascending order, or a - (minus sign) to sort in descending order. sort=+CANCEL_ID. To sort in descending order according to cancellation request date, sort=-CANCEL_REQUEST_DATE would be used. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/post-order/post-order/types/can:CancelSortField",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "transaction_id",
"in": "query",
"description": "The unique eBay-assigned ID of the line item purchase. If this parameter is used, the item_id query parameter must also be used, as both Item ID and Transaction ID values are needed to identify a line item. If you use transaction_id without also supplying an item_id value, this parameter is ignored.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/FindCancelResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/post-order/v2/cancellation/{cancelId}/approve": {
"post": {
"tags": [
"Cancellation"
],
"summary": "Approve Cancellation",
"description": "This method approves a buyer's order cancellation request on behalf of the seller.Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including this method. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload. If the order is eligible for cancellation and the seller agrees, this method cancels the order and notifies the buyer of the cancellation. 200 is returned. Important! The shipmentDate and trackingNumber fields are optional in the request payload. If you do not include either of these fields, you must submit a payload consisting of just the opening and closing braces ({ }).
caseId value that is passed in as part of the call URI. You must be involved in the case in order to retrieve the case details.This method can be used on behalf of sellers to issue a full refund to the buyer to resolve an INR or Return case that was filed against the seller. The seller can voluntarily use this method before eBay customer support makes a decision on the case, or after, when and if eBay customer supports rules in favor of the buyer and forces the seller to issue a refund to the buyer.Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including this method. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.
", "operationId": "issueCaseRefund", "parameters": [ { "name": "caseId", "in": "path", "description": "The unique identifier of a case. This URI parameter is required in order to identify the case for which a full refund will be issued to the buyer. The case ID value is passed in as part of the call URI.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Use this method to use a refund as the result of a case resolution.", "content": { "application/json": { "schema": { "description": "Use this method to use a refund as the result of a case resolution.", "$ref": "#/components/schemas/CaseVoluntaryRefundRequest" } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "description": "Base response of the issue case refund method.", "$ref": "#/components/schemas/VoluntaryRefundResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell@user" ] } ] } }, "/post-order/v2/casemanagement/{caseId}/provide_return_address": { "post": { "tags": [ "Case Management" ], "summary": "Provides Return Address", "description": "Note: This call has been deprecated and will be decommissioned on March 2, 2026.This method can be used on behalf of sellers to provide the correct return address to the buyer. If applicable, and requested by the buyer, the seller can also provide the Return Merchandise Authorization (RMA) number to the buyer through the request payload.
This method can be used on behalf of buyers to close an open case. Buyers can close an INR case after the item arrives, and they might close a Return case if they decide to keep the item, or have otherwise worked out an agreement with the seller.
", "operationId": "closeCase", "parameters": [ { "name": "caseId", "in": "path", "description": "The unique identifier of a case. This URI parameter is required in order to identify the case that is being closed. The case ID value is passed in as part of the call URI.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Use this method to close an open case.", "content": { "application/json": { "schema": { "description": "Use this method to close an open case.", "$ref": "#/components/schemas/BuyerCloseCaseRequest" } } }, "required": false }, "responses": { "200": { "description": "Success" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [] } ] } }, "/post-order/v2/casemanagement/{caseId}/provide_shipment_info": { "post": { "tags": [ "Case Management" ], "summary": "Provide Case Shipment Info", "description": "Note: This call has been deprecated and will be decommissioned on March 2, 2026.This method is used to provide shipment tracking information for an item that is involved in case.
2015-05-15T03:52:39.000Z.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "case_creation_date_range_to",
"in": "query",
"description": "The case_creation_date_range_from and case_creation_date_range_to query parameters are used if the user wants to retrieve cases that were created during a specific time range. The ending date range is input into the case_creation_date_range_to query parameter. The case_creation_date_range_to date must be more recent than the case_creation_date_range_from date. If the case_creation_date_range_from query parameter is used, but the case_creation_date_range_to query parameter is not used, the method will look for all cases created at or after the case_creation_date_range_from value, going forward 90 days from this date. The ISO-8601 date format should be used for this query parameter. Here's a sample of that format: 2015-05-15T03:52:39.000Z.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "case_status_filter",
"in": "query",
"description": "This query parameter is used if the user wants to search for cases in a specific state. One of the enumeration values defined in the CaseStatusFilter type definition must be used in this query parameter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/post-order/post-order/types/res:CaseStatusFilter",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "fieldgroups",
"in": "query",
"description": "In the future, the fieldgroups query parameter may be used in the request to control the amount of detail that is returned in the response, but for now, the scope of the response will be the same even if this query parameter is used and set to DEFAULT, which is the only supported value. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/post-order/post-order/types/res:CaseSearchFieldGroupEnum",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item_id",
"in": "query",
"description": "The unique eBay-assigned ID of a listing. If this parameter is used, eBay will search for any cases filed against this listing. 0 is set in this field or if this query parameter is omitted. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results in the paginationOutput container of your initial call).Descending or Ascending must be used as the value.Descending is the default value, so this query parameter is more useful if you want to sort cases in ascending order.201 is returned, and the Location response header will contain the call URI that can be used to retrieve the newly-created inquiry. ",
"operationId": "createInquiry",
"requestBody": {
"description": "This is the base request type for the 'Create Inquiry' method.",
"content": {
"application/json": {
"schema": {
"description": "This is the base request type for the 'Create Inquiry' method.",
"$ref": "#/components/schemas/CreateInquiryRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Success"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"api_auth": []
}
]
}
},
"/post-order/v2/inquiry/{inquiryId}/send_message": {
"post": {
"tags": [
"Inquiry"
],
"summary": "Send Inquiry Message",
"description": "This method allows a buyer or seller to send a message to their order partner in regards to an INR inquiry.This method can be used on behalf of the buyer to confirm receipt of a full refund for the order line item that has the INR inquiry. This method has no request or response payloads. The inquiryId value is passed in as a path parameter, and if the refund is successfully confirmed, an HTTP status code of 200 is returned.
", "operationId": "confirmInquiryRefund", "parameters": [ { "name": "inquiryId", "in": "path", "description": "The unique ID of the inquiry for which the refund is to be confirmed. The inquiry ID value is passed in as part of the call URI.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [] } ] } }, "/post-order/v2/inquiry/{inquiryId}": { "get": { "tags": [ "Inquiry" ], "summary": "Get Inquiry", "description": "This method retrieves details about the specified INR inquiry and a summary of the activity to date with respect to the inquiry. The response can also include provisional refund state and an estimated resolution date when the inquiry is in a provisional refund eligible flow. The summary includes any actions taken by the buyer, the seller, the Inquiry service, or customer support representatives.", "operationId": "getInquiry", "parameters": [ { "name": "inquiryId", "in": "path", "description": "The unique ID of the inquiry for which details and history are to be retrieved. The inquiry ID value is passed in as part of the call URI.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryDetailsResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/post-order/v2/inquiry/{inquiryId}/issue_refund": { "post": { "tags": [ "Inquiry" ], "summary": "Issue Inquiry Refund", "description": "This method can be used on behalf of the seller to issue a full refund to the buyer for the missing line item. This method will be used if the buyer is seeking a full refund for the missing line item and the seller has yet to ship the line item.Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including this method. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.", "operationId": "issueInquiryRefund", "parameters": [ { "name": "inquiryId", "in": "path", "description": "The unique ID of the inquiry for which a refund is to be issued. The inquiry ID value is passed in as part of the call URI.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "This is the base request type for the 'Issue Inquiry Refund' method.", "content": { "application/json": { "schema": { "description": "This is the base request type for the 'Issue Inquiry Refund' method.", "$ref": "#/components/schemas/InquiryVoluntaryRefundRequest" } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoluntaryRefundResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell@user" ] } ] } }, "/post-order/v2/inquiry/{inquiryId}/provide_shipment_info": { "post": { "tags": [ "Inquiry" ], "summary": "Provide Inquiry Shipment Info", "description": "This method can be used to provide shipment tracking and other information about the shipment of an order line item that had an INR inquiry filed against it.Note: Inquiries that have been escalated to cases are excluded from searchInquiries results. Use getCase to locate the escalated case and the other Post-Order Case Management Calls to manage escalated items. The getInquiry endpoint may still return the original inquiry for historical context.
DEFAULT, which is the only supported value. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/post-order/post-order/types/res:InquirySearchFieldGroupEnum",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "inquiry_creation_date_range_from",
"in": "query",
"description": "The inquiry_creation_date_range_from and inquiry_creation_date_range_to query parameters are used if the user wants to retrieve inquiries that were created during a specific time range. The starting date range is input into the inquiry_creation_date_range_from query parameter. The inquiry_creation_date_range_from date must be older than the inquiry_creation_date_range_to date, and it cannot be set back more than 18 months in the past. If the inquiry_creation_date_range_from query parameter is used, but the inquiry_creation_date_range_to query parameter is not used, the method will look for all inquiries created at or after this date/time, going forward 90 days from this date. The ISO-8601 date format should be used for this query parameter. Here's a sample of that format: 2015-05-15T03:52:39.000Z.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "inquiry_creation_date_range_to",
"in": "query",
"description": "The inquiry_creation_date_range_from and inquiry_creation_date_range_to query parameters are used if the user wants to retrieve inquiries that were created during a specific time range. The ending date range is input into the inquiry_creation_date_range_to query parameter. The inquiry_creation_date_range_to date must be more recent than the inquiry_creation_date_range_from date. If the inquiry_creation_date_range_from query parameter is used, but the inquiry_creation_date_range_to query parameter is not used, the method will look for all inquiries created at or after the inquiry_creation_date_range_from value, going forward 90 days from this date. The ISO-8601 date format should be used for this query parameter. Here's a sample of that format: 2015-05-15T03:52:39.000Z.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "inquiry_status",
"in": "query",
"description": "This query parameter is used if the user wants to search for INR inquiries in a specific state. One of the enumeration values defined in the InquirySearchFieldGroupEnum type definition must be used in this query parameter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/post-order/post-order/types/res:InquiryStatusFilter",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item_id",
"in": "query",
"description": "The unique eBay-assigned ID of a listing. If this parameter is used, eBay will search for any INR inquiries filed against this listing. 0 is set in this field or if this query parameter is omitted. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results in the paginationOutput container of your initial call).Descending or Ascending must be used as the value.Descending is the default value, so this query parameter is more useful if you want to sort inquiries in ascending order.This method on behalf of the seller to provide more information to the buyer about a refund, as is required in certain countries.
", "operationId": "provideInquiryRefundInfo", "parameters": [ { "name": "inquiryId", "in": "path", "description": "The unique ID of the inquiry for which to provide refund information. The inquiry ID value is passed in as part of the call URI. ", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "This is the base request type for the 'Provide Inquiry Refund Info' method.", "content": { "application/json": { "schema": { "description": "This is the base request type for the 'Provide Inquiry Refund Info' method.", "$ref": "#/components/schemas/SellerProvideRefundInfoRequest" } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell@user" ] } ] } }, "/post-order/v2/return": { "post": { "tags": [ "Return" ], "summary": "Create Return Request", "description": "This method is used to create a return request on behalf of the buyer. If you are converting a return request draft into an actual return request, you must include the draftId field in the request. Whether you are creating a return request directly, or converting a return request draft into a return request, you must include values for the itemId, transactionId, reason, returnQuantity, and type fields.Note: If the fieldgroups query parameter is set to FULL, the response may also include provisional refund information under detail.detail.refundInfo.provisionalRefund, since the full response uses the same return detail type returned by the Get Return call.
NONE, which means that only the returnId value for the newly-created return request will be in the response.",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "This is the base request of the create return method.",
"content": {
"application/json": {
"schema": {
"description": "This is the base request of the create return method.",
"$ref": "#/components/schemas/CreateReturnRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/xml": {
"schema": {
"description": "This is the base response of the create return method.",
"$ref": "#/components/schemas/CreateReturnResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"api_auth": []
}
]
}
},
"/post-order/v2/return/{returnId}": {
"get": {
"tags": [
"Return"
],
"summary": "Get Return",
"description": "Use this method to retrieve information on a specific return request. The user can retrieve either the full details or a summary of the return. When applicable, the full response may also include provisional refund state under detail.refundInfo.provisionalRefund to indicate whether a provisional refund was provided before return creation and whether that refund was later reversed.FULL, which means that only the detail container will get returned for the return request, and not the summary container.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "returnId",
"in": "path",
"description": "The unique eBay-assigned ID of the return request. This field is required to identify the return request that the user wishes to retrieve. The return ID value is passed in as part of the call URI.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/GetDetailResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/post-order/v2/return/search": {
"get": {
"tags": [
"Return"
],
"summary": "Search Returns",
"description": "Use this method to retrieve the details on one or more return requests, or a summary of return requests per user. This method supports several filters, supplied as query parameters, that allow you to restrict results by date, return status, return type, or by listing. If you use more than one filter type in the request, Boolean AND logic is applied to the results set. Boolean OR logic is used for conditions within a filter.2021-05-15T03:52:39.000Z.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "creation_date_range_to",
"in": "query",
"description": "Specify the creation_date_range_from and creation_date_range_to query parameters if you want to retrieve return requests that were created during a specific period of time. 2021-07-15T03:52:39.000Z.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "item_id",
"in": "query",
"description": "The unique eBay-assigned ID of a listing. If this parameter is used, eBay will search for any return requests filed against this listing. 0 is set in this field or if this query parameter is omitted. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results in the paginationOutput container of your initial call).BUYER and SELLER, and both value are case-sensitive (e.g. all CAPS are required).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "This query parameter allows a user to sort cancellation requests in the response by ACTUAL_AMOUNT, BUYER_LOGIN_NAME, ESTIMATED_AMOUNT, FILING_DATE, REASON, REFUND_DUE_DATE, RETURN_ID, or STATUS in ascending or descending order. One of these enumeration values must be used as the sort value, and will be preceding by either a + (plus sign) to sort in ascending order, or a - (minus sign) to sort in descending order. sort=+ACTUAL_AMOUNT. To sort in descending order according to return creation date, sort=-FILING_DATE would be used. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/post-order/post-order/types/ret:ReturnSortField",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "states",
"in": "query",
"description": "This query parameter is used if the user wants to search for return requests in a specific state in the return process. One of the enumeration values defined in the ReturnStateEnum type definition must be used in this query parameter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/post-order/post-order/types/ret:ReturnStateEnum",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "transaction_id",
"in": "query",
"description": "The unique eBay-assigned ID of the line item purchase. If this parameter is used, the item_id query parameter must also be used, as both Item ID and Transaction ID values are needed to identify a line item. If you use transaction_id without also supplying an item_id value, this parameter is ignored.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/GetSummaryResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/post-order/v2/return/{returnId}/escalate": {
"post": {
"tags": [
"Return"
],
"summary": "Escalate Return",
"description": "This method is used to escalate a return request into a case. The escalation reason and an accompanying comment can be included in the request payload. If the return request is successfully escalated, a caseId value is returned in the response.SUCCESS if the refund has been successfully issued to the buyer.0.0.",
"$ref": "#/components/schemas/Amount"
},
"fundings": {
"type": "array",
"description": "This array shows one or more seller payment sources used for the buyer refund.",
"items": {
"$ref": "#/components/schemas/RefundFundingType"
}
}
},
"description": "This type is used to provide details about buyer refund information for an order cancellation request."
},
"Address": {
"type": "object",
"properties": {
"addressLine1": {
"type": "string",
"description": "The first line of the street address. The first line of the street address is always used by containers using the Address type."
},
"addressLine2": {
"type": "string",
"description": "The second line of the street address. This field is not always used, but it should be provided if applicable. It might be used for something like 'Suite Number' or 'Apt Number'."
},
"addressType": {
"type": "string",
"description": "This enumeration value indicates whether the address is a business, a personal address, PO Box, or other type of address. This field is not always used by containers using the Address type.true if language transliteration was required."
},
"nationalRegion": {
"type": "string",
"description": "This string value indicates a specific region or metropolitan area within a country in which the address resides. Not all countries have defined national regions."
},
"postalCode": {
"type": "string",
"description": "The postal code of the address. This field is always used by containers using the Address type."
},
"script": {
"type": "string",
"description": "This enumeration value indicates the language that the address has been transliterated into. This field is only returned if transliteration was required (and the isTransliterated field is true. Transliteration is required for languages that use special characters, such as Japanese, Chinese, or Arabic.true if the buyer or seller is eligible to appeal the decision on the case."
}
},
"description": "This type provides information related to the appeal of a case decision."
},
"AppealGrantStatusEnum": {
"type": "object",
"description": "This enumeration type contains the possible outcomes of a case decision that has been appealed by the buyer or seller.",
"enum": [
"GRANTED",
"DENIED",
"OTHER"
]
},
"AppealRequest": {
"type": "object",
"properties": {
"comments": {
"description": "This container is used if the buyer or seller wants to add a note or explanation about why an appeal is being made against the case decision.",
"$ref": "#/components/schemas/Text"
}
},
"description": "The base request type of the POST /post-order/v2/casemanagement/appeal method."
},
"AppealStatusEnum": {
"type": "object",
"description": "This enumerated type defines all posssible status values of an appeal against a case decision.",
"enum": [
"BUYER_APPEALED",
"SELLER_APPEALED",
"BUYER_SELLER_APPEALED",
"SELLER_RECOUPED_BUYER_APPEALED",
"SELLER_RECOUPED_BUYER_APPEALED_CLOSED_CASE",
"SELLER_RECOUP_APPEALED",
"SELLER_RECOUP_NEEDED_BUYER_APPEALED",
"SELLER_RECOUP_NEEDED_BUYER_APPEALED_CLOSED_CASE",
"SELLER_INVOICED_BUYER_APPEALED",
"OTHER"
]
},
"AvailableOptionType": {
"type": "object",
"properties": {
"actionType": {
"description": "This enumeration value informs the buyer or seller what the next action is to move the return request to the next stage. Note that most values in the ActivityOptionEnum type are either specific to the buyer or the seller, but not to both.",
"$ref": "#/components/schemas/ActivityOptionEnum"
},
"actionURL": {
"type": "string",
"description": "This field contains the URL to an eBay page where the buyer or seller can take their next action (specified in the actionType field) in a return request. This field will only be returned if there is an eBay page associated with the next action."
}
},
"description": "This type contains the next option(s) that are available to the buyer or seller to move the return request to the next stage. This type is used by the buyerAvailableOption and sellerAvailableOption arrays that are returned in the POST /post-order/v2/return, GET /post-order/v2/return/search, and GET /post-order/v2/return/{returnId} methods."
},
"BuyerCloseCaseRequest": {
"type": "object",
"properties": {
"closeReason": {
"description": "This field is used to provide a reason why the buyer is closing the case. One of the values in the BuyerCloseReasonEnum type (shown below) must be used. If the OTHER value is passed in, the buyer should use the comments container to provide some more details on why the case is being closed. ",
"$ref": "#/components/schemas/BuyerCloseReasonEnum"
},
"comments": {
"description": "This container can be used if the buyer wants to provide more details on why the case is being closed.",
"$ref": "#/components/schemas/Text"
}
},
"description": "The base request type of the POST /post-order/v2/casemanagement/close method, which is used to close an INR or a Return case on behalf of the buyer."
},
"BuyerCloseInquiryRequest": {
"type": "object",
"properties": {
"closeReason": {
"description": "This field is used to state the reason why the buyer is closing the INR inquiry. One of the values defined in the BuyerCloseReasonEnum type definition (shown below) must be used.SUCCESS. If the status value shows any value other than SUCCESS, the expected amount of the monetary transaction can be seen in the requestedAmount field.",
"$ref": "#/components/schemas/Amount"
},
"creationDate": {
"description": "This timestamp indicates the date and time when the monetary transaction occurred.",
"$ref": "#/components/schemas/DateTime"
},
"moneyMovementType": {
"description": "This enumeration value indicates the type of monetary transaction that is either in the process of being executed or has already executed. SUCCESS.",
"$ref": "#/components/schemas/Amount"
},
"status": {
"type": "string",
"description": "This enumeration value indicates the success or failure of the monetary transaction type (noted in the moneyMovementType field)SUMMARY activityHistories."
},
"CancelActivityTypeEnum": {
"type": "object",
"description": "Enumeration type that is used to provide the possible events or actions that may occur during the life of an order cancellation request.",
"enum": [
"UNKNOWN",
"BUYER_CREATE_CANCEL",
"SYSTEM_CREATE_CANCEL",
"SYSTEM_REFUND",
"SYSTEM_NOTIFY_REFUND_STATUS",
"SELLER_CREATE_CANCEL",
"SELLER_APPROVE",
"SELLER_REJECT",
"BUYER_CONFIRM_REFUND",
"SYSTEM_REJECT",
"SYSTEM_TIMEOUT_FOR_APPROVAL",
"SYSTEM_TIMEOUT_FOR_CONFIRMATION",
"SYSTEM_NOTIFYPP_REFUND",
"SYSTEM_TIMEOUT_FOR_NOTIFY_REFUND_STATUS",
"SYSTEM_PAYOUT",
"SYSTEM_NOTIFY_PAYOUT_STATUS",
"SYSTEM_TIMEOUT_FOR_NOTIFY_PAYOUT_STATUS",
"SYSTEM_CHARGEBACK_OPENED"
]
},
"CancelCloseReasonEnum": {
"type": "object",
"description": "This enumerated type defines the possible reasons why an order cancellation request was closed.",
"enum": [
"UNKNOWN",
"INELIGIBLE_FOR_CANCEL",
"FULL_REFUNDED",
"FULL_REFUNDED_T2_FAILED",
"FULL_REFUNDED_T2_ONLY",
"REFUND_FAILED",
"SELLER_DECLINE",
"SYSTEM_NOTIFY_SHIPPING_STATUS",
"SELLER_APPROVE_TIMEOUT_PAID",
"SELLER_APPROVE_TIMEOUT_UNPAID",
"SELLER_APPROVE_UNPAID",
"BUYER_CONFIRM_REFUND",
"BUYER_CONFIRM_NOT_PAID",
"BUYER_CONFIRM_TIMEOUT_NON_PAYPAL_PAID",
"BUYER_CONFIRM_TIMEOUT_PAYPAL_PAID",
"SELLER_CANCEL_UNPAID",
"FULL_REFUNDED_AS_PAYOUT",
"PAYOUT_FAILED",
"CHARGEBACK_DISPUTE_FILED"
]
},
"CancelDetail": {
"type": "object",
"properties": {
"activityHistories": {
"type": "array",
"description": "A complete list of the activity associated with the order cancellation request.",
"items": {
"$ref": "#/components/schemas/CancelActivityHistory"
}
},
"buyerLoginName": {
"type": "string",
"description": "The eBay username of the buyer involved in the order cancellation request.Note: The unique identifier of an order changes as the order goes from unpaid to paid, so the IDs for both unpaid and paid orders may be returned in this field based on payment status."
},
"marketplaceId": {
"type": "string",
"description": "A unique identifier for the eBay marketplace where the order cancellation request was created.
The full list of enumeration values that represent eBay marketplaces are defined in the MarketplaceIdEnum type definition."
},
"moneyMovementInfo": {
"type": "array",
"description": "This array consists of detailed information on any and all money movement transactions that have occurred in regards to the order cancellation request.",
"items": {
"$ref": "#/components/schemas/CanMoneyMovementDetailType"
}
},
"partialOrderType": {
"description": "This value indicates whether the cancellation request is for the entire order, or only for a subset of one or more line items in an order.
Currently, only full orders are eligible for cancellation, so the value returned here should be FULL_ORDER.",
"$ref": "#/components/schemas/PartialOrderTypeEnum"
},
"paymentStatus": {
"description": "The value returned in this field will indicate whether or not the buyer has paid for the order that is being cancelled or considered for cancellation.",
"$ref": "#/components/schemas/PaymentStatusEnum"
},
"payoutRecoupInfo": {
"description": "This container shows the payout ID and payout amount associated with a paid order that is being cancelled or considered for cancellation. It will not be returned for unpaid orders.
The payout amount data includes the sale price in the seller's currency, and if any currency conversion was necessary, it will also show the amount, currency, and exchange rate used for conversion.",
"$ref": "#/components/schemas/PayoutRecoupInfo"
},
"refundInfo": {
"description": "This container provides detailed information about a buyer refund that was issued, or is scheduled to be issued for a cancelled order.",
"$ref": "#/components/schemas/RefundInfo"
},
"requestorType": {
"description": "The enumeration value returned here indicates who initiated the order cancellation request (either the buyer or seller).",
"$ref": "#/components/schemas/PartyEnum"
},
"requestRefundAmount": {
"description": "This container shows the amount of the refund that the buyer is expecting to receive if the order is successfully cancelled.
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.",
"$ref": "#/components/schemas/Amount"
},
"sellerLoginName": {
"type": "string",
"description": "The eBay username of the seller involved in the order cancellation request.
Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance. "
},
"sellerResponseDueDate": {
"description": "The timestamp in this container indicates the time by which the seller is required to respond to an active order cancellation request.
This container is not returned if the order cancellation request does not currently require a response from the seller.",
"$ref": "#/components/schemas/DateTime"
},
"shipmentDate": {
"description": "The timestamp in this container 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 order cancellation request to be granted.",
"$ref": "#/components/schemas/DateTime"
}
},
"description": "This type contains all of the details associated with an order cancellation request.
The containers and fields returned under the cancelDetail container will depend on whether the fieldgroups query parameter of the GET /post-order/v2/cancellation/{cancelId} request is set to FULL or SUMMARY."
},
"CancelReasonEnum": {
"type": "object",
"description": "This enum type lists the possible reasons why an order may be cancelled.",
"enum": [
"ORDER_MISTAKE",
"FOUND_CHEAPER_PRICE",
"WONT_ARRIVE_IN_TIME",
"WRONG_SHIPPING_ADDRESS",
"WRONG_SHIPPING_METHOD",
"WRONG_PAYMENT_METHOD",
"UNKNOWN",
"PRICE_TOO_HIGH",
"OTHER",
"BUYER_CANCEL_OR_ADDRESS_ISSUE",
"OUT_OF_STOCK_OR_CANNOT_FULFILL",
"BUYER_ASKED_CANCEL",
"ADDRESS_ISSUES",
"ORDER_UNPAID"
]
},
"CancelSortField": {
"type": "object",
"properties": {
"ascending": {
"type": "boolean",
"description": "This boolean field is not literally used. To initiate the return of cancellation requests in ascending order, a plus sign (+) prepends the sort value. To initiate the return of cancellation requests in descending order, a minus sign (-) prepends the sort value."
},
"enumValue": {
"type": "object",
"description": "This field is not literally used, but the sort query parameter value is set to one of the values defined in CancelSortTypeEnum type, prepended by either a plus sign (+) or minus sign (-) to set ascending or descending order, respectively. See the CancelSortTypeEnum type definition for a complete list of supported sort values."
},
"field": {
"type": "string",
"description": "This field is not used."
}
},
"description": "Although the sort query parameter in the GET /post-order/v2/cancellation/search method actually references this type, none of the elements defined in this type are literally used through the sort query parameter."
},
"CancelSortTypeEnum": {
"type": "object",
"description": "This enumeration type lists the possible keys upon which order cancellation requests can be sorted by in a GET /post-order/v2/cancellation/search method. You can use one of these values in the sort query parameter of this request. A plus sign (+) must prepend the value to sort records in ascending order, or a minus sign (-) must prepend the value to sort records in descending order.",
"enum": [
"CANCEL_ID",
"CANCEL_REQUEST_DATE"
]
},
"CancelStateEnum": {
"type": "object",
"description": "This enumerated type lists the possible states of an order cancellation request.",
"enum": [
"INITIAL",
"REFUND_PENDING",
"REFUND_INITIATED",
"APPROVAL_PENDING",
"CONFIRM_REFUND_PENDING",
"CLOSED",
"REFUND_FAILED_RETRY",
"OTHER"
]
},
"CancelStatusEnum": {
"type": "object",
"description": "Enumeration type that is used to provide the last action taken by one of the parties associated with an order cancellation.",
"enum": [
"INVALID",
"CANCEL_REQUESTED",
"CANCEL_PENDING",
"CANCEL_REJECTED",
"CANCEL_CLOSED_NO_REFUND",
"CANCEL_CLOSED_WITH_REFUND",
"CANCEL_CLOSED_UNKNOWN_REFUND",
"CANCEL_CLOSED_FOR_COMMITMENT"
]
},
"CancelSummary": {
"type": "object",
"properties": {
"buyerLoginName": {
"type": "string",
"description": "The eBay username of the buyer involved in the order cancellation request.
Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance. "
},
"buyerResponseDueDate": {
"description": "The timestamp in this container indicates the time by which the buyer is required to respond to an active order cancellation request. This container is not returned if the order cancellation request does not currently require a response from the buyer.",
"$ref": "#/components/schemas/DateTime"
},
"cancelCloseDate": {
"description": "The timestamp in this container indicates when the order cancellation request was closed. This field is only applicable and returned if/when the cancellation request is closed (regardless of outcome).",
"$ref": "#/components/schemas/DateTime"
},
"cancelCloseReason": {
"type": "string",
"description": "This enumeration value indicates the reason why the order cancellation request was closed. This field is only applicable and returned if/when the cancellation request was closed or if the buyer attempted to close the cancellation request.
The full list of enumeration values that may get returned in this field are defined in the CancelCloseReasonEnum type definition."
},
"cancelId": {
"type": "string",
"description": "A unique eBay-assigned ID for an order cancellation request."
},
"cancelReason": {
"type": "string",
"description": "This value indicates the reason why the user (either the buyer or seller, as defined in the requestorType field) initiated the order cancellation request.
The full list of enumeration values that may get returned in this field are defined in the CancelReasonEnum type definition."
},
"cancelRequestDate": {
"description": "The timestamp in this container indicates when the order cancellation request was created.",
"$ref": "#/components/schemas/DateTime"
},
"cancelState": {
"type": "string",
"description": "This value indicates the current state 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.
The full list of enumeration values that may get returned in this field are defined in the CancelStateEnum type definition."
},
"cancelStatus": {
"type": "string",
"description": "This value indicates the last action taken by one of the parties associated with the order cancellation request.
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.
The full list of enumeration values that may get returned in this field are defined in the CancelStatusEnum type definition."
},
"legacyOrderId": {
"type": "string",
"description": "A unique eBay-assigned ID for the order being considered for cancellation.
Note: The unique identifier of an order changes as the order goes from unpaid to paid, so the IDs for both unpaid and paid orders may be returned in this field based on payment status."
},
"marketplaceId": {
"type": "string",
"description": "A unique identifier for the eBay marketplace where the order cancellation request was created.
The full list of enumeration values that represent eBay marketplaces are defined in the MarketplaceIdEnum type definition."
},
"partialOrderType": {
"description": "This value indicates whether the cancellation request is for the entire order, or only for a subset of one or more line items in an order.
Currently, only full orders are eligible for cancellation, so the value returned here should be FULL_ORDER.",
"$ref": "#/components/schemas/PartialOrderTypeEnum"
},
"paymentStatus": {
"description": "The value returned in this field will indicate whether or not the buyer has paid for the order that is being cancelled or considered for cancellation.",
"$ref": "#/components/schemas/PaymentStatusEnum"
},
"payoutRecoupInfo": {
"description": "This container shows the payout ID and payout amount associated with a paid order that is being cancelled or considered for cancellation. It will not be returned for unpaid orders.
The payout amount data includes the sale price in the seller's currency, and if any currency conversion was necessary, it will also show the amount, currency, and exchange rate used for conversion.",
"$ref": "#/components/schemas/PayoutRecoupInfo"
},
"requestorType": {
"description": "The enumeration value returned here indicates who initiated the order cancellation request (either the buyer or seller).",
"$ref": "#/components/schemas/PartyEnum"
},
"requestRefundAmount": {
"description": "This container shows the amount of the refund that the buyer is expecting to receive if the order is successfully cancelled.
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.",
"$ref": "#/components/schemas/Amount"
},
"sellerLoginName": {
"type": "string",
"description": "The eBay username of the seller involved in the order cancellation request.
Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance. "
},
"sellerResponseDueDate": {
"description": "The timestamp in this container indicates the time by which the seller is required to respond to an active order cancellation request.
This container is not returned if the order cancellation request does not currently require a response from the seller.",
"$ref": "#/components/schemas/DateTime"
},
"shipmentDate": {
"description": "The timestamp in this container 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 order cancellation request to be granted.",
"$ref": "#/components/schemas/DateTime"
}
},
"description": "This type is used to provide a summary of information on each order cancellation request that is returned with a GET /post-order/v2/cancellation/search request."
},
"CaseCloseReasonEnum": {
"type": "object",
"description": "This enumeration type contains valid/applicable reasons indicating why a case was closed.",
"enum": [
"UNDEFINED",
"BUYER_CLOSE",
"SELLER_FULL_REFUND_PP",
"BUYER_CONFIRM_FULL_REFUND_PP",
"BUYER_CONFIRM_FULL_REFUND_NPP",
"SELLER_PARTIAL_REFUND_PP",
"BUYER_CONFIRM_PARTIAL_REFUND_PP",
"BUYER_CONFIRM_PARTIAL_REFUND_NPP",
"RETURN_TRACKING_DELIVERED",
"CLOSED_CS_CLOSE",
"AUTO_DISPOSE_BUYER_WIN_NO_SELLER_FAULT",
"AUTO_DISPOSE_SELLER_WIN_BUYER_FAULT",
"ESCALATE_CS_AUTO_DISPOSE_BUYER_WIN_SELLER_FAULT",
"ESCALATE_CS_AUTO_DISPOSE_SELLER_WIN_BUYER_FAULT",
"ESCALATE_CS_AUTO_DISPOSE_BUYER_WIN_SELLER_FAULT_NO_RECOUP",
"BUYER_WINS_SELLER_FAULT",
"BUYER_WINS_NO_SELLER_FAULT",
"SELLER_WINS_BUYER_FAULT",
"NO_SELLER_FAULT_BUYER_DESTROYS_ITEM",
"BUYER_WINS_DESTROY_ITEM",
"BUYER_WINS_NO_ITEM_RETURNS",
"BUYER_WINS_SELLER_FAULT_BUYER_RETURNS_ITEM",
"NO_SELLER_FAULT_BUYER_RETURNS_ITEM",
"AGENT_CLOSE_FOR_BUYER",
"AGENT_CLOSE_FOR_SELLER",
"AGENT_CLOSE_FOR_EBAY",
"EXPIRE_ENTER_TRACKING_AFTER_CS_DECISION",
"ITEM_DELIVERED_FOR_FORCED_RETURN",
"EXPIRE_AFTER_ENTER_TRACKING_FOR_FORCED_RETURN",
"BUYER_WINS_SELLER_FAULT_FOR_FORCED_RETURN",
"BUYER_WINS_NO_SELLER_FAULT_FOR_FORCED_RETURN",
"SELLER_WINS_BUYER_FAULT_FOR_FORCED_RETURN",
"BUYER_WINS_NO_SELLER_FAULT_PARTIAL_CREDIT",
"BUYER_REFUNDED",
"BUYER_WINS_SELLER_FAULT_NO_CREDIT",
"ESCALATE_CS_AUTO_DISPOSE_BUYER_WINS_NO_SELLER_FAULT_NO_CREDIT",
"ECHECK_TIMEOUT",
"PAYMENT_PROCESSOR_CLAIM_FILED",
"CLOSED_ON_CHARGEBACK_NOTIFICATION",
"CLOSED_ON_MONEY_MOVEMENT_AFTER_CHARGEBACK_NOTIFICATION",
"OTHER"
]
},
"CaseDetails": {
"type": "object",
"properties": {
"buyerFinalAcceptResolution": {
"type": "string",
"description": "This string value indicates what the buyer ultimately agreed to with the seller to resolve the case."
},
"buyerInitExpectResolution": {
"type": "string",
"description": "This string value indicates what the buyer initially agreed to with the seller to resolve the case."
},
"creationDate": {
"description": "The timestamp in this container indicates when the case was created.",
"$ref": "#/components/schemas/DateTime"
},
"escalationDate": {
"description": "The timestamp in this container indicates when the associated INR inquiry or return request was escalated into a case.",
"$ref": "#/components/schemas/DateTime"
},
"expirationDate": {
"description": "The timestamp in this container indicates when a case will expire naturally if a required response from the buyer or seller is not made.",
"$ref": "#/components/schemas/DateTime"
},
"lastBuyerRespDate": {
"description": "The timestamp in this container indicates when the buyer last responded to, or performed an action on the case. This field is only returned if the buyer has responded to and/or performed an action on the case.",
"$ref": "#/components/schemas/DateTime"
},
"lastSellerRespDate": {
"description": "The timestamp in this container indicates when the seller last responded to, or performed an action on the case. This field is only returned if the seller has responded to and/or performed an action on the case.",
"$ref": "#/components/schemas/DateTime"
},
"paypalPaid": {
"type": "boolean",
"description": "THIS FIELD IS DEPRECATED."
},
"refundAmounts": {
"description": "This container consists of details related to the expected and actual refund amounts. This container is only returned if a refund is scheduled to, or has been issued to the buyer.",
"$ref": "#/components/schemas/RefundAmounts"
},
"refundChargeAmount": {
"description": "This container shows the total amount charged to the seller for this refund. The value will be in the seller's default currency. This container is only applicable and returned if a refund has been issued to the buyer.",
"$ref": "#/components/schemas/Amount"
},
"refundDeadlineDate": {
"description": "The timestamp in this container indicates the latest date/time when the buyer is eligible for a refund.",
"$ref": "#/components/schemas/DateTime"
},
"refundType": {
"description": "This enumeration value indicates whether the buyer is scheduled to, or has already received a a full or partial refund. This field is only returned if a refund is scheduled to, or has been issued to the buyer.",
"$ref": "#/components/schemas/RefundType"
}
},
"description": "This type is used by the caseDetails container that is returned in the GET /post-order/v2/casemanagement/{caseId} method to provide detailed information about the case."
},
"CaseDetailsResponse": {
"type": "object",
"properties": {
"actionDeadlines": {
"description": "This container provides the number of remaining days that a buyer or seller has before being required to take action on an INR or Return case.",
"$ref": "#/components/schemas/ActionDeadlines"
},
"appealDetails": {
"description": "This container consists of information related to the appeal of a case decision. This container is only returned if the case decision was appealed by the buyer or seller.",
"$ref": "#/components/schemas/AppealDetails"
},
"buyerClosureReason": {
"type": "string",
"description": "This enumeration value indicates why the buyer chose to close the case. This field is only returned if the buyer closed the case, or if the case was closed on behalf of the buyer.
The list of enumeration values that may be returned in this field are defined in the CaseCloseReasonEnum type definition."
},
"buyerProtectedProgramLink": {
"type": "string",
"description": "This string value is the URL for the eBay Resolution Center."
},
"caseDetails": {
"description": "This container provides detailed information about the case.",
"$ref": "#/components/schemas/CaseDetails"
},
"caseHistoryDetails": {
"description": "This container provides detailed information about the history of the case, including each action that has been performed on the case.",
"$ref": "#/components/schemas/ClaimHistoryResponse"
},
"caseId": {
"type": "string",
"description": "The unique identifier of an INR or Return case."
},
"caseQuantity": {
"type": "integer",
"description": "This integer value indicates the quantity of the line item purchased by the buyer.",
"format": "int32"
},
"caseType": {
"description": "This enumeration type indicates if the case involves an item that has not been received by the buyer within the expected delivery window, or if the case involves a return request that has been escalated into a case by the buyer or seller after they were unable to come up with a return solution that would work for both parties.",
"$ref": "#/components/schemas/CaseTypeEnum"
},
"claimAmount": {
"description": "This container displays the dollar value of the case, which is generally the amount of the refund that the buyer will receive if the buyer wins the case, or if the seller voluntarily refunds the buyer.",
"$ref": "#/components/schemas/Amount"
},
"creationDate": {
"description": "The timestamp in this container indicates when the case was created.",
"$ref": "#/components/schemas/DateTime"
},
"escalatedBy": {
"description": "This enumeration value indicates the party that escalated the INR inquiry or return request into a case.",
"$ref": "#/components/schemas/UserPartyEnum"
},
"escalateReason": {
"type": "string",
"description": "Indicates why the buyer or seller escalated an INR inquiry or a return request into a case.
For an INR inquiry that was escalated, the applicable values are defined in the InquiryEscalationReasonEnum type definition. type.
For a return request that was escalated, the applicable values are defined in the EscalateReasonEnum type definition."
},
"eventTicketsLink": {
"type": "string",
"description": "This string value is the URL for the event tickets page, where electronic event tickets can be downloaded by the purchaser. This field is only returned if the case involves an event tickets order."
},
"extTransactionId": {
"type": "string",
"description": "This string value is the unique identifier of the payment transaction for the order. This field will only be returned if the payment transaction happened outside of eBay's system."
},
"fsnadDaysToAddTrackingAfterShippingItem": {
"type": "integer",
"description": "This integer value indicates the number of days that the buyer has to provide shipment tracking information for an item that is being returned to the seller.
This field is only returned for Return cases, and only if the buyer is being required to provide shipment tracking information for the item being returned.",
"format": "int32"
},
"fsnadShipToSellerByDate": {
"description": "The timestamp in this container indicates the deadline when the buyer must ship the return item back to the seller. This container is only returned for Return cases, and only if the buyer has yet to ship the return item, or has not provided proof that the item has been shipped.",
"$ref": "#/components/schemas/DateTime"
},
"initiator": {
"description": "This enumeration value indicates whether the buyer or the seller initiated the INR inquiry or Return request that has been escalated to a case. This value will usually be BUYER.",
"$ref": "#/components/schemas/UserPartyEnum"
},
"caseContentOnHold": {
"type": "boolean",
"description": "This field indicates the item content related to the case is hidden (the respective content is not returned). This field is returned as 'true' if the corresponding case content is on hold due to eBay policy violation; false otherwise."
},
"itemId": {
"type": "string",
"description": "The unique identifier of the eBay listing where the line item was purchased. This field is used in conjunction with the transactionId field to identify a line item that is associated with the case."
},
"itemOnHold": {
"type": "boolean",
"description": "This field indicates the item related to the case is hidden (the respective content is not returned). This field is returned as 'true' if the corresponding item is on hold due to eBay policy violation; false otherwise."
},
"lastModifiedDate": {
"description": "The timestamp in this container indicates when the last action was performed on the case.",
"$ref": "#/components/schemas/DateTime"
},
"payForItemLink": {
"type": "string",
"description": "This string value is the URL for the purchase item page. This field will be returned if available/applicable."
},
"priceSignatureConfirmationAmount": {
"type": "string",
"description": "This string value indicates the dollar value threshold for the signature confirmation add-on. The buyer must purchase the signature confirmation add-on for high-value items at or above this dollar value."
},
"recalledItemLink": {
"type": "string",
"description": "This string is the URL for the recalled item page. This field will be returned if available/applicable."
},
"returnDetails": {
"description": "This container consists of information related to a buyer returning a line item to the seller, and includes the seller's return address and the RMA number (if applicable).
This container is only returned if the case type is a Return.",
"$ref": "#/components/schemas/ReturnAddress"
},
"returnId": {
"type": "string",
"description": "The unique identifier of a return. This field is only returned if the case type is a Return."
},
"sellerClosureReason": {
"type": "string",
"description": "This enumeration value indicates why the seller chose to close the case. This field is only returned if the seller closed the case, or if the case was closed on behalf of the seller.
The list of enumeration values that may be returned in this field are defined in the CaseCloseReasonEnum type definition."
},
"shippingFee": {
"description": "This container displays the expected return shipping fees. Depending on the case type and the details of the case type, the return shipping fees may be paid by the buyer or the seller. amount that the buyer
This container is only returned if the case is expected to involve the buyer returning the item to the seller.",
"$ref": "#/components/schemas/Amount"
},
"status": {
"type": "string",
"description": "This enumeration value indicates the current status of the case.
The list of enumeration values that may be returned in this field are defined in the CaseStatusEnum type definition."
},
"transactionId": {
"type": "string",
"description": "The unique identifier of the purchase transaction. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify the line item that is associated with the case."
}
},
"description": "The base response type for the GET /post-order/v2/casemanagement/{caseId} method. This type contains detailed information about an INR or Return case."
},
"CaseSearchFieldGroupEnum": {
"type": "object",
"description": "This enumerated type lists the values that can be used in the fieldGroups query parameter of the GET /post-order/v2/casemanagement/search request.
Note: Using the fieldGroups query parameter is not recommended at this time, since only the DEFAULT value is supported, and this is the default value that is used if the fieldGroups query parameter is not used. A 'summary-level' resonse may be supported in the future.",
"enum": [
"DEFAULT",
"SUMMARY"
]
},
"CaseSearchResponse": {
"type": "object",
"properties": {
"members": {
"type": "array",
"description": "An array of one or more cases that match the filter criteria in request.",
"items": {
"$ref": "#/components/schemas/CaseSummaryType"
}
},
"paginationOutput": {
"description": "This container consists of metadata related to the current page of results. It shows the total number of cases that match the filter criteria, the total number of cases to show per page of results, and the total number of pages in the results set.",
"$ref": "#/components/schemas/PaginationOutput"
},
"totalNumberOfCases": {
"type": "integer",
"description": "This integer value indicates the total number of cases that were found based on the input filter(s) in the request.",
"format": "int32"
}
},
"description": "The base response type of the GET /post-order/v2/casemanagement/search method, which is used to retrieve cases based on filter criteria in the request."
},
"CaseStatusEnum": {
"type": "object",
"description": "This enumerated type contains a list of values that indicate the current status of a case, an action that just occurred on a case, or an action that needs to occur next during the life of a case.",
"enum": [
"WAITING_DELIVERY",
"WAITING_CS",
"OPEN",
"ON_HOLD",
"REFUND_AGREED_BUT_FAILED",
"CLOSED",
"CS_CLOSED",
"OTHER"
]
},
"CaseStatusFilter": {
"type": "object",
"description": "This enumerated type lists the possible states of a case. These values can be used in the case_status_filter query parameter of the GET /post-order/v2/casemanagement/search request if the user wants to retrieve cases in a specific state.",
"enum": [
"WAITING_DELIVERY",
"WAITING_CS",
"OPEN",
"ON_HOLD",
"REFUND_AGREED_BUT_FAILED",
"CLOSED",
"CS_CLOSED",
"OTHER"
]
},
"CaseSummaryType": {
"type": "object",
"properties": {
"buyer": {
"type": "string",
"description": "The eBay user ID of the buyer involved in the case.
Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance. "
},
"caseId": {
"type": "integer",
"description": "The unique identifier of the case.",
"format": "int32"
},
"caseStatusEnum": {
"type": "string",
"description": "This enumeration value indicates the current status of the case.
The list of enumeration values that may be returned in this field are defined in the CaseStatusEnum type definition."
},
"claimAmount": {
"description": "This container displays the dollar value of the order line item associated with the case, which is generally the amount of the refund that the buyer will receive if the buyer is looking for a refund, or if the seller voluntarily refunds the buyer.",
"$ref": "#/components/schemas/Amount"
},
"creationDate": {
"description": "The timestamp in this container indicates when the case was created.",
"$ref": "#/components/schemas/DateTime"
},
"itemId": {
"type": "integer",
"description": "The unique identifier of the eBay listing where the line item was purchased. This field is used in conjunction with the transactionId field to identify a line item that is associated with the case.",
"format": "int32"
},
"lastModifiedDate": {
"description": "The timestamp in this container indicates when the last action was performed on the case.",
"$ref": "#/components/schemas/DateTime"
},
"respondByDate": {
"description": "The timestamp in this container indicates the deadline for when a buyer or seller must perform the next action on the case. This field will only be returned if there is a deadline associated with the next action.",
"$ref": "#/components/schemas/DateTime"
},
"seller": {
"type": "string",
"description": "The eBay user ID of the seller involved in the case.
Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance. "
},
"transactionId": {
"type": "integer",
"description": "The unique identifier of the purchase transaction. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify the line item that is associated with the case.",
"format": "int32"
}
},
"description": "This type is used to provide a summary of information on each case that is returned in the GET /post-order/v2/casemanagement/search response."
},
"CaseTypeEnum": {
"type": "object",
"description": "This enumeration type lists the types of cases that may be created by the buyer or seller.",
"enum": [
"ITEM_NOT_RECEIVED",
"RETURN"
]
},
"CaseVoluntaryRefundRequest": {
"type": "object",
"properties": {
"comments": {
"description": "This container is used if the seller wants to add a note or explanation about the refund being issued.",
"$ref": "#/components/schemas/Text"
}
},
"description": "This type is used if the seller would like to provide a comment when voluntarily issuing a refund through the POST /post-order/v2/casemanagement/{caseId}/issue_refund request."
},
"ClaimHistoryEventModel": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "This string value indicates the action initiated by one of the parties involved with the INR inquiry or case."
},
"actor": {
"description": "This enumeration value indicates the party that took this action.",
"$ref": "#/components/schemas/UserPartyEnum"
},
"date": {
"description": "The timestamp in this container indicates the date and time of this event or action.",
"$ref": "#/components/schemas/DateTime"
},
"description": {
"type": "string",
"description": "A text-based description of this event or action. This field is returned if available."
},
"moneyMovement": {
"description": "This container provides details on one or more monetary transactions that were involved with the event or action. This container is not returned if no monetary transaction was involved with the event or action.",
"$ref": "#/components/schemas/MoneyMovementEntries"
}
},
"description": "This type is used to provide information about each event or action that has occurred with a particular INR inquiry or case."
},
"ClaimHistoryResponse": {
"type": "object",
"properties": {
"history": {
"type": "array",
"description": "This array contains one or more events or actions associated with an INR inquiry or a case.",
"items": {
"$ref": "#/components/schemas/ClaimHistoryEventModel"
}
},
"shipmentTrackingDetails": {
"description": "This container will show detailed shipment tracking information if an INR item is being shipped to the buyer, or if the buyer is returning an item to the seller. This container is only returned if shipment tracking is currently relevant to the inquiry or case.",
"$ref": "#/components/schemas/ShipmentTrackingDetailType"
}
},
"description": "This type is used to provide the history of events associated with an INR inquiry or a case."
},
"CloseReturnReasonEnum": {
"type": "object",
"description": "This enumerated type lists all possible reasons why a return request is closed. A buyer would typically close a return request after they receive a refund or if they initiated the return request by mistake.",
"enum": [
"BUYER_CLOSED",
"FULL_REFUNDED",
"FULL_REFUNDED_BY_DISPOSITION_RULE",
"PARTIALLY_REFUNDED",
"SHIPMENT_TIMEOUT",
"REFUND_TIMEOUT",
"RETURN_REJECTED",
"AUTO_REFUNDED",
"AUTO_PARTIAL_REFUNDED",
"STORE_CREDIT_REFUNDED",
"BUYER_PAYOUT",
"SELLER_INVOICED",
"REPLACEMENT_PAYOUT_RECOUP",
"REQUEST_TIMEOUT",
"REQUEST_DECLINED",
"SELLER_PAYOUT_FAILED",
"BUYER_PAYOUT_FAILED",
"REPLACED",
"MARK_REFUND_RECEIVED",
"MARK_REFUND_RECEIVED_TIMEOUT",
"MARK_PARTIAL_REFUND_RECEIVED",
"BUYER_NO_ACTION",
"ESCALATED",
"LVT_IMMEDIATE_REFUND",
"BUYER_REFUND_AS_PAYOUT",
"BUYER_PARTIAL_REFUND_AS_PAYOUT",
"CHARGEBACK_DISPUTE_FILED",
"BUYER_ACCEPT_LESS_THAN_FULL_REFUND",
"BUYER_ACCEPT_LESS_THAN_FULL_REFUND_AS_PAYOUT",
"ITEM_REJECTED",
"OTHER"
]
},
"ConfirmRefundRequest": {
"type": "object",
"properties": {
"refundDate": {
"description": "A timestamp is supplied here to indicate the date and time when the buyer received a refund. This container is conditionally required if the buyer has received a refund.",
"$ref": "#/components/schemas/DateTime"
},
"unpaidOrder": {
"type": "boolean",
"description": "This boolean field is supplied here and set to true to indicate that the buyer never paid for the order that is being cancelled, so the buyer is not eligible for a refund."
}
},
"description": "The base request type for the POST /post-order/v2/cancellation/{cancelId}/confirm method."
},
"CountSummaryType": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "This integer value indicates how many return requests in the return state indicated by the corresponding type value were returned in the results.",
"format": "int32"
},
"type": {
"description": "This enumeration value indicates the return request status that is being counted through the corresponding count field. Return request states include ALL_OPEN, CLOSED, ITEM_SHIPPED, or ITEM_DELIVERED. For a complete list of values and their descriptions, see the ReturnCountFilterEnum type definition.",
"$ref": "#/components/schemas/ReturnCountFilterEnum"
}
},
"description": "This type is used by the countSummary container, which holds a count of return requests in different states, such as ALL_OPEN, CLOSED, ITEM_SHIPPED, or ITEM_DELIVERED. The return request states that are returned depends on which returnState values (if any) were passed in as query parameters in the GET /post-order/v2/return/search request. If no returnState query parameter is used, the default behavior is for the GET /post-order/v2/return/search method to return only those return requests in the 'ALL_OPEN' state."
},
"CountryCodeEnum": {
"type": "object",
"description": "This enumerated type lists the two-letter ISO 3166-1 Alpha-2 code representing a country.",
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AN",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
]
},
"CreateCancelRequest": {
"type": "object",
"properties": {
"buyerPaid": {
"type": "boolean",
"description": "This field should be included and set to true if the buyer has paid for the order, and is eligible for a refund if the cancellation request is approved by the seller. If the buyer has paid for the order, the payment date should also be included in the buyerPaidDate field.
If the buyer has not paid for an order, this field should be included and set to false. In this case, the buyer is not eligible for a refund even if the cancellation request is approved by the seller."
},
"buyerPaidDate": {
"description": "The timestamp in this container indicates that the buyer paid for the order. If the buyer has not paid for the order, this container is not applicable.",
"$ref": "#/components/schemas/DateTime"
},
"cancelReason": {
"type": "string",
"description": "This field is used to indicate the reason why the buyer or seller wants to cancel the order. One of the enumeration values defined in the CancelReasonEnum type definition must be used in this field. The descriptions for each enumeration value in that type definition will indicate whether the cancel reason is intended for the buyer or seller.
Although not required, it is highly recommended that a cancel reason is provided."
},
"legacyOrderId": {
"type": "string",
"description": "A unique eBay-assigned ID for the order being considered for cancellation.
Note: The unique identifier of an order changes as the order goes from unpaid to paid, so the IDs for both unpaid and paid orders are supported in this field. For orders where payment has been made, the ID for the paid order should be used."
},
"relistLineItem": {
"type": "array",
"description": "This array can be used for seller-initiated order cancellation requests if the seller wishes to relist one or more line items that are a part of the order being cancelled. Once the order cancellation is successfully processed by eBay, the line item(s) will be relisted automatically.",
"items": {
"$ref": "#/components/schemas/RelistLineItem"
}
}
},
"description": "This is the base request type for the POST /post-order/v2/cancellation method, which is used to create an order cancellation request."
},
"CreateCancelResponse": {
"type": "object",
"properties": {
"cancelId": {
"type": "string",
"description": "The unique eBay-assigned ID for the order cancellation request. This field is returned unless the order is not eligible for cancellation, or if an error is triggered with the POST /post-order/v2/cancellation request."
},
"orderEligibilityResult": {
"description": "This container indicates whether or not the order is eligible to be cancelled. Cancellation eligibility for each line item in the order is returned in a separate itemEligibilityResult container.",
"$ref": "#/components/schemas/OrderEligibilityResult"
},
"warnings": {
"type": "array",
"description": "This array is returned if the POST /post-order/v2/cancellation request triggers any errors or warnings.",
"items": {
"$ref": "#/components/schemas/ErrorData"
}
}
},
"description": "Base response type of the POST /post-order/v2/cancellation method."
},
"CreateInquiryRequest": {
"type": "object",
"properties": {
"claimQuantity": {
"type": "integer",
"description": "This integer is the quantity of the line item purchased by the buyer. This value will usually be 1 unless the buyer purchased multiple quantity of a line item in a multiple-quantity, fixed-priced listing.
If this field is omitted, its value defaults to 1.",
"format": "int32"
},
"comments": {
"description": "This container can be used if the buyer wants to provide more information about initiating the INR inquiry.",
"$ref": "#/components/schemas/Text"
},
"desiredOutcome": {
"description": "This field is used to indicate whether the buyer still wants the item (STILL_WANT_ITEM is passed in), or whether the buyer is now looking to receive a full refund (FULL_REFUND is passed in) for the line item even if it received by the buyer.
If this field is omitted, the desiredOutcome value defaults to STILL_WANT_ITEM.",
"$ref": "#/components/schemas/DesiredOutcomeTypeEnum"
},
"itemId": {
"type": "string",
"description": "The unique identifier of the eBay listing where the line item was purchased. This field and the transactionId field are required in order to identify the line item for which an INR inquiry will be created."
},
"transactionId": {
"type": "string",
"description": "The unique identifier for the purchase of a item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field and the itemId field are required in order to identify the line item for which an INR inquiry will be created."
}
},
"description": "The base request type of the POST /post-order/v2/inquiry method, which is used to create an Item Not Received (INR) inquiry on behalf of the buyer."
},
"CreateReturnRequest": {
"type": "object",
"properties": {
"draftId": {
"type": "string",
"description": "The unique eBay-assigned ID of a return request draft. This field is only applicable (and required) if the buyer is converting a return request draft into an actual return request with the POST /post-order/v2/return method."
},
"returnRequest": {
"description": "This container is used to provide details about the buyer's return request, including the order line item (and quantity) that is being returned or the reason for the return.",
"$ref": "#/components/schemas/ReturnRequestType"
}
},
"description": "The base request type of the POST /post-order/v2/return method, which allows you to create a return request from scratch or to convert a return request draft into a return request."
},
"CreateReturnResponse": {
"type": "object",
"properties": {
"detail": {
"description": "This container consists of detailed information on the return request. This container will not be returned if the fieldGroups query parameter is used and its value is set to SUMMARY or NONE.",
"$ref": "#/components/schemas/GetDetailResponse"
},
"eligibilityResult": {
"description": "This container consists of information on the return item and the results for each eligibility check type that was run against the order line item.",
"$ref": "#/components/schemas/ReturnEligibilityPerItemType"
},
"returnId": {
"type": "string",
"description": "The unique eBay-assigned ID of the newly created return request. This field is only returned if the return request was successfully created."
},
"summary": {
"description": "This container consists of summarized information on the return item. This container will not be returned if the fieldGroups query parameter is used and its value is set to FULL or NONE.",
"$ref": "#/components/schemas/ReturnSummaryType"
}
},
"description": "The base response type of the POST /post-order/v2/return/create method, which is used to create a return request."
},
"CurrencyCodeEnum": {
"type": "object",
"description": "This enumerated type lists the three-letter ISO 4217 codes representing the supported world currencies.",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTN",
"BWP",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"STD",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW",
"ZWL"
]
},
"DateTime": {
"type": "object",
"properties": {
"formattedValue": {
"type": "string",
"description": "Reserved for future use. "
},
"value": {
"type": "string",
"description": "This timestamp indicates the date and time when an action or event occurred.
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: 2022-03-20T00:00:00.000Z"
}
},
"description": "This type is used by all fields that require a timestamp, both in UTC and as a formatted value."
},
"DecideReturnRequest": {
"type": "object",
"properties": {
"comments": {
"description": "This container is used by the seller or buyer to provide more information about the action that is being performed with the decide method.",
"$ref": "#/components/schemas/Text"
},
"decision": {
"description": "This field must be included in each request, and the value that is supplied here will depend on whether the seller or the buyer is using this method, and it will also depend on the current state of the return request. The POST /post-order/v2/return/{returnId}/decide request will fail unless an appropriate value is specified in this field.
Sellers can use this method to approve or decline a return request, offer a partial refund to the buyer, or provide a Return Merchandise Authorization (RMA) number to the buyer.
Buyers can use this method to accept or decline a partial refund offer.",
"$ref": "#/components/schemas/DecisionEnum"
},
"keepOriginalItem": {
"type": "boolean",
"description": "The seller can include this field and set it to true if they are OK with the buyer keeping the original item they received, and not requiring them to return the item. A seller may choose to do this in the case of a SNAD item or if the buyer is claiming that the item arrived damaged or was missing parts.
Default: false"
},
"partialRefundAmount": {
"description": "This container is conditionally required if the seller is using the decide method to offer a partial refund amount to the buyer in order to settle the return request. This amount is the amount the seller is willing to offer the buyer as a partial refund. This field has no relevance if anything other than OFFER_PARTIAL_REFUND is passed in the decision field.",
"$ref": "#/components/schemas/Amount"
},
"RMANumber": {
"type": "string",
"description": "This field is conditionally required if the seller is using the POST /post-order/v2/return/{returnId}/decide method to provide a return merchandise authorization (RMA) to the buyer. The RMA value cannot be validated by eBay, so the seller should pay close attention to ensure that the RMA is accurate. If an RMA is provided in this field, the decision value should be PROVIDE_RMA."
},
"rMAProvided": {
"type": "boolean",
"description": "If set to true, it indicates that the seller provided an RMA number to the buyer for processing of the return.
Default: false"
}
},
"description": "The base request type of the POST /post-order/v2/return/{returnId}/decide method."
},
"DecideReturnResponse": {
"type": "object",
"properties": {
"refundStatus": {
"description": "This field is only returned in the response if a refund has been requested or initiated. The value in this field indicates the status of any refund action initiated through the POST /post-order/v2/return/{returnId}/decide request.",
"$ref": "#/components/schemas/Refund_MoneyMovementStatusEnum"
}
},
"description": "The base response type of the POST /post-order/v2/return/{returnId}/decide method."
},
"DecisionEnum": {
"type": "object",
"description": "This enumerated type lists all values that can be passed in the decision field of the POST /post-order/v2/return/{returnId}/decide request. With the values supported in the decision field, the seller can offer the return option to the buyer, approve or decline a return request, offer a partial refund to the buyer, or provide a Return Merchandise Authorization (RMA) number to the buyer. There are only a few supported values for a buyer, and these are discussed in the descriptions below.",
"enum": [
"PROVIDE_RMA",
"APPROVE",
"APPROVE_WITHOUT_EBAY_LABEL",
"DECLINE",
"OFFER_RETURN",
"OFFER_RETURN_WITHOUT_LABEL",
"OFFER_PARTIAL_REFUND",
"ACCEPT_PARTIAL_REFUND",
"DECLINE_PARTIAL_REFUND",
"OFFER_REPLACEMENT",
"ACCEPT_REPLACEMENT_OFFER",
"DECLINE_REPLACEMENT_OFFER",
"UNKNOWN"
]
},
"DesiredOutcomeTypeEnum": {
"type": "object",
"description": "This enumerated type lists the desired outcomes that the buyer may specify when creating an INR inquiry.",
"enum": [
"FULL_REFUND",
"STILL_WANT_ITEM"
]
},
"EligibilityErrorType": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "A unique eBay-assigned ID of the error."
},
"content": {
"type": "string",
"description": "The actual content of the eligibility error."
},
"description": {
"type": "string",
"description": "A description of the error."
}
},
"description": "This type is used by the eligibilityError container, which shows information related to an error that may have occurred with an eligibility check operation."
},
"EligibilityFailureReasonEnum": {
"type": "object",
"description": "An enumerated type that defines the different reasons why an order, or an individual line item within an order is not eligible to be cancelled.",
"enum": [
"UNKNOWN",
"INSTORE_PICKUP_MADE",
"IN_STORE_PICKUP_READY",
"UNPAID_ORDER",
"UNSUPPORTED_PAYMENT_METHOD",
"CANCELLATION_EXIST",
"CASE_EXIST",
"RETURN_EXIST",
"PAYPAL_DISPUTE_EXIST",
"FULL_REFUNDED_ORDER",
"PARTIAL_REFUNDED_ORDER",
"CROSS_SITE_ORDER",
"SHIPPED_ORDER",
"CANCEL_WINDOW_ELAPSED",
"ELV_RETURN_OR_REVERSAL_EXISTS",
"DELETED_BUYER",
"PAYMENT_PENDING",
"CHARGEBACK_OPENED",
"PARTIAL_CANCEL_NOT_ALLOWED",
"PARTIAL_QUANTITY_NOT_ALLOWED",
"REQUESTED_QUANTITY_NOT_AVAILABLE",
"ITEM_LEVEL_ELIGIBILITY_FAILURE",
"INVALID_LINEITEM",
"DUPLICATE_LINEITEM",
"FULL_REFUNDED_LINEITEM",
"INTERNAL_SYSTEM_ERROR",
"INVALID_ORDER",
"INVALID_USER",
"UNSUPPORTED_SITE"
]
},
"EligibilityResultType": {
"type": "object",
"properties": {
"caseId": {
"type": "string",
"description": "This value is the unique eBay-assigned ID of an eBay case associated with the return request. This field is only returned if the return request was escalated into an eBay case."
},
"eligibilityErrorDetail": {
"type": "array",
"description": "This array may consist of one or more errors that may have occurred with the return eligibility check. This array is only returned if one or more return eligibility check errors occurred.",
"items": {
"$ref": "#/components/schemas/ReturnEligibilityErrorDetailType"
}
},
"eligibilityStatus": {
"description": "This enumeration value indicates the success or failure of a return eligibility check. See StatusType for the description of the supported values.",
"$ref": "#/components/schemas/StatusType"
},
"eligibleStartDate": {
"description": "The timestamp in this container indicates when the buyer is first eligible to create a return request for a item. This field is not returned if the buyer is not eligible to return the item.",
"$ref": "#/components/schemas/DateTime"
},
"returnCreationDate": {
"description": "The timestamp in this container indicates the date/time when the return request was created. This field is only returned if a return request was successfully created. ",
"$ref": "#/components/schemas/DateTime"
},
"returnDeadline": {
"description": "The timestamp in this container indicates the deadline for which the buyer must file a return request.",
"$ref": "#/components/schemas/DateTime"
},
"returnId": {
"type": "string",
"description": "The unique eBay-assigned ID of the newly-created return request. This field is only returned if a return request was successfully created."
}
},
"description": "This type is used by the eligibilityInfo container, which includes the results of the return eligibility check, including any errors that may have occurred with the eligibility check."
},
"Error": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Identifies the type of erro."
},
"domain": {
"type": "string",
"description": "Name for the primary system where the error occurred. This is relevant for application errors."
},
"errorId": {
"type": "integer",
"description": "A unique number to identify the error.",
"format": "int32"
},
"inputRefIds": {
"type": "array",
"description": "An array of request elements most closely associated to the error.",
"items": {
"type": "string"
}
},
"longMessage": {
"type": "string",
"description": "A more detailed explanation of the error."
},
"message": {
"type": "string",
"description": "Information on how to correct the problem, in the end user's terms and language where applicable."
},
"outputRefIds": {
"type": "array",
"description": "An array of request elements most closely associated to the error.",
"items": {
"type": "string"
}
},
"parameters": {
"type": "array",
"description": "An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.",
"items": {
"$ref": "#/components/schemas/ErrorParameter"
}
},
"subdomain": {
"type": "string",
"description": "Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc."
}
},
"description": "This type defines the fields that can be returned in an error."
},
"ErrorCategory": {
"type": "object",
"description": "An enumerated type that defines the possible categories to which an error can be attributed.",
"enum": [
"SYSTEM",
"APPLICATION",
"REQUEST"
]
},
"ErrorData": {
"type": "object",
"properties": {
"category": {
"description": "The category type for this error or warning.
The value returned in this field will be one of the values defined in the ErrorCategory type, and these values are discussed below.",
"$ref": "#/components/schemas/ErrorCategory"
},
"domain": {
"type": "string",
"description": "Name of the domain, primary system or service, or application where the error occurred."
},
"errorId": {
"type": "integer",
"description": "A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
Error messages and their corresponding IDs can be found on the Errors by Number page.",
"format": "int32"
},
"httpStatusCode": {
"type": "integer",
"description": "The HTTP status code that resulted from the request.",
"format": "int32"
},
"longMessage": {
"type": "string",
"description": "A more detailed explanation of the error than given in the message error field."
},
"message": {
"type": "string",
"description": "Information on how to correct the problem, where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the locale of the request."
},
"parameter": {
"type": "array",
"description": "This optional list of name/value pairs that contain context-specific ErrorParameter objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value.",
"items": {
"$ref": "#/components/schemas/ErrorParameter"
}
},
"severity": {
"description": "The severity can be either a WARNING or an ERROR, where a warning does not stop the processing of the request while an error does.
While you must fix errors before the service will process your request, you should also fix all warnings to ensure your application runs as designed.",
"$ref": "#/components/schemas/ErrorSeverity"
}
},
"description": "This type is used to show any errors or warnings that were triggered by the request."
},
"ErrorParameter": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The object of the error."
},
"value": {
"type": "string",
"description": "The value of the object."
}
}
},
"ErrorSeverity": {
"type": "object",
"description": "This enumeration type defines the different error severity levels.",
"enum": [
"ERROR",
"WARNING"
]
},
"EscalateInquiryRequest": {
"type": "object",
"properties": {
"comments": {
"description": "The buyer or seller escalating the INR inquiry is required to use this container to provide more details about why the INR inquiry is being escalated to a case.",
"$ref": "#/components/schemas/Text"
},
"escalateInquiryReason": {
"type": "string",
"description": "This field is used to specify the reason why the buyer or seller is escalating the specified INR inquiry into a case.
One of the enumeration values defined in the InquiryEscalationReasonEnum type definition must be used here. Some values are only applicable to the buyer escalating the inquiry, some values are only applicable to the seller escalating the inquiry, and some values are relevant to either party."
}
},
"description": "This is the base request type of the POST /post-order/v2/inquiry/{inquiryId}/escalate method, which is used to escalate an INR inquiry into a case."
},
"EscalateReasonEnum": {
"type": "object",
"description": "This enumerated type lists the values that can be used by a buyer or seller as a reason to escalate a return request to a return case.",
"enum": [
"SELLER_NO_RESPONSE",
"TROUBLE_COMMUNICATION_WITH_SELLER",
"TROUBLE_COMMUNICATION_WITH_BUYER",
"NO_REFUND_RECEIVED",
"NO_REFUND_FOR_RETURN_SHIPPING",
"BUYER_RETURNED_WRONG_ITEM",
"BUYER_NORESPONSE",
"DISAGREE_WITH_RETURN_REASON",
"ITEM_RECEIVED_IN_DIFFERENT_CONDITION",
"ITEM_NOT_RECEIVED",
"NEW_ITEM_NOT_RECEIVED",
"RECEIVED_WRONG_ITEM",
"RECEIVED_EMPTY_BOX",
"RESOLVED_WITH_BUYER",
"RECEIVED_DAMAGED_ITEM",
"ESCALATED_BY_EBAY",
"OTHER"
]
},
"EscalateRequest": {
"type": "object",
"properties": {
"comments": {
"description": "This container is used if the buyer or seller wants to add a note or explanation about why the return request is being escalated to a case.",
"$ref": "#/components/schemas/Text"
},
"reason": {
"type": "string",
"description": "This field is used to specify the reason why the buyer or seller is escalating the specified return request into a case.
One of the enumeration values defined in the EscalateReasonEnum type definition must be used here. Some values are only applicable to the buyer escalating the return request, some values are only applicable to the seller escalating the return request, and some values are relevant to either party.
Although this field is not required, it is recommended that it is used by the buyer or seller."
}
},
"description": "The base request type of the POST /post-order/v2/return/{returnId}/escalate method, which is used to escalate a return request to a case."
},
"EscalateResponse": {
"type": "object",
"properties": {
"caseId": {
"type": "string",
"description": "This is unique eBay-assigned ID of the new case that was created after the return request was escalated to customer support. This field is only returned if the return request was successfully escalated to a return case."
},
"caseUrl": {
"type": "string",
"description": "This is the URL to the eBay page where more details on the case can be viewed. This field is only returned if the return request was successfully escalated to a return case."
}
},
"description": "The base response type of the POST /post-order/v2/return/{returnId}/escalate method."
},
"EscalationEligibilityInfo": {
"type": "object",
"properties": {
"eligible": {
"type": "boolean",
"description": "This boolean value indicates whether or not the buyer or seller is eligible to escalate the return request to a case. If the value is true, the time window in which the buyer or seller can escalate the case is found in the startTime and endTime containers."
},
"endTime": {
"description": "The timestamp in this container provides the deadline in which the buyer or seller may escalate the return request to a case. As soon as this time expires, the buyer or seller may no longer escalate the return request to a case. This field will not be returned if the value of the eligible field is false.",
"$ref": "#/components/schemas/DateTime"
},
"startTime": {
"description": "The timestamp in this container provides the earliest date in which the buyer or seller may escalate the return request to a case. As soon as this time arrives, up until the time shown in the end field, the buyer or seller is eligible to escalate the return request to a case. This field will not be returned if the value of the eligible field is false.",
"$ref": "#/components/schemas/DateTime"
}
},
"description": "This type is used to indicate if the buyer or seller is eligible to escalate a return request to a case."
},
"EscalationInfoType": {
"type": "object",
"properties": {
"buyerEscalationEligibilityInfo": {
"description": "This container indicates if the buyer is eligible to escalate the return request into a return case. If the buyer is eligible to escalate the return request into a return case, the time window during which this buyer must perform this action is returned under this container.",
"$ref": "#/components/schemas/EscalationEligibilityInfo"
},
"caseId": {
"type": "string",
"description": "The unique eBay-assigned ID of an eBay case. This field will only be returned if the return request was successfully escalated to a return case."
},
"sellerEscalationEligibilityInfo": {
"description": "This container indicates if the seller is eligible to escalate the return request into a return case. If the seller is eligible to escalate the return request into a return case, the time window during which this seller must perform this action is returned under this container.",
"$ref": "#/components/schemas/EscalationEligibilityInfo"
}
},
"description": "This type is used by the escalationInfo container, which contains information related to the buyer's and seller's eligibility to escalate a return request to a case."
},
"EstimatedRefundDetailType": {
"type": "object",
"properties": {
"itemizedRefundDetails": {
"type": "array",
"description": "This array shows the estimated amounts for one or more refunds that the seller may have to issue to a buyer in a return request.",
"items": {
"$ref": "#/components/schemas/EstimatedRefundType"
}
},
"optionalRefundLineItems": {
"type": "array",
"description": "This array shows the different refund types and associated costs that the seller can voluntarily issue to the buyer at his/her discretion. The seller is not obligated to issue any of the refund types in this array, but might do so as a matter of good customer service.",
"items": {
"$ref": "#/components/schemas/EstimatedRefundType"
}
}
},
"description": "This type is used by the estimatedRefundDetail container, which shows estimated refund information before the seller issues any refunds to the buyer."
},
"EstimatedRefundType": {
"type": "object",
"properties": {
"estimatedAmount": {
"description": "This container shows the estimated amount of the refund.",
"$ref": "#/components/schemas/Amount"
},
"maxAmount": {
"description": "This container shows the maximum amount that the refund could be based on the cost of the order.",
"$ref": "#/components/schemas/Amount"
},
"minAmount": {
"description": "This container shows the minimum amount that the refund could be based on the cost of the order.",
"$ref": "#/components/schemas/Amount"
},
"purchasePriceDeductedPercentageList": {
"type": "array",
"description": "This array shows one or more percentage values, and these values indicate the percentage value(s) deducted off of the purchase price.",
"items": {
"type": "integer"
}
},
"refundFeeType": {
"description": "This enumerated value indicates the type of refund. When issuing a refund through the POST /post-order/v2/return/{returnId}/issue_refund method, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, one for original shipping, and one for a restocking fee (if applicable).",
"$ref": "#/components/schemas/RefundFeeTypeEnum"
},
"restockingFeePercentage": {
"type": "string",
"description": "THIS FIELD IS DEPRECATED."
}
},
"description": "This type is used by the estimatedRefundDetail.itemizedRefundDetail container, which shows the estimated refund information before the seller issues a refund to the buyer. Once the refund is actually successfully processed, information on the refund may be seen in the actualRefundDetail container."
},
"FileFormatEnum": {
"type": "object",
"description": "This enumerated type lists the file types that can be used for files that are associated with a return request or return request draft.",
"enum": [
"JPG",
"JPEG",
"PNG",
"GIF",
"BMP",
"UNKNOWN"
]
},
"FileStatusEnum": {
"type": "object",
"description": "This enumerated type contains the possible states that a return-associated file can be in.",
"enum": [
"CREATED",
"PUBLISHED",
"DELETED",
"UNKNOWN"
]
},
"FindCancelResponse": {
"type": "object",
"properties": {
"cancellations": {
"type": "array",
"description": "An array of one or more order cancellation requests that match the request criteria.
This array is returned as empty if no order cancellation requests match the input criteria.",
"items": {
"$ref": "#/components/schemas/CancelSummary"
}
},
"paginationOutput": {
"description": "The result set from this method is paginated because the request can result in a large number of matches. This container consists of metadata related to the current response page.
It contains the page number and the cancellation entries per page, as well as the total amount of response pages and cancellation entries. This container is not returned if no cancellation requests match the input criteria.",
"$ref": "#/components/schemas/PaginationOutput"
},
"total": {
"type": "integer",
"description": "The total number of cancellation requests that match the input criteria. A value of 0 is returned if no cancellation requests match the input criteria.",
"format": "int32"
}
},
"description": "The base response type of the GET /post-order/v2/cancellation/search method. This response returns information about an order cancellation request.
The order cancellation request(s) returned are the ones that match the filter criteria passed in the query parameter(s) of the request."
},
"FundingMethodBrandEnum": {
"type": "object",
"description": "This enumeration type lists the possible credit card brands that can be used by eBay to fund a seller's refund to a buyer. This type is only applicable if a buyer refund will be funded using a seller's credit card as the funding source.",
"enum": [
"VISA",
"MASTERCARD",
"AMERICAN_EXPRESS",
"DISCOVER"
]
},
"FundingMethodTypeEnum": {
"type": "object",
"description": "This enumeration type lists the possible funding methods that can be used by eBay to fund a seller's refund to a buyer.",
"enum": [
"CREDIT_CARD",
"DIRECT_DEBIT",
"PAY_UPON_INVOICE",
"AVAILABLE_FUNDS"
]
},
"FundingSource": {
"type": "object",
"properties": {
"brand": {
"description": "The enumeration value here indicates the brand of credit card used to fund the refund. This will be the seller's credit card on file with eBay.
This field is only returned if the funding source type is CREDIT_CARD.",
"$ref": "#/components/schemas/FundingMethodBrandEnum"
},
"memo": {
"type": "string",
"description": "This provides a note about the funding source. This field is only returned if available, or it might get returned as an empty string."
},
"type": {
"description": "he enumeration value here indicates the type of funding source, such as bank account, credit card, or available seller payout funds.",
"$ref": "#/components/schemas/FundingMethodTypeEnum"
}
},
"description": "This type shows the seller's funding source used for the buyer refund, or in the case where eBay issued the refund to the buyer, the seller's funding source used by eBay to recoup this refund money from the seller."
},
"FundingSourceType": {
"type": "object",
"properties": {
"brand": {
"description": "The enumeration value here indicates the brand of credit card used to fund the buyer's refund. This field is only returned if the funding source type is CREDIT_CARD.",
"$ref": "#/components/schemas/FundingMethodBrandEnum"
},
"memo": {
"type": "string",
"description": "This provides a note about the funding source. This field is only returned if available, or it might get returned as an empty string."
},
"type": {
"description": "The enumeration value here indicates the type of funding source, such as bank account, credit card, or available seller payout funds.",
"$ref": "#/components/schemas/FundingMethodTypeEnum"
}
},
"description": "This type provides details on the seller's funding source used for buyer refund."
},
"FundingStatusEnum": {
"type": "object",
"description": "This enumerated type is used to indicate if eBay was able to successfully 'fund' a refund to the buyer using the seller's preferred method of payment for refunds.",
"enum": [
"FUNDED",
"FAILED"
]
},
"GetCancelDetailResponse": {
"type": "object",
"properties": {
"cancelDetail": {
"description": "Contains information about a cancelled 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.",
"$ref": "#/components/schemas/CancelDetail"
}
},
"description": "This type defines the response payload for the GET /post-order/v2/cancellation/{cancelId} method. This method returns the details of the cancellation request specified by the cancelId path parameter of the request."
},
"GetCancelFieldGroup": {
"type": "object",
"description": "This enumerated type holds the values that may be passed into the fieldgroups query parameter of the GET /post-order/v2/cancellation/{cancelId} method to control the level of details returned by the request.",
"enum": [
"SUMMARY",
"FULL"
]
},
"GetDetailResponse": {
"type": "object",
"properties": {
"detail": {
"description": "This container consists of detailed information on the return request. This container is not returned if the fieldgroups query parameter is omitted, or if it is used and its value is set to SUMMARY or NONE.",
"$ref": "#/components/schemas/ReturnDetailType"
},
"summary": {
"description": "This container consists of summarized information on the return request. This container is not returned if the fieldgroups query parameter is omitted, or if it is used and its value is set to FULL or NONE.'",
"$ref": "#/components/schemas/ReturnSummaryType"
}
},
"description": "This type provides details on a return request that is returned in the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} responses."
},
"GetFileResponse": {
"type": "object",
"properties": {
"files": {
"type": "array",
"description": "This array consists of details on one or more files associated with the return request or return draft specified in the request. If there are no files associated with the specified return request or return draft, this container will not be returned.",
"items": {
"$ref": "#/components/schemas/ReturnFileType"
}
}
},
"description": "This type defines the base response of the two 'Get Files' methods (for return request and return draft). The response of these two methods is an array of one or more files associated with the return request or return draft specified in the request."
},
"GetReturnFieldGroupEnum": {
"type": "object",
"description": "This enumerated type contains the detail control filters that can be used in a POST /post-order/v2/return or GET /post-order/v2/return/{returnId} methods to control the data that is returned in the response.",
"enum": [
"NONE",
"SUMMARY",
"FULL"
]
},
"GetSellerReturnPreferenceResponse": {
"type": "object",
"properties": {
"advanceRulesEnabled": {
"type": "boolean",
"description": "This boolean field is returned as true if the seller's account is enabled to set up advanced return rules. Return Rules are set up and managed in My eBay."
},
"rmaRequired": {
"type": "boolean",
"description": "This boolean field is returned as true if the seller is requiring that an Return Merchandise Authorization (RMA) number be provided by the buyer when returning an item. This boolean field is returned as false if the seller is not requiring that an RMA number be provided for return items."
},
"versionId": {
"type": "integer",
"description": "The unique eBay-assigned ID of the seller's current set of return rules. This unique eBay-assigned ID will be updated each time the seller makes any type of update to return rules in My eBay.",
"format": "int32"
}
},
"description": "The base response type for the getReturnPreferences method."
},
"GetSummaryResponse": {
"type": "object",
"properties": {
"countSummary": {
"type": "array",
"description": "This array holds a count of return requests in different states. A separate count and type pair is returned for each return request state, such as ALL_OPEN, RETURN_STARTED, or ITEM_DELIVERED. The return request states that are returned depend on the use of the return_state query parameter in the request. If this query parameter is omitted in the request, the count for every return request state is returned. However, if this query parameter is used, only the count for the specified return request state will be returned.",
"items": {
"$ref": "#/components/schemas/CountSummaryType"
}
},
"members": {
"type": "array",
"description": "This array provides information on one or more return requests that match the filter criteria in the request.
This array is returned as empty if no return requests match the filter criteria in the request.",
"items": {
"$ref": "#/components/schemas/ReturnSummaryType"
}
},
"paginationOutput": {
"description": "This container consists of metadata related to the current page of results. It shows the total number of return requests that match the filter criteria, the total number of return requests to show per page of results, and the total number of pages in the results set.",
"$ref": "#/components/schemas/PaginationOutput"
},
"total": {
"type": "integer",
"description": "This field is not currently used. The total number of return requests and the number of return requests on the current page are shown in the paginationOutput container.",
"format": "int32"
}
},
"description": "The base response type for the GET /post-order/v2/return/search method, which is used to search for return requests."
},
"GetTrackingHistoryResponse": {
"type": "object",
"properties": {
"carrierUsed": {
"type": "string",
"description": "This string value indicates the shipping carrier used to ship the item."
},
"scanHistory": {
"type": "array",
"description": "This container holds an array of one or more shipment events/scans that have occurred with the item being returned, and each node provides details on each time a shipment is scanned by the shipping carrier.",
"items": {
"$ref": "#/components/schemas/ScanDetailType"
}
},
"trackingNumber": {
"type": "string",
"description": "This value is the tracking number for the shipment. Shipment tracking is mandatory except in countries where shipment tracking is not available, so this number should generally always be returned."
},
"trackingStatus": {
"type": "string",
"description": "This string value indicates the delivery status of the shipment, such as in-transit or delivered. This field will be returned unless it is not known."
}
},
"description": "The base response for the GET /post-order/v2/return/{returnId}/tracking method. The information in this response should be available once the shipment information has been uploaded to the eBay system"
},
"INRCreationReasonEnum": {
"type": "object",
"description": "This enumeration type lists the possible reasons why an 'Item not received' (INR) inquiry is opened by a buyer.",
"enum": [
"TRACKING_INFO_UNAVAILABLE",
"INCOMPLETE_ORDER",
"ITEM_NOT_RECEIVED_TRACKING_SHOWS_DELIVERED",
"ITEM_NOT_RECEIVED_ASK_FOR_REFUND",
"LATE_ORDER",
"EMPTY_BOX",
"UNKNOWN"
]
},
"InquiryDetails": {
"type": "object",
"properties": {
"appealDetails": {
"description": "This container consists of information related to the appeal of a case decision. This container is only returned for an INR inquiry that was escalated into a case and the case decision was appealed by the buyer or seller.",
"$ref": "#/components/schemas/AppealDetails"
},
"creationDate": {
"description": "The timestamp in this container indicates when the INR inquiry was created by the buyer.",
"$ref": "#/components/schemas/DateTime"
},
"escalationDate": {
"description": "The timestamp in this container indicates when the INR inquiry was escalated to a case. This container is not returned if the inquiry was not escalated.",
"$ref": "#/components/schemas/DateTime"
},
"expirationDate": {
"description": "The timestamp in this container indicates when the INR inquiry will naturally expire if no further action is taken.",
"$ref": "#/components/schemas/DateTime"
},
"lastBuyerRespDate": {
"description": "The timestamp in this container indicates when the buyer last responded to, or performed an action on the INR inquiry.",
"$ref": "#/components/schemas/DateTime"
},
"provisionalRefund": {
"description": "This container indicates whether a provisional refund was issued to the buyer and whether the provisional refund was later reversed.",
"$ref": "#/components/schemas/ProvisionalRefund"
},
"refundAmounts": {
"description": "This container consists of details related to the expected and actual buyer refund amounts related to an INR inquiry or case. This container is only returned if a refund is scheduled to, or has been issued to the buyer.",
"$ref": "#/components/schemas/RefundAmounts"
},
"refundChargeAmount": {
"description": "This container shows the total amount charged to the seller for this buyer refund. The value will be in the seller's default currency. This container is only applicable and is only returned if a refund has been issued to the buyer.",
"$ref": "#/components/schemas/Amount"
},
"refundDeadlineDate": {
"description": "The timestamp in this container indicates when the seller is required to issue a refund for the INR inquiry. This container is only returned if the buyer is seeking a full refund and no longer wants the missing item.",
"$ref": "#/components/schemas/DateTime"
},
"totalAmount": {
"description": "This container shows the total cost of the order, including the item price and shipping fees. This will generally be the amount that the buyer will expect to receive if the buyer is seeking a full refund for the missing item.",
"$ref": "#/components/schemas/Amount"
}
},
"description": "Type used by the inquiryDetails container of the GET /post-order/v2/inquiry/{inquiryId} response. The inquiryDetails container provides details about a specific INR inquiry that is identified through a path parameter in the request."
},
"InquiryDetailsResponse": {
"type": "object",
"properties": {
"claimAmount": {
"description": "This container displays the dollar value of the order line item associated with the inquiry, which is generally the amount of the refund that the buyer will receive if the buyer is looking for a refund, or if the seller voluntarily refunds the buyer.
Note: There's a possibility that this value can be inaccurate if the buyer passed in an inaccurate value into the claimQuantity field when the inquiry was created.",
"$ref": "#/components/schemas/Amount"
},
"creationReason": {
"type": "string",
"description": "The enumeration value in this field indicates why the buyer created an INR inquiry for the line item.
The list of enumeration values that may be returned in this field are defined in the INRCreationReasonEnum type definition."
},
"extTransactionId": {
"type": "string",
"description": "This string value is the unique identifier of the payment transaction for the order. This field will only be returned if the payment transaction happened outside of eBay's system."
},
"initiator": {
"description": "The party who created this inquiry. In most cases, this value will be BUYER.",
"$ref": "#/components/schemas/UserPartyEnum"
},
"inquiryClosureDate": {
"description": "The timestamp in this container indicates when the inquiry was closed.
This container will only be returned if the INR inquiry has been closed.",
"$ref": "#/components/schemas/DateTime"
},
"inquiryContentOnHold": {
"type": "boolean",
"description": "This field indicates the item content related to the inquiry is hidden (the respective content is not returned). This field is returned as 'true' if the corresponding inquiry content is on hold due to eBay policy violation; false otherwise."
},
"inquiryDetails": {
"description": "This container provides details on the specified INR inquiry.",
"$ref": "#/components/schemas/InquiryDetails"
},
"inquiryHistoryDetails": {
"description": "This container consists of information about the events and actions that have occurred throughout the course of the specified INR inquiry.",
"$ref": "#/components/schemas/ClaimHistoryResponse"
},
"inquiryId": {
"type": "string",
"description": "The unique identifier of the INR inquiry for which details have been retrieved. All information returned in the response is relevant to this specific INR inquiry."
},
"inquiryQuantity": {
"type": "integer",
"description": "This integer is the quantity of the line item purchased by the buyer. This value is the same value passed into the claimQuantity field when the INR inquiry was created. If the claimQuantity field was omitted when the INR inquiry was created, this value defaults to 1. ",
"format": "int32"
},
"itemDetails": {
"description": "This container consists of details related to the item associated with the INR inquiry, including the item title, price, and the URL of the gallery picture.",
"$ref": "#/components/schemas/ItemDetails"
},
"itemId": {
"type": "string",
"description": "The unique identifier of the eBay listing where the line item was purchased. This field is used in conjunction with the transactionId field to identify a line item that is associated with the INR inquiry."
},
"returnDetails": {
"description": "This container consists of information related to a buyer returning an order to the seller, including the seller's return address and the RMA number (if applicable). This container is only returned under the following circumstances:
DEFAULT value is supported, and this is the default value that is used if the fieldGroups query parameter is not used. A 'summary-level' resonse may be supported in the future.",
"enum": [
"DEFAULT",
"SUMMARY"
]
},
"InquirySearchResponse": {
"type": "object",
"properties": {
"members": {
"type": "array",
"description": "An array of one or more INR inquiries that match the filter criteria in request.",
"items": {
"$ref": "#/components/schemas/InquirySummaryType"
}
},
"paginationOutput": {
"description": "This container consists of metadata related to the current page of results. It shows the total number of INR inquiries that match the filter criteria, the total number of INR inquiries to show per page of results, and the total number of pages in the results set.",
"$ref": "#/components/schemas/PaginationOutput"
},
"totalNumberOfInquiries": {
"type": "integer",
"description": "This integer value indicates the total number of INR inquiries that were found based on the input filter(s) in the request.",
"format": "int32"
}
},
"description": "The base response type of the GET /post-order/v2/inquiry/search method, which is used to retrieve INR inquiries based on filter criteria in the request."
},
"InquiryStateEnum": {
"type": "object",
"description": "This enumerated type lists the possible states of an inquiry.",
"enum": [
"INITIAL",
"PENDING_CREATED",
"CREATED",
"FULL_REFUND_AGREED",
"PARTIAL_REFUND_OFFERED",
"PARTIAL_REFUND_ACCEPTED",
"SELLER_ECHECK_FULL_REFUND_INITIATED",
"SELLER_ECHECK_PARTIAL_REFUND_INITIATED",
"SELLER_ECHECK_REFUND_GRACE_EXPIRED",
"TRACKING_PROVIDED",
"SHIPPING_INFO_PROVIDED",
"AUTO_DISPOSE_MONEY_MOVEMENT_PENDING",
"VOLUNTARY_REFUND_PAYOUT_PENDING",
"ON_HOLD",
"ON_HOLD_FOR_UPLOAD",
"CLOSED",
"OTHER"
]
},
"InquiryStatusEnum": {
"type": "object",
"description": "This enumerated type lists the possible statuses into which an inquiry is placed.",
"enum": [
"PENDING",
"OPEN",
"WAITING_BUYER_RESPONSE",
"WAITING_SELLER_RESPONSE",
"CLOSED",
"CS_CLOSED",
"CLOSED_WITH_ESCALATION",
"OTHER"
]
},
"InquiryStatusFilter": {
"type": "object",
"description": "This enumerated type lists the possible inquiry state values that can be used if the inquiry_status filter is used in a GET /post-order/v2/inquiry/search request.",
"enum": [
"PENDING",
"OPEN",
"WAITING_BUYER_RESPONSE",
"WAITING_SELLER_RESPONSE",
"CLOSED",
"CS_CLOSED",
"CLOSED_WITH_ESCALATION",
"OTHER"
]
},
"InquirySummaryType": {
"type": "object",
"properties": {
"buyer": {
"type": "string",
"description": "The eBay user ID of the buyer involved in the INR inquiry.WAITING_SELLER_RESPONSE or WAITING_BUYER_RESPONSE, the seller or buyer, respectively, should make sure they respond no later than the date and time found in the respondByDate container.WAITING_SELLER_RESPONSE, or will apply to the buyer if the inquiryStatusEnum value is WAITING_BUYER_RESPONSE.",
"$ref": "#/components/schemas/DateTime"
},
"seller": {
"type": "string",
"description": "The eBay user ID of the seller involved in the INR inquiry.true if the seller wants to relist/restock the returned item automatically after the refund operation succeeds. SUCCESS (the relist succeeded) or FAILED (the relist request did not succeed). PENDING value is returned, it may indicate that the refund is happening outside of eBay's system and there is no way for eBay to check the status of the refund. In this scenario, the seller should call POST /post-order/v2/return/{returnId}/mark_refund_sent to mark the refund as sent and/or the buyer should call POST /post-order/v2/return/{returnId}/mark_refund_received to mark the refund as received.",
"$ref": "#/components/schemas/Refund_MoneyMovementStatusEnum"
}
},
"description": "The base response type of the POST /post-order/v2/return/{returnId}/issue_refund method."
},
"ItemDetailType": {
"type": "object",
"properties": {
"ebayPlusTxn": {
"type": "boolean",
"description": "This field indicates if the order line item was part of an eBay Plus order. eBay Plus is currently available on the eBay Australia and eBay Germany marketplaces."
},
"itemId": {
"type": "string",
"description": "The unique identifier for the eBay listing where the item was purchased. This field is used in conjunction with the transactionId field to identify a line item within an order."
},
"itemOnHold": {
"type": "boolean",
"description": "This field indicates the item related to the return is hidden (the respective content is not returned). This field is returned as 'true' if the corresponding item is on hold due to eBay policy violation; false otherwise."
},
"listingSiteId": {
"type": "integer",
"description": "This integer value indicates the eBay marketplace where the sale occurred. The site IDs used for each eBay marketplace can be found in the eBay Site ID to Global ID Mapping page.",
"format": "int32"
},
"relistedItemId": {
"type": "string",
"description": "This field is only returned if the returned item is relisted as a new eBay listing, and this value will be different than the value in the itemId field."
},
"relistStatus": {
"description": "This enumeration value either indicates if the order line item is eligible to be relisted, or in a case where the seller wants to relist the item, the value returned here will indicate if relisting was successful or if it failed.",
"$ref": "#/components/schemas/RelistStatusEnum"
},
"returnQuantity": {
"type": "integer",
"description": "This integer value indicates the quantity of the order line item being returned. This number is typically 1, unless the buyer bought multiple quantity of the same line item in a multiple-quantity, fixed-price listing.",
"format": "int32"
},
"transactionId": {
"type": "string",
"description": "The unique identifier for the purchase of the item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify a line item within an order."
},
"transactionDate": {
"description": "This timestamp indicates when the sales transaction occurred.",
"$ref": "#/components/schemas/DateTime"
},
"itemPrice": {
"description": "Shows the price of the item. If currency conversion was needed, the original currency and the exchange rate used are also shown.",
"$ref": "#/components/schemas/Amount"
},
"itemPicUrl": {
"type": "string",
"description": "The URL of the gallery image for the listing. This field is returned when available. If the item is on hold, the returned value will be masked."
},
"itemTitle": {
"type": "string",
"description": "The title of the eBay listing. If the item is on hold, the returned value will be masked."
}
},
"description": "This type is used by the itemDetail container, which consists of information about the order line item, including listing ID, transaction ID, price, transaction date, and quantity being returned."
},
"ItemDetails": {
"type": "object",
"properties": {
"itemOnHold": {
"type": "boolean",
"description": "This field indicates the item related to the inquiry is hidden (the respective content is not returned). This field is returned as 'true' if the item is on hold due to eBay policy violation; false otherwise."
},
"itemPictureUrl": {
"type": "string",
"description": "This field provides an URL where the gallery picture of the item may be viewed. This field is returned when available. If the item is on hold, this field may not be returned."
},
"itemPrice": {
"description": "This container shows the final price of the line item, or the amount of money that the buyer agreed to pay for the item.",
"$ref": "#/components/schemas/Amount"
},
"itemTitle": {
"type": "string",
"description": "The title of the eBay listing. If the item is on hold, the itemID of the listing is returned instead of the title."
},
"viewPurchasedItemUrl": {
"type": "string",
"description": "When available, this field provides the URL to the item purchase page. If the item is on hold, a placeholder may be returned instead of the gallery picture."
}
},
"description": "This type provides information about the line item associated with the INR inquiry."
},
"ItemEligibilityResult": {
"type": "object",
"properties": {
"cancelQuantity": {
"type": "integer",
"description": "The quantity of the specified order line item that is being cancelled. true, the corresponding line item is eligible for cancellation. true for all line items in the order if the value of the corresponding orderEligibilityResult.eligible field is also true. However, if the value of the orderEligibilityResult.eligible field is false, it is possible that some line items in the order may be eligible for cancellation, but other line items may not be eligible."
},
"failureReason": {
"type": "array",
"description": "An array of one or more reasons why a line item has been found to be ineligible for cancellation. This array is only returned if the value of the itemEligibilityResult.eligible field is false.Note: The unique identifier of an order changes as the order goes from unpaid to paid, so the IDs for both unpaid and paid orders are supported in this field. For orders where payment has been made, the ID for the paid order should be used."
}
},
"description": "The base request type of the POST /post-order/v2/cancellation/check_eligibility method. In this method, the unique identifier of the order is passed in through the request payload to see if an order is eligible to be cancelled. "
},
"OrderEligibilityResult": {
"type": "object",
"properties": {
"eligible": {
"type": "boolean",
"description": "If this value is returned as true, the specified order is eligible to be cancelled. If this value is returned as false, the order is not eligible to be cancelled. One or more reasons why an order may not be eligible for cancellation will be shown in the failureReason array."
},
"eligibleCancelReason": {
"type": "array",
"description": "A list of one or more reasons that a buyer or seller can give for cancelling this order. This field is returned only if the value of the eligible field is true.
Supported enumeration values representing buyer and seller order cancellation reasons can be found in the CancelReasonEnum type definition.",
"items": {
"type": "string"
}
},
"failureReason": {
"type": "array",
"description": "A list of one or more reasons why this order has been found to be ineligible for cancellation. This field is returned only if the value of the eligible field is false.
The full list of reasons why an order may not be eligible for cancellation can be found in the EligibilityFailureReasonEnum type definition.",
"items": {
"type": "string"
}
},
"itemEligibilityResult": {
"type": "array",
"description": "A list of all line items in the order and whether or not each line item is eligible to be cancelled. Because only full-order cancellations are supported at this time, if the orderEligibilityResult.eligible value is returned as true, the itemEligibilityResult.eligible value for all line items within the order will also be returned as true.
Note it's possible for the orderEligibilityResult.eligible value to be returned as false while one or more itemEligibilityResult.eligible values may be returned as true.",
"items": {
"$ref": "#/components/schemas/ItemEligibilityResult"
}
},
"legacyOrderId": {
"type": "string",
"description": "A unique eBay-assigned ID for the order being considered for cancellation.
Note: The unique identifier of an order changes as the order goes from unpaid to paid, so the IDs for both unpaid and paid orders may be returned in this field based on payment status."
}
},
"description": "This type is used to describe whether or not the order is eligible to be cancelled."
},
"OrderTypeEnum": {
"type": "object",
"description": "This enumeration type contains a list of different eBay order types.",
"enum": [
"IN_STORE_PICKUP",
"EBAY_NOW",
"ONLINE",
"OTHER"
]
},
"PaginationOutput": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "The maximum number of entries to return per request. This value is set through the limit query parameter in the request (or the default value is used if this query parameter is omitted).
The value of the totalEntries field divided by the value of this field determines the value of the totalPages field. ",
"format": "int32"
},
"offset": {
"type": "integer",
"description": "The offset value indicates the number of entries to skip in the results set before returning the first entry in the paginated response. The offset query parameter is paired with the limit query parameter to control the number of entries returned in the response, and which entries appear on that page of data. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 entries from the results set. If the offset was set to 10 and the limit was set to 20, the first page of the results set would contain entries 11-30.
The offset value defaults to 0 if the offset query parameter is omitted from the request.",
"format": "int32"
},
"totalEntries": {
"type": "integer",
"description": "The total number of entries that match the current input criteria of the request. This value divided by the value of the limit field determines the value of the totalPages field.",
"format": "int32"
},
"totalPages": {
"type": "integer",
"description": "The total number of pages of entries that match the current input criteria of the request.
This value is determined by dividing the value of the totalEntries field by the value of the limit field. If totalPages is more than 1, subsequent calls must be used to view subsequent pages in the results set.",
"format": "int32"
}
},
"description": "This type contains information about the pagination of a response payload. The entries (data records) returned by the request are grouped into pages, which are limited in size according to the number of entries per page as specified by the limit field."
},
"PartialOrderTypeEnum": {
"type": "object",
"description": "This enumeration type defines the values that can be used to describe the scope of an order cancellation.
Note: At this time, only full order cancellations are supported. Neither a buyer or a seller may initiate the cancellation of just one line item within a multiple line item order.",
"enum": [
"UNKNOWN",
"FULL_ORDER",
"PARTIAL_ORDER"
]
},
"PartyEnum": {
"type": "object",
"description": "This enumeration type lists the eBay user types that can create or perform an action against an order cancellation request.",
"enum": [
"UNKNOWN",
"SELLER",
"BUYER"
]
},
"PaymentDenialReasonEnum": {
"type": "object",
"description": "THIS ENUMERATED TYPE AND ITS VALUES ARE DEPRECATED..",
"enum": [
"PP_PAYPAL_GUEST",
"PP_DISALLOWED_DISPUTE",
"PP_ADMINISTRATIVE_FRAUD_REVIEW",
"PP_CREDITCARD_CHARGEBACK",
"PP_ELV_REVERSAL",
"PP_ACH_RETURN",
"PP_UNAUTHORIZED_TRANSACTION",
"OTHER"
]
},
"PaymentProviderEnum": {
"type": "object",
"description": "This token type lists the external payment system used for the monetary transaction.",
"enum": [
"UNKNOWN",
"PAYPAL"
]
},
"PaymentStatusEnum": {
"type": "object",
"description": "This enumerated type defines the status values for a buyer's payment for an order.",
"enum": [
"UNKNOWN",
"PAYPAL_PAID",
"ONLINE_PAID",
"MARK_AS_PAID",
"NOT_PAID"
]
},
"PayoutRecoupInfo": {
"type": "object",
"properties": {
"amountToRecoup": {
"description": "This container shows the amount of the seller payout which must be recouped from the seller by eBay in the case of a cancelled order",
"$ref": "#/components/schemas/Amount"
},
"payoutId": {
"type": "integer",
"description": "The unique identifier of the seller payout associated with the cancelled order.",
"format": "int32"
}
},
"description": "This type defines the amount of the seller payout, which must be recouped from the seller by eBay in the case of a cancelled order."
},
"ProvideLabelRequest": {
"type": "object",
"properties": {
"carrierEnum": {
"type": "string",
"description": "One of the values defined in the ShippingCarrierEnum type definition must be used in this field to indicate the shipping carrier that will be used to ship the return item. This field is conditionally required if the POST /post-order/v2/return/{returnId}/add_shipping_label method is being used to initiate an eBay shipping label. Otherwise, the carrierName field can be used to indicate which shipping carrier will be used.
Note that the ShippingCarrierEnum type defines enumeration values for some popular shipping carriers for the US, UK, Germany, Canada, and Australia, but it is not a complete global list. "
},
"carrierName": {
"type": "string",
"description": "This field is used to show the name of the shipping carrier."
},
"comments": {
"description": "This container can be used to include any applicable comments about the shipping label.",
"$ref": "#/components/schemas/Text"
},
"fileId": {
"type": "string",
"description": "The unique ID of a file attached to the return request. This field may be used if the seller has associated a shipping label related file to the return request."
},
"forwardShippingLabelProvided": {
"type": "boolean",
"description": "This field should be provided and set to true if the seller has already provided the buyer with a return shipping label. This field is generally provided if the labelAction value is set to MARK_AS_SENT."
},
"labelAction": {
"description": "This required field indicates what action is being taken with the POST /post-order/v2/return/{returnId}/add_shipping_label request. Based on what value is supplied here, the noLabelReason, forwardShippingLabelProvided, and labelId fields may become conditionally required.",
"$ref": "#/components/schemas/LabelActionEnum"
},
"labelSentDate": {
"description": "The timestamp in this container indicates when the shipping label was sent to the buyer or seller.",
"$ref": "#/components/schemas/DateTime"
},
"noLabelReason": {
"description": "This field is conditionally required if the labelAction value is set to NO_LABEL. If no shipping label is being provided, the seller must state the reason why through this field. The supported value for this field can be found in the NoSellerUploadLabelReasonEnum type definition.",
"$ref": "#/components/schemas/NoSellerUploadLabelReasonEnum"
},
"returnLabelCost": {
"description": "This container shows the cost of the return shipping label.",
"$ref": "#/components/schemas/Amount"
},
"trackingNumber": {
"type": "string",
"description": "The tracking number on the shipping label. If providing the tracking number, the shipping carrier must also be provided through the carrierEnum field."
}
},
"description": "The base request type of the POST /post-order/v2/return/{returnId}/add_shipping_label method."
},
"ProvideLabelResponse": {
"type": "object",
"properties": {
"labelData": {
"type": "string",
"description": "This field contains the text of the shipping label. This field is returned if the shipping label was successfully created."
},
"labelId": {
"type": "string",
"description": "The unique eBay-assigned ID of the shipping label. This field is returned if the shipping label was successfully created."
},
"labelURL": {
"type": "string",
"description": "This value is the URL of the page where the shipping label can be downloaded and printed. This field is returned if the shipping label was successfully created."
},
"trackingNumber": {
"type": "string",
"description": "The tracking number on the shipping label that will be used for tracking the shipment. This field is returned if the shipping label was successfully created."
}
},
"description": "The base response type of the POST /post-order/v2/return/{returnId}/add_shipping_label method."
},
"ProvideShipmentInfoRequest": {
"type": "object",
"properties": {
"shippingCarrierName": {
"type": "string",
"description": "The shipping carrier enumeration value is passed into this field, and represents the shipping carrier being used to return the item.
A list of shipping carrier enumeration values can be found in the ShippingCarrierEnum type definition."
},
"trackingNumber": {
"type": "string",
"description": "The shipment tracking number is passed into this field. This value should be passed in without hyphens or spaces. The seller is responsible for the accuracy of this value, as eBay can only validate that the format is consistent with the format that is used by the specified shipping carrier."
}
},
"description": "The base request type of the POST /post-order/v2/casemanagement/{caseId}/provide_shipment_info method, which is used to provide return shipment tracking information."
},
"RefundAmounts": {
"type": "object",
"properties": {
"buyerFinalAcceptRefundAmt": {
"description": "This container shows the refund amount finally accepted by the buyer.",
"$ref": "#/components/schemas/Amount"
},
"buyerInitExpectRefundAmt": {
"description": "This container shows the refund amount initially expected by the buyer.",
"$ref": "#/components/schemas/Amount"
},
"donationAmount": {
"description": "This container defines the refund amount for listings that included a charitable donation. This data includes the amount of the charitable donation refunded, as well as currency conversion information when necessary including the current currency code, the value in the original currency, and the original currency's code.",
"$ref": "#/components/schemas/Amount"
},
"feeCreditAmount": {
"description": "This container shows the total amount of fees credited towards this refund as per eBay policy.",
"$ref": "#/components/schemas/Amount"
},
"internationalRefundAmount": {
"description": "This container shows the refund amount issued to the buyer for the international leg of a Global Shipping Program shipment. This container only applies for international orders where the seller used the Global Shipping Program to ship the order.",
"$ref": "#/components/schemas/Amount"
},
"refundAmount": {
"description": "This container shows the refund amount issued to the buyer.",
"$ref": "#/components/schemas/Amount"
}
},
"description": "This type provided details related to the expected and actual buyer refund amounts associated with an INR inquiry or case."
},
"RefundDeductionType": {
"type": "object",
"properties": {
"refundDeductionAmount": {
"description": "This container shows the deduction amount that is taken off the refund amount.
This container will be returned if a set monetary amount was deducted from the refund amount.",
"$ref": "#/components/schemas/Amount"
},
"refundDeductionPercentage": {
"type": "integer",
"description": "This integer value indicates the percentage value that was deducted from the refund amount.
This field will be returned if a percentage value was deducted from the refund amount.",
"format": "int32"
}
},
"description": "This type defines the type of deduction taken off the refund amount as either a percentage of the refund amount or a set monetary amount off the refund amount."
},
"RefundDetailType": {
"type": "object",
"properties": {
"donationAmount": {
"description": "This container defines the refund amount for listings that included a charitable donation. This data includes the amount of the charitable donation refund, as well as currency conversion information when necessary including the current currency code, the value in the original currency, and the original currency's code.
Note: This container is not applicable for the following methods:
",
"$ref": "#/components/schemas/Amount"
},
"itemizedRefundDetail": {
"type": "array",
"description": "This container is used to declare a refund that is being issued, or has been issued to the buyer. An itemizedRefundDetail container is required for each different refund type, such as purchase price and original shipping. This container is required when using the POST /post-order/v2/return/{returnId}/issue_refund method to issue a refund, or when using the POST /post-order/v2/return/{returnId}/mark_refund_sent method to mark a refund as sent. In the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} methods, this container will be returned under the actualRefund container if a refund has occurred.",
"items": {
"$ref": "#/components/schemas/ItemizedRefundDetailType"
}
},
"totalAmount": {
"description": "This container shows the total cumulative amount of the refund issued to the buyer. This value should equal the sum of the values in the itemizedRefundDetail.refundAmount field(s). This container is required when using the POST /post-order/v2/return/{returnId}/issue_refund method to issue a refund, or when using the POST /post-order/v2/return/{returnId}/mark_refund_sent method to mark a refund as sent. In the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} methods, this container will be returned under the actualRefund container if a refund has occurred.",
"$ref": "#/components/schemas/Amount"
},
"feeCreditAmount": {
"description": "This container shows the total amount of fees credited towards this refund as per eBay policy.",
"$ref": "#/components/schemas/Amount"
}
},
"description": "This type is used by refundDetail container in the POST /post-order/v2/return/{returnId}/issue_refund and POST /post-order/v2/return/{returnId}/mark_refund_sent methods to specify the total amount of the refund, as well as an itemizedRefundDetail container for each refund type (refund on purchase price, refund on original shipping, or any other costs paid by the buyer). The amount(s) in the itemizedRefundDetail.amount field(s) should equal the amount in the refundDetail.totalAmount field. This type is also used by the actualRefund container in the response of a POST /post-order/v2/return method to provide information about a successful refund for a return."
},
"RefundFeeTypeEnum": {
"type": "object",
"description": "This enumerated type lists all possible types of refunds. In some cases, multiple refund transaction may be necessary to fully refund the buyer for a return. POST /post-order/v2/returnPOST /post-order/v2/return/{returnId}/issue_refund
When issuing a refund through the POST /post-order/v2/return/{returnId}/issueRefund method, the seller must use a separate itemizedRefundDetail container for each refund type, such as one for the purchase price, one for original shipping, etc.",
"enum": [
"PURCHASE_PRICE",
"ORIGINAL_SHIPPING",
"DOMESTIC_SHIPPING",
"INTERNATIONAL_SHIPPING",
"IMPORT_CHARGE",
"REFUND_FROM_PAYPAL",
"RETURN_SHIPPING",
"ORDER_ADJUSTMENT",
"ITEM_IMPORT_TAX",
"SHIPPING_IMPORT_TAX",
"ITEM_TAX",
"SHIPPING_TAX",
"OTHER"
]
},
"RefundFundingType": {
"type": "object",
"properties": {
"date": {
"description": "The timestamp in this container indicates when the seller's funding source was debited/charged for the buyer refund.",
"$ref": "#/components/schemas/DateTime"
},
"amount": {
"description": "This container shows the amount debited/charged to the seller's funding source for the buyer refund.",
"$ref": "#/components/schemas/Amount"
},
"fundingSource": {
"description": "This container provides information about the seller's funding source for the buyer refund. A funding source can be available seller payout funds, a bank account on file, or a credit card on file.",
"$ref": "#/components/schemas/FundingSourceType"
},
"fundingStatus": {
"description": "The enumeration value returned in this field indicates if the debit/charge to the funding source was successful or not.",
"$ref": "#/components/schemas/FundingStatusEnum"
}
},
"description": "This type is used to provide more information about the seller's funding source used for a buyer's refund in the case of a returned item or order cancellation."
},
"RefundInfo": {
"type": "object",
"properties": {
"actualRefundDetail": {
"description": "This container provides detailed information about a buyer refund that was issued, or is scheduled to be issued for a cancelled order.",
"$ref": "#/components/schemas/ActualRefundDetail"
}
},
"description": "This type is used to provide more information about a buyer refund that was issued, or is scheduled to be issued for a cancelled order."
},
"RefundInfoType": {
"type": "object",
"properties": {
"actualRefundDetail": {
"description": "This container shows the itemized refund information after the seller issues a refund to the buyer. This container is only returned if the seller has issued a refund to the buyer. Until the refund is actually successfully processed, only information on the estimated refund may be seen in the estimatedRefundDetail container.",
"$ref": "#/components/schemas/ActualRefundDetailType"
},
"estimatedRefundDetail": {
"description": "This container shows estimated refund information for the buyer. There will be one itemizedRefundDetail container returned under this container for each refund fee type (such as purchase price and original shipping).",
"$ref": "#/components/schemas/EstimatedRefundDetailType"
},
"provisionalRefund": {
"description": "This container indicates whether a provisional refund was issued to the buyer before return creation and later reversed. This container is only returned when applicable. For the Create Return call, this container may be returned only when the fieldgroups query parameter is set to FULL (the full response uses the same return detail type returned by the Get Return call).",
"$ref": "#/components/schemas/ProvisionalRefundType"
}
},
"description": "This type is used by the refundInfo container, which provides detailed information on the estimated and actual refund amounts."
},
"RefundPaymentTypeEnum": {
"type": "object",
"description": "This enumerated type lists the methods that can be used to issue a buyer refund.",
"enum": [
"INSTANT_REFUND",
"ECHECK",
"PAYOUT",
"INTERMEDIATED_REFUND",
"OTHER"
]
},
"RefundStatusEnum": {
"type": "object",
"description": "This enumeration type contains the possible outcomes of a refund action initiated through the POST /post-order/v2/inquiry/{inquiryId}/issue_refund or POST /post-order/v2/casemanagement/{caseId}/issue_refund methods.",
"enum": [
"PENDING",
"SUCCESS",
"FAILED",
"OTHER"
]
},
"RefundType": {
"type": "object",
"description": "This enumeration type contains the possible types of refunds - partial or full.",
"enum": [
"FULL",
"PARTIAL",
"OTHER"
]
},
"Refund_MoneyMovementStatusEnum": {
"type": "object",
"description": "This enumerated type defines the possible values that can be returned for the status of a buyer refund.",
"enum": [
"REQUESTED",
"SUCCESS",
"PENDING",
"FAILED",
"UNKNOWN"
]
},
"RejectCancelRequest": {
"type": "object",
"properties": {
"shipmentDate": {
"description": "The date and time that a package in the order was shipped by the seller.
Although not a required container, the shipment date should be provided if the seller has indeed shipped the order.",
"$ref": "#/components/schemas/DateTime"
},
"trackingNumber": {
"type": "string",
"description": "The shipment tracking number for the package that is en route to the buyer. Although not a required field, the tracking number should be provided if the seller has indeed shipped the order and the tracking number is readily available."
}
},
"description": "The base request type of the POST /post-order/v2/cancellation/cancel_Id/reject method. This method is used if the seller is rejecting the buyer's request to cancel an order. The unique identifier of the cancellation request is passed in as a path parameter, and the shipmentDate and/or trackingNumber fields are only necessary if the seller has already shipped the order. If the seller has already shipped an order, the cancellation of the order is no longer possible. Instead, the buyer will have to initiate a return request if they still wish to return the item for a refund.
Important! The shipmentDate and trackingNumber fields are optional in the request payload. If you do not provide either field in the request, you must submit a payload that consists of opening and closing braces: { }. or the request will fail.
true, the seller indicates that the buyer can keep the item they received instead of shipping it back to the seller when the refund request is accepted. false"
},
"moneyMovementRef": {
"description": "This container provides the unique eBay-assigned ID of a monetary transaction associated with a return. This container is not returned if no monetary transaction occurred for this particular return activity (identified in the responseHistory.activity field).",
"$ref": "#/components/schemas/MoneyMovementRef"
},
"partialRefundAmount": {
"description": "This container shows the partial refund amount that the seller is offering to the buyer in order to settle the return request. This field is not applicable and not returned if the seller is not offering the buyer a partial refund.",
"$ref": "#/components/schemas/Amount"
},
"refundDeductionType": {
"description": "This container shows the amount/type of deduction that is taken off the refund amount, if any. SUCCESS. Until then, the expected amount of the monetary transaction can be seen in the requestedAmount field.",
"$ref": "#/components/schemas/Amount"
},
"creationDate": {
"description": "The timestamp in this container indicates the date and time when the monetary transaction occurred.",
"$ref": "#/components/schemas/DateTime"
},
"externalPaymentId": {
"type": "string",
"description": "This string value is the unique ID of a monetary transaction that occurred outside of eBay's system."
},
"moneyMovementType": {
"type": "string",
"description": "This enumeration value indicates the type of monetary transaction that is either in the process of being executed or has already been executed. UNKNOWN.",
"$ref": "#/components/schemas/PaymentProviderEnum"
},
"requestedAmount": {
"description": "This container shows the monetary amount of the transaction. SUCCESS.",
"$ref": "#/components/schemas/Amount"
},
"status": {
"type": "string",
"description": "This enumeration value indicates the success or failure of the monetary transaction.true indicates that the return address can be modified, and a value of false indicates that the return address cannot be modified."
},
"firstName": {
"type": "string",
"description": "The first name associated with the return address, or if applicable, a business or store name."
},
"lastName": {
"type": "string",
"description": "The last name associated with the return address. This field will only be returned if applicable."
},
"RMA": {
"type": "string",
"description": "The Return Merchandise Authorization (RMA) identifier authorizing this return. This field is only returned if an RMA number exists for the order line item."
}
},
"description": "This type provides the seller's return address and the Return Merchandise Authorization (RMA) number associated with the item (if applicable)."
},
"ReturnAddressRequest": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "The first name associated with the seller's return address, or if applicable, a business or store name.SNAD or REMORSE.",
"$ref": "#/components/schemas/ReturnReasonTypeEnum"
},
"type": {
"description": "This enumerated value indicates the buyer's desired outcome. Note: Currently, the only supported value is MONEY_BACK.
EBAY_US.",
"$ref": "#/components/schemas/MarketplaceIdEnum"
},
"moneyMovementInfo": {
"type": "array",
"description": "This array consists of detailed information on each monetary transaction that may occur with a return request.",
"items": {
"$ref": "#/components/schemas/RetMoneyMovementDetailType"
}
},
"payoutRecoupInfo": {
"description": "This container indicates the amount that eBay needs to recoup from the seller for a buyer refund, and if this money will be recouped through a seller payout, the payoutId value is returned. Note: Replacement items for returns are not currently supported.
", "$ref": "#/components/schemas/ShipmentType" }, "responseHistory": { "type": "array", "description": "This array consists of detailed information of each activity that occurs with a return request.", "items": { "$ref": "#/components/schemas/ReturnResponseHistoryType" } }, "returnShipmentInfo": { "description": "This container consists of detailed information on return shipment, including who's responsible for paying for return shipping, shipment information (return address, shipment tracking, estimated and actual delivery dates, and delivery status), and shipping costs.", "$ref": "#/components/schemas/ShipmentType" }, "returnContentOnHold": { "type": "boolean", "description": "This field indicates the item content related to the return is hidden (the respective content is not returned). This field is returned as 'true' if the corresponding return content is on hold due to eBay policy violation; false otherwise." }, "RMANumber": { "type": "string", "description": "This field shows the return merchandise authorization (RMA) number for the return. This field is only returned if an RMA is associated with the return request." }, "sellerAddress": { "description": "This container provides the seller's default shipping address.RETURN_CREATION check.",
"$ref": "#/components/schemas/RetEligibilityCheckTypeEnum"
},
"eligibilityInfo": {
"description": "This container includes the results of the return eligibility check, including any errors that may have occurred with the eligibility check, as well as detailed information on the return request.",
"$ref": "#/components/schemas/EligibilityResultType"
}
},
"description": "This type is used by the eligibilityResultsPerCheckType container, which contains the results for each eligibility check type that was run against the order line item."
},
"ReturnEligibilityItemType": {
"type": "object",
"properties": {
"itemId": {
"type": "string",
"description": "The unique identifier of the eBay listing where the item was purchased. This field is used in conjunction with the transactionId field to identify a line item within an order."
},
"reason": {
"type": "string",
"description": "This enumerated value lists indicates the buyer's reason for returning the item.1, unless the buyer bought multiple quantity of the item in a multiple-quantity, fixed-price listing.",
"format": "int32"
},
"transactionId": {
"type": "string",
"description": "The unique identifier for the purchase of a item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify a line item within an order."
}
},
"description": "This type is used by the returnItem container, which contains summary information on the line item being returned, including the listing ID, the line item ID, the return reason, and the quantity purchased."
},
"ReturnEligibilityPerItemType": {
"type": "object",
"properties": {
"eligibilityResultsPerCheckType": {
"type": "array",
"description": "This array contains the results of one or more return eligibility check types for the line, including any errors that may have occurred with the check type.",
"items": {
"$ref": "#/components/schemas/ReturnEligibilityItemPerCheckTypeResult"
}
},
"returnItem": {
"description": "This container consists of summary information on the line item being checked for return eligibility.",
"$ref": "#/components/schemas/ReturnEligibilityItemType"
}
},
"description": "This type is used by the eligibilityResult container, which consists of information related to the return eligibility of a line item."
},
"ReturnFileType": {
"type": "object",
"properties": {
"creationDate": {
"description": "The timestamp in this container indicates when the file was attached to the return request or return request draft.",
"$ref": "#/components/schemas/DateTime"
},
"fileData": {
"type": "string",
"description": "This field is the base64-encoded binary representation of the file associated with the return request or return request draft. This field is always returned for each file that is attached to a return request or return request draft."
},
"fileFormat": {
"description": "This enumeration value indicates the file type (like .GIF or .JPG). This field is always returned for each file that is attached to a return request or return request draft.",
"$ref": "#/components/schemas/FileFormatEnum"
},
"fileId": {
"type": "string",
"description": "This is the unique eBay-assigned ID of a file that is associated with the return request or return request draft. This field is always returned for each file that is attached to a return request or return request draft."
},
"fileName": {
"type": "string",
"description": "This field contains the name of the uploaded file. This field will be returned if the user has specified a name for the file."
},
"filePurpose": {
"description": "This enumeration value indicates the file's purpose. Files attached to return requests or return request drafts may provide more information about the condition of the item, about the buyer's refund, or about shipment tracking or shipping label. This field is always returned for each file that is attached to a return request or draft.",
"$ref": "#/components/schemas/FilePurposeEnum"
},
"fileStatus": {
"description": "This enumeration value indicates the current status of the file. This field is always returned for each file that is attached to a return request or return request draft.",
"$ref": "#/components/schemas/FileStatusEnum"
},
"resizedFileData": {
"type": "string",
"description": "This field is the base64-encoded binary representation of the file associated with the return request or return request draft. This field is returned for each file that is attached to a return request or return request draft that has been resized."
},
"secureUrl": {
"type": "string",
"description": "This field contains the URL where the uploaded file can be viewed."
},
"submitter": {
"description": "This enumeration value indicates which party (buyer or seller) submitted the file. This field is always returned for each file that is attached to a return request or return request draft.",
"$ref": "#/components/schemas/ReturnUserRoleEnum"
}
},
"description": "This type is used by the files container, which contains detailed information about one or more files that are submitted and associated with a return request or return request draft."
},
"ReturnHoldInfoType": {
"type": "object",
"properties": {
"holdCreationDate": {
"description": "The timestamp in this container indicates the date/time when the hold on the return request was initiated.",
"$ref": "#/components/schemas/DateTime"
},
"holdReferenceId": {
"type": "string",
"description": "This string value is the unique eBay-assigned ID of the hold on the return request."
},
"holdReleaseDate": {
"description": "The timestamp in this container indicates the date/time when the hold on the return request is expected to get released.",
"$ref": "#/components/schemas/DateTime"
},
"holdStatus": {
"description": "This enumerated value indicates the current status of the hold on the return request.",
"$ref": "#/components/schemas/ReturnHoldStatusEnum"
},
"holdTransactionId": {
"type": "string",
"description": "This string value is the unique eBay-assigned ID of the transaction that is a part of the return request."
}
},
"description": "This type is used by the holdInfo container, which provides information on a hold that has been initiated on a return request. The holdInfo container and its child elements are only returned if a hold has been placed on the return request."
},
"ReturnHoldStatusEnum": {
"type": "object",
"description": "This enumerated type lists the possible states of a return request that has been put on hold.",
"enum": [
"HOLD_CREATION_SUCCESS",
"HOLD_RELEASE_SUCCESS",
"HOLD_RELEASE_FAILED",
"INELIGIBLE_TO_RELEASE_HOLD",
"OTHER"
]
},
"ReturnItemType": {
"type": "object",
"properties": {
"itemId": {
"type": "string",
"description": "The unique identifier for the eBay listing where the item was purchased. This field is used in conjunction with the transactionId field to identify a line item within an order."
},
"returnQuantity": {
"type": "integer",
"description": "This integer value indicates the quantity of the line item being returned. This number is generally 1, unless the buyer bought multiple quantity of the item in a multiple-quantity, fixed-price listing.",
"format": "int32"
},
"transactionId": {
"type": "string",
"description": "The unique identifier for the purchase of the item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify a line item within an order."
}
},
"description": "This type identifies the line item that is being returned and the quantity being returned."
},
"ReturnPayoutRecoupInfoType": {
"type": "object",
"properties": {
"amountToRecoup": {
"description": "This container shows the amount of money that eBay needs to recoup from the seller to fund a buyer refund.",
"$ref": "#/components/schemas/Amount"
},
"payoutId": {
"type": "integer",
"description": "A unique eBay-assigned ID that identifies the seller payout that is associated with the purchase of the line item.true if the seller is expected to provide a return merchandise authorization (RMA) number to the buyer before the buyer return ships the order line item. The seller can use the POST /post-order/v2/return/{returnId}/decide method to provide the buyer with the RMA number for the item."
}
},
"description": "This type is used by the returnPolicy container, which is used to indicate whether or not the seller is expected to provide an RMA (return merchandise authorization) number to the buyer. The seller can use the POST /post-order/v2/return/{returnId}/decide method to provide the buyer with an RMA number."
},
"ReturnReasonEnum": {
"type": "object",
"description": "This enumerated type lists the possible values that the buyer can use when creating a return request or draft with the POST /post-order/v2/return or POST /post-order/v2/return/draft methods.",
"enum": [
"NO_REASON",
"ORDERED_WRONG_ITEM",
"ORDERED_ACCIDENTALLY",
"FOUND_BETTER_PRICE",
"MISSING_PARTS",
"ORDERED_DIFFERENT_ITEM",
"ARRIVED_DAMAGED",
"NO_LONGER_NEED_ITEM",
"NOT_AS_DESCRIBED",
"DEFECTIVE_ITEM",
"MISCATEGORIZED",
"CUSTOMIZED",
"EXPIRED_ITEM",
"RETURNING_GIFT",
"WRONG_SIZE",
"FAKE_OR_COUNTERFEIT",
"ARRIVED_LATE",
"DIFFERENT_FROM_LISTING",
"IN_STORE_RETURN",
"OUT_OF_STOCK",
"BUYER_REFUSED_TO_PICKUP",
"BUYER_NO_SHOW",
"BUYER_NOT_SCHEDULED",
"BUYER_CANCEL_ORDER",
"VALET_DELIVERY_ISSUES",
"VALET_UNAVAILABLE",
"DOES_NOT_FIT",
"OTHER"
]
},
"ReturnReasonTypeEnum": {
"type": "object",
"description": "This enumeration type lists the broad categories about why a buyer opens a return request.",
"enum": [
"UNKNOWN",
"SNAD",
"REMORSE",
"INSTORE",
"CANCEL"
]
},
"ReturnRefundInitiatorEnum": {
"type": "object",
"description": "This enumerated type lists the values that indicate the initiator of the refund.",
"enum": [
"SELLER_INITIATED",
"AUTO_REFUND",
"OTHER"
]
},
"ReturnRequestType": {
"type": "object",
"properties": {
"carrier": {
"type": "string",
"description": "This enumeration value indicates the shipping carrier that will be used to ship the return item.1, unless the buyer bought multiple quantity of the item in a multiple-quantity, fixed-price listing. This value defaults to 1 if this field is omitted when a return is created.",
"format": "int32"
},
"transactionId": {
"type": "string",
"description": "The unique identifier for the purchase of a item. This value is created right when the buyer is committed to buying the item, whether that buyer uses a 'Buy it Now' capability, is the winning bidder of an auction, or the buyer's Best Offer is accepted by the seller. This field is used in conjunction with the itemId field to identify a line item within an order."
},
"type": {
"description": "This enumeration value indicates the buyer's desired outcome. Note: Currently, MONEY_BACK is the only supported value.
MONEY_BACK",
"$ref": "#/components/schemas/ReturnTypeEnum"
}
},
"description": "This type is used by the returnRequest container that is used in numerous methods to provide details about the buyer's return request, including the order line item (and quantity) that is being returned and the reason for the return."
},
"ReturnResponseDueType": {
"type": "object",
"properties": {
"activityDue": {
"description": "This enumeration value informs the buyer or seller what the next action is to move the return request to the next stage.",
"$ref": "#/components/schemas/ActivityOptionEnum"
},
"respondByDate": {
"description": "The timestamp in this container indicates the deadline for when a buyer or seller must perform the next action (indicated in activityDue field) on the return request. This field will only be returned if there is a deadline associated with the next action.",
"$ref": "#/components/schemas/DateTime"
}
},
"description": "This type is used to provide the type of response due from the buyer or seller on a return request, and when this response is due."
},
"ReturnResponseHistoryType": {
"type": "object",
"properties": {
"activity": {
"description": "This enumeration value indicates the action performed by the buyer, seller, or eBay to move the return request to the next stage. This field is always returned with each action recorded under the responseHistory array.",
"$ref": "#/components/schemas/ActivityOptionEnum"
},
"attributes": {
"description": "This container consists of various return shipping and buyer refund information, such as the shipping carrier, shipment tracking number, a partial refund amount (if applicable), and a monetary transaction identifier (if applicable). This container will be returned if the the buyer/seller/eBay action (specified in the activity field) requires the data in this container.",
"$ref": "#/components/schemas/ResponseHistoryAttributesType"
},
"author": {
"description": "This enumeration value indicates the actor (such as buyer, seller, or eBay) that performed the action (specified in the activity field). This field is always with each action recorded under the responseHistory array.",
"$ref": "#/components/schemas/ReturnUserRoleEnum"
},
"creationDate": {
"description": "The timestamp in this container indicates the date/time when the action (specified in the activity field) was performed. This container is always with each action recorded under the responseHistory array.",
"$ref": "#/components/schemas/DateTime"
},
"fromState": {
"description": "This enumeration value indicates the previous state of the return request before the action (specified in the activity field) was performed. This field is always with each action recorded under the responseHistory array.",
"$ref": "#/components/schemas/ReturnStateEnum"
},
"notes": {
"type": "string",
"description": "This string value contains a note about the buyer/seller/eBay action (specified in the activity field). This field is only returned if a note exists for the action."
},
"toState": {
"description": "This enumeration value indicates the new state of the return after the action (specified in the activity field) was performed. This field is always with each action recorded under the responseHistory array.",
"$ref": "#/components/schemas/ReturnStateEnum"
}
},
"description": "This type is used by the responseHistory array, which consists of detailed information of each activity that occurs with a return request."
},
"ReturnShippingCostDetailType": {
"type": "object",
"properties": {
"itemizedReturnShippingCost": {
"type": "array",
"description": "This container consists of the costs to ship an item. A separate itemizedReturnShippingCost node will be returned for each shipping cost type, such as label cost, shipping insurance, or the signature confirmation service.",
"items": {
"$ref": "#/components/schemas/ItemizedReturnShippingCostType"
}
},
"totalAmount": {
"description": "This container shows the total amount of shipping costs associated with shipping the item. This value should equal the sum of the values in the itemizedReturnShippingCost.amount field(s).",
"$ref": "#/components/schemas/Amount"
}
},
"description": "This type is used to provide an estimate of itemized and total return shipping costs."
},
"ReturnShippingCostType": {
"type": "object",
"description": "This enumerated type lists the types of shipping costs, including the cost of the shipping label, shipping insurance, and certified shipping.",
"enum": [
"LABEL_COST",
"SIGNATURE_CONFIRMATION_COST",
"INSURANCE",
"OTHER"
]
},
"ReturnSortEnum": {
"type": "object",
"description": "This enumerated type lists all values that can be passed into the sort query parameter of the GET /post-order/v2/return/search request in order to sort return requests by a particular metric of the return request, such as filing date or status. Either a (+) or a (-) operator must prepend the enumeration value, with a (+) sign being used to sort in ascending order according to that metric, and a (-) sign being used to sort in descending order according to that metric.",
"enum": [
"FILING_DATE",
"REASON",
"STATUS",
"ESTIMATED_AMOUNT",
"BUYER_LOGIN_NAME",
"ACTUAL_AMOUNT",
"REFUND_DUE_DATE",
"RETURN_ID",
"UNKNOWN"
]
},
"ReturnSortField": {
"type": "object",
"properties": {
"ascending": {
"type": "boolean",
"description": "This boolean field is not literally used. To initiate the retrieval of return requests in ascending order, a plus sign (+) prepends the sort value. To initiate the retrieval of return requests in descending order, a minus sign (-) prepends the sort value."
},
"enumValue": {
"type": "string",
"description": "This field is not literally used, but the sort query parameter value is set to one of the values defined in ReturnSortEnum type, prepended by either a plus sign (+) or minus sign (-) to set ascending or descending order, respectively. See the ReturnSortEnum type definition for a complete list of supported sort values."
},
"field": {
"type": "string",
"description": "This field is not used."
}
},
"description": "Although the sort query parameter in the GET /post-order/v2/return/search method actually references this type, none of the elements defined in this type are literally used through the sort query parameter. "
},
"ReturnStateEnum": {
"type": "object",
"description": "This enumerated type lists the possible states for a return request. These state values are returned in the responses of the GET /post-order/v2/return/{returnId} and POST /post-order/v2/return methods.",
"enum": [
"UNKNOWN",
"INITIAL",
"RMA_PENDING",
"ITEM_READY_TO_SHIP",
"ITEM_SHIPPED",
"ITEM_DELIVERED",
"ITEM_KEPT",
"REFUND_TIMEOUT",
"PARTIAL_REFUNDED",
"REFUND_INITIATED",
"RETURN_REQUESTED",
"RETURN_LABEL_REQUESTED",
"RETURN_LABEL_REQUESTED_TIMEOUT",
"RETURN_REQUEST_TIMEOUT",
"RETURN_REJECTED",
"RETURN_LABEL_PENDING",
"RETURN_LABEL_PENDING_TIMEOUT",
"REPLACEMENT_LABEL_PENDING",
"REPLACEMENT_LABEL_PENDING_TIMEOUT",
"PARTIAL_REFUND_REQUESTED",
"PARTIAL_REFUND_INITIATED",
"PARTIAL_REFUND_FAILED",
"PARTIAL_REFUND_DECLINED",
"PARTIAL_REFUND_NON_PAYPAL_INITIATED",
"PARTIAL_REFUND_AS_PAYOUT_INITIATED",
"REPLACEMENT_REQUESTED",
"REPLACEMENT_LABEL_REQUESTED",
"REPLACEMENT_LABEL_REQUESTED_TIMEOUT",
"REPLACEMENT_REQUEST_TIMEOUT",
"REPLACEMENT_OFFER_PENDING",
"PAYOUT_INITIATED",
"AUTO_REFUND_INITIATED",
"REFUND_AS_PAYOUT_INITIATED",
"REFUND_SENT_PENDING_CONFIRMATION",
"REFUND_FAILED",
"LESS_THAN_A_FULL_REFUND_ISSUED",
"CLOSED",
"REPLACEMENT_STARTED",
"REPLACEMENT_RMA_PENDING",
"REPLACEMENT_SHIPPED",
"REPLACEMENT_DELIVERED",
"REPLACED",
"REPLACEMENT_CLOSED"
]
},
"ReturnStatusEnum": {
"type": "object",
"description": "This enumeration type lists the possible statuses for a return request.",
"enum": [
"WAITING_FOR_RMA",
"WAITING_FOR_RETURN_LABEL",
"READY_FOR_SHIPPING",
"ITEM_SHIPPED",
"ITEM_DELIVERED",
"RETURN_REQUESTED",
"RETURN_REQUESTED_TIMEOUT",
"RETURN_REJECTED",
"RETURN_LABEL_REQUESTED",
"PARTIAL_REFUND_REQUESTED",
"PARTIAL_REFUND_INITIATED",
"PARTIAL_REFUND_DECLINED",
"PARTIAL_REFUND_FAILED",
"LESS_THAN_A_FULL_REFUND_ISSUED",
"CLOSED",
"ESCALATED",
"REPLACEMENT_STARTED",
"REPLACEMENT_SHIPPED",
"REPLACEMENT_DELIVERED",
"REPLACED",
"REPLACEMENT_CLOSED",
"REPLACEMENT_WAITING_FOR_RMA",
"REPLACEMENT_REQUESTED",
"REPLACEMENT_LABEL_REQUESTED",
"UNKNOWN"
]
},
"ReturnSummaryType": {
"type": "object",
"properties": {
"buyerAvailableOptions": {
"type": "array",
"description": "This array consists one or more options that are available to the buyer to move the return request to the next stage. If the return request is currently waiting for a response from the seller, this array may not appear at all.",
"items": {
"$ref": "#/components/schemas/AvailableOptionType"
}
},
"buyerLoginName": {
"type": "string",
"description": "This string value is the eBay user name of the buyer.Note: Currently, the only supported value is MONEY_BACK.
FULL."
},
"ReturnTypeEnum": {
"type": "object",
"description": "This enumerated type lists the possible values that the buyer can pass in the type field when the buyer is creating a return request or draft with the POST /post-order/v2/return or POST /post-order/v2/return/draft methods. Note: Currently, MONEY_BACK is the only supported value.
true if the seller wishes to require that the buyer provide a Return Merchandise Authorization (RMA) when returning an item. This field is included and set to false if the seller wishes to turn off the RMA requirement when an item is returned. Since this is the only field in the request payload of the setReturnPreferences method, it is required when this method is used."
}
},
"description": "The base request type of the setReturnPreferences method."
},
"ShipmentInfoRequest": {
"type": "object",
"properties": {
"proofOfShipmentUploaded": {
"type": "boolean",
"description": "This boolean field should be included and set to true if shipment tracking information for the order line item is already available in the eBay system. If this field is included in the request and set to true, no other shipment tracking fields are necessary, although they can still be provided by the seller."
},
"sellerComments": {
"description": "This container is used if the seller wants to add a note or explanation about shipment tracking.",
"$ref": "#/components/schemas/Text"
},
"shippedWithTracking": {
"type": "boolean",
"description": "This field can be included and set to true if the shipping carrier used to ship the package uses tracking information. Most, but not all shipping carriers provide shipment tracking numbers."
},
"shippingCarrierName": {
"type": "string",
"description": "The seller provides the name of the shipping carrier in this field. This field is conditionally required unless shipment tracking information has already been uploaded to the eBay system (proofOfShipmentUploaded=true). A list of shipping carrier enumeration values can be found in the ShippingCarrierEnum type definition."
},
"shippingDate": {
"description": "The timestamp in this container indicates when the order line item was shipped. This field is conditionally required unless shipment tracking information has already been uploaded to the eBay system (proofOfShipmentUploaded=true).",
"$ref": "#/components/schemas/DateTime"
},
"trackingNumber": {
"type": "string",
"description": "The seller provides the shipping carrier's tracking number in this field. This field is conditionally required unless shipment tracking information has already been uploaded to the eBay system (proofOfShipmentUploaded=true).DELIVERED.",
"$ref": "#/components/schemas/DateTime"
},
"actualShipDate": {
"description": "The timestamp in this container indicates the date/time when the item was actually shipped from its origin address. This field is not returned until the order line item has been shipped or marked as shipped.",
"$ref": "#/components/schemas/DateTime"
},
"carrierEnum": {
"type": "string",
"description": "This value indicates the shipping carrier used to ship the return item. ShippingCarrierType contains some popular shipping carriers for the US, UK, Germany, Canada and Australia, but it is not a complete list."
},
"carrierId": {
"type": "integer",
"description": "This integer value is the numeric identifier of the shipping carrier. This field is returned if available.",
"format": "int32"
},
"carrierName": {
"type": "string",
"description": "This field shows the name of the shipping carrier. This field is returned if available."
},
"carrierUsed": {
"type": "string",
"description": "This string value indicates the shipping carrier used to ship the item. This field is returned if available."
},
"deliveryDate": {
"description": "THIS FIELD IS DEPRECATED. SEE actualDeliveryDate FIELD INSTEAD.",
"$ref": "#/components/schemas/DateTime"
},
"deliveryStatus": {
"description": "This enumeration value indicates the tracking status of the item. This value may get returned as UNKNOWN if shipment tracking has not been provided.",
"$ref": "#/components/schemas/TrackingStatusEnum"
},
"destinationAddress": {
"description": "This container provides the full address of the item's shipping destination.",
"$ref": "#/components/schemas/ReturnAddressType"
},
"errorCode": {
"type": "string",
"description": "This field is only returned if the user encountered an error when trying to provide shipment tracking information."
},
"labelAvailableUntilDate": {
"type": "string",
"description": "The timestamp in this container indicates when the shipping label will expire and will no longer be valid to print and use."
},
"labelDate": {
"description": "The timestamp in this container indicates when the shipping label was created. This container is returned if a shipping label exists for the order line item.",
"$ref": "#/components/schemas/DateTime"
},
"labelId": {
"type": "string",
"description": "This string value is the unique eBay-assigned ID of the shipping label. This field is returned if a shipping label exists for the order line item."
},
"labelPrintExpired": {
"type": "boolean",
"description": "This boolean field will be returned as true if the shipping label has expired and is no longer valid to print and use for shipping."
},
"labelVoidExpired": {
"type": "boolean",
"description": "This boolean field will be returned as true if the initiator of the shipping label no longer has the ability to void the shipping label."
},
"markAsReceived": {
"type": "boolean",
"description": "This boolean field will be returned as true if the item has been mark as received by the recipient."
},
"maxDeliveryEstimate": {
"description": "The timestamp in this container indicates the latest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.",
"$ref": "#/components/schemas/DateTime"
},
"minDeliveryEstimate": {
"description": "The timestamp in this container indicates the earliest date/time when the shipment may arrive at its destination address, based on the shipping carrier and shipping service being used.",
"$ref": "#/components/schemas/DateTime"
},
"originAddress": {
"description": "This container provides the full address of the item's origin address.",
"$ref": "#/components/schemas/ReturnAddressType"
},
"shipDate": {
"description": "THIS FIELD IS DEPRECATED. SEE actualShipDate FIELD INSTEAD.",
"$ref": "#/components/schemas/DateTime"
},
"shipmentId": {
"type": "string",
"description": "This string value is the unique eBay-assigned ID of the shipment. This field is returned if available."
},
"shippedBy": {
"description": "This enumeration value indicates the party shipping the item, such as buyer or seller.",
"$ref": "#/components/schemas/ReturnUserRoleEnum"
},
"shippingMethod": {
"description": "This enumeration value indicates whether the buyer/seller used an eBay shipping label or arranged for shipping on their own.",
"$ref": "#/components/schemas/ShippingMethodEnum"
},
"trackingNumber": {
"type": "string",
"description": "This value is the tracking number of the shipment. This field is returned if shipment tracking has been uploaded."
}
},
"description": "This type is used by the shipmentTracking and allShipmentTrackings containers, which provide detailed information on the whereabouts of a shipped item, including the tracking number, origin and destination addresses, shipping status, estimated and actual shipping and delivery dates, and more."
},
"ShipmentType": {
"type": "object",
"properties": {
"allShipmentTrackings": {
"type": "array",
"description": "This container is an array of shipment tracking information for a return item.",
"items": {
"$ref": "#/components/schemas/ShipmentTrackingType"
}
},
"payee": {
"description": "This enumeration value indicates whether the buyer or seller will be paying for shipment of item.",
"$ref": "#/components/schemas/ReturnUserRoleEnum"
},
"shipmentTracking": {
"description": "This container provides detailed information on the whereabouts of a shipped item, including tracking number, origin and destination address, shipping status, estimated and actual shipping and delivery dates, and more.",
"$ref": "#/components/schemas/ShipmentTrackingType"
},
"shippingLabelCost": {
"description": "This container provides the itemized list of costs associated with shipping the item.",
"$ref": "#/components/schemas/ReturnShippingCostDetailType"
}
},
"description": "This type is used to provide detailed information on shipment of a return item."
},
"ShippingCarrierEnum": {
"type": "object",
"description": "This enumeration type lists the values that indicate the shipping carriers commonly used to ship an item in the US, UK, Germany, Canada, and Australia. This is not a full collection of shipping carriers used all over the world.",
"enum": [
"UNKNOWN",
"OTHER",
"USPS",
"UPS",
"FEDEX",
"COLLECT_PLUS",
"ROYAL_MAIL",
"PARCEL_FORCE",
"HERMES",
"AUSTRALIA_POST",
"CANADA_POST",
"DEUTSCHE_POST",
"DHL",
"POSTE",
"BARTOLINI",
"NEXIVE",
"LA_POSTE",
"MONDIAL_RELAY",
"COLISSIMO",
"CORREOS",
"SEUR",
"MRW"
]
},
"ShippingMethodEnum": {
"type": "object",
"description": "This enumerated type lists the values that indicate whether the buyer/seller used an eBay shipping label or arranged for shipping on their own.",
"enum": [
"SELF_MAIL",
"SHIPPING_LABEL",
"UNKNOWN"
]
},
"StatusType": {
"type": "object",
"description": "This enumerated type lists the values that can be returned in the responses of the GET /post-order/v2/return/check_eligibility and POST /post-order/v2/return methods. See the enumeration descriptions for more information about what these values indicate based on which response these values are returned in.",
"enum": [
"SUCCESS",
"SELLER_APPROVAL",
"FAILED",
"WARNING",
"UNKNOWN"
]
},
"Text": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "This field displays the actual textual content in the language specified in the language field. This field is always used for containers using the Text type."
},
"language": {
"type": "string",
"description": "This two-letter code indicates the language used to display the content in the content field. The language will default to the language used on the eBay site if a specific language is not specified through the Accept-Language HTTP header. This field is always used for containers using the Text type.Note: The data field supports single-time base64 encoding. For backward compatibility, the data field also presently supports double base64 encoding.
" }, "fileName": { "type": "string", "description": "This field is used to name the file that is being uploaded. Naming a file may make it easier for the buyer or seller to keep track of their files, instead of having to remember the fileId value (which is returned in the response) of each file." }, "filePurpose": { "description": "The enumeration value supplied in this required field indicates the purpose of the file that you're uploading. One of the values defined in the FilePurposeEnum type definition must be used in this field.", "$ref": "#/components/schemas/FilePurposeEnum" } }, "description": "The base request type for the POST /post-order/v2/return/{returnId}/file/upload and POST /post-order/v2/return/draft/{draftId}/file/upload methods." }, "UploadFileResponse": { "type": "object", "properties": { "compressedFileData": { "type": "string", "description": "This field is the base64-encoded binary representation of the compressed version of the file that was uploaded with the request. This field will be returned if the file was successfully associated to the return request or return request draft." }, "fileId": { "type": "string", "description": "This is unique eBay-assigned ID of the file associated with a return request or return request draft. This field will be returned if the file was successfully associated to the return request or return request draft." } }, "description": "The base response type of the POST /post-order/v2/return/draft/{draftId}/file/upload and POST /post-order/v2/return/{returnId}/file/upload methods." }, "UserPartyEnum": { "type": "object", "description": "This enumerated type lists the types of users who can possibly perform an action on an INR inquiry or a case.", "enum": [ "UNKNOWN", "SELLER", "BUYER", "CSR", "SYSTEM" ] }, "UserRoleFilterEnum": { "type": "object", "description": "This enumeration type identifies the different types of user role values that can be used with the role query parameter.", "enum": [ "SELLER", "BUYER" ] }, "VoluntaryRefundResponse": { "type": "object", "properties": { "refundResult": { "description": "This container shows the result of the refund action and the source being used for the buyer refund.", "$ref": "#/components/schemas/VoluntaryRefundResult" } }, "description": "This type is used by the base responses of the POST /post-order/v2/inquiry/{inquiryId}/issue_refund and POST /post-order/v2/casemanagement/{caseId}/issue_refund methods to indicate the result of a refund action." }, "VoluntaryRefundResult": { "type": "object", "properties": { "refundSource": { "description": "This enumeration value indicates the payment source used to refund the buyer to resolve an inquiry or case.", "$ref": "#/components/schemas/RefundPaymentTypeEnum" }, "refundStatus": { "description": "This enumeration value indicates the success or failure of a full refund being issued by the seller through an issue_refund method.", "$ref": "#/components/schemas/RefundStatusEnum" } }, "description": "This type is used by the refundResult container, which shows the payment source used and status of the refund to the buyer." }, "WorldRegionEnum": { "type": "object", "description": "This enumerated type contains of list of world regions.", "enum": [ "AFRICA", "AMERICAS", "ASIA", "CARIBBEAN", "CENTRALAMERICA", "EUROPE", "EUROPEANUNION", "LATINAMERICA", "MIDDLEEAST", "NORTHAMERICA", "OCEANIA", "SOUTHAMERICA", "SOUTHEASTASIA" ] }, "ResolutionEstimate": { "type": "object", "properties": { "resolutionEstimateDate": { "$ref": "#/components/schemas/DateTime", "description": "This value indicates the estimated resolution date for the inquiry." } }, "description": "This type defines the estimated resolution date for the inquiry." }, "ProvisionalRefund": { "type": "object", "properties": { "refundProvided": { "type": "boolean", "description": "This value indicates whether a provisional refund was issued to the buyer." }, "refundReversed": { "type": "boolean", "description": "This value indicates whether the provisional refund was later reversed." } }, "description": "This type defines whether a provisional refund was issued to the buyer and whether the provisional refund was later reversed." }, "ProvisionalRefundType": { "type": "object", "properties": { "refundProvided": { "type": "boolean", "description": "This value indicates whether a provisional refund was issued to the buyer before return creation." }, "refundReversed": { "type": "boolean", "description": "This value indicates whether the provisional refund was later reversed." } }, "description": "This type defines whether a provisional refund was issued to the buyer before return creation and later reversed." } }, "securitySchemes": { "api_auth": { "type": "oauth2", "description": "The security definitions for this API. Please check individual operations for applicable scopes.", "flows": { "clientCredentials": { "tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "scopes": { "https://api.ebay.com/oauth/api_scope": "View public data from eBay" } }, "authorizationCode": { "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "scopes": {} } } }, "bearerAuth": { "type": "http", "scheme": "bearer" } } } }