/order/{orderId}/shipping_fulfillment/{fulfillmentId}

Production

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

GET

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.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "fulfillmentId": "string",
    "lineItems": [
        {
            "lineItemId": "string",
            "quantity": 0
        }
    ],
    "shipmentTrackingNumber": "string",
    "shippedDate": "string",
    "shippingCarrierCode": "string"
}

Request

Path Params

fulfillmentId

string

required

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, 9405509699937003457459.

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 getShippingFulfillment 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 complete details of an existing fulfillment for an order.

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.

lineItemId

string

optional

This is the unique identifier of the eBay order line item that is part of the shipping fulfillment. The line item ID is created as soon as there is a commitment to buy from the seller.

quantity

integer <int32>

optional

This field is reserved for internal or future use.

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.

🟠400Bad Request

🟠404Not Found

🔴500Internal Server Error

Modified at 2022-09-11 20:21:04

/order/{orderId}/shipping_fulfillment

Get Payment Dispute Details