ebay.logistics
Module ebay.logistics
API
Definitions
ballerinax/ebay.logistics Ballerina library
Overview
eBay is a global online marketplace where businesses and individuals buy and sell goods. The eBay Logistics API lets approved sellers get live shipping rates, buy shipping labels and manage the resulting shipments through eBay.
The ebay logistics connector provides a Ballerina client for version v1_beta of the eBay Logistics API, so you can request shipping quotes, purchase rates and handle shipments from your integrations. The API is a limited release available only to developers approved by eBay.
Key features
- Request live shipping rates for one or more orders
- Create shipments from a selected shipping quote and rate
- Retrieve shipment and shipping quote details
- Download shipping labels for purchased shipments
- Cancel shipments and track the cancellation status
Setup guide
To use the eBay Logistics connector you need an eBay developer account with access to the Logistics API, and a user access token that carries the https://api.ebay.com/oauth/api_scope/sell.logistics scope.
Step 1: Create an eBay developer account
- Sign up at the eBay Developers Program and sign in.
- Request access to the Logistics API, which is a limited release API available only to developers approved by eBay.
Step 2: Create an application keyset
- Open the Application Keysets page in your developer account.
- Create a keyset for the Production environment and note the App ID (Client ID) and Cert ID (Client Secret).
- Configure an OAuth redirect URL (RuNa) for the keyset.
Step 3: Obtain an access token
- Direct the seller to the eBay consent page (
https://auth.ebay.com/oauth2/authorize) with thehttps://api.ebay.com/oauth/api_scope/sell.logisticsscope to obtain an authorization code. - Exchange the authorization code for a user access token and a refresh token at
https://api.ebay.com/identity/v1/oauth2/token. - Use the access token directly, or use the refresh token together with the client ID and client secret so that the connector can renew the access token.
Quickstart
To use the ebay.logistics connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
import ballerinax/ebay.logistics;
Step 2: Instantiate a new connector
Create a Config.toml file with your access token:
accessToken = "<Access Token>"
Then create a client:
configurable string accessToken = ?; final logistics:Client ebay = check new ({auth: {token: accessToken}});
Step 3: Invoke the connector operation
public function main() returns error? { logistics:ShippingQuote _ = check ebay->getShippingQuote("<Shipping Quote ID>"); }
Step 4: Run the Ballerina application
bal run
Examples
The eBay Logistics connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Shipping label purchase - Request shipping rates for an order, buy the cheapest rate for the buyer's selected shipping service and download the shipping label.
- Shipment cancellation review - Review a purchased shipment against its original quote and cancel it when requested.
Clients
ebay.logistics: Client
The eBay Logistics API lets sellers get live shipping rates for a package, buy a rate to create a shipment and its shipping label, and download or cancel that shipment. It is a limited release API available only to developers approved by eBay, and sellers must set up a payment method in their eBay account before they can create shipments.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.ebay.com/sell/logistics/v1_beta" - URL of the target service
cancelShipment
Cancel a shipment
Parameters
- shipmentId string - This path parameter specifies the unique eBay-assigned ID of the shipment to be canceled.<br><br>The <strong>shipmentId</strong> value is generated and returned by the <a href="/api-docs/sell/logistics/resources/shipment/methods/createFromShippingQuote" target="_blank">createFromShippingQuote</a> method
createFromShippingQuote
function createFromShippingQuote(CreateFromShippingQuoteHeaders headers, CreateShipmentFromQuoteRequest payload) returns Shipment|errorCreate a shipment from a shipping quote
Parameters
- headers CreateFromShippingQuoteHeaders - Headers to be sent with the request
- payload CreateShipmentFromQuoteRequest - The create shipment from quote request
downloadLabelFile
function downloadLabelFile(string shipmentId, DownloadLabelFileHeaders headers) returns Response|errorDownload a shipment label file
Parameters
- shipmentId string - This path parameter specifies the unique eBay-assigned identifier of the shipment associated with the shipping label you want to download.<br><br> The <strong>shipmentId</strong> value is generated and returned by the <a href="/api-docs/sell/logistics/resources/shipment/methods/createFromShippingQuote" target="_blank">createFromShippingQuote</a> method
- headers DownloadLabelFileHeaders - Headers to be sent with the request
getShipment
Get a shipment
Parameters
- shipmentId string - This path parameter specifies the unique eBay-assigned identifier of the shipment you want to retrieve.<br><br>The <strong>shipmentId</strong> value is generated and returned by the <a href="/api-docs/sell/logistics/resources/shipment/methods/createFromShippingQuote" target="_blank">createFromShippingQuote</a> method
createShippingQuote
function createShippingQuote(CreateShippingQuoteHeaders headers, ShippingQuoteRequest payload) returns ShippingQuote|errorCreate a shipping quote
Parameters
- headers CreateShippingQuoteHeaders - Headers to be sent with the request
- payload ShippingQuoteRequest - The request object for <strong>createShippingQuote</strong>
Return Type
- ShippingQuote|error - Created
getShippingQuote
function getShippingQuote(string shippingQuoteId, map<string|string[]> headers) returns ShippingQuote|errorGet a shipping quote
Parameters
- shippingQuoteId string - This path parameter specifies the unique eBay-assigned ID of the shipping quote you want to retrieve.<br><br>The <strong>shippingQuoteId</strong> value is generated and returned by the <a href="/api-docs/sell/logistics/resources/shipping_quote/methods/createShippingQuote" target="_blank">createShippingQuote</a> method
Return Type
- ShippingQuote|error - The retrieved shipping quote
Records
ebay.logistics: AdditionalOption
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
Fields
- optionType? string - 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
- additionalCost? Amount - A complex type that describes the value of a monetary amount as represented by a global currency
ebay.logistics: Amount
A complex type that describes the value of a monetary amount as represented by a global currency
Fields
- currency? CurrencyCodeEnum - This enumerated type lists the three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html" title="https://www.iso.org" target="_blank">ISO 4217</a> 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
- value string - The monetary amount in the specified <strong>currency</strong>. <br><br><i>Required in</i> the <strong>amount</strong> type
ebay.logistics: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
ebay.logistics: Contact
This complex type contains contact information for an individual buyer or seller
Fields
- primaryPhone PhoneNumber - This complex type contains a string field representing a telephone number
- companyName? string - The company name with which the contact is associated
- fullName string - The contact's full name
- contactAddress ContactAddress - This complex type specifies the details of a geographical address
ebay.logistics: ContactAddress
This complex type specifies the details of a geographical address
Fields
- stateOrProvince? string - The state or province in which the address is located. States and provinces often contain multiple counties
- city? string - The city in which the address is located
- countryCode CountryCodeEnum - This enumerated type lists the two-letter <a href="https://www.iso.org/iso-3166-country-codes.html" title="https://www.iso.org" target="_blank">ISO 3166</a> 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
- postalCode string - The postal code of the address
- county string - The county (not country) in which the address is located. Counties typically contain multiple cities or towns
- addressLine1 string - The first line of the street address
- addressLine2? string - The second line of the street address. Use this field for additional address information, such as a suite or apartment number
ebay.logistics: CreateFromShippingQuoteHeaders
Represents the Headers record for the operation: createFromShippingQuote
Fields
- xEBAYCMARKETPLACEID string - This header parameter specifies the eBay marketplace for the shipment being created.<br><br>For a list of valid values, refer to the section <a href="/api-docs/static/rest-request-components.html#marketpl" target="_blank">Marketplace ID Values</a> in the <strong>Using eBay RESTful APIs</strong> guide
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to <strong>application/json</strong>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>
ebay.logistics: CreateShipmentFromQuoteRequest
This complex type contains the request payload for the createFromShippingQuote method
Fields
- labelCustomMessage? string - Optional text to be printed on the shipping label if the selected shipping carrier supports custom messages on their labels
- additionalOptions? AdditionalOption[] - Supply a list of one or more shipping options that the seller wants to purchase for this shipment. <br><br>The <strong>baseShippingCost</strong> 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
- labelSize? string - 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. <br><br>Currently, the only valid value is: <code>4"x6"</code>
- returnTo? Contact - This complex type contains contact information for an individual buyer or seller
- shippingQuoteId string - The unique eBay-assigned identifier of the shipping quote that was generated by the <a href="/api-docs/sell/logistics/resources/shipping_quote/methods/createShippingQuote" target="_blank">createShippingQuote</a> method
- rateId string - The unique eBay-assigned identifier of the shipping rate that the seller selected for the shipment. This value is generated by using the <a href="/api-docs/sell/logistics/resources/shipping_quote/methods/createShippingQuote" target="_blank">createShippingQuote</a> method and is returned in the <strong>rates.rateId</strong> field
ebay.logistics: CreateShippingQuoteHeaders
Represents the Headers record for the operation: createShippingQuote
Fields
- xEBAYCMARKETPLACEID string - This header parameter specifies the eBay marketplace for the shipping quote that is being created.<br><br>For a list of valid values, see <a href="/develop/api/sell/request_headers#marketplace-id-values " target="_blank ">Request Headers</a>
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to <strong>application/json</strong>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>
ebay.logistics: Dimensions
This complex type defines the dimensions of a package to be shipped
Fields
- unit? LengthUnitOfMeasureEnum - 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
- length? string - The numeric value of the length of the package
- width? string - The numeric value of the width of the package
- height? string - The numeric value of the height of the package
ebay.logistics: DownloadLabelFileHeaders
Represents the Headers record for the operation: downloadLabelFile
Fields
- accept string - This header specifies the format of the returned file. For this method, the value of the header should be <code>Accept: application/pdf</code>.
ebay.logistics: ErrorDetailV3
A container that defines the elements of error and warning message
Fields
- domain? string - Name of the domain containing the service or application
- subdomain? string - Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain
- outputRefIds? string[] - Identifies specific response elements associated with the error, if any. Path format is the same as <code>inputRefId</code>
- errorId? Signed32 - 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
- inputRefIds? string[] - Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use <i>JSONPath</i> notation
- category? string - The category type for this error or warning. It takes a string that can have one of three values:<ul><li><code>Application</code>: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.</li><li><code>Business</code>: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as "Seller does not ship item to Antarctica" or "Buyer ineligible to purchase an alcoholic item". Business errors are not syntactical input errors.</li><li><code>Request</code>: Used when there is anything wrong with the request, such as authentication, syntactical errors, rate limiting or missing headers, bad HTTP header values, and so on.</li></ul>
- longMessage? string - An expanded version of message that should be around 100-200 characters long, but is not required to be such
- message? string - 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
- parameters? ErrorParameterV3[] - This optional complex field type contains a list of one or more context-specific <code>ErrorParameter</code> objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each <code>ErrorParameter</code> object consists of two fields, a <code>name</code> and a <code>value</code>
ebay.logistics: ErrorParameterV3
Container for an error parameter
Fields
- name? string - Name of the entity that threw the error
- value? string - A description of the error
ebay.logistics: OAuth2RefreshTokenGrantConfig
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://api.ebay.com/identity/v1/oauth2/token") - Refresh URL
ebay.logistics: Order
This complex type defines an order from which a seller is including one or more line items in a single package to be shipped
Fields
- orderId string - The unique identifier of the order. The <a href="/api-docs/sell/fulfillment/resources/order/methods/getOrders" target="_blank">getOrders</a> method of the <strong>Fulfillment API</strong> can be used to retrieve order IDs
- channel string - The marketplace where the order was created.<br><br>Currently, only <code>EBAY</code> is supported. This value can be used to retrieve rates available for eBay orders
ebay.logistics: PackageSpecification
This complex type specifies the dimensions and weight of a package
Fields
- weight? Weight - This complex type contains information about the weight of an object such as a shipping package
- dimensions? Dimensions - This complex type defines the dimensions of a package to be shipped
ebay.logistics: PhoneNumber
This complex type contains a string field representing a telephone number
Fields
- phoneNumber string - A telephone number
ebay.logistics: PickupSlot
This complex type defines a time window for the pickup of a package
Fields
- pickupSlotEndTime? string - The date and time the pickup slot ends, formatted as an <a href="https://www.iso.org/iso-8601-date-and-time-format.html" title="https://www.iso.org" target="_blank">ISO 8601</a> string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. <br><br><strong>Format:</strong> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br><strong>Example:</strong> <code>2018-08-20T07:09:00.000Z</code>
- pickupSlotTimeZone? string - The time zone of the pickup location, returned as <a href="https://www.iana.org/time-zones " target="_blank">Time Zone Database</a> ID (also known as an Olson time zone ID)
- pickupSlotId? string - Seller-defined name for the pickup slot
- pickupSlotStartTime? string - The date and time the pickup slot begins, formatted as an <a href="https://www.iso.org/iso-8601-date-and-time-format.html" title="https://www.iso.org" target="_blank">ISO 8601</a> UTC string
ebay.logistics: PurchasedRate
The "rate" that has been selected and purchased for the shipment, as referenced by the rateId value
Fields
- minEstimatedDeliveryDate? string - A string value representing minimum (earliest) estimated delivery time, formatted as an <a href="https://www.iso.org/iso-8601-date-and-time-format.html" title="https://www.iso.org" target="_blank">ISO 8601</a> UTC string
- maxEstimatedDeliveryDate? string - A string value representing maximum (latest) estimated delivery time, formatted as an <a href="https://www.iso.org/iso-8601-date-and-time-format.html" title="https://www.iso.org" target="_blank">ISO 8601</a> string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. <br><br><strong>Format:</strong> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br><strong>Example:</strong> <code>2018-08-20T07:09:00.000Z</code>
- pickupSlotId? string - This unique eBay-assigned ID value is returned only if the shipment has been configured for a scheduled pickup
- shippingQuoteId? string - The unique eBay-generated ID of the <i>shipping quote</i> from which the seller selected a shipping rate (<strong>rateId</strong>)
- totalShippingCost? Amount - A complex type that describes the value of a monetary amount as represented by a global currency
- destinationTimeZone? string - The time zone of the destination according to <a href="https://www.iana.org/time-zones " target="_blank">Time Zone Database</a>. For example, "America/Los_Angeles"
- shippingServiceCode? string - String ID code for the shipping service selected for the package shipment. This is a service that the shipping carrier supplies
- pickupType? PickupTypeEnum - 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 <strong>shippingRateId</strong> container is enriched with a collection of <strong>pickupSlots</strong>. To create a shipment for this type of service, you must provide a <strong>pickupSlotId</strong> value in addition to values for <strong>shippingQuoteId</strong> and <strong>shippingRateId</strong>. - 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 <strong>pickupNetwork</strong> field)
- rateId? string - The eBay-generated ID of the shipping rate that the seller has chosen to purchase for the shipment
- shippingServiceName? string - The name of the shipping service
- additionalOptions? AdditionalOption[] - A list of additional, optional features that have been purchased for the shipment
- pickupNetworks? string[] - A list of pickup networks compatible with the shipping service
- shippingCarrierCode? string - The ID code for the carrier that was selected for the package shipment
- baseShippingCost? Amount - A complex type that describes the value of a monetary amount as represented by a global currency
- shippingCarrierName? string - The name of the shipping carrier
ebay.logistics: Rate
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
Fields
- minEstimatedDeliveryDate? string - 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
- maxEstimatedDeliveryDate? string - The latest stated date and time the shipment will be delivered at this rate. <br><br>The time stamp is formatted as an <a href="https://www.iso.org/iso-8601-date-and-time-format.html" title="https://www.iso.org" target="_blank">ISO 8601</a> string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. <br><br><strong>Format:</strong> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br><strong>Example:</strong> <code>2018-08-20T07:09:00.000Z</code>
- pickupSlots? PickupSlot[] - A list of available pickup slots for the package
- destinationTimeZone? string - The name of the time zone region, as defined in the <a href="http://www.iana.org/time-zones " target="_blank">IANA Time Zone Database</a>, to which the package is being shipped. <br><br>Delivery dates are calculated relative to this time zone. <br><br><span class="tablenote"><strong>Note:</strong> This is different from a Coordinated Universal Time (UTC) offset. For example, the <i>America/Los_Angeles</i> time zone identifies a region with the UTC standard time offset of <code>-08:00</code>, but so do several other time zones, including <i>America/Tijuana</i>,<i>America/Dawson</i>, and <i>Pacific/Pitcairn</i>.</span>
- shippingServiceCode? string - The code name of the shipping service to be provided by the carrier identified by <strong>shippingCarrierCode</strong>
- pickupType? PickupTypeEnum - 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 <strong>shippingRateId</strong> container is enriched with a collection of <strong>pickupSlots</strong>. To create a shipment for this type of service, you must provide a <strong>pickupSlotId</strong> value in addition to values for <strong>shippingQuoteId</strong> and <strong>shippingRateId</strong>. - 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 <strong>pickupNetwork</strong> field)
- rateRecommendation? RateRecommendationEnum[] - A list of reasons this rate is recommended. Available values are: <ul> <li><code>BUYER_CHOSEN</code> — The rate meets or exceeds the requirements of the buyer's preferred shipping option.</li> <li><code>CHEAPEST_ON_TIME</code> — The rate is the cheapest rate available that will provide delivery within the seller's time frame commitment.</li> <li><code>EBAY_PLUS_OK</code> — The rate complies with the shipping requirements of the eBay Plus program.</li> <li><code>FASTEST_ON_TIME</code> — The rate has the fastest shipping time, and will provide delivery within the seller's time frame commitment.</li> <li><code>GUARANTEED_DELIVERY_OK</code> — The rate complies with the shipping requirements of the eBay Guaranteed Delivery program.</li></ul>
- rateId? string - The unique eBay-assigned ID for this shipping rate
- shippingServiceName? string - The common name of the shipping service
- additionalOptions? AdditionalOption[] - 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 <code>INSURANCE</code> and <code>SIGNATURE</code>
- pickupNetworks? string[] - A list of pickup networks compatible with the shipping service
- shippingCarrierCode? string - The code name of the shipping carrier who will provide the service identified by <strong>shippingServiceCode</strong>
- baseShippingCost? Amount - A complex type that describes the value of a monetary amount as represented by a global currency
- shippingCarrierName? string - The common name of the shipping carrier
ebay.logistics: Shipment
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.
Fields
- packageSpecification? PackageSpecification - This complex type specifies the dimensions and weight of a package
- shipFrom? Contact - This complex type contains contact information for an individual buyer or seller
- labelDownloadUrl? string - The direct URL the seller can use to download an image of the shipping label. By default, the file format is PDF. See <a href="/api-docs/sell/logistics/resources/shipment/methods/downloadLabelFile">downloadLabelFile</a> for requesting different response file formats
- creationDate? string - The date and time the shipment was created, formatted as an <a href="https://www.iso.org/iso-8601-date-and-time-format.html" title="https://www.iso.org" target="_blank">ISO 8601</a> string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. <br><br><strong>Format:</strong> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br><strong>Example:</strong> <code>2018-08-20T07:09:00.000Z</code>
- labelCustomMessage? string - If supported by the selected shipping carrier, this field can contain optional seller text to be printed on the shipping label
- cancellation? ShipmentCancellation - This type defines a shipment cancellation by the date and time the cancellation request was made and the current status of the request
- labelSize? string - The seller's desired label size. The support for multi-sized labels is shipping-carrier specific and if the size requested in the <strong>createFromShippingQuote</strong> call matches a size the carrier supports, the value will be represented here in the shipment. <br><br>Currently, the only valid value is: <code>4"x6"</code>
- rate? PurchasedRate - The "rate" that has been selected and purchased for the shipment, as referenced by the <strong>rateId</strong> value
- shipmentId? string - The unique eBay-assigned ID for the shipment. The ID is generated when the shipment is created by a call to <strong>createFromShippingQuote</strong>
- returnTo? Contact - This complex type contains contact information for an individual buyer or seller
- shipmentTrackingNumber? string - A unique carrier-assigned ID string that can be used to track the shipment
- orders Order[] - A list of one or more orders that will be shipped in the shipping package
- shipTo? Contact - This complex type contains contact information for an individual buyer or seller
ebay.logistics: ShipmentCancellation
This type defines a shipment cancellation by the date and time the cancellation request was made and the current status of the request
Fields
- cancellationStatus? ShipmentCancellationStatusEnum - 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
- cancellationRequestedDate? string - The time and date the request was made to cancel the shipment, formatted as an <a href="https://www.iso.org/iso-8601-date-and-time-format.html" title="https://www.iso.org" target="_blank">ISO 8601</a> UTC string
ebay.logistics: ShippingQuote
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
Fields
- packageSpecification? PackageSpecification - This complex type specifies the dimensions and weight of a package
- shipFrom? Contact - This complex type contains contact information for an individual buyer or seller
- rates? Rate[] - A list of <i>rates</i> where each rate, as identified by a <strong>rateId</strong>, 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.<br><br><span class="tablenote"><strong>Note:</strong> The Logistics API only supports USPS shipping rates and labels.</span><br>Each rate offered is supported by a label service where you can purchase the rate, and associated shipping label, via a call to <strong>createFromShippingQuote</strong>
- warnings? ErrorDetailV3[] - A list of any warnings triggered by the request
- shippingQuoteId? string - 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
- orders Order[] - A list of one or more orders that will be shipped in the shipping package
- creationDate? string - The date and time this quote was created, expressed as an ISO 8601 UTC string
- expirationDate? string - 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
- shipTo? Contact - This complex type contains contact information for an individual buyer or seller
ebay.logistics: ShippingQuoteRequest
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
Fields
- packageSpecification PackageSpecification - This complex type specifies the dimensions and weight of a package
- shipFrom Contact - This complex type contains contact information for an individual buyer or seller
- orders Order[] - In this array, the seller specifies one or more orders that will be shipped in the shipping package. <br><br>A shipping package can contain any number of line items from one or more orders, providing they all ship in the same package. <br><br><strong>Maximum list size:</strong> 10
- shipTo Contact - This complex type contains contact information for an individual buyer or seller
ebay.logistics: Weight
This complex type contains information about the weight of an object such as a shipping package
Fields
- unit WeightUnitOfMeasureEnum - 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
- value string - The numeric value of the weight of the package, as measured by the value of <strong>unit</strong>
Union types
ebay.logistics: LengthUnitOfMeasureEnum
LengthUnitOfMeasureEnum
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
ebay.logistics: PickupTypeEnum
PickupTypeEnum
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)
ebay.logistics: WeightUnitOfMeasureEnum
WeightUnitOfMeasureEnum
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
ebay.logistics: ShipmentCancellationStatusEnum
ShipmentCancellationStatusEnum
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
ebay.logistics: CurrencyCodeEnum
CurrencyCodeEnum
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
ebay.logistics: RateRecommendationEnum
RateRecommendationEnum
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
ebay.logistics: CountryCodeEnum
CountryCodeEnum
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
Import
import ballerinax/ebay.logistics;Metadata
Released date: about 17 hours ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 52
Current verison: 1
Weekly downloads
Keywords
Vendor/eBay
Area/E-Commerce
Type/Connector
Contributors