fulfillment API1.11.0

getShippingFulfillment

GET
/order/{orderId}/shipping_fulfillment/{fulfillmentId}
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.

Input

Resource URI (production)

GET https://api.ebay.com/sell/fulfillment/v1/order/{orderId}/shipping_fulfillment/{fulfillmentId}

URI parameters

ParameterTypeDescription
orderIdstringThe 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.

Occurrence: Required

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

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.fulfillment

https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
fulfillmentIdstringThe unique identifier of the fulfillment; for example, 9405509699937003457459. This eBay-generated value is created with a successful createShippingFulfillment call.

Occurrence: Always

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

Occurrence: Always

lineItems.lineItemIdstringThis 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.

Occurrence: Always

lineItems.quantityintegerThis field is reserved for internal or future use.

Occurrence: NA

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

Occurrence: Conditional

shippedDatestringThe 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-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z

Occurrence: Conditional

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

Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
400Bad Request
404Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
30500API_FULFILLMENTAPPLICATIONSystem error
32100API_FULFILLMENTREQUESTInvalid order ID: {<i>orderId</i>}
32110API_FULFILLMENTREQUESTInvalid shipping fulfillment ID: {<i>fulfillmentId</i>}

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get a Shipping Fulfillment

This sample retrieves a particular shipping fulfillment for a seller's order corresponding to the provided order and fulfillment IDs.

Input

Use the orderid parameter and the fulfillmentid parameter to retrieve the specified shipping fulfillment associated with the specified order.
GET
https://api.ebay.com/sell/fulfillment/v1/order/6498414015!260000000562911/shipping_fulfillment/1Z50992656936

Output

A successful call returns one ShippingFulfillment container.

Note: Currently, eBay uses the value of the tracking number as the fulfillment ID, but don't depend on this behavior. The fulfillment ID format is subject to change in the future.