This doc page has moved! You should be automatically redirected to the resources page for the eBay Fulfillment API. If you are not redirected automatically, follow this link to the Fulfillment API.
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 Output Error Codes Samples Change History |
See also Samples.
GET https://api.ebay.com/sell/fulfillment/v1/order/{orderId}/shipping_fulfillment
Parameter | Type | Required? | Meaning |
---|---|---|---|
orderId | string | Required |
The unique identifier of the order. This value was returned by the getOrders call in the orders.orderId field; for example, 170009092860-9849164007!140000000544476 .
|
All requests made to eBay REST operations require you to provide the authorization
HTTP header for authentication.
See HTTP request headers for details.
This request requires a user access token with the following scope:
https://api.ebay.com/oauth/api_scope/sell.fulfillment
https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly
See Getting Access Tokens for more information.
This call has no request payload.
Input Output Error Codes Samples Change History |
See also Samples.
This call can return one of the following HTTP status codes. See the HTTP Status Code Registry for a complete overview of HTTP status codes.
Status | Meaning |
---|---|
200 | Success |
400 | Bad Request |
500 | Internal Server Error |
Note: For information about the error fields and how to work with them, see Error Handling.
The following lists all fields that could be included in the response.
{ /* ShippingFulfillmentPagedCollection */ "fulfillments": [ { /* ShippingFulfillment */ "fulfillmentId": string, "lineItems": [ { /* LineItemReference */ "lineItemId": string } /* More LineItemReference nodes here */ ], "shipmentTrackingNumber": string, "shippedDate": string, "shippingCarrierCode": string } /* More ShippingFulfillment nodes here */ ], "total": integer, "warnings": [ { /* ErrorDetailV3 */ "category": string, "domain": string, "errorId": integer, "inputRefIds": [ string /* More string nodes here */ ], "longMessage": string, "message": string, "outputRefIds": [ string /* More string nodes here */ ], "parameters": [ { /* ErrorParameterV3 */ "name": string, "value": string } /* More ErrorParameterV3 nodes here */ ], "subdomain": string } /* More ErrorDetailV3 nodes here */ ] }
Output Container/Field | Type | Occurrence | Meaning |
---|---|---|---|
fulfillments | array of ShippingFulfillment | Always | Contains an array of all the fulfillments returned by this call. The fulfillments are sorted by fulfillments.fulfillmentId. |
fulfillments.fulfillmentId | string | Always |
The unique identifier of the fulfillment; for example, 9405509699937003457459 . This eBay-generated value was created by the Create Shipping Fulfillment call.
|
fulfillments.lineItems | array of LineItemReference | Always | Contains a list of the line items to which the fulfillment applies. |
fulfillments.lineItems .lineItemId |
string | Always |
The globally unique eBay-generated identifier of the line item. Note: A single line item 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 cannot distribute them among multiple shipping packages. Thus, each line item ID will appear in exactly one fulfillment. |
fulfillments .shipmentTrackingNumber |
string | Conditionally | The tracking number provided by the shipping carrier for this fulfillment. |
fulfillments.shippedDate | string | Conditionally |
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. Format: YYYY-MM-DDTHH:MM:SS.SSSZ Example: 2015-08-04T19:09:02.768Z
|
fulfillments .shippingCarrierCode |
string | Conditionally |
The eBay code identifying the shipping carrier for this fulfillment. Note: The Trading API's ShippingCarrierCodeType enumeration contains the most current list of eBay shipping carrier codes and the countries served by each carrier. See ShippingCarrierCodeType. |
total | integer | Always |
The total number of fulfillments in the collection. Note: If no fulfillments are found for the order, this field is returned with a value of 0 .
|
warnings | array of ErrorDetailV3 | Conditionally | Contains warnings related to this call request. This is usually empty. |
warnings.category | string | Conditionally | The context or source of this error or warning. |
warnings.domain | string | Conditionally |
The name of the domain containing the service or application. For example, sell is a domain.
|
warnings.errorId | integer | Conditionally | 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. |
warnings.inputRefIds | array of string | Conditionally | 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. |
warnings.longMessage | string | Conditionally |
An expanded version of the message field. Maximum length: 200 characters |
warnings.message | string | Conditionally |
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 |
warnings.outputRefIds | array of string | Conditionally | 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. |
warnings.parameters | array of ErrorParameterV3 | Conditionally | 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. |
warnings.parameters.name | string | Conditionally | The name of the parameter. |
warnings.parameters.value | string | Conditionally | The value of the parameter. |
warnings.subdomain | string | Conditionally |
The name of the domain's subsystem or subdivision. For example, fulfillment is a subdomain in the sell domain.
|
Input Output Error Codes Samples Change History |
Code | Domain | Category | Nature | Meaning |
---|---|---|---|---|
30500 | API_FULFILLMENT | APPLICATION | ERROR | System error |
32100 | API_FULFILLMENT | REQUEST | ERROR | Invalid order ID: {orderId} |
Input Output Error Codes Samples Change History |
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
Retrieve all shipping fulfillments for a specified order.
Description
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.
URL format. See also the non-wrapped version of this URL. GET https://api.ebay.com/sell/fulfillment/v1/order/6498414015!260000000562911/shipping_fulfillment
Output
A successful call returns the ShippingFulfillmentPagedCollection container with one or more fulfillments objects.
JSON format.
{
"total": 1,
"fulfillments": [
{
"fulfillmentId": "1Z50992656936",
"shipmentTrackingNumber": "1Z50992656936",
"shippingCarrierCode": "USPS",
"shippingServiceCode": "USPS Priority Mail",
"shippedDate": "2016-09-27T19:28:13.000Z",
"lineItems": [
{
"lineItemId": "6262957011"
}
]
}
]
}
Input Output Error Codes Samples Change History |
Change Date | Description |
---|---|
1.0.0 2016-10-19 |
|
Copyright © 2016–2017 eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.