api-specs/sell_fulfillment_v1_oas3.yaml
---
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://go.developer.ebay.com/api-license-agreement"
version: "v1.19.17"
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, <i>orderId</i>. This value was returned in the <b> getOrders</b>\
\ call's <b>orders.orderId</b> field when you searched for orders by creation\
\ date, modification date, or fulfillment status. Include the optional <b>fieldGroups</b>\
\ query parameter set to <code>TAX_BREAKDOWN</code> to return a breakdown\
\ of the taxes and fees. <br /><br /> The returned <b>Order</b> object contains\
\ information you can use to create and process fulfillments, including: <ul>\
\ <li>Information about the buyer and seller</li> <li>Information about the\
\ order's line items</li> <li> The plans for packaging, addressing and shipping\
\ the order</li> <li>The status of payment, packaging, addressing, and shipping\
\ the order</li> <li>A summary of monetary amounts specific to the order such\
\ as pricing, payments, and shipping costs</li> <li>A summary of applied taxes\
\ and fees, and optionally a breakdown of each </li></ul>"
operationId: "getOrder"
parameters:
- name: "fieldGroups"
in: "query"
description: "The response type associated with the order. The only presently\
\ supported value is <code>TAX_BREAKDOWN</code>. This type returns a breakdown\
\ of tax and fee values associated with the order."
required: false
schema:
type: "string"
- name: "orderId"
in: "path"
description: "The unique identifier of the order. Order ID values are shown\
\ in My eBay/Seller Hub, and are also returned by the <b>getOrders</b> method\
\ in the <b>orders.orderId</b> field."
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:
32800:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid field group: {fieldGroup}"
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"
404:
description: "Not Found"
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 call to search for and retrieve one or more orders based\
\ on their creation date, last modification date, or fulfillment status using\
\ the <b>filter</b> parameter. You can alternatively specify a list of orders\
\ using the <b>orderIds</b> parameter. Include the optional <b>fieldGroups</b>\
\ query parameter set to <code>TAX_BREAKDOWN</code> to return a breakdown\
\ of the taxes and fees. <br /><br /> The returned <b>Order</b> objects contain\
\ information you can use to create and process fulfillments, including: <ul>\
\ <li>Information about the buyer and seller</li> <li>Information about the\
\ order's line items</li> <li>The plans for packaging, addressing and shipping\
\ the order</li> <li>The status of payment, packaging, addressing, and shipping\
\ the order</li> <li>A summary of monetary amounts specific to the order such\
\ as pricing, payments, and shipping costs</li> <li>A summary of applied taxes\
\ and fees, and optionally a breakdown of each </li></ul> <br /><br /> <span\
\ class=\"tablenote\"><strong>Important:</strong> In this call, the <b>cancelStatus.cancelRequests</b>\
\ array is returned but is always empty. Use the <b>getOrder</b> call instead,\
\ which returns this array fully populated with information about any cancellation\
\ requests.</span>"
operationId: "getOrders"
parameters:
- name: "fieldGroups"
in: "query"
description: "The response type associated with the order. The only presently\
\ supported value is <code>TAX_BREAKDOWN</code>. This type returns a breakdown\
\ of tax and fee values associated with the order."
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. <br /><br /> <span class=\"tablenote\"\
><strong>Note:</strong> Currently, <b>filter</b> returns data from only\
\ the last 90 days. If the <b>orderIds</b> parameter is included in the\
\ request, the <b>filter</b> parameter will be ignored.</span> <br /><br\
\ /> The available criteria are as follows: <dl> <dt><code><b>creationdate</b></code></dt>\
\ <dd>The time period during which qualifying orders were created (the <b>orders.creationDate</b>\
\ 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: <ul> <li><code>creationdate:[2016-02-21T08:25:43.511Z..]</code>\
\ identifies orders created on or after the given timestamp.</li> <li><code>creationdate:[2016-02-21T08:25:43.511Z..2016-04-21T08:25:43.511Z]</code>\
\ identifies orders created between the given timestamps, inclusive.</li>\
\ </ul> </dd> <dt><code><b>lastmodifieddate</b></code></dt> <dd>The time\
\ period during which qualifying orders were last modified (the <b>orders.modifiedDate</b>\
\ 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: <ul> <li><code>lastmodifieddate:[2016-05-15T08:25:43.511Z..]</code>\
\ identifies orders modified on or after the given timestamp.</li> <li><code>lastmodifieddate:[2016-05-15T08:25:43.511Z..2016-05-31T08:25:43.511Z]</code>\
\ identifies orders modified between the given timestamps, inclusive.</li>\
\ </ul> <span class=\"tablenote\"><strong>Note:</strong> If <b>creationdate</b>\
\ and <b>lastmodifieddate</b> are both included, only <b>creationdate</b>\
\ is used.</span> <br /><br /></dd> <dt><code><b>orderfulfillmentstatus</b></code></dt>\
\ <dd>The degree to which qualifying orders have been shipped (the <b>orders.orderFulfillmentStatus</b>\
\ field). In the URI, this is expressed as one of the following value combinations:\
\ <ul> <li><code>orderfulfillmentstatus:{NOT_STARTED|IN_PROGRESS}</code>\
\ specifies orders for which no shipping fulfillments have been started,\
\ plus orders for which at least one shipping fulfillment has been started\
\ but not completed.</li> <li><code>orderfulfillmentstatus:{FULFILLED|IN_PROGRESS}</code>\
\ specifies orders for which all shipping fulfillments have been completed,\
\ plus orders for which at least one shipping fulfillment has been started\
\ but not completed.</li> </ul> <span class=\"tablenote\"><strong>Note:</strong>\
\ The values <code>NOT_STARTED</code>, <code>IN_PROGRESS</code>, and <code>FULFILLED</code>\
\ can be used in various combinations, but only the combinations shown here\
\ are currently supported.</span> </dd> </dl> Here is an example of a <b>getOrders</b>\
\ call using all of these filters: <br /><br /> <code>GET https://api.ebay.com/sell/v1/order?<br\
\ />filter=<b>creationdate</b>:%5B2016-03-21T08:25:43.511Z..2016-04-21T08:25:43.511Z%5D,<br\
\ /><b>lastmodifieddate</b>:%5B2016-05-15T08:25:43.511Z..%5D,<br /><b>orderfulfillmentstatus</b>:%7BNOT_STARTED%7CIN_PROGRESS%7D</code>\
\ <br /><br /> <span class=\"tablenote\"><strong>Note:</strong> This call\
\ requires that certain special characters in the URI query string be percent-encoded:\
\ <br /> <code>[</code> = <code>%5B</code> <code>]</code>\
\ = <code>%5D</code> <code>{</code>\
\ = <code>%7B</code> <code>|</code>\
\ = <code>%7C</code> <code>}</code>\
\ = <code>%7D</code> <br /> This query filter example uses these codes.</span>\
\ 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 <b>offset</b> parameter to control\
\ the pagination of the output. <br /><br />For example, if <b>offset</b>\
\ is set to <code>10</code> and <b>limit</b> is set to <code>10</code>,\
\ the call retrieves orders 11 thru 20 from the result set. <br /><br />\
\ If a limit is not set, the <b>limit</b> defaults to 50 and returns up\
\ to 50 orders. If a requested limit is more than 200, the call fails and\
\ returns an error.<br ><br> <span class=\"tablenote\"><strong>Note:</strong>\
\ This feature employs a zero-based list, where the first item in the list\
\ has an offset of <code>0</code>. If the <b>orderIds</b> parameter is included\
\ in the request, this parameter will be ignored.</span> <br /><br /> <b>Maximum:</b>\
\ <code>200</code> <br /> <b>Default:</b> <code>50</code>"
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. <p>Combine <b>offset</b>\
\ with the <b>limit</b> query parameter to control the items returned in\
\ the response. For example, if you supply an <b>offset</b> of <code>0</code>\
\ and a <b>limit</b> of <code>10</code>, the first page of the response\
\ contains the first 10 items from the complete list of items retrieved\
\ by the call. If <b>offset</b> is <code>10</code> and <b>limit</b> is <code>20</code>,\
\ the first page of the response contains items 11-30 from the complete\
\ result set.</p> <p><b>Default:</b> 0</p>"
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 <b>orderIds</b> query parameter, all other query parameters\
\ will be ignored."
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:
30800:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid filter value {fieldvalue} for filter {fieldname}"
32800:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid field group: {fieldGroup}"
30850:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Start and end dates can't be in the future"
30820:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Start date is missing"
30900:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Exceeded maximum number of order IDs (the current limit\
\ is <code>50</code>)"
30840:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Start date should be before end date"
31000:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid offset: {offsetvalue}"
30810:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid date format"
30700:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid filter name: {fieldname}"
31100:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid limit: {limitvalue}"
30830:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Start date must be within 90 days of end date and current\
\ date."
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: "<div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
\ data-mc-autonum=\"<b><span style="color: #dd1e31;" class="mcFormatColor">Important!\
\ </span></b>\"><span class=\"autonumber\"><span><b><span style=\"\
color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
\ 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 <b>issueRefund</b>. Please\
\ refer to <a href=\"/develop/guides/digital-signatures-for-apis \" target=\"\
_blank\">Digital Signatures for APIs</a> to learn more on the impacted APIs\
\ and the process to create signatures to be included in the HTTP payload.</p></div><br/>\
\ 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.<br/><br/>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 <a href=\"/api-docs/sell/fulfillment/resources/order/methods/getOrder\"\
\ target=\"_blank\">getOrder</a> call to check the status of the refund. \
\ The status of an order refund can be found in the <a href=\"/api-docs/sell/fulfillment/resources/order/methods/getOrder#response.paymentSummary.refunds.refundStatus\"\
\ target=\"_blank\">paymentSummary.refunds.refundStatus</a> field of the <a\
\ href=\"/api-docs/sell/fulfillment/resources/order/methods/getOrder\" target=\"\
_blank\">getOrder</a> response."
operationId: "issueRefund"
parameters:
- name: "order_id"
in: "path"
description: "The unique identifier of the order. Order IDs are returned in\
\ the <b>getOrders</b> method (and <b>GetOrders</b> call of Trading API).\
\ The <b>issueRefund</b> method supports the legacy API Order IDs and REST\
\ API order IDs."
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:
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."
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."
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."
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:
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."
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."
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, <b>orderId</b>.\
\ This value is returned in the <b>getOrders</b> call's <b>members.orderId</b>\
\ field when you search for orders by creation date or shipment status."
operationId: "getShippingFulfillments"
parameters:
- name: "orderId"
in: "path"
description: "The unique identifier of the order. Order ID values are shown\
\ in My eBay/Seller Hub, and are also returned by the <b>getOrders</b> method\
\ in the <b>orders.orderId</b> field."
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 <i>shipping fulfillment</i>. For each package, execute\
\ this call once to generate a shipping fulfillment associated with that package.\
\ <br /><br /> <span class=\"tablenote\"><strong>Note:</strong> 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.</span>\
\ <br /><br />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: "The unique identifier of the order. Order ID values are shown\
\ in My eBay/Seller Hub, and are also returned by the <b>getOrders</b> method\
\ in the <b>orders.orderId</b> field."
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 code:\
\ <br /><br /><code>{ENV}/sell/fulfillment/v1/order/{ORDERID}/shipping_fulfillment/{FULFILLMENTID}</code>\
\ <br /><br />The <code>ENV</code> string is the HTTPS path to the same\
\ eBay supported environment in which this call was issued. The <code>ORDERID</code>\
\ parameter is the unique identifier of the order addressed by this call;\
\ for example, <code>01-03955-36441</code>. The <code>FULFILLMENTID</code>\
\ parameter identifies the newly created fulfillment; for example, <code>9405509699937003457459</code>.\
\ Use this Get Fulfillment URI to retrieve the contents of the new fulfillment."
headers:
Location:
schema:
type: "string"
description: "A successful call returns the following location code:\
\ <br /><br /><code>{ENV}/sell/fulfillment/v1/order/{ORDERID}/shipping_fulfillment/{FULFILLMENTID}</code>\
\ <br /><br />The <code>ENV</code> string is the HTTPS path to the\
\ same eBay supported environment in which this call was issued.\
\ The <code>ORDERID</code> parameter is the unique identifier of\
\ the order addressed by this call; for example, <code>01-03955-36441</code>.\
\ The <code>FULFILLMENTID</code> parameter identifies the newly\
\ created fulfillment; for example, <code>9405509699937003457459</code>.\
\ Use this Get Fulfillment URI to retrieve the contents of the new\
\ fulfillment."
content:
application/json:
schema:
type: "object"
400:
description: "Bad Request"
x-response-codes:
errors:
32400:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Requested user is suspended"
32210:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Duplicate line item in the request"
32100:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid Order Id: {orderId}"
32500:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid shipped date"
34100:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Maximum tracking number for order is exceeded"
34500:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Please use PUT operation for updating shipping fulfillment"
32200:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid line item id: {lineItemId}"
32600:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid input data"
34200:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Line Items contain Global Shipping Program and non-Global\
\ Shipping Program orders"
32300:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid shipment tracking number or carrier"
34300:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Mark As Shipped for multiple Global Shipping Program\
\ line items is not supported"
500:
description: "Internal Server Error"
x-response-codes:
errors:
30500:
domain: "API_FULFILLMENT"
category: "APPLICATION"
description: "System error"
409:
description: "Conflict"
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, <b>fulfillmentId</b> (combined with the associated\
\ order's <b>orderId</b>). The <b>fulfillmentId</b> value was originally generated\
\ by the <b>createShippingFulfillment</b> call, and is returned by the <b>getShippingFulfillments</b>\
\ call in the <b>members.fulfillmentId</b> field."
operationId: "getShippingFulfillment"
parameters:
- name: "fulfillmentId"
in: "path"
description: "The unique identifier of the fulfillment. This eBay-generated\
\ value was created by the <b>Create Shipping Fulfillment</b> call, and\
\ returned by the <b>getShippingFulfillments</b> call in the <b>fulfillments.fulfillmentId</b>\
\ field; for example, <code>9405509699937003457459</code>."
required: true
schema:
type: "string"
- name: "orderId"
in: "path"
description: "The unique identifier of the order. Order ID values are shown\
\ in My eBay/Seller Hub, and are also returned by the <b>getOrders</b> method\
\ in the <b>orders.orderId</b> field."
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}"
500:
description: "Internal Server Error"
x-response-codes:
errors:
30500:
domain: "API_FULFILLMENT"
category: "APPLICATION"
description: "System error"
404:
description: "Not Found"
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.<br/><br/>Below is a summary of the information\
\ that is retrieved:<ul><li>Current status of payment dispute</li><li>Amount\
\ of the payment dispute</li><li>Reason the payment dispute was opened</li><li>Order\
\ and line items associated with the payment dispute</li><li>Seller response\
\ options if an action is currently required on the payment dispute</li><li>Details\
\ on the results of the payment dispute if it has been closed</li><li>Details\
\ on any evidence that was provided by the seller to fight the payment dispute</li></ul>"
operationId: "getPaymentDispute"
parameters:
- name: "payment_dispute_id"
in: "path"
description: "This is the unique identifier of the payment dispute. This path\
\ parameter must be passed in at the end of the call URI to identify the\
\ payment dispute to retrieve. This identifier is automatically created\
\ by eBay once the payment dispute comes into the eBay system. The unique\
\ identifier for payment disputes is returned in the <strong>paymentDisputeId</strong>\
\ field in the <strong>getPaymentDisputeSummaries</strong> response."
required: true
schema:
type: "string"
responses:
200:
description: "Success"
content:
application/json:
schema:
$ref: "#/components/schemas/PaymentDispute"
400:
description: "Bad 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."
404:
description: "Invalid Payment Dispute Id"
x-response-codes:
errors:
33001:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid Payment Dispute Id"
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:<ul><li><strong>payment_dispute_id</strong>:\
\ the identifier of the payment dispute. The identifier of each payment dispute\
\ is returned in the <strong>getPaymentDisputeSummaries</strong> response.</li><li><strong>evidence_id</strong>:\
\ the identifier of the evidential file set. The identifier of an evidential\
\ file set for a payment dispute is returned under the <strong>evidence</strong>\
\ array in the <strong>getPaymentDispute</strong> response.</li><li><strong>file_id</strong>:\
\ the identifier of an evidential file. This file must belong to the evidential\
\ file set identified through the <strong>evidence_id</strong> query parameter.\
\ The identifier of each evidential file is returned under the <strong>evidence.files</strong>\
\ array in the <strong>getPaymentDispute</strong> response.</li></ul><p>An\
\ actual binary file is returned if the call is successful. An error will\
\ occur if any of three identifiers are invalid.</p>"
operationId: "fetchEvidenceContent"
parameters:
- name: "payment_dispute_id"
in: "path"
description: "The identifier of the payment dispute. The identifier of each\
\ payment dispute is returned in the <strong>getPaymentDisputeSummaries</strong>\
\ response. This identifier is passed in as a path parameter at the end\
\ of the call URI."
required: true
schema:
type: "string"
- name: "evidence_id"
in: "query"
description: "The identifier of the evidential file set. The identifier of\
\ an evidential file set for a payment dispute is returned under the <strong>evidence</strong>\
\ array in the <strong>getPaymentDispute</strong> response.<br><br>Below\
\ is an example of the syntax to use for this query parameter:<br/><br/><code>evidence_id=12345678</code>"
required: true
schema:
type: "string"
- name: "file_id"
in: "query"
description: "The identifier of an evidential file. This file must belong\
\ to the evidential file set identified through the <strong>evidence_id</strong>\
\ query parameter. The identifier of each evidential file is returned under\
\ the <strong>evidence.files</strong> array in the <strong>getPaymentDispute</strong>\
\ response. <br><br>Below is an example of the syntax to use for this query\
\ parameter:<br/><br/><code>file_id=12345678</code> "
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"
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."
404:
description: "Invalid Payment Dispute Id"
x-response-codes:
errors:
33001:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid Payment Dispute Id"
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 is the unique identifier of the payment dispute. This path\
\ parameter must be passed in at the end of the call URI to identify the\
\ payment dispute for which the user wishes to see all activity. This identifier\
\ is automatically created by eBay once the payment dispute comes into the\
\ eBay system. The unique identifier for payment disputes is returned in\
\ the <strong>paymentDisputeId</strong> field in the <strong>getPaymentDisputeSummaries</strong>\
\ response.<br><br>This path parameter is required, and the actual identifier\
\ value is passed in right after the <strong>payment_dispute</strong> resource.\
\ See the Resource URI above."
required: true
schema:
type: "string"
responses:
200:
description: "Success"
content:
application/json:
schema:
$ref: "#/components/schemas/PaymentDisputeActivityHistory"
400:
description: "Bad 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."
404:
description: "Invalid Payment Dispute Id"
x-response-codes:
errors:
33001:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid Payment Dispute Id"
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:<ul><li>Dispute filed against a specific\
\ order (<b>order_id</b> parameter is used)</li><li>Dispute(s) filed by a\
\ specific buyer (<b>buyer_username</b> parameter is used)</li><li>Dispute(s)\
\ filed within a specific date range (<b>open_date_from</b> and/or <b>open_date_to</b>\
\ parameters are used)</li><li>Disputes in a specific state (<b>payment_dispute_status</b>\
\ parameter is used)</li></ul>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.<br/><br/>If none of the filters are used, all open\
\ and recently closed payment disputes are returned.<br/><br/>Pagination is\
\ also available. See the <b>limit</b> and <b>offset</b> 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."
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 seller. 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 <b>open_date_from</b> and/or <b>open_date_to</b> 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 <b>open_date_from</b>\
\ and/or <b>open_date_to</b> 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.<br><br>The\
\ <b>open_date_from</b> 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 <b>open_date_from</b>\
\ field is used, but a <b>open_date_to</b> field is not used, the <b>open_date_to</b>\
\ value will default to 90 days after the date specified in the <b>open_date_from</b>\
\ field, or to the present time if less than 90 days in the past.<br/><br/>The\
\ ISO-8601 format looks like this: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An\
\ example would be <code>2019-08-04T19:09:02.768Z</code>."
required: false
schema:
type: "string"
- name: "open_date_to"
in: "query"
description: "The <b>open_date_from</b> and/or <b>open_date_to</b> 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 <b>open_date_from</b>\
\ and/or <b>open_date_to</b> 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.<br><br>The\
\ <b>open_date_to</b> field sets the ending date of the date range, and\
\ can be set up to 90 days from the date set in the <b>open_date_from</b>\
\ field. <br/><br/>The ISO-8601 format looks like this: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>.\
\ An example would be <code>2019-08-04T19:09:02.768Z</code>."
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 a specific state. More than one value can be specified. If\
\ no <b>payment_dispute_status</b> filter is used, payment disputes in all\
\ states are returned in the response. See <strong>DisputeStateEnum</strong>\
\ 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.<br><br><b>Min</b>:\
\ 1; <b>Max</b>: 200; <b>Default</b>: 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 <b>offset</b>\
\ value to <code>0</code> (default value), the first payment dispute in\
\ the result set appears at the top of the response. <br/><br/>Combine <b>offset</b>\
\ with the <b>limit</b> parameter to control the payment disputes returned\
\ in the response. For example, if you supply an <b>offset</b> value of\
\ <code>0</code> and a <b>limit</b> value of <code>10</code>, the response\
\ will contain the first 10 payment disputes from the result set that matches\
\ the input criteria. If you supply an <b>offset</b> value of <code>10</code>\
\ and a <b>limit</b> value of <code>20</code>, the response will contain\
\ payment disputes 11-30 from the result set that matches the input criteria.<br><br><b>Min</b>:\
\ 0; <b>Max</b>: total number of payment disputes - 1; <b>Default</b>: 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 <strong>getPaymentDisputeSummaries</strong> method.<br/><br/><span\
\ class=\"tablenote\"><strong>Note:</strong> Before contesting a payment dispute,\
\ the seller must upload all supporting files using the <strong>addEvidence</strong>\
\ and <strong>updateEvidence</strong> methods. Once the seller has officially\
\ contested the dispute (using <strong>contestPaymentDispute</strong>), the\
\ <strong>addEvidence</strong> and <strong>updateEvidence</strong> methods\
\ can no longer be used. In the <strong>evidenceRequests</strong> array of\
\ the <strong>getPaymentDispute</strong> response, eBay prompts the seller\
\ with the type of supporting file(s) that will be needed to contest the payment\
\ dispute.</span><br><br>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.<br><br>The <strong>revision</strong> field in the request\
\ payload is required, and the <strong>returnAddress</strong> 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 is the unique identifier of the payment dispute. This path\
\ parameter must be passed into the call URI to identify the payment dispute\
\ for which the user plans to contest. This identifier is automatically\
\ created by eBay once the payment dispute comes into the eBay system. The\
\ unique identifier for payment disputes is returned in the <strong>paymentDisputeId</strong>\
\ field in the <strong>getPaymentDisputeSummaries</strong> response.<br><br>This\
\ path parameter is required, and the actual identifier value is passed\
\ in right after the <strong>payment_dispute</strong> resource. See the\
\ Resource URI above."
required: true
schema:
type: "string"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ContestPaymentDisputeRequest"
required: false
responses:
400:
description: "Bad Request"
x-response-codes:
errors:
33100:
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."
204:
description: "Success"
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"
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 <strong>getPaymentDisputeSummaries</strong>\
\ method.<br><br>The <strong>revision</strong> field in the request payload\
\ is required, and the <strong>returnAddress</strong> 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 is the unique identifier of the payment dispute. This path\
\ parameter must be passed into the call URI to identify the payment dispute\
\ for which the user plans to accept. This identifier is automatically created\
\ by eBay once the payment dispute comes into the eBay system. The unique\
\ identifier for payment disputes is returned in the <strong>paymentDisputeId</strong>\
\ field in the <strong>getPaymentDisputeSummaries</strong> response.<br><br>This\
\ path parameter is required, and the actual identifier value is passed\
\ in right after the <strong>payment_dispute</strong> resource. See the\
\ Resource URI above."
required: true
schema:
type: "string"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AcceptPaymentDisputeRequest"
required: false
responses:
400:
description: "Bad Request"
x-response-codes:
errors:
33100:
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."
204:
description: "Success"
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."
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 <strong>getPaymentDisputeSummaries</strong> method.<br><br><span\
\ class=\"tablenote\"><strong>Note:</strong> The <strong>uploadEvidenceFile</strong>\
\ only uploads an encrypted, binary image file (using <strong>multipart/form-data</strong>\
\ HTTP request header), and does not have a JSON-based request payload.<br><br>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.<br><br>The\
\ three image formats supported at this time are <strong>.JPEG</strong>, <strong>.JPG</strong>,\
\ and <strong>.PNG</strong>.</span><br><br>After the file is successfully\
\ uploaded, the seller will need to grab the <strong>fileId</strong> value\
\ in the response payload to add this file to a new evidence set using the\
\ <strong>addEvidence</strong> method, or to add this file to an existing\
\ evidence set using the <strong>updateEvidence</strong> method."
operationId: "uploadEvidenceFile"
parameters:
- name: "payment_dispute_id"
in: "path"
description: "This is the unique identifier of the payment dispute. This path\
\ parameter must be passed into the call URI to identify the payment dispute\
\ for which the user plans to upload an evidence file. This identifier is\
\ automatically created by eBay after the payment dispute comes into the\
\ eBay system. The unique identifier for payment disputes is returned in\
\ the <strong>paymentDisputeId</strong> field in the <strong>getPaymentDisputeSummaries</strong>\
\ response.<br><br>This path parameter is required, and the actual identifier\
\ value is passed in right after the <strong>payment_dispute</strong> resource.\
\ See the Resource URI above."
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:
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."
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."
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."
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:
33105:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "You reached the maximum number of files you can upload."
33004:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Upload file for evidence is not permitted for given\
\ payment dispute state."
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 <strong>getPaymentDisputeSummaries</strong>\
\ method.<br/><br/><span class=\"tablenote\"><strong>Note:</strong> All evidence\
\ files should be uploaded using <strong>addEvidence</strong> and <strong>updateEvidence</strong>\
\ before the seller decides to contest the payment dispute. Once the seller\
\ has officially contested the dispute (using <strong>contestPaymentDispute</strong>\
\ or through My eBay), the <strong>addEvidence</strong> and <strong>updateEvidence</strong>\
\ methods can no longer be used. In the <strong>evidenceRequests</strong>\
\ array of the <strong>getPaymentDispute</strong> response, eBay prompts the\
\ seller with the type of evidence file(s) that will be needed to contest\
\ the payment dispute.</span><br><br>The file(s) to add are identified through\
\ the <strong>files</strong> 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 <strong>evidenceId</strong> field of the <strong>addEvidence</strong>\
\ response payload upon a successful call.<br><br>The type of evidence being\
\ added should be specified in the <strong>evidenceType</strong> field. All\
\ files being added (if more than one) should correspond to this evidence\
\ type.<br><br>Upon a successful call, an <strong>evidenceId</strong> 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 <strong>fileId</strong> array.\
\ The <strong>evidenceId</strong> value will be needed if the seller wishes\
\ to add to the evidence set by using the <strong>updateEvidence</strong>\
\ method, or if they want to retrieve a specific evidence file within the\
\ evidence set by using the <strong>fetchEvidenceContent</strong> method."
operationId: "addEvidence"
parameters:
- name: "payment_dispute_id"
in: "path"
description: "This is the unique identifier of the payment dispute. This path\
\ parameter must be passed into the call URI to identify the payment dispute\
\ for which the user plans to add evidence for a contested payment dispute.\
\ This identifier is automatically created by eBay once the payment dispute\
\ comes into the eBay system. The unique identifier for payment disputes\
\ is returned in the <strong>paymentDisputeId</strong> field in the <strong>getPaymentDisputeSummaries</strong>\
\ response.<br><br>This path parameter is required, and the actual identifier\
\ value is passed in right after the <strong>payment_dispute</strong> resource.\
\ See the Resource URI above."
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:
33008:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid evidence type."
33104:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "The combined size of attached files should be 1.5MB\
\ or less."
33009:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "User did not echo back the evidence metadata correctly."
33007:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid line items."
33103:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Exceed allowed file count"
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."
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."
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 <strong>getPaymentDisputeSummaries</strong>\
\ method.<br/><br/><span class=\"tablenote\"><strong>Note:</strong> All evidence\
\ files should be uploaded using <strong>addEvidence</strong> and <strong>updateEvidence</strong>\
\ before the seller decides to contest the payment dispute. Once the seller\
\ has officially contested the dispute (using <strong>contestPaymentDispute</strong>\
\ or through My eBay), the <strong>addEvidence</strong> and <strong>updateEvidence</strong>\
\ methods can no longer be used. In the <strong>evidenceRequests</strong>\
\ array of the <strong>getPaymentDispute</strong> response, eBay prompts the\
\ seller with the type of evidence file(s) that will be needed to contest\
\ the payment dispute.</span><br><br>The unique identifier of the evidence\
\ set to update is specified through the <strong>evidenceId</strong> field,\
\ and the file(s) to add are identified through the <strong>files</strong>\
\ array in the request payload. The unique identifier for an evidence file\
\ is automatically generated and returned in the <strong>fileId</strong> field\
\ of the <strong>uploadEvidence</strong> response payload upon a successful\
\ call. Sellers must make sure to capture the <strong>fileId</strong> value\
\ for each evidence file that is uploaded with the <strong>uploadEvidence</strong>\
\ method.<br><br>The type of evidence being added should be specified in the\
\ <strong>evidenceType</strong> field. All files being added (if more than\
\ one) should correspond to this evidence type.<br><br>Upon a successful call,\
\ an http status code of <code>204 Success</code> 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 <strong>fetchEvidenceContent</strong>\
\ method, passing in the proper <strong>evidenceId</strong> and <strong>fileId</strong>\
\ values."
operationId: "updateEvidence"
parameters:
- name: "payment_dispute_id"
in: "path"
description: "This is the unique identifier of the payment dispute. This path\
\ parameter must be passed into the call URI to identify the payment dispute\
\ for which the user plans to update the evidence set for a contested payment\
\ dispute. This identifier is automatically created by eBay once the payment\
\ dispute comes into the eBay system. The unique identifier for payment\
\ disputes is returned in the <strong>paymentDisputeId</strong> field in\
\ the <strong>getPaymentDisputeSummaries</strong> response.<br><br>This\
\ path parameter is required, and the actual identifier value is passed\
\ in right after the <strong>payment_dispute</strong> resource. See the\
\ Resource URI above."
required: true
schema:
type: "string"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateEvidencePaymentDisputeRequest"
required: false
responses:
400:
description: "Bad Request"
x-response-codes:
errors:
33008:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid evidence type."
33104:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "The combined size of attached files should be 1.5MB\
\ or less."
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"
33007:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Invalid line items."
33103:
domain: "API_FULFILLMENT"
category: "REQUEST"
description: "Exceed allowed file count"
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."
204:
description: "Success"
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."
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 <strong>revision</strong>\
\ number for a payment dispute can be retrieved with the <strong>getPaymentDispute</strong>\
\ 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 <strong>acceptPaymentDispute</strong>\
\ 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 <strong>EvidenceTypeEnum</strong> type for the supported\
\ evidence types. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:EvidenceTypeEnum'>eBay\
\ API documentation</a>"
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 <strong>files</strong>\
\ array.<br><br> The unique identifier of an evidence file is returned\
\ in the response payload of the <strong>uploadEvidence</strong> 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. Both the <strong>itemId</strong>\
\ and <strong>lineItemID</strong> fields are needed to identify each order\
\ line item, and both of these values are returned under the <strong>evidenceRequests.lineItems</strong>\
\ array in the <strong>getPaymentDispute</strong> response."
items:
$ref: "#/components/schemas/OrderLineItems"
description: "This type is used by the request payload of the <strong>addEvidence</strong>\
\ method. The <strong>addEvidence</strong> 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 <strong>fileId</strong>\
\ array in the request payload. The <strong>evidenceId</strong> value\
\ will be needed if the seller wishes to add to the evidence set by using\
\ the <strong>updateEvidence</strong> method, or if they want to retrieve\
\ a specific evidence file within the evidence set by using the <strong>fetchEvidenceContent</strong>\
\ method."
description: "This type is used by the response payload of the <strong>addEvidence</strong>\
\ 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."
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."
city:
type: "string"
description: "The city of the shipping destination."
country:
type: "string"
description: "The country of the shipping destination, represented as a\
\ two-letter ISO 3166-1 alpha-2 country code. For example, <code>US</code>\
\ represents the United States, and <code>DE</code> represents Germany.\
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/ba:CountryCodeEnum'>eBay\
\ API documentation</a>"
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 <b>convertedFromValue</b> 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 <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/ba:CurrencyCodeEnum'>eBay\
\ API documentation</a>"
convertedFromValue:
type: "string"
description: "The monetary amount before any conversion is performed, in\
\ the currency specified by the <b>convertedFromCurrency</b> field. This\
\ value is required or returned only if currency conversion/localization\
\ is required. The <b>value</b> field contains the converted amount of\
\ this value, in the currency specified by the <b>currency</b> field."
currency:
type: "string"
description: "A three-letter ISO 4217 code that indicates the currency of\
\ the amount in the <b>value</b> field. If currency conversion/localization\
\ is required, this is the post-conversion currency of the amount in the\
\ <b>value</b> field.<br /><br /><b>Default:</b> The default currency\
\ of the eBay marketplace that hosts the listing. For implementation help,\
\ refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/ba:CurrencyCodeEnum'>eBay\
\ API documentation</a>"
value:
type: "string"
description: "The monetary amount, in the currency specified by the <b>currency</b>\
\ field. If currency conversion/localization is required, this value is\
\ the converted amount, and the <b>convertedFromValue</b> field contains\
\ the amount in the original currency. <br><br><i>Required in</i> the\
\ <b>amount</b> 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.<br/><br/>\
\ 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 <b>SetPromotionalSale</b>\
\ call or the Marketing API's <b>createItemPromotion</b> method."
description: "This type contains information about a sales promotion that is\
\ applied to a line item."
Buyer:
type: "object"
properties:
taxAddress:
description: "This container consists of address information that can be\
\ used by sellers for tax purpose.<br/><br/><span class=\"tablenote\"\
><strong>Note:</strong> When using the eBay vault program, if an item\
\ is shipped to a vault, the tax address will be the vault address.</span>"
$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.<br\
\ /><br /><span class=\"tablenote\"><strong>Note:</strong> Currently,\
\ the <strong>taxIdentifier</strong> container is only returned in <strong>getOrder</strong>\
\ and not in <strong>getOrders</strong>. So, if a seller wanted to view\
\ a buyer's tax information for a particular order returned in <strong>getOrders</strong>,\
\ that seller would need to use the <strong>orderId</strong> value for\
\ that particular order, and then run a <strong>getOrder</strong> call\
\ against that order ID. </span>"
$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.<br\
\ /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>"
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 <b>cancelInitiator</b> 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.<br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>"
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 <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:CancelRequestStateEnum'>eBay\
\ API documentation</a>"
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. <br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>"
cancelRequests:
type: "array"
description: "This array contains details of one or more buyer requests\
\ to cancel the order. <br /><br /><b>For the getOrders call:</b> This\
\ array is returned but is always empty.<br /><b>For the getOrder call:</b>\
\ This array is returned fully populated with information about any cancellation\
\ requests."
items:
$ref: "#/components/schemas/CancelRequest"
cancelState:
type: "string"
description: "The state of the order with regard to cancellation. This field\
\ is always returned, and if there are no cancellation requests, a value\
\ of <code>NONE_REQUESTED</code> is returned. For implementation help,\
\ refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:CancelStateEnum'>eBay\
\ API documentation</a>"
description: "This type contains information about any requests that have been\
\ made to cancel an order."
ContestPaymentDisputeRequest:
type: "object"
properties:
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 <strong>fullName</strong> and <strong>primaryPhone</strong>."
$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 <strong>revision</strong>\
\ number for a payment dispute can be retrieved with the <strong>getPaymentDispute</strong>\
\ 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 <strong>contestPaymentDispute</strong>\
\ method."
DeliveryCost:
type: "object"
properties:
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 <b>value</b> field will show <code>0.0</code> (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.<br /><br />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.<br /><br /><span\
\ class=\"tablenote\"><strong>Note:</strong> The value returned for this\
\ field will always be <code>0.0</code> for line items sold in the UK\
\ marketplace.</span>"
$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 <a href=\"https://www.iso.org/iso-4217-currency-codes.html\"\
\ target=\"_blank\">ISO 4217</a> code representing the currency of the\
\ amount in the <b> convertedFromValue</b> field. This value is the pre-conversion\
\ currency.<br><br>This field is only returned if/when currency conversion\
\ was applied by eBay. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/ba:CurrencyCodeEnum'>eBay\
\ API documentation</a>"
convertedFromValue:
type: "string"
description: "The monetary amount before any conversion is performed, in\
\ the currency specified by the <b> convertedFromCurrency</b> field. This\
\ value is the pre-conversion amount. The <b> value</b> field contains\
\ the converted amount of this value, in the currency specified by the\
\ <b> currency</b> field.<br><br>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 <b>value</b> field. This field is always returned\
\ with any container using <b>Amount</b> type. <br /><br /><b>Default</b>:\
\ The currency of the authenticated user's country. For implementation\
\ help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/ba:CurrencyCodeEnum'>eBay\
\ API documentation</a>"
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 <b>value</b>\
\ field from the dollar value in the <b>convertedFromValue</b> field.<br><br>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 <b>currency</b>\
\ field. This field is always returned with any container using <b>Amount</b>\
\ 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 <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:EvidenceTypeEnum'>eBay\
\ API documentation</a>"
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. <br/><br/>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: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>.\
\ An example would be <code>2019-08-04T19:09:02.768Z</code>."
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. <br/><br/>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: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example\
\ would be <code>2019-08-04T19:09:02.768Z</code>."
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. <br/><br/>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: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example would be <code>2019-08-04T19:09:02.768Z</code>."
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 if the seller has provided shipment tracking information\
\ as evidence to support <code>PROOF_OF_DELIVERY</code>."
items:
$ref: "#/components/schemas/TrackingInfo"
description: "This type is used by the <strong>evidence</strong> array that\
\ is returned in the <strong>getPaymentDispute</strong> 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 <strong>getPaymentDisputeSummaries</strong>\
\ 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 <strong>limit</strong>\
\ value can be passed in as a query parameter in the request, or if it\
\ is not used, it defaults to <code>200</code>. If the value in the <strong>total</strong>\
\ field exceeds this <strong>limit</strong> value, there are multiple\
\ pages in the current result set.<br><br><b>Min</b>: 1; <b>Max</b>: 200;\
\ <b>Default</b>: 200"
format: "int32"
next:
type: "string"
description: "The <strong>getPaymentDisputeSummaries</strong> 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:<br/><br/><code>path/payment_dispute_summary?limit=10&offset=10</code><br/><br/>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 <strong>offset</strong> value can be passed in as a query parameter\
\ in the request, or if it is not used, it defaults to <code>0</code>\
\ 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 <strong>getPaymentDisputeSummaries</strong> 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:<br/><br/><code>path/payment_dispute_summary?limit=10&offset=0</code><br/><br/>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 <strong>limit</strong> 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 <code>0</code>."
format: "int32"
description: "This type defines the base response payload of the <strong>getPaymentDisputeSummaries</strong>\
\ method. Each payment dispute that matches the input criteria is returned\
\ under the <strong>paymentDisputeSummaries</strong> array."
EbayCollectAndRemitTax:
type: "object"
properties:
amount:
description: "The monetary amount of the 'Collect and Remit' tax. This currently\
\ includes:<br/><ul><li>US state-mandated sales tax</li><li>Federal and\
\ Provincial Sales Tax in Canada</li><li>'Goods and Services' tax in Canada,\
\ Australia, and New Zealand</li><li>VAT collected for the UK and EU countries</li></ul><br\
\ /><br /><span class=\"tablenote\"><strong>Note:</strong> If the corresponding\
\ <strong>taxType</strong> is <code>STATE_SALES_TAX</code>, <code>PROVINCE_SALES_TAX</code>,\
\ <code>GST</code>, or <code>VAT</code>, and the <strong>lineItems.taxes</strong>\
\ 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 <strong>lineItems.total</strong>, <strong>paymentSummary.payments.amount</strong>,\
\ <strong>paymentSummary.totalDueSeller</strong>, and <strong>pricingSummary.total</strong>\
\ fields.</span>"
$ref: "#/components/schemas/Amount"
ebayReference:
description: "This container field describes the line-item level VAT tax\
\ details. <p><span class=\"tablenote\"><b>Note:</b> On January 31, 2022,\
\ the <strong>orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.addressLine2</strong>\
\ will stop being used to return VAT information, so developers should\
\ make sure they integrate with the new fields before that time. </span></p>"
$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 <strong>TaxTypeEnum</strong>\
\ type definition for more information about each tax or fee type. For\
\ implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:TaxTypeEnum'>eBay\
\ API documentation</a>"
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\
\ <code>NET</code>.<br /><br /><span class=\"tablenote\"><strong>Note:</strong>\
\ Although the <strong>collectionMethod</strong> field is returned for\
\ all orders subject to 'Collect and Remit' tax, the <strong>collectionMethod</strong>\
\ field and the <strong>CollectionMethodEnum</strong> 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.</span> For implementation\
\ help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:CollectionMethodEnum'>eBay\
\ API documentation</a>"
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.<br/><br/>'Collect\
\ and Remit' tax includes:<ul><li>US state-mandated sales tax</li><li>Federal\
\ and Provincial Sales Tax in Canada</li><li>'Goods and Services' tax in Canada,\
\ Australia, and New Zealand</li><li>VAT collected for the UK and EU countries</li></ul>"
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"
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. <br /><br />Valid value:\
\ <code>EBAY</code>"
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.<br /><br\
\ />Valid value: <code>EBAY</code>"
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 <code>EBAY</code>,\
\ 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:<ul><li><code>ABN</code>: if this string is returned,\
\ the ID in the <strong>value</strong> field is an Australia tax ID</li><li><code>DDG</code>:\
\ if this string is returned, it indicates that tax has been collected\
\ and remitted for Digitally Delivered Goods (DDG)</li><li><code>IOSS</code>:\
\ if this string is returned, the ID in the <strong>value</strong> field\
\ is an eBay EU or UK IOSS number</li><li><code>IRD</code>: if this string\
\ is returned, the ID in the <strong>value</strong> field is an eBay New\
\ Zealand tax ID</li><li><code>OSS</code>: if this string is returned,\
\ the ID in the <strong>value</strong> field is an eBay Germany VAT ID</li><li><code>VOEC</code>:\
\ if this string is returned, the ID in the <strong>value</strong> field\
\ is an eBay Norway tax ID</li></ul>"
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 <strong>name</strong> field\
\ indicates the VAT tax type, which will vary by country/region: <ul><li><strong>ABN</strong>:\
\ <em>eBay AU tax ID</em></li><li><strong>IOSS</strong>: <em>eBay EU IOSS\
\ number</em> / <em>eBay UK IOSS number</em></li><li><strong>IRD</strong>:\
\ <em>eBay NZ tax ID</em></li><li><strong>OSS</strong>: <em>eBay DE VAT\
\ ID</em></li><li><strong>VOEC</strong>: <em>eBay NO number</em></li></ul>"
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. <p> <span class=\"tablenote\"><b>Note:</b> On January 31,\
\ 2022, the <strong>orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.addressLine2</strong>\
\ will stop being used to return VAT information, so developers should make\
\ sure they integrate with the new fields before that time.</span></p>"
EbayVaultProgram:
type: "object"
properties:
fulfillmentType:
type: "string"
description: "This field specifies how an eBay vault order will be fulfilled.\
\ Supported options are:<ul><li><b>Seller to Vault</b>: the order will\
\ be shipped by the seller to an authenticator.</li><li><b>Vault to Vault</b>:\
\ the order will be shipped from an eBay vault to the buyer's vault.</li><li><b>Vault\
\ to Buyer</b>: the order will be shipped from an eBay vault to the buyer's\
\ shipping address.</li></ul> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:EbayVaultFulfillmentTypeEnum'>eBay\
\ API documentation</a>"
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, <code>sell</code> 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 <b>message</b> field. <br /><br\
\ /><b>Maximum length:</b> 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.\
\ <br /><br /><b>Maximum length:</b> 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,\
\ <code>fulfillment</code> is a subdomain in the <code>sell</code> 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 <strong>name</strong> 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 <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:EvidenceTypeEnum'>eBay\
\ API documentation</a>"
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. <br/><br/>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: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example\
\ would be <code>2019-08-04T19:09:02.768Z</code>."
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. <br/><br/>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: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example would be <code>2019-08-04T19:09:02.768Z</code>."
description: "This type is used by the <strong>evidenceRequests</strong> array\
\ that is returned in the <strong>getPaymentDispute</strong> 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. <br /><br /> <span\
\ class=\"tablenote\"> <strong>Note:</strong> If returned, this field\
\ contains the email address of the buyer, even for Global Shipping Program\
\ shipments.</span>"
fullName:
type: "string"
description: "The full name of the buyer or eBay shipping partner."
primaryPhone:
description: "The primary telephone number of the buyer or eBay shipping\
\ partner."
$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: "If an <strong>uploadEvidenceFile</strong> call is successful,\
\ a unique identifier of this evidence file will be returned in the <strong>uploadEvidenceFile</strong>\
\ response payload. This unique <strong>fileId</strong> value is then\
\ used to either add this evidence file to a new evidence set using the\
\ <strong>addEvidence</strong> method, or to add this file to an existing\
\ evidence set using the <strong>updateEvidence</strong> method.<br><br>Note\
\ that if an evidence set already exists for a payment dispute, the <strong>getPaymentDispute</strong>\
\ method will return both the <strong>evidenceId</strong> (unique identifier\
\ of evidence set) value, and the <strong>fileId</strong> (unique identifier\
\ of a file within that evidence set) value(s)."
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. <br/><br/>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: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>.\
\ An example would be <code>2019-08-04T19:09:02.768Z</code>."
description: "This type is used by the <strong>files</strong> array, which shows\
\ the name, ID, file type, and upload date for each provided evidential file."
FulfillmentStartInstruction:
type: "object"
properties:
ebaySupportedFulfillment:
type: "boolean"
description: "This field is only returned if its value is <code>true</code>\
\ and indicates that the fulfillment will be shipped via eBay's Global\
\ Shipping Program, eBay International Shipping, or the Authenticity Guarantee\
\ service program. <br /><br />For more information, see the <a href=\"\
https://www.ebay.com/help/selling/shipping-items/setting-shipping-options/global-shipping-program?id=4646\
\ \" target=\"_blank\">Global Shipping Program</a> help topic."
finalDestinationAddress:
description: "This container is only returned if the value of <b>ebaySupportedFulfillment</b>\
\ field is <code>true</code>. <br /><br />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.<br /><br />For more information, see <a href=\"https://developer.ebay.com/devzone/guides/features-guide/default.html#Development/Shipping-APIWork.html#AddressingaGlobalShippingProgramShipment\
\ \" target=\"_blank\">Addressing a Global Shipping Program Shipment</a>.<p>\
\ <span class=\"tablenote\"><strong>Note:</strong> 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.</span></p>"
$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 <code>SHIP_TO</code>\
\ if the <b>ebaySupportedFulfillment</b> field is returned with a value\
\ of <code>true</code>. See the <strong>FulfillmentInstructionsType</strong>\
\ definition for more information about different fulfillment types. For\
\ implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:FulfillmentInstructionsType'>eBay\
\ API documentation</a>"
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 <b>fulfillmentInstructionsType</b> field is <code>DIGITAL</code>\
\ or <code>PREPARE_FOR_PICKUP</code>. <br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>"
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 <b>fulfillmentInstructionsType</b> field is <code>DIGITAL</code>\
\ or <code>PREPARE_FOR_PICKUP</code>. <br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>"
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 <b>fulfillmentInstructionsType</b> field is <code>DIGITAL</code>,\
\ or for In-Store Pickup orders. <br/><br/> 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."
recipientEmail:
type: "string"
description: "The email address of the gift recipient. The seller will send\
\ the digital gift card to this email address."
senderName:
type: "string"
description: "The name of the buyer, which will appear on the email that\
\ is sent to the gift recipient."
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."
InfoFromBuyer:
type: "object"
properties:
note:
type: "string"
description: "This field shows any note that was left by the buyer for in\
\ regards 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\
\ <b>ReasonForRefundEnum</b> type must be used.<br/><br/>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.<br/><br/><span class=\"\
tablenote\"><strong>Note:</strong> 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 <b>issueRefund</b> calls, one for each refund reason.\
\ </span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:ReasonForRefundEnum'>eBay\
\ API documentation</a>"
comment:
type: "string"
description: "This free-text field allows the seller to clarify why the\
\ refund is being issued to the buyer.<br/><br/><b>Max Length</b>: 100"
refundItems:
type: "array"
description: "The <b>refundItems</b> 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 <b>orderLevelRefundAmount</b>\
\ 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\
\ <b>refundItems</b> array instead."
$ref: "#/components/schemas/SimpleAmount"
description: "The base type used by the request payload of the <b>issueRefund</b>\
\ method."
ItemLocation:
type: "object"
properties:
countryCode:
type: "string"
description: "The two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
\ \" title=\"https://www.iso.org \" target=\"_blank\">ISO 3166</a> code\
\ representing the country of the address. For implementation help, refer\
\ to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/ba:CountryCodeEnum'>eBay\
\ API documentation</a>"
location:
type: "string"
description: "Indicates the geographical location of the item (along with\
\ the value in the <strong>countryCode</strong> field). 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 in legacy/Trading API format.\
\ <br/><br/><span class=\"tablenote\"><strong>Note:</strong> Both <b>legacyItemId</b>\
\ and <b>legacyTransactionId</b> are needed to identify an order line\
\ item. </span>"
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. <br/><br/><span\
\ class=\"tablenote\"><strong>Note:</strong> Both <b>legacyItemId</b>\
\ and <b>legacyTransactionId</b> are needed to identify an order line\
\ item. </span>"
description: "Type defining the <b>legacyReference</b> 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"
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.<br/><br/>'Collect\
\ and Remit' tax includes:<ul><li>US state-mandated sales tax</li><li>Federal\
\ and Provincial Sales Tax in Canada</li><li>'Goods and Services' tax\
\ in Canada, Australia, and New Zealand</li><li>VAT collected for the\
\ UK and EU countries</li></ul>The amount of this tax is shown in the\
\ <strong>amount</strong> field, and the type of tax is shown in the <strong>taxType</strong>\
\ field.<br/><br/>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. <br /><br /><span class=\"tablenote\"\
><strong>Note:</strong> Currently, this container is returned only if\
\ eBay is directly charging the buyer for eBay shipping.</span>"
$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."
$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 <strong>listingId</strong> 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 <b>quantity</b>\
\ 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 <i>eBay Guaranteed Delivery</i> 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 <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:LineItemFulfillmentStatusEnum'>eBay\
\ API documentation</a>"
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."
listingMarketplaceId:
type: "string"
description: "The unique identifier of the eBay marketplace where the line\
\ item was listed. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/ba:MarketplaceIdEnum'>eBay\
\ API documentation</a>"
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 <strong>listingMarketplaceId</strong> and\
\ the <strong>purchaseMarketplaceId</strong> identifier are the same,\
\ but there are occasions when an item will surface on multiple eBay marketplaces.\
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/ba:MarketplaceIdEnum'>eBay\
\ API documentation</a>"
quantity:
type: "integer"
description: "The number of units of the line item in the order. These are\
\ represented as a group by a single <b>lineItemId</b>."
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 <code>AUCTION</code> and <code>FIXED_PRICE</code>. For implementation\
\ help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:SoldFormatEnum'>eBay\
\ API documentation</a>"
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."
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.<br /><br /><span class=\"tablenote\"\
><strong>Note:</strong> 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 <strong>total</strong> value only when the <strong>fieldGroups</strong>\
\ query parameter is set to <code>TAX_BREAKDOWN</code>. If the <strong>fieldGroups</strong>\
\ query parameter is not set to <code>TAX_BREAKDOWN</code>, 'Collect and\
\ Remit' will not be added into this <strong>total</strong> value.<br><br>To\
\ determine if 'Collect and Remit' taxes were added into this <strong>total</strong>\
\ value, the user can check for the corresponding <strong>lineItems.ebayCollectAndRemitTaxes</strong>\
\ and the <strong>lineItems.taxes</strong> containers in the response.\
\ If both of these containers appear for one or more line items in the\
\ response with the following <strong>taxType</strong> values, the 'Collect\
\ and Remit' tax amount that the buyer paid is in this amount:<ul><li><code>STATE_SALES_TAX</code>:\
\ US state-mandated sales tax</li><li><code>PROVINCE_SALES_TAX</code>:\
\ Provincial Sales Tax in Canada</li><li><code>GST</code>: 'Goods and\
\ Services' tax in Canada, Australia, and New Zealand</li><li><code>VAT</code>:\
\ VAT collected for UK and EU countries</li></ul></span>"
$ref: "#/components/schemas/Amount"
description: "This type contains the details of each line item in an order."
LineItemFulfillmentInstructions:
type: "object"
properties:
guaranteedDelivery:
type: "boolean"
description: "This field is returned as <code>true</code> if the order line\
\ item is qualified for eBay Guaranteed Delivery, or <code>false</code>\
\ if it is not eligible. Only domestic shipments are available for eBay\
\ Guaranteed Delivery. At this time, eBay Guaranteed Delivery is only\
\ available to a select number of sellers on the US and Australia sites,\
\ but this feature will be enabled on more eBay sites in 2019.<br/><br/>\
\ There are two different eBay Guaranteed Delivery options - 'Handling\
\ time' option and 'Door-to-Door' option. With both options, the seller\
\ is commiting to getting the order delivered to the buyer within three\
\ business days after purchase. <br/><br/> With the 'Handling time' option,\
\ the seller's stated handling time for a listing must be 'same-day' or\
\ '1-day', and at least one of the available shipping service options\
\ should have a shipping time that guarantees that the buyer receives\
\ the order on time. With this option, eBay will set the 'ship-by date'\
\ and expected delivery window for the seller, and the seller should just\
\ make sure they physically ship the order by the <strong>shipToDate</strong>.<br/><br/>\
\ With the 'Door-to-door' option, the seller must create regional shipping\
\ rate tables (with shipping costs and delivery times based on destination\
\ regions), and then apply these regional shipping rates/delivery times\
\ to the listing. <br/><br/> If a 'Door-to-door' order does not arrive\
\ on time, the seller must refund the buyer the full shipping cost (if\
\ any), and the buyer also has the option of returning the item for a\
\ full refund, and the seller will also have to pay the return shipping\
\ cost. With 'Handling time' option, as long as the seller meets the stated\
\ handling time, and ships using the correct shipping service option,\
\ eBay will refund the buyer the shipping cost and pay for return shipping\
\ label (if buyer wants to return item) if the order arrives after the\
\ expected delivery time. <br/><br/> For more information on the details\
\ and requirements of eBay Guaranteed Delivery, see the <a href=\"https://www.ebay.com/help/selling/shipping-items/offering-ebay-guaranteed-delivery?id=4645\
\ \" target=\"_blank\">Offering eBay Guaranteed Delivery</a> help topic.<br/><br/>\
\ This field will always be returned regardless of whether the listing\
\ site offers eBay Guaranteed Delivery or if the seller is opted in to\
\ the feature."
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. If\
\ the listing is eligible for eBay Guaranteed Delivery (value of <b>guaranteedDelivery</b>\
\ field is <code>true</code>, 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. <br\
\ /><br /><span class=\"tablenote\"><strong>Note:</strong> This timestamp\
\ is in ISO 8601 format, which uses the 24-hour Universal Coordinated\
\ Time (UTC) clock. <br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code></span>"
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.<br\
\ /><br /><span class=\"tablenote\"><strong>Note:</strong> This timestamp\
\ is in ISO 8601 format, which uses the 24-hour Universal Coordinated\
\ Time (UTC) clock. <br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code></span>"
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. If the listing is eligible for eBay Guaranteed Delivery (value\
\ of <b>guaranteedDelivery</b> field is <code>true</code>, 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. <br /><br /><span\
\ class=\"tablenote\"><strong>Note:</strong> This timestamp is in ISO\
\ 8601 format, which uses the 24-hour Universal Coordinated Time (UTC)\
\ clock. <br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code></span>"
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 <i>eBay Guaranteed Delivery</i> as well as for\
\ non-guaranteed delivery."
LineItemProperties:
type: "object"
properties:
buyerProtection:
type: "boolean"
description: "A value of <code>true</code> indicates that the line item\
\ is covered by eBay's Buyer Protection program."
fromBestOffer:
type: "boolean"
description: "This field is only returned if <code>true</code> 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 <code>true</code> 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. The line item ID is created\
\ as soon as there is a commitment to buy from the seller."
quantity:
type: "integer"
description: "This field is reserved for internal or future use."
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.<br/><br/><span\
\ class=\"tablenote\"><b>Note:</b> The refund amount shown is the seller's\
\ <i><b>net amount</b></i> 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.</span>"
$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. <br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>"
refundId:
type: "string"
description: "Unique identifier of a refund that was initiated for an order's\
\ line item through the <b>issueRefund</b> method. If the <b>issueRefund</b>\
\ method was used to issue a refund at the order level, this identifier\
\ is returned at the order level instead (<b>paymentSummary.refunds.refundId</b>\
\ field).<br/><br/> A <b>refundId</b> value is returned in the response\
\ of the <b>issueRefund</b> method, and this same value will be returned\
\ in the <b>getOrder</b> and <b>getOrders</b> 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."
MonetaryTransaction:
type: "object"
properties:
date:
type: "string"
description: "This timestamp indicates when the monetary transaction occurred.\
\ A date is returned for all monetary transactions.<br><br> The following\
\ format is used: <code>YYYY-MM-DDTHH:MM:SS.SSSZ</code>. For example,\
\ <code>2015-08-04T19:09:02.768Z</code>."
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 <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:MonetaryTransactionTypeEnum'>eBay\
\ API documentation</a>"
reason:
type: "string"
description: "This enumeration value indicates the reason for the monetary\
\ transaction. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:MonetaryTransactionReasonEnum'>eBay\
\ API documentation</a>"
amount:
description: "The amount involved in the monetary transaction. For active\
\ cross-border trade orders, the currency conversion and <b>exchangeRate</b>\
\ 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."
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 <strong>cancelState</strong>\
\ field is returned with a value of <code>NONE_REQUESTED</code>, and an\
\ empty <strong>cancelRequests</strong> 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. <br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>"
ebayCollectAndRemitTax:
type: "boolean"
description: "This field is only returned if <code>true</code>, 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 <strong>ebayCollectAndRemitTaxes</strong>\
\ 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 <strong>getShippingFulfillment</strong>\
\ 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.<br /><br /><span class=\"tablenote\"><strong>Note:</strong>\
\ 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.</span>"
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. <br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>"
legacyOrderId:
type: "string"
description: "The unique identifier of the order in legacy format, as traditionally\
\ used by the Trading API (and other legacy APIs). Both the <b>orderId</b>\
\ field and this field are always returned."
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 <strong>OrderFulfillmentStatus</strong> type definition for\
\ more information about each possible fulfillment state. For implementation\
\ help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:OrderFulfillmentStatus'>eBay\
\ API documentation</a>"
orderId:
type: "string"
description: "The unique identifier of the order. Both the <b>legacyOrderId</b>\
\ field (traditionally used by Trading and other legacy APIS) and this\
\ field are 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 <strong>OrderPaymentStatusEnum</strong>\
\ type definition for more information about each possible payment/refund\
\ state. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:OrderPaymentStatusEnum'>eBay\
\ API documentation</a>"
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 <code>fulfillmentStartInstructions.shippingStep.shipTo</code>\
\ 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 <strong>salesRecordReference</strong>\
\ number is only generated and returned at the order level, and not at\
\ the order line item level.<br><br> 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. The\
\ <strong>lineItemId</strong> value is created once the buyer actually\
\ purchases the item, or if there is a commitment to buy (such as an auction\
\ that is won by the buyer, an accepted Best Offer, or other situation\
\ that does not require immediate payment from the buyer)."
description: "This type is used by the <strong>lineItems</strong> 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.<br/><br/><span class=\"tablenote\"\
><b>Note:</b> The refund amount shown is the seller's <i><b>net amount</b></i>\
\ 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.</span>"
$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. <br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>"
refundId:
type: "string"
description: "Unique identifier of a refund that was initiated for an order\
\ through the <b>issueRefund</b> method. If the <b>issueRefund</b> 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 (<b>lineItems.refunds.refundId</b>\
\ field).<br/><br/> A <b>refundId</b> value is returned in the response\
\ of the <b>issueRefund</b> method, and this same value will be returned\
\ in the <b>getOrders</b> and <b>getOrders</b> responses for pending and\
\ completed refunds. For other refunds, see the <b>refundReferenceId</b>\
\ 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 <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:RefundStatusEnum'>eBay\
\ API documentation</a>"
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 <b>getOrders</b> 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 <strong>limit</strong> value can be passed in as a query parameter,\
\ or if omitted, its value defaults to <code>50</code>. <br /><br /><span\
\ class=\"tablenote\"><strong>Note:</strong> If this is the last or only\
\ page of the result set, the page may contain fewer orders than the <strong>limit</strong>\
\ value. To determine the number of pages in a result set, divide the\
\ <b>total</b> value (total number of orders matching input criteria)\
\ by this <strong>limit</strong> value, and then round up to the next\
\ integer. For example, if the <b>total</b> value was <code>120</code>\
\ (120 total orders) and the <strong>limit</strong> value was <code>50</code>\
\ (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 <strong>getOrders</strong>\
\ calls to view all orders matching the input criteria. </span><b>Default:</b>\
\ <code>50</code>"
format: "int32"
next:
type: "string"
description: "The <b>getOrders</b> 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: <br /><br /><code><i>path</i>/order?limit=10&offset=40\
\ </code><br/><br/>This field is only returned if there is a next page\
\ of results to view based on the current input criteria.<br />"
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 <b>offset</b> query parameter. <p class=\"tablenote\"><strong>Note:\
\ </strong>The items in a paginated result set use a zero-based list where\
\ the first item in the list has an offset of <code>0</code>.</p>"
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.\
\ <br /><br />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 <b>getOrders</b> call URI for the previous result set.\
\ For example, the following URI returns orders 21 thru 30 from the collection\
\ of orders: <br /><br /><code><i>path</i>/order?limit=10&offset=20</code><br/><br/>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.<br /><br /><span class=\"tablenote\"><strong>Note:</strong>\
\ If no orders are found, this field is returned with a value of <code>0</code>.</span>"
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 <b>getOrders</b> call. The\
\ collection is grouped into a result set, and based on the query parameters\
\ that are set (including the <strong>limit</strong> and <strong>offset</strong>\
\ 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 <strong>Payment.paymentMethod</strong>.<br /><br\
\ /><span class=\"tablenote\"><strong>Note:</strong> 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 <strong>amount.value</strong> field (and in the <strong>amount.convertedFromValue</strong>\
\ field if currency conversion is applicable).<br><br> To determine if\
\ 'Collect and Remit' taxes were added into this <strong>totalDueSeller</strong>\
\ value, the user can check for the corresponding <strong>lineItems.ebayCollectAndRemitTaxes</strong>\
\ and the <strong>lineItems.taxes</strong> containers in the response.\
\ If both of these containers appear for one or more line items in the\
\ response with the following <strong>taxType</strong> values, the 'Collect\
\ and Remit' tax amount that the buyer paid is included in this amount:<ul><li><code>STATE_SALES_TAX</code>:\
\ US</li><li><code>PROVINCE_SALES_TAX</code>: Provincial Sales Tax in\
\ Canada</li><li><code>GST</code>: Canada, Australia, and New Zealand</li><li><code>VAT</code>:\
\ UK and EU countries</li></ul></span>"
$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. <br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>"
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 <strong>PaymentMethodTypeEnum</strong>\
\ type for more information on the payment methods. For implementation\
\ help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:PaymentMethodTypeEnum'>eBay\
\ API documentation</a>"
paymentReferenceId:
type: "string"
description: "This field is only returned if payment has been made by the\
\ buyer, and the <strong>paymentMethod</strong> is <code>ESCROW</code>.\
\ 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 <strong>PaymentStatusEnum</strong>\
\ type definition for more information on the possible payment states.\
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:PaymentStatusEnum'>eBay\
\ API documentation</a>"
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 <strong>sellerResponse</strong> field will show the\
\ decision that the seller made."
items:
type: "string"
description: " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:SellerDecisionEnum'>eBay\
\ API documentation</a>"
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 <code>CLOSED</code> state.<br/><br/>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: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>.\
\ An example would be <code>2019-08-04T19:09:02.768Z</code>."
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.<br><br>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\
\ <b>itemId</b>/<b>lineItemId</b> 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"
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.<br/><br/>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: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example\
\ would be <code>2019-08-04T19:09:02.768Z</code>."
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 <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:DisputeStateEnum'>eBay\
\ API documentation</a>"
reason:
type: "string"
description: "The enumeration value in this field gives the reason why the\
\ buyer initiated the payment dispute. See <strong>DisputeReasonEnum</strong>\
\ type for a description of the supported reasons that buyers can give\
\ for initiating a payment dispute. For implementation help, refer to\
\ <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:DisputeReasonEnum'>eBay\
\ API documentation</a>"
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 <code>ACTION_NEEDED</code> state. For payment\
\ disputes that currently require action by the seller, that same seller\
\ should look at the <strong>availableChoices</strong> array to see the\
\ available actions.<br/><br/>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: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example\
\ would be <code>2019-08-04T19:09:02.768Z</code>."
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 <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:SellerResponseEnum'>eBay\
\ API documentation</a>"
description: "This type is used by the base response of the <strong>getPaymentDispute</strong>\
\ method. The <strong>getPaymentDispute</strong> 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.<br/><br/>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: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example\
\ would be <code>2019-08-04T19:09:02.768Z</code>."
activityType:
type: "string"
description: "This enumeration value indicates the type of activity that\
\ occured on the payment dispute. For example, a value of <code>DISPUTE_OPENED</code>\
\ is returned when a payment disute is first created, a value indicating\
\ the seller's decision on the dispute, such as <code>SELLER_CONTEST</code>,\
\ is returned when seller makes a decision to accept or contest dispute,\
\ and a value of <code>DISPUTE_CLOSED</code> is returned when a payment\
\ disute is resolved. See <strong>ActivityEnum</strong> for an explanation\
\ of each of the values that may be returned here. For implementation\
\ help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:ActivityEnum'>eBay\
\ API documentation</a>"
actor:
type: "string"
description: "This enumeration value indicates the actor that performed\
\ the action. Possible values include the <code>BUYER</code>, <code>SELLER</code>,\
\ <code>CS_AGENT</code> (eBay customer service), or <code>SYSTEM</code>.\
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:ActorEnum'>eBay\
\ API documentation</a>"
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 <strong>getActivities</strong> 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 <strong>getActivities</strong>\
\ 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 <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:ProtectionStatusEnum'>eBay\
\ API documentation</a>"
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 <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:OutcomeEnum'>eBay\
\ API documentation</a>"
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 <strong>resolution</strong> 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 <code>CLOSED</code> state.<br/><br/>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: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>.\
\ An example would be <code>2019-08-04T19:09:02.768Z</code>."
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.<br/><br/>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: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example\
\ would be <code>2019-08-04T19:09:02.768Z</code>."
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 <strong>getPaymentDispute</strong> call URI to retrieve a specific\
\ payment dispute. The <strong>getPaymentDispute</strong> method returns\
\ more details about a payment dispute than the <strong>getPaymentDisputeSummaries</strong>\
\ method."
paymentDisputeStatus:
type: "string"
description: "The enumeration value in this field gives the current status\
\ of the payment dispute. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:DisputeStateEnum'>eBay\
\ API documentation</a>"
reason:
type: "string"
description: "The enumeration value in this field gives the reason why the\
\ buyer initiated the payment dispute. See <strong>DisputeReasonEnum</strong>\
\ type for a description of the supported reasons that buyers can give\
\ for initiating a payment dispute. For implementation help, refer to\
\ <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:DisputeReasonEnum'>eBay\
\ API documentation</a>"
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 <code>ACTION_NEEDED</code> state. For payment\
\ disputes that require action by the seller, that same seller must call\
\ <strong>getPaymentDispute</strong> to see the next action(s) that they\
\ can take against the payment dispute.<br/><br/>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: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>.\
\ An example would be <code>2019-08-04T19:09:02.768Z</code>."
description: "This type is used by each payment dispute that is returned with\
\ the <strong>getPaymentDisputeSummaries</strong> 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. <br /><br /><b>Format:</b>\
\ <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br /><b>Example:</b>\
\ <code>2015-08-04T19:09:02.768Z</code>"
holdAmount:
description: "The monetary amount of the payment being held. This field\
\ is always returned with the <strong>paymentHolds</strong> 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 <strong>paymentHolds</strong> array."
holdState:
type: "string"
description: "The current stage or condition of the hold. This field is\
\ always returned with the <strong>paymentHolds</strong> array.<br /><br\
\ /><b>Applicable values:</b><ul><li><code>HELD</code></li><li><code>HELD_PENDING</code></li><li><code>NOT_HELD</code></li><li><code>RELEASE_CONFIRMED</code></li><li><code>RELEASE_FAILED</code></li><li><code>RELEASE_PENDING</code></li><li><code>RELEASED</code></li></ul>"
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.<br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>"
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 <strong>paymentStatus</strong>\
\ value was <code>PENDING</code> or <code>FAILED</code>), or if a partial\
\ or full refund occurs with the order.<br /><br /><span class=\"tablenote\"\
><strong>Note:</strong> 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 <strong>totalDueSeller</strong> value.<br><br>To determine\
\ if 'Collect and Remit' taxes were added into this <strong>totalDueSeller</strong>\
\ value, the user can check for the corresponding <strong>lineItems.ebayCollectAndRemitTaxes</strong>\
\ and the <strong>lineItems.taxes</strong> containers in the response.\
\ If both of these containers appear for one or more line items in the\
\ response with the following <strong>taxType</strong> values, the 'Collect\
\ and Remit' tax amount that the buyer paid is included in this amount:<ul><li><code>STATE_SALES_TAX</code>:\
\ US</li><li><code>PROVINCE_SALES_TAX</code>: Provincial Sales Tax in\
\ Canada</li><li><code>GST</code>: Canada, Australia, and New Zealand</li><li><code>VAT</code>:\
\ VAT collected for UK and EU countries</li></ul></span>"
$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 seller's country calling code. 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.\
\ For a full list of calling codes for all countries, see the <a href=\"\
https://countrycode.org/\" target=\"_blank\">countrycode.org</a> site."
number:
type: "string"
description: "The seller's primary phone number associated with the return\
\ address. When this number is provided in a <strong>contestPaymentDispute</strong>\
\ or <strong>contestPaymentDispute</strong> 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: <br><br><code>\"number\" : \"4088084356\"</code><br><br>If\
\ the buyer is located in a different country than the seller, the seller's\
\ country calling code will need to be specified in the <strong>countryCode</strong>\
\ field."
description: "This type is used by the <strong>returnAddress</strong field that\
\ is used by the payment dispute methods. If a buyer is returning the item\
\ (under payment dispute) to the seller, a primary phone number for the seller\
\ must be provided."
PhoneNumber:
type: "object"
properties:
phoneNumber:
type: "string"
description: "The primary telephone number for the shipping recipient."
description: "This type contains a string field representing a telephone number."
PickupStep:
type: "object"
properties:
merchantLocationKey:
type: "string"
description: "A merchant-defined unique identifier of the merchant's store\
\ where the buyer will pick up their In-Store Pickup order.<br/><br/>\
\ This field is always returned with the <b>pickupStep</b> container."
description: "This type is used to indicate the merchant's store where the buyer\
\ will pickup their In-Store Pickup order. The <b>pickupStep</b> 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 <code>PENDING</code> or <code>PASSED</code>.\
\ The possible values returned here are <code>NOT_AUTHENTIC</code>, <code>NOT_AS_DESCRIBED</code>,\
\ <code>CUSTOMIZED</code>, <code>MISCATEGORIZED</code>, or <code>NOT_AUTHENTIC_NO_RETURN</code>.\
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:AuthenticityVerificationReasonEnum'>eBay\
\ API documentation</a>"
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 <code>PENDING</code>, <code>PASSED</code>, <code>FAILED</code>,\
\ or <code>PASSED_WITH_EXCEPTION</code>. For implementation help, refer\
\ to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:AuthenticityVerificationStatusEnum'>eBay\
\ API documentation</a>"
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.<br/><br/>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.<br/><br/>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. <br/><br/>This container is returned if special fees are\
\ being applied to the order and if the <b>fieldGroups</b> is set to <code>TAX_BREAKDOWN</code>."
$ref: "#/components/schemas/Amount"
priceDiscountSubtotal:
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. <br/><br/>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 <b>total</b> field. <br/><br/>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.<br /><br /><span class=\"tablenote\"\
><strong>Note:</strong> 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 <strong>total</strong> value only when the <strong>fieldGroups</strong>\
\ query parameter is set to <code>TAX_BREAKDOWN</code>. If the <strong>fieldGroups</strong>\
\ query parameter is not set to <code>TAX_BREAKDOWN</code>, 'Collect and\
\ Remit' will not be added into this <strong>total</strong> value.<br><br>To\
\ determine if 'Collect and Remit' taxes were added into this <strong>total</strong>\
\ value, the user can check for the corresponding <strong>lineItems.ebayCollectAndRemitTaxes</strong>\
\ and the <strong>lineItems.taxes</strong> containers in the response.\
\ If both of these containers appear for one or more line items in the\
\ response with the following <strong>taxType</strong> values, the 'Collect\
\ and Remit' tax amount that the buyer paid is included in this amount:<ul><li><code>STATE_SALES_TAX</code>:\
\ US state-mandated sales tax</li><li><code>PROVINCE_SALES_TAX</code>:\
\ Provincial Sales Tax in Canada</li><li><code>GST</code>: 'Good and Services'\
\ tax in Canada, Australia, and New Zealand</li><li><code>VAT</code>:\
\ VAT collected for UK and EU countries</li></ul></span>"
$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."
Refund:
type: "object"
properties:
refundId:
type: "string"
description: "The unique identifier of the order refund. This value is returned\
\ unless the refund operation fails (<b>refundStatus</b> value shows <code>FAILED</code>).\
\ This identifier can be used to track the status of the refund through\
\ a <b>getOrder</b> or <b>getOrders</b> call. For order-level refunds,\
\ check the <b>paymentSummary.refunds.refundId</b> field in the <b>getOrder</b>/<b>getOrders</b>\
\ response, and for line item level refunds, check the <b>lineItems.refunds.refundId</b>\
\ field(s) in the <b>getOrder</b>/<b>getOrders</b> response."
refundStatus:
type: "string"
description: "The value returned in this field indicates the success or\
\ failure of the refund operation. A successful <b>issueRefund</b> operation\
\ should result in a value of <code>PENDING</code>. A failed <b>issueRefund</b>\
\ operation should result in a value of <code>FAILED</code>, and an HTTP\
\ status code and/or and API error code may also get returned to possibly\
\ indicate the issue.<br/><br/>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 <a href=\"https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrder\"\
\ target=\"_blank\">getOrder</a> call to check the status of the refund.\
\ The status of an order refund can be found in the <a href=\"https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrder#response.paymentSummary.refunds.refundStatus\"\
\ target=\"_blank\">paymentSummary.refunds.refundStatus</a> field of the\
\ <a href=\"https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrder\"\
\ target=\"_blank\">getOrder</a> response. For implementation help, refer\
\ to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:RefundStatusEnum'>eBay\
\ API documentation</a>"
description: "This is the base type of the <b>issueRefund</b> response payload.\
\ As long as the <b>issueRefund</b> 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 <b>orderLevelRefundAmount</b>\
\ 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 <b>legacyReference</b>\
\ container is needed to identify an individual order line item that will\
\ receive a refund.<br/><br/><span class=\"tablenote\"><strong>Note:</strong>\
\ The <b>lineItemId</b> field is used to identify an order line item in\
\ REST API format, and the <b>legacyReference</b> container is used to\
\ identify an order line item in Trading/legacy API format. Both legacy\
\ and REST API identifiers are returned in <b>getOrder</b> (Fulfillment\
\ API) and <b>GetOrders</b> (Trading API).</span>"
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\
\ <b>lineItemId</b> field is needed to identify an individual order line\
\ item that will receive a refund. <br/><br/><span class=\"tablenote\"\
><strong>Note:</strong> The <b>lineItemId</b> field is used to identify\
\ an order line item in REST API format, and the <b>legacyReference</b>\
\ container is used to identify an order line item in Trading/legacy API\
\ format. Both legacy and REST API identifiers are returned in <b>getOrder</b>\
\ (Fulfillment API) and <b>GetOrders</b> (Trading API).</span>"
$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 <b>orderLevelRefundAmount</b> 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-digt, ISO 3166-1 country code. See the enumeration\
\ type for a country's value. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/ba:CountryCodeEnum'>eBay\
\ API documentation</a>"
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 <strong>sellerActionToRelease</strong>\
\ 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, <code>9405509699937003457459</code>.\
\ This eBay-generated value is created with a successful <b>createShippingFulfillment</b>\
\ 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.<br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code>\
\ <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>"
shippingCarrierCode:
type: "string"
description: "The eBay code identifying the shipping carrier for this fulfillment.\
\ This field is returned if available. <br /><br /><span class=\"tablenote\"\
><strong>Note:</strong> The Trading API's <b>ShippingCarrierCodeType</b>\
\ enumeration type contains the most current list of eBay shipping carrier\
\ codes and the countries served by each carrier. See <a href=\"https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/ShippingCarrierCodeType.html\
\ \" target=\"_blank\">ShippingCarrierCodeType</a>.</span>"
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.<br /><br /><b>Format:</b>\
\ <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br /><b>Example:</b>\
\ <code>2015-08-04T19:09:02.768Z</code><br /><br /><b>Default:</b> 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 <strong>shippingCarrierCode</strong>\
\ and <strong>trackingNumber</strong> fields are optional, but generally\
\ these fields will be provided if the shipping carrier and tracking number\
\ are known. <br /><br /><span class=\"tablenote\"><strong>Note:</strong>\
\ Use the Trading API's <a href=\"https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GeteBayDetails.html\
\ \" target=\"_blank\">GeteBayDetails</a> call to retrieve the latest\
\ shipping carrier enumeration values. When making the <a href=\"https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GeteBayDetails.html\
\ \" target=\"_blank\">GeteBayDetails</a> call, include the <strong>DetailName</strong>\
\ field in the request payload and set its value to <code>ShippingCarrierDetails</code>.\
\ Each valid shipping carrier enumeration value is returned in a <strong>ShippingCarrierDetails.ShippingCarrier</strong>\
\ field in the response payload.</span>"
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.<br /><br\
\ />This field and the <b>shippingCarrierCode</b> field are mutually dependent.\
\ If you include one, you must also include the other.<br /><br /><span\
\ class=\"tablenote\"><strong>Note:</strong> If you include <b>trackingNumber</b>\
\ (and <b>shippingCarrierCode</b>) in the request, the resulting fulfillment's\
\ ID (returned in the HTTP location code) is the tracking number. If you\
\ do not include shipment tracking information, the resulting fulfillment\
\ ID will default to an arbitrary number such as <code>999</code>.</span><br\
\ /><span class=\"tablenote\"><strong>Note:</strong> 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.</span>"
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.<br\
\ /><br /><span class=\"tablenote\"><strong>Note:</strong> If no fulfillments\
\ are found for the order, this field is returned with a value of <code>0</code>.</span>"
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 <b>getShippingFulfillments</b> call. The <b>fulfillments</b> 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. <br /><br /><span class=\"tablenote\"><strong>Note:</strong>\
\ The Trading API's <a href=\"https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GeteBayDetails.html\
\ \" target=\"_blank\">GeteBayDetails</a> call can be used to retrieve\
\ the latest shipping carrier and shipping service option enumeration\
\ values.</span>"
shippingServiceCode:
type: "string"
description: "The unique identifier of the shipping service option being\
\ used to ship the line item.<br /><br /><span class=\"tablenote\"><strong>Note:</strong>\
\ Use the Trading API's <a href=\"https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GeteBayDetails.html\
\ \" target=\"_blank\">GeteBayDetails</a> call to retrieve the latest\
\ shipping carrier and shipping service option enumeration values. When\
\ making the <a href=\"https://developer.ebay.com/devzone/XML/docs/Reference/eBay/GeteBayDetails.html\
\ \" target=\"_blank\">GeteBayDetails</a> call, include the <strong>DetailName</strong>\
\ field in the request payload and set its value to <code>ShippingServiceDetails</code>.\
\ Each valid shipping service option (returned in <strong>ShippingServiceDetails.ShippingService</strong>\
\ field) and corresponding shipping carrier (returned in <strong>ShippingServiceDetails.ShippingCarrier</strong>\
\ field) is returned in response payload.</span>"
shipTo:
description: "This container consists of shipping and contact information\
\ about the individual or organization to whom the fulfillment package\
\ will be shipped.<br/><span class=\"tablenote\"><strong>Note:</strong>\
\ When <b>FulfillmentInstructionsType</b> is <code>FULFILLED_BY_EBAY</code>,\
\ there will be no <b>shipTo</b> address displayed.</span><br/><span class=\"\
tablenote\"><strong>Note:</strong> For Digitally Delivered Goods (DDG),\
\ this address is the same as the Buyer's Registration Address.</span><br/><span\
\ class=\"tablenote\"><strong>Note:</strong> 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 <a href=\"https://developer.ebay.com/devzone/guides/features-guide/default.html#Development/Shipping-APIWork.html#AddressingaGlobalShippingProgramShipment\
\ \" target=\"_blank\">Addressing a Global Shipping Program Shipment</a>.</span>"
$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 <b>fulfillmentStartInstructions.ebaySupportedFulfillment</b>\
\ field will be <code>true</code>. The international shipping provider\
\ uses the <b>shipToReferenceId</b> 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. <br /><br />Sellers must\
\ include this value on the shipping label immediately above the street\
\ address of the international shipping provider. <br /><br />Example:\
\ \"Reference #1234567890123456\" <br /><br /><span class=\"tablenote\"\
><strong>Note:</strong> This value is the same as the <b>ShipToAddress.ReferenceID</b>\
\ value returned by the Trading API's GetOrders call.</span>"
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 <code>USD</code> for\
\ US site) that indicates the currency of the amount in the <strong>value</strong>\
\ field. Both the <strong>value</strong> and <strong>currency</strong>\
\ fields are always returned with the <strong>amount</strong> container.\
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/ba:CurrencyCodeEnum'>eBay\
\ API documentation</a>"
value:
type: "string"
description: "The monetary amount of the payment dispute. Both the <strong>value</strong>\
\ and <strong>currency</strong> fields are always returned with the <strong>amount</strong>\
\ 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 <strong>taxes</strong>\
\ array is always returned for each line item in the order, but this <strong>amount</strong>\
\ 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 <strong>fieldGroups</strong>\
\ is set to <code>TAX_BREAKDOWN</code>. If the order has fees, a breakdown\
\ of the fees is also provided. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:TaxTypeEnum'>eBay\
\ API documentation</a>"
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,\
\ <strong>US</strong> represents the United States, and <strong>DE</strong>\
\ represents Germany. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/ba:CountryCodeEnum'>eBay\
\ API documentation</a>"
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 <strong>taxIdentifierType</strong>\
\ 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\
\ <strong>TaxIdentifierTypeEnum</strong> type. For implementation help,\
\ refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:TaxIdentifierTypeEnum'>eBay\
\ API documentation</a>"
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 <strong>CountryCodeEnum</strong> type, or in the <a\
\ href=\"https://www.iso.org/iso-3166-country-codes.html \">ISO 3166</a>\
\ standard. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/ba:CountryCodeEnum'>eBay\
\ API documentation</a>"
description: "This type is used by the <strong>taxIdentifier</strong> container\
\ that is returned in <strong>getOrder</strong>. The <strong>taxIdentifier</strong>\
\ 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.<br /><br /><span class=\"\
tablenote\"><strong>Note:</strong> Currently, the <strong>taxIdentifier</strong>\
\ container is only returned in <strong>getOrder</strong> and not in <strong>getOrders</strong>.\
\ So, if a seller wanted to view a buyer's tax information for a particular\
\ order returned in <strong>getOrders</strong>, that seller would need to\
\ use the <strong>orderId</strong> value for that particular order, and then\
\ run a <strong>getOrder</strong> call against that order ID. </span>"
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 by the <strong>shipmentTracking</strong> array\
\ returned under the <strong>evidence</strong> container if the seller has\
\ provided shipment tracking information as evidence to support <code>PROOF_OF_DELIVERY</code>\
\ for an INR-related payment dispute."
UpdateEvidencePaymentDisputeRequest:
type: "object"
properties:
evidenceId:
type: "string"
description: "The unique identifier of the evidence set that is being updated\
\ with new evidence files."
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 <strong>EvidenceTypeEnum</strong> type for the supported\
\ evidence types. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:EvidenceTypeEnum'>eBay\
\ API documentation</a>"
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 <strong>files</strong>\
\ array.<br><br> The unique identifier of an evidence file is returned\
\ in the response payload of the <strong>uploadEvidence</strong> 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. Both the <strong>itemId</strong>\
\ and <strong>lineItemID</strong> fields are needed to identify each order\
\ line item, and both of these values are returned under the <strong>evidenceRequests.lineItems</strong>\
\ array in the <strong>getPaymentDispute</strong> response."
items:
$ref: "#/components/schemas/OrderLineItems"
description: "This type is used by the request payload of the <strong>updateEvidence</strong>\
\ method. The <strong>updateEvidence</strong> 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"