### GET /order/fulfillmentStartInstructions

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieves fulfillment start instructions for multiple orders.

```APIDOC
## GET /order/fulfillmentStartInstructions

### Description
Retrieves the instructions necessary to begin the fulfillment process for multiple orders.

### Method
GET

### Endpoint
/order/fulfillmentStartInstructions

### Parameters
#### Query Parameters
- **orderIds** (string) - Optional - A comma-separated list of order IDs to filter the results.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **orders** (array) - A list of orders.
  - **fulfillmentStartInstructions** (object) - Contains details and instructions for starting order fulfillment.

#### Response Example
```json
{
  "example": "{\"orders\": [{\"orderId\": \"ABC123XYZ\", \"fulfillmentStartInstructions\": {\"shippingStep\": {\"shipTo\": {\"fullName\": \"Jane Smith\"}}}}}"
}
```
```

--------------------------------

### GET /order/{orderId}/fulfillmentStartInstructions

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieves the fulfillment start instructions for a specific order.

```APIDOC
## GET /order/{orderId}/fulfillmentStartInstructions

### Description
Retrieves the instructions necessary to begin the fulfillment process for a specific order.

### Method
GET

### Endpoint
/order/{orderId}/fulfillmentStartInstructions

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The unique identifier of the order.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **fulfillmentStartInstructions** (object) - Contains details and instructions for starting order fulfillment.

#### Response Example
```json
{
  "example": "{\"shippingStep\": {\"shipTo\": {\"fullName\": \"John Doe\"}}}"
}
```
```

--------------------------------

### Fulfillment Start Instructions

Source: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrder

Provides instructions on how to start the fulfillment process, including destination address, estimated delivery dates, and fulfillment type.

```APIDOC
## Fulfillment Start Instructions

### Description
Provides instructions on how to start the fulfillment process, including destination address, estimated delivery dates, and fulfillment type.

### Method
N/A (This describes a data structure, not an endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **fulfillmentStartInstructions** (object) - Contains details for starting fulfillment.
  - **finalDestinationAddress** (object) - The shipping address for the order.
    - **addressLine1** (string) - The first line of the street address. Not returned for orders older than 90 days.
    - **addressLine2** (string) - The second line of the street address (e.g., suite, apartment). Returned if defined. Not returned for orders older than 90 days.
    - **city** (string) - The city of the shipping destination.
    - **countryCode** (CountryCodeEnum) - The two-letter ISO 3166-1 alpha-2 country code (e.g., `US`, `DE`).
    - **county** (string) - The county of the shipping destination. Returned if known.
    - **postalCode** (string) - The postal code of the shipping destination. Returned if applicable.
    - **stateOrProvince** (string) - The state or province of the shipping destination. Returned if applicable.
  - **fulfillmentInstructionsType** (FulfillmentInstructionsType) - The method of fulfillment (e.g., `SHIP_TO`).
  - **maxEstimatedDeliveryDate** (string) - The estimated latest delivery date in ISO 8601 format. Not returned for `DIGITAL` or `PREPARE_FOR_PICKUP` types.
  - **minEstimatedDeliveryDate** (string) - The estimated earliest delivery date in ISO 8601 format. Not returned for `DIGITAL` or `PREPARE_FOR_PICKUP` types.
  - **pickupStep** (object) - Container for In-Store Pickup orders.
    - **merchantLocationKey** (string) - A unique identifier for the merchant's store.
  - **shippingStep** (object) - Container for shipping information.
    - **shippingCarrierCode** (string) - The unique identifier of the shipping carrier.

#### Response Example
```json
{
  "fulfillmentStartInstructions": {
    "finalDestinationAddress": {
      "addressLine1": "123 Main St",
      "city": "Anytown",
      "countryCode": "US",
      "postalCode": "12345",
      "stateOrProvince": "CA"
    },
    "fulfillmentInstructionsType": "SHIP_TO",
    "minEstimatedDeliveryDate": "2023-10-26T10:00:00.000Z",
    "maxEstimatedDeliveryDate": "2023-10-28T17:00:00.000Z",
    "shippingStep": {
      "shippingCarrierCode": "USPS"
    }
  }
}
```
```

--------------------------------

### GET /orders

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieves a list of orders, potentially including fulfillment start instructions and service provider appointment dates.

```APIDOC
## GET /orders

### Description
Retrieves a list of orders. This endpoint can provide details about fulfillment start instructions, including service provider appointment dates.

### Method
GET

### Endpoint
/orders

### Parameters
(Query parameters may be available for filtering and pagination, not detailed in the provided text)

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **orders** (array) - A list of order objects, each potentially containing `fulfillmentStartInstructions.serviceProviderAppointmentDate`.

#### Response Example
{
  "orders": [
    {
      "orderId": "12345",
      "fulfillmentStartInstructions": {
        "serviceProviderAppointmentDate": "2023-10-27T10:00:00Z"
      }
    }
  ]
}
```

