{ "openapi": "3.0.0", "info": { "title": "Fulfillment API", "description": "Use the Fulfillment API to complete the process of packaging, addressing, handling, and shipping each order on behalf of the seller, in accordance with the payment method and timing specified at checkout.", "contact": { "name": "eBay Inc." }, "license": { "name": "eBay API License Agreement", "url": "https://developer.ebay.com/join/api-license-agreement" }, "version": "v1.20.7" }, "servers": [ { "url": "https://api.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/fulfillment/v1" } } }, { "url": "https://apiz.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/fulfillment/v1" } } } ], "paths": { "/order/{orderId}": { "get": { "tags": [ "order" ], "description": "Use this call to retrieve the contents of an order based on its unique identifier, orderId. This value was returned in the getOrders call's orders.orderId field when you searched for orders by creation date, modification date, or fulfillment status. Include the optional fieldGroups query parameter set to TAX_BREAKDOWN to return a breakdown of the taxes and fees.

The returned Order object contains information you can use to create and process fulfillments, including: ", "operationId": "getOrder", "parameters": [ { "name": "fieldGroups", "in": "query", "description": "This parameter lets you control what is returned in the response.

Note: The only presently supported value is TAX_BREAKDOWN. This field group adds addition fields to the response that return a breakdown of taxes and fees.", "required": false, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "description": "This path parameter is used to specify the unique identifier of the order being retrieved.

Use the getOrders method to retrieve order IDs. Order ID values are also shown in My eBay/Seller Hub.

Note: getOrders can return orders up to two years old. Do not provide the orderId for an order created more than two years in the past.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "32100": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid order ID: {orderId}" }, "32800": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid field group: {fieldGroup}" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "30500": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "System error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.fulfillment", "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly" ] } ] } }, "/order": { "get": { "tags": [ "order" ], "description": "Use this method to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the filter parameter. You can alternatively specify a list of orders using the orderIds parameter. Include the optional fieldGroups query parameter set to TAX_BREAKDOWN to return a breakdown of the taxes and fees. By default, when no filters are used this call returns all orders created within the last 90 days.

The returned Order objects contain information you can use to create and process fulfillments, including:

Important: In this call, the cancelStatus.cancelRequests array is returned but is always empty. Use the getOrder call instead, which returns this array fully populated with information about any cancellation requests.", "operationId": "getOrders", "parameters": [ { "name": "fieldGroups", "in": "query", "description": "This parameter lets you control what is returned in the response.

Note: The only presently supported value is TAX_BREAKDOWN. This field group adds addition fields to the response that return a breakdown of taxes and fees.", "required": false, "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "One or more comma-separated criteria for narrowing down the collection of orders returned by this call. These criteria correspond to specific fields in the response payload. Multiple filter criteria combine to further restrict the results.

Note: getOrders can return orders up to two years old. Do not set the creationdate filter to a date beyond two years in the past.
Note: If the orderIds parameter is included in the request, the filter parameter will be ignored.
The available criteria are as follows:
creationdate
The time period during which qualifying orders were created (the orders.creationDate field). In the URI, this is expressed as a starting timestamp, with or without an ending timestamp (in brackets). The timestamps are in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.For example:
lastmodifieddate
The time period during which qualifying orders were last modified (the orders.modifiedDate field). In the URI, this is expressed as a starting timestamp, with or without an ending timestamp (in brackets). The timestamps are in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.For example: Note: If creationdate and lastmodifieddate are both included, only creationdate is used.

orderfulfillmentstatus
The degree to which qualifying orders have been shipped (the orders.orderFulfillmentStatus field). In the URI, this is expressed as one of the following value combinations: Note: The values NOT_STARTED, IN_PROGRESS, and FULFILLED can be used in various combinations, but only the combinations shown here are currently supported.
Here is an example of a getOrders call using all of these filters:

GET https://api.ebay.com/sell/v1/order?
filter=creationdate:%5B2016-03-21T08:25:43.511Z..2016-04-21T08:25:43.511Z%5D,
lastmodifieddate:%5B2016-05-15T08:25:43.511Z..%5D,
orderfulfillmentstatus:%7BNOT_STARTED%7CIN_PROGRESS%7D

Note: This call requires that certain special characters in the URI query string be percent-encoded:
    [ = %5B       ] = %5D       { = %7B       | = %7C       } = %7D
This query filter example uses these codes. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/fulfillment/types/api:FilterField", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The number of orders to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

For example, if offset is set to 10 and limit is set to 10, the call retrieves orders 11 thru 20 from the result set.

If a limit is not set, the limit defaults to 50 and returns up to 50 orders. If a requested limit is more than 200, the call fails and returns an error.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0. If the orderIds parameter is included in the request, this parameter will be ignored.

Maximum: 200
Default: 50", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Specifies the number of orders to skip in the result set before returning the first order in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set.

Default: 0

", "required": false, "schema": { "type": "string" } }, { "name": "orderIds", "in": "query", "description": "A comma-separated list of the unique identifiers of the orders to retrieve (maximum 50). If one or more order ID values are specified through the orderIds query parameter, all other query parameters will be ignored.

Note: getOrders can return orders up to two years old. Do not provide the orderId for an order created more than two years in the past.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSearchPagedCollection" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "30700": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid filter name: {fieldname}" }, "30800": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid filter value {fieldvalue} for filter {fieldname}" }, "30810": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid date format" }, "30820": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Start date is missing" }, "30830": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Time range between start date and end date must be within '{allowedTime}' years." }, "30840": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Start date should be before end date" }, "30850": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Start and end dates can't be in the future" }, "30900": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Exceeded maximum number of order IDs (the current limit is 50)" }, "31000": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid offset: {offsetvalue}" }, "31100": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid limit: {limitvalue}" }, "32800": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid field group: {fieldGroup}" } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "30500": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "System error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.fulfillment", "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly" ] } ] } }, "/order/{order_id}/issue_refund": { "post": { "tags": [ "order" ], "summary": "Issue Refund", "description": "

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 issueRefund. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.


This method allows a seller to issue a full or partial refund to a buyer for an order. Full or partial refunds can be issued at the order level or line item level.

The refunds issued through this method are processed asynchronously, so the refund will not show as 'Refunded' right away. A seller will have to make a subsequent getOrder call to check the status of the refund. The status of an order refund can be found in the paymentSummary.refunds.refundStatus field of the getOrder response.", "operationId": "issueRefund", "parameters": [ { "name": "order_id", "in": "path", "description": "This path parameter is used to specify the unique identifier of the order associated with a refund.

Use the getOrders method to retrieve order IDs.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueRefundRequest" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refund" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "34901": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Order id can't be null or empty." }, "34902": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Request can't be empty." }, "34903": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "The refund reason must be specified." }, "34905": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Either orderLevelRefundAmount or refundItems must be specified." }, "34906": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "The amount value must be specified." }, "34907": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "The amount value must be positive and within two decimals." }, "34908": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "The amount currency must be specified." }, "34909": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "The amount currency isn't correct." }, "34910": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Either legacyReference or lineItemId must be specified for item level refund." }, "34911": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Legacy item id must be specified for item level refund if you use legacyReference." }, "34912": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Legacy transaction id must be specified for item level refund if you use legacyReference." }, "34914": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Can't find the item in the order." }, "34915": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "The refund amount exceeds order amount." }, "34916": { "domain": "API_FULFILLMENT", "category": "BUSINESS", "description": "A post-transaction case exists on this order, seller refund can't be triggered." }, "34917": { "domain": "API_FULFILLMENT", "category": "BUSINESS", "description": "This order was already refunded." }, "34920": { "domain": "API_FULFILLMENT", "category": "BUSINESS", "description": "It's too late to issue a refund for this order." }, "34921": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "The comment exceeds the length limit, please make sure it doesn't exceed 1000 characters." }, "34922": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Refund can't be issued while previous refund is processing." }, "34923": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Refund cannot be issued for this type of order." } } } }, "403": { "description": "Access Forbidden" }, "404": { "description": "Resource Not found", "x-response-codes": { "errors": { "34913": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Can not find the order." } } } }, "409": { "description": "Conflict", "x-response-codes": { "errors": { "34918": { "domain": "API_FULFILLMENT", "category": "BUSINESS", "description": "This is not an eBay managed payments order." }, "34919": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Unauthorized access." }, "34924": { "domain": "API_FULFILLMENT", "category": "BUSINESS", "description": "The item refund amount exceeds the item remaining amount." }, "34925": { "domain": "API_FULFILLMENT", "category": "BUSINESS", "description": "The refund operation could not be completed with any of the payment methods saved to the seller's account." }, "34926": { "domain": "API_FULFILLMENT", "category": "BUSINESS", "description": "A suitable payment method could not be found for the refund operation. Please resolve in Seller Hub." }, "34927": { "domain": "API_FULFILLMENT", "category": "BUSINESS", "description": "The selected payment method for the refund operation was invalid or declined." }, "34928": { "domain": "API_FULFILLMENT", "category": "BUSINESS", "description": "Your refund did not go through because we could not verify your payment option. Please change your payment option and try again." }, "34929": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "You cannot refund this order yet since the buyer payment has not been processed. Please try again later." }, "34930": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Default payment method limit exceeded. Please use a different payment option or try again later." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "34900": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.finances" ] } ] } }, "/order/{orderId}/shipping_fulfillment": { "get": { "tags": [ "shipping_fulfillment" ], "description": "Use this call to retrieve the contents of all fulfillments currently defined for a specified order based on the order's unique identifier, orderId. This value is returned in the getOrders call's members.orderId field when you search for orders by creation date or shipment status.", "operationId": "getShippingFulfillments", "parameters": [ { "name": "orderId", "in": "path", "description": "This path parameter is used to specify the unique identifier of the order associated with the shipping fulfillments being retrieved.

