GET/package/{order_line_item_id}/item
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve one or more packages based on the provided order line item ID.
This method can be followed up with getPackage call to retrieve more detailed information about a specific package.
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 |
|---|---|---|
| order_line_item_id | string | This path parameter can be used to specify the unique identifier of the line item that is part of the package being retrieved. This value is returned in the lineItemId field of the getOrders method of the Fulfillment API or the GetOrders method of the Trading API. 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/scope/sell.edelivery
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 |
|---|---|---|
| itemPackages | array of GetItemPackageIdResponsesData | This array returns a list of packages associated with the specified line item ID. Occurrence: Always |
| itemPackages.packageId | string | The unique identifier of the package. Occurrence: Always |
| itemPackages.packageStatus | PackageStatusEnum | The current status of the package. Occurrence: Always |
| itemPackages.trackingNumber | string | The tracking number of the package. Occurrence: Always |
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 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 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 |
|---|---|---|---|
| 355000 | API_EDIS | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 355062 | API_EDIS | REQUEST | Invalid orderLineItemId {orderLineitemId}. Please verify and try again. |
| 355400 | API_EDIS | REQUEST | The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list. |
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: Retrieve packages associated with an order line item
This method can be used to retrieve the package(s) associated with the specified order line item ID value.
Input
To use this method, the ID of the line item that is part of the package(s) being retrieved must be specified in the order_line_item_id path parameter.
GEThttps://api.ebay.com/sell/edelivery_international_shipping/v1/package/2**********9/item
Output
If the call is successful, an the itemPackages array will be returned, listing each package specified order line item is a part of, as well as the ID, status, and tracking number of the package(s).