eBay Order API

The Order API from eBay — 3 operation(s) for order.

Documentation

📖
Documentation
https://developer.ebay.com/api-docs/sell/account/static/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/sell/analytics/static/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/sell/compliance/resources/methods
📖
Documentation
https://developer.ebay.com/api-docs/sell/feed/resources/methods
📖
Documentation
https://developer.ebay.com/api-docs/buy/browse/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/buy/deal/resources/methods
📖
Documentation
https://developer.ebay.com/api-docs/buy/marketing/resources/methods
📖
Documentation
https://developer.ebay.com/api-docs/buy/marketplace-insights/resources/methods
📖
Documentation
https://developer.ebay.com/api-docs/buy/offer/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/buy/order/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/sell/finances/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/sell/fulfillment/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/sell/inventory/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/sell/logistics/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/sell/metadata/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/sell/negotiation/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/sell/recommendation/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/sell/stores/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/commerce/catalog/resources/methods
📖
Documentation
https://developer.ebay.com/api-docs/commerce/charity/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/commerce/identity/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/commerce/media/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/commerce/notification/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/commerce/taxonomy/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/commerce/translation/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/developer/client-registration/overview.html
📖
Documentation
https://developer.ebay.com/api-docs/developer/key-management/overview.html

Specifications

Other Resources

🔗
ReleaseNotes
https://developer.ebay.com/api-docs/buy/browse/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/buy/deal/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/buy/marketing/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/buy/marketplace-insights/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/buy/offer/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/buy/order/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/sell/finances/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/sell/fulfillment/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/sell/inventory/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/sell/logistics/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/sell/metadata/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/sell/negotiation/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/sell/recommendation/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/sell/stores/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/commerce/catalog/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/commerce/charity/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/commerce/identity/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/commerce/media/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/commerce/notification/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/commerce/taxonomy/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/commerce/translation/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/developer/client-registration/release-notes.html
🔗
ReleaseNotes
https://developer.ebay.com/api-docs/developer/key-management/release-notes.html

OpenAPI Specification

ebay-order-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: eBay Account Advertising_eligibility Order API
  description: The <b>Account API</b> gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information.  <br><br>For details on the availability of the methods in this API, see <a href="/api-docs/sell/account/overview.html#requirements">Account API requirements and restrictions</a>.
  contact:
    name: eBay Inc,
  license:
    name: eBay API License Agreement
    url: https://go.developer.ebay.com/api-license-agreement
  version: v1.9.2
servers:
- url: https://api.ebay.com{basePath}
  description: Production
  variables:
    basePath:
      default: /sell/account/v1