--------------------------------

### Appointment and Fulfillment Instructions

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieve appointment and fulfillment start instructions for orders.

```APIDOC
## GET /order/{orderId}appointment

### Description
Retrieves appointment details within the fulfillment start instructions for a specific order.

### Method
GET

### Endpoint
/order/{orderId}appointment

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The unique identifier of the order.

#### Query Parameters
- **fulfillmentStartInstructions** (string) - Optional - Specifies to retrieve fulfillment start instructions, including appointment details.

### Response
#### Success Response (200)
- **appointment** (object) - Details about the appointment.

### Response Example
```json
{
  "appointment": {
    "startTime": "2023-10-27T10:00:00Z",
    "endTime": "2023-10-27T12:00:00Z"
  }
}
```

## GET /orderappointment

### Description
Retrieves appointment details within the fulfillment start instructions for multiple orders.

### Method
GET

### Endpoint
/orderappointment

### Parameters
#### Query Parameters
- **orders.fulfillmentStartInstructions** (string) - Optional - Specifies to retrieve fulfillment start instructions, including appointment details, for multiple orders.

### Response
#### Success Response (200)
- **appointment** (object) - Details about the appointment for the orders.

### Response Example
```json
{
  "appointment": {
    "startTime": "2023-10-28T14:00:00Z",
    "endTime": "2023-10-28T16:00:00Z"
  }
}
```

## GET /order/{orderId}appointment

### Description
Retrieves the end time of an appointment within the fulfillment start instructions for a specific order.

### Method
GET

### Endpoint
/order/{orderId}appointment

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The unique identifier of the order.

#### Query Parameters
- **fulfillmentStartInstructions.appointment** (string) - Optional - Specifies to retrieve the appointment end time.

### Response
#### Success Response (200)
- **appointmentEndTime** (string) - The end time of the appointment.

### Response Example
```json
{
  "appointmentEndTime": "2023-10-27T12:00:00Z"
}
```
```

--------------------------------

### GET /order/{orderId}/shipToReferenceId

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieves the ship-to reference ID for a specific order. This is part of the fulfillment start instructions.

```APIDOC
## GET /order/{orderId}/shipToReferenceId

### Description
Retrieves the ship-to reference ID for a specific order. This information is part of the fulfillment start instructions and is associated with the shipping step.

### Method
GET

### Endpoint
/order/{orderId}/shipToReferenceId

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The unique identifier of the order.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **fulfillmentStartInstructions.shippingStep.shipToReferenceId** (string) - The reference ID for the ship-to destination.

#### Response Example
{
  "fulfillmentStartInstructions": {
    "shippingStep": {
      "shipToReferenceId": "REF123456"
    }
  }
}
```

--------------------------------

### Order Fulfillment Start Instructions

Source: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrders

Provides instructions for fulfilling an order, including shipping details and estimated delivery windows.

```APIDOC
## GET /orders/{orderId}

### Description
Retrieves order details, including instructions for starting the fulfillment process.

### Method
GET

### Endpoint
/orders/{orderId}

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The unique identifier of the order.

### Response
#### Success Response (200)
- **fulfillmentStartInstructions** (array of object) - A set of specifications for fulfilling the order.
  - **appointment** (object) - Provides information for appointment details selected by the buyer (e.g., for tire installation).
    - **appointmentEndTime** (string) - The date and time the appointment ends. (ISO 8601 format, UTC)

#### Response Example
```json
{
  "orderId": "1234567890",
  "fulfillmentStartInstructions": [
    {
      "shippingCarrier": "USPS",
      "shippingService": "First Class",
      "estimatedDeliveryWindow": {
        "minTime": "2023-10-27T10:00:00Z",
        "maxTime": "2023-10-29T17:00:00Z"
      },
      "appointment": {
        "appointmentEndTime": "2023-10-28T15:00:00Z"
      }
    }
  ]
}
```
```

--------------------------------

### GET /order

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieves order pricing summaries, including fees.

```APIDOC
## GET /order

### Description
Retrieves order pricing summaries, including fees.

### Method
GET

### Endpoint
/order

### Parameters
#### Query Parameters
- **fee** (string) - Optional - Specifies to include fee details in the pricing summary.

### Response
#### Success Response (200)
- **orders** (array) - A list of orders.
  - **pricingSummary** (object) - Summary of pricing details.
    - **fee** (array) - A list of fees associated with the order.

#### Response Example
```json
{
  "orders": [
    {
      "orderId": "string",
      "pricingSummary": {
        "fee": [
          {
            "feeType": "string",
            "amount": {
              "value": "string",
              "currency": "string"
            }
          }
        ]
      }
    }
  ]
}
```
```

--------------------------------

### GET /order/{orderId}/shipTo

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieves the shipping destination details for a specific order. This is part of the fulfillment start instructions.

```APIDOC
## GET /order/{orderId}/shipTo

### Description
Retrieves the shipping destination details for a specific order. This information is part of the fulfillment start instructions and includes the 'shipTo' address.

### Method
GET

### Endpoint
/order/{orderId}/shipTo

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The unique identifier of the order.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **fulfillmentStartInstructions.shippingStep.shipTo** (object) - Contains the shipping address details.

#### Response Example
{
  "fulfillmentStartInstructions": {
    "shippingStep": {
      "shipTo": {
        "fullName": "John Doe",
        "address": {
          "addressLine1": "123 Main St",
          "city": "Anytown",
          "stateOrProvince": "CA",
          "postalCode": "90210",
          "countryCode": "US"
        }
      }
    }
  }
}
```

--------------------------------

### GET /order/{orderId}/finalDestinationAddress

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieves the final destination address for a specific order's fulfillment start instructions.

```APIDOC
## GET /order/{orderId}/finalDestinationAddress

### Description
Retrieves the final destination address associated with the fulfillment start instructions for a given order.

### Method
GET

### Endpoint
/order/{orderId}/finalDestinationAddress

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The unique identifier of the order.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **finalDestinationAddress** (object) - Contains the details of the final destination address.

#### Response Example
```json
{
  "example": "{\"addressLine1\": \"123 Main St\", \"city\": \"Anytown\", \"stateOrProvince\": \"CA\", \"postalCode\": \"90210\", \"country\": \"US\"}"
}
```
```

--------------------------------

### GET /order

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieves orders, including buyer registration address and email.

```APIDOC
## GET /order

### Description
Retrieves orders, including buyer registration address and email.

### Method
GET

### Endpoint
/order

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
```json
{
  "example": "GET /order"
}
```

### Response
#### Success Response (200)
- **orders** (array) - A list of orders.
  - **buyer** (object) - Information about the buyer.
    - **buyerRegistrationAddress** (object) - The buyer's registration address.
      - **email** (string) - The buyer's email address.

#### Response Example
```json
{
  "orders": [
    {
      "orderId": "1234567890",
      "buyer": {
        "buyerRegistrationAddress": {
          "email": "buyer@example.com"
        }
      }
    }
  ]
}
```
```

--------------------------------

### GET /order

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieves orders, including shipping step details and email.

```APIDOC
## GET /order

### Description
Retrieves orders, including shipping step details and email.

### Method
GET

### Endpoint
/order

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
```json
{
  "example": "GET /order"
}
```

### Response
#### Success Response (200)
- **orders** (array) - A list of orders.
  - **fulfillmentStartInstructions** (object) - Instructions for starting fulfillment.
    - **shippingStep** (object) - Details about the shipping step.
      - **shipTo** (object) - Information about where to ship the item.
        - **email** (string) - The recipient's email address.

#### Response Example
```json
{
  "orders": [
    {
      "orderId": "1234567890",
      "fulfillmentStartInstructions": {
        "shippingStep": {
          "shipTo": {
            "email": "recipient@example.com"
          }
        }
      }
    }
  ]
}
```
```

--------------------------------

### GET /order/{orderId}/serviceProviderAppointmentDate

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieves the service provider appointment date for a specific order. This is part of the fulfillment start instructions.

```APIDOC
## GET /order/{orderId}/serviceProviderAppointmentDate

### Description
Retrieves the service provider appointment date for a specific order. This is part of the fulfillment start instructions.

### Method
GET

### Endpoint
/order/{orderId}/serviceProviderAppointmentDate

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The unique identifier of the order.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **serviceProviderAppointmentDate** (string) - The date and time of the service provider appointment.

#### Response Example
{
  "serviceProviderAppointmentDate": "2023-10-27T10:00:00Z"
}
```

--------------------------------

### GET /payment_dispute_summary

Source: https://developer.ebay.com/api-docs/sell/fulfillment/types/api%3ADisputeSummaryResponse

Retrieves a paginated list of payment dispute summaries. You can control the number of results per page and the starting offset.

```APIDOC
## GET /payment_dispute_summary

### Description
Retrieves a paginated list of payment dispute summaries. This endpoint allows you to fetch multiple payment disputes that match specific criteria, with options to control the number of results per page and the offset for pagination.

### Method
GET

### Endpoint
/payment_dispute_summary

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of payment disputes to return per page. Defaults to 200. Min: 1, Max: 200.
- **offset** (integer) - Optional - The number of payment disputes to skip before returning results. Defaults to 0.

### Request Example
```
GET /payment_dispute_summary?limit=10&offset=20
```

### Response
#### Success Response (200)
- **href** (string) - The URI of the `getPaymentDisputeSummaries` call request that produced the current page of the result set.
- **limit** (integer) - The maximum number of payment disputes returned on this page.
- **next** (string) - The URI to fetch the next page of results, if available.
- **offset** (integer) - The offset used for this page of results.
- **paymentDisputeSummaries** (array of PaymentDisputeSummary) - An array containing payment dispute summary objects. An empty array is returned if no disputes are found.
- **prev** (string) - The URI to fetch the previous page of results, if available.
- **total** (integer) - The total number of payment disputes matching the criteria.

#### Response Example
```json
{
  "href": "/payment_dispute_summary?limit=10&offset=0",
  "limit": 10,
  "next": "/payment_dispute_summary?limit=10&offset=10",
  "offset": 0,
  "paymentDisputeSummaries": [
    {
      "disputeId": "12345",
      "status": "OPEN"
    }
  ],
  "prev": null,
  "total": 50
}
```
```

--------------------------------

### Retrieve Shipping Fulfillment - Response Payload Example

Source: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/shipping_fulfillment/methods/getShippingFulfillment

This example demonstrates the structure of a successful JSON response when retrieving shipping fulfillment details. It includes fields like fulfillmentId, lineItems, shipmentTrackingNumber, shippedDate, and shippingCarrierCode.

```JSON
{
  "fulfillmentId" : "string",
  "lineItems" : [
    {
      "lineItemId" : "string",
      "quantity" : "integer"
    }
  ],
  "shipmentTrackingNumber" : "string",
  "shippedDate" : "string",
  "shippingCarrierCode" : "string"
}
```

--------------------------------

### GET /orderpickupStep

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieves pickup step details for multiple orders.

```APIDOC
## GET /orderpickupStep

### Description
Retrieves details about the pickup step for a collection of orders, relevant for local pickup fulfillment.

### Method
GET

### Endpoint
/orderpickupStep

### Parameters
#### Query Parameters
- **orderIds** (string) - Required - A comma-separated list of order IDs.

### Response
#### Success Response (200)
- **orders** (array) - An array of order pickup step details.
  - **orderId** (string) - The order ID.
  - **pickupStep** (object) - An object containing details about the pickup step.

#### Response Example
```json
{
  "orders": [
    {
      "orderId": "123-4567890-12345",
      "pickupStep": {
        "pickupLocation": "123 Main St, Anytown, USA"
      }
    }
  ]
}
```
```

--------------------------------

### Retrieve an Order by ID (cURL)

Source: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrder

This cURL command demonstrates how to retrieve a specific order using its unique orderId. It includes an example of how to optionally request a tax breakdown by setting the fieldGroups parameter.

```shell
curl -X GET \
  'https://api.ebay.com/sell/fulfillment/v1/order/1234567890?fieldGroups=TAX_BREAKDOWN' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
```

--------------------------------

### GET /order

Source: https://developer.ebay.com/api-docs/sell/fulfillment/types/sel%3ALineItemFulfillmentInstructions

Retrieves a list of orders, where each order may contain line item fulfillment instructions.

```APIDOC
## GET /order

### Description
Retrieves a list of orders based on specified filters. Each order in the response may include fulfillment instructions for its line items, aiding sellers in managing their fulfillment workflow.

### Method
GET

### Endpoint
`/order`

### Parameters
#### Query Parameters
- **filter** (string) - Optional - Filters for the orders to be returned (e.g., by status, date range).
- **limit** (integer) - Optional - The maximum number of orders to return per page.
- **offset** (integer) - Optional - The number of orders to skip before starting to collect the result set.

### Response
#### Success Response (200)
- **orders** (array) - A list of order objects.
  - Each order object contains:
    - **orderId** (string) - The unique identifier of the order.
    - **fulfillmentInstructions** (object) - Contains specifications for processing the fulfillment of a line item.
      - **destinationTimeZone** (string) - Reserved for internal or future use.
      - **guaranteedDelivery** (boolean) - Indicates if eBay Guaranteed Delivery is applicable (can be ignored).
      - **maxEstimatedDeliveryDate** (string) - The latest estimated date and time for delivery (ISO 8601 format).
      - **minEstimatedDeliveryDate** (string) - The earliest estimated date and time for delivery (ISO 8601 format).
      - **shipByDate** (string) - The latest date and time by which the seller should ship the item (ISO 8601 format).
      - **sourceTimeZone** (string) - Reserved for internal or future use.

#### Response Example
```json
{
  "orders": [
    {
      "orderId": "1234567890",
      "fulfillmentInstructions": {
        "destinationTimeZone": "America/Los_Angeles",
        "guaranteedDelivery": false,
        "maxEstimatedDeliveryDate": "2023-10-27T10:00:00.000Z",
        "minEstimatedDeliveryDate": "2023-10-25T10:00:00.000Z",
        "shipByDate": "2023-10-24T10:00:00.000Z",
        "sourceTimeZone": "America/New_York"
      }
    },
    {
      "orderId": "0987654321",
      "fulfillmentInstructions": {
        "destinationTimeZone": "Europe/London",
        "guaranteedDelivery": false,
        "maxEstimatedDeliveryDate": "2023-10-28T12:00:00.000Z",
        "minEstimatedDeliveryDate": "2023-10-26T12:00:00.000Z",
        "shipByDate": "2023-10-25T12:00:00.000Z",
        "sourceTimeZone": "Europe/Berlin"
      }
    }
  ]
}
```
```

--------------------------------

### ISO 8601 Date/Time Format Example

Source: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrder

Demonstrates the ISO 8601 format for date and time, commonly used for timestamps in the eBay API. This format includes year, month, day, hour, minute, second, and milliseconds, all in UTC.

```text
YYYY-MM-DDTHH:mm:ss.sssZ
Example: 2015-08-04T19:09:02.768Z
```

--------------------------------

### GET /order/fromBestOffer

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieves information about Best Offer properties for line items across multiple orders.

```APIDOC
## GET /order/fromBestOffer

### Description
Retrieves details about line items across multiple orders, specifically indicating if they originated from a Best Offer and their associated properties.

### Method
GET

### Endpoint
/order/fromBestOffer

### Parameters
#### Query Parameters
- **orderIds** (string) - Optional - A comma-separated list of order IDs to filter the results.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **orders** (array) - A list of orders.
  - **lineItems** (array) - A list of line items within an order.
    - **fromBestOffer** (boolean) - Indicates if the line item was from a Best Offer.
    - **properties** (object) - Additional properties related to the line item.

#### Response Example
```json
{
  "example": "{\"orders\": [{\"orderId\": \"ABC123XYZ\", \"lineItems\": [{\"itemId\": \"1234567890\", \"fromBestOffer\": true, \"properties\": {\"discount\": \"10%\"}}]}]}"
}
```
```

--------------------------------

### GET /order

Source: https://developer.ebay.com/api-docs/sell/fulfillment/types/sel%3APaymentSummary

Retrieves a list of orders, with each order potentially including payment summaries.

```APIDOC
## GET /order

### Description
Retrieves a list of orders, with each order potentially including payment summaries.

### Method
GET

### Endpoint
/order

### Parameters
#### Query Parameters
* **filter** (string) - Optional - Filters the orders based on specified criteria.
* **limit** (integer) - Optional - The maximum number of orders to return.
* **offset** (integer) - Optional - The number of orders to skip before returning results.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **orders** (array of Order) - A list of orders, where each order may contain payment summary information.

#### Response Example
```json
{
  "orders": [
    {
      "orderId": "1234567890",
      "payments": [
        {
          "paymentStatus": "PAID",
          "paymentMethod": "PAYPAL",
          "amount": {
            "value": "50.00",
            "currency": "USD"
          },
          "paymentDate": "2023-10-26T15:30:00Z"
        }
      ],
      "refunds": [],
      "totalDueSeller": {
        "value": "48.00",
        "currency": "USD"
      }
    }
  ]
}
```
```

--------------------------------

### Retrieve an Order by ID (Node.js)

Source: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrder

This Node.js example shows how to fetch order details using the eBay Fulfillment API. It requires the 'axios' library for making HTTP requests and demonstrates setting the Authorization header and optional query parameters.

```javascript
const axios = require('axios');

async function getOrderById(orderId, accessToken) {
  const url = `https://api.ebay.com/sell/fulfillment/v1/order/${orderId}?fieldGroups=TAX_BREAKDOWN`;
  try {
    const response = await axios.get(url, {
      headers: {
        'Authorization': `Bearer ${accessToken}`,
        'Content-Type': 'application/json'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error fetching order:', error);
    throw error;
  }
}

// Example usage:
// getOrderById('1234567890', 'YOUR_ACCESS_TOKEN')
//   .then(orderData => console.log(orderData))
//   .catch(err => console.error(err));
```

--------------------------------

### Example Payment Dispute Activity Response (JSON)

Source: https://developer.ebay.com/api-docs/sell/fulfillment/resources/payment_dispute/methods/getActivities

This JSON object represents a successful response from the 'getActivities' API call. It contains an 'activity' array, where each element details a specific action taken on the payment dispute, including the date, type of activity, and the actor who performed it.

```json
{
  "activity": [
    {
      "activityDate": "2019-08-04T19:09:02.768Z",
      "activityType": "DISPUTE_OPENED",
      "actor": "BUYER"
    },
    {
      "activityDate": "2019-08-05T10:30:00.000Z",
      "activityType": "SELLER_CONTEST",
      "actor": "SELLER"
    }
  ]
}
```

--------------------------------

### GET /order

Source: https://developer.ebay.com/api-docs/sell/fulfillment/types/sel%3APricingSummary

Retrieves a list of orders, with each order including a summary of cumulative costs and charges.

```APIDOC
## GET /order

### Description
Retrieves a list of orders, with each order including a summary of cumulative costs and charges for all line items.

### Method
GET

### Endpoint
/order

### Parameters
#### Query Parameters
- **fieldGroups** (string) - Optional - Specifies the data to be included in the response. If set to `TAX_BREAKDOWN`, 'Collect and Remit' tax will be included in the total.

### Request Example
```
GET /order?fieldGroups=TAX_BREAKDOWN
```

### Response
#### Success Response (200)
- **adjustment** (Amount) - Total amount of any adjustments applied to the item cost.
- **deliveryCost** (Amount) - Total cost of delivering the order before discounts.
- **deliveryDiscount** (Amount) - Total amount of delivery discounts applied.
- **fee** (Amount) - Total amount of any special fees applied to the order.
- **priceDiscount** (Amount) - Total amount of item price discounts applied.
- **priceSubtotal** (Amount) - Cumulative costs of all line items before discounts.
- **tax** (Amount) - Total amount of tax for the order.
- **total** (Amount) - The total cost of the order after all adjustments, discounts, taxes, and fees.

#### Response Example
```json
[
  {
    "adjustment": {
      "value": "10.00",
      "currency": "USD"
    },
    "deliveryCost": {
      "value": "5.00",
      "currency": "USD"
    },
    "deliveryDiscount": {
      "value": "-2.00",
      "currency": "USD"
    },
    "fee": {
      "value": "1.00",
      "currency": "USD"
    },
    "priceDiscount": {
      "value": "-3.00",
      "currency": "USD"
    },
    "priceSubtotal": {
      "value": "50.00",
      "currency": "USD"
    },
    "tax": {
      "value": "4.50",
      "currency": "USD"
    },
    "total": {
      "value": "60.50",
      "currency": "USD"
    }
  }
]
```
```

--------------------------------

### GET /order/{orderId}

Source: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrder

Retrieves the details of a specific eBay order.

```APIDOC
## GET /order/{orderId}

### Description
Retrieves the details of a specific eBay order using its unique identifier.

### Method
GET

### Endpoint
`/order/{orderId}`

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The unique identifier of the order.

### Response
#### Success Response (200)
- **buyer** (object) - Information about the buyer.
- **buyerCheckoutNotes** (string) - Notes provided by the buyer during checkout.
- **cancelStatus** (object) - The cancellation status of the order.
- **creationDate** (string) - The date and time the order was created.
- **ebayCollectAndRemitTax** (boolean) - Indicates if eBay collects and remits tax for this order.
- **fulfillmentHrefs** (array) - A list of HREFs for fulfillment details.
- **fulfillmentStartInstructions** (array) - Instructions for starting the fulfillment process.
- **lastModifiedDate** (string) - The date and time the order was last modified.
- **lineItems** (array) - A list of line items included in the order.
- **orderId** (string) - The unique identifier of the order.
- **orderPaymentStatus** (string) - The payment status of the order.
- **orderPieces** (array) - Information about the pieces associated with the order.
- **orderTaxes** (array) - Taxes applied to the order.
- **paymentSummary** (object) - A summary of the payment details for the order.
- **returnHrefs** (array) - A list of HREFs for return details.
- **salesRecordReference** (string) - A reference to the sales record.
- **shippingAddress** (object) - The shipping address for the order.
- **totalOrderCost** (object) - The total cost of the order.

#### Response Example
```json
{
  "buyer": {
    "buyerRegistrationAddress": {
      "companyName": "string",
      "contactAddress": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "countryCode": "AD",
        "county": "string",
        "postalCode": "string",
        "stateOrProvince": "string"
      },
      "email": "string",
      "fullName": "string",
      "primaryPhone": {
        "phoneNumber": "string"
      }
    },
    "taxAddress": {
      "city": "string",
      "countryCode": "AD",
      "postalCode": "string",
      "stateOrProvince": "string"
    },
    "taxIdentifier": {
      "taxpayerId": "string",
      "taxIdentifierType": "CODICE_FISCALE",
      "issuingCountry": "AD"
    },
    "username": "string"
  },
  "buyerCheckoutNotes": "string",
  "cancelStatus": {
    "cancelledDate": "string",
    "cancelRequests": [
      {
        "cancelCompletedDate": "string",
        "cancelInitiator": "string",
        "cancelReason": "string",
        "cancelRequestedDate": "string",
        "cancelRequestId": "string",
        "cancelRequestState": "COMPLETED"
      }
    ],
    "cancelState": "CANCELED"
  },
  "creationDate": "string",
  "ebayCollectAndRemitTax": true,
  "fulfillmentHrefs": [
    "string"
  ],
  "fulfillmentStartInstructions": [
    {
      "appointment": {
        "appointmentEndTime": "string",
        "appointmentStartTime": "string",
        "appointmentStatus": "ON_HOLD",
        "appointmentType": "TIME_SLOT",
        "appointmentWindow": "MORNING",
        "serviceProviderAppointmentDate": "string"
      },
      "destinationTimeZone": "string",
      "ebaySupportedFulfillment": true,
      "finalDestinationAddress": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "countryCode": "AD",
        "county": "string",
        "postalCode": "string",
        "stateOrProvince": "string"
      },
      "fulfillmentInstructionsType": "DIGITAL",
      "maxEstimatedDeliveryDate": "string",
      "minEstimatedDeliveryDate": "string",
      "pickupStep": {
        "merchantLocationKey": "string"
      },
      "shippingStep": {
        "shippingCarrierCode": "string",
        "shippingServiceCode": "string",
        "shipTo": {
          "companyName": "string",
          "contactAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "city": "string",
            "countryCode": "AD",
            "county": "string",
            "postalCode": "string",
            "stateOrProvince": "string"
          },
          "email": "string",
          "fullName": "string",
          "primaryPhone": {
            "phoneNumber": "string"
          }
        },
        "shipToReferenceId": "string"
      }
    }
  ],
  "lastModifiedDate": "string",
  "lineItems": [
    {
      "appliedPromotions": [
        {
          "description": "string",
          "discountAmount": {
              "convertedFromCurrency": "AED",
              "convertedFromValue": "string",
              "currency": "AED",
              "value": "string"
          },
          "promotionId": "string"
        }
      ],
      "compatibilityProperties": [
          {
              "propertyDisplayName": "string",
              "propertyName": "string",
              "propertyValue": "string"
          }
      ],
      "deliveryCost": {
          "discountAmount": {},
          "handlingCost": {},
          "importCharges": {
              "convertedFromCurrency": "AED",
              "convertedFromValue": "string",
              "currency": "AED",
              "value": "string"
          },
          "shippingCost": {
              "convertedFromCurrency": "AED",
              "convertedFromValue": "string",
              "currency": "AED",
              "value": "string"
          },
          "shippingIntermediationFee": {
              "convertedFromCurrency": "AED",
              "convertedFromValue": "string",
              "currency": "AED",
              "value": "string"
          }
      },
      "discountedLineItemCost": {
          "convertedFromCurrency": "AED",
          "convertedFromValue": "string",
          "currency": "AED",
          "value": "string"
      },
      "ebayCollectAndRemitTaxes": [
          {
              "amount": {
                  "convertedFromCurrency": "AED",
                  "convertedFromValue": "string",
                  "currency": "AED",
                  "value": "string"
              },
              "ebayReference": {
                  "name": "string",
                  "value": "string"
              },
              "taxType": "STATE_SALES_TAX"
          }
      ]
    }
  ],
  "orderId": "string",
  "orderPaymentStatus": "PAID",
  "orderPieces": [],
  "orderTaxes": [],
  "paymentSummary": {},
  "returnHrefs": [],
  "salesRecordReference": "string",
  "shippingAddress": {},
  "totalOrderCost": {}
}
```
```

--------------------------------

### Order Pricing and Tax Summary

Source: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrders

This section details the pricing summary for an order, including tax information and total amounts. It covers both converted and original currency values.

```APIDOC
## Order Pricing and Tax Details

### Description
Provides detailed pricing information for an order, including tax amounts and the total order cost. It supports currency conversion and specifies currency codes for all monetary values.

### Endpoint
`/orders` (This is a conceptual grouping, actual endpoints may vary)

### Response Fields

#### `orders.pricingSummary.tax`

- **`convertedFromValue`** (string) - Optional - 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.
- **`currency`** (CurrencyCodeEnum) - Required - A three-letter ISO 4217 code indicating the currency of the `value` field. If currency conversion is required, this is the post-conversion currency.
- **`value`** (string) - Required - The monetary amount, in the currency specified by the `currency` field. If currency conversion is required, this is the converted amount.

#### `orders.pricingSummary.total`

- **`convertedFromCurrency`** (CurrencyCodeEnum) - Optional - A three-letter ISO 4217 code indicating the currency of the `convertedFromValue` field. Required or returned only if currency conversion/localization is required.
- **`convertedFromValue`** (string) - Optional - The monetary amount before any conversion is performed, in the currency specified by the `convertedFromCurrency` field. Required or returned only if currency conversion/localization is required.
- **`currency`** (CurrencyCodeEnum) - Required - A three-letter ISO 4217 code indicating the currency of the `value` field. If currency conversion is required, this is the post-conversion currency.
- **`value`** (string) - Required - The monetary amount, in the currency specified by the `currency` field. If currency conversion is required, this is the converted amount.

### Response Example (Conceptual)
```json
{
  "orders": [
    {
      "pricingSummary": {
        "tax": {
          "convertedFromValue": "10.50",
          "currency": "USD",
          "value": "10.00"
        },
        "total": {
          "convertedFromCurrency": "USD",
          "convertedFromValue": "120.00",
          "currency": "EUR",
          "value": "110.50"
        }
      }
    }
  ]
}
```
```

--------------------------------

### GET /payment_dispute_summary

Source: https://developer.ebay.com/api-docs/sell/fulfillment/types/api%3ADisputeStateEnum

Retrieves a summary of payment disputes. This endpoint can be used to get an overview of disputes, and the DisputeStateEnum indicates the status of each summarized dispute.

```APIDOC
## GET /payment_dispute_summary

### Description
Retrieves a summary of payment disputes, providing an overview of open and closed disputes. The state of each dispute is indicated by the DisputeStateEnum.

### Method
GET

### Endpoint
/payment_dispute_summary

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **paymentDisputes** (array) - A list of payment dispute summaries.
  - **disputeState** (DisputeStateEnum) - The current state of the payment dispute.
  - **paymentDisputeId** (string) - The unique identifier of the payment dispute.

#### Response Example
```json
{
  "paymentDisputes": [
    {
      "disputeState": "OPEN",
      "paymentDisputeId": "1234567890"
    },
    {
      "disputeState": "CLOSED",
      "paymentDisputeId": "0987654321"
    }
  ]
}
```
```

--------------------------------

### GET /order

Source: https://developer.ebay.com/api-docs/sell/fulfillment/fields

Retrieves order details, including payment summary and expected release dates for payment holds.

```APIDOC
## GET /order

### Description
Retrieves order details, including payment summary and expected release dates for payment holds.

### Method
GET

### Endpoint
/order

### Parameters
#### Query Parameters
- **expectedReleaseDate** (string) - Optional - Specifies to include expected release date information for payment holds.

### Response
#### Success Response (200)
- **orders** (array) - A list of orders.
  - **paymentSummary** (object) - Summary of payment details.
    - **payments** (array) - List of payments.
      - **paymentHolds** (array) - Holds placed on payments.
        - **expectedReleaseDate** (string) - The expected date for the payment hold to be released.

#### Response Example
```json
{
  "orders": [
    {
      "orderId": "string",
      "paymentSummary": {
        "payments": [
          {
            "paymentHolds": [
              {
                "expectedReleaseDate": "string"
              }
            ]
          }
        ]
      }
    }
  ]
}
```
```

--------------------------------

### GET /order

Source: https://developer.ebay.com/api-docs/sell/fulfillment/types/sel%3AAmount

Retrieves a list of orders, including monetary amounts.

```APIDOC
## GET /order

### Description
Retrieves a list of orders based on specified filters. This endpoint utilizes the Amount type for monetary values associated with each order in the response.

### Method
GET

### Endpoint
/order

### Parameters
#### Path Parameters
None

#### Query Parameters
- **filter** (string) - Optional - Filters for the orders to be returned.

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **orders** (array of Order) - A list of orders.
- **orderId** (string) - The unique identifier of an order.
- **amount** (Amount) - The total monetary amount for an order.
```

--------------------------------

### Get Shipping Fulfillment - API Response

Source: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/shipping_fulfillment/methods/getShippingFulfillment

This is a sample JSON response for a successful 'Get Shipping Fulfillment' API call. It includes details such as fulfillment ID, shipment tracking number, shipping carrier code, shipped date, and associated line items.

```JSON
{
    "fulfillmentId": "1********6",
    "shipmentTrackingNumber": "1********6",
    "shippingCarrierCode": "USPS",
    "shippedDate": "2016-09-27T19:28:13.000Z",
    "lineItems": [
        {
            "lineItemId": "6********1"
        }
    ]
}
```