GET/package/{package_id}
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve a package based on the provided package ID value.
The packageId value of the package to be retrieved must be input as a path parameter in the request. If the call is successful, information about the package is returned, such as the package's shipping information (its dimensions, weight, ship from, and ship to address) and information about the item(s) it contains.
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 |
|---|---|---|
| package_id | string | This path parameter specifies the unique identifier of the package being retrieved. This ID value is returned when creating a package through the createPackage method. 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 |
|---|---|---|
| packageDetail | GetPackageDetailResponsesData | This container returns the details for the specified package. Occurrence: Always |
| packageDetail.agentInfoResponse | AgentInfoData | This container returns EU AR agent information associated with the package. Occurrence: Conditional |
| packageDetail.agentInfoResponse.agentAddress | string | The address of the EU AR agent. Occurrence: Conditional |
| packageDetail.agentInfoResponse.agentName | string | The name of the EU AR agent. Occurrence: Conditional |
| packageDetail.agentInfoResponse.agentPhone | string | The phone number of the EU AR agent. Occurrence: Conditional |
| packageDetail.consignPreferenceId | string | The unique identifier of the consign address associated with the package. Occurrence: Always |
| packageDetail.incoterm | IncotermEnum | The incoterm information associated with the package.
Occurrence: Conditional |
| packageDetail.items | array of ItemResponses | This array returns information about the eBay line item(s) that are included in the package. Occurrence: Always |
| packageDetail.items.buyerId | string | The buyer's eBay ID. Occurrence: Always |
| packageDetail.items.buyerTaxId | string | The buyer's tax ID. Occurrence: Conditional |
| packageDetail.items.buyerTaxType | string | The buyer's tax type. Occurrence: Conditional |
| packageDetail.items.ebayCollectAndRemitTax | boolean | If returned as Occurrence: Conditional |
| packageDetail.items.ebayCollectAndRemitTaxesValue | string | The value of the collect and remit tax for the corresponding line item. This field is only returned if collect and remit tax is applied to the line item. Occurrence: Conditional |
| packageDetail.items.email | string | The buyer's eBay email address. Occurrence: Conditional |
| packageDetail.items.itemTitle | string | The seller created title of the item. Occurrence: Always |
| packageDetail.items.listingId | string | The unique identifier of the eBay listing associated with the item. Occurrence: Always |
| packageDetail.items.message | string | The buyer's eBay message. Occurrence: Conditional |
| packageDetail.items.orderId | string | The unique identifier of the eBay order that the line item belongs to. Occurrence: Always |
| packageDetail.items.orderLineItem | string | The unique identifier of an eBay order line item. Occurrence: Conditional |
| packageDetail.items.paymentDate | string | The date and time that the payment was received by the seller. This timestamp is returned in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. Occurrence: Always |
| packageDetail.items.payPalEmail | string | The buyer's PayPal email address. Occurrence: Conditional |
| packageDetail.items.payPalMessage | string | The buyer's PayPal message Occurrence: Conditional |
| packageDetail.items.postedQuantity | integer | The quantity of the line item shipped with the package. Occurrence: Conditional |
| packageDetail.items.siteId | integer | The unique identifier of the eBay site in which the order occurred. Occurrence: Always |
| packageDetail.items.sku | SkuRequest | This container returns SKU-related information relating to the item being shipped in the package. Occurrence: Conditional |
| packageDetail.items.sku.elecQualificationId | string | The unique identifier of the battery's electric qualification, which indicates that the battery has a certificate of approval for global shipping. Occurrence: Conditional |
| packageDetail.items.sku.fdcSkus | array of FDCSkuRequest | This array lists the FDC SKUs associated with the item. An FDC SKU is the SKU label in a forward deployment center. Important! Please contact customer service before using these fields. Occurrence: Conditional |
| packageDetail.items.sku.fdcSkus.quantity | integer | The quantity of the FDC SKU. Occurrence: Conditional |
| packageDetail.items.sku.fdcSkus.skuId | string | The unique identifier of the FDC SKU. Occurrence: Conditional |
| packageDetail.items.sku.height | number | The height of the item in centimeters. Occurrence: Conditional |
| packageDetail.items.sku.isLiBattery | boolean | This boolean indicates if the item contains a battery. Occurrence: Conditional |
| packageDetail.items.sku.length | number | The length of the item in centimeters. Occurrence: Conditional |
| packageDetail.items.sku.liBatteryType | LiBatteryTypeEnum | If the item contains a battery, this field indicates the type of battery the item contains. Occurrence: Conditional |
| packageDetail.items.sku.nameEn | string | The English name of the item. Occurrence: Conditional |
| packageDetail.items.sku.nameZh | string | The Chinese name of the item. Occurrence: Conditional |
| packageDetail.items.sku.origin | string | The country of origin of the item. Occurrence: Conditional |
| packageDetail.items.sku.price | Amount | The declared price of the item. Occurrence: Conditional |
| packageDetail.items.sku.price.currency | CurrencyCodeEnum | This enum value represents the type of currency being used. Both the value and currency fields are required/always returned when expressing cost. Occurrence: Conditional |
| packageDetail.items.sku.price.value | string | The monetary amount, in the currency specified by the currency field. Occurrence: Conditional |
| packageDetail.items.sku.remark | string | A remark to the seller themselves. Occurrence: Conditional |
| packageDetail.items.sku.skuNumber | string | The stock keeping unit (SKU) identifier of the item. Occurrence: Conditional |
| packageDetail.items.sku.tariffCode | string | The Harmonized System code for custom declaration. This value declares the category of the item.. Occurrence: Conditional |
| packageDetail.items.sku.weight | number | The weight of the item in grams. Occurrence: Conditional |
| packageDetail.items.sku.width | number | The width of the item in centimeters. Occurrence: Conditional |
| packageDetail.items.soldDate | string | The date the item was sold. Occurrence: Always |
| packageDetail.items.soldPrice | Amount | The price for which the item was sold. Occurrence: Always |
| packageDetail.items.soldPrice.currency | CurrencyCodeEnum | This enum value represents the type of currency being used. Both the value and currency fields are required/always returned when expressing cost. Occurrence: Conditional |
| packageDetail.items.soldPrice.value | string | The monetary amount, in the currency specified by the currency field. Occurrence: Conditional |
| packageDetail.items.soldQuantity | integer | The quantity of the line item that was sold. Occurrence: Always |
| packageDetail.items.transactionId | string | The unique identifier of the eBay transaction. Occurrence: Always |
| packageDetail.lastMileTrackingNumber | string | The last-mile tracking number of the package. Occurrence: Conditional |
| packageDetail.packageComment | string | The seller-defined remark to the buyer associated with the package. Occurrence: Conditional |
| packageDetail.packageHeight | number | The height of the package in centimeters. Occurrence: Always |
| packageDetail.packageId | string | The unique identifier of the package. Occurrence: Always |
| packageDetail.packageLength | number | The length of the package in centimeters. Occurrence: Always |
| packageDetail.packageStatus | PackageStatusEnum | The current status of the package. Occurrence: Always |
| packageDetail.packageWeight | number | The weight of the package in grams. Occurrence: Always |
| packageDetail.packageWidth | number | The width of the package in centimeters. Occurrence: Always |
| packageDetail.paymentCost | Amount | The actual payment cost of the package. Occurrence: Conditional |
| packageDetail.paymentCost.currency | CurrencyCodeEnum | This enum value represents the type of currency being used. Both the value and currency fields are required/always returned when expressing cost. Occurrence: Conditional |
| packageDetail.paymentCost.value | string | The monetary amount, in the currency specified by the currency field. Occurrence: Conditional |
| packageDetail.shipFromAddressId | string | The unique identifier of the ship-from address associated with the package. Occurrence: Always |
| packageDetail.shippingServiceId | string | The unique identifier of the shipping service used for the package. Occurrence: Always |
| packageDetail.shipToAddress | ShipToAddressResponsesData | This container returns information about the address the package is being shipped to. Occurrence: Always |
| packageDetail.shipToAddress.city | string | The city code of the ship-to address. Occurrence: Always |
| packageDetail.shipToAddress.company | string | The name of the company associated with the ship-to address. Occurrence: Always |
| packageDetail.shipToAddress.contact | string | The name of the contact person associated with the ship-to address. Occurrence: Always |
| packageDetail.shipToAddress.countryCode | string | The two-letter country code of the ship-to address. Occurrence: Always |
| packageDetail.shipToAddress.countryName | string | The country name of the ship-to address. Occurrence: Always |
| packageDetail.shipToAddress.district | string | The district code of the ship-to address. Occurrence: Always |
| packageDetail.shipToAddress.phone | string | The phone number associated with the ship-to address. Occurrence: Always |
| packageDetail.shipToAddress.postcode | string | The postal code of the ship-to address. Occurrence: Always |
| packageDetail.shipToAddress.province | string | The province code of the ship-to address. Occurrence: Always |
| packageDetail.shipToAddress.street1 | string | The first line of the street address of the ship-to address. Occurrence: Always |
| packageDetail.shipToAddress.street2 | string | The second line of the street address of the ship-to address. Occurrence: Conditional |
| packageDetail.shipToAddress.street3 | string | The third line of the street address of the ship-to address. Occurrence: Conditional |
| packageDetail.specialServiceDetail | SpecialServiceDetail | This container returns any special services associated with this package. Occurrence: Always |
| packageDetail.specialServiceDetail.insuranceFee | string | The insurance fee, if applicable, on the package. Occurrence: Conditional |
| packageDetail.specialServiceDetail.packagingType | string | The package type.
Occurrence: Conditional |
| packageDetail.specialServiceDetail.signatureType | string | The signature type, if applicable, for the package.
Occurrence: Conditional |
| packageDetail.specialServiceDetail.specialServiceTypes | array of string | Any special service types supported for the package. Occurrence: Conditional |
| packageDetail.valueForCarriage | string | The declared value of the package. 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 | 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. |
| 355004 | API_EDIS | REQUEST | The specified packageId {packageId} is not recognized. Please check 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 a package
This method can be used to retrieve a package based on the provided package ID value.
Input
To use this method, the ID of the packages you wish to retrieve must be input in the package_id path parameter. No other request payload is required.
GEThttps://api.ebay.com/sell/edelivery_international_shipping/v1/package/1********6
Output
If the call is successful, detailed information about the package is returned, such as the package's shipping information (its dimensions, weight, ship from, and ship to address) and information about the item(s) it contains.