{ "openapi": "3.1.0", "info": { "title": "Logistics API", "description": "Note: This is a \"Limited(Limited Release) API available only to select developers approved by business units.

The Logistics API resources offer the following capabilities: Call createShippingQuote to get a list of live shipping rates. The rates returned are all valid for a specific time window and all quoted prices are at eBay-negotiated rates.

Select one of the live rates and using its associated rateId, create a \"shipment\" for the package by calling createFromShippingQuote. Creating a shipment completes an agreement, and the cost of the base service and any added shipping options are summed into the returned totalShippingCost value. This action also generates a shipping label that you can use to ship the package. The total cost of the shipment is incurred when the package is shipped using the supplied shipping label.

Important! Sellers must set up a payment method via their eBay account before they can use the methods in this API to create a shipment and the associated shipping label.

", "contact": { "name": "eBay Inc," }, "license": { "name": "eBay API License Agreement", "url": "https://developer.ebay.com/join/api-license-agreement" }, "version": "v1_beta.0.0" }, "servers": [ { "url": "https://api.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/logistics/v1_beta" } } } ], "security": [ {} ], "paths": { "/shipment/{shipmentId}/cancel": { "post": { "tags": [ "shipment" ], "description": "This method cancels the shipment associated with the specified shipment ID and the associated shipping label is deleted. When you cancel a shipment, the totalShippingCost of the canceled shipment is refunded to the account established by the user's billing agreement.

Note that you cannot cancel a shipment if you have used the associated shipping label.", "operationId": "cancelShipment", "parameters": [ { "name": "shipmentId", "in": "path", "description": "This path parameter specifies the unique eBay-assigned ID of the shipment to be canceled.

The shipmentId value is generated and returned by the createFromShippingQuote method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90005": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "The resource could not be found." } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90260": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "Cannot cancel shipment {shipmentId}" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90000": { "domain": "API_LOGISTICS", "category": "APPLICATION", "description": "A system error has occurred." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.logistics" ] } ] } }, "/shipment/create_from_shipping_quote": { "post": { "tags": [ "shipment" ], "description": "This method creates a shipment based on the shippingQuoteId and rateId values supplied in the request. The rate identified by the rateId value specifies the carrier and service for the package shipment, and the rate ID must be contained in the shipping quote identified by the shippingQuoteId value. Call createShippingQuote to retrieve a set of live shipping rates.

Note: The Logistics API only supports USPS shipping rates and labels.
When you create a shipment, eBay generates a shipping label that you can download and use to ship your package.

In a createFromShippingQuote request, sellers can include a list of shipping options they want to add to the base service quoted in the selected rate. The list of available shipping options is specific to each quoted rate and if available, the options are listed in the rate container of the shipping quote.

In addition to a configurable return-to location and other details about the shipment, the response to this method includes:When you create a shipment, your billing agreement account is charged the sum of the baseShippingCost and the total cost of any additional shipping options you might have selected. Use the URL returned in labelDownloadUrl field, or call downloadLabelFile with the shipmentId value from the response, to download a shipping label for your package.

Important! Sellers must set up their payment method before they can use this method to create a shipment and the associated shipping label.

Set up a billing agreement
Prior to using this method to create a shipment, sellers must first set up their billing agreement. Failure to do so will return Error 90030 Payment could not be completed.

The preferred method for sellers to set up their billing agreement is to go to Set up billing agreement and follow the on-screen directions.

Alternatively, sellers can do the following:", "operationId": "createFromShippingQuote", "parameters": [ { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } }, { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header parameter specifies the eBay marketplace for the shipment being created.

For a list of valid values, refer to the section Marketplace ID Values in the Using eBay RESTful APIs guide.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The create shipment from quote request.", "content": { "application/json": { "schema": { "description": "The create shipment from quote request.", "$ref": "#/components/schemas/CreateShipmentFromQuoteRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90010": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "Missing field {fieldName}." }, "90020": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "Invalid field {fieldName}." } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90030": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "Payment could not be completed." }, "90200": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "The quote has expired. Please request a new quote." }, "90210": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "The quote has already been purchased. Please request a new quote." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90000": { "domain": "API_LOGISTICS", "category": "APPLICATION", "description": "A system error has occurred." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.logistics" ] } ] } }, "/shipment/{shipmentId}/download_label_file": { "get": { "tags": [ "shipment" ], "description": "This method returns the shipping label file that was generated for the shipmentId value specified in the request. Call createFromShippingQuote to generate a shipment ID.

Note: The Logistics API only supports USPS shipping rates and labels.
Use the Accept HTTP header to specify the format of the returned file. The default file format is a PDF file.", "operationId": "downloadLabelFile", "parameters": [ { "name": "shipmentId", "in": "path", "description": "This path parameter specifies the unique eBay-assigned identifier of the shipment associated with the shipping label you want to download.

The shipmentId value is generated and returned by the createFromShippingQuote method.", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "This header specifies the format of the returned file. For this method, the value of the header should be Accept: application/pdf. ", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/pdf": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90005": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "The resource could not be found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90000": { "domain": "API_LOGISTICS", "category": "APPLICATION", "description": "A system error has occurred." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.logistics" ] } ] } }, "/shipment/{shipmentId}": { "get": { "tags": [ "shipment" ], "description": "This method retrieves the shipment details for the specified shipment ID. Call createFromShippingQuote to generate a shipment ID.", "operationId": "getShipment", "parameters": [ { "name": "shipmentId", "in": "path", "description": "This path parameter specifies the unique eBay-assigned identifier of the shipment you want to retrieve.

The shipmentId value is generated and returned by the createFromShippingQuote method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90005": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "The resource could not be found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90000": { "domain": "API_LOGISTICS", "category": "APPLICATION", "description": "A system error has occurred." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.logistics" ] } ] } }, "/shipping_quote": { "post": { "tags": [ "shipping_quote" ], "description": "The createShippingQuote method returns a shipping quote that contains a list of live \"rates.\"

Each rate represents an offer made by a shipping carrier for a specific service and each offer has a live quote for the base service cost. Rates have a time window in which they are \"live,\" and rates expire when their purchase window ends. If offered by the carrier, rates can include shipping options (and their associated prices), and users can add any offered shipping option to the base service should they desire. Also, depending on the services required, rates can also include pickup and delivery windows.

Note: The Logistics API only supports USPS shipping rates and labels.
Each rate is for a single package and is based on the following information: Rates are identified by a unique eBay-assigned rateId and rates are based on price points, pickup and delivery time frames, and other user requirements. Because each rate offered must be compliant with the eBay shipping program, all rates reflect eBay-negotiated prices.

The various rates returned in a shipping quote offer the user a choice from which they can choose a shipping service that best fits their needs. Select the rate for your shipment and using the associated rateId, call createFromShippingQuote to create a shipment and generate a shipping label that you can use to ship the package.", "operationId": "createShippingQuote", "parameters": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "This header parameter specifies the eBay marketplace for the shipping quote that is being created.

For a list of valid values, see Request Headers.", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request object for createShippingQuote.", "content": { "application/json": { "schema": { "description": "The request object for createShippingQuote.", "$ref": "#/components/schemas/ShippingQuoteRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingQuote" } } }, "x-response-codes": { "errors": { "90135": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "The provided shipTo address does not match the destination address of the order(s)." } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90010": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "Missing field {fieldName}." }, "90020": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "Invalid field {fieldName}." }, "90110": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "The order {orderId} was not found on the platform." } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90100": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "No shipping services available for the provided addresses." }, "90120": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "The package specification is incompatible with the destination." }, "90130": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "Order {orderId} is incompatible with our services." }, "90133": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "Maximum number of orders exceeded. Current limitation is 10." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90000": { "domain": "API_LOGISTICS", "category": "APPLICATION", "description": "A system error has occurred." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.logistics" ] } ] } }, "/shipping_quote/{shippingQuoteId}": { "get": { "tags": [ "shipping_quote" ], "description": "This method retrieves the complete details of the shipping quote associated with the specified shippingQuoteId value.

A \"shipping quote\" pertains to a single specific package and contains a set of shipping \"rates\" that quote the cost to ship the package by different shipping carriers and services. The quotes are based on the package's origin, destination, and size.

Call createShippingQuote to create a shippingQuoteId.", "operationId": "getShippingQuote", "parameters": [ { "name": "shippingQuoteId", "in": "path", "description": "This path parameter specifies the unique eBay-assigned ID of the shipping quote you want to retrieve.

The shippingQuoteId value is generated and returned by the createShippingQuote method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingQuote" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90005": { "domain": "API_LOGISTICS", "category": "REQUEST", "description": "The resource could not be found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "90000": { "domain": "API_LOGISTICS", "category": "APPLICATION", "description": "A system error has occurred." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.logistics" ] } ] } } }, "components": { "schemas": { "AdditionalOption": { "type": "object", "properties": { "additionalCost": { "description": "The monetary cost of the additional shipping option identified by the optionType field.", "$ref": "#/components/schemas/Amount" }, "optionType": { "type": "string", "description": "The name of a shipping option that can be purchased in addition to the base shipping cost of this rate. The value supplied in this field must match exactly the option name as supplied by the selected rate." } }, "description": "This complex type contains information about a shipping option that can be purchased in addition to the base shipping cost of a recommended rate. Additional options for each rate are defined, named, and offered by the selected shipping carrier. Examples include shipping insurance or the requirement for a recipient signature." }, "Amount": { "type": "object", "required": [ "value" ], "properties": { "currency": { "description": "The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.", "$ref": "#/components/schemas/CurrencyCodeEnum" }, "value": { "type": "string", "description": "The monetary amount in the specified currency.

Required in the amount type." } }, "description": "A complex type that describes the value of a monetary amount as represented by a global currency." }, "Contact": { "type": "object", "required": [ "contactAddress", "fullName", "primaryPhone" ], "properties": { "companyName": { "type": "string", "description": "The company name with which the contact is associated." }, "contactAddress": { "description": "The details of the contact's geographical address.", "$ref": "#/components/schemas/ContactAddress" }, "fullName": { "type": "string", "description": "The contact's full name." }, "primaryPhone": { "description": "The contact's primary telephone number.", "$ref": "#/components/schemas/PhoneNumber" } }, "description": "This complex type contains contact information for an individual buyer or seller." }, "ContactAddress": { "type": "object", "required": [ "addressLine1", "countryCode", "county", "postalCode" ], "properties": { "addressLine1": { "type": "string", "description": "The first line of the street address." }, "addressLine2": { "type": "string", "description": "The second line of the street address. Use this field for additional address information, such as a suite or apartment number." }, "city": { "type": "string", "description": "The city in which the address is located." }, "countryCode": { "description": "The country of the address, represented as two-letter ISO 3166 country code. For example, US represents the United States and DE represents Germany.", "$ref": "#/components/schemas/CountryCodeEnum" }, "county": { "type": "string", "description": "The county (not country) in which the address is located. Counties typically contain multiple cities or towns." }, "postalCode": { "type": "string", "description": "The postal code of the address." }, "stateOrProvince": { "type": "string", "description": "The state or province in which the address is located. States and provinces often contain multiple counties." } }, "description": "This complex type specifies the details of a geographical address." }, "CountryCodeEnum": { "type": "object", "description": "This enumerated type lists the two-letter ISO 3166 code representing a country. | - **AD**: Andorra - **AE**: United Arab Emirates - **AF**: Afghanistan - **AG**: Antigua and Barbuda - **AI**: Anguilla - **AL**: Albania - **AM**: Armenia - **AN**: Netherlands Antilles - **AO**: Angola - **AQ**: Antarctica - **AR**: Argentina - **AS**: American Samoa - **AT**: Austria - **AU**: Australia - **AW**: Aruba - **AX**: Aland Islands - **AZ**: Azerbaijan - **BA**: Bosnia and Herzegovina - **BB**: Barbados - **BD**: Bangladesh - **BE**: Belgium - **BF**: Burkina Faso - **BG**: Bulgaria - **BH**: Bahrain - **BI**: Burundi - **BJ**: Benin - **BL**: Saint Barthelemy - **BM**: Bermuda - **BN**: Brunei Darussalam - **BO**: Bolivia - **BQ**: Bonaire, Sint Eustatius, and Saba - **BR**: Brazil - **BS**: Bahamas - **BT**: Bhutan - **BV**: Bouvet Island - **BW**: Botswana - **BY**: Belarus - **BZ**: Belize - **CA**: Canada - **CC**: Cocos (Keeling) Islands - **CD**: The Democratic Republic of the Congo - **CF**: Central African Republic - **CG**: Congo - **CH**: Switzerland - **CI**: Cote d'Ivoire - **CK**: Cook Islands - **CL**: Chile - **CM**: Cameroon - **CN**: China - **CO**: Colombia - **CR**: Costa Rica - **CU**: Cuba - **CV**: Cape Verde - **CW**: Curacao - **CX**: Christmas Island - **CY**: Cyprus - **CZ**: Czech Republic - **DE**: Germany - **DJ**: Djibouti - **DK**: Denmark - **DM**: Dominica - **DO**: Dominican Republic - **DZ**: Algeria - **EC**: Ecuador - **EE**: Estonia - **EG**: Egypt - **EH**: Western Sahara - **ER**: Eritrea - **ES**: Spain - **ET**: Ethiopia - **FI**: Finland - **FJ**: Fiji - **FK**: Falkland Islands (Malvinas) - **FM**: Federated States of Micronesia - **FO**: Faroe Islands - **FR**: France - **GA**: Gabon - **GB**: United Kingdom - **GD**: Grenada - **GE**: Georgia - **GF**: French Guiana - **GG**: Guernsey - **GH**: Ghana - **GI**: Gibraltar - **GL**: Greenland - **GM**: Gambia - **GN**: Guinea - **GP**: Guadeloupe - **GQ**: Equatorial Guinea - **GR**: Greece - **GS**: South Georgia and the South Sandwich Islands - **GT**: Guatemala - **GU**: Guam - **GW**: Guinea-Bissau - **GY**: Guyana - **HK**: Hong Kong - **HM**: Heard Island and McDonald Islands - **HN**: Honduras - **HR**: Croatia - **HT**: Haiti - **HU**: Hungary - **ID**: Indonesia - **IE**: Ireland - **IL**: Israel - **IM**: Isle of Man - **IN**: India - **IO**: British Indian Ocean Territory - **IQ**: Iraq - **IR**: Islamic Republic of Iran - **IS**: Iceland - **IT**: Italy - **JE**: Jersey - **JM**: Jamaica - **JO**: Jordan - **JP**: Japan - **KE**: Kenya - **KG**: Kyrgyzstan - **KH**: Cambodia - **KI**: Kiribati - **KM**: Comoros - **KN**: Saint Kitts and Nevis - **KP**: Democratic People's Republic of Korea - **KR**: Republic of Korea - **KW**: Kuwait - **KY**: Cayman Islands - **KZ**: Kazakhstan - **LA**: Lao People's Democratic Republic - **LB**: Lebanon - **LC**: Saint Lucia - **LI**: Liechtenstein - **LK**: Sri Lanka - **LR**: Liberia - **LS**: Lesotho - **LT**: Lithuania - **LU**: Luxembourg - **LV**: Latvia - **LY**: Libyan Arab Jamahiriya - **MA**: Morocco - **MC**: Monaco - **MD**: Republic of Moldova - **ME**: Montenegro - **MF**: Saint Martin (French part) - **MG**: Madagascar - **MH**: Marshall Islands - **MK**: The Former Yugoslav Republic of Macedonia - **ML**: Mali - **MM**: Myanmar - **MN**: Mongolia - **MO**: Macao - **MP**: Northern Mariana Islands - **MQ**: Martinique - **MR**: Mauritania - **MS**: Montserrat - **MT**: Malta - **MU**: Mauritius - **MV**: Maldives - **MW**: Malawi - **MX**: Mexico - **MY**: Malaysia - **MZ**: Mozambique - **NA**: Namibia - **NC**: New Caledonia - **NE**: Niger - **NF**: Norfolk Island - **NG**: Nigeria - **NI**: Nicaragua - **NL**: Netherlands - **NO**: Norway - **NP**: Nepal - **NR**: Nauru - **NU**: Niue - **NZ**: New Zealand - **OM**: Oman - **PA**: Panama - **PE**: Peru - **PF**: French Polynesia. Includes Tahiti - **PG**: Papua New Guinea - **PH**: Philippines - **PK**: Pakistan - **PL**: Poland - **PM**: Saint Pierre and Miquelon - **PN**: Pitcairn - **PR**: Puerto Rico - **PS**: Palestinian territory Occupied - **PT**: Portugal - **PW**: Palau - **PY**: Paraguay - **QA**: Qatar - **RE**: Reunion - **RO**: Romania - **RS**: Serbia - **RU**: Russian Federation - **RW**: Rwanda - **SA**: Saudi Arabia - **SB**: Solomon Islands - **SC**: Seychelles - **SD**: Sudan - **SE**: Sweden - **SG**: Singapore - **SH**: Saint Helena - **SI**: Slovenia - **SJ**: Svalbard and Jan Mayen - **SK**: Slovakia - **SL**: Sierra Leone - **SM**: San Marino - **SN**: Senegal - **SO**: Somalia - **SR**: Suriname - **ST**: Sao Tome and Principe - **SV**: El Salvador - **SX**: Sint Maarten (Dutch part) - **SY**: Syrian Arab Republic - **SZ**: Swaziland - **TC**: Turks and Caicos Islands - **TD**: Chad - **TF**: French Southern Territories - **TG**: Togo - **TH**: Thailand - **TJ**: Tajikistan - **TK**: Tokelau - **TL**: Timor-Leste - **TM**: Turkmenistan - **TN**: Tunisia - **TO**: Tonga - **TR**: Turkey - **TT**: Trinidad and Tobago - **TV**: Tuvalu - **TW**: Taiwan - **TZ**: Tanzania - **UA**: Ukraine - **UG**: Uganda - **UM**: United States Minor Outlying Islands - **US**: United States - **UY**: Uruguay - **UZ**: Uzbekistan - **VA**: Holy See (Vatican City state) - **VC**: Saint Vincent and the Grenadines - **VE**: Venezuela - **VG**: British Virgin Islands - **VI**: the U.S. Virgin Islands - **VN**: Vietnam - **VU**: Vanuatu - **WF**: Wallis and Futuna - **WS**: Samoa - **YE**: Yemen - **YT**: Mayotte - **ZA**: South Africa - **ZM**: Zambia - **ZW**: Zimbabwe", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ] }, "CreateShipmentFromQuoteRequest": { "type": "object", "required": [ "rateId", "shippingQuoteId"], "properties": { "additionalOptions": { "type": "array", "description": "Supply a list of one or more shipping options that the seller wants to purchase for this shipment.

The baseShippingCost field that's associated with the selected shipping rate is the cost of the base service offered in the rate. In addition to the base service, sellers can add additional shipping services to the base service. Shipping options include things such as shipping insurance or a recipient's signature upon delivery. The cost of any added services is summed with the base shipping cost to determine the final cost for the shipment. All options added to the shipment must be chosen from the set of shipping options offered with the selected rate.", "items": { "$ref": "#/components/schemas/AdditionalOption" } }, "labelCustomMessage": { "type": "string", "description": "Optional text to be printed on the shipping label if the selected shipping carrier supports custom messages on their labels." }, "labelSize": { "type": "string", "description": "The seller's desired label size. Any supplied value is applied only if the shipping carrier supports multiple label sizes, otherwise the carrier's default label size is used.

Currently, the only valid value is: 4\"x6\"" }, "rateId": { "type": "string", "description": "The unique eBay-assigned identifier of the shipping rate that the seller selected for the shipment. This value is generated by using the createShippingQuote method and is returned in the rates.rateId field." }, "returnTo": { "description": "The optional return address and contact details for the shipment. The return address is printed on the shipping label. If not specified, the return address defaults to the shipFrom address returned in shipping quote. ", "$ref": "#/components/schemas/Contact" }, "shippingQuoteId": { "type": "string", "description": "The unique eBay-assigned identifier of the shipping quote that was generated by the createShippingQuote method." } }, "description": "This complex type contains the request payload for the createFromShippingQuote method." }, "CurrencyCodeEnum": { "type": "object", "description": "This enumerated type lists the three-letter ISO 4217 codes representing the supported world currencies. | - **AED**: United Arab Emirates dirham - **AFN**: Afghan afghani - **ALL**: Albanian lek - **AMD**: Armenian dram - **ANG**: Netherlands Antillean guilder - **AOA**: Angolan kwanza - **ARS**: Argentine peso - **AUD**: Australian dollar - **AWG**: Aruban florin - **AZN**: Azerbaijani manat - **BAM**: Bosnia and Herzegovina convertible mark - **BBD**: Barbados dollar - **BDT**: Bangladeshi taka - **BGN**: Bulgarian lev - **BHD**: Bahraini dinar - **BIF**: Burundian franc - **BMD**: Bermudian dollar - **BND**: Brunei dollar - **BOB**: Bolivian Boliviano - **BRL**: Brazilian real - **BSD**: Bahamian dollar - **BTN**: Bhutanese ngultrum - **BWP**: Botswana pula - **BYR**: Belarusian ruble - **BZD**: Belize dollar - **CAD**: Canadian dollar - **CDF**: Congolese franc - **CHF**: Swiss franc - **CLP**: Chilean peso - **CNY**: Chinese yuan renminbi - **COP**: Colombian peso - **CRC**: Costa Rican colon - **CUP**: Cuban peso - **CVE**: Cape Verde escudo - **CZK**: Czech koruna - **DJF**: Djiboutian franc - **DKK**: Danish krone - **DOP**: Dominican peso - **DZD**: Algerian dinar - **EGP**: Egyptian pound - **ERN**: Eritrean nakfa - **ETB**: Ethiopian birr - **EUR**: European Union euro - **FJD**: Fiji dollar - **FKP**: Falkland Islands pound - **GBP**: British pound sterling - **GEL**: Georgian lari - **GHS**: Ghanaian cedi - **GIP**: Gibraltar pound - **GMD**: Gambian dalasi - **GNF**: Guinean franc - **GTQ**: Guatemalan quetzal - **GYD**: Guyanese dollar - **HKD**: Hong Kong dollar - **HNL**: Honduran lempira - **HRK**: Croatian kuna - **HTG**: Haitian gourde - **HUF**: Hungarian forint - **IDR**: Indonesian rupiah - **ILS**: Israeli new shekel - **INR**: Indian rupee - **IQD**: Iraqi dinar - **IRR**: Iranian rial - **ISK**: Icelandic krona - **JMD**: Jamaican dollar - **JOD**: Jordanian dinar - **JPY**: Japanese yen - **KES**: Kenyan shilling - **KGS**: Kyrgyzstani som - **KHR**: Cambodian riel - **KMF**: Comoro franc - **KPW**: North Korean won - **KRW**: South Korean won - **KWD**: Kuwaiti dinar - **KYD**: Cayman Islands dollar - **KZT**: Kazakhstani tenge - **LAK**: Lao kip - **LBP**: Lebanese pound - **LKR**: Sri Lankan rupee - **LRD**: Liberian dollar - **LSL**: Lesotho loti - **LTL**: Lithuanian litas - **LYD**: Libyan dinar - **MAD**: Moroccan dirham - **MDL**: Moldovan leu - **MGA**: Malagasy ariary - **MKD**: Macedonian denar - **MMK**: Myanmar kyat - **MNT**: Mongolian tugrik - **MOP**: Macanese pataca - **MRO**: Mauritanian ouguiya - **MUR**: Mauritian rupee - **MVR**: Maldivian rufiyaa - **MWK**: Malawian kwacha - **MXN**: Mexican peso - **MYR**: Malaysian ringgit - **MZN**: Mozambican metical - **NAD**: Namibian dollar - **NGN**: Nigerian naira - **NIO**: Nicaraguan cordoba oro - **NOK**: Norwegian krone - **NPR**: Nepalese rupee - **NZD**: New Zealand dollar - **OMR**: Omani rial - **PAB**: Panamanian balboa - **PEN**: Peruvian sol - **PGK**: Papua New Guinean kina - **PHP**: Philippine peso - **PKR**: Pakistani rupee - **PLN**: Polish zloty - **PYG**: Paraguayan guarani - **QAR**: Qatari riyal - **RON**: Romanian leu - **RSD**: Serbian dinar - **RUB**: Russian ruble - **RWF**: Rwandan franc - **SAR**: Saudi riyal - **SBD**: Solomon Islands dollar - **SCR**: Seychelles rupee - **SDG**: Sudanese pound - **SEK**: Swedish krona - **SGD**: Singapore dollar - **SHP**: Saint Helena pound - **SLL**: Sierra Leonean leone - **SOS**: Somali shilling - **SRD**: Surinamese dollar - **STD**: Sao Tome and Principe dobra - **SYP**: Syrian pound - **SZL**: Swazi lilangeni - **THB**: Thai baht - **TJS**: Tajikistani somoni - **TMT**: Turkmenistani manat - **TND**: Tunisian dinar - **TOP**: Tongan pa'anga - **TRY**: Turkish lira - **TTD**: Trinidad and Tobago dollar - **TWD**: New Taiwan dollar - **TZS**: Tanzanian shilling - **UAH**: Ukrainian hryvnia - **UGX**: Ugandan shilling - **USD**: United States dollar - **UYU**: Uruguayan peso - **UZS**: Uzbekistani som - **VEF**: Venezuelan bolivar - **VND**: Vietnamese dong - **VUV**: Vanuatu vatu - **WST**: Samoan tala - **XAF**: CFA franc BEAC - **XCD**: East Caribbean dollar - **XOF**: CFA franc BCEAO - **XPF**: CFP franc - **YER**: Yemeni rial - **ZAR**: South African rand - **ZMW**: Zambian kwacha - **ZWL**: Zimbabwean dollar", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "DKK", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "INR", "IQD", "IRR", "ISK", "GBP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "CHF", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "XCD", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NPR", "OMR", "PAB", "PEN", "XPF", "PGK", "PHP", "PKR", "PLN", "ILS", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "NOK", "SLL", "SOS", "SRD", "STD", "ANG", "SYP", "SZL", "XAF", "XOF", "THB", "TJS", "NZD", "TMT", "TND", "TOP", "TRY", "TTD", "AUD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "YER", "EUR", "ZAR", "ZMW", "ZWL" ] }, "Dimensions": { "type": "object", "properties": { "height": { "type": "string", "description": "The numeric value of the height of the package." }, "length": { "type": "string", "description": "The numeric value of the length of the package." }, "unit": { "description": "The unit of measure used to express the height, length, and width of the package.", "$ref": "#/components/schemas/LengthUnitOfMeasureEnum" }, "width": { "type": "string", "description": "The numeric value of the width of the package." } }, "description": "This complex type defines the dimensions of a package to be shipped." }, "Error": { "type": "object", "properties": { "category": { "type": "string", "description": "Identifies the type of error." }, "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." }, "ErrorDetailV3": { "type": "object", "properties": { "category": { "type": "string", "description": "The category type for this error or warning. It takes a string that can have one of three values:" }, "domain": { "type": "string", "description": "Name of the domain containing the service or application." }, "errorId": { "type": "integer", "description": "A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.", "format": "int32" }, "inputRefIds": { "type": "array", "description": "Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.", "items": { "type": "string" } }, "longMessage": { "type": "string", "description": "An expanded version of message that should be around 100-200 characters long, but is not required to be such." }, "message": { "type": "string", "description": "An end user and app-developer friendly device agnostic message. It explains what the error or warning is, and how to fix it (in a general sense). Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale." }, "outputRefIds": { "type": "array", "description": "Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId.", "items": { "type": "string" } }, "parameters": { "type": "array", "description": "This optional complex field type contains a list of one or more context-specific ErrorParameter objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value.", "items": { "$ref": "#/components/schemas/ErrorParameterV3" } }, "subdomain": { "type": "string", "description": "Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain." } }, "description": "A container that defines the elements of error and warning message." }, "ErrorParameter": { "type": "object", "properties": { "name": { "type": "string", "description": "The object of the error." }, "value": { "type": "string", "description": "The value of the object." } } }, "ErrorParameterV3": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the entity that threw the error." }, "value": { "type": "string", "description": "A description of the error." } }, "description": "Container for an error parameter." }, "LengthUnitOfMeasureEnum": { "type": "object", "description": "This enum contains the supported units of measure that can be used to express the linear dimensions a package to be shipped. | - **INCH**: The dimensions are expressed in inches. - **FEET**: The dimensions are expressed in feet. - **CENTIMETER**: The dimensions are expressed in centimeters. - **METER**: The dimensions are expressed in meters.", "enum": [ "INCH", "FEET", "CENTIMETER", "METER" ] }, "Order": { "type": "object", "required": [ "channel", "orderId"], "properties": { "channel": { "type": "string", "description": "The marketplace where the order was created.

Currently, only EBAY is supported. This value can be used to retrieve rates available for eBay orders." }, "orderId": { "type": "string", "description": "The unique identifier of the order. The getOrders method of the Fulfillment API can be used to retrieve order IDs." } }, "description": "This complex type defines an order from which a seller is including one or more line items in a single package to be shipped." }, "PackageSpecification": { "type": "object", "properties": { "dimensions": { "description": "Declares the height, length, width, and unit of measure for the package to be shipped.", "$ref": "#/components/schemas/Dimensions" }, "weight": { "description": "Declares the weight of the package.", "$ref": "#/components/schemas/Weight" } }, "description": "This complex type specifies the dimensions and weight of a package." }, "PhoneNumber": { "type": "object", "required": [ "phoneNumber" ], "properties": { "phoneNumber": { "type": "string", "description": "A telephone number." } }, "description": "This complex type contains a string field representing a telephone number." }, "PickupSlot": { "type": "object", "properties": { "pickupSlotEndTime": { "type": "string", "description": "The date and time the pickup slot ends, formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2018-08-20T07:09:00.000Z" }, "pickupSlotId": { "type": "string", "description": "Seller-defined name for the pickup slot." }, "pickupSlotStartTime": { "type": "string", "description": "The date and time the pickup slot begins, formatted as an ISO 8601 UTC string." }, "pickupSlotTimeZone": { "type": "string", "description": "The time zone of the pickup location, returned as Time Zone Database ID (also known as an Olson time zone ID)." } }, "description": "This complex type defines a time window for the pickup of a package." }, "PickupTypeEnum": { "type": "object", "description": "This enum defines the values that you can use to describe a package pickup or drop off. | - **REGULAR_PICKUP**: The service is of type pickup. The pickup will not be booked automatically by the platform. - **SCHEDULED_PICKUP**: The service is of type pickup, and the platform will book the pickup when the shipment is created. With this type of pickup, the shippingRateId container is enriched with a collection of pickupSlots. To create a shipment for this type of service, you must provide a pickupSlotId value in addition to values for shippingQuoteId and shippingRateId. - **DROP_OFF**: The service is of type drop-off and the API customer is responsible for dropping-off the parcel at a pickup location that is compatible with the selected shipping service (see the value of the pickupNetwork field).", "enum": [ "REGULAR_PICKUP", "SCHEDULED_PICKUP", "DROP_OFF" ] }, "PurchasedRate": { "type": "object", "properties": { "additionalOptions": { "type": "array", "description": "A list of additional, optional features that have been purchased for the shipment.", "items": { "$ref": "#/components/schemas/AdditionalOption" } }, "baseShippingCost": { "description": "The amount of the \"base cost\" for the shipment as set by the given carrier for the specified service. This cost excludes any additional costs accrued from the addition of any optional shipping options.", "$ref": "#/components/schemas/Amount" }, "destinationTimeZone": { "type": "string", "description": "The time zone of the destination according to Time Zone Database. For example, \"America/Los_Angeles\"." }, "maxEstimatedDeliveryDate": { "type": "string", "description": "A string value representing maximum (latest) estimated delivery time, formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2018-08-20T07:09:00.000Z" }, "minEstimatedDeliveryDate": { "type": "string", "description": "A string value representing minimum (earliest) estimated delivery time, formatted as an ISO 8601 UTC string." }, "pickupNetworks": { "type": "array", "description": "A list of pickup networks compatible with the shipping service.", "items": { "type": "string" } }, "pickupSlotId": { "type": "string", "description": "This unique eBay-assigned ID value is returned only if the shipment has been configured for a scheduled pickup." }, "pickupType": { "description": "The type of pickup or drop-off configured for the shipment.", "$ref": "#/components/schemas/PickupTypeEnum" }, "rateId": { "type": "string", "description": "The eBay-generated ID of the shipping rate that the seller has chosen to purchase for the shipment." }, "shippingCarrierCode": { "type": "string", "description": "The ID code for the carrier that was selected for the package shipment." }, "shippingCarrierName": { "type": "string", "description": "The name of the shipping carrier." }, "shippingQuoteId": { "type": "string", "description": "The unique eBay-generated ID of the shipping quote from which the seller selected a shipping rate (rateId)." }, "shippingServiceCode": { "type": "string", "description": "String ID code for the shipping service selected for the package shipment. This is a service that the shipping carrier supplies." }, "shippingServiceName": { "type": "string", "description": "The name of the shipping service." }, "totalShippingCost": { "description": "The total shipping cost, which is the sum cost of the base shipping cost and the cost of all the selected shipping options.", "$ref": "#/components/schemas/Amount" } }, "description": "The \"rate\" that has been selected and purchased for the shipment, as referenced by the rateId value." }, "Rate": { "type": "object", "properties": { "additionalOptions": { "type": "array", "description": "Contains service and pricing information for one or more shipping options that are offered by the carrier and can be purchased in addition to the base shipping service provided by this rate. Shipping options can include items such as INSURANCE and SIGNATURE.", "items": { "$ref": "#/components/schemas/AdditionalOption" } }, "baseShippingCost": { "description": "A live quote for the cost that the carrier (identified by shippingCarrierCode) is charging for the shipping service being offered (identified by shippingServiceCode), excluding any additional shipping options.", "$ref": "#/components/schemas/Amount" }, "destinationTimeZone": { "type": "string", "description": "The name of the time zone region, as defined in the IANA Time Zone Database, to which the package is being shipped.

Delivery dates are calculated relative to this time zone.

Note: This is different from a Coordinated Universal Time (UTC) offset. For example, the America/Los_Angeles time zone identifies a region with the UTC standard time offset of -08:00, but so do several other time zones, including America/Tijuana,America/Dawson, and Pacific/Pitcairn." }, "maxEstimatedDeliveryDate": { "type": "string", "description": "The latest stated date and time the shipment will be delivered at this rate.

The time stamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2018-08-20T07:09:00.000Z" }, "minEstimatedDeliveryDate": { "type": "string", "description": "The estimated earliest date and time the shipment will be delivered at this rate. The time stamp is formatted as an ISO 8601 UTC string." }, "pickupNetworks": { "type": "array", "description": "A list of pickup networks compatible with the shipping service.", "items": { "type": "string" } }, "pickupSlots": { "type": "array", "description": "A list of available pickup slots for the package.", "items": { "$ref": "#/components/schemas/PickupSlot" } }, "pickupType": { "description": "The type of pickup or drop-off service associated with the pickupSlots time frames.", "$ref": "#/components/schemas/PickupTypeEnum" }, "rateId": { "type": "string", "description": "The unique eBay-assigned ID for this shipping rate." }, "rateRecommendation": { "type": "array", "description": "A list of reasons this rate is recommended. Available values are: ", "items": { "$ref": "#/components/schemas/RateRecommendationEnum" } }, "shippingCarrierCode": { "type": "string", "description": "The code name of the shipping carrier who will provide the service identified by shippingServiceCode." }, "shippingCarrierName": { "type": "string", "description": "The common name of the shipping carrier." }, "shippingServiceCode": { "type": "string", "description": "The code name of the shipping service to be provided by the carrier identified by shippingCarrierCode." }, "shippingServiceName": { "type": "string", "description": "The common name of the shipping service." } }, "description": "This complex type contains live quote information about a shipping service that's available for a given shipping quote request, including the shipping carrier and service, delivery window, shipping cost, and additional shipping options." }, "RateRecommendationEnum": { "type": "object", "description": "This enumerated type contains a list of the available reasons for recommending a given shipping rate. | - **BUYER_CHOSEN**: The rate meets or exceeds the requirements of the buyer's preferred shipping option. - **CHEAPEST_ON_TIME**: The rate is the cheapest rate available that will provide delivery within the seller's time frame commitment. - **EBAY_PLUS_OK**: The rate complies with the shipping requirements of the eBay Plus program. - **FASTEST_ON_TIME**: The rate has the fastest shipping time, and will provide delivery within the seller's time frame commitment. - **GUARANTEED_DELIVERY_OK**: The rate complies with the shipping requirements of the eBay Guaranteed Delivery program.", "enum": [ "BUYER_CHOSEN", "CHEAPEST_ON_TIME", "EBAY_PLUS_OK", "FASTEST_ON_TIME", "GUARANTEED_DELIVERY_OK" ] }, "Shipment": { "type": "object", "required": [ "orders"], "properties": { "cancellation": { "description": "Cancellation status for the package, if one exists.", "$ref": "#/components/schemas/ShipmentCancellation" }, "creationDate": { "type": "string", "description": "The date and time the shipment was created, formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2018-08-20T07:09:00.000Z" }, "labelCustomMessage": { "type": "string", "description": "If supported by the selected shipping carrier, this field can contain optional seller text to be printed on the shipping label." }, "labelDownloadUrl": { "type": "string", "description": "The direct URL the seller can use to download an image of the shipping label. By default, the file format is PDF. See downloadLabelFile for requesting different response file formats." }, "labelSize": { "type": "string", "description": "The seller's desired label size. The support for multi-sized labels is shipping-carrier specific and if the size requested in the createFromShippingQuote call matches a size the carrier supports, the value will be represented here in the shipment.

Currently, the only valid value is: 4\"x6\"" }, "orders": { "type": "array", "description": "A list of one or more orders that will be shipped in the shipping package.", "items": { "$ref": "#/components/schemas/Order" } }, "packageSpecification": { "description": "The weight and dimensions of the package.", "$ref": "#/components/schemas/PackageSpecification" }, "rate": { "description": "The shipping rate that the seller has chosen to purchase for this shipment. Each rate, identified by a rateId, contains the offered base service, options, and shipping parameters that were selected for the package shipment.", "$ref": "#/components/schemas/PurchasedRate" }, "returnTo": { "description": "The address and contact details that should be used for item returns. Sellers have the option to define a return address that is different from their shipFrom address. If not specified, the return address defaults to the shipFrom address in the shipping quote.", "$ref": "#/components/schemas/Contact" }, "shipFrom": { "description": "The address and contact details for the origin of the package shipment.", "$ref": "#/components/schemas/Contact" }, "shipmentId": { "type": "string", "description": "The unique eBay-assigned ID for the shipment. The ID is generated when the shipment is created by a call to createFromShippingQuote." }, "shipmentTrackingNumber": { "type": "string", "description": "A unique carrier-assigned ID string that can be used to track the shipment." }, "shipTo": { "description": "The address and contact details for the destination of the shipment.", "$ref": "#/components/schemas/Contact" } }, "description": "This complex type defines a shipment for a specific package (for example, a box or letter). Shipments are always linked to a purchased shipping label. " }, "ShipmentCancellation": { "type": "object", "properties": { "cancellationRequestedDate": { "type": "string", "description": "The time and date the request was made to cancel the shipment, formatted as an ISO 8601 UTC string." }, "cancellationStatus": { "description": "This enum specifies the current cancellation status of a shipment, if a cancellation request has been made.", "$ref": "#/components/schemas/ShipmentCancellationStatusEnum" } }, "description": "This type defines a shipment cancellation by the date and time the cancellation request was made and the current status of the request." }, "ShipmentCancellationStatusEnum": { "type": "object", "description": "This enum defines the possible states for a shipment cancellation. | - **CANCELLATION_REQUESTED**: A shipment cancellation requests has been submitted. The carrier will accept or reject the cancellation at a later stage. - **CANCELLATION_ACCEPTED**: The shipment cancellation has been accepted by the carrier. - **CANCELLATION_REJECTED**: The shipment cancellation has been rejected by the carrier.", "enum": [ "CANCELLATION_REQUESTED", "CANCELLATION_ACCEPTED", "CANCELLATION_REJECTED" ] }, "ShippingQuote": { "type": "object", "required": [ "orders"], "properties": { "creationDate": { "type": "string", "description": "The date and time this quote was created, expressed as an ISO 8601 UTC string." }, "expirationDate": { "type": "string", "description": "The last date and time that this quote will be honored, expressed as an ISO 8601 UTC string. After this time the quote expires and the expressed rates can no longer be purchased." }, "orders": { "type": "array", "description": "A list of one or more orders that will be shipped in the shipping package.", "items": { "$ref": "#/components/schemas/Order" } }, "packageSpecification": { "description": "The weight and dimensions of the package covered by this shipping quote.", "$ref": "#/components/schemas/PackageSpecification" }, "rates": { "type": "array", "description": "A list of rates where each rate, as identified by a rateId, contains information about a specific shipping service offered by a carrier. Rates include shipping carrier and service, the to and from locations, the pickup and delivery windows, the seller's shipping parameters, the service constraints, and the cost for the base service and a list of additional shipping options.

Note: The Logistics API only supports USPS shipping rates and labels.
Each rate offered is supported by a label service where you can purchase the rate, and associated shipping label, via a call to createFromShippingQuote.", "items": { "$ref": "#/components/schemas/Rate" } }, "shipFrom": { "description": "The address and contact details for the origin of the shipment.", "$ref": "#/components/schemas/Contact" }, "shippingQuoteId": { "type": "string", "description": "The unique eBay-assigned ID for this shipping quote. The value of this field is associated with a specific package, based on its origin, destination, and size." }, "shipTo": { "description": "The address and contact details for the destination of the shipment.", "$ref": "#/components/schemas/Contact" }, "warnings": { "type": "array", "description": "A list of any warnings triggered by the request.", "items": { "$ref": "#/components/schemas/ErrorDetailV3" } } }, "description": "This complex type describes a \"shipping quote,\" which contains the parameters for a package shipment. The shipping quote contains a list of \"live quotes\" or rates for the shipment. Rates are offered by a carrier for a particular service, or set of services, for shipping the package. Included in the shipping quote are the package specifications, the shipment's origin and destination addresses, and the shipping parameters specified by the seller.

Use the rateId value to select the specific service you want when you create a shipment by calling createFromShippingQuote." }, "ShippingQuoteRequest": { "type": "object", "required": [ "orders", "packageSpecification", "shipFrom", "shipTo" ], "properties": { "orders": { "type": "array", "description": "In this array, the seller specifies one or more orders that will be shipped in the shipping package.

A shipping package can contain any number of line items from one or more orders, providing they all ship in the same package.

Maximum list size: 10", "items": { "$ref": "#/components/schemas/Order" } }, "packageSpecification": { "description": "Declares the weight and dimensions of the package.", "$ref": "#/components/schemas/PackageSpecification" }, "shipFrom": { "description": "The address and contact details pertaining to the origin of the shipment.", "$ref": "#/components/schemas/Contact" }, "shipTo": { "description": "The address and contact details pertaining to the shipment's destination.", "$ref": "#/components/schemas/Contact" } }, "description": "This complex type defines the request body for createShippingQuote. Sellers request a quote for a shipment by defining the \"To\" and \"From\" addresses for the package, plus the package's size.

Carriers respond by offering up a \"rate\" for the service that best fits the seller's needs." }, "Weight": { "type": "object", "required": [ "unit", "value" ], "properties": { "unit": { "description": "The unit of measurement used to specify the weight of a shipping package. Both the unit and value fields are required if the weight container is used. If the English system of measurement is being used, the applicable values for weight units are POUND and OUNCE. If the metric system of measurement is being used, the applicable values for weight units are KILOGRAM and GRAM. The metric system is used by most countries outside of the US.", "$ref": "#/components/schemas/WeightUnitOfMeasureEnum" }, "value": { "type": "string", "description": "The numeric value of the weight of the package, as measured by the value of unit." } }, "description": "This complex type contains information about the weight of an object such as a shipping package." }, "WeightUnitOfMeasureEnum": { "type": "object", "description": "This enumerated type contains the available units of measure used to express the weight of an object such as a shipping package. | - **GRAM**: The weight is expressed in grams. - **KILOGRAM**: The weight is expressed in kilograms. - **OUNCE**: The weight is expressed in ounces. - **POUND**: The weight is expressed in pounds.", "enum": [ "GRAM", "KILOGRAM", "OUNCE", "POUND" ] } }, "securitySchemes": { "api_auth": { "type": "oauth2", "description": "The security definitions for this API. Please check individual operations for applicable scopes.", "flows": { "authorizationCode": { "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "scopes": { "https://api.ebay.com/oauth/api_scope/sell.logistics": " This scope would allow signed in user to access Logistics information." } } } }, "bearerAuth": { "type": "http", "scheme": "bearer" } } } }