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.

eBay Fulfillment APIVersion 1.2.0

Get a Shipping Fulfillment

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

See also Samples.

Resource URI (production)

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

URI parameters

Parameter Type Required? Meaning
fulfillmentId string Required The 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.
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.


HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.



OAuth request scope

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.



Payload model

This call has no request payload.


Output

See also Samples.

HTTP status codes

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
404 Not Found
500 Internal Server Error

Payload model

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.

{ /* ShippingFulfillment */
"fulfillmentId": string,
"lineItems": [
    { /* LineItemReference */
    "lineItemId": string
    }
    /* More LineItemReference nodes here */
  ],
"shipmentTrackingNumber": string,
"shippedDate": string,
"shippingCarrierCode": string
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
fulfillmentId string Always The unique identifier of the fulfillment; for example, 9405509699937003457459. This eBay-generated value was created by the Create Shipping Fulfillment call.
lineItems array of LineItemReference Always Contains a list of the line items to which the fulfillment applies.
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.
shipmentTrackingNumber string Conditionally The tracking number provided by the shipping carrier for this fulfillment.
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
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.



Error Codes

Code Domain Category Nature Meaning
30500 API_FULFILLMENT APPLICATION ERROR System error
32100 API_FULFILLMENT REQUEST ERROR Invalid order ID: {orderId}
32110 API_FULFILLMENT REQUEST ERROR Invalid shipping fulfillment ID: {fulfillmentId}



Samples

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.

Sample: Get a Shipping Fulfillment

Retrieve the shipping fulfillment specified by fulfillment ID.

Description

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.

URL format. See also the non-wrapped version of this URL.

GET https://api.ebay.com/sell/fulfillment/v1/order/6498414015!260000000562911/shipping_fulfillment/1Z50992656936

Output

A successful call returns one ShippingFulfillment container.

JSON format.
{
  "fulfillmentId": "1Z50992656936",
  "shipmentTrackingNumber": "1Z50992656936",
  "shippingCarrierCode": "USPS",
  "shippingServiceCode": "USPS Priority Mail",
  "shippedDate": "2016-09-27T19:28:13.000Z",
  "lineItems": [
    {
      "lineItemId": "6262957011"
    }
  ]
}



Change History

Change Date Description
1.0.0
2016-10-19
  • Call (added): New call.