openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 205 kB

JSON

{"openapi":"3.0.0","servers":[{"description":"Production","url":"https://api.ebay.com{basePath}","variables":{"basePath":{"default":"/sell/fulfillment/v1"}}},{"description":"Production","url":"https://apiz.ebay.com{basePath}","variables":{"basePath":{"default":"/sell/fulfillment/v1"}}}],"info":{"contact":{"name":"eBay Inc.","x-twitter":"ebay"},"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.","license":{"name":"eBay API License Agreement","url":"https://go.developer.ebay.com/api-license-agreement"},"title":"Fulfillment API","version":"v1.20.0","x-apisguru-categories":["ecommerce"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://twitter.com/ebay/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json","version":"3.0"}],"x-providerName":"ebay.com","x-serviceName":"sell-fulfillment"},"paths":{"/order":{"get":{"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 filter parameter. You can alternatively specify a list of orders using the orderIds parameter. Include the optional fieldGroups query parameter set to <code>TAX_BREAKDOWN</code> to return a breakdown of the taxes and fees. The returned Order 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> Important: In this call, the cancelStatus.cancelRequests array is returned but is always empty. Use the getOrder call instead, which returns this array fully populated with information about any cancellation requests.","operationId":"getOrders","parameters":[{"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.","in":"query","name":"fieldGroups","required":false,"schema":{"type":"string"}},{"description":"One or more comma-separated criteria for narrowing down the collection of orders returned by this call. These criteria correspond to specific fields in the response payload. Multiple filter criteria combine to further restrict the results. Note: getOrders can return orders up to two years old. Do not set the <code>creationdate</code> filter to a date beyond two years in the past. Note: If the orderIds parameter is included in the request, the filter parameter will be ignored. The available criteria are as follows: <dl> <dt><code>creationdate</code></dt> <dd>The time period during which qualifying orders were created (the orders.creationDate field). In the URI, this is expressed as a starting timestamp, with or without an ending timestamp (in brackets). The timestamps are in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.For example: <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>lastmodifieddate</code></dt> <dd>The time period during which qualifying orders were last modified (the orders.modifiedDate field). In the URI, this is expressed as a starting timestamp, with or without an ending timestamp (in brackets). The timestamps are in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.For example: <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> Note: If creationdate and lastmodifieddate are both included, only creationdate is used. </dd> <dt><code>orderfulfillmentstatus</code></dt> <dd>The degree to which qualifying orders have been shipped (the orders.orderFulfillmentStatus field). In the URI, this is expressed as one of the following value combinations: <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> Note: 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. </dd> </dl> Here is an example of a getOrders call using all of these filters: <code>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</code> Note: This call requires that certain special characters in the URI query string be percent-encoded:     <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> This query filter example uses these codes. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/fulfillment/types/api:FilterField","in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"description":"The number of orders to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to <code>10</code> and limit is set to <code>10</code>, the call retrieves orders 11 thru 20 from the result set. If a limit is not set, the limit defaults to 50 and returns up to 50 orders. If a requested limit is more than 200, the call fails and returns an error. Note: This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>. If the orderIds parameter is included in the request, this parameter will be ignored. Maximum: <code>200</code> Default: <code>50</code>","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"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 <code>0</code> and a limit 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 offset is <code>10</code> and limit is <code>20</code>, the first page of the response contains items 11-30 from the complete result set. Default: 0","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of the unique identifiers of the orders to retrieve (maximum 50). If one or more order ID values are specified through the orderIds query parameter, all other query parameters will be ignored. Note: getOrders can return orders up to two years old. Do not provide the orderId for an order created more than two years in the past.","in":"query","name":"orderIds","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSearchPagedCollection"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"30700":{"category":"REQUEST","description":"Invalid filter name: {fieldname}","domain":"API_FULFILLMENT"},"30800":{"category":"REQUEST","description":"Invalid filter value {fieldvalue} for filter {fieldname}","domain":"API_FULFILLMENT"},"30810":{"category":"REQUEST","description":"Invalid date format","domain":"API_FULFILLMENT"},"30820":{"category":"REQUEST","description":"Start date is missing","domain":"API_FULFILLMENT"},"30830":{"category":"REQUEST","description":"Time range between start date and end date must be within '{allowedTime}' years.","domain":"API_FULFILLMENT"},"30840":{"category":"REQUEST","description":"Start date should be before end date","domain":"API_FULFILLMENT"},"30850":{"category":"REQUEST","description":"Start and end dates can't be in the future","domain":"API_FULFILLMENT"},"30900":{"category":"REQUEST","description":"Exceeded maximum number of order IDs (the current limit is <code>50</code>)","domain":"API_FULFILLMENT"},"31000":{"category":"REQUEST","description":"Invalid offset: {offsetvalue}","domain":"API_FULFILLMENT"},"31100":{"category":"REQUEST","description":"Invalid limit: {limitvalue}","domain":"API_FULFILLMENT"},"32800":{"category":"REQUEST","description":"Invalid field group: {fieldGroup}","domain":"API_FULFILLMENT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"30500":{"category":"APPLICATION","description":"System error","domain":"API_FULFILLMENT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.fulfillment","https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly"]}],"tags":["order"]}},"/order/{orderId}":{"get":{"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 <code>TAX_BREAKDOWN</code> to return a breakdown of the taxes and fees. The returned Order 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":[{"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.","in":"query","name":"fieldGroups","required":false,"schema":{"type":"string"}},{"description":"The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the orders.orderId field.Note: getOrders can return orders up to two years old. Do not provide the orderId for an order created more than two years in the past.","in":"path","name":"orderId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"32100":{"category":"REQUEST","description":"Invalid order ID: {orderId}","domain":"API_FULFILLMENT"},"32800":{"category":"REQUEST","description":"Invalid field group: {fieldGroup}","domain":"API_FULFILLMENT"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"30500":{"category":"APPLICATION","description":"System error","domain":"API_FULFILLMENT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.fulfillment","https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly"]}],"tags":["order"]}},"/order/{orderId}/shipping_fulfillment":{"get":{"description":"Use this call to retrieve the contents of all fulfillments currently defined for a specified order based on the order's unique identifier, orderId. This value is returned in the getOrders call's members.orderId field when you search for orders by creation date or shipment status.","operationId":"getShippingFulfillments","parameters":[{"description":"The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the orders.orderId field.","in":"path","name":"orderId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingFulfillmentPagedCollection"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"32100":{"category":"REQUEST","description":"Invalid order ID: {orderId}","domain":"API_FULFILLMENT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"30500":{"category":"APPLICATION","description":"System error","domain":"API_FULFILLMENT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.fulfillment","https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly"]}],"tags":["shipping_fulfillment"]},"post":{"description":"When you group an order's line items into one or more packages, each package requires a corresponding plan for handling, addressing, and shipping; this is a shipping fulfillment. For each package, execute this call once to generate a shipping fulfillment associated with that package. Note: A single line item in an order can consist of multiple units of a purchased item, and one unit can consist of multiple parts or components. Although these components might be provided by the manufacturer in separate packaging, the seller must include all components of a given line item in the same package. Before using this call for a given package, you must determine which line items are in the package. If the package has been shipped, you should provide the date of shipment in the request. If not provided, it will default to the current date and time.","operationId":"createShippingFulfillment","parameters":[{"description":"The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the orders.orderId field.","in":"path","name":"orderId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingFulfillmentDetails","description":"fulfillment payload"}}},"description":"fulfillment payload","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Created. The call also returns the following location code: <code>{ENV}/sell/fulfillment/v1/order/{ORDERID}/shipping_fulfillment/{FULFILLMENTID}</code> 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":{"description":"A successful call returns the following location code: <code>{ENV}/sell/fulfillment/v1/order/{ORDERID}/shipping_fulfillment/{FULFILLMENTID}</code> 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.","type":"string"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"32100":{"category":"REQUEST","description":"Invalid Order Id: {orderId}","domain":"API_FULFILLMENT"},"32200":{"category":"REQUEST","description":"Invalid line item id: {lineItemId}","domain":"API_FULFILLMENT"},"32210":{"category":"REQUEST","description":"Duplicate line item in the request","domain":"API_FULFILLMENT"},"32300":{"category":"REQUEST","description":"Invalid shipment tracking number or carrier","domain":"API_FULFILLMENT"},"32400":{"category":"REQUEST","description":"Requested user is suspended","domain":"API_FULFILLMENT"},"32500":{"category":"REQUEST","description":"Invalid shipped date","domain":"API_FULFILLMENT"},"32600":{"category":"REQUEST","description":"Invalid input data","domain":"API_FULFILLMENT"},"34100":{"category":"REQUEST","description":"Maximum tracking number for order is exceeded","domain":"API_FULFILLMENT"},"34200":{"category":"REQUEST","description":"Line Items contain Global Shipping Program and non-Global Shipping Program orders","domain":"API_FULFILLMENT"},"34300":{"category":"REQUEST","description":"Mark As Shipped for multiple Global Shipping Program line items is not supported","domain":"API_FULFILLMENT"},"34500":{"category":"REQUEST","description":"Please use PUT operation for updating shipping fulfillment","domain":"API_FULFILLMENT"}}}},"409":{"description":"Conflict"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"30500":{"category":"APPLICATION","description":"System error","domain":"API_FULFILLMENT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.fulfillment"]}],"tags":["shipping_fulfillment"]}},"/order/{orderId}/shipping_fulfillment/{fulfillmentId}":{"get":{"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":[{"description":"The unique identifier of the fulfillment. This eBay-generated value was created by the Create Shipping Fulfillment call, and returned by the getShippingFulfillments call in the fulfillments.fulfillmentId field; for example, <code>9405509699937003457459</code>.","in":"path","name":"fulfillmentId","required":true,"schema":{"type":"string"}},{"description":"The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the orders.orderId field.","in":"path","name":"orderId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingFulfillment"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"32100":{"category":"REQUEST","description":"Invalid order ID: {orderId}","domain":"API_FULFILLMENT"},"32110":{"category":"REQUEST","description":"Invalid shipping fulfillment ID: {fulfillmentId}","domain":"API_FULFILLMENT"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"30500":{"category":"APPLICATION","description":"System error","domain":"API_FULFILLMENT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.fulfillment","https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly"]}],"tags":["shipping_fulfillment"]}},"/order/{order_id}/issue_refund":{"post":{"description":"<div class=\"msgbox_important\">Important! \">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 <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.</div> This method allows a seller to issue a full or partial refund to a buyer for an order. Full or partial refunds can be issued at the order level or line item level. The refunds issued through this method are processed asynchronously, so the refund will not show as 'Refunded' right away. A seller will have to make a subsequent <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":[{"description":"The unique identifier of the order. Order IDs are returned in the getOrders method (and GetOrders call of Trading API). The issueRefund method supports the legacy API Order IDs and REST API order IDs.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueRefundRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund"}}},"description":"OK"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"34901":{"category":"REQUEST","description":"Order id can't be null or empty.","domain":"API_FULFILLMENT"},"34902":{"category":"REQUEST","description":"Request can't be empty.","domain":"API_FULFILLMENT"},"34903":{"category":"REQUEST","description":"The refund reason must be specified.","domain":"API_FULFILLMENT"},"34905":{"category":"REQUEST","description":"Either orderLevelRefundAmount or refundItems must be specified.","domain":"API_FULFILLMENT"},"34906":{"category":"REQUEST","description":"The amount value must be specified.","domain":"API_FULFILLMENT"},"34907":{"category":"REQUEST","description":"The amount value must be positive and within two decimals.","domain":"API_FULFILLMENT"},"34908":{"category":"REQUEST","description":"The amount currency must be specified.","domain":"API_FULFILLMENT"},"34909":{"category":"REQUEST","description":"The amount currency isn't correct.","domain":"API_FULFILLMENT"},"34910":{"category":"REQUEST","description":"Either legacyReference or lineItemId must be specified for item level refund.","domain":"API_FULFILLMENT"},"34911":{"category":"REQUEST","description":"Legacy item id must be specified for item level refund if you use legacyReference.","domain":"API_FULFILLMENT"},"34912":{"category":"REQUEST","description":"Legacy transaction id must be specified for item level refund if you use legacyReference.","domain":"API_FULFILLMENT"},"34914":{"category":"REQUEST","description":"Can't find the item in the order.","domain":"API_FULFILLMENT"},"34915":{"category":"REQUEST","description":"The refund amount exceeds order amount.","domain":"API_FULFILLMENT"},"34916":{"category":"BUSINESS","description":"A post-transaction case exists on this order, seller refund can't be triggered.","domain":"API_FULFILLMENT"},"34917":{"category":"BUSINESS","description":"This order was already refunded.","domain":"API_FULFILLMENT"},"34920":{"category":"BUSINESS","description":"It's too late to issue a refund for this order.","domain":"API_FULFILLMENT"},"34921":{"category":"REQUEST","description":"The comment exceeds the length limit, please make sure it doesn't exceed 1000 characters.","domain":"API_FULFILLMENT"},"34922":{"category":"REQUEST","description":"Refund can't be issued while previous refund is processing.","domain":"API_FULFILLMENT"},"34923":{"category":"REQUEST","description":"Refund cannot be issued for this type of order.","domain":"API_FULFILLMENT"}}}},"403":{"description":"Access Forbidden"},"404":{"description":"Resource Not found","x-response-codes":{"errors":{"34913":{"category":"REQUEST","description":"Can not find the order.","domain":"API_FULFILLMENT"}}}},"409":{"description":"Conflict","x-response-codes":{"errors":{"34918":{"category":"BUSINESS","description":"This is not an eBay managed payments order.","domain":"API_FULFILLMENT"},"34919":{"category":"REQUEST","description":"Unauthorized access.","domain":"API_FULFILLMENT"},"34924":{"category":"BUSINESS","description":"The item refund amount exceeds the item remaining amount.","domain":"API_FULFILLMENT"},"34925":{"category":"BUSINESS","description":"The refund operation could not be completed with any of the payment methods saved to the seller's account.","domain":"API_FULFILLMENT"},"34926":{"category":"BUSINESS","description":"A suitable payment method could not be found for the refund operation. Please resolve in Seller Hub.","domain":"API_FULFILLMENT"},"34927":{"category":"BUSINESS","description":"The selected payment method for the refund operation was invalid or declined.","domain":"API_FULFILLMENT"},"34928":{"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.","domain":"API_FULFILLMENT"},"34929":{"category":"REQUEST","description":"You cannot refund this order yet since the buyer payment has not been processed. Please try again later.","domain":"API_FULFILLMENT"},"34930":{"category":"REQUEST","description":"Default payment method limit exceeded. Please use a different payment option or try again later.","domain":"API_FULFILLMENT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"34900":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FULFILLMENT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.finances"]}],"summary":"Issue Refund","tags":["order"]}},"/payment_dispute/{payment_dispute_id}":{"get":{"description":"This method retrieves detailed information on a specific payment dispute. The payment dispute identifier is passed in as path parameter at the end of the call URI. Below is a summary of the information that is retrieved:<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":[{"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 paymentDisputeId field in the getPaymentDisputeSummaries response.","in":"path","name":"payment_dispute_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentDispute"}}},"description":"Success"},"400":{"description":"Bad Request"},"404":{"description":"Invalid Payment Dispute Id","x-response-codes":{"errors":{"33001":{"category":"REQUEST","description":"Invalid Payment Dispute Id","domain":"API_FULFILLMENT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"33000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FULFILLMENT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.payment.dispute"]}],"summary":"Get Payment Dispute Details","tags":["payment_dispute"]},"servers":[{"description":"Production","url":"https://apiz.ebay.com{basePath}","variables":{"basePath":{"default":"/sell/fulfillment/v1"}}}]},"/payment_dispute/{payment_dispute_id}/accept":{"post":{"description":"This method is used if the seller wishes to accept a payment dispute. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method. The revision field in the request payload is required, and the returnAddress field should be supplied if the seller is expecting the buyer to return the item. See the Request Payload section for more information on theste fields.","operationId":"acceptPaymentDispute","parameters":[{"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 paymentDisputeId field in the getPaymentDisputeSummaries response. This path parameter is required, and the actual identifier value is passed in right after the payment_dispute resource. See the Resource URI above.","in":"path","name":"payment_dispute_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptPaymentDisputeRequest"}}},"required":false},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"33100":{"category":"REQUEST","description":"Invalid input request","domain":"API_FULFILLMENT"}}}},"404":{"description":"Not Found"},"409":{"description":"Conflict","x-response-codes":{"errors":{"33011":{"category":"REQUEST","description":"There was a change in payment dispute attributes. Please use get payment dispute api to get latest details.","domain":"API_FULFILLMENT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"33000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FULFILLMENT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.payment.dispute"]}],"summary":"Accept Payment Dispute","tags":["payment_dispute"]},"servers":[{"description":"Production","url":"https://apiz.ebay.com{basePath}","variables":{"basePath":{"default":"/sell/fulfillment/v1"}}}]},"/payment_dispute/{payment_dispute_id}/activity":{"get":{"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":[{"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 paymentDisputeId field in the getPaymentDisputeSummaries response. This path parameter is required, and the actual identifier value is passed in right after the payment_dispute resource. See the Resource URI above.","in":"path","name":"payment_dispute_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentDisputeActivityHistory"}}},"description":"Success"},"400":{"description":"Bad Request"},"404":{"description":"Invalid Payment Dispute Id","x-response-codes":{"errors":{"33001":{"category":"REQUEST","description":"Invalid Payment Dispute Id","domain":"API_FULFILLMENT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"33000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FULFILLMENT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.payment.dispute"]}],"summary":"Get Payment Dispute Activity","tags":["payment_dispute"]},"servers":[{"description":"Production","url":"https://apiz.ebay.com{basePath}","variables":{"basePath":{"default":"/sell/fulfillment/v1"}}}]},"/payment_dispute/{payment_dispute_id}/add_evidence":{"post":{"description":"This method is used by the seller to add one or more evidence files to address a payment dispute initiated by the buyer. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method. Note: All evidence files should be uploaded using addEvidence and updateEvidence before the seller decides to contest the payment dispute. Once the seller has officially contested the dispute (using contestPaymentDispute or through My eBay), the addEvidence and updateEvidence methods can no longer be used. In the evidenceRequests array of the getPaymentDispute response, eBay prompts the seller with the type of evidence file(s) that will be needed to contest the payment dispute. The file(s) to add are identified through the files array in the request payload. Adding one or more new evidence files for a payment dispute triggers the creation of an evidence file, and the unique identifier for the new evidence file is automatically generated and returned in the evidenceId field of the addEvidence response payload upon a successful call. The type of evidence being added should be specified in the evidenceType field. All files being added (if more than one) should correspond to this evidence type. Upon a successful call, an evidenceId value is returned in the response. This indicates that a new evidence set has been created for the payment dispute, and this evidence set includes the evidence file(s) that were passed in to the fileId array. The evidenceId value will be needed if the seller wishes to add to the evidence set by using the updateEvidence method, or if they want to retrieve a specific evidence file within the evidence set by using the fetchEvidenceContent method.","operationId":"addEvidence","parameters":[{"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 paymentDisputeId field in the getPaymentDisputeSummaries response. This path parameter is required, and the actual identifier value is passed in right after the payment_dispute resource. See the Resource URI above.","in":"path","name":"payment_dispute_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddEvidencePaymentDisputeRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddEvidencePaymentDisputeResponse"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"33003":{"category":"REQUEST","description":"Invalid Evidence File Id","domain":"API_FULFILLMENT"},"33007":{"category":"REQUEST","description":"Invalid line items.","domain":"API_FULFILLMENT"},"33008":{"category":"REQUEST","description":"Invalid evidence type.","domain":"API_FULFILLMENT"},"33009":{"category":"REQUEST","description":"User did not echo back the evidence metadata correctly.","domain":"API_FULFILLMENT"},"33103":{"category":"REQUEST","description":"Exceed allowed file count","domain":"API_FULFILLMENT"},"33104":{"category":"REQUEST","description":"The combined size of attached files should be 1.5MB or less.","domain":"API_FULFILLMENT"}}}},"404":{"description":"Not Found","x-response-codes":{"errors":{"33001":{"category":"REQUEST","description":"Invalid Payment Dispute Id","domain":"API_FULFILLMENT"}}}},"409":{"description":"Conflict","x-response-codes":{"errors":{"33004":{"category":"REQUEST","description":"Upload file for evidence is not permitted for given payment dispute state.","domain":"API_FULFILLMENT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"33000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FULFILLMENT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.payment.dispute"]}],"summary":"Add an Evidence File","tags":["payment_dispute"]},"servers":[{"description":"Production","url":"https://apiz.ebay.com{basePath}","variables":{"basePath":{"default":"/sell/fulfillment/v1"}}}]},"/payment_dispute/{payment_dispute_id}/contest":{"post":{"description":"This method is used if the seller wishes to contest a payment dispute initiated by the buyer. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method. Note: Before contesting a payment dispute, the seller must upload all supporting files using the addEvidence and updateEvidence methods. Once the seller has officially contested the dispute (using contestPaymentDispute), the addEvidence and updateEvidence methods can no longer be used. In the evidenceRequests array of the getPaymentDispute response, eBay prompts the seller with the type of supporting file(s) that will be needed to contest the payment dispute. If a seller decides to contest a payment dispute, that seller should be prepared to provide supporting documents such as proof of delivery, proof of authentication, or other documents. The type of supporting documents that the seller will provide will depend on why the buyer filed the payment dispute. The revision field in the request payload is required, and the returnAddress field should be supplied if the seller is expecting the buyer to return the item. See the Request Payload section for more information on these fields.","operationId":"contestPaymentDispute","parameters":[{"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 paymentDisputeId field in the getPaymentDisputeSummaries response. This path parameter is required, and the actual identifier value is passed in right after the payment_dispute resource. See the Resource URI above.","in":"path","name":"payment_dispute_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContestPaymentDisputeRequest"}}},"required":false},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"33100":{"category":"REQUEST","description":"Invalid input request","domain":"API_FULFILLMENT"}}}},"404":{"description":"Not Found"},"409":{"description":"Conflict","x-response-codes":{"errors":{"33011":{"category":"REQUEST","description":"There was a change in payment dispute attributes. Please use get payment dispute api to get latest details.","domain":"API_FULFILLMENT"},"33101":{"category":"REQUEST","description":"Invalid payment dispute state","domain":"API_FULFILLMENT"},"33102":{"category":"REQUEST","description":"No evidence available for contest","domain":"API_FULFILLMENT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"33000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FULFILLMENT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.payment.dispute"]}],"summary":"Contest Payment Dispute","tags":["payment_dispute"]},"servers":[{"description":"Production","url":"https://apiz.ebay.com{basePath}","variables":{"basePath":{"default":"/sell/fulfillment/v1"}}}]},"/payment_dispute/{payment_dispute_id}/fetch_evidence_content":{"get":{"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>payment_dispute_id: the identifier of the payment dispute. The identifier of each payment dispute is returned in the getPaymentDisputeSummaries response.</li><li>evidence_id: the identifier of the evidential file set. The identifier of an evidential file set for a payment dispute is returned under the evidence array in the getPaymentDispute response.</li><li>file_id: the identifier of an evidential file. This file must belong to the evidential file set identified through the evidence_id query parameter. The identifier of each evidential file is returned under the evidence.files array in the getPaymentDispute response.</li></ul>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":[{"description":"The identifier of the payment dispute. The identifier of each payment dispute is returned in the getPaymentDisputeSummaries response. This identifier is passed in as a path parameter at the end of the call URI.","in":"path","name":"payment_dispute_id","required":true,"schema":{"type":"string"}},{"description":"The identifier of the evidential file set. The identifier of an evidential file set for a payment dispute is returned under the evidence array in the getPaymentDispute response. Below is an example of the syntax to use for this query parameter: <code>evidence_id=12345678</code>","in":"query","name":"evidence_id","required":true,"schema":{"type":"string"}},{"description":"The identifier of an evidential file. This file must belong to the evidential file set identified through the evidence_id query parameter. The identifier of each evidential file is returned under the evidence.files array in the getPaymentDispute response. Below is an example of the syntax to use for this query parameter: <code>file_id=12345678</code> ","in":"query","name":"file_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"33002":{"category":"REQUEST","description":"Invalid Evidence Id","domain":"API_FULFILLMENT"},"33003":{"category":"REQUEST","description":"Invalid Evidence File Id","domain":"API_FULFILLMENT"}}}},"404":{"description":"Invalid Payment Dispute Id","x-response-codes":{"errors":{"33001":{"category":"REQUEST","description":"Invalid Payment Dispute Id","domain":"API_FULFILLMENT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"33000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_FULFILLMENT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.payment.dispute"]}],"summary":"Get Payment Dispute Evidence File","tags":["payment_dispute"]},"servers":[{"description":"Production","url":"https://apiz.ebay.com{basePath}","variables":{"basePath":{"default":"/sell/fulfillment/v1"}}}]},"/payment_dispute/{payment_dispute_id}/update_evidence":{"post":{"description":"This method is used by the seller to update an existing evidence set for a payment dispute with one or more evidence files. The unique identifier of the payment dispute is passed in as a path parameter, and unique identifiers for payment disputes can be retrieved with the getPaymentDisputeSummaries method. Note: All evidence files should be uploaded using addEvidence and updateEvidence before the seller decides to contest the payment dispute. Once the seller has officially contested the dispute (using contestPaymentDispute or through My eBay), the addEvidence and updateEvidence methods can no longer be used. In the evidenceRequests array of the getPaymentDispute response, eBay prompts the seller with the type of evidence file(s) that will be needed to contest the payment dispute. The unique identifier of the evidence set to update is specified through the evidenceId field, and the file(s) to add are identified through the files array in the request payload. The unique identifier for an evidence file is automatically generated and returned in the fileId field of the uploadEvidence response payload upon a successful call. Sellers must make sure to capture the fileId value for each evidence file that is uploaded with the uploadEvidence method. The type of evidence being added should be specified in the evidenceType field. All files being added (if more than one) should correspond to this evidence type. Upon a successful call, an http status code of <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 fetchEvidenceContent method, passing in the proper evidenceId and fileId values.","operationId":"updateEvidence","parameters":[{"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 i