{ "openapi": "3.0.0", "info": { "title": "EDIS public shipping API", "description": "

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


This API allows 3rd party developers in the Greater-China area to process package shipping details.", "contact": { "name": "eBay Inc," }, "license": { "name": "eBay API License Agreement", "url": "https://developer.ebay.com/join/api-license-agreement" }, "version": "1.1.0" }, "servers": [ { "url": "https://api.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/edelivery_international_shipping/v1" } } } ], "paths": { "/actual_costs": { "get": { "tags": [ "actual_costs" ], "description": "

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


This method is used to retrieve the actual weight and cost for one or more packages based on the provided input criteria.

Responses can be filtered by the tracking_numbers query parameter. If this parameter is used, actual costs for each package associated with the provided tracking numbers are returned.

Alternatively, responses can be filtered by the trans_begin_time and trans_end_time query parameters. If these parameters are used, the actual costs of all packages created within this date range are returned.

Only one filtering method can be used per call.", "operationId": "getActualCosts", "parameters": [ { "name": "tracking_numbers", "in": "query", "description": "This query parameter specifies the tracking number(s) of the package(s) for which to retrieve the actual weight and cost. Tracking numbers are returned when creating packages through the createPackage method.

Up to 200 tracking numbers can be provided.

Note: This query parameter is required if trans_begin_time and trans_end_time is not provided.", "required": false, "schema": { "type": "string" } }, { "name": "trans_begin_time", "in": "query", "description": "This query parameter specifies the start time of a transaction in UTC format.

If the the trans_begin_time and trans_end_time query parameters are used, the actual costs of all packages created within this date range are returned.

Note: This query parameter and trans_end_time are required if tracking_numbers is not provided.
Format: YYYY-MM-DDTHH:MM:SS.SSSZ", "required": false, "schema": { "type": "string" } }, { "name": "trans_end_time", "in": "query", "description": "This query parameter specifies ending time of a transaction in UTC format.

If the the trans_begin_time and trans_end_time query parameters are used, the actual costs of all packages created within this date range are returned.

Note: This query parameter and trans_start_time are required if tracking_numbers is not provided.
Format: YYYY-MM-DDTHH:MM:SS.SSSZ", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetActualCostResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355069": { "domain": "API_EDIS", "category": "REQUEST", "description": "The date format of the trans_begin_time field is incorrect." }, "355070": { "domain": "API_EDIS", "category": "REQUEST", "description": "The date format of the trans_end_time field is incorrect." }, "355071": { "domain": "API_EDIS", "category": "REQUEST", "description": "The specified tracking number {tracking_number} does not belong to the seller, so cannot be retrieved." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/address_preference": { "get": { "tags": [ "address_preference" ], "description": "

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 ship-from and/or return addresses associated with a seller's eDIS account.", "operationId": "getAddressPreferences", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAddressPreferenceListResponses" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] }, "post": { "tags": [ "address_preference" ], "description": "

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


This method can be used to create an address on your eDIS account.

The following types of addresses can be created through this method:The address information for the address, including location details, contact information, and address type, must be provided in the shipFromAddress container. If the call is successful, the addressId for the newly created address will be returned. This identifier can then be used when creating a package to specify the address to use for the shipment.", "operationId": "createAddressPreference", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAddressPreferenceRequest" } } }, "required": false }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAddressPreferenceResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355002": { "domain": "API_EDIS", "category": "REQUEST", "description": "Length of street can not be greater than 50. Please revise it." }, "355072": { "domain": "API_EDIS", "category": "REQUEST", "description": "Invalid input value for countrycode. Please revise it." }, "355073": { "domain": "API_EDIS", "category": "REQUEST", "description": "Invalid input value for province. Please revise it." }, "355074": { "domain": "API_EDIS", "category": "REQUEST", "description": "Invalid input value for city. Please revise it." }, "355075": { "domain": "API_EDIS", "category": "REQUEST", "description": "Invalid input value for district. Please revise it." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." }, "355049": { "domain": "API_EDIS", "category": "APPLICATION", "description": "Connection failed with logistic service provider system. Please wait and retry." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/agents": { "get": { "tags": [ "agents" ], "description": "

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 the EU Authorized Representative (AR) agent(s) associated with a seller's eDIS account.

An EU AR agent acts as a liaison between non-EU manufacturers and European regulatory authorities to ensure compliance with EU regulations. This method returns contact information about each agent, as well as their eBay ID and the countries that they support.", "operationId": "getAgents", "parameters": [ { "name": "limit", "in": "query", "description": "This query parameter sets the maximum number of agents to return on each page of the paginated response.

Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10, the call retrieves orders 11 through 20 from the result set.

Max: 200

Default: 50", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "This query parameter specifies the number of agents to skip in the result set before returning the first agent in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.

Default: 0", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAgentListResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355076": { "domain": "API_EDIS", "category": "REQUEST", "description": "Invalid input value of pagination parameters. Please revise them." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/battery_qualifications": { "get": { "tags": [ "battery_qualifications" ], "description": "

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


This method is used to retrieve all battery qualifications associated with your eDIS account. This includes the type, electronic qualification ID and name, and expiration date for each battery.", "operationId": "getBatteryQualifications", "parameters": [ { "name": "limit", "in": "query", "description": "This query parameter sets the maximum number of qualifications to return on each page of the paginated response.

Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10, the call retrieves orders 11 through 20 from the result set.

Max: 200

Default: 50", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "This query parameter specifies the number of qualifications to skip in the result set before returning the first qualification in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.

Default: 0", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBatteryQualListResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355076": { "domain": "API_EDIS", "category": "REQUEST", "description": "Invalid input value of pagination parameters. Please revise them." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/bundle/{bundle_id}/cancel": { "post": { "tags": [ "bundle" ], "description": "

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


This method is used to cancel a bundle.

The bundleId value of the bundle to be canceled must be input as a path parameter in the request.

Note: Bundles cannot be canceled if they are currently being processed.", "operationId": "cancelBundle", "parameters": [ { "name": "bundle_id", "in": "path", "description": "This path parameter specifies the unique identifier of the bundle being canceled.

This ID value is returned when creating a bundle through the createBundle method.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355082": { "domain": "API_EDIS", "category": "REQUEST", "description": "No permission to access requested data." }, "355083": { "domain": "API_EDIS", "category": "REQUEST", "description": "Missing or invalid bundle_id value." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/bundle": { "post": { "tags": [ "bundle" ], "description": "

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


This method is used to create a bundle for multiple packages in an order.

To create a bundle, the consign address to be associated with the bundle and the tracking numbers of the packages to be used in the bundle must be specified in the request.

If the call is successful, the bundleId for the newly created bundle will be returned.

Note: Sellers should keep track of the returned bundleId, as there is no programmatic way to retrieve this value at this time.", "operationId": "createBundle", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBundleRequest" } } }, "required": false }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBundleResponse" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355078": { "domain": "API_EDIS", "category": "REQUEST", "description": "Missing consign preference ID. Please check." }, "355079": { "domain": "API_EDIS", "category": "REQUEST", "description": "Missing tracking numbers. Please check." }, "355080": { "domain": "API_EDIS", "category": "REQUEST", "description": "Please choose packages with same consign preference option." }, "355081": { "domain": "API_EDIS", "category": "REQUEST", "description": "Total weight exceeded. Please check." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/bundle/{bundle_id}": { "get": { "tags": [ "bundle" ], "description": "

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


This method is used to retrieved information about a specific bundle based on the provided bundle ID value.

The bundle_id value of the bundle to be retrieved must be input as a path parameter in the request. If the call is successful, information about the bundle is returned, such as its associated consign preference ID and the tracking numbers of each package in the bundle.", "operationId": "getBundle", "parameters": [ { "name": "bundle_id", "in": "path", "description": "This path parameter specifies the unique identifier of the bundle being retrieved.

This ID value is returned when creating a bundle through the createBundle method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BundleDetailResponse" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355082": { "domain": "API_EDIS", "category": "REQUEST", "description": "No permission to access requested data." }, "355083": { "domain": "API_EDIS", "category": "REQUEST", "description": "Missing or invalid bundle_id value." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/bundle/{bundle_id}/label": { "get": { "tags": [ "bundle" ], "description": "

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


This method can be used to retrieve the bundle label for a bundle of packages.

The bundle for which to retrieve a bundle label is specified through the bundleId path parameter.

Bundle labels will be returned as base64 string values which can be converted to PDF files.", "operationId": "getBundleLabel", "parameters": [ { "name": "bundle_id", "in": "path", "description": "This path parameter specifies the unique identifier of the bundle for which to retrieve a label.

This ID value is returned when creating a bundle through the createBundle method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BundleLabelResponse" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355082": { "domain": "API_EDIS", "category": "REQUEST", "description": "No permission to access requested data." }, "355083": { "domain": "API_EDIS", "category": "REQUEST", "description": "Missing or invalid bundle_id value." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/complaint": { "post": { "tags": [ "complaint" ], "description": "

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


This method can be used to create a complaint about a shipment order. Complaints can be filed if there is a pickup delay on an order or if an item has been lost in transit.

The complaint reason, complaint type, and the date the issue occurred must be specified in the request. If the complaint is being filed for a missing package, the affected packageId values must also be specified in the affectedPackages array.

If the call was successful, HTTP status code 201 Created will be returned, and the complaint will be created.", "operationId": "createComplaint", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddComplaintRequest" } } }, "required": false }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355060": { "domain": "API_EDIS", "category": "REQUEST", "description": "Complaint submission is declined on logistic service provider side. Please contact customer service for help." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/consign_preference": { "get": { "tags": [ "consign_preference" ], "description": "

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.", "operationId": "getConsignPreferences", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetConsignPreferenceListResponses" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] }, "post": { "tags": [ "consign_preference" ], "description": "

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


This method can be used to create a consign address.

The following types of address preferences can be created via this method:The address information for the consign address must be provided in the consignAddress container. If the call is successful, the addressId for the newly created address will be returned. This ID can then be used when creating a package to specify the consign address to use for the shipment.", "operationId": "createConsignPreference", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConsignPreferenceRequest" } } }, "required": false }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConsignPreferenceResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355050": { "domain": "API_EDIS", "category": "REQUEST", "description": "Invalid value for type. Please check the document." }, "355051": { "domain": "API_EDIS", "category": "REQUEST", "description": "pickupTime is missing. Please check." }, "355053": { "domain": "API_EDIS", "category": "REQUEST", "description": "Connection failed with backend service. Please wait and retry." }, "355055": { "domain": "API_EDIS", "category": "REQUEST", "description": "Missing package address. Please check." }, "355056": { "domain": "API_EDIS", "category": "REQUEST", "description": "Missing request period. Please check." }, "355057": { "domain": "API_EDIS", "category": "REQUEST", "description": "Missing address ID of dropoff site. Please check." }, "355058": { "domain": "API_EDIS", "category": "REQUEST", "description": "Shipping preference name already exists. Please add a new name." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/dropoff_sites": { "get": { "tags": [ "dropoff_sites" ], "description": "

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


This method can be used to retrieve metadata for one or more drop-off sites associated with a seller's eDIS account.

Pagination query parameters are provided that allow users to control how many drop-off site locations are returned in the response.", "operationId": "getDropoffSites", "parameters": [ { "name": "limit", "in": "query", "description": "This query parameter sets the maximum number of drop-off site locations to return on each page of the paginated response.

Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10, the call retrieves orders 11 through 20 from the result set.

Max: 200

Default: 50", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "This query parameter specifies the number of drop-off site locations to skip in the result set before returning the first location in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.

Default: 0", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDropoffSiteListResponses" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/handover_sheet": { "get": { "tags": [ "handover_sheet" ], "description": "

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


This method can be used to retrieve the handover sheet for one or more packages in a pickup request.

The tracking numbers for the packages for which to retrieve handover sheets are specified through the tracking_numbers query parameter.

The retrieved handover sheet will be returned as a base64 string value, and can be used for confirmation with a pickup contact. Only one handover sheet will be returned for the specified packages.", "operationId": "getHandoverSheet", "parameters": [ { "name": "tracking_numbers", "in": "query", "description": "This query parameter specifies an array of tracking numbers for the packages for which to retrieve a handover sheet.

Tracking numbers are returned when creating packages through the createPackage method.

Up to 200 tracking numbers can be provided. Multiple tracking numbers can be input as individual query parameters. For example,

tracking_numbers=E***********************N&tracking_numbers=E***********************Q", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHandoverSheetResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355067": { "domain": "API_EDIS", "category": "REQUEST", "description": "The field tracking_numbers is required." }, "355068": { "domain": "API_EDIS", "category": "REQUEST", "description": "The specified tracking number {tracking_number} is not recognized. Please check and try again." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/labels": { "get": { "tags": [ "labels" ], "description": "

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


This method can be used to retrieve shipping labels for the one or more specified packages.

The packages for which to retrieve shipping labels can be specified through the tracking_numbers query parameter. The page size and print preference settings for the shipping label(s) can also be specified through the query parameters.

Shipping labels are returned as base64 string values which can be converted to PDF files. A separate file will be returned for each tracking number specified in the request.", "operationId": "getLabels", "parameters": [ { "name": "page_size", "in": "query", "description": "This query parameter specifies the page size of the retrieved shipping labels.

Valid values:", "required": false, "schema": { "type": "string" } }, { "name": "print_preference", "in": "query", "description": "This query parameter specifies one or more printing preferences to be set when retrieving shipping labels. Multiple values can be delimited by a comma.

Valid values:", "required": false, "schema": { "type": "string" } }, { "name": "tracking_numbers", "in": "query", "description": "This query parameter specifies an array of tracking numbers of the packages for which to retrieve shipping labels.

Tracking numbers are returned when creating packages through the createPackage method.

Up to 200 tracking numbers can be provided. Multiple tracking numbers can be input as individual query parameters.For example,

tracking_numbers=E***********************N&tracking_numbers=E***********************Q", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLabelListResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355004": { "domain": "API_EDIS", "category": "REQUEST", "description": "The specified tracking number {tracking_number} is not recognized. Please check and try again." }, "355067": { "domain": "API_EDIS", "category": "REQUEST", "description": "The field tracking_numbers is required." }, "355071": { "domain": "API_EDIS", "category": "REQUEST", "description": "The specified tracking number {tracking_number} does not belong to the seller, so cannot be retrieved." }, "355077": { "domain": "API_EDIS", "category": "REQUEST", "description": "Invalid input value for page setting parameters. Please revise it." } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/package/bulk_cancel_packages": { "post": { "tags": [ "package" ], "description": "

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


This method can be used to cancel multiple packages and their associated tracking numbers.

The package ID values for the packages to be canceled must be input in the packageIds array of the request.

Note: Packages cannot be cancelled if they are currently being processed. ", "operationId": "bulkCancelPackages", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelPackagesRequest" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelPackagesResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355004": { "domain": "API_EDIS", "category": "REQUEST", "description": "The specified packageId {packageId} is not recognized. Please check and try again." }, "355036": { "domain": "API_EDIS", "category": "REQUEST", "description": "Package processing. Please try again later." }, "355037": { "domain": "API_EDIS", "category": "REQUEST", "description": "Invalid packageId {packageId}. Please verify and try again." }, "355042": { "domain": "API_EDIS", "category": "REQUEST", "description": "The package cannot be cancelled due to its current status. Please check status and try again." }, "355044": { "domain": "API_EDIS", "category": "REQUEST", "description": "Cancel failed on logistic service provider side. Please contact logistic customer service for help." } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/package/bulk_confirm_packages": { "post": { "tags": [ "package" ], "description": "

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


This method can be used to confirm the shipping order for multiple packages.

The package ID values for the packages to be confirmed must be input in the packageIds array of the request.

After a package is confirmed, the estimated cost will be frozen in your wallet and the pickup request will be submitted.", "operationId": "bulkConfirmPackages", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmPackagesRequest" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmPackagesResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355004": { "domain": "API_EDIS", "category": "REQUEST", "description": "The specified packageId {packageId} is not recognized. Please check and try again." }, "355036": { "domain": "API_EDIS", "category": "REQUEST", "description": "Package processing. Please try again later." }, "355037": { "domain": "API_EDIS", "category": "REQUEST", "description": "Unrecognized packageId. Please check." }, "355038": { "domain": "API_EDIS", "category": "REQUEST", "description": "The package cannot be confirmed due to its current status. Please check the status and try again." }, "355039": { "domain": "API_EDIS", "category": "REQUEST", "description": "The package cannot be confirmed due to missing or invalid battery qualification. Please update battery qualification and try again." }, "355040": { "domain": "API_EDIS", "category": "REQUEST", "description": "The package cannot be confirmed due to missing or invalid tracking number. Please add tracking number for package and try again." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/package/bulk_delete_packages": { "post": { "tags": [ "package" ], "description": "

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


This method can be used to delete multiple packages.

The package ID values for the packages to be deleted must be input in the packageIds array of the request.

Note: Packages can only be deleted once they have been cancelled through the cancelPackage or bulkCancelPackages methods and no longer have a tracking number associated with them.", "operationId": "bulkDeletePackages", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePackagesRequest" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePackagesResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355004": { "domain": "API_EDIS", "category": "REQUEST", "description": "The specified packageId {packageId} is not recognized. Please check and try again." }, "355064": { "domain": "API_EDIS", "category": "REQUEST", "description": "The package cannot be deleted due to its current status. Please check the status and try again." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/package/{package_id}/cancel": { "post": { "tags": [ "package" ], "description": "

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


This method can be used to cancel a package and its associated tracking number.

The packageId value of the package to be canceled must be input as a path parameter in the request.

Note: Packages cannot be canceled if they are currently being processed.", "operationId": "cancelPackage", "parameters": [ { "name": "package_id", "in": "path", "description": "This path parameter specifies the unique identifier of the package being canceled.

This ID value is returned when creating a package through the createPackage method.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355004": { "domain": "API_EDIS", "category": "REQUEST", "description": "The specified packageId {packageId} is not recognized. Please check and try again." }, "355036": { "domain": "API_EDIS", "category": "REQUEST", "description": "Package processing. Please try again later." }, "355037": { "domain": "API_EDIS", "category": "REQUEST", "description": "Invalid packageId {packageId}. Please verify and try again." }, "355042": { "domain": "API_EDIS", "category": "REQUEST", "description": "The package cannot be cancelled due to its current status. Please check status and try again." }, "355044": { "domain": "API_EDIS", "category": "REQUEST", "description": "Cancel failed on logistic service provider side. Please contact logistic customer service for help." } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/package/{package_id}/clone": { "post": { "tags": [ "package" ], "description": "

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


This method can be used to clone a package for redelivery, resending the package with the same information input during the createPackage call.

The packageId value of the package to be cloned must be input as a path parameter in the request.", "operationId": "clonePackage", "parameters": [ { "name": "package_id", "in": "path", "description": "This path parameter specifies the packageId value of the package to be cloned.

This ID value is returned when creating a package through the createPackage method.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClonePackageResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355004": { "domain": "API_EDIS", "category": "REQUEST", "description": "The specified packageId {packageId} is not recognized. Please check and try again." }, "355045": { "domain": "API_EDIS", "category": "REQUEST", "description": "Current package status does not support re-ship function. Please check." }, "355046": { "domain": "API_EDIS", "category": "REQUEST", "description": "This package have exceeded the limit of re-ship times." } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/package/{package_id}/confirm": { "post": { "tags": [ "package" ], "description": "

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


This method can be used to confirm the shipping order for a package.

The packageId value of the package to be confirmed must be input as a path parameter in the request.

After confirmation the estimated cost will be frozen in your wallet and the pickup request will be submitted.", "operationId": "confirmPackage", "parameters": [ { "name": "package_id", "in": "path", "description": "This path parameter specifies the unique identifier of the package you wish to be confirmed.

This ID value is returned when creating a package through the createPackage method.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355004": { "domain": "API_EDIS", "category": "REQUEST", "description": "The specified packageId {packageId} is not recognized. Please check and try again." }, "355036": { "domain": "API_EDIS", "category": "REQUEST", "description": "Package processing. Please try again later." }, "355037": { "domain": "API_EDIS", "category": "REQUEST", "description": "Unrecognized packageId. Please check." }, "355038": { "domain": "API_EDIS", "category": "REQUEST", "description": "The package cannot be confirmed due to its current status. Please check the status and try again." }, "355039": { "domain": "API_EDIS", "category": "REQUEST", "description": "The package cannot be confirmed due to missing or invalid battery qualification. Please update battery qualification and try again." }, "355040": { "domain": "API_EDIS", "category": "REQUEST", "description": "The package cannot be confirmed due to missing or invalid tracking number. Please add tracking number for package and try again." }, "355041": { "domain": "API_EDIS", "category": "REQUEST", "description": "Package processing. Please try again later." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/package": { "post": { "tags": [ "package" ], "description": "

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


This method can be used to create a package for an order.

To create a package, the package's shipping information, such as the dimensions, weight, ship from, and ship to address, as well as information about the item(s) it contains must be specified in the request.

If the call is successful, the packageId and tracking number for the newly created package will be returned.

Note: Sellers should keep track of the returned packageId, as there is no programmatic way to retrieve this value at this time.", "operationId": "createPackage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddPackageRequest" } } }, "required": false }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddPackageResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355003": { "domain": "API_EDIS", "category": "REQUEST", "description": "Our current system setting is not allowing you to add packages via API. Please change your settings to ‘ship via API’ and try again." }, "355005": { "domain": "API_EDIS", "category": "REQUEST", "description": "OrderLineItem {orderLineItemId} has already been assigned to another package, so cannot be added to this one." }, "355008": { "domain": "API_EDIS", "category": "REQUEST", "description": "OrderLineItem is not matched to your ebayID. Please check." }, "355009": { "domain": "API_EDIS", "category": "REQUEST", "description": "Order not synced to system yet. Please wait and retry." }, "355011": { "domain": "API_EDIS", "category": "REQUEST", "description": "Order has not been paid. Please check." }, "355012": { "domain": "API_EDIS", "category": "REQUEST", "description": "ServiceId does not exist. Please check the document." }, "355013": { "domain": "API_EDIS", "category": "REQUEST", "description": "The fdcSkus array cannot be empty. Please include this array and add at least one sku and associated quantity for that sku." }, "355014": { "domain": "API_EDIS", "category": "REQUEST", "description": "You have exceeded the maximum amount of skus allowed under the fdcSkus array." }, "355015": { "domain": "API_EDIS", "category": "REQUEST", "description": "Each sku under fdcSkus array requires skuId and quantity. Please revise them." }, "355016": { "domain": "API_EDIS", "category": "REQUEST", "description": "The skus array has one or more duplicate skuId values. Please remove duplicate skus." }, "355017": { "domain": "API_EDIS", "category": "REQUEST", "description": "Length of skuId can not be greater than 50. Please revise it." }, "355018": { "domain": "API_EDIS", "category": "REQUEST", "description": "The SPECIAL_GOODS_WITH_NO_BATTERY enum value is only allowed when miniPackage is specified as the packagingType value." }, "355019": { "domain": "API_EDIS", "category": "REQUEST", "description": "User T&C update. Please sign the updated version of the Letter of Commitment for Lithium Battery items." }, "355020": { "domain": "API_EDIS", "category": "REQUEST", "description": "Your elecQualificationId does not exist. Please check your qualification list.\t" }, "355021": { "domain": "API_EDIS", "category": "REQUEST", "description": "The status of elecQualificationId is not avaliable. Please check." }, "355022": { "domain": "API_EDIS", "category": "REQUEST", "description": "Your elecQualificationId is expired. Please update a new one." }, "355023": { "domain": "API_EDIS", "category": "REQUEST", "description": "LiBatteryType is not matched to battery qualification." }, "355024": { "domain": "API_EDIS", "category": "REQUEST", "description": "No available shipping service found. Please revise package information and retry." }, "355025": { "domain": "API_EDIS", "category": "REQUEST", "description": "ServiceId not available. Please revise it and retry." }, "355026": { "domain": "API_EDIS", "category": "REQUEST", "description": "Package is now under processing. Please retry later." }, "355030": { "domain": "API_EDIS", "category": "REQUEST", "description": "The seller's balance could not be accessed to to pay for the package. Please contact logistics customer service for help." }, "355031": { "domain": "API_EDIS", "category": "REQUEST", "description": "Account balance is not enough to pay for the package. Please add sufficient funds to balance and try again." }, "355063": { "domain": "API_EDIS", "category": "REQUEST", "description": "AgentName or agentAddress is missing. Please revise them." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." }, "355066": { "domain": "API_EDIS", "category": "APPLICATION", "description": "Concurrent actions on same orderLineItem. Please wait and retry." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/package/{package_id}": { "get": { "tags": [ "package" ], "description": "

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.", "operationId": "getPackage", "parameters": [ { "name": "package_id", "in": "path", "description": "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.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPackageDetailResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355004": { "domain": "API_EDIS", "category": "REQUEST", "description": "The specified packageId {packageId} is not recognized. Please check and try again." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] }, "delete": { "tags": [ "package" ], "description": "

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


This method can be used to delete a package.

The packageId value of the package to be deleted must be input as a path parameter in the request. If the call is successful, HTTP status code 204 No Content will be returned, and the package will be deleted.

Note: Packages can only be deleted once they have been cancelled through the cancelPackage or bulkCancelPackages methods and no longer have a tracking number associated with them.", "operationId": "deletePackage", "parameters": [ { "name": "package_id", "in": "path", "description": "This path parameter specifies the unique identifier of the package being deleted. This package must already be cancelled and have no tracking number associated with it.

This ID value is returned when creating a package through the createPackage method.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355004": { "domain": "API_EDIS", "category": "REQUEST", "description": "The specified packageId {packageId} is not recognized. Please check and try again." }, "355064": { "domain": "API_EDIS", "category": "REQUEST", "description": "The package cannot be deleted due to its current status. Please check the status and try again." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/package/{order_line_item_id}/item": { "get": { "tags": [ "package" ], "description": "

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.", "operationId": "getPackagesByLineItemID", "parameters": [ { "name": "order_line_item_id", "in": "path", "description": "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.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetItemPackageIdResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355062": { "domain": "API_EDIS", "category": "REQUEST", "description": "Invalid orderLineItemId {orderLineitemId}. Please verify and try again." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/services": { "get": { "tags": [ "services" ], "description": "

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


This method can be used to retrieve metadata on available shipping services, such as the name, description, and directions.", "operationId": "getServices", "parameters": [ { "name": "limit", "in": "query", "description": "This query parameter sets the maximum number of shipping services to return on each page of the paginated response.

Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10, the call retrieves orders 11 through 20 from the result set.

Max: 200

Default: 50", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "This query parameter specifies the number of shipping services to skip in the result set before returning the first shipping service in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.

Default: 0", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetServiceListResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355076": { "domain": "API_EDIS", "category": "REQUEST", "description": "Invalid input value of pagination parameters. Please revise them." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } }, "/tracking": { "get": { "tags": [ "tracking" ], "description": "

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


This method can be used to retrieve tracking event details for a package associated with the provided tracking number.

Each tracking event is returned in the trackingDetails array and includes the description, location, time, and status of the event.", "operationId": "getTracking", "parameters": [ { "name": "tracking_number", "in": "query", "description": "This query parameter specifies the tracking number for which to retrieve current tracking event details.

This value is returned when creating a package through the createPackage method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTrackingDetailResponses" } } } }, "400": { "description": "Bad Request", "x-response-codes": { "errors": { "355004": { "domain": "API_EDIS", "category": "REQUEST", "description": "The specified tracking number {tracking_number} is not recognized. Please check and try again." } } } }, "401": { "description": "Unauthorized", "x-response-codes": { "errors": { "355400": { "domain": "API_EDIS", "category": "REQUEST", "description": "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." } } } }, "404": { "description": "Not found" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "355000": { "domain": "API_EDIS", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/scope/sell.edelivery" ] } ] } } }, "components": { "schemas": { "AddComplaintRequest": { "type": "object", "properties": { "complaintRequest": { "description": "This container is used to specify the information included in a complaint request, such as the complaint reason, date, and type.", "$ref": "#/components/schemas/AddComplaintRequestData" } }, "description": "This type is used to define the request container of the createComplaint method." }, "AddComplaintRequestData": { "type": "object", "properties": { "affectedPackages": { "type": "array", "description": "This array specifies a list of packages, specified by their packageId, affected by the issue causing the complaint.

Package ID values are returned when creating a package through the createPackage method

This array is required if the complaint being filed is for a missing package.", "items": { "type": "string" } }, "complaintDate": { "type": "string", "description": "The date in which the issue associated with the complaint occurred.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ " }, "complaintReason": { "type": "string", "description": "This string specifies the reason the complaint was filed.

Max length: 200 characters" }, "complaintType": { "type": "string", "description": "The type of complaint being filed.

Valid values: For implementation help, refer to eBay API documentation" }, "preferenceId": { "type": "integer", "description": "The unique identifier of the address associated with the complaint.

This field is required if the complain being filed is associated with a specific address.", "format": "int32" }, "remark": { "type": "string", "description": "A remark to the seller themselves." } }, "description": "This type specifies the information included in a complaint request." }, "AddPackageRequest": { "type": "object", "properties": { "packageInfo": { "description": "This container is used to specify the information needed to create a package.", "$ref": "#/components/schemas/PackageInfoRequest" } }, "description": "This type defines the request container used in the createPackage method." }, "AddPackageResponses": { "type": "object", "properties": { "createPackageResult": { "description": "This container returns information about the newly created package, including its tracking number and packageId value.", "$ref": "#/components/schemas/AddPackageResponsesData" } }, "description": "This type defines the response container used in the createPackage method." }, "AddPackageResponsesData": { "type": "object", "properties": { "estimateCost": { "description": "The estimated shipping cost of the package.", "$ref": "#/components/schemas/Amount" }, "lastMileTrackingNumber": { "type": "string", "description": "The last-mile tracking number of the package.

This field is only returned if the last-mile tracking number is provided by the carrier." }, "packageId": { "type": "string", "description": "The unique identifier of the created package.

Note: Sellers should keep track of the returned packageId, as there is no programmatic way to retrieve this value at this time." }, "paymentCost": { "description": "The actual payment cost of the package.", "$ref": "#/components/schemas/Amount" }, "trackingNumber": { "type": "string", "description": "The tracking number of the created package." } }, "description": "This type specifies information about the newly created package, such as its estimated costs, tracking number, and package ID value." }, "AgentInfoData": { "type": "object", "properties": { "agentAddress": { "type": "string", "description": "The address of the EU AR agent." }, "agentName": { "type": "string", "description": "The name of the EU AR agent." }, "agentPhone": { "type": "string", "description": "The phone number of the EU AR agent." } }, "description": "This type defines information about an EU AR agent, such as their address, name, and phone number." }, "AgentModelResponses": { "type": "object", "properties": { "agentAddress": { "type": "string", "description": "The address of the EU AR agent." }, "agentName": { "type": "string", "description": "The name of the EU AR agent." }, "agentPhone": { "type": "string", "description": "The phone number of the EU AR agent." }, "agentPreferences": { "type": "array", "description": "This array returns the supported shipping countries and eBay user IDs associated with the EU AR agent.", "items": { "$ref": "#/components/schemas/AgentPreferenceListResponse" } }, "arName": { "type": "string", "description": "The seller-defined setting name of the AR agent." } }, "description": "This type defines the fields that describe an EU AR agent." }, "AgentPreferenceListResponse": { "type": "object", "properties": { "ebayId": { "type": "string", "description": "The eBay ID of the EU AR agent." }, "shippingCountry": { "type": "string", "description": "The two-letter ISO 3166 code of the shipping country that an EU AR agent supports." } }, "description": "This type defines the fields that describe a EU AR agents preferences." }, "Amount": { "type": "object", "properties": { "currency": { "type": "string", "description": "This enum value represents the type of currency being used. Both the value and currency fields are required/always returned when expressing cost.

See the CurrencyCodeEnum type for the full list of supported values.

Both the value and currency fields are required/always returned when expressing cost. For implementation help, refer to eBay API documentation" }, "value": { "type": "string", "description": "The monetary amount, in the currency specified by the currency field.

Both the value and currency fields are required/always returned when expressing cost." } }, "description": "This type defines the monetary value of an amount. " }, "BatteryQualResponses": { "type": "object", "properties": { "batteryType": { "type": "string", "description": "The type of the battery. For implementation help, refer to eBay API documentation" }, "elecQualificationId": { "type": "string", "description": "The unique identifier of the battery's electric qualification, which indicates that the battery has a certificate of approval for global shipping." }, "elecQualificationName": { "type": "string", "description": "The name of the battery's electric qualification." }, "expireDate": { "type": "string", "description": "The expiration date of the battery qualification." }, "remark": { "type": "string", "description": "A remark to the seller themselves.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." } }, "description": "This type defines the fields to describe a battery's qualifications." }, "BundleDetailResponse": { "type": "object", "properties": { "bundleDetail": { "description": "This container returns information about the retrieved bundle, such as its tracking numbers and consign preference ID.", "$ref": "#/components/schemas/BundleDetailResponseData" } }, "description": "This type defines the response payload of the getBundle method." }, "BundleDetailResponseData": { "type": "object", "properties": { "consignPreferenceId": { "type": "string", "description": "The unique identifier of the consign address associated with the retrieved bundle." }, "trackingNumbers": { "type": "array", "description": "This array specifies the tracking numbers of the packages included in the bundle.", "items": { "type": "string" } } }, "description": "This type is used to specify information, such as the tracking numbers and consign preference ID, of a bundle." }, "BundleLabelResponse": { "type": "object", "properties": { "label": { "description": "This container returns the bundle label information, such as the base64 string value, for the specified bundle.", "$ref": "#/components/schemas/BundleLabelResponseData" } }, "description": "This type defines the response container of the getBundleLabel method." }, "BundleLabelResponseData": { "type": "object", "properties": { "base64Str": { "type": "string", "description": "The base 64 string value for the bundle label.

This string value can be converted into a PDF file." } }, "description": "This type defines the base64 string value used to download a bundle label PDF file." }, "CancelPackagesRequest": { "type": "object", "properties": { "requests": { "description": "This container is used to specify the package ID values for the packages being canceled.", "$ref": "#/components/schemas/CancelPackagesRequestData" } }, "description": "This type defines the request container for the bulkCancelPackages method." }, "CancelPackagesRequestData": { "type": "object", "properties": { "packageIds": { "type": "array", "description": "This comma-delimited array lists the unique identifiers of the packages being canceled.

Up to 200 package IDs can be specified.", "items": { "type": "string" } } }, "description": "This type indicates the IDs of the packages being canceled." }, "CancelPackagesResponses": { "type": "object", "properties": { "responses": { "type": "array", "description": "This array returns the result code and message for each cancelled package. Each package is denoted by its package ID value.", "items": { "$ref": "#/components/schemas/CancelPackagesResponsesData" } } }, "description": "This type defines the response container of the bulkCancelPackages method." }, "CancelPackagesResponsesData": { "type": "object", "properties": { "message": { "type": "string", "description": "This string returns any additional information about the cancelation of the package." }, "packageId": { "type": "string", "description": "The unique identifier of the canceled package." }, "resultCode": { "type": "string", "description": "The result code detailing the results cancelation process.

For example, a result code of 200 indicates that the call was a success and the package and tracking number were canceled." } }, "description": "This type indicates the response data returned after canceling multiple packages." }, "ClonePackageResponses": { "type": "object", "properties": { "clonePackageResult": { "description": "This container returns the package ID, payment cost, and tracking number for the cloned package.", "$ref": "#/components/schemas/ClonePackageResponsesData" } }, "description": "This type defines the response container used in the clonePackage method." }, "ClonePackageResponsesData": { "type": "object", "properties": { "lastMileTrackingNumber": { "type": "string", "description": "The last-mile tracking number of the package.

This field is only returned if the last-mile tracking number is provided by the carrier." }, "packageId": { "type": "string", "description": "The unique identifier of the package. A new packageId value is generated when a package is cloned." }, "paymentCost": { "description": "The payment cost for the package.", "$ref": "#/components/schemas/Amount" }, "trackingNumber": { "type": "string", "description": "The tracking number for the cloned package." } }, "description": "This type specifies the package ID, payment cost, tracking number, and last-mile tracking number (if applicable) for the cloned package." }, "ConfirmPackagesRequest": { "type": "object", "properties": { "requests": { "description": "This container is used to specify the package ID values of the packages being confirmed.", "$ref": "#/components/schemas/ConfirmPackagesRequestData" } }, "description": "This type defines the request container of the bulkConfirmPackages method." }, "ConfirmPackagesRequestData": { "type": "object", "properties": { "packageIds": { "type": "array", "description": "This comma-delimited array lists the unique identifiers of the packages being confirmed.

Up to 200 packages can be specified.", "items": { "type": "string" } } }, "description": "This type specifies the IDs of the packages being confirmed." }, "ConfirmPackagesResponses": { "type": "object", "properties": { "responses": { "type": "array", "description": "This array returns the result code and message for each confirmed package. Each package is denoted by its package ID value.", "items": { "$ref": "#/components/schemas/ConfirmPackagesResponsesData" } } }, "description": "This type defines the response container of the bulkConfirmPackages method." }, "ConfirmPackagesResponsesData": { "type": "object", "properties": { "message": { "type": "string", "description": "This string returns any additional information about the confirmation of the package." }, "packageId": { "type": "string", "description": "The unique identifier of the confirmed package." }, "resultCode": { "type": "string", "description": "The result code relating to the confirmation of the package.

For example, a result code of 200 indicates that the call was a success and the package was confirmed." } }, "description": "This type indicates the response data after confirming multiple packages." }, "ConsignPreferenceInfoResponses": { "type": "object", "properties": { "consignPreferenceId": { "type": "string", "description": "The unique identifier of the consign address." }, "consignPreferenceName": { "type": "string", "description": "The name of the consign address." }, "dropoffSiteId": { "type": "string", "description": "The unique identifier of the drop-off site.

This field is only returned if the consign address is a drop-off location." }, "pickupAddress": { "description": "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.", "$ref": "#/components/schemas/PickupAddressResponsesData" }, "pickupTime": { "type": "string", "description": "The supported pickup window that the pickup location supports.

This field is only returned if the consign address is a pickup-from location For implementation help, refer to eBay API documentation" }, "type": { "type": "string", "description": "The address type of the consign address.

Valid values: For implementation help, refer to eBay API documentation" } }, "description": "This type specifies the fields used to create a consign address." }, "CreateAddressPreferenceRequest": { "type": "object", "properties": { "shipFromAddress": { "description": "This container is used to specify the address details used to create an address.", "$ref": "#/components/schemas/CreateAddressPreferenceRequestData" } }, "description": "This type is used to define the request container used in the createAddressPreference method." }, "CreateAddressPreferenceRequestData": { "type": "object", "properties": { "city": { "type": "string", "description": "The city code of the address.

See 商户API地址编码主数据 for valid city codes." }, "company": { "type": "string", "description": "The company name associated with the address.

Max length: 50 characters" }, "contact": { "type": "string", "description": "The name of the contact person associated with the address.

Max length: 50 characters" }, "countryCode": { "type": "string", "description": "The two-letter country code of the address.

Valid values:" }, "district": { "type": "string", "description": "The district code of the address.

See 商户API地址编码主数据 for valid district codes." }, "name": { "type": "string", "description": "The name of the address.

Max length: 50 characters" }, "phone": { "type": "string", "description": "The phone number associated with the address." }, "postcode": { "type": "string", "description": "The postal code of the address." }, "province": { "type": "string", "description": "The province code of the address.

See 商户API地址编码主数据 for valid province codes." }, "street1": { "type": "string", "description": "The first line of the street address of the address.

Max length: 50 characters" }, "street2": { "type": "string", "description": "The second line, if applicable, of the street address of the address.

Max length: 50 characters" }, "street3": { "type": "string", "description": "The third line, if applicable, of the street address of the address.

Max length: 50 characters" }, "type": { "type": "string", "description": "The address type of the address being created.

Valid values: For implementation help, refer to eBay API documentation" } }, "description": "This type is used to specify the address details used to create an address." }, "CreateAddressPreferenceResponses": { "type": "object", "properties": { "shipFromAddressId": { "description": "This container specifies the unique identifier of the newly created address.", "$ref": "#/components/schemas/CreateAddressPreferenceResponsesData" } }, "description": "This type is used to define the response container of the createAddressPreference method." }, "CreateAddressPreferenceResponsesData": { "type": "object", "properties": { "addressId": { "type": "string", "description": "The unique identifier of the newly-created address.

This ID value can be used when creating a package through the createPackage method to specify the ship-from or return address associated with the package." } }, "description": "This type defines the unique identifier of a newly created address." }, "CreateBundleRequest": { "type": "object", "properties": { "bundle": { "description": "This container is used to specify the information needed to create a bundle, such as the consign address associated with the bundle and the tracking numbers of the packages to be included in the bundle.", "$ref": "#/components/schemas/CreateBundleRequestData" } }, "description": "This type defines the request container of the createBundle method." }, "CreateBundleRequestData": { "type": "object", "properties": { "consignPreferenceId": { "type": "string", "description": "The unique identifier of the consign address to be associated with the bundle.

This ID can be retrieved using the getConsignPreferences method." }, "trackingNumbers": { "type": "array", "description": "This array specifies the tracking numbers of the packages to be included in the bundle.

Tracking numbers are returned when creating a package through the createPackage method.", "items": { "type": "string" } } }, "description": "This type defines the information used to create a bundle." }, "CreateBundleResponse": { "type": "object", "properties": { "bundle": { "description": "This container returns information about the newly created bundle, such as its bundleId value.", "$ref": "#/components/schemas/CreateBundleResponseData" } }, "description": "This type defines the response container of the createBundle method" }, "CreateBundleResponseData": { "type": "object", "properties": { "bundleId": { "type": "string", "description": "The unique identifier of the newly created bundle." } }, "description": "This type defines the unique identifier of the newly-created bundle." }, "CreateConsignPreferenceRequest": { "type": "object", "properties": { "consignAddress": { "description": "This container is used to specify the address details used to create a consign address.", "$ref": "#/components/schemas/CreateConsignPreferenceRequestData" } }, "description": "This type is used to define the request container of the createConsignPreference method." }, "CreateConsignPreferenceRequestData": { "type": "object", "properties": { "consignPreferenceName": { "type": "string", "description": "The name of the consign address." }, "dropoffSiteId": { "type": "string", "description": "The unique identifier of a drop-off site location. This value can be retrieved using the getDropoffSites method.

This field is required if the DROPOFF address type is specified." }, "pickupAddress": { "description": "This container is used to specify the address details used to create a pickup-from address.

This container is required if the PICK_UP address type is specified.", "$ref": "#/components/schemas/PickupAddressRequestData" }, "pickupTime": { "type": "string", "description": "The pickup time that the pickup location supports.

This field is required if the PICK_UP address type is specified. For implementation help, refer to eBay API documentation" }, "type": { "type": "string", "description": "The address type of the consign address.

Valid values: For implementation help, refer to eBay API documentation" } }, "description": "This type is used to specify the address details used to create a consign address." }, "CreateConsignPreferenceResponses": { "type": "object", "properties": { "consignAddressId": { "description": "This container specifies the unique identifier of the newly created consign address.", "$ref": "#/components/schemas/CreateConsignPreferenceResponsesData" } }, "description": "This type defines the response container for the createConsignPreference method." }, "CreateConsignPreferenceResponsesData": { "type": "object", "properties": { "consignPreferenceId": { "type": "string", "description": "The unique identifier of the newly-created consign address.

This ID can be used when creating a package through the createPackage method to specify the pickup, drop-off, or forward deployment address associated with the package." } }, "description": "This type defines the unique identifier of the newly created consign address." }, "DeletePackagesRequest": { "type": "object", "properties": { "requests": { "description": "This container is used to specify the package ID values for the packages being deleted.", "$ref": "#/components/schemas/DeletePackagesRequestData" } }, "description": "This type defines the request container for the bulkDeletePackages method." }, "DeletePackagesRequestData": { "type": "object", "properties": { "packageIds": { "type": "array", "description": "This comma-delimited array lists the unique identifiers of the packages being deleted. These values must be for packages that have been cancelled and do not have tracking numbers associated with them.

Package ID values are returned when creating a package through the createPackage method.", "items": { "type": "string" } } }, "description": "DeletePackagesRequestData" }, "DeletePackagesResponses": { "type": "object", "properties": { "responses": { "type": "array", "description": "This array returns the result code and message for each deleted package. Each package is denoted by its package ID value.", "items": { "$ref": "#/components/schemas/DeletePackagesResponsesData" } } }, "description": "This type defines the response container of the bulkDeletePackages method." }, "DeletePackagesResponsesData": { "type": "object", "properties": { "message": { "type": "string", "description": "This string returns any additional information about the deletion of the package." }, "packageId": { "type": "string", "description": "The unique identifier of the deleted package." }, "resultCode": { "type": "string", "description": "The result code detailing the result of the deletion process.

For example, a result code of 200 indicates that the call was a success and the package was deleted." } }, "description": "This type defines the response data after deleting multiple packages." }, "DirectionsResponses": { "type": "object", "properties": { "batteryType": { "type": "string", "description": "The supported battery type for the shipping service." }, "from": { "type": "string", "description": "The two-letter ISO 3166 ship-from country code." }, "to": { "type": "string", "description": "The two-letter ISO 3166 destination country code." } }, "description": "This container specifies direction information for a shipping service." }, "Error": { "type": "object", "properties": { "category": { "type": "string", "description": "Identifies the type of erro." }, "domain": { "type": "string", "description": "Name for the primary system where the error occurred. This is relevant for application errors." }, "errorId": { "type": "integer", "description": "A unique number to identify the error.", "format": "int32" }, "inputRefIds": { "type": "array", "description": "An array of request elements most closely associated to the error.", "items": { "type": "string" } }, "longMessage": { "type": "string", "description": "A more detailed explanation of the error." }, "message": { "type": "string", "description": "Information on how to correct the problem, in the end user's terms and language where applicable." }, "outputRefIds": { "type": "array", "description": "An array of request elements most closely associated to the error.", "items": { "type": "string" } }, "parameters": { "type": "array", "description": "An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.", "items": { "$ref": "#/components/schemas/ErrorParameter" } }, "subdomain": { "type": "string", "description": "Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc." } }, "description": "This type defines the fields that can be returned in an error." }, "ErrorParameter": { "type": "object", "properties": { "name": { "type": "string", "description": "The object of the error." }, "value": { "type": "string", "description": "The value of the object." } } }, "FDCSkuRequest": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "The quantity of the FDC SKU.", "format": "int32" }, "skuId": { "type": "string", "description": "The unique identifier of the FDC SKU." } }, "description": "This type specifies FDC SKU information." }, "GetActualCostResponses": { "type": "object", "properties": { "actualCosts": { "type": "array", "description": "This array returns a list of actual costs associated with the packages matching the input criteria.", "items": { "$ref": "#/components/schemas/GetActualCostResponsesData" } } }, "description": "This type defines the response containers of the getActualCost method." }, "GetActualCostResponsesData": { "type": "object", "properties": { "actualWeight": { "type": "number", "description": "The actual weight of the package in grams." }, "amount": { "description": "This container specifies the total monetary amount of the actual cost of the package. ", "$ref": "#/components/schemas/Amount" }, "billingTime": { "type": "string", "description": "The time the seller was charged for the actual cost of the package in UTC format." }, "chargeMode": { "type": "string", "description": "The two-digit charge mode for the package.

Valid values:" }, "chargeWeight": { "type": "number", "description": "The weight, in grams, charged for when shipping the package." }, "costType": { "type": "string", "description": "The two-digit cost type of the package. This field indicates any fees associated with the package.

The following values are the typical cost types returned through this field. If an undocumented cost type is returned, check the logistic provider's website for the latest values:
" }, "message": { "type": "string", "description": "A seller-defined message to the buyer regarding the transaction.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." }, "remark": { "type": "string", "description": "A remark to the seller themselves.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." }, "resultCode": { "type": "string", "description": "The result code associated with the call.

For example, a result code of 200 indicates that the call was a success." }, "size": { "type": "string", "description": "The size of the package in centimeters. This value is returned in Length*Width*Height format." }, "trackingNumber": { "type": "string", "description": "The tracking number associated with the package." } }, "description": "This type defines the actual weight, cost, and additional information of a specified package or packages." }, "GetAddressPreferenceListResponses": { "type": "object", "properties": { "addressPreferenceList": { "description": "This container returns all ship-from and/or return addresses associated with a seller's eDIS account.", "$ref": "#/components/schemas/GetAddressPreferenceListResponsesData" } }, "description": "This type defines the response container associated with the getAddressPreferences method." }, "GetAddressPreferenceListResponsesData": { "type": "object", "properties": { "addresses": { "type": "array", "description": "This array returns a list of address, contact, and identifier information for each of a seller's ship-from and/or return addresses associated with their eDIS account.", "items": { "$ref": "#/components/schemas/GetAddressPreferencesResponses" } } }, "description": "This type defines the list of addresses associated with a eDIS account." }, "GetAddressPreferencesResponses": { "type": "object", "properties": { "addressId": { "type": "string", "description": "The unique identifier of the address." }, "city": { "type": "string", "description": "The city code of the address.

See 商户API地址编码主数据 for valid city codes." }, "cityName": { "type": "string", "description": "The city name of the address." }, "company": { "type": "string", "description": "The company name associated with the address." }, "contact": { "type": "string", "description": "The name of the contact person associated with the address." }, "countryCode": { "type": "string", "description": "The two-letter country code of the address." }, "countryName": { "type": "string", "description": "The country name of the address." }, "district": { "type": "string", "description": "The district code of the address.

See 商户API地址编码主数据 for valid district codes." }, "districtName": { "type": "string", "description": "The district name of the address." }, "name": { "type": "string", "description": "The name of the address." }, "phone": { "type": "string", "description": "The phone number associated with the address." }, "postcode": { "type": "string", "description": "The postal code of the address." }, "province": { "type": "string", "description": "The province code of the address.

See 商户API地址编码主数据 for valid province codes." }, "provinceName": { "type": "string", "description": "The province name of the address." }, "street1": { "type": "string", "description": "The first line of the street address of the address." }, "street2": { "type": "string", "description": "The second line of the street address of the address.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." }, "street3": { "type": "string", "description": "The third line of the street address of address.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." }, "type": { "type": "string", "description": "The address type of the address. For implementation help, refer to eBay API documentation" } }, "description": "This type defines the fields associated with a seller's ship-from address, including the location and contact details of the addresses, as well as its unique identifier." }, "GetAgentListResponses": { "type": "object", "properties": { "agentList": { "description": "This container returns a list of all EU AR agents associated with your eDIS account and their information.", "$ref": "#/components/schemas/GetAgentListResponsesData" } }, "description": "This type defines the response container of the getAgents method." }, "GetAgentListResponsesData": { "type": "object", "properties": { "agents": { "type": "array", "description": "This array returns information about each EU AR agent associated with a seller's eDIS account, including their contact information, eBay ID, and supported shipping countries.", "items": { "$ref": "#/components/schemas/AgentModelResponses" } }, "href": { "type": "string", "description": "The URL to the current page of the result set." }, "limit": { "type": "integer", "description": "The value of the limit parameter submitted in the request.", "format": "int32" }, "next": { "type": "string", "description": "The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set." }, "offset": { "type": "integer", "description": "The value of the offset parameter submitted in the request.", "format": "int32" }, "prev": { "type": "string", "description": "The URI for the previous page of results. This is returned if there is a previous page of results from the result set." }, "total": { "type": "integer", "description": "The total number of results that match the input criteria.", "format": "int32" } }, "description": "This type defines the fields in a paginated result set of agents associated with a seller's eDIS account. The response consists of 0 or more sequenced pages that are returned from the complete result set, where each page consists of 0 or more items." }, "GetBatteryQualListResponses": { "type": "object", "properties": { "batteryQualificationList": { "description": "This container returns a list of all battery qualifications associated with an eDIS account.", "$ref": "#/components/schemas/GetBatteryQualListResponsesData" } }, "description": "This type defines the response container of the getbatteryQualifications method." }, "GetBatteryQualListResponsesData": { "type": "object", "properties": { "href": { "type": "string", "description": "The URL to the current page of the result set." }, "limit": { "type": "integer", "description": "The value of the limit parameter submitted in the request.", "format": "int32" }, "next": { "type": "string", "description": "The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set." }, "offset": { "type": "integer", "description": "The value of the offset parameter submitted in the request.", "format": "int32" }, "prev": { "type": "string", "description": "The URI for the previous page of results. This is returned if there is a previous page of results from the result set." }, "qualifications": { "type": "array", "description": "This array returns information about each battery qualification associated with an eDIS account, such as the battery type, qualification name, and expiration date.", "items": { "$ref": "#/components/schemas/BatteryQualResponses" } }, "total": { "type": "integer", "description": "The total number of results that match the input criteria.", "format": "int32" } }, "description": "This type defines the fields in a paginated result set of battery qualifications associated with a seller's eDIS account. The response consists of 0 or more sequenced pages that are returned from the complete result set, where each page consists of 0 or more items." }, "GetConsignPreferenceListResponses": { "type": "object", "properties": { "consignPreferenceList": { "description": "This container returns a list of all consign addresses associated with a seller's eDIS account.", "$ref": "#/components/schemas/GetConsignPreferenceListResponsesData" } }, "description": "This type defines the response container of the getConsignPreferences method." }, "GetConsignPreferenceListResponsesData": { "type": "object", "properties": { "consignPreferences": { "type": "array", "description": "This array returns information about each of a seller's consign addresses associated with their eDIS account.", "items": { "$ref": "#/components/schemas/ConsignPreferenceInfoResponses" } } }, "description": "This type defines the fields associated with a seller's consign addresses, including the location and contact details of the address, as well as its unique identifiers." }, "GetDropoffSiteListResponses": { "type": "object", "properties": { "dropoffSiteList": { "description": "This container returns a list of all of the drop-off site locations associated with an eDIS account.", "$ref": "#/components/schemas/GetDropoffSitesResponsesData" } }, "description": "This type defines the response container associated with the getDropoffSites method." }, "GetDropoffSitesResponses": { "type": "object", "properties": { "city": { "type": "string", "description": "The city code of the drop-off site location.

See 商户API地址编码主数据 for valid city codes." }, "contact": { "type": "string", "description": "The name of the contact person associated with the drop-off site location." }, "country": { "type": "string", "description": "The two-letter country code associated with the drop-off site location." }, "district": { "type": "string", "description": "The district code of the drop-off site location.

See 商户API地址编码主数据 for valid district codes." }, "dropoffSiteId": { "type": "string", "description": "The unique identifier of the drop-off site location." }, "name": { "type": "string", "description": "The name of the drop-off site location." }, "phone": { "type": "string", "description": "The phone number associated with the drop-off site location." }, "province": { "type": "string", "description": "The province code of the drop-off site location.

See 商户API地址编码主数据 for valid province codes." }, "street1": { "type": "string", "description": "The first line of the street address of the drop-off site location." }, "street2": { "type": "string", "description": "The second line, if applicable, of the street address of the drop-off site location.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." }, "street3": { "type": "string", "description": "The third line, if applicable, of the street address of the drop-off site location.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." }, "type": { "type": "string", "description": "The type of the drop-off site location.

Currently, the only valid response is DROP_OFF." } }, "description": "This type defines the fields associated with one or more drop-off sites associated with a seller's eDIS account." }, "GetDropoffSitesResponsesData": { "type": "object", "properties": { "dropoffSites": { "type": "array", "description": "This array returns address, contact, and identifier information for each of a seller's drop-off locations associated with their eDIS account.", "items": { "$ref": "#/components/schemas/GetDropoffSitesResponses" } }, "href": { "type": "string", "description": "The URL to the current page of the result set." }, "limit": { "type": "integer", "description": "The value of the limit parameter submitted in the request.", "format": "int32" }, "next": { "type": "string", "description": "The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set." }, "offset": { "type": "integer", "description": "The value of the offset parameter submitted in the request.", "format": "int32" }, "prev": { "type": "string", "description": "The URI for the previous page of results. This is returned if there is a previous page of results from the result set." }, "total": { "type": "integer", "description": "The total number of results that match the input criteria.", "format": "int32" } }, "description": "This type defines the list of drop-off site locations associated with an eDIS account." }, "GetHandoverSheetResponses": { "type": "object", "properties": { "handoverSheet": { "description": "This container returns the base64 string value for a handover sheet.", "$ref": "#/components/schemas/GetHandoverSheetResponsesData" } }, "description": "This type is used to define the response container for the getHandoverSheet method." }, "GetHandoverSheetResponsesData": { "type": "object", "properties": { "base64Str": { "type": "string", "description": "The base 64 string value for a handover sheet. This string can be converted to a PDF file once it has been retrieved." } }, "description": "This type specifies the base64 string value for a handover sheet." }, "GetItemPackageIdResponses": { "type": "object", "properties": { "itemPackages": { "type": "array", "description": "This array returns a list of packages associated with the specified line item ID.", "items": { "$ref": "#/components/schemas/GetItemPackageIdResponsesData" } } }, "description": "This type defines the response container of the getPackageByLineItemID method." }, "GetItemPackageIdResponsesData": { "type": "object", "properties": { "packageId": { "type": "string", "description": "The unique identifier of the package." }, "packageStatus": { "type": "string", "description": "The current status of the package. For implementation help, refer to eBay API documentation" }, "trackingNumber": { "type": "string", "description": "The tracking number of the package." } }, "description": "This type returns information on the packages being retrieved based on the specified line item ID. " }, "GetLabelListResponses": { "type": "object", "properties": { "labels": { "type": "array", "description": "This array returns the shipping label information, such as the base64 string value and result code for each specified tracking number.", "items": { "$ref": "#/components/schemas/GetLabelListResponsesData" } } }, "description": "This type defines the response container of the getLabels method." }, "GetLabelListResponsesData": { "type": "object", "properties": { "base64Str": { "type": "string", "description": "The base 64 string value for a shipping label.

This string value can be converted to a PDF file." }, "message": { "type": "string", "description": "A message relating to the status of the shipping label retrieval process." }, "resultCode": { "type": "string", "description": "The result code detailing the results of the shipping label retrieval process.

For example, a result code of 200 indicates that at least one shipping label was successfully retrieved." }, "trackingNumber": { "type": "string", "description": "The tracking number for which the shipping label is being retrieved." } }, "description": "GetLabelListResponsesData" }, "GetPackageDetailResponses": { "type": "object", "properties": { "packageDetail": { "description": "This container returns the details for the specified package.", "$ref": "#/components/schemas/GetPackageDetailResponsesData" } }, "description": "This type defines the response container of the getPackage method." }, "GetPackageDetailResponsesData": { "type": "object", "properties": { "agentInfoResponse": { "description": "This container returns EU AR agent information associated with the package.", "$ref": "#/components/schemas/AgentInfoData" }, "consignPreferenceId": { "type": "string", "description": "The unique identifier of the consign address associated with the package." }, "incoterm": { "type": "string", "description": "The incoterm information associated with the package.

Supported values: For implementation help, refer to eBay API documentation" }, "items": { "type": "array", "description": "This array returns information about the eBay line item(s) that are included in the package.", "items": { "$ref": "#/components/schemas/ItemResponses" } }, "lastMileTrackingNumber": { "type": "string", "description": "The last-mile tracking number of the package.

This field is only returned if the last-mile tracking number is provided by the carrier." }, "packageComment": { "type": "string", "description": "The seller-defined remark to the buyer associated with the package." }, "packageHeight": { "type": "number", "description": "The height of the package in centimeters." }, "packageId": { "type": "string", "description": "The unique identifier of the package." }, "packageLength": { "type": "number", "description": "The length of the package in centimeters." }, "packageStatus": { "type": "string", "description": "The current status of the package. For implementation help, refer to eBay API documentation" }, "packageWeight": { "type": "number", "description": "The weight of the package in grams." }, "packageWidth": { "type": "number", "description": "The width of the package in centimeters." }, "paymentCost": { "description": "The actual payment cost of the package.", "$ref": "#/components/schemas/Amount" }, "shipFromAddressId": { "type": "string", "description": "The unique identifier of the ship-from address associated with the package." }, "shippingServiceId": { "type": "string", "description": "The unique identifier of the shipping service used for the package." }, "shipToAddress": { "description": "This container returns information about the address the package is being shipped to.", "$ref": "#/components/schemas/ShipToAddressResponsesData" }, "specialServiceDetail": { "description": "This container returns any special services associated with this package.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.", "$ref": "#/components/schemas/SpecialServiceDetail" }, "valueForCarriage": { "type": "string", "description": "The declared value of the package." } }, "description": "This type specifies the details returned for the specified package." }, "GetServiceListResponses": { "type": "object", "properties": { "serviceList": { "description": "This container returns shipping service metadata associated with a seller's eDIS account.", "$ref": "#/components/schemas/GetServiceListResponsesData" } }, "description": "This type defines the response container of the getService method." }, "GetServiceListResponsesData": { "type": "object", "properties": { "href": { "type": "string", "description": "The URL to the current page of the result set." }, "limit": { "type": "integer", "description": "The value of the limit parameter submitted in the request.", "format": "int32" }, "next": { "type": "string", "description": "The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set." }, "offset": { "type": "integer", "description": "The value of the offset parameter submitted in the request.", "format": "int32" }, "prev": { "type": "string", "description": "The URI for the previous page of results. This is returned if there is a previous page of results from the result set." }, "services": { "type": "array", "description": "This array returns a list of available shipping services, as well as the descriptions, directions, and identifiers of each service.", "items": { "$ref": "#/components/schemas/ServiceInfoResponses" } }, "total": { "type": "integer", "description": "The total number of shipping services being displayed on the current results page.", "format": "int32" } }, "description": "This type defines the details returned for the retrieved shipping service(s)." }, "GetTrackingDetailResponses": { "type": "object", "properties": { "trackingDetails": { "type": "array", "description": "This array returns a list of tracking event details for the specified tracking number.", "items": { "$ref": "#/components/schemas/GetTrackingDetailResponsesData" } } }, "description": "This container defines the response container for the getTracking method." }, "GetTrackingDetailResponsesData": { "type": "object", "properties": { "city": { "type": "string", "description": "The city code in which the tracking event occurred.

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

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." }, "country": { "type": "string", "description": "The two-letter ISO 3166 country code where the tracking event occurred." }, "descriptionEn": { "type": "string", "description": "The English description of the tracking event." }, "descriptionZh": { "type": "string", "description": "The Chinese description of the tracking event." }, "district": { "type": "string", "description": "The district code where the tracking event occurred.

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

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." }, "eventPostalCode": { "type": "string", "description": "The postal code of where the tracking event occurred.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." }, "eventTime": { "type": "string", "description": "This timestamp the time and date the tracking event occurred." }, "province": { "type": "string", "description": "The province code where the tracking event occurred.

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

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." }, "status": { "type": "string", "description": "The status of the shipment." }, "trackingNumber": { "type": "string", "description": "The tracking number specified in the request." } }, "description": "This type specifies the tracking event details for the specified tracking number." }, "ItemRequest": { "type": "object", "properties": { "buyerId": { "type": "string", "description": "The buyer's eBay user ID." }, "buyerTaxId": { "type": "string", "description": "The tax ID for the buyer. The type of Tax ID is specified in the buyerTaxIdType field." }, "buyerTaxType": { "type": "string", "description": "The type of tax ID that was supplied by the buyer during the checkout process." }, "ebayCollectAndRemitTax": { "type": "boolean", "description": "This boolean indicates if the corresponding line item is subject to a 'Collect and Remit' tax that eBay will collect and remit to the proper taxing authority on the buyer's behalf." }, "ebayCollectAndRemitTaxesValue": { "type": "string", "description": "The value of the 'Collect and Remit' tax for the order that the line item belongs to." }, "email": { "type": "string", "description": "The buyer's email address." }, "itemTitle": { "type": "string", "description": "The title of the listing." }, "listingId": { "type": "string", "description": "The unique identifier of the eBay listing.

Note: Either a listingId and transactionId pair, or an orderLineItem field is required to identify an order line item." }, "message": { "type": "string", "description": "A message from the seller to the buyer." }, "orderId": { "type": "string", "description": "The unique identifier of the eBay order that the line item belongs to." }, "orderLineItem": { "type": "string", "description": "The unique identifier of the line item.

Note: Either a listingId and transactionId pair, or an orderLineItem field is required to identify an order line item." }, "paymentDate": { "type": "string", "description": "The date and time the buyer pays for the order.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ" }, "payPalEmail": { "type": "string", "description": "The buyer's PayPal email address." }, "payPalMessage": { "type": "string", "description": "The buyer's PayPal message." }, "postedQuantity": { "type": "integer", "description": "The quantity of the line item that will be shipped with the package. This value can differ from the order quantity in the case of a combined or split shipment.

Min: 1

Max: 999", "format": "int32" }, "siteId": { "type": "integer", "description": "The unique identifier of the eBay site in which the order occurred.", "format": "int32" }, "sku": { "description": "This container specifies information relating to the item being shipped in the package.", "$ref": "#/components/schemas/SkuRequest" }, "soldDate": { "type": "string", "description": "The date the item was sold.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ" }, "soldPrice": { "description": "The price for which the item was sold.", "$ref": "#/components/schemas/Amount" }, "soldQuantity": { "type": "integer", "description": "The quantity of the line item that was sold.", "format": "int32" }, "transactionId": { "type": "string", "description": "The unique identifier of the monetary transaction.

Note: Either a listingId and transactionId pair, or an orderLineItem field is required to identify an order line item." } }, "description": "This container specifies information about the items being included in a package." }, "ItemResponses": { "type": "object", "properties": { "buyerId": { "type": "string", "description": "The buyer's eBay ID." }, "buyerTaxId": { "type": "string", "description": "The buyer's tax ID." }, "buyerTaxType": { "type": "string", "description": "The buyer's tax type." }, "ebayCollectAndRemitTax": { "type": "boolean", "description": "If returned as true, this boolean indicates that eBay will collect tax for the corresponding line item, and remit the tax to the taxing authority of the buyer's residence. " }, "ebayCollectAndRemitTaxesValue": { "type": "string", "description": "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. " }, "email": { "type": "string", "description": "The buyer's eBay email address." }, "itemTitle": { "type": "string", "description": "The seller created title of the item." }, "listingId": { "type": "string", "description": "The unique identifier of the eBay listing associated with the item." }, "message": { "type": "string", "description": "The buyer's eBay message." }, "orderId": { "type": "string", "description": "The unique identifier of the eBay order that the line item belongs to." }, "orderLineItem": { "type": "string", "description": "The unique identifier of an eBay order line item." }, "paymentDate": { "type": "string", "description": "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." }, "payPalEmail": { "type": "string", "description": "The buyer's PayPal email address." }, "payPalMessage": { "type": "string", "description": "The buyer's PayPal message" }, "postedQuantity": { "type": "integer", "description": "The quantity of the line item shipped with the package.", "format": "int32" }, "siteId": { "type": "integer", "description": "The unique identifier of the eBay site in which the order occurred.", "format": "int32" }, "sku": { "description": "This container returns SKU-related information relating to the item being shipped in the package.", "$ref": "#/components/schemas/SkuRequest" }, "soldDate": { "type": "string", "description": "The date the item was sold." }, "soldPrice": { "description": "The price for which the item was sold.", "$ref": "#/components/schemas/Amount" }, "soldQuantity": { "type": "integer", "description": "The quantity of the line item that was sold.", "format": "int32" }, "transactionId": { "type": "string", "description": "The unique identifier of the eBay transaction." } }, "description": "This type defines item information for items in a package." }, "PackageInfoRequest": { "type": "object", "properties": { "agentInfoRequest": { "description": "This container specifies the EU AR agent information associated with the package.

This information can be retrieved using the getAgents method.", "$ref": "#/components/schemas/AgentInfoData" }, "consignPreferenceId": { "type": "string", "description": "The unique identifier of the consign address to be associated with the package.

This ID can be retrieved using the getConsignPreferences method." }, "incoterm": { "type": "string", "description": "The incoterm information associated with the package.

Supported values: For implementation help, refer to eBay API documentation" }, "items": { "type": "array", "description": "This array is used to specify applicable information about the eBay line item(s) that will be included in the package.", "items": { "$ref": "#/components/schemas/ItemRequest" } }, "maxQuantityLimit": { "type": "integer", "description": "This field is used to limit the maximum number of parcels used in a single order. If the order has more than one parcel, revise this value to increase the limit.", "format": "int32" }, "packageComment": { "type": "string", "description": "A seller-defined comment about the package." }, "packageHeight": { "type": "number", "description": "The height of the package in centimeters." }, "packageLength": { "type": "number", "description": "The length of the package in centimeters." }, "packageWeight": { "type": "number", "description": "The weight of the package in grams." }, "packageWidth": { "type": "number", "description": "The width of the package in centimeters." }, "shipFromAddressId": { "type": "string", "description": "The unique identifier of the ship-from address used for the package.

Use the getAddressPreferences method to retrieve valid ship-from addressId values associated with your account." }, "shippingServiceId": { "type": "string", "description": "The unique identifier of the shipping service being used for the package.

This value can be retrieved using the getServices method." }, "shipToAddress": { "description": "This container specifies the address details of the address ship-to address.", "$ref": "#/components/schemas/ShipToAddressRequestData" }, "specialServiceDetail": { "description": "This container specifies any special service details about the package, such as any insurance fee, required signatures, or delivery exceptions.", "$ref": "#/components/schemas/SpecialServiceDetail" }, "valueForCarriage": { "type": "string", "description": "The declared value of a large carriage (a combination of several orders together)." } }, "description": "This type is used to specify the package information needed to create a package." }, "PickupAddressRequestData": { "type": "object", "properties": { "city": { "type": "string", "description": "The city code of the pickup address.

See 商户API地址编码主数据 for valid city codes." }, "company": { "type": "string", "description": "The company name associated with the pickup address.

Max length: 50 characters" }, "contact": { "type": "string", "description": "The name of the contact person associated with the pickup address.

Max length: 50 characters" }, "countryCode": { "type": "string", "description": "The two-letter country code of the pickup address.

Valid values:" }, "district": { "type": "string", "description": "The district code of the pickup address.

See 商户API地址编码主数据 for valid district codes." }, "name": { "type": "string", "description": "The name of the pickup address.

Max length: 50 characters" }, "phone": { "type": "string", "description": "The phone number associated with the pickup address." }, "postcode": { "type": "string", "description": "The postal code of the pickup address." }, "province": { "type": "string", "description": "The province code of the the pickup address.

See 商户API地址编码主数据 for valid province codes." }, "street1": { "type": "string", "description": "The first line of the street address of the pickup address.

Max length: 50 characters" }, "street2": { "type": "string", "description": "The second line, if applicable, of the street address of the pickup address.

Max length: 50 characters" }, "street3": { "type": "string", "description": "The third line, if applicable, of the street address of the pickup address.

Max length: 50 characters" } }, "description": "This type defines the field used to create a pickup address." }, "PickupAddressResponsesData": { "type": "object", "properties": { "city": { "type": "string", "description": "The city code of the pickup address.

See 商户API地址编码主数据 for valid city codes." }, "cityName": { "type": "string", "description": "The city name of the pickup address." }, "company": { "type": "string", "description": "The name of the company associated with the pickup address." }, "contact": { "type": "string", "description": "The name of the contact person associated with the pickup address." }, "countryCode": { "type": "string", "description": "The two-letter country code of the pickup address." }, "countryName": { "type": "string", "description": "The name of the country of the pickup address." }, "district": { "type": "string", "description": "The district code of the pickup address.

See 商户API地址编码主数据 for valid district codes." }, "districtName": { "type": "string", "description": "The district name of the pickup address." }, "name": { "type": "string", "description": "The name of the pickup address." }, "phone": { "type": "string", "description": "The phone number associated with the pickup address." }, "postcode": { "type": "string", "description": "The postal code of the pickup address." }, "province": { "type": "string", "description": "The province code of the pickup address.

See 商户API地址编码主数据 for valid province codes." }, "provinceName": { "type": "string", "description": "The name of the province of the pickup address." }, "street1": { "type": "string", "description": "The first line of the street address of the pickup address." }, "street2": { "type": "string", "description": "The second line, if applicable, of the street address of the pickup address." }, "street3": { "type": "string", "description": "The third line, if applicable, of the street address of the pickup address." } }, "description": "This type defines the fields used to specify location and contact information for a pickup-from consign address associated with a seller's eDIS account." }, "ServiceInfoResponses": { "type": "object", "properties": { "descriptionEn": { "type": "string", "description": "Basic shipping service information in English." }, "descriptionHk": { "type": "string", "description": "Basic shipping service information in traditional Chinese." }, "descriptionJp": { "type": "string", "description": "Basic shipping service information in Japanese." }, "descriptionZh": { "type": "string", "description": "Basic shipping service information in simplified Chinese." }, "directions": { "type": "array", "description": "This array lists includes all Ship From/Ship To combinations that the service supports. It also includes the type of batteries that may be shipping using the shipping service.", "items": { "$ref": "#/components/schemas/DirectionsResponses" } }, "incoterm": { "type": "string", "description": "The incoterm information associated with the the shipping service.

Supported values: For implementation help, refer to eBay API documentation" }, "maxLength": { "type": "number", "description": "This value indicates the maximum length (in centimeters) of the shipping package that the shipping service allows.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." }, "maxTotalLength": { "type": "number", "description": "This value indicates the total maximum value of the length, width, and height of the package.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." }, "maxWeight": { "type": "number", "description": "This value indicates the maximum weight (in grams) of the shipping package that the shipping service allows.

Note: This field is always returned, but will show as null or have an empty value if not defined/applicable." }, "nameEn": { "type": "string", "description": "The shipping service name in English" }, "nameHk": { "type": "string", "description": "The shipping service name in traditional Chinese" }, "nameJp": { "type": "string", "description": "The shipping service name in Japanese." }, "nameZh": { "type": "string", "description": "The shipping service name in simplified Chinese" }, "shippingServiceId": { "type": "string", "description": "The unique identifier of the shipping service being retrieved.

This value can be input in the shippingServiceId field when creating a package through the the createPackage method." } }, "description": "This type specifies the shipping service information." }, "ShipToAddressRequestData": { "type": "object", "properties": { "city": { "type": "string", "description": "The city code of the ship-to address.

See 商户API地址编码主数据 for valid city codes." }, "company": { "type": "string", "description": "The name of the company associated with the ship-to address." }, "contact": { "type": "string", "description": "The name of the contact person associated with the the ship-to address." }, "countryCode": { "type": "string", "description": "The two-letter country code of the ship-to address." }, "countryName": { "type": "string", "description": "The country name of the ship-to address." }, "district": { "type": "string", "description": "The district code of the ship-to address.

See 商户API地址编码主数据 for valid district codes." }, "phone": { "type": "string", "description": "The phone number associated with the ship-to address." }, "postcode": { "type": "string", "description": "The postal code of the ship-to address." }, "province": { "type": "string", "description": "The province code of the ship-to address.

See 商户API地址编码主数据 for valid province codes." }, "street1": { "type": "string", "description": "The first line of the street address of the ship-to address.

Max length: 50 characters" }, "street2": { "type": "string", "description": "The second line, if applicable, of the street address of the ship-to address.

Max length: 50 characters" }, "street3": { "type": "string", "description": "The third line, if applicable, of the street address of the ship-to address.

Max length: 50 characters" } }, "description": "This type is used to specify the address fields of the ship-to address location." }, "ShipToAddressResponsesData": { "type": "object", "properties": { "city": { "type": "string", "description": "The city code of the ship-to address.

See 商户API地址编码主数据 for valid city codes." }, "company": { "type": "string", "description": "The name of the company associated with the ship-to address." }, "contact": { "type": "string", "description": "The name of the contact person associated with the ship-to address." }, "countryCode": { "type": "string", "description": "The two-letter country code of the ship-to address." }, "countryName": { "type": "string", "description": "The country name of the ship-to address." }, "district": { "type": "string", "description": "The district code of the ship-to address.

See 商户API地址编码主数据 for valid district codes." }, "phone": { "type": "string", "description": "The phone number associated with the ship-to address." }, "postcode": { "type": "string", "description": "The postal code of the ship-to address." }, "province": { "type": "string", "description": "The province code of the ship-to address.

See 商户API地址编码主数据 for valid province codes." }, "street1": { "type": "string", "description": "The first line of the street address of the ship-to address." }, "street2": { "type": "string", "description": "The second line of the street address of the ship-to address." }, "street3": { "type": "string", "description": "The third line of the street address of the ship-to address." } }, "description": "This type specifies the ship-to address information for a retrieved package." }, "SkuRequest": { "type": "object", "properties": { "elecQualificationId": { "type": "string", "description": "The unique identifier of the battery's electric qualification, which indicates that the battery has a certificate of approval for global shipping.

This value is returned in the getBatteryQualifications method." }, "fdcSkus": { "type": "array", "description": "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.

", "items": { "$ref": "#/components/schemas/FDCSkuRequest" } }, "height": { "type": "number", "description": "The height of the item in centimeters." }, "isLiBattery": { "type": "boolean", "description": "This boolean indicates if the item contains a battery." }, "length": { "type": "number", "description": "The length of the item in centimeters." }, "liBatteryType": { "type": "string", "description": "If the item contains a battery, this field indicates the type of battery the item contains. For implementation help, refer to eBay API documentation" }, "nameEn": { "type": "string", "description": "The English name of the item." }, "nameZh": { "type": "string", "description": "The Chinese name of the item." }, "origin": { "type": "string", "description": "The country of origin of the item." }, "price": { "description": "The declared price of the item.", "$ref": "#/components/schemas/Amount" }, "remark": { "type": "string", "description": "A remark to the seller themselves." }, "skuNumber": { "type": "string", "description": "The stock keeping unit (SKU) identifier of the item." }, "tariffCode": { "type": "string", "description": "The Harmonized System code for custom declaration. This value declares the category of the item.." }, "weight": { "type": "number", "description": "The weight of the item in grams." }, "width": { "type": "number", "description": "The width of the item in centimeters." } }, "description": "This type specifies information relating to the SKU item in a package." }, "SpecialServiceDetail": { "type": "object", "properties": { "insuranceFee": { "type": "string", "description": "The insurance fee, if applicable, on the package.

The insurance amount and currency are consistent with the currency of the destination country" }, "packagingType": { "type": "string", "description": "The package type.

Valid values:" }, "signatureType": { "type": "string", "description": "The signature type, if applicable, for the package.

Valid values:" }, "specialServiceTypes": { "type": "array", "description": "Any special service types supported for the package.

For example, SATURDAY_DELIVERY indicates that the item is eligible for Saturday delivery.", "items": { "type": "string" } } }, "description": "This type defines the special service details available for a package." } }, "securitySchemes": { "api_auth": { "type": "oauth2", "description": "The security definitions for this API. Please check individual operations for applicable scopes.", "flows": {} } } } }