GET
/order/{orderId}/shipping_fulfillment
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.
Input
Resource URI (production)
GET https://api.ebay.com/sell/fulfillment/v1/order/{orderId}/shipping_fulfillment
URI parameters
| Parameter | Type | Description |
|---|---|---|
| orderId | string | 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. 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
{ /* ShippingFulfillmentPagedCollection */ }
| Output container/field | Type | Description |
|---|---|---|
| fulfillments | array of ShippingFulfillment | This array contains one or more fulfillments required for the order that was specified in method endpoint. Occurrence: Always |
| fulfillments.fulfillmentId | string | The unique identifier of the fulfillment; for example, 9405509699937003457459. This eBay-generated value is created with a successful createShippingFulfillment call. Occurrence: Always |
| fulfillments.lineItems | array of LineItemReference | This array contains a list of one or more line items (and purchased quantity) to which the fulfillment applies. Occurrence: Always |
| fulfillments.lineItems.lineItemId | string | 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. Occurrence: Always |
| fulfillments.lineItems.quantity | integer | This field is reserved for internal or future use. Occurrence: NA |
| fulfillments.shipmentTrackingNumber | string | The tracking number provided by the shipping carrier for the package shipped in this fulfillment. This field is returned if available. Occurrence: Conditional |
| fulfillments.shippedDate | string | 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 Occurrence: Conditional |
| fulfillments.shippingCarrierCode | string | 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. Occurrence: Conditional |
| total | integer | 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. Occurrence: Always |
| warnings | array of ErrorDetailV3 | This array is only returned if one or more errors or warnings occur with the call request. Occurrence: Conditional |
| warnings.category | string | The context or source of this error or warning. Occurrence: Conditional |
| warnings.domain | string | The name of the domain containing the service or application. For example, sell is a domain. Occurrence: Conditional |
| warnings.errorId | integer | A positive integer that uniquely identifies the specific error condition that occurred. Your application can use these values as error code identifiers in your customized error-handling algorithms. Occurrence: Conditional |
| warnings.inputRefIds | array of string | A list of one or more specific request elements (if any) associated with the error or warning. The format of these strings depends on the request payload format. For JSON, use JSONPath notation. Occurrence: Conditional |
| warnings.longMessage | string | An expanded version of the message field. Maximum length: 200 characters Occurrence: Conditional |
| warnings.message | string | A message about the error or warning which is device agnostic and readable by end users and application developers. It explains what the error or warning is, and how to fix it (in a general sense). If applicable, the value is localized to the end user's requested locale. Maximum length: 50 characters Occurrence: Conditional |
| warnings.outputRefIds | array of string | A list of one or more specific response elements (if any) associated with the error or warning. The format of these strings depends on the request payload format. For JSON, use JSONPath notation. Occurrence: Conditional |
| warnings.parameters | array of ErrorParameterV3 | Contains a list of name/value pairs that provide additional information concerning this error or warning. Each item in the list is an input parameter that contributed to the error or warning condition. Occurrence: Conditional |
| warnings.parameters.name | string | This is the name of input field that caused an issue with the call request. Occurrence: Conditional |
| warnings.parameters.value | string | This is the actual value that was passed in for the element specified in the name field. Occurrence: Conditional |
| warnings.subdomain | string | The name of the domain's subsystem or subdivision. For example, fulfillment is a subdomain in the sell domain. 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.
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 30500 | API_FULFILLMENT | APPLICATION | System error |
| 32100 | API_FULFILLMENT | REQUEST | Invalid order ID: {<i>orderId</i>} |
Warnings
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 Your Shipping Fulfillments
This sample retrieves all shipping fulfillments that have been created for the order that corresponds to the provided order ID.
Input
Use the orderid parameter to specify the order with the shipping fulfillments to retrieve.
GET
https://api.ebay.com/sell/fulfillment/v1/order/6********5!2********1/shipping_fulfillment
Output
A successful call returns the ShippingFulfillmentPagedCollection container with one or more fulfillments objects.
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.
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.