Skip to main content

GET/consign_preference

Important! This method is only available for Greater-China based sellers with an active eDIS account.


This method can be used to retrieve information about all the pickup, drop-off, and/or forward deployment consign addresses associated with a seller's eDIS account.

Input

Resource URI

GET https://api.ebay.com/sell/edelivery_international_shipping/v1/consign_preference

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

This method has no URI parameters.

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

{ /* GetConsignPreferenceListResponses */
"consignPreferenceList" :
{ /* GetConsignPreferenceListResponsesData */
"consignPreferences" : [
{ /* ConsignPreferenceInfoResponses */
"consignPreferenceId" : "string",
"consignPreferenceName" : "string",
"dropoffSiteId" : "string",
"pickupAddress" :
{ /* PickupAddressResponsesData */
"city" : "string",
"cityName" : "string",
"company" : "string",
"contact" : "string",
"countryCode" : "string",
"countryName" : "string",
"district" : "string",
"districtName" : "string",
"name" : "string",
"phone" : "string",
"postcode" : "string",
"province" : "string",
"provinceName" : "string",
"street1" : "string",
"street2" : "string",
"street3" : "string"
},
"pickupTime" : "PickUpTimeTypeEnum : [TIME_14_16,TIME_16_18]",
"type" : "ConsignTypeEnum : [PICK_UP,DROP_OFF,FORWARD_DEPLOYMENT]"
}
]
}
}

Response fields

Output container/fieldTypeDescription
consignPreferenceListGetConsignPreferenceListResponsesData

This container returns a list of all consign addresses associated with a seller's eDIS account.

Occurrence: Always

consignPreferenceList.consignPreferencesarray of ConsignPreferenceInfoResponses

This array returns information about each of a seller's consign addresses associated with their eDIS account.

Occurrence: Always

consignPreferenceList.consignPreferences.consignPreferenceIdstring

The unique identifier of the consign address.

Occurrence: Always

consignPreferenceList.consignPreferences.consignPreferenceNamestring

The name of the consign address.

Occurrence: Always

consignPreferenceList.consignPreferences.dropoffSiteIdstring

The unique identifier of the drop-off site.

This field is only returned if the consign address is a drop-off location.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddressPickupAddressResponsesData

This container returns the address and contact information for a pickup address.

Note: This container is always returned, but will show as null or have an empty value if not defined/applicable.

Occurrence: Always

consignPreferenceList.consignPreferences.pickupAddress.citystring

The city code of the pickup address.

See 商户API地址编码主数据 for valid city codes.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.cityNamestring

The city name of the pickup address.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.companystring

The name of the company associated with the pickup address.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.contactstring

The name of the contact person associated with the pickup address.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.countryCodestring

The two-letter country code of the pickup address.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.countryNamestring

The name of the country of the pickup address.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.districtstring

The district code of the pickup address.

See 商户API地址编码主数据 for valid district codes.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.districtNamestring

The district name of the pickup address.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.namestring

The name of the pickup address.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.phonestring

The phone number associated with the pickup address.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.postcodestring

The postal code of the pickup address.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.provincestring

The province code of the pickup address.

See 商户API地址编码主数据 for valid province codes.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.provinceNamestring

The name of the province of the pickup address.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.street1string

The first line of the street address of the pickup address.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.street2string

The second line, if applicable, of the street address of the pickup address.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupAddress.street3string

The third line, if applicable, of the street address of the pickup address.

Occurrence: Conditional

consignPreferenceList.consignPreferences.pickupTimePickUpTimeTypeEnum

The supported pickup window that the pickup location supports.

This field is only returned if the consign address is a pickup-from location

Occurrence: Conditional

consignPreferenceList.consignPreferences.typeConsignTypeEnum

The address type of the consign address.

Valid values:

  • PICK_UP
  • DROP_OFF
  • FORWARD_DEPLOYMENT

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.

StatusMeaning
200OK
401Unauthorized
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
355000API_EDISAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
355400API_EDISREQUESTThe 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 all consign addresses associated with your eDIS account

This method retrieves all consign addresses associated with the user's eDIS account.

Input

There are no input parameters for this method.

GEThttps://api.ebay.com/sell/edelivery_international_shipping/v1/consign_preference

Output

If the call is successful, information about each consign address preference associated with a user's eDIS account is returned.

In this sample, seven consign addresses, along with their location, contact, identifier information, and type are returned.