tags:
- name: Order
paths:
  /order/{orderId}:
    get:
      tags:
      - Order
      description: 'Use this call to retrieve the contents of an order based on its unique identifier, <i>orderId</i>. This value was returned in the <b> getOrders</b> call''s <b>orders.orderId</b> field when you searched for orders by creation date, modification date, or fulfillment status. Include the optional <b>fieldGroups</b> query parameter set to <code>TAX_BREAKDOWN</code> to return a breakdown of the taxes and fees. <br><br> The returned <b>Order</b> object contains information you can use to create and process fulfillments, including: <ul> <li>Information about the buyer and seller</li> <li>Information about the order''s line items</li> <li> The plans for packaging, addressing and shipping the order</li> <li>The status of payment, packaging, addressing, and shipping the order</li> <li>A summary of monetary amounts specific to the order such as pricing, payments, and shipping costs</li> <li>A summary of applied taxes and fees, and optionally a breakdown of each </li></ul>'
      operationId: getOrder
      parameters:
      - name: fieldGroups
        in: query
        description: This parameter lets you control what is returned in the response.<br><br><span class="tablenote"><b>Note:</b> The only presently supported value is <code>TAX_BREAKDOWN</code>. This field group adds addition fields to the response that return a breakdown of taxes and fees.</span>
        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.<br><br> Use the <a href="/api-docs/sell/fulfillment/resources/order/methods/getOrders" target="_blank ">getOrders</a> method to retrieve order IDs. Order ID values are also shown in My eBay/Seller Hub.<br><br><span class="tablenote"><strong>Note:</strong> <b>getOrders</b> can return orders up to two years old. Do not provide the <b>orderId</b> for an order created more than two years in the past.</span>
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '32100':
                domain: API_FULFILLMENT
                category: REQUEST
                description: 'Invalid order ID: {orderId}'
              '32800':
                domain: API_FULFILLMENT
                category: REQUEST
                description: 'Invalid field group: {fieldGroup}'
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '30500':
                domain: API_FULFILLMENT
                category: APPLICATION
                description: System error
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope/sell.fulfillment
        - https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly
  /order:
    get:
      tags:
      - Order
      description: 'Use this method to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the <b>filter</b> parameter. You can alternatively specify a list of orders using the <b>orderIds</b> parameter. Include the optional <b>fieldGroups</b> query parameter set to <code>TAX_BREAKDOWN</code> to return a breakdown of the taxes and fees. By default, when no filters are used this call returns all orders created within the last 90 days. <br><br> The returned <b>Order</b> objects contain information you can use to create and process fulfillments, including: <ul> <li>Information about the buyer and seller</li> <li>Information about the order''s line items</li> <li>The plans for packaging, addressing and shipping the order</li> <li>The status of payment, packaging, addressing, and shipping the order</li> <li>A summary of monetary amounts specific to the order such as pricing, payments, and shipping costs</li> <li>A summary of applied taxes and fees, and optionally a breakdown of each </li></ul> <br><br> <span class="tablenote"><strong>Important:</strong> In this call, the <b>cancelStatus.cancelRequests</b> array is returned but is always empty. Use the <b>getOrder</b> call instead, which returns this array fully populated with information about any cancellation requests.</span>'
      operationId: getOrders
      parameters:
      - name: fieldGroups
        in: query
        description: This parameter lets you control what is returned in the response.<br><br><span class="tablenote"><b>Note:</b> The only presently supported value is <code>TAX_BREAKDOWN</code>. This field group adds addition fields to the response that return a breakdown of taxes and fees.</span>
        required: false
        schema:
          type: string
      - name: filter
        in: query
        description: 'One or more comma-separated criteria for narrowing down the collection of orders returned by this call. These criteria correspond to specific fields in the response payload. Multiple filter criteria combine to further restrict the results. <br><br><span class="tablenote"><strong>Note:</strong> <b>getOrders</b> 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.</span><br><span class="tablenote"><strong>Note:</strong> If the <b>orderIds</b> parameter is included in the request, the <b>filter</b> parameter will be ignored.</span><br>The available criteria are as follows: <dl> <dt><code><b>creationdate</b></code></dt> <dd>The time period during which qualifying orders were created (the <b>orders.creationDate</b> field). In the URI, this is expressed as a starting timestamp, with or without an ending timestamp (in brackets). The timestamps are in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.For example: <ul> <li><code>creationdate:[2016-02-21T08:25:43.511Z..]</code> identifies orders created on or after the given timestamp.</li> <li><code>creationdate:[2016-02-21T08:25:43.511Z..2016-04-21T08:25:43.511Z]</code> identifies orders created between the given timestamps, inclusive.</li> </ul> </dd> <dt><code><b>lastmodifieddate</b></code></dt> <dd>The time period during which qualifying orders were last modified (the <b>orders.modifiedDate</b> field).  In the URI, this is expressed as a starting timestamp, with or without an ending timestamp (in brackets). The timestamps are in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.For example: <ul> <li><code>lastmodifieddate:[2016-05-15T08:25:43.511Z..]</code> identifies orders modified on or after the given timestamp.</li> <li><code>lastmodifieddate:[2016-05-15T08:25:43.511Z..2016-05-31T08:25:43.511Z]</code> identifies orders modified between the given timestamps, inclusive.</li> </ul> <span class="tablenote"><strong>Note:</strong> If <b>creationdate</b> and <b>lastmodifieddate</b> are both included, only <b>creationdate</b> is used.</span> <br><br></dd> <dt><code><b>orderfulfillmentstatus</b></code></dt> <dd>The degree to which qualifying orders have been shipped (the <b>orders.orderFulfillmentStatus</b> field). In the URI, this is expressed as one of the following value combinations: <ul> <li><code>orderfulfillmentstatus:{NOT_STARTED|IN_PROGRESS}</code> specifies orders for which no shipping fulfillments have been started, plus orders for which at least one shipping fulfillment has been started but not completed.</li> <li><code>orderfulfillmentstatus:{FULFILLED|IN_PROGRESS}</code> specifies orders for which all shipping fulfillments have been completed, plus orders for which at least one shipping fulfillment has been started but not completed.</li> </ul> <span class="tablenote"><strong>Note:</strong> The values <code>NOT_STARTED</code>, <code>IN_PROGRESS</code>, and <code>FULFILLED</code> can be used in various combinations, but only the combinations shown here are currently supported.</span> </dd> </dl> Here is an example of a <b>getOrders</b> call using all of these filters: <br><br> <code>GET https://api.ebay.com/sell/v1/order?<br>filter=<b>creationdate</b>:%5B2016-03-21T08:25:43.511Z..2016-04-21T08:25:43.511Z%5D,<br><b>lastmodifieddate</b>:%5B2016-05-15T08:25:43.511Z..%5D,<br><b>orderfulfillmentstatus</b>:%7BNOT_STARTED%7CIN_PROGRESS%7D</code> <br><br> <span class="tablenote"><strong>Note:</strong> This call requires that certain special characters in the URI query string be percent-encoded: <br> &nbsp;&nbsp;&nbsp;&nbsp;<code>[</code> = <code>%5B</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>]</code> = <code>%5D</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>{</code> = <code>%7B</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>|</code> = <code>%7C</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>}</code> = <code>%7D</code> <br> This query filter example uses these codes.</span> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/fulfillment/types/api:FilterField'
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: The number of orders to return per page of the result set. Use this parameter in conjunction with the <b>offset</b> parameter to control the pagination of the output. <br><br>For example, if <b>offset</b> is set to <code>10</code> and <b>limit</b> is set to <code>10</code>, the call retrieves orders 11 thru 20 from the result set. <br><br> If a limit is not set, the <b>limit</b> defaults to 50 and returns up to 50 orders. If a requested limit is more than 200, the call fails and returns an error.<br ><br> <span class="tablenote"><strong>Note:</strong> This feature employs a zero-based list, where the first item in the list has an offset of <code>0</code>. If the <b>orderIds</b> parameter is included in the request, this parameter will be ignored.</span> <br><br> <b>Maximum:</b> <code>200</code> <br> <b>Default:</b> <code>50</code>
        required: false
        schema:
          type: string
      - name: offset
        in: query
        description: Specifies the number of orders to skip in the result set before returning the first order in the paginated response.  <p>Combine <b>offset</b> with the <b>limit</b> query parameter to control the items returned in the response. For example, if you supply an <b>offset</b> of <code>0</code> and a <b>limit</b> of <code>10</code>, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If <b>offset</b> is <code>10</code> and <b>limit</b> is <code>20</code>, the first page of the response contains items 11-30 from the complete result set.</p> <p><b>Default:</b> 0</p>
        required: false
        schema:
          type: string
      - name: orderIds
        in: query
        description: A comma-separated list of the unique identifiers of the orders to retrieve (maximum 50). If one or more order ID values are specified through the <b>orderIds</b> query parameter, all other query parameters will be ignored.<br><br><span class="tablenote"><strong>Note:</strong> <b>getOrders</b> can return orders up to two years old. Do not provide the <b>orderId</b> for an order created more than two years in the past.</span>
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderSearchPagedCollection'
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '30700':
                domain: API_FULFILLMENT
                category: REQUEST
                description: 'Invalid filter name: {fieldname}'
              '30800':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Invalid filter value {fieldvalue} for filter {fieldname}
              '30810':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Invalid date format
              '30820':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Start date is missing
              '30830':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Time range between start date and end date must be within '{allowedTime}' years.
              '30840':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Start date should be before end date
              '30850':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Start and end dates can't be in the future
              '30900':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Exceeded maximum number of order IDs (the current limit is <code>50</code>)
              '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: eBay Issue Refund
      description: '<div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;"><span class="autonumber"><span><b><span style="color: #dd1e31;" class="mcFormatColor">Important!</span></b></span></span> Due to EU &amp; UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU/UK sellers, including <b>issueRefund</b>. Please refer to <a href="/develop/guides/digital-signatures-for-apis " target="_blank">Digital Signatures for APIs</a> to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.</p></div><br> This method allows a seller to issue a full or partial refund to a buyer for an order. Full or partial refunds can be issued at the order level or line item level.<br><br>The refunds issued through this method are processed asynchronously, so the refund will not show as ''Refunded'' right away. A seller will have to make a subsequent <a href="/api-docs/sell/fulfillment/resources/order/methods/getOrder" target="_blank">getOrder</a> call to check the status of the refund.  The status of an order refund can be found in the <a href="/api-docs/sell/fulfillment/resources/order/methods/getOrder#response.paymentSummary.refunds.refundStatus" target="_blank">paymentSummary.refunds.refundStatus</a> field of the <a href="/api-docs/sell/fulfillment/resources/order/methods/getOrder" target="_blank">getOrder</a> response.'
      operationId: issueRefund
      parameters:
      - name: order_id
        in: path
        description: This path parameter is used to specify the unique identifier of the order associated with a refund.<br><br>Use the <a href="/api-docs/sell/fulfillment/resources/order/methods/getOrders" target="_blank ">getOrders</a> method to retrieve order IDs.
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueRefundRequest'
        required: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refund'
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '34901':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Order id can't be null or empty.
              '34902':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Request can't be empty.
              '34903':
                domain: API_FULFILLMENT
                category: REQUEST
                description: The refund reason must be specified.
              '34905':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Either orderLevelRefundAmount or refundItems must be specified.
              '34906':
                domain: API_FULFILLMENT
                category: REQUEST
                description: The amount value must be specified.
              '34907':
                domain: API_FULFILLMENT
                category: REQUEST
                description: The amount value must be positive and within two decimals.
              '34908':
                domain: API_FULFILLMENT
                category: REQUEST
                description: The amount currency must be specified.
              '34909':
                domain: API_FULFILLMENT
                category: REQUEST
                description: The amount currency isn't correct.
              '34910':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Either legacyReference or lineItemId must be specified for item level refund.
              '34911':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Legacy item id must be specified for item level refund if you use legacyReference.
              '34912':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Legacy transaction id must be specified for item level refund if you use legacyReference.
              '34914':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Can't find the item in the order.
              '34915':
                domain: API_FULFILLMENT
                category: REQUEST
                description: The refund amount exceeds order amount.
              '34916':
                domain: API_FULFILLMENT
                category: BUSINESS
                description: A post-transaction case exists on this order, seller refund can't be triggered.
              '34917':
                domain: API_FULFILLMENT
                category: BUSINESS
                description: This order was already refunded.
              '34920':
                domain: API_FULFILLMENT
                category: BUSINESS
                description: It's too late to issue a refund for this order.
              '34921':
                domain: API_FULFILLMENT
                category: REQUEST
                description: The comment exceeds the length limit, please make sure it doesn't exceed 1000 characters.
              '34922':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Refund can't be issued while previous refund is processing.
              '34923':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Refund cannot be issued for this type of order.
        '403':
          description: Access Forbidden
        '404':
          description: Resource Not found
          x-response-codes:
            errors:
              '34913':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Can not find the order.
        '409':
          description: Conflict
          x-response-codes:
            errors:
              '34918':
                domain: API_FULFILLMENT
                category: BUSINESS
                description: This is not an eBay managed payments order.
              '34919':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Unauthorized access.
              '34924':
                domain: API_FULFILLMENT
                category: BUSINESS
                description: The item refund amount exceeds the item remaining amount.
              '34925':
                domain: API_FULFILLMENT
                category: BUSINESS
                description: The refund operation could not be completed with any of the payment methods saved to the seller's account.
              '34926':
                domain: API_FULFILLMENT
                category: BUSINESS
                description: A suitable payment method could not be found for the refund operation. Please resolve in Seller Hub.
              '34927':
                domain: API_FULFILLMENT
                category: BUSINESS
                description: The selected payment method for the refund operation was invalid or declined.
              '34928':
                domain: API_FULFILLMENT
                category: BUSINESS
                description: Your refund did not go through because we could not verify your payment option. Please change your payment option and try again.
              '34929':
                domain: API_FULFILLMENT
                category: REQUEST
                description: You cannot refund this order yet since the buyer payment has not been processed. Please try again later.
              '34930':
                domain: API_FULFILLMENT
                category: REQUEST
                description: Default payment method limit exceeded. Please use a different payment option or try again later.
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '34900':
                domain: API_FULFILLMENT
                category: APPLICATION
                description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope/sell.finances