Use the getOrders method to retrieve order IDs. Order ID values are also shown in My eBay/Seller Hub.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingFulfillmentPagedCollection" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "32100": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid order ID: {orderId}" } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "30500": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "System error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.fulfillment", "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly" ] } ] }, "post": { "tags": [ "shipping_fulfillment" ], "description": "When you group an order's line items into one or more packages, each package requires a corresponding plan for handling, addressing, and shipping; this is a shipping fulfillment. For each package, execute this call once to generate a shipping fulfillment associated with that package.

Note: A single line item in an order can consist of multiple units of a purchased item, and one unit can consist of multiple parts or components. Although these components might be provided by the manufacturer in separate packaging, the seller must include all components of a given line item in the same package.

Before using this call for a given package, you must determine which line items are in the package. If the package has been shipped, you should provide the date of shipment in the request. If not provided, it will default to the current date and time.", "operationId": "createShippingFulfillment", "parameters": [ { "name": "orderId", "in": "path", "description": "This path parameter is used to specify the unique identifier of the order associated with the shipping fulfillment being created.

Use the getOrders method to retrieve order IDs.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "fulfillment payload", "content": { "application/json": { "schema": { "description": "fulfillment payload", "$ref": "#/components/schemas/ShippingFulfillmentDetails" } } }, "required": true }, "responses": { "201": { "description": "Created. The call also returns the following location response header:

{ENV}/sell/fulfillment/v1/order/{ORDERID}/shipping_fulfillment/{FULFILLMENTID}

The ENV string is the HTTPS path to the same eBay supported environment in which this call was issued. The ORDERID parameter is the unique identifier of the order addressed by this call; for example, 01-03955-36441. The FULFILLMENTID parameter identifies the newly created fulfillment; for example, 9405509699937003457459. Use this Get Fulfillment URI to retrieve the contents of the new fulfillment.", "headers": { "Location": { "schema": { "type": "string", "description": "The location response header contains the getShippingFulfillment URI to retrieve the contents of the newly created shipping fulfillment. The URL includes the eBay-assigned fulfillmentId, which you can use to reference the shipping fulfillment." } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "32100": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid Order Id: {orderId}" }, "32200": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid line item id: {lineItemId}" }, "32210": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Duplicate line item in the request" }, "32300": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid shipment tracking number or carrier" }, "32400": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Requested user is suspended" }, "32500": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid shipped date" }, "32600": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid input data" }, "34100": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Maximum tracking number for order is exceeded" }, "34200": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Line Items contain Global Shipping Program and non-Global Shipping Program orders" }, "34300": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Mark As Shipped for multiple Global Shipping Program line items is not supported" }, "34500": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Please use PUT operation for updating shipping fulfillment" } } } }, "409": { "description": "Conflict" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "30500": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "System error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.fulfillment" ] } ] } }, "/order/{orderId}/shipping_fulfillment/{fulfillmentId}": { "get": { "tags": [ "shipping_fulfillment" ], "description": "Use this call to retrieve the contents of a fulfillment based on its unique identifier, fulfillmentId (combined with the associated order's orderId). The fulfillmentId value was originally generated by the createShippingFulfillment call, and is returned by the getShippingFulfillments call in the members.fulfillmentId field.", "operationId": "getShippingFulfillment", "parameters": [ { "name": "fulfillmentId", "in": "path", "description": "This path parameter is used to specify the unique identifier of the shipping fulfillment being retrieved.

Use the getShippingFulfillments method to retrieved fulfillment IDs.", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "description": "This path parameter is used to specify the unique identifier of the order associated with the shipping fulfillment being retrieved.

Use the getOrders method to retrieve order IDs. Order ID values are also shown in My eBay/Seller Hub.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingFulfillment" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "32100": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid order ID: {orderId}" }, "32110": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid shipping fulfillment ID: {fulfillmentId}" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "30500": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "System error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.fulfillment", "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly" ] } ] } }, "/payment_dispute/{payment_dispute_id}": { "get": { "tags": [ "payment_dispute" ], "summary": "Get Payment Dispute Details", "description": "This method retrieves detailed information on a specific payment dispute. The payment dispute identifier is passed in as path parameter at the end of the call URI.

Below is a summary of the information that is retrieved:", "operationId": "getPaymentDispute", "parameters": [ { "name": "payment_dispute_id", "in": "path", "description": "This parameter is used to specify the unique identifier of the payment dispute being retrieved.

Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentDispute" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Invalid Payment Dispute Id", "x-response-codes": { "errors": { "33001": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid Payment Dispute Id" } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "33000": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" ] } ] }, "servers": [ { "url": "https://apiz.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/fulfillment/v1" } } } ] }, "/payment_dispute/{payment_dispute_id}/fetch_evidence_content": { "get": { "tags": [ "payment_dispute" ], "summary": "Get Payment Dispute Evidence File", "description": "This call retrieves a specific evidence file for a payment dispute. The following three identifying parameters are needed in the call URI:

An actual binary file is returned if the call is successful. An error will occur if any of three identifiers are invalid.

", "operationId": "fetchEvidenceContent", "parameters": [ { "name": "payment_dispute_id", "in": "path", "description": "This path parameter is used to specify the unique identifier of the payment dispute associated with the evidence file being retrieved.

Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs.", "required": true, "schema": { "type": "string" } }, { "name": "evidence_id", "in": "query", "description": "This query parameter is used to specify the unique identifier of the evidential file set.

The identifier of an evidential file set for a payment dispute is returned under the evidence array in the getPaymentDispute response.", "required": true, "schema": { "type": "string" } }, { "name": "file_id", "in": "query", "description": "This query parameter is used to specify the unique identifier of an evidential file. This file must belong to the evidential file set identified through the evidence_id query parameter.

The identifier of each evidential file is returned under the evidence.files array in the getPaymentDispute response.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "33002": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid Evidence Id" }, "33003": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid Evidence File Id" } } } }, "404": { "description": "Invalid Payment Dispute Id", "x-response-codes": { "errors": { "33001": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid Payment Dispute Id" } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "33000": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" ] } ] }, "servers": [ { "url": "https://apiz.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/fulfillment/v1" } } } ] }, "/payment_dispute/{payment_dispute_id}/activity": { "get": { "tags": [ "payment_dispute" ], "summary": "Get Payment Dispute Activity", "description": "This method retrieve a log of activity for a payment dispute. The identifier of the payment dispute is passed in as a path parameter. The output includes a timestamp for each action of the payment dispute, from creation to resolution, and all steps in between.", "operationId": "getActivities", "parameters": [ { "name": "payment_dispute_id", "in": "path", "description": "This parameter is used to specify the unique identifier of the payment dispute associated with the activity log being retrieved.

Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentDisputeActivityHistory" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Invalid Payment Dispute Id", "x-response-codes": { "errors": { "33001": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid Payment Dispute Id" } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "33000": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" ] } ] }, "servers": [ { "url": "https://apiz.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/fulfillment/v1" } } } ] }, "/payment_dispute_summary": { "get": { "tags": [ "payment_dispute" ], "summary": "Search Payment Dispute by Filters", "description": "This method is used retrieve one or more payment disputes filed against the seller. These payment disputes can be open or recently closed. The following filter types are available in the request payload to control the payment disputes that are returned:More than one of these filter types can be used together. See the request payload request fields for more information about how each filter is used.

If none of the filters are used, all open and recently closed payment disputes are returned.

Pagination is also available. See the limit and offset fields for more information on how pagination is used for this method.", "operationId": "getPaymentDisputeSummaries", "parameters": [ { "name": "order_id", "in": "query", "description": "This filter is used if the seller wishes to retrieve one or more payment disputes filed against a specific order. It is possible that there can be more than one dispute filed against an order if the order has multiple line items. If this filter is used, any other filters are ignored.

Use the getOrders method to retrieve order IDs. Order ID values are also shown in My eBay/Seller Hub.", "required": false, "schema": { "type": "string" } }, { "name": "buyer_username", "in": "query", "description": "This filter is used if the seller wishes to retrieve one or more payment disputes opened by a specific buyer. The string that is passed in to this query parameter is the eBay user ID of the buyer.", "required": false, "schema": { "type": "string" } }, { "name": "open_date_from", "in": "query", "description": "The open_date_from and/or open_date_to date filters are used if the seller wishes to retrieve payment disputes opened within a specific date range. A maximum date range that may be set with the open_date_from and/or open_date_to filters is 90 days. These date filters use the ISO-8601 24-hour date and time format, and time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu.

The open_date_from field sets the beginning date of the date range, and can be set as far back as 18 months from the present time. If a open_date_from field is used, but a open_date_to field is not used, the open_date_to value will default to 90 days after the date specified in the open_date_from field, or to the present time if less than 90 days in the past.

The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.", "required": false, "schema": { "type": "string" } }, { "name": "open_date_to", "in": "query", "description": "The open_date_from and/or open_date_to date filters are used if the seller wishes to retrieve payment disputes opened within a specific date range. A maximum date range that may be set with the open_date_from and/or open_date_to filters is 90 days. These date filters use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu.

The open_date_to field sets the ending date of the date range, and can be set up to 90 days from the date set in the open_date_from field.

The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z.", "required": false, "schema": { "type": "string" } }, { "name": "payment_dispute_status", "in": "query", "description": "This filter is used if the seller wishes to only retrieve payment disputes in one or more specific states. To filter by more than one status value, a separate payment_dispute_status filter must be used for each value, as shown below:

https://apiz.ebay.com/sell/fulfillment/v1/payment_dispute_summary?payment_dispute_status=OPEN&payment_dispute_status=ACTION_NEEDED

If no payment_dispute_status filter is used, payment disputes in all states are returned in the response.

See DisputeStatusEnum type for supported values.", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The value passed in this query parameter sets the maximum number of payment disputes to return per page of data. The value passed in this field should be an integer from 1 to 200. If this query parameter is not set, up to 200 records will be returned on each page of results.

Min: 1

Max: 200

Default: 200", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "This field is used to specify the number of records to skip in the result set before returning the first payment dispute in the paginated response. A zero-based index is used, so if you set the offset value to 0 (default value), the first payment dispute in the result set appears at the top of the response.

Combine offset with the limit parameter to control the payment disputes returned in the response. For example, if you supply an offset value of 0 and a limit value of 10, the response will contain the first 10 payment disputes from the result set that matches the input criteria. If you supply an offset value of 10 and a limit value of 20, the response will contain payment disputes 11-30 from the result set that matches the input criteria.

Min: 0

Default: 0", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisputeSummaryResponse" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "33001": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid input request" } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "33000": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" ] } ] }, "servers": [ { "url": "https://apiz.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/fulfillment/v1" } } } ] }, "/payment_dispute/{payment_dispute_id}/contest": { "post": { "tags": [ "payment_dispute" ], "summary": "Contest Payment Dispute", "description": "This method is used if the seller wishes to contest a payment dispute initiated by the buyer. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method.

Note: Before contesting a payment dispute, the seller must upload all supporting files using the addEvidence and updateEvidence methods. Once the seller has officially contested the dispute (using contestPaymentDispute), the addEvidence and updateEvidence methods can no longer be used. In the evidenceRequests array of the getPaymentDispute response, eBay prompts the seller with the type of supporting file(s) that will be needed to contest the payment dispute.

If a seller decides to contest a payment dispute, that seller should be prepared to provide supporting documents such as proof of delivery, proof of authentication, or other documents. The type of supporting documents that the seller will provide will depend on why the buyer filed the payment dispute.

The revision field in the request payload is required, and the returnAddress field should be supplied if the seller is expecting the buyer to return the item. See the Request Payload section for more information on these fields.", "operationId": "contestPaymentDispute", "parameters": [ { "name": "payment_dispute_id", "in": "path", "description": "This parameter is used to specify the unique identifier of the payment dispute being contested.

Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContestPaymentDisputeRequest" } } }, "required": false }, "responses": { "204": { "description": "Success" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "33100": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid input request" } } } }, "404": { "description": "Not Found" }, "409": { "description": "Conflict", "x-response-codes": { "errors": { "33011": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "There was a change in payment dispute attributes. Please use get payment dispute api to get latest details." }, "33101": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid payment dispute state" }, "33102": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "No evidence available for contest" } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "33000": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" ] } ] }, "servers": [ { "url": "https://apiz.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/fulfillment/v1" } } } ] }, "/payment_dispute/{payment_dispute_id}/accept": { "post": { "tags": [ "payment_dispute" ], "summary": "Accept Payment Dispute", "description": "This method is used if the seller wishes to accept a payment dispute. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method.

The revision field in the request payload is required, and the returnAddress field should be supplied if the seller is expecting the buyer to return the item. See the Request Payload section for more information on theste fields.", "operationId": "acceptPaymentDispute", "parameters": [ { "name": "payment_dispute_id", "in": "path", "description": "This parameter is used to specify the unique identifier of the payment dispute being accepted.

Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptPaymentDisputeRequest" } } }, "required": false }, "responses": { "204": { "description": "Success" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "33100": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid input request" } } } }, "404": { "description": "Not Found" }, "409": { "description": "Conflict", "x-response-codes": { "errors": { "33011": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "There was a change in payment dispute attributes. Please use get payment dispute api to get latest details." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "33000": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" ] } ] }, "servers": [ { "url": "https://apiz.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/fulfillment/v1" } } } ] }, "/payment_dispute/{payment_dispute_id}/upload_evidence_file": { "post": { "tags": [ "payment_dispute" ], "summary": "Upload an Evidence File", "description": "This method is used to upload an evidence file for a contested payment dispute. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method.

Note: The uploadEvidenceFile only uploads an encrypted, binary image file (using multipart/form-data HTTP request header), and does not have a JSON-based request payload.

Use 'file' as the name of the key that you use to upload the image file. The upload will not be successful if a different key name is used.

The three image formats supported at this time are .JPEG, .JPG, and .PNG.

After the file is successfully uploaded, the seller will need to grab the fileId value in the response payload to add this file to a new evidence set using the addEvidence method, or to add this file to an existing evidence set using the updateEvidence method.", "operationId": "uploadEvidenceFile", "parameters": [ { "name": "payment_dispute_id", "in": "path", "description": "This parameter is used to specify the unique identifier of the contested payment dispute for which the user intends to upload an evidence file.

Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to multipart/form-data.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileEvidence" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "33005": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "File type is invalid." }, "33006": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "File size should be 1.5 MB or less." }, "33106": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "The file name should not be empty and should not exceed 255 characters." }, "33107": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Only one file can be uploaded per request." } } } }, "404": { "description": "Not Found", "x-response-codes": { "errors": { "33001": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid Payment Dispute Id" } } } }, "409": { "description": "Conflict", "x-response-codes": { "errors": { "33004": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Upload file for evidence is not permitted for given payment dispute state." }, "33105": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "You reached the maximum number of files you can upload." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "33000": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" ] } ] }, "servers": [ { "url": "https://apiz.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/fulfillment/v1" } } } ] }, "/payment_dispute/{payment_dispute_id}/add_evidence": { "post": { "tags": [ "payment_dispute" ], "summary": "Add an Evidence File", "description": "This method is used by the seller to add one or more evidence files to address a payment dispute initiated by the buyer. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method.

Note: All evidence files should be uploaded using addEvidence and updateEvidence before the seller decides to contest the payment dispute. Once the seller has officially contested the dispute (using contestPaymentDispute or through My eBay), the addEvidence and updateEvidence methods can no longer be used. In the evidenceRequests array of the getPaymentDispute response, eBay prompts the seller with the type of evidence file(s) that will be needed to contest the payment dispute.

The file(s) to add are identified through the files array in the request payload. Adding one or more new evidence files for a payment dispute triggers the creation of an evidence file, and the unique identifier for the new evidence file is automatically generated and returned in the evidenceId field of the addEvidence response payload upon a successful call.

The type of evidence being added should be specified in the evidenceType field. All files being added (if more than one) should correspond to this evidence type.

Upon a successful call, an evidenceId value is returned in the response. This indicates that a new evidence set has been created for the payment dispute, and this evidence set includes the evidence file(s) that were passed in to the fileId array. The evidenceId value will be needed if the seller wishes to add to the evidence set by using the updateEvidence method, or if they want to retrieve a specific evidence file within the evidence set by using the fetchEvidenceContent method.", "operationId": "addEvidence", "parameters": [ { "name": "payment_dispute_id", "in": "path", "description": "This parameter is used to specify the unique identifier of the contested payment dispute for which the seller wishes to add evidence files.

Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddEvidencePaymentDisputeRequest" } } }, "required": false }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddEvidencePaymentDisputeResponse" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "33003": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid Evidence File Id" }, "33007": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid line items." }, "33008": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid evidence type." }, "33009": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "User did not echo back the evidence metadata correctly." }, "33100": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid input request" }, "33103": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Exceed allowed file count" }, "33104": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "The combined size of attached files should be 1.5MB or less." } } } }, "404": { "description": "Not Found", "x-response-codes": { "errors": { "33001": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid Payment Dispute Id" } } } }, "409": { "description": "Conflict", "x-response-codes": { "errors": { "33004": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Upload file for evidence is not permitted for given payment dispute state." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "33000": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" ] } ] }, "servers": [ { "url": "https://apiz.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/fulfillment/v1" } } } ] }, "/payment_dispute/{payment_dispute_id}/update_evidence": { "post": { "tags": [ "payment_dispute" ], "summary": "Update evidence", "description": "This method is used by the seller to update an existing evidence set for a payment dispute with one or more evidence files. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method.

Note: All evidence files should be uploaded using addEvidence and updateEvidence before the seller decides to contest the payment dispute. Once the seller has officially contested the dispute (using contestPaymentDispute or through My eBay), the addEvidence and updateEvidence methods can no longer be used. In the evidenceRequests array of the getPaymentDispute response, eBay prompts the seller with the type of evidence file(s) that will be needed to contest the payment dispute.

The unique identifier of the evidence set to update is specified through the evidenceId field, and the file(s) to add are identified through the files array in the request payload. The unique identifier for an evidence file is automatically generated and returned in the fileId field of the uploadEvidence response payload upon a successful call. Sellers must make sure to capture the fileId value for each evidence file that is uploaded with the uploadEvidence method.

The type of evidence being added should be specified in the evidenceType field. All files being added (if more than one) should correspond to this evidence type.

Upon a successful call, an http status code of 204 Success is returned. There is no response payload unless an error occurs. To verify that a new file is a part of the evidence set, the seller can use the fetchEvidenceContent method, passing in the proper evidenceId and fileId values.", "operationId": "updateEvidence", "parameters": [ { "name": "payment_dispute_id", "in": "path", "description": "This parameter is used to specify the unique identifier of the contested payment dispute for which the user plans to update the evidence set.

Use the getPaymentDisputeSummaries method to retrieve payment dispute IDs.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEvidencePaymentDisputeRequest" } } }, "required": false }, "responses": { "204": { "description": "Success" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "33003": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid Evidence File Id" }, "33007": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid line items." }, "33008": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid evidence type." }, "33009": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "User did not echo back the evidence metadata correctly." }, "33010": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Evidence Id is invalid" }, "33100": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid input request" }, "33103": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Exceed allowed file count" }, "33104": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "The combined size of attached files should be 1.5MB or less." } } } }, "404": { "description": "Not Found", "x-response-codes": { "errors": { "33001": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Invalid Payment Dispute Id" } } } }, "409": { "description": "Conflict", "x-response-codes": { "errors": { "33004": { "domain": "API_FULFILLMENT", "category": "REQUEST", "description": "Upload file for evidence is not permitted for given payment dispute state." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "33000": { "domain": "API_FULFILLMENT", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.payment.dispute" ] } ] }, "servers": [ { "url": "https://apiz.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/fulfillment/v1" } } } ] } }, "components": { "schemas": { "AcceptPaymentDisputeRequest": { "type": "object", "properties": { "returnAddress": { "description": "This container is used if the seller wishes to provide a return address to the buyer. This container should be used if the seller is requesting that the buyer return the item.", "$ref": "#/components/schemas/ReturnAddress" }, "revision": { "type": "integer", "description": "This integer value indicates the revision number of the payment dispute. This field is required. The current revision number for a payment dispute can be retrieved with the getPaymentDispute method. Each time an action is taken against a payment dispute, this integer value increases by 1.", "format": "int32" } }, "description": "This type is used by base request of the acceptPaymentDispute method." }, "AddEvidencePaymentDisputeRequest": { "type": "object", "properties": { "evidenceType": { "type": "string", "description": "This field is used to indicate the type of evidence being provided through one or more evidence files. All evidence files (if more than one) should be associated with the evidence type passed in this field.

See the EvidenceTypeEnum type for the supported evidence types. For implementation help, refer to eBay API documentation" }, "files": { "type": "array", "description": "This array is used to specify one or more evidence files that will become part of a new evidence set associated with a payment dispute. At least one evidence file must be specified in the files array.", "items": { "$ref": "#/components/schemas/FileEvidence" } }, "lineItems": { "type": "array", "description": "This array identifies the order line item(s) for which the evidence file(s) will be applicable.

These values are returned under the evidenceRequests.lineItems array in the getPaymentDispute response.", "items": { "$ref": "#/components/schemas/OrderLineItems" } } }, "description": "This type is used by the request payload of the addEvidence method. The addEvidence method is used to create a new evidence set against a payment dispute with one or more evidence files." }, "AddEvidencePaymentDisputeResponse": { "type": "object", "properties": { "evidenceId": { "type": "string", "description": "The value returned in this field is the unique identifier of the newly-created evidence set. Upon a successful call, this value is automatically genererated. This new evidence set for the payment dispute includes the evidence file(s) that were passed in to the fileId array in the request payload. The evidenceId value will be needed if the seller wishes to add to the evidence set by using the updateEvidence method, or if they want to retrieve a specific evidence file within the evidence set by using the fetchEvidenceContent method." } }, "description": "This type is used by the response payload of the addEvidence method. Its only field is an unique identifier of an evidence set." }, "Address": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "The first line of the street address.

Note: addressLine1 will not be returned for any order that is more than 90 days old." }, "addressLine2": { "type": "string", "description": "The second line of the street address. This field can be used for additional address information, such as a suite or apartment number. This field will be returned if defined for the shipping address.

Note: addressLine2 will not be returned for any order that is more than 90 days old." }, "city": { "type": "string", "description": "The city of the shipping destination." }, "countryCode": { "type": "string", "description": "The country of the shipping destination, represented as a two-letter ISO 3166-1 alpha-2 country code. For example, US represents the United States, and DE represents Germany. For implementation help, refer to eBay API documentation" }, "county": { "type": "string", "description": "The county of the shipping destination. Counties typically, but not always, contain multiple cities or towns. This field is returned if known/available." }, "postalCode": { "type": "string", "description": "The postal code of the shipping destination. Usually referred to as Zip codes in the US. Most countries have postal codes, but not all. The postal code will be returned if applicable." }, "stateOrProvince": { "type": "string", "description": "The state or province of the shipping destination. Most countries have states or provinces, but not all. The state or province will be returned if applicable." } }, "description": "This type contains the details of a geographical address." }, "Amount": { "type": "object", "properties": { "convertedFromCurrency": { "type": "string", "description": "A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency. For implementation help, refer to eBay API documentation" }, "convertedFromValue": { "type": "string", "description": "The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field." }, "currency": { "type": "string", "description": "A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The default currency of the eBay marketplace that hosts the listing. For implementation help, refer to eBay API documentation" }, "value": { "type": "string", "description": "The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.

Required in the amount type." } }, "description": "This type defines the monetary value of an amount. It can provide the amount in both the currency used on the eBay site where an item is being offered and the conversion of that value into another currency, if applicable." }, "AppliedPromotion": { "type": "object", "properties": { "description": { "type": "string", "description": "A description of the applied sales promotion." }, "discountAmount": { "description": "The monetary amount of the sales promotion.", "$ref": "#/components/schemas/Amount" }, "promotionId": { "type": "string", "description": "An eBay-generated unique identifier of the sales promotion.

Multiple types of sales promotions are available to eBay Store owners, including order size/volume discounts, shipping discounts, special coupons, and price markdowns. Sales promotions can be managed through the Marketing tab of Seller Hub in My eBay, or by using the Trading API's SetPromotionalSale call or the Marketing API's createItemPromotion method." } }, "description": "This type contains information about a sales promotion that is applied to a line item." }, "AppointmentDetails": { "type": "object", "properties": { "appointmentEndTime": { "type": "string", "description": "The date and time the appointment ends, formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Required for tire installation.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-10-28T00:00:00.000Z" }, "appointmentStartTime": { "type": "string", "description": "The date and time the appointment begins, 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-10-28T00:10:00.000Z" }, "appointmentStatus": { "type": "string", "description": "The status of the appointment. For implementation help, refer to eBay API documentation" }, "appointmentType": { "type": "string", "description": "The type of appointment. MACRO appointments only have a start time (not bounded with end time). TIME_SLOT appointments have a period (both start time and end time). Required for tire installation. For implementation help, refer to eBay API documentation" }, "appointmentWindow": { "type": "string", "description": "Appointment window for MACRO appointments. For implementation help, refer to eBay API documentation" }, "serviceProviderAppointmentDate": { "type": "string", "description": "Service provider date of the appointment (no time stamp). Returned only for MACRO appointment types." } }, "description": "This type contains information used by the installation provider concerning appointment details selected by the buyer" }, "Buyer": { "type": "object", "properties": { "buyerRegistrationAddress": { "description": "Buyer's contact information that includes the buyer's name, email, phone number, and address.", "$ref": "#/components/schemas/ExtendedContact" }, "taxAddress": { "description": "This container consists of address information that can be used by sellers for tax purpose.

Note: When using the eBay vault program, if an item is shipped to a vault, the tax address will be the vault address.", "$ref": "#/components/schemas/TaxAddress" }, "taxIdentifier": { "description": "This container consists of taxpayer identification information for buyers from Italy, Spain, or Guatemala. It is currently only returned for orders occurring on the eBay Italy or eBay Spain marketplaces.

Note: Currently, the taxIdentifier container is only returned in getOrder and not in getOrders. So, if a seller wanted to view a buyer's tax information for a particular order returned in getOrders, that seller would need to use the orderId value for that particular order, and then run a getOrder call against that order ID. ", "$ref": "#/components/schemas/TaxIdentifier" }, "username": { "type": "string", "description": "The buyer's eBay user ID." } }, "description": "This type contains information about the order's buyer." }, "CancelRequest": { "type": "object", "properties": { "cancelCompletedDate": { "type": "string", "description": "The date and time that the order cancellation was completed, if applicable. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the cancellation request has actually been approved by the seller.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "cancelInitiator": { "type": "string", "description": "This string value indicates the party who made the initial cancellation request. Typically, either the 'Buyer' or 'Seller'. If a cancellation request has been made, this field should be returned." }, "cancelReason": { "type": "string", "description": "The reason why the cancelInitiator initiated the cancellation request. Cancellation reasons for a buyer might include 'order placed by mistake' or 'order won't arrive in time'. For a seller, a typical cancellation reason is 'out of stock'. If a cancellation request has been made, this field should be returned." }, "cancelRequestedDate": { "type": "string", "description": "The date and time that the order cancellation was requested. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is returned for each cancellation request.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "cancelRequestId": { "type": "string", "description": "The unique identifier of the order cancellation request. This field is returned for each cancellation request." }, "cancelRequestState": { "type": "string", "description": "The current stage or condition of the cancellation request. This field is returned for each cancellation request. For implementation help, refer to eBay API documentation" } }, "description": "This type contains information about a buyer request to cancel an order." }, "CancelStatus": { "type": "object", "properties": { "cancelledDate": { "type": "string", "description": "The date and time the order was cancelled, if applicable. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "cancelRequests": { "type": "array", "description": "This array contains details of one or more buyer requests to cancel the order.

For the getOrders call: This array is returned but is always empty.
For the getOrder call: This array is returned fully populated with information about any cancellation requests.", "items": { "$ref": "#/components/schemas/CancelRequest" } }, "cancelState": { "type": "string", "description": "The state of the order with regard to cancellation. This field is always returned, and if there are no cancellation requests, a value of NONE_REQUESTED is returned. For implementation help, refer to eBay API documentation" } }, "description": "This type contains information about any requests that have been made to cancel an order." }, "Charge": { "type": "object", "properties": { "amount": { "description": "This container shows the amount and currency of the charge.", "$ref": "#/components/schemas/Amount" }, "chargeType": { "type": "string", "description": "This field shows the type of buyer charge

Note: Currently, the only supported charge type is BUYER_PROTECTION. For implementation help, refer to eBay API documentation" } }, "description": "This type is used to display the charge type and the amount of the charge against the buyer." }, "ContestPaymentDisputeRequest": { "type": "object", "properties": { "note": { "type": "string", "description": "This field shows information that the seller provides about the dispute, such as the basis for the dispute, any relevant evidence, tracking numbers, and so forth.

Max Length: 1000 characters." }, "returnAddress": { "description": "This container is needed if the seller is requesting that the buyer return the item. If this container is used, all relevant fields must be included, including fullName and primaryPhone.

Note: If the Dispute Reason is SIGNIFICANTLY_NOT_AS_DESCRIBED, returnAddress is required.", "$ref": "#/components/schemas/ReturnAddress" }, "revision": { "type": "integer", "description": "This integer value indicates the revision number of the payment dispute. This field is required. The current revision number for a payment dispute can be retrieved with the getPaymentDispute method. Each time an action is taken against a payment dispute, this integer value increases by 1.", "format": "int32" } }, "description": "This type is used by the request payload of the contestPaymentDispute method." }, "DeliveryCost": { "type": "object", "properties": { "discountAmount": { "description": "The amount of any shipping discount that has been applied to the line item. This container is returned only if a shipping discount applies to the line item.", "$ref": "#/components/schemas/Amount" }, "handlingCost": { "description": "The amount of any handing cost that has been applied to the line item. This container is returned only if a handling cost applies to the line item.", "$ref": "#/components/schemas/Amount" }, "importCharges": { "description": "The amount of any import charges applied to international shipping of the line item. This container is only returned if import charges apply to the line item.", "$ref": "#/components/schemas/Amount" }, "shippingCost": { "description": "The total cost of shipping all units of the line item. This container is always returned even when the shipping cost is free, in which case the value field will show 0.0 (dollars).", "$ref": "#/components/schemas/Amount" }, "shippingIntermediationFee": { "description": "This field shows the fee due to eBay's international shipping provider for a line item that is being shipped through the Global Shipping Program.

This container is only returned for line items being shipped internationally through the Global Shipping Program, which is currently only supported in the US and UK marketplaces.

Note: The value returned for this field will always be 0.0 for line items sold in the UK marketplace.", "$ref": "#/components/schemas/Amount" } }, "description": "This type contains a breakdown of all costs associated with the fulfillment of a line item." }, "DisputeAmount": { "type": "object", "properties": { "convertedFromCurrency": { "type": "string", "description": "The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.

This field is only returned if/when currency conversion was applied by eBay. For implementation help, refer to eBay API documentation" }, "convertedFromValue": { "type": "string", "description": "The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is the pre-conversion amount. The value field contains the converted amount of this value, in the currency specified by the currency field.

This field is only returned if/when currency conversion was applied by eBay." }, "currency": { "type": "string", "description": "A three-letter ISO 4217 code that indicates the currency of the amount in the value field. This field is always returned with any container using Amount type.

Default: The currency of the authenticated user's country. For implementation help, refer to eBay API documentation" }, "exchangeRate": { "type": "string", "description": "The exchange rate used for the monetary conversion. This field shows the exchange rate used to convert the dollar value in the value field from the dollar value in the convertedFromValue field.

This field is only returned if/when currency conversion was applied by eBay." }, "value": { "type": "string", "description": "The monetary amount, in the currency specified by the currency field. This field is always returned with any container using Amount type." } }, "description": "This type defines the monetary value of an amount. It can provide the amount in both the currency used on the eBay site where an item is being offered and the conversion of that value into another currency, if applicable." }, "DisputeEvidence": { "type": "object", "properties": { "evidenceId": { "type": "string", "description": "Unique identifier of the evidential file set. Potentially, each evidential file set can have more than one file, that is why there is this file set identifier, and then an identifier for each file within this file set." }, "evidenceType": { "type": "string", "description": "This enumeration value shows the type of evidential file provided. For implementation help, refer to eBay API documentation" }, "files": { "type": "array", "description": "This array shows the name, ID, file type, and upload date for each provided file.", "items": { "$ref": "#/components/schemas/FileInfo" } }, "lineItems": { "type": "array", "description": "This array shows one or more order line items associated with the evidential document that has been provided.", "items": { "$ref": "#/components/schemas/OrderLineItems" } }, "providedDate": { "type": "string", "description": "The timestamp in this field shows the date/time when the seller provided a requested evidential document to eBay.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." }, "requestDate": { "type": "string", "description": "The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." }, "respondByDate": { "type": "string", "description": "The timestamp in this field shows the date/time when the seller was expected to provide a requested evidential document to eBay.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." }, "shipmentTracking": { "type": "array", "description": "This array shows the shipping carrier and shipment tracking number associated with each shipment package of the order. This array is returned under the evidence container if the seller has provided shipment tracking information as evidence to support PROOF_OF_DELIVERY for an INR-related payment dispute.", "items": { "$ref": "#/components/schemas/TrackingInfo" } } }, "description": "This type is used by the evidence array that is returned in the getPaymentDispute response if one or more evidential documents are associated with the payment dispute. " }, "DisputeSummaryResponse": { "type": "object", "properties": { "href": { "type": "string", "description": "The URI of the getPaymentDisputeSummaries call request that produced the current page of the result set." }, "limit": { "type": "integer", "description": "This value shows the maximum number of payment disputes that will appear on one page of the result set. The limit value can be passed in as a query parameter in the request, or if it is not used, it defaults to 200. If the value in the total field exceeds this limit value, there are multiple pages in the current result set.

Min: 1; Max: 200; Default: 200", "format": "int32" }, "next": { "type": "string", "description": "The getPaymentDisputeSummaries call URI to use if you wish to view the next page of the result set. For example, the following URI returns records 11 thru 20 from the collection of payment disputes:

path/payment_dispute_summary?limit=10&offset=10

This field is only returned if there is a next page of results to view based on the current input criteria." }, "offset": { "type": "integer", "description": "This integer value indicates the number of payment disputes skipped before listing the first payment dispute from the result set. The offset value can be passed in as a query parameter in the request, or if it is not used, it defaults to 0 and the first payment dispute of the result set is shown at the top of the response.", "format": "int32" }, "paymentDisputeSummaries": { "type": "array", "description": "Each payment dispute that matches the input criteria is returned under this array. If no payment disputes are found, an empty array is returned.", "items": { "$ref": "#/components/schemas/PaymentDisputeSummary" } }, "prev": { "type": "string", "description": "The getPaymentDisputeSummaries call URI to use if you wish to view the previous page of the result set. For example, the following URI returns records 1 thru 10 from the collection of payment disputes:

path/payment_dispute_summary?limit=10&offset=0

This field is only returned if there is a previous page of results to view based on the current input criteria." }, "total": { "type": "integer", "description": "This integer value is the total number of payment disputes that matched the input criteria. If the total number of entries exceeds the value that was set for limit in the request payload, you will have to make multiple API calls to see all pages of the results set. This field is returned even if it is 0.", "format": "int32" } }, "description": "This type defines the base response payload of the getPaymentDisputeSummaries method. Each payment dispute that matches the input criteria is returned under the paymentDisputeSummaries array." }, "EbayCollectAndRemitTax": { "type": "object", "properties": { "amount": { "description": "The monetary amount of the 'Collect and Remit' tax. This currently includes:


Note: If the corresponding taxType is STATE_SALES_TAX, PROVINCE_SALES_TAX, GST, VAT, or SST and the lineItems.taxes container also appears for this line item with the same tax amount, the order is subject to 'eBay Collect and Remit' tax. For orders that are subject to 'eBay Collect and Remit' tax, the tax amount in this field will be included in the lineItems.total, paymentSummary.payments.amount, paymentSummary.totalDueSeller, and pricingSummary.total fields.", "$ref": "#/components/schemas/Amount" }, "ebayReference": { "description": "This container field describes the line-item level VAT tax details.
", "$ref": "#/components/schemas/EbayTaxReference" }, "taxType": { "type": "string", "description": "The type of tax and fees that eBay will collect and remit to the taxing or fee authority. See the TaxTypeEnum type definition for more information about each tax or fee type. For implementation help, refer to eBay API documentation" }, "collectionMethod": { "type": "string", "description": "This field indicates the collection method used to collect the 'Collect and Remit' tax for the order. This field is always returned for orders subject to 'Collect and Remit' tax, and its value is always NET.

Note: Although the collectionMethod field is returned for all orders subject to 'Collect and Remit' tax, the collectionMethod field and the CollectionMethodEnum type are not currently of any practical use, although this field may have use in the future. If and when the logic of this field is changed, this note will be updated and a note will also be added to the Release Notes. For implementation help, refer to eBay API documentation" } }, "description": "This type contains information about the type and amount of tax that eBay will collect and remit to the state, province, country, or other taxing authority in the buyer's location, as required by that taxing authority.

'Collect and Remit' tax includes:" }, "EbayCollectedCharges": { "type": "object", "properties": { "ebayShipping": { "description": "This container consists of costs related to eBay Shipping collected by eBay from the buyer of this order.", "$ref": "#/components/schemas/Amount" }, "charges": { "type": "array", "description": "This array shows any charges that eBay collects from the buyer.

Note: Currently, the only supported charge type is BUYER_PROTECTION.", "items": { "$ref": "#/components/schemas/Charge" } } }, "description": "This type contains the breakdown of costs that are collected by eBay from the buyer." }, "EbayFulfillmentProgram": { "type": "object", "properties": { "fulfilledBy": { "type": "string", "description": "The value returned in this field indicates the party that is handling fulfillment of the order line item.

Valid value: EBAY" } }, "description": "This type is used to provide details about an order line item being fulfilled by eBay or an eBay fulfillment partner." }, "EbayInternationalShipping": { "type": "object", "properties": { "returnsManagedBy": { "type": "string", "description": "The value returned in this field indicates the party that is responsible for managing returns of the order line item.

Valid value: EBAY" } }, "description": "This type is used to provide details about an order line item being managed through eBay International Shipping." }, "EbayShipping": { "type": "object", "properties": { "shippingLabelProvidedBy": { "type": "string", "description": "This field contains the shipping label provider. If EBAY, this order is managed by eBay shipping and a free shipping label by eBay is downloadable by the seller via the eBay website." } }, "description": "This type contains information about the management of the shipping for the order." }, "EbayTaxReference": { "type": "object", "properties": { "name": { "type": "string", "description": "This field value is returned to indicate the VAT tax type, which will vary by country/region. This string value will be one of the following:" }, "value": { "type": "string", "description": "The value returned in this field is the VAT identifier number (VATIN), which will vary by country/region. This field will be returned if VAT tax is applicable for the order. The name field indicates the VAT tax type, which will vary by country/region: " } }, "description": "This type describes the VAT tax details. The eBay VAT tax type and the eBay VAT identifier number will be returned if a VAT tax is applicable for the order.
" }, "EbayVaultProgram": { "type": "object", "properties": { "fulfillmentType": { "type": "string", "description": "This field specifies how an eBay vault order will be fulfilled. Supported options are: For implementation help, refer to eBay API documentation" } } }, "Error": { "type": "object", "properties": { "category": { "type": "string", "description": "The context or source of this error or warning." }, "domain": { "type": "string", "description": "The name of the domain containing the service or application. For example, sell is a domain." }, "errorId": { "type": "integer", "description": "A positive integer that uniquely identifies the specific error condition that occurred. Your application can use these values as error code identifiers in your customized error-handling algorithms.", "format": "int32" }, "inputRefIds": { "type": "array", "description": "A list of one or more specific request elements (if any) associated with the error or warning. The format of these strings depends on the request payload format. For JSON, use JSONPath notation.", "items": { "type": "string" } }, "longMessage": { "type": "string", "description": "An expanded version of the message field.

Maximum length: 200 characters" }, "message": { "type": "string", "description": "A message about the error or warning which is device agnostic and readable by end users and application developers. It explains what the error or warning is, and how to fix it (in a general sense). If applicable, the value is localized to the end user's requested locale.

Maximum length: 50 characters" }, "outputRefIds": { "type": "array", "description": "A list of one or more specific response elements (if any) associated with the error or warning. The format of these strings depends on the request payload format. For JSON, use JSONPath notation.", "items": { "type": "string" } }, "parameters": { "type": "array", "description": "Contains a list of name-value pairs that provide additional information concerning this error or warning. Each item in the list is an input parameter that contributed to the error or warning condition.", "items": { "$ref": "#/components/schemas/ErrorParameter" } }, "subdomain": { "type": "string", "description": "The name of the domain's subsystem or subdivision. For example, fulfillment is a subdomain in the sell domain." } }, "description": "This type contains a error or warning related to a call request. " }, "ErrorParameter": { "type": "object", "properties": { "name": { "type": "string", "description": "This is the name of input field that caused an issue with the call request." }, "value": { "type": "string", "description": "This is the actual value that was passed in for the element specified in the name field." } }, "description": "This type contains the name and value of an input parameter that contributed to a specific error or warning condition." }, "EvidenceRequest": { "type": "object", "properties": { "evidenceId": { "type": "string", "description": "Unique identifier of the evidential file set. Potentially, each evidential file set can have more than one file, that is why there is this file set identifier, and then an identifier for each file within this file set." }, "evidenceType": { "type": "string", "description": "This enumeration value shows the type of evidential document provided. For implementation help, refer to eBay API documentation" }, "lineItems": { "type": "array", "description": "This array shows one or more order line items associated with the evidential document that has been provided.", "items": { "$ref": "#/components/schemas/OrderLineItems" } }, "requestDate": { "type": "string", "description": "The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." }, "respondByDate": { "type": "string", "description": "The timestamp in this field shows the date/time when the seller is expected to provide a requested evidential document to eBay.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." } }, "description": "This type is used by the evidenceRequests array that is returned in the getPaymentDispute response if one or more evidential documents are being requested to help resolve the payment dispute." }, "ExtendedContact": { "type": "object", "properties": { "companyName": { "type": "string", "description": "The company name associated with the buyer or eBay shipping partner. This field is only returned if defined/applicable to the buyer or eBay shipping partner." }, "contactAddress": { "description": "This container shows the shipping address of the buyer or eBay shipping partner.", "$ref": "#/components/schemas/Address" }, "email": { "type": "string", "description": "This field contains the email address of the buyer. This address will be returned for up to 14 days from order creation. If an order is more than 14 days old, no address is returned.

Note: If returned, this field contains the email address of the buyer, even for Global Shipping Program shipments.

The email will not be returned for any order that is more than 90 days old." }, "fullName": { "type": "string", "description": "The full name of the buyer or eBay shipping partner.

Note: The fullName will not be returned for any order that is more than 90 days old." }, "primaryPhone": { "description": "The primary telephone number of the buyer or eBay shipping partner.

Note: The primaryPhone will not be returned for any order that is more than 90 days old.", "$ref": "#/components/schemas/PhoneNumber" } }, "description": "This type contains shipping and contact information for a buyer or an eBay shipping partner." }, "FileEvidence": { "type": "object", "properties": { "fileId": { "type": "string", "description": "This field is used to identify the evidence file to be uploaded to the evidence set.

This file is created with the uploadEvidenceFile method and can be retrieved using the getPaymentDisputes method." } }, "description": "This type is used to store the unique identifier of an evidence file. Evidence files are used by seller to contest a payment dispute." }, "FileInfo": { "type": "object", "properties": { "fileId": { "type": "string", "description": "The unique identifier of the evidence file." }, "fileType": { "type": "string", "description": "The type of file uploaded. Supported file extensions are .JPEG, .JPG, and .PNG., and maximum file size allowed is 1.5 MB." }, "name": { "type": "string", "description": "The seller-provided name of the evidence file." }, "uploadedDate": { "type": "string", "description": "The timestamp in this field shows the date/time when the seller uploaded the evidential document to eBay.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." } }, "description": "This type is used by the files array, which shows the name, ID, file type, and upload date for each provided evidential file." }, "FulfillmentStartInstruction": { "type": "object", "properties": { "appointment": { "description": "This container provides information used by the installation provider concerning appointment details selected by the buyer.", "$ref": "#/components/schemas/AppointmentDetails" }, "ebaySupportedFulfillment": { "type": "boolean", "description": "This field is only returned if its value is true and indicates that the fulfillment will be shipped via eBay's Global Shipping Program, eBay International Shipping, or the Authenticity Guarantee service program.

For more information, see the Global Shipping Program help topic." }, "finalDestinationAddress": { "description": "This container is only returned if the value of ebaySupportedFulfillment field is true.

This is the final destination address for a Global Shipping Program shipment or an eBay International Shipping shipment, which is usually the recipient's home. Sellers should not ship directly to this address; instead they should ship this package to their international shipping provider's domestic warehouse. The international shipping provider is responsible for delivery to the final destination address.

For more information, see Addressing Shipments.

Note: For Authenticity Guarantee program shipment, this is the address of the authenticator's warehouse. The authenticator is responsible for delivery to the buyer shipping address.

", "$ref": "#/components/schemas/Address" }, "fulfillmentInstructionsType": { "type": "string", "description": "The enumeration value returned in this field indicates the method of fulfillment that will be used to deliver this set of line items (this package) to the buyer. This field will have a value of SHIP_TO if the ebaySupportedFulfillment field is returned with a value of true. See the FulfillmentInstructionsType definition for more information about different fulfillment types. For implementation help, refer to eBay API documentation" }, "maxEstimatedDeliveryDate": { "type": "string", "description": "This is the estimated latest date that the fulfillment will be completed. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned ifthe value of the fulfillmentInstructionsType field is DIGITAL or PREPARE_FOR_PICKUP.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "minEstimatedDeliveryDate": { "type": "string", "description": "This is the estimated earliest date that the fulfillment will be completed. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned if the value of the fulfillmentInstructionsType field is DIGITAL or PREPARE_FOR_PICKUP.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "pickupStep": { "description": "This container is only returned for In-Store Pickup orders, and it indicates the specific merchant's store where the buyer will pick up the order. The In-Store Pickup feature is supported in the US, Canada, UK, Germany, and Australia marketplaces.", "$ref": "#/components/schemas/PickupStep" }, "shippingStep": { "description": "This container consists of shipping information for this fulfillment, including the shipping carrier, the shipping service option, and the shipment destination. This container is not returned if the value of the fulfillmentInstructionsType field is DIGITAL, or for In-Store Pickup orders.

For Click and Collect orders, the shipping destination will be a brick-and-mortar store where the buyer will pick up the order.", "$ref": "#/components/schemas/ShippingStep" } }, "description": "This type contains a set of specifications for processing a fulfillment of an order, including the type of fulfillment, shipping carrier and service, addressing details, and estimated delivery window. These instructions are derived from the buyer's and seller's eBay account preferences, the listing parameters, and the buyer's checkout selections. The seller can use them as a starting point for packaging, addressing, and shipping the order." }, "GiftDetails": { "type": "object", "properties": { "message": { "type": "string", "description": "This field contains the gift message from the buyer to the gift recipient. This field is only returned if the buyer of the gift included a message for the gift.

Note: The message will not be returned for any order that is more than 90 days old." }, "recipientEmail": { "type": "string", "description": "The email address of the gift recipient. The seller will send the digital gift card to this email address.

Note: The recipientEmail will not be returned for any order that is more than 90 days old." }, "senderName": { "type": "string", "description": "The name of the buyer, which will appear on the email that is sent to the gift recipient.

Note: The senderName will not be returned for any order that is more than 90 days old." } }, "description": "This type contains information about a digital gift card line item that was purchased as a gift and sent to the recipient by email.

Note: GiftDetails will not be returned for any order that is more than 90 days old." }, "InfoFromBuyer": { "type": "object", "properties": { "contentOnHold": { "type": "boolean", "description": "When the value of this field is true it indicates that the buyer's note regarding the payment dispute (i.e., the buyerProvided.note field,) is on hold. When this is the case, the buyerProvided.note field will not be returned.

When the value of this field is false, it is not returned." }, "note": { "type": "string", "description": "This field shows any note that was left by the buyer in regard to the dispute." }, "returnShipmentTracking": { "type": "array", "description": "This array shows shipment tracking information for one or more shipping packages being returned to the buyer after a payment dispute.", "items": { "$ref": "#/components/schemas/TrackingInfo" } } }, "description": "This container is returned if the buyer is returning one or more line items in an order that is associated with the payment dispute, and that buyer has provided return shipping tracking information and/or a note about the return." }, "IssueRefundRequest": { "type": "object", "properties": { "reasonForRefund": { "type": "string", "description": "The enumeration value passed into this field indicates the reason for the refund. One of the defined enumeration values in the ReasonForRefundEnum type must be used.

This field is required, and it is highly recommended that sellers use the correct refund reason, especially in the case of a buyer-requested cancellation or 'buyer remorse' return to indicate that there was nothing wrong with the item(s) or with the shipment of the order.

Note: If issuing refunds for more than one order line item, keep in mind that the refund reason must be the same for each of the order line items. If the refund reason is different for one or more order line items in an order, the seller would need to make separate issueRefund calls, one for each refund reason. For implementation help, refer to eBay API documentation" }, "comment": { "type": "string", "description": "This free-text field allows the seller to clarify why the refund is being issued to the buyer.

Max Length: 100" }, "refundItems": { "type": "array", "description": "The refundItems array is only required if the seller is issuing a refund for one or more individual order line items in a multiple line item order. Otherwise, the seller just uses the orderLevelRefundAmount container to specify the amount of the refund for the entire order.", "items": { "$ref": "#/components/schemas/RefundItem" } }, "orderLevelRefundAmount": { "description": "This container is used to specify the amount of the refund for the entire order. If a seller wants to issue a refund for an individual line item within a multiple line item order, the seller would use the refundItems array instead.", "$ref": "#/components/schemas/SimpleAmount" } }, "description": "The base type used by the request payload of the issueRefund method." }, "ItemLocation": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "The two-letter ISO 3166 code representing the country of the address. For implementation help, refer to eBay API documentation" }, "location": { "type": "string", "description": "Indicates the geographical location of the item (along with the values in the countryCode and postalCode fields).

Note: If the item is shipped from a fulfillment center location through the Multi-Warehouse Program, this field will return the geographical location of the fulfillment center closest to the buyer.
This field provides city, province, state, or similar information." }, "postalCode": { "type": "string", "description": "The postal code of the address." } }, "description": "This type describes the physical location of an order." }, "LegacyReference": { "type": "object", "properties": { "legacyItemId": { "type": "string", "description": "The unique identifier of a listing.

This value can be found in the Transaction container in the response of the getOrder call of the Trading API.

Note: Both legacyItemId and legacyTransactionId are needed to identify an order line item. " }, "legacyTransactionId": { "type": "string", "description": "The unique identifier of a sale/transaction in legacy/Trading API format. A 'transaction ID' is created once a buyer purchases a 'Buy It Now' item or if an auction listing ends with a winning bidder.

This value can be found in the Transaction container in the response of the getOrder call of the Trading API.

Note: Both legacyItemId and legacyTransactionId are needed to identify an order line item. " } }, "description": "Type defining the legacyReference container. This container is needed if the seller is issuing a refund for an individual order line item, and wishes to use an item ID and transaction ID to identify the order line item." }, "LineItem": { "type": "object", "properties": { "appliedPromotions": { "type": "array", "description": "This array contains information about one or more sales promotions or discounts applied to the line item. It is always returned, but will be returned as an empty array if no special sales promotions or discounts apply to the order line item.", "items": { "$ref": "#/components/schemas/AppliedPromotion" } }, "compatibilityProperties": { "type": "array", "description": "This array is only returned for a Parts & Accessory item, and identifies the buyer's motor vehicle that is compatible with the part or accessory.", "items": { "$ref": "#/components/schemas/Property" } }, "deliveryCost": { "description": "This container consists of a breakdown of all costs associated with the fulfillment of the line item.", "$ref": "#/components/schemas/DeliveryCost" }, "discountedLineItemCost": { "description": "The cost of the line item after applying any discounts. This container is only returned if the order line item was discounted through a promotion.", "$ref": "#/components/schemas/Amount" }, "ebayCollectAndRemitTaxes": { "type": "array", "description": "This container will be returned if the order line item is subject to a 'Collect and Remit' tax that eBay will collect and remit to the proper taxing authority on the buyer's behalf.

'Collect and Remit' tax includes:The amount of this tax is shown in the amount field, and the type of tax is shown in the taxType field.

eBay will display the tax type and amount during checkout in accordance with the buyer's address, and handle collection and remittance of the tax without requiring the seller to take any action.", "items": { "$ref": "#/components/schemas/EbayCollectAndRemitTax" } }, "ebayCollectedCharges": { "description": "This container consists of a breakdown of costs that are collected by eBay from the buyer for this order.

Note: Currently, this container is returned only if eBay is directly charging the buyer for eBay shipping.", "$ref": "#/components/schemas/EbayCollectedCharges" }, "giftDetails": { "description": "This container consists of information that is needed by the seller to send a digital gift card to the buyer, or recipient of the digital gift card. This container is only returned and applicable for digital gift card line items.", "$ref": "#/components/schemas/GiftDetails" }, "itemLocation": { "description": "This container field describes the physical location of the order line item.

Note: If the item is shipped from a fulfillment center location through the Multi-Warehouse Program, this container will return the location details of the fulfillment center closest to the buyer.", "$ref": "#/components/schemas/ItemLocation" }, "legacyItemId": { "type": "string", "description": "The eBay-generated legacy listing item ID of the listing. Note that the unique identifier of a listing in REST-based APIs is called the listingId instead." }, "legacyVariationId": { "type": "string", "description": "The unique identifier of a single variation within a multiple-variation listing. This field is only returned if the line item purchased was from a multiple-variation listing." }, "lineItemCost": { "description": "The selling price of the line item before applying any discounts. The value of this field is calculated by multiplying the single unit price by the number of units purchased (value of the quantity field).", "$ref": "#/components/schemas/Amount" }, "lineItemFulfillmentInstructions": { "description": "This container consists of information related to shipping dates and expectations, including the 'ship-by date' and expected delivery windows that are based on the seller's stated handling time and the shipping service option that will be used. These fields provide guidance on making sure expected delivery dates are made, whether the order is a eBay Guaranteed Delivery order or a non-guaranteed delivery order.", "$ref": "#/components/schemas/LineItemFulfillmentInstructions" }, "lineItemFulfillmentStatus": { "type": "string", "description": "This enumeration value indicates the current fulfillment status of the line item. For implementation help, refer to eBay API documentation" }, "lineItemId": { "type": "string", "description": "This is the unique identifier of an eBay order line item. This field is created as soon as there is a commitment to buy from the seller." }, "linkedOrderLineItems": { "type": "array", "description": "An array of one or more line items related to the corresponding order, but not a part of that order. Details include the order ID, line item ID, and title of the linked line item, the seller of that item, item specifics, estimated delivery times, and shipment tracking (if available).", "items": { "$ref": "#/components/schemas/LinkedOrderLineItem" } }, "listingMarketplaceId": { "type": "string", "description": "The unique identifier of the eBay marketplace where the line item was listed. For implementation help, refer to eBay API documentation" }, "properties": { "description": "Contains information about the eBay programs, if any, under which the line item was listed.", "$ref": "#/components/schemas/LineItemProperties" }, "purchaseMarketplaceId": { "type": "string", "description": "The unique identifier of the eBay marketplace where the line item was listed. Often, the listingMarketplaceId and the purchaseMarketplaceId identifier are the same, but there are occasions when an item will surface on multiple eBay marketplaces. For implementation help, refer to eBay API documentation" }, "quantity": { "type": "integer", "description": "The number of units of the line item in the order. These are represented as a group by a single lineItemId.", "format": "int32" }, "refunds": { "type": "array", "description": "This array is always returned, but is returned as an empty array unless the seller has submitted a partial or full refund to the buyer for the order. If a refund has occurred, the refund amount and refund date will be shown for each refund.", "items": { "$ref": "#/components/schemas/LineItemRefund" } }, "sku": { "type": "string", "description": "Seller-defined Stock-Keeping Unit (SKU). This inventory identifier must be unique within the seller's eBay inventory. SKUs are optional when listing in the legacy/Trading API system, but SKUs are required when listing items through the Inventory API model." }, "soldFormat": { "type": "string", "description": "The eBay listing type of the line item. The most common listing types are AUCTION and FIXED_PRICE. For implementation help, refer to eBay API documentation" }, "taxes": { "type": "array", "description": "Contains a list of taxes applied to the line item, if any. This array is always returned, but will be returned as empty if no taxes are applicable to the line item.", "items": { "$ref": "#/components/schemas/Tax" } }, "title": { "type": "string", "description": "The title of the listing.

Note: The Item ID value for the listing will be returned in this field instead of the actual title if this particular listing is on-hold due to an eBay policy violation." }, "total": { "description": "This is the total price that the buyer must pay for the line item after all costs (item cost, delivery cost, taxes,) are added, minus any discounts and/or promotions.

Note: For orders that are subject to 'eBay Collect and Remit' tax, the 'Collect and Remit' tax amount for the order will be included in this total value only when the fieldGroups query parameter is set to TAX_BREAKDOWN. If the fieldGroups query parameter is not set to TAX_BREAKDOWN, 'Collect and Remit' will not be added into this total value.

To determine if 'Collect and Remit' taxes were added into this total value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes and the lineItems.taxes containers in the response. If both of these containers appear for one or more line items in the response with the following taxType values, the 'Collect and Remit' tax amount that the buyer paid is in this amount:", "$ref": "#/components/schemas/Amount" }, "variationAspects": { "type": "array", "description": "An array of aspect name-value pairs that identifies the specific variation of a multi-variation listing. This array can contain multiple name-value pairs, such as color:blue and size:large, and will only be returned for orders created from a multiple-variation listing.", "items": { "$ref": "#/components/schemas/NameValuePair" } } }, "description": "This type contains the details of each line item in an order." }, "LineItemFulfillmentInstructions": { "type": "object", "properties": { "guaranteedDelivery": { "type": "boolean", "description": "Although this field is still returned, it can be ignored since eBay Guaranteed Delivery is no longer a supported feature on any marketplace. This field may get removed from the schema in the future." }, "maxEstimatedDeliveryDate": { "type": "string", "description": "The estimated latest date and time that the buyer can expect to receive the line item based on the seller's stated handling time and the transit times of the available shipping service options. The seller must pay extra attention to this date, as a failure to deliver by this date/time can result in a 'Late shipment' seller defect, and can affect seller level and Top-Rated Seller status. In addition to the seller defect, buyers will be eligible for a shipping cost refund, and will also be eligible to return the item for a full refund (with no return shipping charge) if they choose.

Note: This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "minEstimatedDeliveryDate": { "type": "string", "description": "The estimated earliest date and time that the buyer can expect to receive the line item based on the seller's stated handling time and the transit times of the available shipping service options.

Note: This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "shipByDate": { "type": "string", "description": "The latest date and time by which the seller should ship line item in order to meet the expected delivery window. This timestamp will be set by eBay based on time of purchase and the seller's stated handling time. The seller must pay extra attention to this date, as a failure to physically ship the line item by this date/time can result in a 'Late shipment' seller defect, and can affect seller level and Top-Rated Seller status. In addition to the seller defect, buyers will be eligible for a shipping cost refund, and will also be eligible to return the item for a full refund (with no return shipping charge) if they choose.

Note: This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" } }, "description": "This type contains the specifications for processing the fulfillment of a line item, including the handling window and the delivery window. These fields provide guidance for eBay Guaranteed Delivery as well as for non-guaranteed delivery." }, "LineItemProperties": { "type": "object", "properties": { "buyerProtection": { "type": "boolean", "description": "A value of true indicates that the line item is covered by eBay's Buyer Protection program." }, "fromBestOffer": { "type": "boolean", "description": "This field is only returned if true and indicates that the purchase occurred by the buyer and seller mutually agreeing on a Best Offer amount. The Best Offer feature can be set up for any listing type, but if this feature is set up for an auction listing, it will no longer be available once a bid has been placed on the listing." }, "soldViaAdCampaign": { "type": "boolean", "description": "This field is only returned if true and indicates that the line item was sold as a result of a seller's ad campaign." } }, "description": "This type contains information about the eBay programs under which a line item was listed and sold." }, "LineItemReference": { "type": "object", "properties": { "lineItemId": { "type": "string", "description": "This is the unique identifier of the eBay order line item that is part of the shipping fulfillment.

Line item Ids can be found in the lineItems.lineItemId field of the getOrders response." }, "quantity": { "type": "integer", "description": "This is the number of lineItems associated with the trackingNumber specified by the seller. This must be a whole number greater than zero (0).

Default: 1", "format": "int32" } }, "description": "This type identifies the line item and quantity of that line item that comprises one fulfillment, such as a shipping package." }, "LineItemRefund": { "type": "object", "properties": { "amount": { "description": "This field shows the refund amount for a line item. This field is only returned if the buyer is due a refund for the line item.

Note: The refund amount shown is the seller's net amount received from the sale/transaction. eBay-collected tax will not be included in this amount, so the actual amount of the buyer's refund may be higher than this value.", "$ref": "#/components/schemas/Amount" }, "refundDate": { "type": "string", "description": "The date and time that the refund was issued for the line item. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the refund has been issued.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "refundId": { "type": "string", "description": "Unique identifier of a refund that was initiated for an order's line item through the issueRefund method. If the issueRefund method was used to issue a refund at the order level, this identifier is returned at the order level instead (paymentSummary.refunds.refundId field).

A refundId value is returned in the response of the issueRefund method, and this same value will be returned in the getOrder and getOrders responses for pending and completed refunds." }, "refundReferenceId": { "type": "string", "description": "This field is reserved for internal or future use." } }, "description": "This type contains refund information for a line item." }, "LinkedOrderLineItem": { "type": "object", "properties": { "lineItemAspects": { "type": "array", "description": "This array contains the complete set of items aspects for the linked line item. For example:
\"lineItemAspects\": [
    {
        \"name\": \"Tire Type\",
        \"value\": \"All Season\"
    },

    ...
 
    {
        \"name\": \"Car Type\",
        \"value\": \"Performance\"
    }
]
Note: All item specifics for the listing are returned. The name/value pairs returned are in the language of the linked line item's listing site, which may vary from the seller's language.", "items": { "$ref": "#/components/schemas/NameValuePair" } }, "lineItemId": { "type": "string", "description": "The unique identifier of the linked order line item." }, "maxEstimatedDeliveryDate": { "type": "string", "description": "The end of the date range in which the linked line item is expected to be delivered to the shipping address." }, "minEstimatedDeliveryDate": { "type": "string", "description": "The beginning of the date range in which the linked line item is expected to be delivered to the shipping address." }, "orderId": { "type": "string", "description": "The unique identifier of the order to which the linked line item belongs." }, "sellerId": { "type": "string", "description": "The eBay user ID of the seller who sold the linked line item. For example, the user ID of the tire seller." }, "shipments": { "type": "array", "description": "An array containing any shipment tracking information available for the linked line item.", "items": { "$ref": "#/components/schemas/TrackingInfo" } }, "title": { "type": "string", "description": "The listing title of the linked line item.

Note: The Item ID value for the listing will be returned in this field instead of the actual title if this particular listing is on-hold due to an eBay policy violation." } }, "description": "This type contains data on a line item that is related to, but not a part of the order." }, "MonetaryTransaction": { "type": "object", "properties": { "date": { "type": "string", "description": "This timestamp indicates when the monetary transaction occurred. A date is returned for all monetary transactions.

The following format is used: YYYY-MM-DDTHH:MM:SS.SSSZ. For example, 2015-08-04T19:09:02.768Z." }, "type": { "type": "string", "description": "This enumeration value indicates whether the monetary transaction is a charge or a credit to the seller. For implementation help, refer to eBay API documentation" }, "reason": { "type": "string", "description": "This enumeration value indicates the reason for the monetary transaction. For implementation help, refer to eBay API documentation" }, "amount": { "description": "The amount involved in the monetary transaction. For active cross-border trade orders, the currency conversion and exchangeRate fields will be displayed as well.", "$ref": "#/components/schemas/DisputeAmount" } }, "description": "This type is used to provide details about one or more monetary transactions that occur as part of a payment dispute." }, "NameValuePair": { "type": "object", "properties": { "name": { "type": "string", "description": "The text representing the name of the aspect for the name-value pair. For example, color, or Tire Type." }, "value": { "type": "string", "description": "The value of the aspect for the name-value pair. For example, red, or All Season." } }, "description": "This type contains the name-value specifics of a multi-variation listing (variationAspects) or the name-value specifics for all item aspects of a linked line item (linkedOrderLineItems)." }, "Order": { "type": "object", "properties": { "buyer": { "description": "This container consists of information about the order's buyer. At this time, only the buyer's eBay user ID is returned, but it's possible that more buyer information can be added to this container in the future.", "$ref": "#/components/schemas/Buyer" }, "buyerCheckoutNotes": { "type": "string", "description": "This field contains any comments that the buyer left for the seller about the order during checkout process. This field is only returned if a buyer left comments at checkout time. " }, "cancelStatus": { "description": "This container consists of order cancellation information if a cancel request has been made. This container is always returned, and if no cancel request has been made, the cancelState field is returned with a value of NONE_REQUESTED, and an empty cancelRequests array is also returned.", "$ref": "#/components/schemas/CancelStatus" }, "creationDate": { "type": "string", "description": "The date and time that the order was created. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "ebayCollectAndRemitTax": { "type": "boolean", "description": "This field is only returned if true, and indicates that eBay will collect tax (US state-mandated sales tax, Federal and Provincial Sales Tax in Canada, 'Goods and Services' tax in Canada, Australia, and New Zealand, and VAT collected for UK and EU countries,) for at least one line item in the order, and remit the tax to the taxing authority of the buyer's residence. If this field is returned, the seller should search for one or more ebayCollectAndRemitTaxes containers at the line item level to get more information about the type of tax and the amount." }, "fulfillmentHrefs": { "type": "array", "description": "This array contains a list of one or more getShippingFulfillment call URIs that can be used to retrieve shipping fulfillments that have been set up for the order.", "items": { "type": "string" } }, "fulfillmentStartInstructions": { "type": "array", "description": "This container consists of a set of specifications for fulfilling the order, including the type of fulfillment, shipping carrier and service, shipping address, and estimated delivery window. These instructions are derived from the buyer's and seller's eBay account preferences, the listing parameters, and the buyer's checkout selections. The seller can use them as a starting point for packaging, addressing, and shipping the order.

Note: Although this container is presented as an array, it currently returns only one set of fulfillment specifications. Additional array members will be supported in future functionality.", "items": { "$ref": "#/components/schemas/FulfillmentStartInstruction" } }, "lastModifiedDate": { "type": "string", "description": "The date and time that the order was last modified. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "lineItems": { "type": "array", "description": "This array contains the details for all line items that comprise the order.", "items": { "$ref": "#/components/schemas/LineItem" } }, "orderFulfillmentStatus": { "type": "string", "description": "The degree to which fulfillment of the order is complete. See the OrderFulfillmentStatus type definition for more information about each possible fulfillment state. For implementation help, refer to eBay API documentation" }, "orderId": { "type": "string", "description": "The unique identifier of the order. This field is always returned." }, "orderPaymentStatus": { "type": "string", "description": "The enumeration value returned in this field indicates the current payment status of an order, or in case of a refund request, the current status of the refund. See the OrderPaymentStatusEnum type definition for more information about each possible payment/refund state. For implementation help, refer to eBay API documentation" }, "paymentSummary": { "description": "This container consists of detailed payment information for the order, including buyer payment for the order, refund information (if applicable), and seller payment holds (if applicable).", "$ref": "#/components/schemas/PaymentSummary" }, "pricingSummary": { "description": "This container consists of a summary of cumulative costs and charges for all line items of an order, including item price, price adjustments, sales taxes, delivery costs, and order discounts.", "$ref": "#/components/schemas/PricingSummary" }, "program": { "description": "This container is returned for orders that are eligible for eBay's Authenticity Guarantee service. The seller ships Authenticity Guarantee service items to the authentication partner instead of the buyer. The authenticator address is found in the fulfillmentStartInstructions.shippingStep.shipTo container. If the item is successfully authenticated, the authenticator will ship the item to the buyer.", "$ref": "#/components/schemas/Program" }, "salesRecordReference": { "type": "string", "description": "An eBay-generated identifier that is used to identify and manage orders through the Selling Manager and Selling Manager Pro tools. This order identifier can also be found on the Orders grid page and in the Sales Record pages in Seller Hub. A salesRecordReference number is only generated and returned at the order level, and not at the order line item level.

In cases where the seller does not have a Selling Manager or Selling Manager Pro subscription nor access to Seller Hub, this field may not be returned." }, "sellerId": { "type": "string", "description": "The unique eBay user ID of the seller who sold the order." }, "totalFeeBasisAmount": { "description": "This is the cumulative base amount used to calculate the final value fees for each order. The final value fees are deducted from the seller payout associated with the order. Final value fees are calculated as a percentage of order cost (item cost + shipping cost) and the percentage rate can vary by eBay category. ", "$ref": "#/components/schemas/Amount" }, "totalMarketplaceFee": { "description": "This is the cumulative fees accrued for the order and deducted from the seller payout.", "$ref": "#/components/schemas/Amount" } }, "description": "This type contains the details of an order, including information about the buyer, order history, shipping fulfillments, line items, costs, payments, and order fulfillment status." }, "OrderLineItems": { "type": "object", "properties": { "itemId": { "type": "string", "description": "The unique identifier of the eBay listing associated with the order." }, "lineItemId": { "type": "string", "description": "The unique identifier of the line item within the order." } }, "description": "This type is used by the lineItems array that is used to identify one or more line items in the order with the payment dispute." }, "OrderRefund": { "type": "object", "properties": { "amount": { "description": "This field shows the refund amount for an order. This container is always returned for each refund.

Note: The refund amount shown is the seller's net amount received from the sale/transaction. eBay-collected tax will not be included in this amount, so the actual amount of the buyer's refund may be higher than this value.", "$ref": "#/components/schemas/Amount" }, "refundDate": { "type": "string", "description": "The date and time that the refund was issued. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the refund has been issued.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "refundId": { "type": "string", "description": "Unique identifier of a refund that was initiated for an order through the issueRefund method. If the issueRefund method was used to issue one or more refunds at the line item level, these refund identifiers are returned at the line item level instead (lineItems.refunds.refundId field).

A refundId value is returned in the response of the issueRefund method, and this same value will be returned in the getOrders and getOrders responses for pending and completed refunds. For other refunds, see the refundReferenceId field." }, "refundReferenceId": { "type": "string", "description": "The eBay-generated unique identifier for the refund. This field is not returned until the refund has been issued." }, "refundStatus": { "type": "string", "description": "This enumeration value indicates the current status of the refund to the buyer. This container is always returned for each refund. For implementation help, refer to eBay API documentation" } }, "description": "This type contains information about a refund issued for an order. This does not include line item level refunds." }, "OrderSearchPagedCollection": { "type": "object", "properties": { "href": { "type": "string", "description": "The URI of the getOrders call request that produced the current page of the result set." }, "limit": { "type": "integer", "description": "The maximum number of orders returned per page of the result set. The limit value can be passed in as a query parameter, or if omitted, its value defaults to 50.

Note: If this is the last or only page of the result set, the page may contain fewer orders than the limit value. To determine the number of pages in a result set, divide the total value (total number of orders matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was 120 (120 total orders) and the limit value was 50 (show 50 orders per page), the total number of pages in the result set is three, so the seller would have to make three separate getOrders calls to view all orders matching the input criteria. Default: 50", "format": "int32" }, "next": { "type": "string", "description": "The getOrders call URI to use if you wish to view the next page of the result set. For example, the following URI returns records 41 thru 50 from the collection of orders:

path/order?limit=10&offset=40

This field is only returned if there is a next page of results to view based on the current input criteria.
" }, "offset": { "type": "integer", "description": "The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.

Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.

", "format": "int32" }, "orders": { "type": "array", "description": "This array contains one or more orders that are part of the current result set, that is controlled by the input criteria. The details of each order include information about the buyer, order history, shipping fulfillments, line items, costs, payments, and order fulfillment status.

By default, orders are returned according to creation date (oldest to newest), but the order will vary according to any filter that is set in request.", "items": { "$ref": "#/components/schemas/Order" } }, "prev": { "type": "string", "description": "The getOrders call URI for the previous result set. For example, the following URI returns orders 21 thru 30 from the collection of orders:

path/order?limit=10&offset=20

This field is only returned if there is a previous page of results to view based on the current input criteria." }, "total": { "type": "integer", "description": "The total number of orders in the results set based on the current input criteria.

Note: If no orders are found, this field is returned with a value of 0.", "format": "int32" }, "warnings": { "type": "array", "description": "This array is returned if one or more errors or warnings occur with the call request.", "items": { "$ref": "#/components/schemas/Error" } } }, "description": "This type contains the specifications for the collection of orders that match the search or filter criteria of a getOrders call. The collection is grouped into a result set, and based on the query parameters that are set (including the limit and offset parameters), the result set may included multiple pages, but only one page of the result set can be viewed at a time." }, "Payment": { "type": "object", "properties": { "amount": { "description": "The amount that seller receives for the order via the payment method mentioned in Payment.paymentMethod.

Note: For orders that are subject to 'eBay Collect and Remit' tax, which includes US state-mandated sales tax, Federal and Provincial Sales Tax in Canada, 'Good and Services' tax in Canada, Australia, and New Zealand, and VAT collected for UK or EU, the 'Collect and Remit' tax amount for the order will be included in this amount.value field (and in the amount.convertedFromValue field if currency conversion is applicable).

To determine if 'Collect and Remit' taxes were added into this totalDueSeller value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes and the lineItems.taxes containers in the response. If both of these containers appear for one or more line items in the response with the following taxType values, the 'Collect and Remit' tax amount that the buyer paid is included in this amount:", "$ref": "#/components/schemas/Amount" }, "paymentDate": { "type": "string", "description": "The date and time that the payment was received by the seller. This field will not be returned if buyer has yet to pay for the order. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "paymentHolds": { "type": "array", "description": "This container is only returned if eBay is temporarily holding the seller's funds for the order. If a payment hold has been placed on the order, this container includes the reason for the payment hold, the expected release date of the funds into the seller's account, the current state of the hold, and as soon as the payment hold has been released, the actual release date.", "items": { "$ref": "#/components/schemas/PaymentHold" } }, "paymentMethod": { "type": "string", "description": "The payment method used to pay for the order. See the PaymentMethodTypeEnum type for more information on the payment methods. For implementation help, refer to eBay API documentation" }, "paymentReferenceId": { "type": "string", "description": "This field is only returned if payment has been made by the buyer, and the paymentMethod is ESCROW. This field contains a special ID for ESCROW." }, "paymentStatus": { "type": "string", "description": "The enumeration value returned in this field indicates the status of the payment for the order. See the PaymentStatusEnum type definition for more information on the possible payment states. For implementation help, refer to eBay API documentation" } }, "description": "This type is used to provide details about the seller payments for an order." }, "PaymentDispute": { "type": "object", "properties": { "amount": { "description": "This container shows the dollar value associated with the payment dispute in the currency used by the seller's marketplace.", "$ref": "#/components/schemas/SimpleAmount" }, "availableChoices": { "type": "array", "description": "The value(s) returned in this array indicate the choices that the seller has when responding to the payment dispute. Once the seller has responded to the payment dispute, this field will no longer be shown, and instead, the sellerResponse field will show the decision that the seller made.", "items": { "type": "string", "description": " For implementation help, refer to eBay API documentation" } }, "buyerProvided": { "description": "This container is returned if the buyer is returning one or more line items in an order that is associated with the payment dispute, and that buyer has provided return shipping tracking information and/or a note about the return.", "$ref": "#/components/schemas/InfoFromBuyer" }, "buyerUsername": { "type": "string", "description": "This is the eBay user ID of the buyer that initiated the payment dispute." }, "closedDate": { "type": "string", "description": "The timestamp in this field shows the date/time when the payment dispute was closed, so this field is only returned for payment disputes in the CLOSED state.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." }, "evidence": { "type": "array", "description": "This container shows any evidence that has been provided by the seller to contest the payment dispute. Evidence may include shipment tracking information, proof of authentication documentation, image(s) to proof that an item is as described, or financial documentation/invoice.

This container is only returned if the seller has provided at least one document used as evidence against the payment dispute.", "items": { "$ref": "#/components/schemas/DisputeEvidence" } }, "evidenceRequests": { "type": "array", "description": "This container is returned if one or more evidence documents are being requested from the seller.", "items": { "$ref": "#/components/schemas/EvidenceRequest" } }, "lineItems": { "type": "array", "description": "This array is used to identify one or more order line items associated with the payment dispute. There will always be at least one itemId/lineItemId pair returned in this array.", "items": { "$ref": "#/components/schemas/OrderLineItems" } }, "monetaryTransactions": { "type": "array", "description": "This array provide details about one or more monetary transactions that occur as part of a payment dispute. This array is only returned once one or more monetary transacations occur with a payment dispute.", "items": { "$ref": "#/components/schemas/MonetaryTransaction" } }, "note": { "type": "string", "description": "This field shows information that the seller provides about the dispute, such as the basis for the dispute, any relevant evidence, tracking numbers, and so forth.

This field is limited to 1000 characters." }, "openDate": { "type": "string", "description": "The timestamp in this field shows the date/time when the payment dispute was opened. This field is returned for payment disputes in all states.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." }, "orderId": { "type": "string", "description": "This is the unique identifier of the order involved in the payment dispute." }, "paymentDisputeId": { "type": "string", "description": "This is the unique identifier of the payment dispute. This is the same identifier that is passed in to the call URI. This identifier is automatically created by eBay once the payment dispute comes into the eBay system." }, "paymentDisputeStatus": { "type": "string", "description": "The enumeration value in this field gives the current status of the payment dispute. The status of a payment dispute partially determines other fields that are returned in the response. For implementation help, refer to eBay API documentation" }, "reason": { "type": "string", "description": "The enumeration value in this field gives the reason why the buyer initiated the payment dispute. See DisputeReasonEnum type for a description of the supported reasons that buyers can give for initiating a payment dispute. For implementation help, refer to eBay API documentation" }, "resolution": { "description": "This container gives details about a payment dispute that has been resolved. This container is only returned for resolved/closed payment disputes.", "$ref": "#/components/schemas/PaymentDisputeOutcomeDetail" }, "respondByDate": { "type": "string", "description": "The timestamp in this field shows the date/time when the seller must response to a payment dispute, so this field is only returned for payment disputes in the ACTION_NEEDED state. For payment disputes that currently require action by the seller, that same seller should look at the availableChoices array to see the available actions.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." }, "returnAddress": { "description": "This container gives the address where the order will be returned to. This container is returned if the seller is accepting the payment dispute and will issue a refund to the buyer once the item is returned to this address.", "$ref": "#/components/schemas/ReturnAddress" }, "revision": { "type": "integer", "description": "This integer value indicates the revision number of the payment dispute. Each time an action is taken against a payment dispute, this integer value increases by 1.", "format": "int32" }, "sellerResponse": { "type": "string", "description": "The enumeration value returned in this field indicates how the seller has responded to the payment dispute. The seller has the option of accepting the payment dispute and agreeing to issue a refund, accepting the payment dispute and agreeing to issue a refund as long as the buyer returns the item, or contesting the payment dispute. This field is returned as soon as the seller makes an initial decision on the payment dispute. For implementation help, refer to eBay API documentation" } }, "description": "This type is used by the base response of the getPaymentDispute method. The getPaymentDispute method retrieves detailed information on a specific payment dispute." }, "PaymentDisputeActivity": { "type": "object", "properties": { "activityDate": { "type": "string", "description": "The timestamp in this field shows the date/time of the payment dispute activity.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." }, "activityType": { "type": "string", "description": "This enumeration value indicates the type of activity that occured on the payment dispute. For example, a value of DISPUTE_OPENED is returned when a payment disute is first created, a value indicating the seller's decision on the dispute, such as SELLER_CONTEST, is returned when seller makes a decision to accept or contest dispute, and a value of DISPUTE_CLOSED is returned when a payment disute is resolved. See ActivityEnum for an explanation of each of the values that may be returned here. For implementation help, refer to eBay API documentation" }, "actor": { "type": "string", "description": "This enumeration value indicates the actor that performed the action. Possible values include the BUYER, SELLER, CS_AGENT (eBay customer service), or SYSTEM. For implementation help, refer to eBay API documentation" } }, "description": "This type is used by each recorded activity on a payment dispute, from creation to resolution." }, "PaymentDisputeActivityHistory": { "type": "object", "properties": { "activity": { "type": "array", "description": "This array holds all activities of a payment dispute, from creation to resolution. For each activity, the activity type, the actor, and a timestamp is shown. The getActivities response is dynamic, and grows with each recorded activity.", "items": { "$ref": "#/components/schemas/PaymentDisputeActivity" } } }, "description": "This type is used by the base response of the getActivities method, and includes a log of all activities of a payment dispute, from creation to resolution." }, "PaymentDisputeOutcomeDetail": { "type": "object", "properties": { "fees": { "description": "This container will show the dollar value of any fees associated with the payment dispute. This container is only returned if there are fees associated with the payment dispute.", "$ref": "#/components/schemas/SimpleAmount" }, "protectedAmount": { "description": "This container shows the amount of money that the seller is protected against in a payment dispute under eBay's seller protection policy.", "$ref": "#/components/schemas/SimpleAmount" }, "protectionStatus": { "type": "string", "description": "This enumeration value indicates if the seller is fully protected, partially protected, or not protected by eBay for the payment dispute. This field is always returned once the payment dispute is resolved. For implementation help, refer to eBay API documentation" }, "reasonForClosure": { "type": "string", "description": "The enumeration value returned in this field indicates the outcome of the payment dispute for the seller. This field is always returned once the payment dispute is resolved. For implementation help, refer to eBay API documentation" }, "recoupAmount": { "description": "This container shows the dollar amount being recouped from the seller. This container is empty if the seller wins the payment dispute or if the seller is fully protected by eBay's seller protection policy.", "$ref": "#/components/schemas/SimpleAmount" }, "totalFeeCredit": { "description": "This container shows the amount of money in selling fee credits due back to the seller after a payment dispute is settled.", "$ref": "#/components/schemas/SimpleAmount" } }, "description": "This type is used by the resolution container that is returned for payment disputes that have been resolved." }, "PaymentDisputeSummary": { "type": "object", "properties": { "amount": { "description": "This container shows the dollar value associated with the payment dispute in the currency used by the seller's marketplace. This container is returned for all payment disputes returned in the response.", "$ref": "#/components/schemas/SimpleAmount" }, "buyerUsername": { "type": "string", "description": "This is the buyer's eBay user ID. This field is returned for all payment disputes returned in the response." }, "closedDate": { "type": "string", "description": "The timestamp in this field shows the date/time when the payment dispute was closed, so this field is only returned for payment disputes in the CLOSED state.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." }, "openDate": { "type": "string", "description": "The timestamp in this field shows the date/time when the payment dispute was opened. This field is returned for payment disputes in all states.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." }, "orderId": { "type": "string", "description": "This is the unique identifier of the order involved in the payment dispute." }, "paymentDisputeId": { "type": "string", "description": "This is the unique identifier of the payment dispute. This identifier is automatically created by eBay once the payment dispute comes into the eBay system. This identifier is passed in at the end of the getPaymentDispute call URI to retrieve a specific payment dispute. The getPaymentDispute method returns more details about a payment dispute than the getPaymentDisputeSummaries method." }, "paymentDisputeStatus": { "type": "string", "description": "The enumeration value in this field gives the current status of the payment dispute. For implementation help, refer to eBay API documentation" }, "reason": { "type": "string", "description": "The enumeration value in this field gives the reason why the buyer initiated the payment dispute. See DisputeReasonEnum type for a description of the supported reasons that buyers can give for initiating a payment dispute. For implementation help, refer to eBay API documentation" }, "respondByDate": { "type": "string", "description": "The timestamp in this field shows the date/time when the seller must response to a payment dispute, so this field is only returned for payment disputes in the ACTION_NEEDED state. For payment disputes that require action by the seller, that same seller must call getPaymentDispute to see the next action(s) that they can take against the payment dispute.

The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: yyyy-MM-ddThh:mm.ss.sssZ. An example would be 2019-08-04T19:09:02.768Z." } }, "description": "This type is used by each payment dispute that is returned with the getPaymentDisputeSummaries method." }, "PaymentHold": { "type": "object", "properties": { "expectedReleaseDate": { "type": "string", "description": "The date and time that the payment being held is expected to be released to the seller. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field will be returned if known by eBay.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "holdAmount": { "description": "The monetary amount of the payment being held. This field is always returned with the paymentHolds array. ", "$ref": "#/components/schemas/Amount" }, "holdReason": { "type": "string", "description": "The reason that the payment is being held. A seller's payment may be held for a number of reasons, including when the seller is new, the seller's level is below standard, or if a return case or 'Significantly not as described' case is pending against the seller. This field is always returned with the paymentHolds array." }, "holdState": { "type": "string", "description": "The current stage or condition of the hold. This field is always returned with the paymentHolds array.

Applicable values:" }, "releaseDate": { "type": "string", "description": "The date and time that the payment being held was actually released to the seller. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the seller's payment is actually released into the seller's account.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "sellerActionsToRelease": { "type": "array", "description": "A list of one or more possible actions that the seller can take to expedite the release of the payment hold.", "items": { "$ref": "#/components/schemas/SellerActionsToRelease" } } }, "description": "This type contains information about a hold placed on a payment to a seller for an order, including the reason why the buyer's payment for the order is being held, the expected release date of the funds into the seller's account, the current state of the hold, and the actual release date if the payment has been released, and possible actions the seller can take to expedite the payout of funds into their account." }, "PaymentSummary": { "type": "object", "properties": { "payments": { "type": "array", "description": "This array consists of payment information for the order, including payment status, payment method, payment amount, and payment date. This array is always returned, although some of the fields under this container will not be returned until payment has been made.", "items": { "$ref": "#/components/schemas/Payment" } }, "refunds": { "type": "array", "description": "This array is always returned, but is returned as an empty array unless the seller has submitted a partial or full refund to the buyer for the order. If a refund has occurred, the refund amount and refund date will be shown for each refund.", "items": { "$ref": "#/components/schemas/OrderRefund" } }, "totalDueSeller": { "description": "This is the total price that the seller receives for the entire order after all costs (item cost, delivery cost, taxes) are added for all line items, minus any discounts and/or promotions for any of the line items. Note that this value is subject to change before payment is actually made by the buyer (if the paymentStatus value was PENDING or FAILED), or if a partial or full refund occurs with the order.

Note: For orders that are subject to 'eBay Collect and Remit' tax, the 'Collect and Remit' tax amount for the order will be included in this totalDueSeller value.

To determine if 'Collect and Remit' taxes were added into this totalDueSeller value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes and the lineItems.taxes containers in the response. If both of these containers appear for one or more line items in the response with the following taxType values, the 'Collect and Remit' tax amount that the buyer paid is included in this amount:", "$ref": "#/components/schemas/Amount" } }, "description": "This type contains information about the various monetary exchanges that apply to the net balance due for the order." }, "Phone": { "type": "object", "properties": { "countryCode": { "type": "string", "description": " The two-letter, ISO 3166 code associated with the seller's phone number. This field is needed if the buyer is located in a different country than the seller. It is also OK to provide if the buyer and seller are both located in the same country

See CountryCodeEnum for a list of supported values." }, "number": { "type": "string", "description": "The seller's primary phone number associated with the return address. When this number is provided in a contestPaymentDispute or contestPaymentDispute method, it is provided as one continuous numeric string, including the area code. So, if the phone number's area code was '408', a number in this field may look something like this:

\"number\" : \"4088084356\"

If the buyer is located in a different country than the seller, the seller's country code will need to be specified in the countryCode field." } }, "description": "This type is used by the returnAddress
This field is always returned with the pickupStep container." } }, "description": "This type is used to indicate the merchant's store where the buyer will pickup their In-Store Pickup order. The pickupStep container is only returned for In-Store Pickup orders. The In-Store Pickup feature is supported in the US, Canada, UK, Germany, and Australia marketplaces." }, "PostSaleAuthenticationProgram": { "type": "object", "properties": { "outcomeReason": { "type": "string", "description": "This field indicates the result of the authenticity verification inspection on an order line item. This field is not returned when the status value of the order line item is PENDING or PASSED. The possible values returned here are NOT_AUTHENTIC, NOT_AS_DESCRIBED, CUSTOMIZED, MISCATEGORIZED, or NOT_AUTHENTIC_NO_RETURN. For implementation help, refer to eBay API documentation" }, "status": { "type": "string", "description": "The value in this field indicates whether the order line item has passed or failed the authenticity verification inspection, or if the inspection and/or results are still pending. The possible values returned here are PENDING, PASSED, FAILED, or PASSED_WITH_EXCEPTION. For implementation help, refer to eBay API documentation" } }, "description": "This type is used to provide the status and outcome of an order line item going through the Authenticity Guarantee verification process." }, "PricingSummary": { "type": "object", "properties": { "adjustment": { "description": "This container shows the total amount of any adjustments that were applied to the cost of the item(s) in the order. This amount does not include shipping, discounts, fixed fees, or taxes.

This container is only returned if price adjustments were made to the order after the initial transaction/commitment to buy occurred.", "$ref": "#/components/schemas/Amount" }, "deliveryCost": { "description": "This container shows the total cost of delivering the order to the buyer, before any shipping/delivery discount is applied.", "$ref": "#/components/schemas/Amount" }, "deliveryDiscount": { "description": "This container shows the total amount of delivery discounts (including shipping discounts) that apply to the order. This should be a negative real number.

This container is only returned if delivery discounts are being applied to the order.", "$ref": "#/components/schemas/Amount" }, "fee": { "description": "This container shows the total amount of any special fees applied to the order, such as a tire recycling fee or an electronic waste fee.

This container is returned if special fees are being applied to the order and if the fieldGroups is set to TAX_BREAKDOWN.", "$ref": "#/components/schemas/Amount" }, "priceDiscount": { "description": "This container shows the total amount of all item price discounts (including promotions) that apply to the order and reduce its cost to the buyer. This should be a negative real number.

This container is only returned if special discounts are being applied to the order.", "$ref": "#/components/schemas/Amount" }, "priceSubtotal": { "description": "This container shows the cumulative costs of of all units of all line items in the order, before any discount is applied.", "$ref": "#/components/schemas/Amount" }, "tax": { "description": "This container shows the total amount of tax for the order. To calculate the tax percentage rate, divide this value by the value of the total field.

This container is only returned if any type of tax (sales tax, tax on shipping, tax on handling, import tax, etc.) is applied to the order.", "$ref": "#/components/schemas/Amount" }, "total": { "description": "The total cost of the order after adding all line item costs, delivery costs, sales tax, and special fees, and then subtracting all special discounts and price adjustments.

Note: For orders that are subject to 'eBay Collect and Remit' tax, the 'Collect and Remit' tax amount for the order will be included in this total value only when the fieldGroups query parameter is set to TAX_BREAKDOWN. If the fieldGroups query parameter is not set to TAX_BREAKDOWN, 'Collect and Remit' will not be added into this total value.

To determine if 'Collect and Remit' taxes were added into this total value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes and the lineItems.taxes containers in the response. If both of these containers appear for one or more line items in the response with the following taxType values, the 'Collect and Remit' tax amount that the buyer paid is included in this amount:", "$ref": "#/components/schemas/Amount" } }, "description": "This type contains a summary of cumulative costs and charges for all line items of an order, including item price, price adjustments, sales taxes, delivery costs, and order discounts." }, "Program": { "type": "object", "properties": { "authenticityVerification": { "description": "This field is returned when the third-party authenticator performs the authentication verification inspection on the order line item. Different values will be returned based on whether the item passed or failed the authentication verification inspection.", "$ref": "#/components/schemas/PostSaleAuthenticationProgram" }, "ebayShipping": { "description": "This container is returned only if the order is an eBay shipping order. It consists of a field that indicates the provider of a shipping label for this order.", "$ref": "#/components/schemas/EbayShipping" }, "ebayVault": { "description": "This field provides information about the eBay vault program that has been selected for an order. This is returned only for those items that are eligible for the eBay Vault Program.", "$ref": "#/components/schemas/EbayVaultProgram" }, "ebayInternationalShipping": { "description": "This container is returned if the order is being fulfilled through eBay International Shipping.", "$ref": "#/components/schemas/EbayInternationalShipping" }, "fulfillmentProgram": { "description": "This field provides details about an order line item being handled by eBay fulfillment. It is only returned for paid orders being fulfilled by eBay or an eBay fulfillment partner.", "$ref": "#/components/schemas/EbayFulfillmentProgram" } }, "description": "This type is returned for order line items eligible for the Authenticity Guarantee service and/or for order line items fulfilled by the eBay Fulfillment program or eBay shipping." }, "Property": { "type": "object", "properties": { "propertyDisplayName": { "type": "string", "description": "The display name of the motor vehicle aspect. This is the localized name of the compatibility property." }, "propertyName": { "type": "string", "description": "The name of the motor vehicle aspect.

For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category." }, "propertyValue": { "type": "string", "description": "The value of the property specified in the propertyName field.

For example, if the propertyName is Make, then the propertyValue will be the specific make of the vehicle, such as Toyota." } }, "description": "This type defines the property name and value for an order." }, "Refund": { "type": "object", "properties": { "refundId": { "type": "string", "description": "The unique identifier of the order refund. This value is returned unless the refund operation fails (refundStatus value shows FAILED). This identifier can be used to track the status of the refund through a getOrder or getOrders call. For order-level refunds, check the paymentSummary.refunds.refundId field in the getOrder/getOrders response, and for line item level refunds, check the lineItems.refunds.refundId field(s) in the getOrder/getOrders response." }, "refundStatus": { "type": "string", "description": "The value returned in this field indicates the success or failure of the refund operation. A successful issueRefund operation should result in a value of PENDING. A failed issueRefund operation should result in a value of FAILED, and an HTTP status code and/or and API error code may also get returned to possibly indicate the issue.

The refunds issued through this method are processed asynchronously, so the refund will not show as 'Refunded' right away. A seller will have to make a subsequent getOrder call to check the status of the refund. The status of an order refund can be found in the paymentSummary.refunds.refundStatus field of the getOrder response. For implementation help, refer to eBay API documentation" } }, "description": "This is the base type of the issueRefund response payload. As long as the issueRefund method does not trigger an error, a response payload will be returned." }, "RefundItem": { "type": "object", "properties": { "refundAmount": { "description": "This container is used to specify the amount of the refund for the corresponding order line item. If a seller wants to issue a refund for an entire order, the seller would use the orderLevelRefundAmount container instead.", "$ref": "#/components/schemas/SimpleAmount" }, "lineItemId": { "type": "string", "description": "The unique identifier of an order line item. This identifier is created once a buyer purchases a 'Buy It Now' item or if an auction listing ends with a winning bidder.

Either this field or the legacyReference container is needed to identify an individual order line item that will receive a refund.

This value is returned using the getOrders method." }, "legacyReference": { "description": "This container is needed if the seller is issuing a refund for an individual order line item, and wishes to use an item ID/transaction ID pair to identify the order line item.

Either this container or the lineItemId field is needed to identify an individual order line item that will receive a refund.

Note: This container should only be used if a seller is using the GetOrders method of the Trading API.", "$ref": "#/components/schemas/LegacyReference" } }, "description": "This type is used if the seller is issuing a refund for one or more individual order line items in a multiple line item order. Otherwise, the seller just uses the orderLevelRefundAmount container to specify the amount of the refund for the entire order." }, "ReturnAddress": { "type": "object", "properties": { "addressLine1": { "type": "string", "description": "The first line of the street address." }, "addressLine2": { "type": "string", "description": "The second line of the street address. This line is not always necessarily, but is often used for apartment number or suite number, or other relevant information that can not fit on the first line." }, "city": { "type": "string", "description": "The city of the return address." }, "country": { "type": "string", "description": "The country's two-letter, ISO 3166-1 country code. See the enumeration type for a country's value. For implementation help, refer to eBay API documentation" }, "county": { "type": "string", "description": "The county of the return address. Counties are not applicable to all countries." }, "fullName": { "type": "string", "description": "The full name of return address owner." }, "postalCode": { "type": "string", "description": "The postal code of the return address." }, "primaryPhone": { "description": "This container shows the seller's primary phone number associated with the return address.", "$ref": "#/components/schemas/Phone" }, "stateOrProvince": { "type": "string", "description": "The state or province of the return address." } }, "description": "This type is used by the payment dispute methods, and is relevant if the buyer will be returning the item to the seller." }, "SellerActionsToRelease": { "type": "object", "properties": { "sellerActionToRelease": { "type": "string", "description": "A possible action that the seller can take to expedite the release of a payment hold. A sellerActionToRelease field is returned for each possible action that a seller may take. Possible actions may include providing shipping/tracking information, issuing a refund, providing refund information, contacting customer support, etc." } }, "description": "This type is used to state possible action(s) that a seller can take to release a payment hold placed against an order." }, "ShippingFulfillment": { "type": "object", "properties": { "fulfillmentId": { "type": "string", "description": "The unique identifier of the fulfillment; for example, 9405509699937003457459. This eBay-generated value is created with a successful createShippingFulfillment call." }, "lineItems": { "type": "array", "description": "This array contains a list of one or more line items (and purchased quantity) to which the fulfillment applies.", "items": { "$ref": "#/components/schemas/LineItemReference" } }, "shipmentTrackingNumber": { "type": "string", "description": "The tracking number provided by the shipping carrier for the package shipped in this fulfillment. This field is returned if available." }, "shippedDate": { "type": "string", "description": "The date and time that the fulfillment package was shipped. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field should only be returned if the package has been shipped.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z" }, "shippingCarrierCode": { "type": "string", "description": "The eBay code identifying the shipping carrier for this fulfillment. This field is returned if available.

Note: The Trading API's ShippingCarrierCodeType enumeration type contains the most current list of eBay shipping carrier codes and the countries served by each carrier. See ShippingCarrierCodeType." } }, "description": "This type contains the complete details of an existing fulfillment for an order." }, "ShippingFulfillmentDetails": { "type": "object", "properties": { "lineItems": { "type": "array", "description": "This array contains a list of or more line items and the quantity that will be shipped in the same package.", "items": { "$ref": "#/components/schemas/LineItemReference" } }, "shippedDate": { "type": "string", "description": "This is the actual date and time that the fulfillment package was shipped. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. The seller should use the actual date/time that the package was shipped, but if this field is omitted, it will default to the current date/time.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2015-08-04T19:09:02.768Z

Default: The current date and time." }, "shippingCarrierCode": { "type": "string", "description": "The unique identifier of the shipping carrier being used to ship the line item(s). Technically, the shippingCarrierCode and trackingNumber fields are optional, but generally these fields will be provided if the shipping carrier and tracking number are known.

Note: Use the Trading API's GeteBayDetails call to retrieve the latest shipping carrier enumeration values. When making the GeteBayDetails call, include the DetailName field in the request payload and set its value to ShippingCarrierDetails. Each valid shipping carrier enumeration value is returned in a ShippingCarrierDetails.ShippingCarrier field in the response payload." }, "trackingNumber": { "type": "string", "description": "The tracking number provided by the shipping carrier for this fulfillment. The seller should be careful that this tracking number is accurate since the buyer will use this tracking number to track shipment, and eBay has no way to verify the accuracy of this number.

This field and the shippingCarrierCode field are mutually dependent. If you include one, you must also include the other.

Note: If you include trackingNumber (and shippingCarrierCode) in the request, the resulting fulfillment's ID (returned in the HTTP location response header) is the tracking number. If you do not include shipment tracking information, the resulting fulfillment ID will default to an arbitrary number such as 999.
Note: Only alphanumeric characters are supported for shipment tracking numbers. Spaces, hyphens, and all other special characters are not supported. Do not include a space in the tracking number even if a space appears in the tracking number on the shipping label." } }, "description": "This type contains the details for creating a fulfillment for an order." }, "ShippingFulfillmentPagedCollection": { "type": "object", "properties": { "fulfillments": { "type": "array", "description": "This array contains one or more fulfillments required for the order that was specified in method endpoint.", "items": { "$ref": "#/components/schemas/ShippingFulfillment" } }, "total": { "type": "integer", "description": "The total number of fulfillments in the specified order.

Note: If no fulfillments are found for the order, this field is returned with a value of 0.", "format": "int32" }, "warnings": { "type": "array", "description": "This array is only returned if one or more errors or warnings occur with the call request.", "items": { "$ref": "#/components/schemas/Error" } } }, "description": "This type contains the specifications for the entire collection of shipping fulfillments that are associated with the order specified by a getShippingFulfillments call. The fulfillments container returns an array of all the fulfillments in the collection." }, "ShippingStep": { "type": "object", "properties": { "shippingCarrierCode": { "type": "string", "description": "The unique identifier of the shipping carrier being used to ship the line item.

Note: The Trading API's GeteBayDetails call can be used to retrieve the latest shipping carrier and shipping service option enumeration values." }, "shippingServiceCode": { "type": "string", "description": "The unique identifier of the shipping service option being used to ship the line item.

Note: Use the Trading API's GeteBayDetails call to retrieve the latest shipping carrier and shipping service option enumeration values. When making the GeteBayDetails call, include the DetailName field in the request payload and set its value to ShippingServiceDetails. Each valid shipping service option (returned in ShippingServiceDetails.ShippingService field) and corresponding shipping carrier (returned in ShippingServiceDetails.ShippingCarrier field) is returned in response payload." }, "shipTo": { "description": "This container consists of shipping and contact information about the individual or organization to whom the fulfillment package will be shipped.
Note: When FulfillmentInstructionsType is FULFILLED_BY_EBAY, there will be no shipTo address displayed.
Note: For Digitally Delivered Goods (DDG), this address is the same as the Buyer's Registration Address.
Note: For a Global Shipping Program shipment, this is the address of the international shipping provider's domestic warehouse. The international shipping provider is responsible for delivery to the final destination address. For more information, see Addressing Shipments.", "$ref": "#/components/schemas/ExtendedContact" }, "shipToReferenceId": { "type": "string", "description": "This is the unique identifer of the Global Shipping Program (GSP) shipment. This field is only returned if the line item is being shipped via GSP (the value of the fulfillmentStartInstructions.ebaySupportedFulfillment field will be true. The international shipping provider uses the shipToReferenceId value as the primary reference number to retrieve the relevant details about the buyer, the order, and the fulfillment, so the shipment can be completed.

Sellers must include this value on the shipping label immediately above the street address of the international shipping provider.

Example: \"Reference #1234567890123456\"

Note: This value is the same as the ShipToAddress.ReferenceID value returned by the Trading API's GetOrders call." } }, "description": "This type contains shipping information for a fulfillment, including the shipping carrier, the shipping service option, the shipment destination, and the Global Shipping Program reference ID." }, "SimpleAmount": { "type": "object", "properties": { "currency": { "type": "string", "description": "A three-letter ISO 4217 code (such as USD for US site) that indicates the currency of the amount in the value field. Both the value and currency fields are always returned with the amount container. For implementation help, refer to eBay API documentation" }, "value": { "type": "string", "description": "The monetary amount of the payment dispute. Both the value and currency fields are always returned with the amount container." } }, "description": "This type defines the monetary value of the payment dispute, and the currency used." }, "Tax": { "type": "object", "properties": { "amount": { "description": "The monetary amount of the tax. The taxes array is always returned for each line item in the order, but this amount will only be returned when the line item is subject to any type of sales tax. ", "$ref": "#/components/schemas/Amount" }, "taxType": { "type": "string", "description": "Tax type. This field is only available when fieldGroups is set to TAX_BREAKDOWN. If the order has fees, a breakdown of the fees is also provided. For implementation help, refer to eBay API documentation" } }, "description": "This type contains information about any sales tax applied to a line item." }, "TaxAddress": { "type": "object", "properties": { "city": { "type": "string", "description": "The city name that can be used by sellers for tax purpose." }, "countryCode": { "type": "string", "description": "The country code that can be used by sellers for tax purpose, represented as a two-letter ISO 3166-1 alpha-2 country code. For example, US represents the United States, and DE represents Germany. For implementation help, refer to eBay API documentation" }, "postalCode": { "type": "string", "description": "The postal code that can be used by sellers for tax purpose. Usually referred to as Zip codes in the US." }, "stateOrProvince": { "type": "string", "description": "The state name that can be used by sellers for tax purpose." } }, "description": "This container consists of address information that can be used by sellers for tax purpose." }, "TaxIdentifier": { "type": "object", "properties": { "taxpayerId": { "type": "string", "description": "This value is the unique tax ID associated with the buyer. The type of tax identification is shown in the taxIdentifierType field." }, "taxIdentifierType": { "type": "string", "description": "This enumeration value indicates the type of tax identification being used for the buyer. The different tax types are defined in the TaxIdentifierTypeEnum type. For implementation help, refer to eBay API documentation" }, "issuingCountry": { "type": "string", "description": "This two-letter code indicates the country that issued the buyer's tax ID. The country that the two-letter code represents can be found in the CountryCodeEnum type, or in the ISO 3166 standard. For implementation help, refer to eBay API documentation" } }, "description": "This type is used by the taxIdentifier container that is returned in getOrder. The taxIdentifier container consists of taxpayer identification information for buyers from Italy, Spain, or Guatemala. It is currently only returned for orders occurring on the eBay Italy or eBay Spain marketplaces.

Note: Currently, the taxIdentifier container is only returned in getOrder and not in getOrders. So, if a seller wanted to view a buyer's tax information for a particular order returned in getOrders, that seller would need to use the orderId value for that particular order, and then run a getOrder call against that order ID. " }, "TrackingInfo": { "type": "object", "properties": { "shipmentTrackingNumber": { "type": "string", "description": "This string value represents the shipment tracking number of the package." }, "shippingCarrierCode": { "type": "string", "description": "This string value represents the shipping carrier used to ship the package." } }, "description": "This type is used for seller provided shipment tracking information." }, "UpdateEvidencePaymentDisputeRequest": { "type": "object", "properties": { "evidenceId": { "type": "string", "description": "The unique identifier of the evidence set that is being updated with new evidence files.

This ID is returned under the evidence array in the getPaymentDispute response." }, "evidenceType": { "type": "string", "description": "This field is used to indicate the type of evidence being provided through one or more evidence files. All evidence files (if more than one) should be associated with the evidence type passed in this field.

See the EvidenceTypeEnum type for the supported evidence types. For implementation help, refer to eBay API documentation" }, "files": { "type": "array", "description": "This array is used to specify one or more evidence files that will be added to the evidence set associated with a payment dispute. At least one evidence file must be specified in the files array.

The unique identifier of an evidence file is returned in the response payload of the uploadEvidence method.", "items": { "$ref": "#/components/schemas/FileEvidence" } }, "lineItems": { "type": "array", "description": "This required array identifies the order line item(s) for which the evidence file(s) will be applicable.

These values are returned under the evidenceRequests.lineItems array in the getPaymentDispute response.

Note: Both the itemId and lineItemID fields are needed to identify each order line item.", "items": { "$ref": "#/components/schemas/OrderLineItems" } } }, "description": "This type is used by the request payload of the updateEvidence method. The updateEvidence method is used to update an existing evidence set against a payment dispute with one or more evidence files." } }, "securitySchemes": { "api_auth": { "type": "oauth2", "description": "The security definitions for this API. Please check individual operations for applicable scopes.", "flows": { "authorizationCode": { "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "scopes": { "https://api.ebay.com/oauth/api_scope/sell.fulfillment": "View and manage your order fulfillments", "https://api.ebay.com/oauth/api_scope/sell.finances": "View and manage your payment and order information to display this information to you and allow you to initiate refunds using the third party application", "https://api.ebay.com/oauth/api_scope/sell.payment.dispute": "View and manage disputes and related details (including payment and order information).", "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly": "View your order fulfillments" } } } } } } }