/order/{orderId}/shipping_fulfillment

Production

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

POST

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://api.ebay.com{basePath}/order//shipping_fulfillment' \
--header 'Content-Type: application/json' \
--data-raw '{
    "lineItems": [
        {
            "lineItemId": "string",
            "quantity": 0
        }
    ],
    "shippedDate": "string",
    "shippingCarrierCode": "string",
    "trackingNumber": "string"
}'

Response Example

201 - Example 1

{}

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 createShippingFulfillment 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.

Body Params application/json

fulfillment payload

lineItems

array[object (LineItemReference) {2}]

optional

This array contains a list of or more line items and the quantity that will be shipped in the same package.

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.

shippedDate

string

optional

This is the actual 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. The seller should use the actual date/time that the package was shipped, but if this field is omitted, it will default to the current date/time. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z Default: The current date and time.

shippingCarrierCode

string

optional

The unique identifier of the shipping carrier being used to ship the line item(s). Technically, the shippingCarrierCode and trackingNumber fields are optional, but generally these fields will be provided if the shipping carrier and tracking number are known. Note: Use the Trading API's GeteBayDetails call to retrieve the latest shipping carrier enumeration values. When making the GeteBayDetails call, include the DetailName field in the request payload and set its value to ShippingCarrierDetails. Each valid shipping carrier enumeration value is returned in a ShippingCarrierDetails.ShippingCarrier field in the response payload.

trackingNumber

string

optional

The tracking number provided by the shipping carrier for this fulfillment. The seller should be careful that this tracking number is accurate since the buyer will use this tracking number to track shipment, and eBay has no way to verify the accuracy of this number. This field and the shippingCarrierCode field are mutually dependent. If you include one, you must also include the other. Note: If you include trackingNumber (and shippingCarrierCode) in the request, the resulting fulfillment's ID (returned in the HTTP location code) is the tracking number. If you do not include shipment tracking information, the resulting fulfillment ID will default to an arbitrary number such as 999.

Examples

Responses

🟢201Created. 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 enviro

application/json

Body

object {0}

🟠400Bad Request

🔴500Internal Server Error. Note: In some cases, this call may succeed if you issue it once more after receiving this error.

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

/order/{orderId}/shipping_fulfillment

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