components:
  schemas:
    PaymentSummary:
      type: object
      properties:
        payments:
          type: array
          description: This array consists of payment information for the order, including payment status, payment method, payment amount, and payment date. This array is always returned, although some of the fields under this container will not be returned until payment has been made.
          items:
            $ref: '#/components/schemas/Payment'
        refunds:
          type: array
          description: This array is always returned, but is returned as an empty array unless the seller has submitted a partial or full refund to the buyer for the order. If a refund has occurred, the refund amount and refund date will be shown for each refund.
          items:
            $ref: '#/components/schemas/OrderRefund'
        totalDueSeller:
          description: 'This is the total price that the seller receives for the entire order after all costs (item cost, delivery cost, taxes) are added for all line items, minus any discounts and/or promotions for any of the line items. Note that this value is subject to change before payment is actually made by the buyer (if the <strong>paymentStatus</strong> value was <code>PENDING</code> or <code>FAILED</code>), or if a partial or full refund occurs with the order.<br><br><span class="tablenote"><strong>Note:</strong> For orders that are subject to ''eBay Collect and Remit'' tax, the ''Collect and Remit'' tax amount for the order will be included in this <strong>totalDueSeller</strong> value.<br><br>To determine if ''Collect and Remit'' taxes were added into this <strong>totalDueSeller</strong> value, the user can check for the corresponding <strong>lineItems.ebayCollectAndRemitTaxes</strong> and the <strong>lineItems.taxes</strong> containers in the response. If both of these containers appear for one or more line items in the response with the following <strong>taxType</strong> values, the ''Collect and Remit'' tax amount that the buyer paid is included in this amount:<ul><li><code>STATE_SALES_TAX</code>: US</li><li><code>PROVINCE_SALES_TAX</code>: Provincial Sales Tax in Canada</li><li><code>GST</code>: Canada, Australia, and New Zealand</li><li><code>VAT</code>: VAT collected for UK and EU countries</li></ul></span>'
          $ref: '#/components/schemas/Amount'
      description: This type contains information about the various monetary exchanges that apply to the net balance due for the order.
    LineItemProperties:
      type: object
      properties:
        buyerProtection:
          type: boolean
          description: A value of <code>true</code> indicates that the line item is covered by eBay's Buyer Protection program.
        fromBestOffer:
          type: boolean
          description: This field is only returned if <code>true</code> and indicates that the purchase occurred by the buyer and seller mutually agreeing on a Best Offer amount. The Best Offer feature can be set up for any listing type, but if this feature is set up for an auction listing, it will no longer be available once a bid has been placed on the listing.
        soldViaAdCampaign:
          type: boolean
          description: This field is only returned if <code>true</code> and indicates that the line item was sold as a result of a seller's ad campaign.
      description: This type contains information about the eBay programs under which a line item was listed and sold.
    OrderRefund:
      type: object
      properties:
        amount:
          description: This field shows the refund amount for an order. This container is always returned for each refund.<br><br><span class="tablenote"><b>Note:</b> The refund amount shown is the seller's <i><b>net amount</b></i> received from the sale/transaction. eBay-collected tax will not be included in this amount, so the actual amount of the buyer's refund may be higher than this value.</span>
          $ref: '#/components/schemas/Amount'
        refundDate:
          type: string
          description: The date and time that the refund was issued. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the refund has been issued. <br><br><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>
        refundId:
          type: string
          description: Unique identifier of a refund that was initiated for an order through the <b>issueRefund</b> method. If the <b>issueRefund</b> method was used to issue one or more refunds at the line item level, these refund identifiers are returned at the line item level instead (<b>lineItems.refunds.refundId</b> field).<br><br> A <b>refundId</b> value is returned in the response of the <b>issueRefund</b> method, and this same value will be returned in the <b>getOrders</b> and <b>getOrders</b> responses for pending and completed refunds. For other refunds, see the <b>refundReferenceId</b> field.
        refundReferenceId:
          type: string
          description: The eBay-generated unique identifier for the refund. This field is not returned until the refund has been issued.
        refundStatus:
          type: string
          description: This enumeration value indicates the current status of the refund to the buyer. This container is always returned for each refund. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/sel:RefundStatusEnum'>eBay API documentation</a>
      description: This type contains information about a refund issued for an order. This does not include line item level refunds.
    Address:
      type: object
      properties:
        addressLine1:
          type: string
          description: The first line of the street address.<br><br><span class="tablenote"><strong>Note:</strong> <b>addressLine1</b> will not be returned for any order that is more than 90 days old.</span>
        addressLine2:
          type: string
          description: The second line of the street address. This field can be used for additional address information, such as a suite or apartment number. This field will be returned if defined for the shipping address.<br><br><span class="tablenote"><strong>Note:</strong> <b>addressLine2</b> will not be returned for any order that is more than 90 days old.</span><br><span class="tablenote"><b>Note:</b> As of January 31, 2022, <b>addressLine2</b> no longer returns EU VAT tax information. To determine line-item level VAT tax information, refer to <a href="#response.orders.lineItems.ebayCollectAndRemitTaxes.ebayReference">eBayReference</a>.</span>
        city:
          type: string
          description: The city of the shipping destination.
        countryCode:
          type: string
          description: The country of the shipping destination, represented as a two-letter ISO 3166-1 alpha-2 country code. For example, <code>US</code> represents the United States, and <code>DE</code> represents Germany. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/ba:CountryCodeEnum'>eBay API documentation</a>
        county:
          type: string
          description: The county of the shipping destination. Counties typically, but not always, contain multiple cities or towns. This field is returned if known/available.
        postalCode:
          type: string
          description: The postal code of the shipping destination. Usually referred to as Zip codes in the US. Most countries have postal codes, but not all. The postal code will be returned if applicable.
        stateOrProvince:
          type: string
          description: The state or province of the shipping destination. Most countries have states or provinces, but not all. The state or province will be returned if applicable.
      description: This type contains the details of a geographical address.
    DeliveryCost:
      type: object
      properties:
        discountAmount:
          description: The amount of any shipping discount that has been applied to the line item. This container is returned only if a shipping discount applies to the line item.
          $ref: '#/components/schemas/Amount'
        handlingCost:
          description: The amount of any handing cost that has been applied to the line item. This container is returned only if a handling cost applies to the line item.
          $ref: '#/components/schemas/Amount

# --- truncated at 32 KB (122 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ebay/refs/heads/main/openapi/ebay-order-api-openapi.yml