{
"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.20.4"
},
"servers": [
{
"url": "https://api.ebay.com{basePath}",
"description": "Production",
"variables": {
"basePath": {
"default": "/sell/fulfillment/v1"
}
}
},
{
"url": "https://apiz.ebay.com{basePath}",
"description": "Production",
"variables": {
"basePath": {
"default": "/sell/fulfillment/v1"
}
}
}
],
"paths": {
"/order/{orderId}": {
"get": {
"tags": [
"order"
],
"description": "Use this call to retrieve the contents of an order based on its unique identifier, orderId. This value was returned in the getOrders call's orders.orderId field when you searched for orders by creation date, modification date, or fulfillment status. Include the optional fieldGroups query parameter set to TAX_BREAKDOWN
to return a breakdown of the taxes and fees.
The returned Order object contains information you can use to create and process fulfillments, including:
TAX_BREAKDOWN
. This field group adds addition fields to the response that return a breakdown of taxes and fees.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "orderId",
"in": "path",
"description": "This path parameter is used to specify the unique identifier of the order being retrieved.TAX_BREAKDOWN
to return a breakdown of the taxes and fees. By default, when no filters are used this call returns all orders created within the last 90 days. TAX_BREAKDOWN
. This field group adds addition fields to the response that return a breakdown of taxes and fees.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "One or more comma-separated criteria for narrowing down the collection of orders returned by this call. These criteria correspond to specific fields in the response payload. Multiple filter criteria combine to further restrict the results. creationdate
filter to a date beyond two years in the past.creationdate
creationdate:[2016-02-21T08:25:43.511Z..]
identifies orders created on or after the given timestamp.creationdate:[2016-02-21T08:25:43.511Z..2016-04-21T08:25:43.511Z]
identifies orders created between the given timestamps, inclusive.lastmodifieddate
lastmodifieddate:[2016-05-15T08:25:43.511Z..]
identifies orders modified on or after the given timestamp.lastmodifieddate:[2016-05-15T08:25:43.511Z..2016-05-31T08:25:43.511Z]
identifies orders modified between the given timestamps, inclusive.orderfulfillmentstatus
orderfulfillmentstatus:{NOT_STARTED|IN_PROGRESS}
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.orderfulfillmentstatus:{FULFILLED|IN_PROGRESS}
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.NOT_STARTED
, IN_PROGRESS
, and FULFILLED
can be used in various combinations, but only the combinations shown here are currently supported. GET https://api.ebay.com/sell/v1/order?
filter=creationdate:%5B2016-03-21T08:25:43.511Z..2016-04-21T08:25:43.511Z%5D,
lastmodifieddate:%5B2016-05-15T08:25:43.511Z..%5D,
orderfulfillmentstatus:%7BNOT_STARTED%7CIN_PROGRESS%7D
[
= %5B
]
= %5D
{
= %7B
|
= %7C
}
= %7D
10
and limit is set to 10
, the call retrieves orders 11 thru 20 from the result set. 0
. If the orderIds parameter is included in the request, this parameter will be ignored. 200
50
",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "offset",
"in": "query",
"description": "Specifies the number of orders to skip in the result set before returning the first order in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0
and a limit of 10
, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10
and limit is 20
, the first page of the response contains items 11-30 from the complete result set.
Default: 0
", "required": false, "schema": { "type": "string" } }, { "name": "orderIds", "in": "query", "description": "A comma-separated list of the unique identifiers of the orders to retrieve (maximum 50). If one or more order ID values are specified through the orderIds query parameter, all other query parameters will be ignored.50
)"
},
"31000": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Invalid offset: {offsetvalue}"
},
"31100": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Invalid limit: {limitvalue}"
},
"32800": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Invalid field group: {fieldGroup}"
}
}
}
},
"500": {
"description": "Internal Server Error",
"x-response-codes": {
"errors": {
"30500": {
"domain": "API_FULFILLMENT",
"category": "APPLICATION",
"description": "System error"
}
}
}
}
},
"security": [
{
"api_auth": [
"https://api.ebay.com/oauth/api_scope/sell.fulfillment",
"https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly"
]
}
]
}
},
"/order/{order_id}/issue_refund": {
"post": {
"tags": [
"order"
],
"summary": "Issue Refund",
"description": "Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including issueRefund. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.
{ENV}/sell/fulfillment/v1/order/{ORDERID}/shipping_fulfillment/{FULFILLMENTID}
ENV
string is the HTTPS path to the same eBay supported environment in which this call was issued. The ORDERID
parameter is the unique identifier of the order addressed by this call; for example, 01-03955-36441
. The FULFILLMENTID
parameter identifies the newly created fulfillment; for example, 9405509699937003457459
. Use this Get Fulfillment URI to retrieve the contents of the new fulfillment.",
"headers": {
"Location": {
"schema": {
"type": "string",
"description": "The location response header contains the getShippingFulfillment URI to retrieve the contents of the newly created shipping fulfillment. The URL includes the eBay-assigned fulfillmentId
, which you can use to reference the shipping fulfillment."
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request",
"x-response-codes": {
"errors": {
"32100": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Invalid Order Id: {orderId}"
},
"32200": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Invalid line item id: {lineItemId}"
},
"32210": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Duplicate line item in the request"
},
"32300": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Invalid shipment tracking number or carrier"
},
"32400": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Requested user is suspended"
},
"32500": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Invalid shipped date"
},
"32600": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Invalid input data"
},
"34100": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Maximum tracking number for order is exceeded"
},
"34200": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Line Items contain Global Shipping Program and non-Global Shipping Program orders"
},
"34300": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Mark As Shipped for multiple Global Shipping Program line items is not supported"
},
"34500": {
"domain": "API_FULFILLMENT",
"category": "REQUEST",
"description": "Please use PUT operation for updating shipping fulfillment"
}
}
}
},
"409": {
"description": "Conflict"
},
"500": {
"description": "Internal Server Error",
"x-response-codes": {
"errors": {
"30500": {
"domain": "API_FULFILLMENT",
"category": "APPLICATION",
"description": "System error"
}
}
}
}
},
"security": [
{
"api_auth": [
"https://api.ebay.com/oauth/api_scope/sell.fulfillment"
]
}
]
}
},
"/order/{orderId}/shipping_fulfillment/{fulfillmentId}": {
"get": {
"tags": [
"shipping_fulfillment"
],
"description": "Use this call to retrieve the contents of a fulfillment based on its unique identifier, fulfillmentId (combined with the associated order's orderId). The fulfillmentId value was originally generated by the createShippingFulfillment call, and is returned by the getShippingFulfillments call in the members.fulfillmentId field.",
"operationId": "getShippingFulfillment",
"parameters": [
{
"name": "fulfillmentId",
"in": "path",
"description": "This path parameter is used to specify the unique identifier of the shipping fulfillment being retrieved.An actual binary file is returned if the call is successful. An error will occur if any of three identifiers are invalid.
", "operationId": "fetchEvidenceContent", "parameters": [ { "name": "payment_dispute_id", "in": "path", "description": "This path parameter is used to specify the unique identifier of the payment dispute associated with the evidence file being retrieved.2019-08-04T19:09:02.768Z
.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "open_date_to",
"in": "query",
"description": "The open_date_from and/or open_date_to date filters are used if the seller wishes to retrieve payment disputes opened within a specific date range. A maximum date range that may be set with the open_date_from and/or open_date_to filters is 90 days. These date filters use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu.2019-08-04T19:09:02.768Z
.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "payment_dispute_status",
"in": "query",
"description": "This filter is used if the seller wishes to only retrieve payment disputes in one or more specific states. To filter by more than one status value, a separate payment_dispute_status filter must be used for each value, as shown below:0
(default value), the first payment dispute in the result set appears at the top of the response. 0
and a limit value of 10
, the response will contain the first 10 payment disputes from the result set that matches the input criteria. If you supply an offset value of 10
and a limit value of 20
, the response will contain payment disputes 11-30 from the result set that matches the input criteria.204 Success
is returned. There is no response payload unless an error occurs. To verify that a new file is a part of the evidence set, the seller can use the fetchEvidenceContent method, passing in the proper evidenceId and fileId values.",
"operationId": "updateEvidence",
"parameters": [
{
"name": "payment_dispute_id",
"in": "path",
"description": "This parameter is used to specify the unique identifier of the contested payment dispute for which the user plans to update the evidence set.US
represents the United States, and DE
represents Germany. For implementation help, refer to eBay API documentation"
},
"county": {
"type": "string",
"description": "The county of the shipping destination. Counties typically, but not always, contain multiple cities or towns. This field is returned if known/available."
},
"postalCode": {
"type": "string",
"description": "The postal code of the shipping destination. Usually referred to as Zip codes in the US. Most countries have postal codes, but not all. The postal code will be returned if applicable."
},
"stateOrProvince": {
"type": "string",
"description": "The state or province of the shipping destination. Most countries have states or provinces, but not all. The state or province will be returned if applicable."
}
},
"description": "This type contains the details of a geographical address."
},
"Amount": {
"type": "object",
"properties": {
"convertedFromCurrency": {
"type": "string",
"description": "A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency. For implementation help, refer to eBay API documentation"
},
"convertedFromValue": {
"type": "string",
"description": "The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field."
},
"currency": {
"type": "string",
"description": "A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2022-10-28T00:00:00.000Z
"
},
"appointmentStartTime": {
"type": "string",
"description": "The date and time the appointment begins, formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2022-10-28T00:10:00.000Z
"
},
"appointmentStatus": {
"type": "string",
"description": "The status of the appointment. For implementation help, refer to eBay API documentation"
},
"appointmentType": {
"type": "string",
"description": "The type of appointment. MACRO appointments only have a start time (not bounded with end time). TIME_SLOT appointments have a period (both start time and end time). Required for tire installation. For implementation help, refer to eBay API documentation"
},
"appointmentWindow": {
"type": "string",
"description": "Appointment window for MACRO appointments. For implementation help, refer to eBay API documentation"
},
"serviceProviderAppointmentDate": {
"type": "string",
"description": "Service provider date of the appointment (no time stamp). Returned only for MACRO appointment types."
}
},
"description": "This type contains information used by the installation provider concerning appointment details selected by the buyer"
},
"Buyer": {
"type": "object",
"properties": {
"buyerRegistrationAddress": {
"description": "Buyer's contact information that includes the buyer's name, email, phone number, and address.",
"$ref": "#/components/schemas/ExtendedContact"
},
"taxAddress": {
"description": "This container consists of address information that can be used by sellers for tax purpose.[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"cancelInitiator": {
"type": "string",
"description": "This string value indicates the party who made the initial cancellation request. Typically, either the 'Buyer' or 'Seller'. If a cancellation request has been made, this field should be returned."
},
"cancelReason": {
"type": "string",
"description": "The reason why the cancelInitiator initiated the cancellation request. Cancellation reasons for a buyer might include 'order placed by mistake' or 'order won't arrive in time'. For a seller, a typical cancellation reason is 'out of stock'. If a cancellation request has been made, this field should be returned."
},
"cancelRequestedDate": {
"type": "string",
"description": "The date and time that the order cancellation was requested. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is returned for each cancellation request.[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"cancelRequestId": {
"type": "string",
"description": "The unique identifier of the order cancellation request. This field is returned for each cancellation request."
},
"cancelRequestState": {
"type": "string",
"description": "The current stage or condition of the cancellation request. This field is returned for each cancellation request. For implementation help, refer to eBay API documentation"
}
},
"description": "This type contains information about a buyer request to cancel an order."
},
"CancelStatus": {
"type": "object",
"properties": {
"cancelledDate": {
"type": "string",
"description": "The date and time the order was cancelled, if applicable. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"cancelRequests": {
"type": "array",
"description": "This array contains details of one or more buyer requests to cancel the order. NONE_REQUESTED
is returned. For implementation help, refer to eBay API documentation"
}
},
"description": "This type contains information about any requests that have been made to cancel an order."
},
"ContestPaymentDisputeRequest": {
"type": "object",
"properties": {
"note": {
"type": "string",
"description": "This field shows information that the seller provides about the dispute, such as the basis for the dispute, any relevant evidence, tracking numbers, and so forth.0.0
(dollars).",
"$ref": "#/components/schemas/Amount"
},
"shippingIntermediationFee": {
"description": "This field shows the fee due to eBay's international shipping provider for a line item that is being shipped through the Global Shipping Program.0.0
for line items sold in the UK marketplace.",
"$ref": "#/components/schemas/Amount"
}
},
"description": "This type contains a breakdown of all costs associated with the fulfillment of a line item."
},
"DisputeAmount": {
"type": "object",
"properties": {
"convertedFromCurrency": {
"type": "string",
"description": "The three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is the pre-conversion currency.2019-08-04T19:09:02.768Z
."
},
"requestDate": {
"type": "string",
"description": "The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute. 2019-08-04T19:09:02.768Z
."
},
"respondByDate": {
"type": "string",
"description": "The timestamp in this field shows the date/time when the seller was expected to provide a requested evidential document to eBay. 2019-08-04T19:09:02.768Z
."
},
"shipmentTracking": {
"type": "array",
"description": "This array shows the shipping carrier and shipment tracking number associated with each shipment package of the order. This array is returned under the evidence container if the seller has provided shipment tracking information as evidence to support PROOF_OF_DELIVERY
for an INR-related payment dispute.",
"items": {
"$ref": "#/components/schemas/TrackingInfo"
}
}
},
"description": "This type is used by the evidence array that is returned in the getPaymentDispute response if one or more evidential documents are associated with the payment dispute. "
},
"DisputeSummaryResponse": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The URI of the getPaymentDisputeSummaries call request that produced the current page of the result set."
},
"limit": {
"type": "integer",
"description": "This value shows the maximum number of payment disputes that will appear on one page of the result set. The limit value can be passed in as a query parameter in the request, or if it is not used, it defaults to 200
. If the value in the total field exceeds this limit value, there are multiple pages in the current result set.path/payment_dispute_summary?limit=10&offset=10
0
and the first payment dispute of the result set is shown at the top of the response.",
"format": "int32"
},
"paymentDisputeSummaries": {
"type": "array",
"description": "Each payment dispute that matches the input criteria is returned under this array. If no payment disputes are found, an empty array is returned.",
"items": {
"$ref": "#/components/schemas/PaymentDisputeSummary"
}
},
"prev": {
"type": "string",
"description": "The getPaymentDisputeSummaries call URI to use if you wish to view the previous page of the result set. For example, the following URI returns records 1 thru 10 from the collection of payment disputes:path/payment_dispute_summary?limit=10&offset=0
0
.",
"format": "int32"
}
},
"description": "This type defines the base response payload of the getPaymentDisputeSummaries method. Each payment dispute that matches the input criteria is returned under the paymentDisputeSummaries array."
},
"EbayCollectAndRemitTax": {
"type": "object",
"properties": {
"amount": {
"description": "The monetary amount of the 'Collect and Remit' tax. This currently includes:STATE_SALES_TAX
, PROVINCE_SALES_TAX
, GST
, VAT
, or SST
and the lineItems.taxes container also appears for this line item with the same tax amount, the order is subject to 'eBay Collect and Remit' tax. For orders that are subject to 'eBay Collect and Remit' tax, the tax amount in this field will be included in the lineItems.total, paymentSummary.payments.amount, paymentSummary.totalDueSeller, and pricingSummary.total fields.",
"$ref": "#/components/schemas/Amount"
},
"ebayReference": {
"description": "This container field describes the line-item level VAT tax details.NET
.EBAY
"
}
},
"description": "This type is used to provide details about an order line item being fulfilled by eBay or an eBay fulfillment partner."
},
"EbayInternationalShipping": {
"type": "object",
"properties": {
"returnsManagedBy": {
"type": "string",
"description": "The value returned in this field indicates the party that is responsible for managing returns of the order line item.EBAY
"
}
},
"description": "This type is used to provide details about an order line item being managed through eBay International Shipping."
},
"EbayShipping": {
"type": "object",
"properties": {
"shippingLabelProvidedBy": {
"type": "string",
"description": "This field contains the shipping label provider. If EBAY
, this order is managed by eBay shipping and a free shipping label by eBay is downloadable by the seller via the eBay website."
}
},
"description": "This type contains information about the management of the shipping for the order."
},
"EbayTaxReference": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "This field value is returned to indicate the VAT tax type, which will vary by country/region. This string value will be one of the following:ABN
: if this string is returned, the ID in the value field is an Australia tax IDDDG
: if this string is returned, it indicates that tax has been collected and remitted for Digitally Delivered Goods (DDG)IOSS
: if this string is returned, the ID in the value field is an eBay EU or UK IOSS numberIRD
: if this string is returned, the ID in the value field is an eBay New Zealand tax IDSST
: if this string is returned, the ID in the value field is an eBay Malaysia taxNumberOSS
: if this string is returned, the ID in the value field is an eBay Germany VAT IDVOEC
: if this string is returned, the ID in the value field is an eBay Norway tax IDsell
is a domain."
},
"errorId": {
"type": "integer",
"description": "A positive integer that uniquely identifies the specific error condition that occurred. Your application can use these values as error code identifiers in your customized error-handling algorithms.",
"format": "int32"
},
"inputRefIds": {
"type": "array",
"description": "A list of one or more specific request elements (if any) associated with the error or warning. The format of these strings depends on the request payload format. For JSON, use JSONPath notation.",
"items": {
"type": "string"
}
},
"longMessage": {
"type": "string",
"description": "An expanded version of the message field. fulfillment
is a subdomain in the sell
domain."
}
},
"description": "This type contains a error or warning related to a call request. "
},
"ErrorParameter": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "This is the name of input field that caused an issue with the call request."
},
"value": {
"type": "string",
"description": "This is the actual value that was passed in for the element specified in the name field."
}
},
"description": "This type contains the name and value of an input parameter that contributed to a specific error or warning condition."
},
"EvidenceRequest": {
"type": "object",
"properties": {
"evidenceId": {
"type": "string",
"description": "Unique identifier of the evidential file set. Potentially, each evidential file set can have more than one file, that is why there is this file set identifier, and then an identifier for each file within this file set."
},
"evidenceType": {
"type": "string",
"description": "This enumeration value shows the type of evidential document provided. For implementation help, refer to eBay API documentation"
},
"lineItems": {
"type": "array",
"description": "This array shows one or more order line items associated with the evidential document that has been provided.",
"items": {
"$ref": "#/components/schemas/OrderLineItems"
}
},
"requestDate": {
"type": "string",
"description": "The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute. 2019-08-04T19:09:02.768Z
."
},
"respondByDate": {
"type": "string",
"description": "The timestamp in this field shows the date/time when the seller is expected to provide a requested evidential document to eBay. 2019-08-04T19:09:02.768Z
."
}
},
"description": "This type is used by the evidenceRequests array that is returned in the getPaymentDispute response if one or more evidential documents are being requested to help resolve the payment dispute."
},
"ExtendedContact": {
"type": "object",
"properties": {
"companyName": {
"type": "string",
"description": "The company name associated with the buyer or eBay shipping partner. This field is only returned if defined/applicable to the buyer or eBay shipping partner."
},
"contactAddress": {
"description": "This container shows the shipping address of the buyer or eBay shipping partner.",
"$ref": "#/components/schemas/Address"
},
"email": {
"type": "string",
"description": "This field contains the email address of the buyer. This address will be returned for up to 14 days from order creation. If an order is more than 14 days old, no address is returned.2019-08-04T19:09:02.768Z
."
}
},
"description": "This type is used by the files array, which shows the name, ID, file type, and upload date for each provided evidential file."
},
"FulfillmentStartInstruction": {
"type": "object",
"properties": {
"appointment": {
"description": "This container provides information used by the installation provider concerning appointment details selected by the buyer.",
"$ref": "#/components/schemas/AppointmentDetails"
},
"ebaySupportedFulfillment": {
"type": "boolean",
"description": "This field is only returned if its value is true
and indicates that the fulfillment will be shipped via eBay's Global Shipping Program, eBay International Shipping, or the Authenticity Guarantee service program. true
. Note: For Authenticity Guarantee program shipment, this is the address of the authenticator's warehouse. The authenticator is responsible for delivery to the buyer shipping address.
", "$ref": "#/components/schemas/Address" }, "fulfillmentInstructionsType": { "type": "string", "description": "The enumeration value returned in this field indicates the method of fulfillment that will be used to deliver this set of line items (this package) to the buyer. This field will have a value ofSHIP_TO
if the ebaySupportedFulfillment field is returned with a value of true
. See the FulfillmentInstructionsType definition for more information about different fulfillment types. For implementation help, refer to eBay API documentation"
},
"maxEstimatedDeliveryDate": {
"type": "string",
"description": "This is the estimated latest date that the fulfillment will be completed. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned ifthe value of the fulfillmentInstructionsType field is DIGITAL
or PREPARE_FOR_PICKUP
. [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"minEstimatedDeliveryDate": {
"type": "string",
"description": "This is the estimated earliest date that the fulfillment will be completed. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned if the value of the fulfillmentInstructionsType field is DIGITAL
or PREPARE_FOR_PICKUP
. [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"pickupStep": {
"description": "This container is only returned for In-Store Pickup orders, and it indicates the specific merchant's store where the buyer will pick up the order. The In-Store Pickup feature is supported in the US, Canada, UK, Germany, and Australia marketplaces.",
"$ref": "#/components/schemas/PickupStep"
},
"shippingStep": {
"description": "This container consists of shipping information for this fulfillment, including the shipping carrier, the shipping service option, and the shipment destination. This container is not returned if the value of the fulfillmentInstructionsType field is DIGITAL
, or for In-Store Pickup orders. true
it indicates that the buyer's note regarding the payment dispute (i.e., the buyerProvided.note field,) is on hold. When this is the case, the buyerProvided.note field will not be returned.false
, it is not returned."
},
"note": {
"type": "string",
"description": "This field shows any note that was left by the buyer in regard to the dispute."
},
"returnShipmentTracking": {
"type": "array",
"description": "This array shows shipment tracking information for one or more shipping packages being returned to the buyer after a payment dispute.",
"items": {
"$ref": "#/components/schemas/TrackingInfo"
}
}
},
"description": "This container is returned if the buyer is returning one or more line items in an order that is associated with the payment dispute, and that buyer has provided return shipping tracking information and/or a note about the return."
},
"IssueRefundRequest": {
"type": "object",
"properties": {
"reasonForRefund": {
"type": "string",
"description": "The enumeration value passed into this field indicates the reason for the refund. One of the defined enumeration values in the ReasonForRefundEnum type must be used.AUCTION
and FIXED_PRICE
. For implementation help, refer to eBay API documentation"
},
"taxes": {
"type": "array",
"description": "Contains a list of taxes applied to the line item, if any. This array is always returned, but will be returned as empty if no taxes are applicable to the line item.",
"items": {
"$ref": "#/components/schemas/Tax"
}
},
"title": {
"type": "string",
"description": "The title of the listing.TAX_BREAKDOWN
. If the fieldGroups query parameter is not set to TAX_BREAKDOWN
, 'Collect and Remit' will not be added into this total value.STATE_SALES_TAX
: US state-mandated sales taxPROVINCE_SALES_TAX
: Provincial Sales Tax in CanadaGST
: 'Goods and Services' tax in Canada, Australia, and New ZealandVAT
: VAT collected for UK and EU countriescolor:blue
and size:large
, and will only be returned for orders created from a multiple-variation listing.",
"items": {
"$ref": "#/components/schemas/NameValuePair"
}
}
},
"description": "This type contains the details of each line item in an order."
},
"LineItemFulfillmentInstructions": {
"type": "object",
"properties": {
"guaranteedDelivery": {
"type": "boolean",
"description": "Although this field is still returned, it can be ignored since eBay Guaranteed Delivery is no longer a supported feature on any marketplace. This field may get removed from the schema in the future."
},
"maxEstimatedDeliveryDate": {
"type": "string",
"description": "The estimated latest date and time that the buyer can expect to receive the line item based on the seller's stated handling time and the transit times of the available shipping service options. The seller must pay extra attention to this date, as a failure to deliver by this date/time can result in a 'Late shipment' seller defect, and can affect seller level and Top-Rated Seller status. In addition to the seller defect, buyers will be eligible for a shipping cost refund, and will also be eligible to return the item for a full refund (with no return shipping charge) if they choose. [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"minEstimatedDeliveryDate": {
"type": "string",
"description": "The estimated earliest date and time that the buyer can expect to receive the line item based on the seller's stated handling time and the transit times of the available shipping service options.[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"shipByDate": {
"type": "string",
"description": "The latest date and time by which the seller should ship line item in order to meet the expected delivery window. This timestamp will be set by eBay based on time of purchase and the seller's stated handling time. The seller must pay extra attention to this date, as a failure to physically ship the line item by this date/time can result in a 'Late shipment' seller defect, and can affect seller level and Top-Rated Seller status. In addition to the seller defect, buyers will be eligible for a shipping cost refund, and will also be eligible to return the item for a full refund (with no return shipping charge) if they choose. [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
}
},
"description": "This type contains the specifications for processing the fulfillment of a line item, including the handling window and the delivery window. These fields provide guidance for eBay Guaranteed Delivery as well as for non-guaranteed delivery."
},
"LineItemProperties": {
"type": "object",
"properties": {
"buyerProtection": {
"type": "boolean",
"description": "A value of true
indicates that the line item is covered by eBay's Buyer Protection program."
},
"fromBestOffer": {
"type": "boolean",
"description": "This field is only returned if true
and indicates that the purchase occurred by the buyer and seller mutually agreeing on a Best Offer amount. The Best Offer feature can be set up for any listing type, but if this feature is set up for an auction listing, it will no longer be available once a bid has been placed on the listing."
},
"soldViaAdCampaign": {
"type": "boolean",
"description": "This field is only returned if true
and indicates that the line item was sold as a result of a seller's ad campaign."
}
},
"description": "This type contains information about the eBay programs under which a line item was listed and sold."
},
"LineItemReference": {
"type": "object",
"properties": {
"lineItemId": {
"type": "string",
"description": "This is the unique identifier of the eBay order line item that is part of the shipping fulfillment.[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"refundId": {
"type": "string",
"description": "Unique identifier of a refund that was initiated for an order's line item through the issueRefund method. If the issueRefund method was used to issue a refund at the order level, this identifier is returned at the order level instead (paymentSummary.refunds.refundId field).\"lineItemAspects\": [Note: All item specifics for the listing are returned. The name/value pairs returned are in the language of the linked line item's listing site, which may vary from the seller's language.", "items": { "$ref": "#/components/schemas/NameValuePair" } }, "lineItemId": { "type": "string", "description": "The unique identifier of the linked order line item." }, "maxEstimatedDeliveryDate": { "type": "string", "description": "The end of the date range in which the linked line item is expected to be delivered to the shipping address." }, "minEstimatedDeliveryDate": { "type": "string", "description": "The beginning of the date range in which the linked line item is expected to be delivered to the shipping address." }, "orderId": { "type": "string", "description": "The unique identifier of the order to which the linked line item belongs." }, "sellerId": { "type": "string", "description": "The eBay user ID of the seller who sold the linked line item. For example, the user ID of the tire seller." }, "shipments": { "type": "array", "description": "An array containing any shipment tracking information available for the linked line item.", "items": { "$ref": "#/components/schemas/TrackingInfo" } }, "title": { "type": "string", "description": "The listing title of the linked line item.
{
\"name\": \"Tire Type\",
\"value\": \"All Season\"
},
...
{
\"name\": \"Car Type\",
\"value\": \"Performance\"
}
]
YYYY-MM-DDTHH:MM:SS.SSSZ
. For example, 2015-08-04T19:09:02.768Z
."
},
"type": {
"type": "string",
"description": "This enumeration value indicates whether the monetary transaction is a charge or a credit to the seller. For implementation help, refer to eBay API documentation"
},
"reason": {
"type": "string",
"description": "This enumeration value indicates the reason for the monetary transaction. For implementation help, refer to eBay API documentation"
},
"amount": {
"description": "The amount involved in the monetary transaction. For active cross-border trade orders, the currency conversion and exchangeRate fields will be displayed as well.",
"$ref": "#/components/schemas/DisputeAmount"
}
},
"description": "This type is used to provide details about one or more monetary transactions that occur as part of a payment dispute."
},
"NameValuePair": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The text representing the name of the aspect for the name-value pair. For example, color
, or Tire Type
."
},
"value": {
"type": "string",
"description": "The value of the aspect for the name-value pair. For example, red
, or All Season
."
}
},
"description": "This type contains the name-value specifics of a multi-variation listing (variationAspects) or the name-value specifics for all item aspects of a linked line item (linkedOrderLineItems)."
},
"Order": {
"type": "object",
"properties": {
"buyer": {
"description": "This container consists of information about the order's buyer. At this time, only the buyer's eBay user ID is returned, but it's possible that more buyer information can be added to this container in the future.",
"$ref": "#/components/schemas/Buyer"
},
"buyerCheckoutNotes": {
"type": "string",
"description": "This field contains any comments that the buyer left for the seller about the order during checkout process. This field is only returned if a buyer left comments at checkout time. "
},
"cancelStatus": {
"description": "This container consists of order cancellation information if a cancel request has been made. This container is always returned, and if no cancel request has been made, the cancelState field is returned with a value of NONE_REQUESTED
, and an empty cancelRequests array is also returned.",
"$ref": "#/components/schemas/CancelStatus"
},
"creationDate": {
"type": "string",
"description": "The date and time that the order was created. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"ebayCollectAndRemitTax": {
"type": "boolean",
"description": "This field is only returned if true
, and indicates that eBay will collect tax (US state-mandated sales tax, Federal and Provincial Sales Tax in Canada, 'Goods and Services' tax in Canada, Australia, and New Zealand, and VAT collected for UK and EU countries,) for at least one line item in the order, and remit the tax to the taxing authority of the buyer's residence. If this field is returned, the seller should search for one or more ebayCollectAndRemitTaxes containers at the line item level to get more information about the type of tax and the amount."
},
"fulfillmentHrefs": {
"type": "array",
"description": "This array contains a list of one or more getShippingFulfillment call URIs that can be used to retrieve shipping fulfillments that have been set up for the order.",
"items": {
"type": "string"
}
},
"fulfillmentStartInstructions": {
"type": "array",
"description": "This container consists of a set of specifications for fulfilling the order, including the type of fulfillment, shipping carrier and service, shipping address, and estimated delivery window. These instructions are derived from the buyer's and seller's eBay account preferences, the listing parameters, and the buyer's checkout selections. The seller can use them as a starting point for packaging, addressing, and shipping the order.[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"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 orderId 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 OrderFulfillmentStatus type definition for more information about each possible fulfillment state. For implementation help, refer to eBay API documentation"
},
"orderId": {
"type": "string",
"description": "The unique identifier of the order. Both the legacyOrderId 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 OrderPaymentStatusEnum type definition for more information about each possible payment/refund state. For implementation help, refer to eBay API documentation"
},
"paymentSummary": {
"description": "This container consists of detailed payment information for the order, including buyer payment for the order, refund information (if applicable), and seller payment holds (if applicable).",
"$ref": "#/components/schemas/PaymentSummary"
},
"pricingSummary": {
"description": "This container consists of a summary of cumulative costs and charges for all line items of an order, including item price, price adjustments, sales taxes, delivery costs, and order discounts.",
"$ref": "#/components/schemas/PricingSummary"
},
"program": {
"description": "This container is returned for orders that are eligible for eBay's Authenticity Guarantee service. The seller ships Authenticity Guarantee service items to the authentication partner instead of the buyer. The authenticator address is found in the fulfillmentStartInstructions.shippingStep.shipTo
container. If the item is successfully authenticated, the authenticator will ship the item to the buyer.",
"$ref": "#/components/schemas/Program"
},
"salesRecordReference": {
"type": "string",
"description": "An eBay-generated identifier that is used to identify and manage orders through the Selling Manager and Selling Manager Pro tools. This order identifier can also be found on the Orders grid page and in the Sales Record pages in Seller Hub. A salesRecordReference number is only generated and returned at the order level, and not at the order line item level.[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"refundId": {
"type": "string",
"description": "Unique identifier of a refund that was initiated for an order through the issueRefund method. If the issueRefund method was used to issue one or more refunds at the line item level, these refund identifiers are returned at the line item level instead (lineItems.refunds.refundId field).50
. 120
(120 total orders) and the limit value was 50
(show 50 orders per page), the total number of pages in the result set is three, so the seller would have to make three separate getOrders calls to view all orders matching the input criteria. Default: 50
",
"format": "int32"
},
"next": {
"type": "string",
"description": "The getOrders call URI to use if you wish to view the next page of the result set. For example, the following URI returns records 41 thru 50 from the collection of orders: path/order?limit=10&offset=40
Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0
.
path/order?limit=10&offset=20
0
.",
"format": "int32"
},
"warnings": {
"type": "array",
"description": "This array is returned if one or more errors or warnings occur with the call request.",
"items": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "This type contains the specifications for the collection of orders that match the search or filter criteria of a getOrders call. The collection is grouped into a result set, and based on the query parameters that are set (including the limit and offset parameters), the result set may included multiple pages, but only one page of the result set can be viewed at a time."
},
"Payment": {
"type": "object",
"properties": {
"amount": {
"description": "The amount that seller receives for the order via the payment method mentioned in Payment.paymentMethod.STATE_SALES_TAX
: USPROVINCE_SALES_TAX
: Provincial Sales Tax in CanadaGST
: Canada, Australia, and New ZealandVAT
: UK and EU countries[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"paymentHolds": {
"type": "array",
"description": "This container is only returned if eBay is temporarily holding the seller's funds for the order. If a payment hold has been placed on the order, this container includes the reason for the payment hold, the expected release date of the funds into the seller's account, the current state of the hold, and as soon as the payment hold has been released, the actual release date.",
"items": {
"$ref": "#/components/schemas/PaymentHold"
}
},
"paymentMethod": {
"type": "string",
"description": "The payment method used to pay for the order. See the PaymentMethodTypeEnum type for more information on the payment methods. For implementation help, refer to eBay API documentation"
},
"paymentReferenceId": {
"type": "string",
"description": "This field is only returned if payment has been made by the buyer, and the paymentMethod is ESCROW
. This field contains a special ID for ESCROW."
},
"paymentStatus": {
"type": "string",
"description": "The enumeration value returned in this field indicates the status of the payment for the order. See the PaymentStatusEnum type definition for more information on the possible payment states. For implementation help, refer to eBay API documentation"
}
},
"description": "This type is used to provide details about the seller payments for an order."
},
"PaymentDispute": {
"type": "object",
"properties": {
"amount": {
"description": "This container shows the dollar value associated with the payment dispute in the currency used by the seller's marketplace.",
"$ref": "#/components/schemas/SimpleAmount"
},
"availableChoices": {
"type": "array",
"description": "The value(s) returned in this array indicate the choices that the seller has when responding to the payment dispute. Once the seller has responded to the payment dispute, this field will no longer be shown, and instead, the sellerResponse field will show the decision that the seller made.",
"items": {
"type": "string",
"description": " For implementation help, refer to eBay API documentation"
}
},
"buyerProvided": {
"description": "This container is returned if the buyer is returning one or more line items in an order that is associated with the payment dispute, and that buyer has provided return shipping tracking information and/or a note about the return.",
"$ref": "#/components/schemas/InfoFromBuyer"
},
"buyerUsername": {
"type": "string",
"description": "This is the eBay user ID of the buyer that initiated the payment dispute."
},
"closedDate": {
"type": "string",
"description": "The timestamp in this field shows the date/time when the payment dispute was closed, so this field is only returned for payment disputes in the CLOSED
state.2019-08-04T19:09:02.768Z
."
},
"evidence": {
"type": "array",
"description": "This container shows any evidence that has been provided by the seller to contest the payment dispute. Evidence may include shipment tracking information, proof of authentication documentation, image(s) to proof that an item is as described, or financial documentation/invoice.2019-08-04T19:09:02.768Z
."
},
"orderId": {
"type": "string",
"description": "This is the unique identifier of the order involved in the payment dispute."
},
"paymentDisputeId": {
"type": "string",
"description": "This is the unique identifier of the payment dispute. This is the same identifier that is passed in to the call URI. This identifier is automatically created by eBay once the payment dispute comes into the eBay system."
},
"paymentDisputeStatus": {
"type": "string",
"description": "The enumeration value in this field gives the current status of the payment dispute. The status of a payment dispute partially determines other fields that are returned in the response. For implementation help, refer to eBay API documentation"
},
"reason": {
"type": "string",
"description": "The enumeration value in this field gives the reason why the buyer initiated the payment dispute. See DisputeReasonEnum type for a description of the supported reasons that buyers can give for initiating a payment dispute. For implementation help, refer to eBay API documentation"
},
"resolution": {
"description": "This container gives details about a payment dispute that has been resolved. This container is only returned for resolved/closed payment disputes.",
"$ref": "#/components/schemas/PaymentDisputeOutcomeDetail"
},
"respondByDate": {
"type": "string",
"description": "The timestamp in this field shows the date/time when the seller must response to a payment dispute, so this field is only returned for payment disputes in the ACTION_NEEDED
state. For payment disputes that currently require action by the seller, that same seller should look at the availableChoices array to see the available actions.2019-08-04T19:09:02.768Z
."
},
"returnAddress": {
"description": "This container gives the address where the order will be returned to. This container is returned if the seller is accepting the payment dispute and will issue a refund to the buyer once the item is returned to this address.",
"$ref": "#/components/schemas/ReturnAddress"
},
"revision": {
"type": "integer",
"description": "This integer value indicates the revision number of the payment dispute. Each time an action is taken against a payment dispute, this integer value increases by 1.",
"format": "int32"
},
"sellerResponse": {
"type": "string",
"description": "The enumeration value returned in this field indicates how the seller has responded to the payment dispute. The seller has the option of accepting the payment dispute and agreeing to issue a refund, accepting the payment dispute and agreeing to issue a refund as long as the buyer returns the item, or contesting the payment dispute. This field is returned as soon as the seller makes an initial decision on the payment dispute. For implementation help, refer to eBay API documentation"
}
},
"description": "This type is used by the base response of the getPaymentDispute method. The getPaymentDispute method retrieves detailed information on a specific payment dispute."
},
"PaymentDisputeActivity": {
"type": "object",
"properties": {
"activityDate": {
"type": "string",
"description": "The timestamp in this field shows the date/time of the payment dispute activity.2019-08-04T19:09:02.768Z
."
},
"activityType": {
"type": "string",
"description": "This enumeration value indicates the type of activity that occured on the payment dispute. For example, a value of DISPUTE_OPENED
is returned when a payment disute is first created, a value indicating the seller's decision on the dispute, such as SELLER_CONTEST
, is returned when seller makes a decision to accept or contest dispute, and a value of DISPUTE_CLOSED
is returned when a payment disute is resolved. See ActivityEnum for an explanation of each of the values that may be returned here. For implementation help, refer to eBay API documentation"
},
"actor": {
"type": "string",
"description": "This enumeration value indicates the actor that performed the action. Possible values include the BUYER
, SELLER
, CS_AGENT
(eBay customer service), or SYSTEM
. For implementation help, refer to eBay API documentation"
}
},
"description": "This type is used by each recorded activity on a payment dispute, from creation to resolution."
},
"PaymentDisputeActivityHistory": {
"type": "object",
"properties": {
"activity": {
"type": "array",
"description": "This array holds all activities of a payment dispute, from creation to resolution. For each activity, the activity type, the actor, and a timestamp is shown. The getActivities response is dynamic, and grows with each recorded activity.",
"items": {
"$ref": "#/components/schemas/PaymentDisputeActivity"
}
}
},
"description": "This type is used by the base response of the getActivities method, and includes a log of all activities of a payment dispute, from creation to resolution."
},
"PaymentDisputeOutcomeDetail": {
"type": "object",
"properties": {
"fees": {
"description": "This container will show the dollar value of any fees associated with the payment dispute. This container is only returned if there are fees associated with the payment dispute.",
"$ref": "#/components/schemas/SimpleAmount"
},
"protectedAmount": {
"description": "This container shows the amount of money that the seller is protected against in a payment dispute under eBay's seller protection policy.",
"$ref": "#/components/schemas/SimpleAmount"
},
"protectionStatus": {
"type": "string",
"description": "This enumeration value indicates if the seller is fully protected, partially protected, or not protected by eBay for the payment dispute. This field is always returned once the payment dispute is resolved. For implementation help, refer to eBay API documentation"
},
"reasonForClosure": {
"type": "string",
"description": "The enumeration value returned in this field indicates the outcome of the payment dispute for the seller. This field is always returned once the payment dispute is resolved. For implementation help, refer to eBay API documentation"
},
"recoupAmount": {
"description": "This container shows the dollar amount being recouped from the seller. This container is empty if the seller wins the payment dispute or if the seller is fully protected by eBay's seller protection policy.",
"$ref": "#/components/schemas/SimpleAmount"
},
"totalFeeCredit": {
"description": "This container shows the amount of money in selling fee credits due back to the seller after a payment dispute is settled.",
"$ref": "#/components/schemas/SimpleAmount"
}
},
"description": "This type is used by the resolution container that is returned for payment disputes that have been resolved."
},
"PaymentDisputeSummary": {
"type": "object",
"properties": {
"amount": {
"description": "This container shows the dollar value associated with the payment dispute in the currency used by the seller's marketplace. This container is returned for all payment disputes returned in the response.",
"$ref": "#/components/schemas/SimpleAmount"
},
"buyerUsername": {
"type": "string",
"description": "This is the buyer's eBay user ID. This field is returned for all payment disputes returned in the response."
},
"closedDate": {
"type": "string",
"description": "The timestamp in this field shows the date/time when the payment dispute was closed, so this field is only returned for payment disputes in the CLOSED
state.2019-08-04T19:09:02.768Z
."
},
"openDate": {
"type": "string",
"description": "The timestamp in this field shows the date/time when the payment dispute was opened. This field is returned for payment disputes in all states.2019-08-04T19:09:02.768Z
."
},
"orderId": {
"type": "string",
"description": "This is the unique identifier of the order involved in the payment dispute."
},
"paymentDisputeId": {
"type": "string",
"description": "This is the unique identifier of the payment dispute. This identifier is automatically created by eBay once the payment dispute comes into the eBay system. This identifier is passed in at the end of the getPaymentDispute call URI to retrieve a specific payment dispute. The getPaymentDispute method returns more details about a payment dispute than the getPaymentDisputeSummaries method."
},
"paymentDisputeStatus": {
"type": "string",
"description": "The enumeration value in this field gives the current status of the payment dispute. For implementation help, refer to eBay API documentation"
},
"reason": {
"type": "string",
"description": "The enumeration value in this field gives the reason why the buyer initiated the payment dispute. See DisputeReasonEnum type for a description of the supported reasons that buyers can give for initiating a payment dispute. For implementation help, refer to eBay API documentation"
},
"respondByDate": {
"type": "string",
"description": "The timestamp in this field shows the date/time when the seller must response to a payment dispute, so this field is only returned for payment disputes in the ACTION_NEEDED
state. For payment disputes that require action by the seller, that same seller must call getPaymentDispute to see the next action(s) that they can take against the payment dispute.2019-08-04T19:09:02.768Z
."
}
},
"description": "This type is used by each payment dispute that is returned with the getPaymentDisputeSummaries method."
},
"PaymentHold": {
"type": "object",
"properties": {
"expectedReleaseDate": {
"type": "string",
"description": "The date and time that the payment being held is expected to be released to the seller. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field will be returned if known by eBay. [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"holdAmount": {
"description": "The monetary amount of the payment being held. This field is always returned with the paymentHolds array. ",
"$ref": "#/components/schemas/Amount"
},
"holdReason": {
"type": "string",
"description": "The reason that the payment is being held. A seller's payment may be held for a number of reasons, including when the seller is new, the seller's level is below standard, or if a return case or 'Significantly not as described' case is pending against the seller. This field is always returned with the paymentHolds array."
},
"holdState": {
"type": "string",
"description": "The current stage or condition of the hold. This field is always returned with the paymentHolds array.HELD
HELD_PENDING
NOT_HELD
RELEASE_CONFIRMED
RELEASE_FAILED
RELEASE_PENDING
RELEASED
[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"sellerActionsToRelease": {
"type": "array",
"description": "A list of one or more possible actions that the seller can take to expedite the release of the payment hold.",
"items": {
"$ref": "#/components/schemas/SellerActionsToRelease"
}
}
},
"description": "This type contains information about a hold placed on a payment to a seller for an order, including the reason why the buyer's payment for the order is being held, the expected release date of the funds into the seller's account, the current state of the hold, and the actual release date if the payment has been released, and possible actions the seller can take to expedite the payout of funds into their account."
},
"PaymentSummary": {
"type": "object",
"properties": {
"payments": {
"type": "array",
"description": "This array consists of payment information for the order, including payment status, payment method, payment amount, and payment date. This array is always returned, although some of the fields under this container will not be returned until payment has been made.",
"items": {
"$ref": "#/components/schemas/Payment"
}
},
"refunds": {
"type": "array",
"description": "This array is always returned, but is returned as an empty array unless the seller has submitted a partial or full refund to the buyer for the order. If a refund has occurred, the refund amount and refund date will be shown for each refund.",
"items": {
"$ref": "#/components/schemas/OrderRefund"
}
},
"totalDueSeller": {
"description": "This is the total price that the seller receives for the entire order after all costs (item cost, delivery cost, taxes) are added for all line items, minus any discounts and/or promotions for any of the line items. Note that this value is subject to change before payment is actually made by the buyer (if the paymentStatus value was PENDING
or FAILED
), or if a partial or full refund occurs with the order.STATE_SALES_TAX
: USPROVINCE_SALES_TAX
: Provincial Sales Tax in CanadaGST
: Canada, Australia, and New ZealandVAT
: VAT collected for UK and EU countries\"number\" : \"4088084356\"
PENDING
or PASSED
. The possible values returned here are NOT_AUTHENTIC
, NOT_AS_DESCRIBED
, CUSTOMIZED
, MISCATEGORIZED
, or NOT_AUTHENTIC_NO_RETURN
. For implementation help, refer to eBay API documentation"
},
"status": {
"type": "string",
"description": "The value in this field indicates whether the order line item has passed or failed the authenticity verification inspection, or if the inspection and/or results are still pending. The possible values returned here are PENDING
, PASSED
, FAILED
, or PASSED_WITH_EXCEPTION
. For implementation help, refer to eBay API documentation"
}
},
"description": "This type is used to provide the status and outcome of an order line item going through the Authenticity Guarantee verification process."
},
"PricingSummary": {
"type": "object",
"properties": {
"adjustment": {
"description": "This container shows the total amount of any adjustments that were applied to the cost of the item(s) in the order. This amount does not include shipping, discounts, fixed fees, or taxes.TAX_BREAKDOWN
.",
"$ref": "#/components/schemas/Amount"
},
"priceDiscount": {
"description": "This container shows the total amount of all item price discounts (including promotions) that apply to the order and reduce its cost to the buyer. This should be a negative real number. TAX_BREAKDOWN
. If the fieldGroups query parameter is not set to TAX_BREAKDOWN
, 'Collect and Remit' will not be added into this total value.STATE_SALES_TAX
: US state-mandated sales taxPROVINCE_SALES_TAX
: Provincial Sales Tax in CanadaGST
: 'Good and Services' tax in Canada, Australia, and New ZealandVAT
: VAT collected for UK and EU countriesFAILED
). This identifier can be used to track the status of the refund through a getOrder or getOrders call. For order-level refunds, check the paymentSummary.refunds.refundId field in the getOrder/getOrders response, and for line item level refunds, check the lineItems.refunds.refundId field(s) in the getOrder/getOrders response."
},
"refundStatus": {
"type": "string",
"description": "The value returned in this field indicates the success or failure of the refund operation. A successful issueRefund operation should result in a value of PENDING
. A failed issueRefund operation should result in a value of FAILED
, and an HTTP status code and/or and API error code may also get returned to possibly indicate the issue.9405509699937003457459
. This eBay-generated value is created with a successful createShippingFulfillment call."
},
"lineItems": {
"type": "array",
"description": "This array contains a list of one or more line items (and purchased quantity) to which the fulfillment applies.",
"items": {
"$ref": "#/components/schemas/LineItemReference"
}
},
"shipmentTrackingNumber": {
"type": "string",
"description": "The tracking number provided by the shipping carrier for the package shipped in this fulfillment. This field is returned if available."
},
"shippedDate": {
"type": "string",
"description": "The date and time that the fulfillment package was shipped. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field should only be returned if the package has been shipped.[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
"
},
"shippingCarrierCode": {
"type": "string",
"description": "The eBay code identifying the shipping carrier for this fulfillment. This field is returned if available. [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2015-08-04T19:09:02.768Z
ShippingCarrierDetails
. Each valid shipping carrier enumeration value is returned in a ShippingCarrierDetails.ShippingCarrier field in the response payload."
},
"trackingNumber": {
"type": "string",
"description": "The tracking number provided by the shipping carrier for this fulfillment. The seller should be careful that this tracking number is accurate since the buyer will use this tracking number to track shipment, and eBay has no way to verify the accuracy of this number.999
.0
.",
"format": "int32"
},
"warnings": {
"type": "array",
"description": "This array is only returned if one or more errors or warnings occur with the call request.",
"items": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "This type contains the specifications for the entire collection of shipping fulfillments that are associated with the order specified by a getShippingFulfillments call. The fulfillments container returns an array of all the fulfillments in the collection."
},
"ShippingStep": {
"type": "object",
"properties": {
"shippingCarrierCode": {
"type": "string",
"description": "The unique identifier of the shipping carrier being used to ship the line item. ShippingServiceDetails
. Each valid shipping service option (returned in ShippingServiceDetails.ShippingService field) and corresponding shipping carrier (returned in ShippingServiceDetails.ShippingCarrier field) is returned in response payload."
},
"shipTo": {
"description": "This container consists of shipping and contact information about the individual or organization to whom the fulfillment package will be shipped.FULFILLED_BY_EBAY
, there will be no shipTo address displayed.true
. The international shipping provider uses the shipToReferenceId value as the primary reference number to retrieve the relevant details about the buyer, the order, and the fulfillment, so the shipment can be completed. USD
for US site) that indicates the currency of the amount in the value field. Both the value and currency fields are always returned with the amount container. For implementation help, refer to eBay API documentation"
},
"value": {
"type": "string",
"description": "The monetary amount of the payment dispute. Both the value and currency fields are always returned with the amount container."
}
},
"description": "This type defines the monetary value of the payment dispute, and the currency used."
},
"Tax": {
"type": "object",
"properties": {
"amount": {
"description": "The monetary amount of the tax. The taxes array is always returned for each line item in the order, but this amount will only be returned when the line item is subject to any type of sales tax. ",
"$ref": "#/components/schemas/Amount"
},
"taxType": {
"type": "string",
"description": "Tax type. This field is only available when fieldGroups is set to TAX_BREAKDOWN
. If the order has fees, a breakdown of the fees is also provided. For implementation help, refer to eBay API documentation"
}
},
"description": "This type contains information about any sales tax applied to a line item."
},
"TaxAddress": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city name that can be used by sellers for tax purpose."
},
"countryCode": {
"type": "string",
"description": "The country code that can be used by sellers for tax purpose, represented as a two-letter ISO 3166-1 alpha-2 country code. For example, US represents the United States, and DE represents Germany. For implementation help, refer to eBay API documentation"
},
"postalCode": {
"type": "string",
"description": "The postal code that can be used by sellers for tax purpose. Usually referred to as Zip codes in the US."
},
"stateOrProvince": {
"type": "string",
"description": "The state name that can be used by sellers for tax purpose."
}
},
"description": "This container consists of address information that can be used by sellers for tax purpose."
},
"TaxIdentifier": {
"type": "object",
"properties": {
"taxpayerId": {
"type": "string",
"description": "This value is the unique tax ID associated with the buyer. The type of tax identification is shown in the taxIdentifierType field."
},
"taxIdentifierType": {
"type": "string",
"description": "This enumeration value indicates the type of tax identification being used for the buyer. The different tax types are defined in the TaxIdentifierTypeEnum type. For implementation help, refer to eBay API documentation"
},
"issuingCountry": {
"type": "string",
"description": "This two-letter code indicates the country that issued the buyer's tax ID. The country that the two-letter code represents can be found in the CountryCodeEnum type, or in the ISO 3166 standard. For implementation help, refer to eBay API documentation"
}
},
"description": "This type is used by the taxIdentifier container that is returned in getOrder. The taxIdentifier container consists of taxpayer identification information for buyers from Italy, Spain, or Guatemala. It is currently only returned for orders occurring on the eBay Italy or eBay Spain marketplaces.