> ## Documentation Index > Fetch the complete documentation index at: https://developers.teleship.com/llms.txt > Use this file to discover all available pages before exploring further. # Get shipping quotes > Calculate and retrieve real-time shipping rates and quotes for your shipment. **How it works:** - Provide shipment details (origin, destination, weight, dimensions, etc.) - Receive a list of available services, each with: - Price breakdown (Freight, VAT, Duty, etc.) - Estimated delivery date - Service code and name **Example use case:** Get instant shipping options for a checkout page or to compare costs for different service levels. ## OpenAPI ````yaml /api-reference/openapi.json post /api/rates/quotes openapi: 3.0.0 info: title: Teleship description: > Teleship is a leading cross-border logistics provider offering seamless global commerce solutions through our comprehensive API. With Teleship's API, developers can integrate our cross-border shipping services, trade engine, and logistics solutions directly into their applications. **Key Features:** - Cross-border shipping solutions for international commerce - Real-time shipping rates and delivery estimates - End-to-end shipment tracking with detailed status updates - Automated customs compliance and product classification - Real-time event notifications through webhooks **Why Teleship?** - API-first: Developer-friendly integration with comprehensive documentation - Enterprise-ready: Built for businesses of all sizes - Secure: Enterprise-grade security and compliance - Integrated: Seamless connection with e-commerce, ERP, and fulfillment systems Start shipping globally with Teleship's powerful cross-border logistics API. version: 1.0.0 contact: {} servers: - url: https://api.teleship.com security: [] tags: [] paths: /api/rates/quotes: post: tags: - Shipping Services summary: Get shipping quotes description: > Calculate and retrieve real-time shipping rates and quotes for your shipment. **How it works:** - Provide shipment details (origin, destination, weight, dimensions, etc.) - Receive a list of available services, each with: - Price breakdown (Freight, VAT, Duty, etc.) - Estimated delivery date - Service code and name **Example use case:** Get instant shipping options for a checkout page or to compare costs for different service levels. operationId: getShippingQuotes parameters: - name: x-request-id in: header required: false schema: type: string - name: x-account-id in: header required: false schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QuoteRequestDto' examples: UKToUS: value: shipTo: name: John address: line1: 2513 S Jackson St city: Seattle postcode: '98144' state: WA country: US shipFrom: name: Jane address: line1: 3 Belvedere Pl city: London postcode: SE1 0AD country: GB weight: value: '1.2' unit: kg dimensions: length: '40' width: '30' height: '16' unit: cm packageType: parcel UKToUSOrder: value: customerReference: '#EN40754' packageType: parcel shipTo: name: John Doe email: john.doe@example.com phone: +1 213-601-6000 address: city: Los Angeles line1: 1300 Eunice Avenue state: CA country: US postcode: '90001' shipFrom: name: Sample Electronics Ltd address: city: Watford line1: 4 Langley Business Court line2: Beechen Grove state: Hertfordshire country: GB postcode: WD17 4HA company: Sample Electronics Ltd weight: unit: kg value: 0.85 dimensions: unit: cm width: 20 height: 10 length: 25 commodities: - sku: ABox-2 title: E-Stim ABox 2 Audio Powered Stimulator value: amount: 179.17 currency: GBP quantity: 1 unitWeight: unit: kg value: 0.45 hsCode: '9019109000' description: >- Audio powered electrostimulation device for TENS/EMS therapy countryOfOrigin: GB category: electronics - sku: EM140 title: Electrode Pads (Pack of 4) value: amount: 12.5 currency: GBP quantity: 2 unitWeight: unit: kg value: 0.05 hsCode: '9018909980' description: >- Self-adhesive electrode pads for electrostimulation devices countryOfOrigin: CN category: medical_accessories - sku: CB-USB-A title: USB Charging Cable value: amount: 8.33 currency: GBP quantity: 1 unitWeight: unit: kg value: 0.03 hsCode: '8544422000' description: USB Type-A charging cable for electronic devices countryOfOrigin: CN category: electronics metadata: fulfillmentOrderId: gid://shopify/FulfillmentOrder/761708049XXX customs: EORI: GB078617476000 contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.026Z' invoiceNumber: '#EN40754' incoterms: DAP orderTotalValue: amount: 212.5 currency: GBP UKToDE: value: shipTo: name: Logan Doe address: line1: Leopoldstraße 119 city: München postcode: '80804' country: DE shipFrom: name: Jane address: line1: 3 Belvedere Pl city: London postcode: SE1 0AD country: GB weight: value: '0.5' unit: kg dimensions: length: '10' width: '20' height: '20' unit: cm packageType: parcel DutiableUKToDE: value: shipTo: name: Logan Doe address: line1: Leopoldstraße 119 city: München postcode: '80804' country: DE shipFrom: name: Jane address: line1: 3 Belvedere Pl city: London postcode: SE1 0AD country: GB packageType: parcel weight: value: '4.5' unit: kg dimensions: length: '30' width: '30' height: '25' unit: cm commodities: - quantity: 1 title: Flix Earrings hsCode: '7117190090' value: amount: 136.74 currency: GBP kgWeight: 0.18 unitWeight: unit: kg value: 0.18 sku: stock-1 countryOfOrigin: GR customs: contentType: CommercialGoods orderTrackingReference: '1234567890' USToGB: value: customerReference: '#2501' packageType: parcel shipTo: name: Robin Doe email: robin.doe@example.com phone: +44 20 7946 0987 address: city: London line1: 42 Kensington Gardens line2: Flat 3 state: England country: GB postcode: W8 4PX shipFrom: name: Sample Tech Co company: Sample Enterprises LLC phone: +1 617-555-4321 address: city: Boston line1: 155 Seaport Boulevard line2: Suite 500 state: MA country: US postcode: '02210' weight: unit: kg value: 1.25 dimensions: unit: cm width: 28 height: 10 length: 42 commodities: - sku: BTG-AUDIO-505 title: Premium Noise-Cancelling Headphones value: amount: 249.99 currency: USD quantity: 1 unitWeight: unit: kg value: 0.35 description: >- Professional-grade over-ear headphones with active noise cancellation and Bluetooth 5.2 technology. countryOfOrigin: US hsCode: 8518.30.2000 - sku: BTG-ACC-121 title: Protective Headphone Case value: amount: 45.99 currency: USD quantity: 1 unitWeight: unit: kg value: 0.28 description: >- Hard-shell protective case with custom molded interior for headphones. countryOfOrigin: US hsCode: 4202.12.8000 customs: contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#BTG-INV-5678' metadata: orderSource: website orderDate: '2026-05-02T20:22:57.027Z' USToNL: value: customerReference: '#3092' packageType: parcel shipTo: name: Sage Doe email: sage.doe@example.com phone: +31 20 123 4567 address: city: Amsterdam line1: Prinsengracht 587 line2: 2nd Floor country: NL postcode: 1016 HT shipFrom: name: Sample Natural Products company: Sample Organics Inc. phone: +1 503-555-7890 address: city: Portland line1: 1750 NW Naito Parkway state: OR country: US postcode: '97209' weight: unit: kg value: 2.7 dimensions: unit: cm width: 35 height: 22 length: 45 commodities: - sku: POI-SUPP-742 title: Organic Mushroom Extract Blend value: amount: 75.5 currency: USD quantity: 3 unitWeight: unit: kg value: 0.18 description: >- Premium blend of organic lion's mane, reishi, chaga, and cordyceps mushroom extracts in capsule form. countryOfOrigin: US hsCode: 2106.90.9998 - sku: POI-VITA-311 title: Plant-Based Omega-3 Supplement value: amount: 32.99 currency: USD quantity: 2 unitWeight: unit: kg value: 0.22 description: >- Vegan omega-3 supplement derived from algae oil, containing EPA and DHA fatty acids. countryOfOrigin: US hsCode: 2106.90.9200 - sku: POI-TEA-129 title: Organic Herbal Tea Collection value: amount: 28.95 currency: USD quantity: 1 unitWeight: unit: kg value: 0.35 description: >- Set of 4 organic herbal tea blends including chamomile, peppermint, lemon balm, and valerian root. countryOfOrigin: US hsCode: 0902.10.0000 customs: contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#POI-2025-1243' IOSS: IM8741236501 metadata: orderSource: marketplace orderDate: '2026-05-01T20:22:57.027Z' NLToGB: value: customerReference: '#4001' packageType: parcel shipTo: name: Oakley Doe email: oakley.doe@example.com phone: +44 20 7946 1234 address: city: London line1: 15 Baker Street line2: Suite 3A state: England country: GB postcode: NW1 6XE shipFrom: name: Parker Doe company: Sample Design Studio phone: +31 20 555 0123 email: parker.doe@example.com address: city: Amsterdam line1: Herengracht 245 line2: 2nd Floor country: NL postcode: 1016 BG weight: unit: kg value: 1.8 dimensions: unit: cm width: 32 height: 18 length: 45 commodities: - sku: DDS-LAMP-301 title: Dutch Design Table Lamp value: amount: 89.99 currency: EUR quantity: 1 unitWeight: unit: kg value: 1.2 description: >- Modern minimalist table lamp with sustainable bamboo base and energy-efficient LED bulb. countryOfOrigin: NL hsCode: 9405.20.1000 - sku: DDS-BULB-LED title: Energy Efficient LED Bulb value: amount: 12.5 currency: EUR quantity: 2 unitWeight: unit: kg value: 0.3 description: >- Replacement LED bulb with warm white light, compatible with Dutch Design lamps. countryOfOrigin: NL hsCode: 8539.50.0000 customs: contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#DDS-2025-4001' EORI: NL858077810B01 metadata: orderSource: webshop orderDate: '2026-05-02T20:22:57.027Z' DEToGB: value: customerReference: '#5002' packageType: parcel shipTo: name: Pat Doe email: pat.doe@example.com phone: +44 161 234 5678 address: city: Manchester line1: 42 Deansgate state: England country: GB postcode: M3 2AZ shipFrom: name: Kelly Doe company: Sample Tools GmbH phone: +49 30 12345678 email: kelly.doe@example.com address: city: Berlin line1: Unter den Linden 12 line2: Büro 405 country: DE postcode: '10117' weight: unit: kg value: 3.2 dimensions: unit: cm width: 25 height: 12 length: 55 commodities: - sku: PT-DRILL-SET-PRO title: Professional Drill Bit Set value: amount: 145 currency: EUR quantity: 1 unitWeight: unit: kg value: 2.8 description: >- Professional 20-piece HSS drill bit set with titanium coating, manufactured in Germany. countryOfOrigin: DE hsCode: 8207.50.3000 - sku: PT-CASE-METAL title: Metal Storage Case value: amount: 28 currency: EUR quantity: 1 unitWeight: unit: kg value: 0.4 description: >- Durable metal storage case with foam inserts for drill bits and tools. countryOfOrigin: DE hsCode: 7326.90.9800 customs: contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#PT-INV-5002' EORI: DE123456789012345 metadata: orderSource: b2b_portal orderDate: '2026-04-30T20:22:57.027Z' BEToGB: value: customerReference: '#6003' packageType: parcel shipTo: name: James Doe email: james.doe@example.com phone: +44 131 555 0987 address: city: Edinburgh line1: 28 Royal Mile line2: Flat 2B state: Scotland country: GB postcode: EH1 1TH shipFrom: name: Morgan Doe company: Sample Chocolatiers SA phone: +32 2 123 4567 email: marie@belgchocolate.be address: city: Brussels line1: Rue de la Loi 200 line2: Bureau 15 country: BE postcode: '1000' weight: unit: kg value: 2.1 dimensions: unit: cm width: 30 height: 8 length: 40 commodities: - sku: BC-PRALINE-DELUXE title: Belgian Praline Collection Deluxe value: amount: 65 currency: EUR quantity: 2 unitWeight: unit: kg value: 0.8 description: >- Premium Belgian pralines with dark, milk, and white chocolate varieties, handcrafted in Brussels. countryOfOrigin: BE hsCode: 1806.90.5000 - sku: BC-GIFT-BOX title: Luxury Gift Box value: amount: 15 currency: EUR quantity: 2 unitWeight: unit: kg value: 0.25 description: >- Elegant gift box with gold foil embossing and satin ribbon. countryOfOrigin: BE hsCode: 4819.20.1000 customs: contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#BC-2025-6003' EORI: BE0123456789 metadata: orderSource: gourmet_marketplace orderDate: '2026-05-01T20:22:57.027Z' giftWrapped: true FRToGB: value: customerReference: '#7004' packageType: parcel shipTo: name: Chris Doe email: chris.doe@example.com phone: +44 29 2055 5432 address: city: Cardiff line1: 56 Queen Street line2: Apartment 4C state: Wales country: GB postcode: CF10 2GQ shipFrom: name: Sydney Doe company: Sample Parfums phone: +33 1 42 36 78 90 email: sydney.doe@example.com address: city: Paris line1: 25 Rue de Rivoli line2: 3ème étage country: FR postcode: '75001' weight: unit: kg value: 0.8 dimensions: unit: cm width: 20 height: 15 length: 25 commodities: - sku: PDP-PERFUME-001 title: Eau de Parfum - Rose Éternelle value: amount: 125 currency: EUR quantity: 1 unitWeight: unit: kg value: 0.5 description: >- Luxury French perfume with notes of Bulgarian rose, jasmine, and sandalwood. 50ml bottle. countryOfOrigin: FR hsCode: 3303.00.1000 - sku: PDP-BODY-LOTION title: Scented Body Lotion value: amount: 45 currency: EUR quantity: 1 unitWeight: unit: kg value: 0.3 description: >- Matching scented body lotion with rose essence and moisturizing ingredients. 150ml. countryOfOrigin: FR hsCode: 3304.99.0000 customs: contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#PDP-FR-7004' EORI: FR12345678901 metadata: orderSource: beauty_boutique orderDate: '2026-05-02T20:22:57.027Z' fragileItems: true ESToGB: value: customerReference: '#8005' packageType: parcel shipTo: name: Marlo Doe email: marlo.doe@example.com phone: +44 113 456 7890 address: city: Leeds line1: 89 The Headrow state: England country: GB postcode: LS1 5JW shipFrom: name: Cameron Doe company: Sample Design SL phone: +34 91 123 4567 email: cameron.doe@example.com address: city: Madrid line1: Calle de Alcalá 42 line2: Piso 3 country: ES postcode: '28014' weight: unit: kg value: 4.5 dimensions: unit: cm width: 35 height: 25 length: 50 commodities: - sku: DM-SILLA-ROBLE title: Silla de Comedor Mediterránea value: amount: 189 currency: EUR quantity: 1 unitWeight: unit: kg value: 3.8 description: >- Silla de comedor artesanal hecha de roble español con acabado natural de aceite. countryOfOrigin: ES hsCode: 9401.61.0000 - sku: DM-COJIN-LINO title: Cojín de Asiento de Lino Orgánico value: amount: 79 currency: EUR quantity: 1 unitWeight: unit: kg value: 0.7 description: >- Cómodo cojín de asiento hecho de lino orgánico con relleno natural. countryOfOrigin: ES hsCode: 9404.90.1000 customs: contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#DM-ES-8005' EORI: ES123456789000 metadata: orderSource: furniture_store orderDate: '2026-04-28T20:22:57.027Z' sustainableProducts: true UKToCanada: value: customerReference: '#CA-1001' packageType: parcel shipTo: name: Pat Doe email: sarah@canadianshop.ca phone: +1 250-555-0123 address: city: Victoria line1: 778 Douglas Street state: BC country: CA postcode: V8W 2B5 shipFrom: name: Manchester Store address: city: Manchester line1: Mosley Road state: England country: GB postcode: M17 1FQ company: Sample Fashion Co weight: unit: kg value: 2.5 dimensions: unit: cm width: 30 height: 15 length: 35 commodities: - sku: CL12877213039 title: >- Uptown | Black Croc Fitted Over-Knee Pointed Heeled Boots - UK 6 value: amount: 185.13 currency: GBP quantity: 3 unitWeight: unit: kg value: 0.7 description: High-quality fashion boots with fitted design countryOfOrigin: GB hsCode: '6403511000' customs: EORI: GB078617476000 contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#CA-1001' orderTotalValue: amount: 555.39 currency: GBP UKToAustralia: value: customerReference: '#AU-2001' packageType: parcel shipTo: name: Chris Doe email: chris.doe@example.com phone: +61 2 9555 0123 address: city: Sydney line1: 1 Martin Place line2: Level 5 state: NSW country: AU postcode: '2000' company: Sample Imports Pty Ltd shipFrom: name: London Store address: city: London line1: Buckingham Palace Road state: England country: GB postcode: SW1A 1AA company: Sample Goods Ltd weight: unit: kg value: 2.2 dimensions: unit: cm width: 35 height: 25 length: 40 commodities: - sku: TS-001-AU title: Premium British Tea Set value: amount: 129.99 currency: GBP quantity: 2 unitWeight: unit: kg value: 0.9 description: Fine bone china tea set with British heritage design countryOfOrigin: GB hsCode: '6911101000' customs: contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#AU-2001' orderTotalValue: amount: 259.98 currency: GBP UKToNewZealand: value: customerReference: '#NZ-3001' packageType: parcel shipTo: name: James Doe email: james@wellingtonltd.co.nz phone: +64 4 555 0123 address: city: Wellington line1: 123 Lambton Quay state: Wellington country: NZ postcode: '6011' shipFrom: name: Edinburgh Store address: city: Edinburgh line1: 1 Princes Street state: Scotland country: GB postcode: EH1 1RF company: Sample Scottish Exports weight: unit: kg value: 1.5 dimensions: unit: cm width: 40 height: 10 length: 60 commodities: - sku: WB-002-NZ title: Highland Wool Blanket value: amount: 99.99 currency: GBP quantity: 1 unitWeight: unit: kg value: 1.5 description: Traditional Scottish wool blanket, handwoven countryOfOrigin: GB hsCode: '6301300010' customs: contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#NZ-3001' orderTotalValue: amount: 99.99 currency: GBP UKToSingapore: value: customerReference: '#SG-4001' packageType: parcel shipTo: name: Casey Doe email: wei.chen@asiapacific.sg phone: +65 6555 0123 address: city: Singapore line1: 1 Raffles Place line2: '#42-01' country: SG postcode: '018956' company: Sample Pacific Imports shipFrom: name: Oxford Store address: city: Oxford line1: High Street state: Oxfordshire country: GB postcode: OX1 2JD company: Sample Trading Co weight: unit: kg value: 0.35 dimensions: unit: cm width: 15 height: 5 length: 20 commodities: - sku: DW-003-SG title: Designer Luxury Watch value: amount: 450 currency: GBP quantity: 1 unitWeight: unit: kg value: 0.25 description: Swiss-made luxury timepiece with leather strap countryOfOrigin: CH hsCode: '9102210080' customs: contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#SG-4001' orderTotalValue: amount: 450 currency: GBP UKToHongKong: value: customerReference: '#HK-5001' packageType: parcel shipTo: name: Riley Doe email: li.ming@hktraders.hk phone: +852 2555 0123 address: city: Central line1: 8 Finance Street line2: Unit 1502 state: Hong Kong Island country: HK company: Sample Traders Ltd shipFrom: name: Birmingham Store address: city: Birmingham line1: New Street state: West Midlands country: GB postcode: B1 1AA company: Sample Jewellers weight: unit: kg value: 0.2 dimensions: unit: cm width: 10 height: 3 length: 15 commodities: - sku: SN-004-HK title: Sterling Silver Necklace value: amount: 280 currency: GBP quantity: 2 unitWeight: unit: kg value: 0.06 description: Handcrafted sterling silver necklace with gemstones countryOfOrigin: GB hsCode: '7113112000' customs: contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#HK-5001' orderTotalValue: amount: 560 currency: GBP UKToUAE: value: customerReference: '#AE-6001' packageType: parcel shipTo: name: Quinn Doe email: ahmed@dubaitrading.ae phone: +971 4 555 0123 address: city: Dubai line1: Sheikh Zayed Road line2: Boulevard Plaza Tower 1 state: Dubai country: AE postcode: '00000' company: Sample Trading LLC shipFrom: name: Leeds Store address: city: Leeds line1: City Square state: West Yorkshire country: GB postcode: LS1 1UR company: Sample Exports Ltd weight: unit: kg value: 1 dimensions: unit: cm width: 35 height: 8 length: 40 commodities: - sku: LH-005-AE title: Designer Luxury Handbag value: amount: 750 currency: GBP quantity: 1 unitWeight: unit: kg value: 0.8 description: Premium leather handbag with gold hardware countryOfOrigin: IT hsCode: '4202210090' customs: contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#AE-6001' orderTotalValue: amount: 750 currency: GBP UKToSaudiArabia: value: customerReference: '#SA-7001' packageType: parcel shipTo: name: Drew Doe email: mohammed@riyadhcommerce.sa phone: +966 11 555 0123 address: city: Riyadh line1: King Fahd Road line2: Al Olaya District state: Riyadh country: SA postcode: '12271' company: Sample Commerce Co shipFrom: name: Glasgow Store address: city: Glasgow line1: George Square state: Scotland country: GB postcode: G2 1DY company: Sample Merchants weight: unit: kg value: 2.8 dimensions: unit: cm width: 40 height: 12 length: 60 commodities: - sku: BS-006-SA title: Savile Row Business Suits value: amount: 950 currency: GBP quantity: 3 unitWeight: unit: kg value: 0.8 description: Bespoke tailored business suits in premium wool countryOfOrigin: GB hsCode: '6203110000' customs: contentType: CommercialGoods invoiceDate: '2026-05-03T20:22:57.027Z' invoiceNumber: '#SA-7001' orderTotalValue: amount: 2850 currency: GBP responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/QuoteResponseDto' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ResponseMessagesDto' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ResponseMessagesDto' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ResponseMessagesDto' security: - bearer: [] components: schemas: QuoteRequestDto: type: object properties: shipTo: $ref: '#/components/schemas/RateDestinationDto' shipFrom: $ref: '#/components/schemas/RateOriginDto' returnTo: $ref: '#/components/schemas/RateOriginDto' billTo: $ref: '#/components/schemas/LocationDto' shipDate: type: string description: >- The expected pickup/dropoff date. If provided this must be at least one non-holiday, business day in the future format: date-time example: '2024-01-01T00:00:00.00Z' weight: $ref: '#/components/schemas/WeightDto' dimensions: $ref: '#/components/schemas/DimensionsDto' description: type: string description: Gives the recipient information about the parcel in tracking emails. maxLength: 100 packageType: type: string description: The type of package for the shipment enum: - envelope - tube - parcel default: parcel commodities: description: >- List of the parcel's contents for customs purposes. One entry for each item in the parcel. type: array items: $ref: '#/components/schemas/CommodityDataDto' customs: description: Customs declaration details for the shipment default: contentType: CommercialGoods allOf: - $ref: '#/components/schemas/CustomsDto' additionalServices: description: Additional services for the shipment allOf: - $ref: '#/components/schemas/AdditionalServiceDto' orderTrackingReference: type: string description: The request reference for the shipment customerReference: type: string description: >- Customer information that will appear on the label. This can be used for pick and pack purposes, to help with parcel identification, or anything else the shipper needs. commercialInvoiceReference: type: string description: Commercial invoice reference metadata: type: object additionalProperties: true default: {} freightCharge: description: >- The freight/shipping charge provided by the merchant at checkout. Used for accurate VAT-on-freight calculations. allOf: - $ref: '#/components/schemas/AmountDto' required: - shipTo - shipFrom - weight - dimensions QuoteResponseDto: type: object properties: messages: type: array items: $ref: '#/components/schemas/ErrorResponseDto' rates: description: The available rates for the shipment type: array items: $ref: '#/components/schemas/RateDto' commodities: description: Classified and dutiable commodities info type: array items: $ref: '#/components/schemas/CommodityInfoDto' scaleWeight: description: The scale weight of the shipment allOf: - $ref: '#/components/schemas/WeightDto' dimWeight: description: The dimensional weight of the shipment allOf: - $ref: '#/components/schemas/WeightDto' billWeight: description: The bill weight of the shipment allOf: - $ref: '#/components/schemas/WeightDto' required: - messages ResponseMessagesDto: type: object properties: messages: type: array items: $ref: '#/components/schemas/ErrorResponseDto' required: - messages RateDestinationDto: type: object properties: email: type: string description: Email address for the recipient. phone: type: string description: >- Phone number for the recipient. A valid local phone number including area code or a fully qualified international number. Drivers can use this to coordinate pickup with the sender. company: type: string description: >- Business name. This helps the driver successfully collect and deliver the parcel. name: type: string description: The recipient's name. address: description: The destination address for the shipment allOf: - $ref: '#/components/schemas/RateDestinationAddressDto' required: - address RateOriginDto: type: object properties: email: type: string description: Email address for the shipper. phone: type: string description: >- Phone number for the shipper. A valid local phone number including area code or a fully qualified international number. Drivers can use this to coordinate pickup with the sender. company: type: string description: >- Business name. This helps the driver successfully collect and deliver the parcel. name: type: string description: The shipper's name. address: description: The origin address for the shipment allOf: - $ref: '#/components/schemas/RateOriginAddressDto' required: - address LocationDto: type: object properties: name: type: string description: The shipper's name. email: type: string description: Email address for the shipper. phone: type: string description: >- Phone number for the shipper. A valid local phone number including area code or a fully qualified international number. Drivers can use this to coordinate pickup with the sender. company: type: string description: >- Business name. This helps the driver successfully collect and deliver the parcel. stateTaxId: type: string description: The state tax Id countryTaxId: type: string description: The country tax Id. EORI number for GB, EIN number for US address: default: line1: '' city: '' postcode: '' country: GB allOf: - $ref: '#/components/schemas/AddressDto' required: - name - address WeightDto: type: object properties: value: type: number description: The decimal value of the item weight. default: '1.0' minimum: 0.001 unit: type: string description: The unit of measurement for the weight enum: - kg - lb default: kg required: - value - unit DimensionsDto: type: object properties: length: type: number description: The decimal value of the length of the item default: '40.0' width: type: number description: The decimal value of the width of the item default: '30.0' height: type: number description: The decimal value of the height of the item default: '16.0' unit: type: string description: The unit of measurement for the dimensions enum: - cm - in default: cm required: - length - width - height - unit CommodityDataDto: type: object properties: title: type: string description: Short name or title of the item. maxLength: 250 description: type: string description: Detailed description of the contents for customs purposes. maxLength: 250 hsCode: type: string description: >- A Harmonized System code for this item, appropriate for the destination country. Single HS tarrif code only. Must be a valid HS code format of 6–10 digits. sku: type: string description: The SKU of the item. maxLength: 50 quantity: type: number description: How many of this item are in the parcel? Must be a whole number. default: 1 value: description: The monetary value of the item. allOf: - $ref: '#/components/schemas/AmountDto' unitWeight: description: >- The weight of a single item. Note we will get a total weight from the quantity and unit weight. allOf: - $ref: '#/components/schemas/WeightDto' countryOfOrigin: type: string description: The country where the goods were manufactured. enum: - AF - AL - DZ - AS - AC - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - EL - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - AN - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW category: type: string description: The category of the item. imageUrl: type: string description: The URL of the product image. productUrl: type: string description: The URL of the product page. productId: type: string description: The product ID of the item. variantId: type: string description: The variant ID of the item. compliance: description: The advanced details of the commodity. allOf: - $ref: '#/components/schemas/CommodityComplianceDto' metadata: type: object additionalProperties: true description: Metadata about the commodity. default: {} required: - title - quantity - value - unitWeight CustomsDto: type: object properties: contentType: type: string description: The description of the contents for customs purposes. enum: - Documents - Gift - Sample - Other - CommercialGoods - ReturnOfGoods incoterms: type: string description: The incoterms for the shipment. enum: - DDP - DDU invoiceNumber: type: string description: The invoice number for the shipment. invoiceDate: format: date-time type: string description: The date of the invoice. orderId: type: string description: The order ID of the shipment orderTotalValue: description: The total value of the invoice. allOf: - $ref: '#/components/schemas/AmountDto' certified: type: boolean description: Whether the contents are cerified. signedBy: type: string description: The name of the person who certifies the customs content. EORI: type: string description: The EORI number of the seller. IOSS: type: string description: The IOSS number of the seller. VAT: type: string description: The VAT number of the seller. EIN: type: string description: The EIN number of the seller. VOECNUMBER: type: string description: The Norwegian VAT number of the seller. SWISSVAT: type: string description: The Swiss VAT number of the seller. KAR_VAT: type: string description: K number of the seller. CA_GST: type: string description: Canadian GST number of the seller. AU_GST: type: string description: Australian GST number of the seller. NZ_GST: type: string description: New Zealand GST number of the seller. JPConsumptionTax: type: string description: The Swiss VAT number of the seller. GPSRContactInfo: type: string description: The contact information for the GPSR. importerOfRecord: description: The importer of record. allOf: - $ref: '#/components/schemas/LocationDto' required: - contentType AdditionalServiceDto: type: object properties: signatureRequired: type: boolean description: Whether the package is signature required. fees may apply. deliveryWarranty: type: boolean description: The delivery warranty. fees may apply. deliveryPUDO: type: boolean description: The delivery PUDO. fees may apply. lowCarbon: type: boolean description: The low carbon. fees may apply. dutyTaxCalculation: type: string description: The duty tax calculation. enum: - DUTY_TAX_GUARANTEE - DUTY_TAX_CONSIGNEE_COLLECTION AmountDto: type: object properties: amount: type: number description: A decimal value. example: '15.0' currency: type: string description: The currency of the amount. enum: - GBP - USD - EUR - CAD - AUD - BGN - CZK - DKK - HUF - PLN - RON - SEK - NZD - SAR - AED - HKD - SGD default: GBP required: - amount - currency ErrorResponseDto: type: object properties: code: type: number level: type: string enum: - error - warning - info example: error description: Error level default: error timestamp: format: date-time type: string example: '2024-01-01T00:00:00.00Z' message: type: string example: An error occurred details: example: - Missing required field type: array items: type: string required: - code - level - timestamp - message - details RateDto: type: object properties: price: type: number description: The amount charged. example: '10.59' currency: type: string description: The currency of the rate. enum: - GBP - USD - EUR - CAD - AUD - BGN - CZK - DKK - HUF - PLN - RON - SEK - NZD - SAR - AED - HKD - SGD example: GBP transit: type: number description: The transit time in days. example: 5 estimatedDelivery: format: date-time type: string description: The estimated delivery date of the rate. example: '2024-01-01T00:00:00.00Z' service: description: The shipping service being used. allOf: - $ref: '#/components/schemas/ServiceDto' charges: description: >- Breakdowns of the components of the price. These items summed equal the total price. example: - name: base amount: 22.77 currency: GBP - name: Duty amount: 1.2 currency: GBP - name: VAT amount: 0.5 currency: GBP type: array items: $ref: '#/components/schemas/ChargeDto' required: - price - currency - transit - estimatedDelivery - service - charges CommodityInfoDto: type: object properties: itemNumber: type: number description: The item number of the commodity. title: type: string description: Short name or title of the item. maxLength: 250 hsCode: type: string description: The HS (Harmonized System) code used for duty calculation. charges: description: Breakdowns of the components of the price. example: - name: Duty amount: 1.2 currency: GBP rate: 0.1 type: array items: $ref: '#/components/schemas/ChargeDto' restrictions: description: The restrictions for the commodity. type: array items: $ref: '#/components/schemas/RestrictionFlagsEntryDto' required: - itemNumber - title RateDestinationAddressDto: type: object properties: line2: type: string description: Second line of the street address for the location. city: type: string description: >- City or town of the location. In certain regions the name here is validated against the postcode, so must be valid and match. state: type: string description: State, province, or territory of the location. postcode: type: string description: Postcode, postal code, or ZIP code of the location. isResidential: type: boolean description: Whether the address is residential. country: type: string description: The country of destination for the shipment enum: - US - GB - CA - AU - AT - BE - BG - HR - CY - CZ - DK - EE - FI - FR - DE - GR - HU - IE - IT - LV - LT - LU - MT - NL - PL - PT - RO - SI - SK - ES - SE - CH - IS - LI - 'NO' - NZ - SG - HK - AE - SA line1: type: string description: >- The street address for the location. Do not include the postcode, state, or suburb in this field. required: - country RateOriginAddressDto: type: object properties: line2: type: string description: Second line of the street address for the location. city: type: string description: >- City or town of the location. In certain regions the name here is validated against the postcode, so must be valid and match. state: type: string description: State, province, or territory of the location. postcode: type: string description: Postcode, postal code, or ZIP code of the location. isResidential: type: boolean description: Whether the address is residential. country: type: string description: The country of origin for the shipment enum: - GB - US - AT - BE - DE - ES - FR - IT - LU - NL line1: type: string description: >- The street address for the location. Do not include the postcode, state, or suburb in this field. required: - country AddressDto: type: object properties: line1: type: string description: >- The street address for the location. Do not include the postcode, state, or suburb in this field. line2: type: string description: Second line of the street address for the location. city: type: string description: >- City or town of the location. In certain regions the name here is validated against the postcode, so must be valid and match. state: type: string description: State, province, or territory of the location. country: type: string description: Country for the recipient. enum: - AF - AL - DZ - AS - AC - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - EL - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - AN - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW postcode: type: string description: Postcode, postal code, or ZIP code of the location. isResidential: type: boolean description: Whether the address is residential. required: - line1 - country CommodityComplianceDto: type: object properties: isControlGood: type: boolean description: Whether the commodity is controlled. controlType: type: string description: The type of control for the commodity. example: HealthRegulated regulatoryAgency: type: string description: The regulatory agencies for the commodity. example: FDA regulatoryProgram: type: string description: The regulatory program for the commodity. example: Food Safety regulatoryCategoryCode: type: string description: The regulatory category code for the commodity. example: 21-CFR-XYZ EIN: type: string description: The EIN of the seller. iossNumber: type: string description: The IOSS number of the seller. importLicenseNumber: type: string description: The license number of the seller. certificationType: type: string description: The certification type for the commodity. example: CE certificationReference: type: string description: The certificate number of the seller. example: CE-DECL-12345 ServiceDto: type: object properties: name: type: string description: The name of the service checkoutName: type: string description: The checkout display name for the service code: type: string description: The code of the service description: type: string description: The description of the service transit: type: number description: The transit time of the service dispatchDays: type: number description: The number of days it takes to dispatch the shipment default: 1 includeFirstMile: type: boolean description: Whether to include the first mile in the service default: false isActive: type: boolean description: Whether the service is active default: true config: type: object description: >- Service configuration options (JSON). Used for service-specific settings like postal duty calculation. example: isPostal: true id: type: string required: - name - code - transit ChargeDto: type: object properties: amount: type: number description: A decimal value. example: '15.0' currency: type: string description: The currency of the amount. enum: - GBP - USD - EUR - CAD - AUD - BGN - CZK - DKK - HUF - PLN - RON - SEK - NZD - SAR - AED - HKD - SGD default: GBP name: type: string description: The name of the charge. rate: type: number description: The rate of the charge (for VAT and duty charges). code: type: string description: The code of the charge. required: - name RestrictionFlagsEntryDto: type: object properties: id: type: string importRegion: type: string description: The import region flag: type: string description: The restriction flag status importRisk: type: string description: The import risk level countryOfOrigin: $ref: '#/components/schemas/Country' hts: type: string description: The hts information chapter: type: string description: The chapter information message: type: string description: Detailed restriction message info: type: string description: Additional information capture: type: string description: Capture type metadata: type: object description: Additional metadata serviceCode: type: string description: Service code for route-specific restrictions example: TELESHIP-EXPEDITED-PICKUP shippingMethod: type: string description: Shipping method for route-specific restrictions example: RM-RETURN-T24 restrictionLevel: $ref: '#/components/schemas/RestrictionLevel' createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - importRegion - flag - importRisk Country: type: string description: The country of origin enum: - AF - AL - DZ - AS - AC - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - EL - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - AN - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW RestrictionLevel: type: string description: Restriction level for this commodity enum: - 'FALSE' - 'TRUE' - ACCOUNT - All securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ````