/order/{orderId}/shipping_fulfillment

Production

https://api.ebay.com{basePath}

GET

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.ebay.com{basePath}/order//shipping_fulfillment'

Response Example

200 - Example 1

{
    "fulfillments": [
        {
            "fulfillmentId": "string",
            "lineItems": [
                {
                    "lineItemId": "string",
                    "quantity": 0
                }
            ],
            "shipmentTrackingNumber": "string",
            "shippedDate": "string",
            "shippingCarrierCode": "string"
        }
    ],
    "total": 0,
    "warnings": [
        {
            "category": "string",
            "domain": "string",
            "errorId": 0,
            "inputRefIds": [
                "string"
            ],
            "longMessage": "string",
            "message": "string",
            "outputRefIds": [
                "string"
            ],
            "parameters": [
                {
                    "name": "string",
                    "value": "string"
                }
            ],
            "subdomain": "string"
        }
    ]
}

Request

Path Params

orderId

string

required

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: A new order ID format was introduced to all eBay APIs (legacy and REST) in June 2019. In REST APIs that return Order IDs, including the Fulfillment API, all order IDs are returned in the new format, but the getShippingFulfillments method will accept both the legacy and new format order ID. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers will be automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

Responses

🟢200Success

application/json

Body

This type contains the specifications for the entire collection of shipping fulfillments that are associated with the order specified by a getShippingFulfillments call. The fulfillments container returns an array of all the fulfillments in the collection.

fulfillments

array[object (ShippingFulfillment) {5}]

optional

This array contains one or more fulfillments required for the order that was specified in method endpoint.

fulfillmentId

string

optional

The unique identifier of the fulfillment; for example, 9405509699937003457459. This eBay-generated value is created with a successful createShippingFulfillment call.

lineItems

array[object (LineItemReference) {2}]

optional

This array contains a list of one or more line items (and purchased quantity) to which the fulfillment applies.

shipmentTrackingNumber

string

optional

The tracking number provided by the shipping carrier for the package shipped in this fulfillment. This field is returned if available.

shippedDate

string

optional

The date and time that the fulfillment package was shipped. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field should only be returned if the package has been shipped. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z

shippingCarrierCode

string

optional

The eBay code identifying the shipping carrier for this fulfillment. This field is returned if available. Note: The Trading API's ShippingCarrierCodeType enumeration type contains the most current list of eBay shipping carrier codes and the countries served by each carrier. See ShippingCarrierCodeType.

total

integer <int32>

optional

The total number of fulfillments in the specified order. Note: If no fulfillments are found for the order, this field is returned with a value of 0.

warnings

array[object (Error) {9}]

optional

This array is only returned if one or more errors or warnings occur with the call request.