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
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| orderId | string | This path parameter is used to specify the unique identifier of the order associated with the shipping fulfillment being retrieved. Use the getOrders method to retrieve order IDs. Order ID values are also shown in My eBay/Seller Hub. Occurrence: Required |
| fulfillmentId | string | This path parameter is used to specify the unique identifier of the shipping fulfillment being retrieved. Use the getShippingFulfillments method to retrieved fulfillment IDs. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
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.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| fulfillmentId | string | The unique identifier of the fulfillment; for example, Occurrence: Always |
| 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 |
| lineItems.lineItemId | string | This is the unique identifier of the eBay order line item that is part of the shipping fulfillment. Occurrence: Always |
| lineItems.quantity | integer | This is the number of lineItems associated with the trackingNumber specified by the seller. This must be a whole number greater than zero (0). Occurrence: Always |
| 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 |
| 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. Occurrence: Conditional |
| shippingCarrierCode | string | The eBay code identifying the shipping carrier for this fulfillment. This field is returned if available. 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 |
| 404 | Not Found |
| 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: {orderId} |
| 32110 | API_FULFILLMENT | REQUEST | Invalid shipping fulfillment ID: {fulfillmentId} |
Warnings
This call has no 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 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.
GEThttps://api.ebay.com/sell/fulfillment/v1/order/6********5!2********1/shipping_fulfillment/1********6
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.