---
updatedAt: 2026-06-18T06:23:52.000Z
agentTools:
  projectIndex: https://developers.easyship.com/llms.txt
---

# Create a Shipment

Create a new shipment.

Required authorization scope: `public.shipment:write` and `public.label:write` if a label is requested during the request.

## Select a courier

If you use our Rates API, you can define a courier ID to assign a courier to the shipment using `courier_service_id`. If you skip courier ID, we will return a list of all possible rates to your new shipment and assign the best value for money courier.

## Calculate dimensions and total weight

You can calculate dimensions and total weight of your shipment in three ways:

* Provide `total_actual_weight` and `box` objects for the shipment.
* Specify `actual_weight` and `dimensions` for each item of the `items` object: in this case, total weight and box size will be calculated automatically.
* Specify `sku` for each item of the `items` object: in this case, actual weight and dimensions for calculations will be taken as set for the product.


# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Easyship Public API",
    "version": "v2024-09",
    "description": "## Powerful Shipping API for Ecommerce\nEasyship provides a powerful shipping API for you to add hassle free worldwide shipping options to your website and end to end shipping functionality to your warehouse, ERP or platform.\n\n### Craft an amazing checkout experience\nProvide instant access to heavily discounted shipping with a single integration. Let end customers choose their preferred shipping method and cost, all within your own UI. Once they've selected and paid, confirm the shipment and all costs are guaranteed by us.\n\n### Write less code, have more options\nYou don’t need to be a shipping expert. We continuously add new shipping solutions to our platform to provide better pricing and service to our users. You don’t need to open direct accounts or write multiple integrations, once we’ve added them, they’re available to you instantly.\n\n### Streamline your processes\nInteract with the Easyship platform from any interface. Whether it’s your ecommerce platform, warehouse/wms, ERP or order management system, you can get rates, create shipments, download labels and track deliveries, without leaving your main business system.",
    "termsOfService": "https://www.easyship.com/legal/terms/overview",
    "contact": {
      "name": "Easyship Support",
      "url": "https://www.easyship.com/contact"
    }
  },
  "externalDocs": {
    "description": "Find out more about Easyship API",
    "url": "https://developers.easyship.com/"
  },
  "tags": [
    {
      "name": "Shipments"
    }
  ],
  "paths": {
    "/2024-09/shipments": {
      "post": {
        "summary": "Create a Shipment",
        "tags": [
          "Shipments"
        ],
        "operationId": "shipments_create",
        "description": "Create a new shipment.\n\nRequired authorization scope: `public.shipment:write` and `public.label:write` if a label is requested during the request.\n\n## Select a courier\n\nIf you use our Rates API, you can define a courier ID to assign a courier to the shipment using `courier_service_id`. If you skip courier ID, we will return a list of all possible rates to your new shipment and assign the best value for money courier.\n\n## Calculate dimensions and total weight\n\nYou can calculate dimensions and total weight of your shipment in three ways:\n\n* Provide `total_actual_weight` and `box` objects for the shipment.\n* Specify `actual_weight` and `dimensions` for each item of the `items` object: in this case, total weight and box size will be calculated automatically.\n* Specify `sku` for each item of the `items` object: in this case, actual weight and dimensions for calculations will be taken as set for the product.\n",
        "security": [
          {
            "Bearer": []
          }
        ],
        "parameters": [],
        "responses": {
          "201": {
            "description": "shipment successfully created",
            "content": {
              "application/json": {
                "examples": {
                  "product_id": {
                    "value": {
                      "shipment": {
                        "easyship_shipment_id": "ESSG10006002",
                        "buyer_regulatory_identifiers": {
                          "ein": null,
                          "ssn": null,
                          "vat_number": null
                        },
                        "consignee_tax_id": null,
                        "courier_service": {
                          "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                          "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                          "easyship_courier_service": true,
                          "name": "Courier 1",
                          "umbrella_name": "DHL"
                        },
                        "created_at": "2022-02-22T12:21:00Z",
                        "currency": "HKD",
                        "delivery_state": "not_created",
                        "destination_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+85230085678",
                          "country_alpha2": "HK",
                          "delivery_instructions": null,
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "eei_reference": null,
                        "incoterms": "DDU",
                        "insurance": {
                          "is_insured": false,
                          "insured_amount": 0,
                          "insured_currency": "HKD"
                        },
                        "label_generated_at": null,
                        "label_paid_at": null,
                        "label_state": "not_created",
                        "last_failure_http_response_messages": [],
                        "metadata": {},
                        "order_data": {
                          "buyer_notes": null,
                          "buyer_selected_courier_name": null,
                          "order_created_at": null,
                          "order_tag_list": [],
                          "platform_name": null,
                          "platform_order_number": null,
                          "seller_notes": null
                        },
                        "origin_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "parcels": [
                          {
                            "box": {
                              "id": null,
                              "name": null,
                              "outer_dimensions": {
                                "length": 0.785,
                                "width": 14.75,
                                "height": 21.9
                              },
                              "slug": null,
                              "type": "box",
                              "weight": 0
                            },
                            "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                            "items": [
                              {
                                "actual_weight": 0.206,
                                "category": "Mobile Phones",
                                "contains_battery_pi966": null,
                                "contains_battery_pi967": true,
                                "contains_liquids": null,
                                "declared_currency": "USD",
                                "declared_customs_value": 10,
                                "description": "iPhone 14 Pro",
                                "dimensions": {
                                  "length": 14.75,
                                  "width": 7.15,
                                  "height": 0.785
                                },
                                "hs_code": "15081000",
                                "id": "12663646-58c1-4607-8fe0-cae3e33c0001",
                                "origin_country_alpha2": "US",
                                "origin_currency": "HKD",
                                "origin_customs_value": 70,
                                "quantity": 2,
                                "sku": "SKU-00000001"
                              }
                            ],
                            "total_actual_weight": 1,
                            "tracking_number": null
                          }
                        ],
                        "pickup_state": "not_requested",
                        "rates": [
                          {
                            "additional_services_surcharge": 0,
                            "available_handover_options": [
                              "dropoff",
                              "free_pickup"
                            ],
                            "cost_rank": 2,
                            "courier_remarks": null,
                            "courier_service": {
                              "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                              "easyship_courier_service": true,
                              "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                              "logo": null,
                              "name": "Courier 1",
                              "umbrella_name": "DHL"
                            },
                            "currency": "USD",
                            "ddp_handling_fee": 0,
                            "delivery_time_rank": 4,
                            "description": "description",
                            "discount": null,
                            "easyship_rating": 2,
                            "estimated_import_duty": 0,
                            "estimated_import_tax": 65.96,
                            "fuel_surcharge": 10,
                            "full_description": "full description",
                            "import_duty_charge": 0,
                            "import_duty_details": null,
                            "import_tax_charge": 0,
                            "import_tax_non_chargeable": 0,
                            "incoterms": "DDU",
                            "insurance_fee": 0,
                            "is_above_duty_threshold": null,
                            "is_above_threshold": true,
                            "max_delivery_time": 39,
                            "min_delivery_time": 19,
                            "minimum_pickup_fee": 0,
                            "other_surcharges": {
                              "details": [
                                {
                                  "fee": 0,
                                  "name": "Peak Surcharge",
                                  "origin_fee": 0
                                }
                              ],
                              "total_fee": 0
                            },
                            "oversized_surcharge": 0,
                            "payment_recipient": "Easyship",
                            "provincial_sales_tax": 0,
                            "rates_in_origin_currency": {
                              "additional_services_surcharge": 0,
                              "currency": "HKD",
                              "ddp_handling_fee": 0,
                              "estimated_import_duty": 0,
                              "estimated_import_tax": 65.96,
                              "fuel_surcharge": 1400,
                              "import_duty_charge": 0,
                              "import_tax_charge": 0,
                              "import_tax_non_chargeable": 0,
                              "insurance_fee": 0,
                              "minimum_pickup_fee": 0,
                              "oversized_surcharge": 0,
                              "provincial_sales_tax": 0,
                              "remote_area_surcharge": 0,
                              "residential_discounted_fee": 0,
                              "residential_full_fee": 0,
                              "sales_tax": 0,
                              "shipment_charge": 140,
                              "shipment_charge_total": 1540,
                              "total_charge": 1540,
                              "warehouse_handling_fee": 0
                            },
                            "remote_area_surcharge": 0,
                            "remote_area_surcharges": null,
                            "residential_discounted_fee": 0,
                            "residential_full_fee": 0,
                            "sales_tax": 0,
                            "shipment_charge": 100,
                            "shipment_charge_total": 110,
                            "total_charge": 110,
                            "tracking_rating": 2,
                            "value_for_money_rank": 4,
                            "warehouse_handling_fee": 0
                          }
                        ],
                        "regulatory_identifiers": {
                          "eori": null,
                          "ioss": null,
                          "vat_number": null
                        },
                        "return": false,
                        "return_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "sender_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "set_as_residential": false,
                        "shipment_state": "created",
                        "shipping_documents": [],
                        "shipping_settings": {
                          "b13a_filing": null,
                          "label_customization_fields": []
                        },
                        "tracking_page_url": "http://api.easyship.com:9003/shipment-tracking/ESSG10006002",
                        "trackings": [],
                        "updated_at": "2022-02-22T12:21:00Z",
                        "warehouse_state": "none"
                      },
                      "meta": {
                        "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
                        "unavailable_couriers": []
                      }
                    },
                    "summary": "shipment with product_id successfully created"
                  },
                  "rates_with_duty_breakdown": {
                    "value": {
                      "shipment": {
                        "easyship_shipment_id": "ESSG10006002",
                        "buyer_regulatory_identifiers": {
                          "ein": null,
                          "ssn": null,
                          "vat_number": null
                        },
                        "consignee_tax_id": null,
                        "courier_service": {
                          "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                          "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                          "easyship_courier_service": true,
                          "name": "Courier 1",
                          "umbrella_name": "DHL"
                        },
                        "created_at": "2022-02-22T12:21:00Z",
                        "currency": "HKD",
                        "delivery_state": "not_created",
                        "destination_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+85230085678",
                          "country_alpha2": "HK",
                          "delivery_instructions": null,
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "eei_reference": null,
                        "incoterms": "DDU",
                        "insurance": {
                          "is_insured": false,
                          "insured_amount": 0,
                          "insured_currency": "HKD"
                        },
                        "label_generated_at": null,
                        "label_paid_at": null,
                        "label_state": "not_created",
                        "last_failure_http_response_messages": [],
                        "metadata": {},
                        "order_data": {
                          "buyer_notes": null,
                          "buyer_selected_courier_name": null,
                          "order_created_at": null,
                          "order_tag_list": [],
                          "platform_name": null,
                          "platform_order_number": null,
                          "seller_notes": null
                        },
                        "origin_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "parcels": [
                          {
                            "box": {
                              "id": null,
                              "name": null,
                              "outer_dimensions": {
                                "length": 3,
                                "width": 2,
                                "height": 2
                              },
                              "slug": null,
                              "type": "box",
                              "weight": 0
                            },
                            "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                            "items": [
                              {
                                "actual_weight": 10,
                                "category": null,
                                "contains_battery_pi966": true,
                                "contains_battery_pi967": true,
                                "contains_liquids": true,
                                "declared_currency": "USD",
                                "declared_customs_value": 20,
                                "description": "item",
                                "dimensions": {
                                  "length": 1,
                                  "width": 2,
                                  "height": 3
                                },
                                "hs_code": "12345600",
                                "id": "12663646-58c1-4607-8fe0-cae3e33c0001",
                                "origin_country_alpha2": "HK",
                                "origin_currency": "HKD",
                                "origin_customs_value": 140,
                                "quantity": 2,
                                "sku": "sku"
                              }
                            ],
                            "total_actual_weight": 1,
                            "tracking_number": null
                          }
                        ],
                        "pickup_state": "not_requested",
                        "rates": [
                          {
                            "additional_services_surcharge": 0,
                            "available_handover_options": [
                              "dropoff",
                              "free_pickup"
                            ],
                            "cost_rank": 2,
                            "courier_remarks": null,
                            "courier_service": {
                              "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                              "easyship_courier_service": true,
                              "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                              "logo": null,
                              "name": "Courier 1",
                              "umbrella_name": "DHL"
                            },
                            "currency": "USD",
                            "ddp_handling_fee": 0,
                            "delivery_time_rank": 4,
                            "description": "description",
                            "discount": null,
                            "easyship_rating": 2,
                            "estimated_import_duty": 0,
                            "estimated_import_tax": 65.96,
                            "fuel_surcharge": 10,
                            "full_description": "full description",
                            "import_duty_charge": 0,
                            "import_duty_details": [
                              {
                                "hs_code_provided": "42029100",
                                "hs_code_applied": "4202910010",
                                "subheading": false,
                                "duty_origin_country_id_provided": 234,
                                "duty_origin_country_id_applied": 234,
                                "duty_calculation_method": "CIF",
                                "line_item_shipment_value": 100,
                                "applied_rate_type": "general",
                                "additional_rates": [
                                  {
                                    "description": "Additional duty surcharge",
                                    "rate": 0.025,
                                    "amount": 2.5
                                  }
                                ],
                                "base_duty_rate": 0.05,
                                "base_duty_amount": 5,
                                "line_item_total_duty": 7.5
                              }
                            ],
                            "import_tax_charge": 0,
                            "import_tax_non_chargeable": 0,
                            "incoterms": "DDU",
                            "insurance_fee": 0,
                            "is_above_duty_threshold": true,
                            "is_above_threshold": true,
                            "max_delivery_time": 39,
                            "min_delivery_time": 19,
                            "minimum_pickup_fee": 0,
                            "other_surcharges": {
                              "details": [
                                {
                                  "fee": 0,
                                  "name": "Peak Surcharge",
                                  "origin_fee": 0
                                }
                              ],
                              "total_fee": 0
                            },
                            "oversized_surcharge": 0,
                            "payment_recipient": "Easyship",
                            "provincial_sales_tax": 0,
                            "rates_in_origin_currency": {
                              "additional_services_surcharge": 0,
                              "currency": "HKD",
                              "ddp_handling_fee": 0,
                              "estimated_import_duty": 0,
                              "estimated_import_tax": 65.96,
                              "fuel_surcharge": 1400,
                              "import_duty_charge": 0,
                              "import_tax_charge": 0,
                              "import_tax_non_chargeable": 0,
                              "insurance_fee": 0,
                              "minimum_pickup_fee": 0,
                              "oversized_surcharge": 0,
                              "provincial_sales_tax": 0,
                              "remote_area_surcharge": 0,
                              "residential_discounted_fee": 0,
                              "residential_full_fee": 0,
                              "sales_tax": 0,
                              "shipment_charge": 140,
                              "shipment_charge_total": 1540,
                              "total_charge": 1540,
                              "warehouse_handling_fee": 0
                            },
                            "remote_area_surcharge": 0,
                            "remote_area_surcharges": null,
                            "residential_discounted_fee": 0,
                            "residential_full_fee": 0,
                            "sales_tax": 0,
                            "shipment_charge": 100,
                            "shipment_charge_total": 110,
                            "total_charge": 110,
                            "tracking_rating": 2,
                            "value_for_money_rank": 4,
                            "warehouse_handling_fee": 0
                          }
                        ],
                        "regulatory_identifiers": {
                          "eori": null,
                          "ioss": null,
                          "vat_number": null
                        },
                        "return": false,
                        "return_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "sender_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "set_as_residential": false,
                        "shipment_state": "created",
                        "shipping_documents": [],
                        "shipping_settings": {
                          "b13a_filing": null,
                          "label_customization_fields": []
                        },
                        "tracking_page_url": "http://api.easyship.com:9003/shipment-tracking/ESSG10006002",
                        "trackings": [],
                        "updated_at": "2022-02-22T12:21:00Z",
                        "warehouse_state": "none"
                      },
                      "meta": {
                        "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
                        "unavailable_couriers": []
                      }
                    },
                    "summary": "shipment"
                  },
                  "insufficient_subscription_tier": {
                    "value": {
                      "shipment": {
                        "easyship_shipment_id": "ESSG10006002",
                        "buyer_regulatory_identifiers": {
                          "ein": null,
                          "ssn": null,
                          "vat_number": null
                        },
                        "consignee_tax_id": null,
                        "courier_service": {
                          "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                          "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                          "easyship_courier_service": true,
                          "name": "Courier 1",
                          "umbrella_name": "DHL"
                        },
                        "created_at": "2022-02-22T12:21:00Z",
                        "currency": "HKD",
                        "delivery_state": "not_created",
                        "destination_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+85230085678",
                          "country_alpha2": "HK",
                          "delivery_instructions": null,
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "eei_reference": null,
                        "incoterms": "DDU",
                        "insurance": {
                          "is_insured": false,
                          "insured_amount": 0,
                          "insured_currency": "HKD"
                        },
                        "label_generated_at": null,
                        "label_paid_at": null,
                        "label_state": "not_created",
                        "last_failure_http_response_messages": [],
                        "metadata": {},
                        "order_data": {
                          "buyer_notes": null,
                          "buyer_selected_courier_name": null,
                          "order_created_at": null,
                          "order_tag_list": [],
                          "platform_name": null,
                          "platform_order_number": null,
                          "seller_notes": null
                        },
                        "origin_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "parcels": [
                          {
                            "box": {
                              "id": null,
                              "name": null,
                              "outer_dimensions": {
                                "length": 3,
                                "width": 2,
                                "height": 2
                              },
                              "slug": null,
                              "type": "box",
                              "weight": 0
                            },
                            "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                            "items": [
                              {
                                "actual_weight": 10,
                                "category": null,
                                "contains_battery_pi966": true,
                                "contains_battery_pi967": true,
                                "contains_liquids": true,
                                "declared_currency": "USD",
                                "declared_customs_value": 20,
                                "description": "item",
                                "dimensions": {
                                  "length": 1,
                                  "width": 2,
                                  "height": 3
                                },
                                "hs_code": "12345600",
                                "id": "12663646-58c1-4607-8fe0-cae3e33c0001",
                                "origin_country_alpha2": "HK",
                                "origin_currency": "HKD",
                                "origin_customs_value": 140,
                                "quantity": 2,
                                "sku": "sku"
                              }
                            ],
                            "total_actual_weight": 1,
                            "tracking_number": null
                          }
                        ],
                        "pickup_state": "not_requested",
                        "rates": [
                          {
                            "additional_services_surcharge": 0,
                            "available_handover_options": [
                              "dropoff",
                              "free_pickup"
                            ],
                            "cost_rank": 2,
                            "courier_remarks": null,
                            "courier_service": {
                              "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                              "easyship_courier_service": true,
                              "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                              "logo": null,
                              "name": "Courier 1",
                              "umbrella_name": "DHL"
                            },
                            "currency": "USD",
                            "ddp_handling_fee": null,
                            "delivery_time_rank": 4,
                            "description": "",
                            "discount": null,
                            "easyship_rating": 2,
                            "estimated_import_duty": null,
                            "estimated_import_tax": null,
                            "fuel_surcharge": 10,
                            "full_description": "Courier 1 (19-39 working days)",
                            "import_duty_charge": null,
                            "import_duty_details": null,
                            "import_tax_charge": null,
                            "import_tax_non_chargeable": null,
                            "incoterms": "DDU",
                            "insurance_fee": 0,
                            "is_above_duty_threshold": null,
                            "is_above_threshold": true,
                            "max_delivery_time": 39,
                            "min_delivery_time": 19,
                            "minimum_pickup_fee": 0,
                            "other_surcharges": {
                              "details": [
                                {
                                  "fee": 0,
                                  "name": "Peak Surcharge",
                                  "origin_fee": 0
                                }
                              ],
                              "total_fee": 0
                            },
                            "oversized_surcharge": 0,
                            "payment_recipient": "Easyship",
                            "provincial_sales_tax": 0,
                            "rates_in_origin_currency": {
                              "additional_services_surcharge": 0,
                              "currency": "HKD",
                              "ddp_handling_fee": null,
                              "estimated_import_duty": null,
                              "estimated_import_tax": null,
                              "fuel_surcharge": 1400,
                              "import_duty_charge": null,
                              "import_tax_charge": null,
                              "import_tax_non_chargeable": null,
                              "insurance_fee": 0,
                              "minimum_pickup_fee": 0,
                              "oversized_surcharge": 0,
                              "provincial_sales_tax": 0,
                              "remote_area_surcharge": 0,
                              "residential_discounted_fee": 0,
                              "residential_full_fee": 0,
                              "sales_tax": 0,
                              "shipment_charge": 140,
                              "shipment_charge_total": 1540,
                              "total_charge": 1540,
                              "warehouse_handling_fee": 0
                            },
                            "remote_area_surcharge": 0,
                            "remote_area_surcharges": null,
                            "residential_discounted_fee": 0,
                            "residential_full_fee": 0,
                            "sales_tax": 0,
                            "shipment_charge": 100,
                            "shipment_charge_total": 110,
                            "total_charge": 110,
                            "tracking_rating": 2,
                            "value_for_money_rank": 4,
                            "warehouse_handling_fee": 0
                          }
                        ],
                        "regulatory_identifiers": {
                          "eori": null,
                          "ioss": null,
                          "vat_number": null
                        },
                        "return": false,
                        "return_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "sender_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "set_as_residential": false,
                        "shipment_state": "created",
                        "shipping_documents": [],
                        "shipping_settings": {
                          "b13a_filing": null,
                          "label_customization_fields": []
                        },
                        "tracking_page_url": "http://api.easyship.com:9003/shipment-tracking/ESSG10006002",
                        "trackings": [],
                        "updated_at": "2022-02-22T12:21:00Z",
                        "warehouse_state": "none"
                      },
                      "meta": {
                        "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
                        "unavailable_couriers": []
                      }
                    },
                    "summary": "shipment successfully created but taxes and duties excluded due to insufficient subscription"
                  },
                  "with_zpl_printing_options": {
                    "value": {
                      "shipment": {
                        "easyship_shipment_id": "ESSG10006002",
                        "buyer_regulatory_identifiers": {
                          "ein": null,
                          "ssn": null,
                          "vat_number": null
                        },
                        "consignee_tax_id": null,
                        "courier_service": {
                          "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                          "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                          "easyship_courier_service": true,
                          "name": "Fedex Ground",
                          "umbrella_name": "FedEx"
                        },
                        "created_at": "2022-02-22T12:21:00Z",
                        "currency": "USD",
                        "delivery_state": "not_created",
                        "destination_address": {
                          "city": "Belmont",
                          "company_name": "Test Plc.",
                          "contact_email": "us@testusemail.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "9172756975",
                          "country_alpha2": "US",
                          "delivery_instructions": null,
                          "line_1": "73 CHESTER RD",
                          "line_2": null,
                          "line_3": "Unit 1000",
                          "postal_code": "02478",
                          "state": "Massachusetts"
                        },
                        "eei_reference": null,
                        "incoterms": "DDU",
                        "insurance": {
                          "is_insured": false,
                          "insured_amount": 0,
                          "insured_currency": "USD"
                        },
                        "label_generated_at": "2022-02-22T12:21:00Z",
                        "label_paid_at": "2022-02-22T12:21:00Z",
                        "label_state": "printed",
                        "last_failure_http_response_messages": [],
                        "metadata": {},
                        "order_data": {
                          "buyer_notes": null,
                          "buyer_selected_courier_name": null,
                          "order_created_at": null,
                          "order_tag_list": [],
                          "platform_name": null,
                          "platform_order_number": null,
                          "seller_notes": null
                        },
                        "origin_address": {
                          "city": "Belmont",
                          "company_name": "Test Plc.",
                          "contact_email": "us@testusemail.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "917-275-6975",
                          "country_alpha2": "US",
                          "line_1": "73 CHESTER RD",
                          "line_2": null,
                          "line_3": "Unit 1000",
                          "postal_code": "02478",
                          "state": "Massachusetts"
                        },
                        "parcels": [
                          {
                            "box": {
                              "id": null,
                              "name": null,
                              "outer_dimensions": {
                                "length": 3,
                                "width": 2,
                                "height": 2
                              },
                              "slug": null,
                              "type": "box",
                              "weight": 0
                            },
                            "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                            "items": [
                              {
                                "actual_weight": 10,
                                "category": null,
                                "contains_battery_pi966": null,
                                "contains_battery_pi967": null,
                                "contains_liquids": null,
                                "declared_currency": "USD",
                                "declared_customs_value": 20,
                                "description": "item",
                                "dimensions": {
                                  "length": 1,
                                  "width": 2,
                                  "height": 3
                                },
                                "hs_code": "12345600",
                                "id": "12663646-58c1-4607-8fe0-cae3e33c0001",
                                "origin_country_alpha2": "US",
                                "origin_currency": "USD",
                                "origin_customs_value": 20,
                                "quantity": 2,
                                "sku": "sku"
                              }
                            ],
                            "total_actual_weight": 1,
                            "tracking_number": null
                          }
                        ],
                        "pickup_state": "not_requested",
                        "rates": [
                          {
                            "additional_services_surcharge": 0,
                            "available_handover_options": [
                              "free_pickup"
                            ],
                            "cost_rank": 2,
                            "courier_remarks": null,
                            "courier_service": {
                              "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                              "easyship_courier_service": true,
                              "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                              "logo": null,
                              "name": "Fedex Ground",
                              "umbrella_name": "FedEx"
                            },
                            "currency": "USD",
                            "ddp_handling_fee": 0,
                            "delivery_time_rank": 4,
                            "description": "description",
                            "discount": null,
                            "easyship_rating": 2,
                            "estimated_import_duty": 0,
                            "estimated_import_tax": 65.96,
                            "fuel_surcharge": 20,
                            "full_description": "full description",
                            "import_duty_charge": 0,
                            "import_duty_details": null,
                            "import_tax_charge": 0,
                            "import_tax_non_chargeable": 0,
                            "incoterms": "DDU",
                            "insurance_fee": 0,
                            "is_above_duty_threshold": null,
                            "is_above_threshold": true,
                            "max_delivery_time": 39,
                            "min_delivery_time": 19,
                            "minimum_pickup_fee": 0,
                            "other_surcharges": {
                              "details": [
                                {
                                  "fee": 0,
                                  "name": "Peak Surcharge",
                                  "origin_fee": 0
                                }
                              ],
                              "total_fee": 0
                            },
                            "oversized_surcharge": 0,
                            "payment_recipient": "Easyship",
                            "provincial_sales_tax": 0,
                            "rates_in_origin_currency": {
                              "additional_services_surcharge": 0,
                              "currency": "HKD",
                              "ddp_handling_fee": 0,
                              "estimated_import_duty": 0,
                              "estimated_import_tax": 65.96,
                              "fuel_surcharge": 1400,
                              "import_duty_charge": 0,
                              "import_tax_charge": 0,
                              "import_tax_non_chargeable": 0,
                              "insurance_fee": 0,
                              "minimum_pickup_fee": 0,
                              "oversized_surcharge": 0,
                              "provincial_sales_tax": 0,
                              "remote_area_surcharge": 0,
                              "residential_discounted_fee": 0,
                              "residential_full_fee": 0,
                              "sales_tax": 0,
                              "shipment_charge": 140,
                              "shipment_charge_total": 1540,
                              "total_charge": 1540,
                              "warehouse_handling_fee": 0
                            },
                            "remote_area_surcharge": 0,
                            "remote_area_surcharges": null,
                            "residential_discounted_fee": 0,
                            "residential_full_fee": 0,
                            "sales_tax": 0,
                            "shipment_charge": 100,
                            "shipment_charge_total": 120,
                            "total_charge": 120,
                            "tracking_rating": 2,
                            "value_for_money_rank": 4,
                            "warehouse_handling_fee": 0
                          }
                        ],
                        "regulatory_identifiers": {
                          "eori": null,
                          "ioss": null,
                          "vat_number": null
                        },
                        "return": false,
                        "return_address": {
                          "city": "Belmont",
                          "company_name": "Test Plc.",
                          "contact_email": "us@testusemail.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "917-275-6975",
                          "country_alpha2": "US",
                          "line_1": "73 CHESTER RD",
                          "line_2": null,
                          "line_3": "Unit 1000",
                          "postal_code": "02478",
                          "state": "Massachusetts"
                        },
                        "sender_address": {
                          "city": "Belmont",
                          "company_name": "Test Plc.",
                          "contact_email": "us@testusemail.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "917-275-6975",
                          "country_alpha2": "US",
                          "line_1": "73 CHESTER RD",
                          "line_2": null,
                          "line_3": "Unit 1000",
                          "postal_code": "02478",
                          "state": "Massachusetts"
                        },
                        "set_as_residential": false,
                        "shipment_state": "created",
                        "shipping_documents": [
                          {
                            "base64_encoded_strings": [
                              "XlhBXkNGLDAsMCwwXlBSMTJeTUQzMF5QVzgwMF5QT0leQ0kxM15MSDAsMjAKXkZPMTIsMTI0XkdCNzU1LDIsMl5GUwpeRk8xMiwzOTBeR0I3NzcsMiwyXkZTCl5GTzMyLDNeQWROLDAsMF5GV05eRkheRkRGUk9NOl5GUwpeRk8zMiwxOV5BZE4sMCwwXkZXTl5GSF5GREZvbyBCYXJeRlMKXkZPMzIsMzdeQWROLDAsMF5GV05eRkheRkRUZXN0IFBsYy5eRlMKXkZPMzIsNTVeQWROLDAsMF5GV05eRkheRkQ3MyBDSEVTVEVSIFJEXkZTCl5GTzMyLDczXkFkTiwwLDBeRldOXkZIXkZEXkZTCl5GTzMyLDEwOV5BZE4sMCwwXkZXTl5GSF5GRFVTIF5GUwpeRk8yMjQsM15BZE4sMCwwXkZXTl5GSF5GRCg5MTcpIDI3NS02OTc1XkZTCl5GTzI4LDc0Ml5BME4sMjQsMjReRldOXkZIXkZEVFJLI15GUwpeRk8yOCw4MDBeQTBOLDI3LDMyXkZXTl5GSF5GRF5GUwpeRk8xMzYsNzEyXkEwTiwyNywzNl5GV05eRkheRkReRlMKXkZPMzIsOTFeQWROLDAsMF5GV05eRkheRkRCZWxtb250IE1BIDAyNDc4XkZTCl5GTzQ3OCwzXkFkTiwwLDBeRldOXkZIXkZEU0hJUCBEQVRFOiAzMEFQUjI1XkZTCl5GTzQ3OCwxOV5BZE4sMCwwXkZXTl5GSF5GREFDVFdHVDogMi4yMCBMQl5GUwpeRk80NzgsMzdeQWROLDAsMF5GV05eRkheRkRDQUQ6IDAwMDAwMDAvRkFQSTIyMDheRlMKXkZPNDc4LDkxXkFkTiwwLDBeRldOXkZIXkZEQklMTCBTRU5ERVJeRlMKXkZPMzksMTM2XkEwTiwzOSwzOV5GV05eRkheRkRGb28gQmFyXkZTCl5GTzM5LDE3OF5BME4sMzksMzleRldOXkZIXkZEVGVzdCBQbGMuXkZTCl5GTzM5LDIyMF5BME4sMzksMzleRldOXkZIXkZENzMgQ0hFU1RFUiBSRF5GUwpeRk8zOSwyNjJeQTBOLDM5LDM5XkZXTl5GSF5GRCoqVEVTVCBMQUJFTCAtIERPIE5PVCBTSElQKipeRlMKXkZPMzksMzQ3XkFkTiwwLDBeRldOXkZIXkZEKDkxNykgMjc1LTY5NzVeRlMKXkZPMzksMzA0XkEwTiw0Myw0MF5GV05eRkheRkRCZWxtb250IE1BIDAyNDc4XkZTCl5GTzcxOSwzMDReQTBOLDQzLDQwXkZXTl5GSF5GRChVUyleRlMKXkZPNzA5LDQ0MF5BME4sMTksMjZeRldOXkZIXkZER3JvdW5kXkZTCl5GTzY4OSw0ODBeQTBOLDEyOCwxMzdeRldOXkZIXkZER15GUwpeRk82NzcsNDYyXkdCMTA0LDEwLDEwXkZTCl5GTzY3Nyw0NzJeR0IxMCwxMTIsMTBeRlMKXkZPNzcxLDQ3Ml5HQjEwLDExMiwxMF5GUwpeRk82NzcsNTg0XkdCMTA0LDEwLDEwXkZTCl5GTzQ2NCwtLV5HQjIsMTI2LDJeRlMKXkZPNjU0LDQwMl5BME4sNDMsNTheRldOXkZIXkZERmVkRXheRlMKXkZPNzA5LDQ0MF5BME4sMTksMjZeRldOXkZIXkZER3JvdW5kXkZTCl5GTzY4OSw0ODBeQTBOLDEyOCwxMzdeRldOXkZIXkZER15GUwpeRk83OTEsNDkzXkEwTiwxMywxOF5GV0JeRkheRkRKMjUyMDI1MDQwODAxdXZeRlMKXkZPOSwxMzZeQTBOLDIxLDIxXkZXTl5GSF5GRFRPXkZTCl5GTzIxLDQxMl5CWTIsMl5CN04sMTAsNSwxNF5GSF5GV05eRkheRkRbKT5fMUUwMV8xRDAyMDI0NzhfMUQ4NDBfMUQwMTlfMUQ3OTQ4NzA5NTQ4NTJfMURGREVHXzFENDkwMTc2MV8xRDEyMF8xRF8xRDEvMV8xRDIuMjBMQl8xRE5fMUQ3MyBDSEVTVEVSIFJEXzFEQmVsbW9udF8xRE1BXzFERm9vIEJhcl8xRTA2XzFEMTBaR0QwMDlfMUQxMVpUZXN0IFBsYy5fMUQxMlo5MTcyNzU2OTc1XzFEMjBaXzFDXzFEMzFaOTYyMjAwMTkwMDAwNDkwMTc2MTQwMDc5NDg3MDk1NDg1Ml8xRDM0WjAxXzFEOUtFU1NHMTAwMDYwMDJfMURfMUVfMDReRlMKXkZPMjgsODM3XkEwTiwxMDcsOTZeRldOXkZIXkZEXkZTCl5GTzEyLDY4MV5HQjc3NywyLDJeRlMKXkZPNDk0LDg4NV5BME4sNDMsNDNeRldOXkZIXkZEXkZTCl5GTzc4OCwyOF5BYk4sMTEsN15GV0JeRkheRkQ1OEdKMi80QUNDLzU5RjJeRlMKXkZPOTUsNzQ2XkEwTiw1Myw0MF5GV05eRkheRkQwMDAwIDAwMDAgMDAwMF5GUwpeRk80MDksNjk1XkEwTiw1MSwzOF5GV05eRkheRkIzOTAsLCxSLF5GRCAgICAgICAgICAgICAgICAgICBeRlMKXkZPNDA0LDc0N15BME4sNTEsMzheRldOXkZIXkZCNDAwLCwsUixeRkQgICAgICAgICAgICAgICAgICAgXkZTCl5GTzQxMyw3OTleQTBOLDQwLDQwXkZXTl5GSF5GQjM4NiwsLFIsXkZEICAgICAgICAgICAgICAgIF5GUwpeRk80OTUsODQxXkEwTiw0NCw0NF5GV05eRkheRkIyOTgsLCxSLF5GRCAgICAgMDI0NzheRlMKXkZPNTc0LDkwMV5BME4sMjQsMjReRldOXkZIXkZCMTIwLCwsUixeRkQgICAgICBeRlMKXkZPNjk1LDg4NV5BME4sNDMsNDNeRldOXkZIXkZCMTAwLCwsUixeRkQgICBeRlMKXkZPMzksOTI3XkEwTiwyNywzNl5GV05eRkheRkQwMDAwIDAwMDAgMCAoMDAwIDAwMCAwMDAwKSAwIDAwIDAwMDAgMDAwMCAwMDAwXkZTCl5GTzc1LDk2OF5CWTMsMl5CQ04sMjAwLE4sTixOLE5eRldOXkZEPjs5NjIyMDAxOTAwMDA0OTAxNzYxNDAwMDAwMDAwMDAwMDAwXkZTCl5GTzEzNSwxMDI4XkEwTiwxMjgsMTM3XkZXTl5GSF5GRFNBTVBMRV5GUwpeRk80NzgsNTVeQWROLDAsMF5GV05eRkheRkRESU1NRUQ6IDEgWCAxIFggMSBJTl5GUwpeRk8zMjksMzQ5XkFiTiwxMSw3XkZXTl5GSF5GRFJFRjogRVNTRzEwMDA2MDAyXkZTCl5GTzM5LDM2M15BYk4sMTEsN15GV05eRkheRkRJTlY6IF5GUwpeRk8zOSwzNzdeQWJOLDExLDdeRldOXkZIXkZEUE86IF5GUwpeRk80MjksMzc3XkFiTiwxMSw3XkZXTl5GSF5GRERFUFQ6IF5GUwpeUFExCl5YWgo="
                            ],
                            "category": "label",
                            "format": "zpl",
                            "page_size": "4x6",
                            "required": true,
                            "url": null
                          },
                          {
                            "base64_encoded_strings": [],
                            "category": "packing_slip",
                            "format": "zpl",
                            "page_size": "4x6",
                            "required": true,
                            "url": null
                          }
                        ],
                        "shipping_settings": {
                          "b13a_filing": null,
                          "label_customization_fields": []
                        },
                        "tracking_page_url": "http://api.easyship.com:9003/shipment-tracking/ESSG10006002",
                        "trackings": [
                          {
                            "alternate_tracking_number": null,
                            "handler": "aramex",
                            "leg_number": 1,
                            "local_tracking_number": null,
                            "tracking_number": "794870954852",
                            "tracking_state": "active"
                          }
                        ],
                        "updated_at": "2022-02-22T12:21:00Z",
                        "warehouse_state": "none"
                      },
                      "meta": {
                        "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
                        "unavailable_couriers": []
                      }
                    },
                    "summary": "shipment successfully created with zpl format printing options"
                  },
                  "with_qr_code": {
                    "value": {
                      "shipment": {
                        "easyship_shipment_id": "ESSG10006002",
                        "buyer_regulatory_identifiers": {
                          "ein": null,
                          "ssn": null,
                          "vat_number": null
                        },
                        "consignee_tax_id": null,
                        "courier_service": {
                          "id": "01563646-58c1-4607-8fe0-cae3e33c0004",
                          "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                          "easyship_courier_service": true,
                          "name": "USPS - Priority Mail",
                          "umbrella_name": "USPS"
                        },
                        "created_at": "2022-02-22T12:21:00Z",
                        "currency": "USD",
                        "delivery_state": "not_created",
                        "destination_address": {
                          "city": "Belmont",
                          "company_name": "Test Plc.",
                          "contact_email": "us@testusemail.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "9172756975",
                          "country_alpha2": "US",
                          "delivery_instructions": null,
                          "line_1": "73 CHESTER RD",
                          "line_2": null,
                          "postal_code": "02478",
                          "state": "Massachusetts"
                        },
                        "eei_reference": null,
                        "incoterms": "DDU",
                        "insurance": {
                          "is_insured": false,
                          "insured_amount": 0,
                          "insured_currency": "USD"
                        },
                        "label_generated_at": "2022-02-22T12:21:00Z",
                        "label_paid_at": "2022-02-22T12:21:00Z",
                        "label_state": "generated",
                        "last_failure_http_response_messages": [],
                        "metadata": {},
                        "order_data": {
                          "buyer_notes": null,
                          "buyer_selected_courier_name": null,
                          "order_created_at": null,
                          "order_tag_list": [],
                          "platform_name": null,
                          "platform_order_number": null,
                          "seller_notes": null
                        },
                        "origin_address": {
                          "city": "Belmont",
                          "company_name": "Test Plc.",
                          "contact_email": "us@testusemail.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "917-275-6975",
                          "country_alpha2": "US",
                          "line_1": "73 CHESTER RD",
                          "line_2": null,
                          "postal_code": "02478",
                          "state": "Massachusetts"
                        },
                        "parcels": [
                          {
                            "box": {
                              "id": null,
                              "name": null,
                              "outer_dimensions": {
                                "length": 3,
                                "width": 2,
                                "height": 2
                              },
                              "slug": null,
                              "type": "box",
                              "weight": 0
                            },
                            "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                            "items": [
                              {
                                "actual_weight": 10,
                                "category": "Fashion",
                                "contains_battery_pi966": false,
                                "contains_battery_pi967": false,
                                "contains_liquids": false,
                                "declared_currency": "USD",
                                "declared_customs_value": 20,
                                "description": "item",
                                "dimensions": {
                                  "length": 1,
                                  "width": 2,
                                  "height": 3
                                },
                                "hs_code": null,
                                "id": "12663646-58c1-4607-8fe0-cae3e33c0001",
                                "origin_country_alpha2": "US",
                                "origin_currency": "USD",
                                "origin_customs_value": 20,
                                "quantity": 2,
                                "sku": "sku"
                              }
                            ],
                            "total_actual_weight": 1,
                            "tracking_number": null
                          }
                        ],
                        "pickup_state": "not_requested",
                        "rates": [
                          {
                            "additional_services_surcharge": 0,
                            "available_handover_options": [],
                            "cost_rank": 2,
                            "courier_remarks": null,
                            "courier_service": {
                              "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                              "easyship_courier_service": true,
                              "id": "01563646-58c1-4607-8fe0-cae3e33c0004",
                              "logo": null,
                              "name": "USPS - Priority Mail",
                              "umbrella_name": "USPS"
                            },
                            "currency": "USD",
                            "ddp_handling_fee": 0,
                            "delivery_time_rank": 4,
                            "description": "description",
                            "discount": null,
                            "easyship_rating": 2,
                            "estimated_import_duty": 0,
                            "estimated_import_tax": 65.96,
                            "fuel_surcharge": 20,
                            "full_description": "full description",
                            "import_duty_charge": 0,
                            "import_duty_details": null,
                            "import_tax_charge": 0,
                            "import_tax_non_chargeable": 0,
                            "incoterms": "DDU",
                            "insurance_fee": 0,
                            "is_above_duty_threshold": null,
                            "is_above_threshold": true,
                            "max_delivery_time": 39,
                            "min_delivery_time": 19,
                            "minimum_pickup_fee": 0,
                            "other_surcharges": {
                              "details": [
                                {
                                  "fee": 0,
                                  "name": "Peak Surcharge",
                                  "origin_fee": 0
                                }
                              ],
                              "total_fee": 0
                            },
                            "oversized_surcharge": 0,
                            "payment_recipient": "Easyship",
                            "provincial_sales_tax": 0,
                            "rates_in_origin_currency": {
                              "additional_services_surcharge": 0,
                              "currency": "HKD",
                              "ddp_handling_fee": 0,
                              "estimated_import_duty": 0,
                              "estimated_import_tax": 65.96,
                              "fuel_surcharge": 1400,
                              "import_duty_charge": 0,
                              "import_tax_charge": 0,
                              "import_tax_non_chargeable": 0,
                              "insurance_fee": 0,
                              "minimum_pickup_fee": 0,
                              "oversized_surcharge": 0,
                              "provincial_sales_tax": 0,
                              "remote_area_surcharge": 0,
                              "residential_discounted_fee": 0,
                              "residential_full_fee": 0,
                              "sales_tax": 0,
                              "shipment_charge": 140,
                              "shipment_charge_total": 1540,
                              "total_charge": 1540,
                              "warehouse_handling_fee": 0
                            },
                            "remote_area_surcharge": 0,
                            "remote_area_surcharges": null,
                            "residential_discounted_fee": 0,
                            "residential_full_fee": 0,
                            "sales_tax": 0,
                            "shipment_charge": 100,
                            "shipment_charge_total": 120,
                            "total_charge": 120,
                            "tracking_rating": 2,
                            "value_for_money_rank": 4,
                            "warehouse_handling_fee": 0
                          }
                        ],
                        "regulatory_identifiers": {
                          "eori": null,
                          "ioss": null,
                          "vat_number": null
                        },
                        "return": true,
                        "return_address": {
                          "city": "Belmont",
                          "company_name": "Test Plc.",
                          "contact_email": "us@testusemail.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "917-275-6975",
                          "country_alpha2": "US",
                          "line_1": "73 CHESTER RD",
                          "line_2": null,
                          "postal_code": "02478",
                          "state": "Massachusetts"
                        },
                        "sender_address": {
                          "city": "Belmont",
                          "company_name": "Test Plc.",
                          "contact_email": "us@testusemail.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "917-275-6975",
                          "country_alpha2": "US",
                          "line_1": "73 CHESTER RD",
                          "line_2": null,
                          "postal_code": "02478",
                          "state": "Massachusetts"
                        },
                        "set_as_residential": false,
                        "shipment_state": "created",
                        "shipping_documents": [
                          {
                            "base64_encoded_strings": [],
                            "category": "label",
                            "format": "url",
                            "page_size": "4x6",
                            "required": true,
                            "url": "https://api.easyship.com/shipment/v1/shipments/01563646-58c1-4607-8fe0-cae3e33c0005/shipping_documents/label?page_size=4x6"
                          },
                          {
                            "base64_encoded_strings": [],
                            "category": "qr_code",
                            "format": "url",
                            "page_size": "4x6",
                            "required": true,
                            "url": "https://api.easyship.com/shipment/v1/shipments/01563646-58c1-4607-8fe0-cae3e33c0005/shipping_documents/qr_code?page_size=4x6"
                          }
                        ],
                        "shipping_settings": {
                          "b13a_filing": null,
                          "label_customization_fields": []
                        },
                        "tracking_page_url": "http://api.easyship.com:9003/shipment-tracking/ESSG10006002",
                        "trackings": [
                          {
                            "alternate_tracking_number": null,
                            "handler": "aramex",
                            "leg_number": 1,
                            "local_tracking_number": null,
                            "tracking_number": "9301989864200000474727",
                            "tracking_state": "active"
                          }
                        ],
                        "updated_at": "2022-02-22T12:21:00Z",
                        "warehouse_state": "none"
                      },
                      "meta": {
                        "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
                        "unavailable_couriers": []
                      }
                    },
                    "summary": "return shipment successfully created with QR code and label documents",
                    "description": "Demonstrates a return shipment with `qr_code: \"qr_code\"` and `buy_label: true` returning both the QR code and label in `shipping_documents`.\n\nUses the USPS direct integration — see `shipping_settings.additional_services.qr_code` in the request schema."
                  },
                  "shipment_successfully_created": {
                    "value": {
                      "shipment": {
                        "easyship_shipment_id": "ESSG10006002",
                        "buyer_regulatory_identifiers": {
                          "ein": "12-3456789",
                          "ssn": "123-45-6789",
                          "vat_number": "EU1234567890"
                        },
                        "consignee_tax_id": null,
                        "courier_service": {
                          "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                          "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                          "easyship_courier_service": true,
                          "name": "Courier 1",
                          "umbrella_name": "DHL"
                        },
                        "created_at": "2022-02-22T12:21:00Z",
                        "currency": "HKD",
                        "delivery_state": "not_created",
                        "destination_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+85230085678",
                          "country_alpha2": "HK",
                          "delivery_instructions": null,
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "eei_reference": null,
                        "incoterms": "DDU",
                        "insurance": {
                          "is_insured": false,
                          "insured_amount": 0,
                          "insured_currency": "HKD"
                        },
                        "label_generated_at": null,
                        "label_paid_at": null,
                        "label_state": "not_created",
                        "last_failure_http_response_messages": [],
                        "metadata": {},
                        "order_data": {
                          "buyer_notes": null,
                          "buyer_selected_courier_name": "test_courier",
                          "order_created_at": "2024-01-31T18:00:00Z",
                          "order_tag_list": [],
                          "platform_name": "test plat_form",
                          "platform_order_number": null,
                          "seller_notes": null
                        },
                        "origin_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "parcels": [
                          {
                            "box": {
                              "id": null,
                              "name": null,
                              "outer_dimensions": {
                                "length": 3,
                                "width": 2,
                                "height": 2
                              },
                              "slug": null,
                              "type": "box",
                              "weight": 0
                            },
                            "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                            "items": [
                              {
                                "actual_weight": 10,
                                "category": null,
                                "contains_battery_pi966": true,
                                "contains_battery_pi967": true,
                                "contains_liquids": true,
                                "declared_currency": "USD",
                                "declared_customs_value": 20,
                                "description": "item",
                                "dimensions": {
                                  "length": 1,
                                  "width": 2,
                                  "height": 3
                                },
                                "hs_code": "12345600",
                                "id": "12663646-58c1-4607-8fe0-cae3e33c0001",
                                "origin_country_alpha2": "HK",
                                "origin_currency": "HKD",
                                "origin_customs_value": 140,
                                "quantity": 2,
                                "sku": "sku"
                              }
                            ],
                            "total_actual_weight": 1,
                            "tracking_number": null
                          }
                        ],
                        "pickup_state": "not_requested",
                        "rates": [
                          {
                            "additional_services_surcharge": 0,
                            "available_handover_options": [
                              "dropoff",
                              "free_pickup"
                            ],
                            "cost_rank": 2,
                            "courier_remarks": null,
                            "courier_service": {
                              "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                              "easyship_courier_service": true,
                              "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                              "logo": null,
                              "name": "Courier 1",
                              "umbrella_name": "DHL"
                            },
                            "currency": "USD",
                            "ddp_handling_fee": 0,
                            "delivery_time_rank": 4,
                            "description": "description",
                            "discount": null,
                            "easyship_rating": 2,
                            "estimated_import_duty": 0,
                            "estimated_import_tax": 65.96,
                            "fuel_surcharge": 10,
                            "full_description": "full description",
                            "import_duty_charge": 0,
                            "import_duty_details": null,
                            "import_tax_charge": 0,
                            "import_tax_non_chargeable": 0,
                            "incoterms": "DDU",
                            "insurance_fee": 0,
                            "is_above_duty_threshold": null,
                            "is_above_threshold": true,
                            "max_delivery_time": 39,
                            "min_delivery_time": 19,
                            "minimum_pickup_fee": 0,
                            "other_surcharges": {
                              "details": [
                                {
                                  "fee": 0,
                                  "name": "Peak Surcharge",
                                  "origin_fee": 0
                                }
                              ],
                              "total_fee": 0
                            },
                            "oversized_surcharge": 0,
                            "payment_recipient": "Easyship",
                            "provincial_sales_tax": 0,
                            "rates_in_origin_currency": {
                              "additional_services_surcharge": 0,
                              "currency": "HKD",
                              "ddp_handling_fee": 0,
                              "estimated_import_duty": 0,
                              "estimated_import_tax": 65.96,
                              "fuel_surcharge": 1400,
                              "import_duty_charge": 0,
                              "import_tax_charge": 0,
                              "import_tax_non_chargeable": 0,
                              "insurance_fee": 0,
                              "minimum_pickup_fee": 0,
                              "oversized_surcharge": 0,
                              "provincial_sales_tax": 0,
                              "remote_area_surcharge": 0,
                              "residential_discounted_fee": 0,
                              "residential_full_fee": 0,
                              "sales_tax": 0,
                              "shipment_charge": 140,
                              "shipment_charge_total": 1540,
                              "total_charge": 1540,
                              "warehouse_handling_fee": 0
                            },
                            "remote_area_surcharge": 0,
                            "remote_area_surcharges": null,
                            "residential_discounted_fee": 0,
                            "residential_full_fee": 0,
                            "sales_tax": 0,
                            "shipment_charge": 100,
                            "shipment_charge_total": 110,
                            "total_charge": 110,
                            "tracking_rating": 2,
                            "value_for_money_rank": 4,
                            "warehouse_handling_fee": 0
                          }
                        ],
                        "regulatory_identifiers": {
                          "eori": "DE 123456789 12345",
                          "ioss": "IM1234567890",
                          "vat_number": "EU1234567890"
                        },
                        "return": false,
                        "return_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "sender_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "set_as_residential": false,
                        "shipment_state": "created",
                        "shipping_documents": [],
                        "shipping_settings": {
                          "b13a_filing": null,
                          "label_customization_fields": []
                        },
                        "tracking_page_url": "http://api.easyship.com:9003/shipment-tracking/ESSG10006002",
                        "trackings": [],
                        "updated_at": "2022-02-22T12:21:00Z",
                        "warehouse_state": "none"
                      },
                      "meta": {
                        "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
                        "unavailable_couriers": []
                      }
                    },
                    "summary": "shipment successfully created"
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/shipment_single"
                }
              }
            }
          },
          "202": {
            "description": "shipment partially created without available rates",
            "content": {
              "application/json": {
                "examples": {
                  "label_failed": {
                    "value": {
                      "shipment": {
                        "easyship_shipment_id": "ESSG10006002",
                        "buyer_regulatory_identifiers": {
                          "ein": null,
                          "ssn": null,
                          "vat_number": null
                        },
                        "consignee_tax_id": null,
                        "courier_service": {
                          "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                          "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                          "easyship_courier_service": true,
                          "name": "Courier 1",
                          "umbrella_name": "DHL"
                        },
                        "created_at": "2022-02-22T12:21:00Z",
                        "currency": "HKD",
                        "delivery_state": "not_created",
                        "destination_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+85230085678",
                          "country_alpha2": "HK",
                          "delivery_instructions": null,
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "eei_reference": null,
                        "incoterms": "DDU",
                        "insurance": {
                          "is_insured": false,
                          "insured_amount": 0,
                          "insured_currency": "HKD"
                        },
                        "label_generated_at": null,
                        "label_paid_at": "2022-02-22T12:21:00Z",
                        "label_state": "failed",
                        "last_failure_http_response_messages": [],
                        "metadata": {},
                        "order_data": {
                          "buyer_notes": null,
                          "buyer_selected_courier_name": null,
                          "order_created_at": null,
                          "order_tag_list": [],
                          "platform_name": null,
                          "platform_order_number": null,
                          "seller_notes": null
                        },
                        "origin_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "parcels": [
                          {
                            "box": {
                              "id": null,
                              "name": null,
                              "outer_dimensions": {
                                "length": 3,
                                "width": 2,
                                "height": 2
                              },
                              "slug": null,
                              "type": "box",
                              "weight": 0
                            },
                            "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                            "items": [
                              {
                                "actual_weight": 10,
                                "category": null,
                                "contains_battery_pi966": true,
                                "contains_battery_pi967": true,
                                "contains_liquids": true,
                                "declared_currency": "USD",
                                "declared_customs_value": 20,
                                "description": "item",
                                "dimensions": {
                                  "length": 1,
                                  "width": 2,
                                  "height": 3
                                },
                                "hs_code": "12345600",
                                "id": "12663646-58c1-4607-8fe0-cae3e33c0001",
                                "origin_country_alpha2": "HK",
                                "origin_currency": "HKD",
                                "origin_customs_value": 140,
                                "quantity": 2,
                                "sku": "sku"
                              }
                            ],
                            "total_actual_weight": 1,
                            "tracking_number": null
                          }
                        ],
                        "pickup_state": "not_requested",
                        "rates": [
                          {
                            "additional_services_surcharge": 0,
                            "available_handover_options": [
                              "dropoff",
                              "free_pickup"
                            ],
                            "cost_rank": 2,
                            "courier_remarks": null,
                            "courier_service": {
                              "courier_id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                              "easyship_courier_service": true,
                              "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                              "logo": null,
                              "name": "Courier 1",
                              "umbrella_name": "DHL"
                            },
                            "currency": "USD",
                            "ddp_handling_fee": 0,
                            "delivery_time_rank": 4,
                            "description": "description",
                            "discount": null,
                            "easyship_rating": 2,
                            "estimated_import_duty": 0,
                            "estimated_import_tax": 65.96,
                            "fuel_surcharge": 10,
                            "full_description": "full description",
                            "import_duty_charge": 0,
                            "import_duty_details": null,
                            "import_tax_charge": 0,
                            "import_tax_non_chargeable": 0,
                            "incoterms": "DDU",
                            "insurance_fee": 0,
                            "is_above_duty_threshold": null,
                            "is_above_threshold": true,
                            "max_delivery_time": 39,
                            "min_delivery_time": 19,
                            "minimum_pickup_fee": 0,
                            "other_surcharges": {
                              "details": [
                                {
                                  "fee": 0,
                                  "name": "Peak Surcharge",
                                  "origin_fee": 0
                                }
                              ],
                              "total_fee": 0
                            },
                            "oversized_surcharge": 0,
                            "payment_recipient": "Easyship",
                            "provincial_sales_tax": 0,
                            "rates_in_origin_currency": {
                              "additional_services_surcharge": 0,
                              "currency": "HKD",
                              "ddp_handling_fee": 0,
                              "estimated_import_duty": 0,
                              "estimated_import_tax": 65.96,
                              "fuel_surcharge": 1400,
                              "import_duty_charge": 0,
                              "import_tax_charge": 0,
                              "import_tax_non_chargeable": 0,
                              "insurance_fee": 0,
                              "minimum_pickup_fee": 0,
                              "oversized_surcharge": 0,
                              "provincial_sales_tax": 0,
                              "remote_area_surcharge": 0,
                              "residential_discounted_fee": 0,
                              "residential_full_fee": 0,
                              "sales_tax": 0,
                              "shipment_charge": 140,
                              "shipment_charge_total": 1540,
                              "total_charge": 1540,
                              "warehouse_handling_fee": 0
                            },
                            "remote_area_surcharge": 0,
                            "remote_area_surcharges": null,
                            "residential_discounted_fee": 0,
                            "residential_full_fee": 0,
                            "sales_tax": 0,
                            "shipment_charge": 100,
                            "shipment_charge_total": 110,
                            "total_charge": 110,
                            "tracking_rating": 2,
                            "value_for_money_rank": 4,
                            "warehouse_handling_fee": 0
                          }
                        ],
                        "regulatory_identifiers": {
                          "eori": null,
                          "ioss": null,
                          "vat_number": null
                        },
                        "return": false,
                        "return_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "sender_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "set_as_residential": false,
                        "shipment_state": "created",
                        "shipping_documents": [],
                        "shipping_settings": {
                          "b13a_filing": null,
                          "label_customization_fields": []
                        },
                        "tracking_page_url": "http://api.easyship.com:9003/shipment-tracking/ESSG10006002",
                        "trackings": [],
                        "updated_at": "2022-02-22T12:21:00Z",
                        "warehouse_state": "none"
                      },
                      "meta": {
                        "errors": [
                          "Generate label action 'generate_label' is not available for Courier 1_SG API"
                        ],
                        "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
                        "status": "partial_success",
                        "unavailable_couriers": []
                      }
                    },
                    "summary": "shipment partially created without label"
                  },
                  "no_rates_found": {
                    "value": {
                      "shipment": {
                        "easyship_shipment_id": "ESSG10006002",
                        "buyer_regulatory_identifiers": {
                          "ein": null,
                          "ssn": null,
                          "vat_number": null
                        },
                        "consignee_tax_id": null,
                        "courier_service": null,
                        "created_at": "2022-02-22T12:21:00Z",
                        "currency": "HKD",
                        "delivery_state": "not_created",
                        "destination_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+85230085678",
                          "country_alpha2": "HK",
                          "delivery_instructions": null,
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "eei_reference": null,
                        "incoterms": null,
                        "insurance": {
                          "is_insured": false,
                          "insured_amount": 0,
                          "insured_currency": "HKD"
                        },
                        "label_generated_at": null,
                        "label_paid_at": null,
                        "label_state": "not_created",
                        "last_failure_http_response_messages": [],
                        "metadata": {},
                        "order_data": {
                          "buyer_notes": null,
                          "buyer_selected_courier_name": null,
                          "order_created_at": null,
                          "order_tag_list": [],
                          "platform_name": null,
                          "platform_order_number": null,
                          "seller_notes": null
                        },
                        "origin_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "parcels": [
                          {
                            "box": {
                              "id": null,
                              "name": null,
                              "outer_dimensions": {
                                "length": 3,
                                "width": 2,
                                "height": 2
                              },
                              "slug": null,
                              "type": "box",
                              "weight": 0
                            },
                            "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                            "items": [
                              {
                                "actual_weight": 10,
                                "category": null,
                                "contains_battery_pi966": true,
                                "contains_battery_pi967": true,
                                "contains_liquids": true,
                                "declared_currency": "USD",
                                "declared_customs_value": 20,
                                "description": "item",
                                "dimensions": {
                                  "length": 1,
                                  "width": 2,
                                  "height": 3
                                },
                                "hs_code": "12345600",
                                "id": "12663646-58c1-4607-8fe0-cae3e33c0001",
                                "origin_country_alpha2": "HK",
                                "origin_currency": "HKD",
                                "origin_customs_value": 140,
                                "quantity": 2,
                                "sku": "sku"
                              }
                            ],
                            "total_actual_weight": 1,
                            "tracking_number": null
                          }
                        ],
                        "pickup_state": "not_requested",
                        "rates": [],
                        "regulatory_identifiers": {
                          "eori": null,
                          "ioss": null,
                          "vat_number": null
                        },
                        "return": false,
                        "return_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "sender_address": {
                          "city": "Hong Kong",
                          "company_name": "Test Plc.",
                          "contact_email": "asd@asd.com",
                          "contact_name": "Foo Bar",
                          "contact_phone": "+852-3008-5678",
                          "country_alpha2": "HK",
                          "line_1": "Kennedy Town",
                          "line_2": "Block 3",
                          "line_3": "Unit 1000",
                          "postal_code": "0000",
                          "state": "Yuen Long"
                        },
                        "set_as_residential": false,
                        "shipment_state": "created",
                        "shipping_documents": [],
                        "shipping_settings": {
                          "b13a_filing": null,
                          "label_customization_fields": []
                        },
                        "tracking_page_url": "http://api.easyship.com:9003/shipment-tracking/ESSG10006002",
                        "trackings": [],
                        "updated_at": "2022-02-22T12:21:00Z",
                        "warehouse_state": "none"
                      },
                      "meta": {
                        "errors": [
                          "Sorry, we couldn't find any shipping solutions based on the information provided."
                        ],
                        "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
                        "status": "partial_success",
                        "unavailable_couriers": [
                          {
                            "id": "01563646-58c1-4607-8fe0-cae3e33c0001",
                            "message": "This courier service only supports shipping item(s) of the Cameras, Accessory (with battery), Health & Beauty, Tablets, Computers & Laptops or Mobile Phones category.",
                            "name": "Quantium - Q-Smart battery"
                          }
                        ]
                      }
                    },
                    "summary": "shipment partially created without available rates"
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/shipment_single"
                }
              }
            }
          },
          "402": {
            "description": "insufficient subscription tier for a specific feature",
            "content": {
              "application/json": {
                "examples": {
                  "not_enough_funds": {
                    "value": {
                      "error": {
                        "code": "payment_required",
                        "details": [
                          "We were unable to generate a label as you do not have enough funds on your account."
                        ],
                        "links": [
                          {
                            "kind": "documentation",
                            "name": "Errors",
                            "url": "https://developers.easyship.com/reference/errors"
                          },
                          {
                            "kind": "documentation",
                            "name": "Payments",
                            "url": "https://developers.easyship.com/reference/payments"
                          },
                          {
                            "kind": "documentation",
                            "name": "Create a Shipment",
                            "url": "https://developers.easyship.com/reference/shipments_create"
                          },
                          {
                            "kind": "how-to-guide",
                            "name": "How to Automate your Shipments",
                            "url": "https://developers.easyship.com/docs/how-to-automate-your-shipments"
                          }
                        ],
                        "message": "Insufficient balance on your account. Please add more funds.",
                        "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
                        "type": "invalid_request_error"
                      }
                    },
                    "summary": "not enough funds on account"
                  },
                  "subscription_limit": {
                    "value": {
                      "error": {
                        "code": "over_limit",
                        "details": [
                          "We were unable to generate a label as you reached your subscription limitation for number of created shipments."
                        ],
                        "links": [
                          {
                            "kind": "documentation",
                            "name": "Errors",
                            "url": "https://developers.easyship.com/reference/errors"
                          },
                          {
                            "kind": "documentation",
                            "name": "Subscriptions",
                            "url": "https://developers.easyship.com/reference/subscription"
                          },
                          {
                            "kind": "documentation",
                            "name": "Create a Shipment",
                            "url": "https://developers.easyship.com/reference/shipments_create"
                          },
                          {
                            "kind": "how-to-guide",
                            "name": "How to Automate your Shipments",
                            "url": "https://developers.easyship.com/docs/how-to-automate-your-shipments"
                          }
                        ],
                        "message": "You have reached your plan limit. Please upgrade your subscription plan.",
                        "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
                        "type": "invalid_request_error"
                      }
                    },
                    "summary": "reached a subscription limit"
                  },
                  "balance_limit": {
                    "value": {
                      "error": {
                        "code": "overdraft_limit",
                        "details": [
                          "We were unable to generate a label as your maximum balance limit has been reached. Please contact your account manager."
                        ],
                        "links": [
                          {
                            "kind": "documentation",
                            "name": "Errors",
                            "url": "https://developers.easyship.com/reference/errors"
                          },
                          {
                            "kind": "documentation",
                            "name": "Create a Shipment",
                            "url": "https://developers.easyship.com/reference/shipments_create"
                          },
                          {
                            "kind": "how-to-guide",
                            "name": "How to Automate your Shipments",
                            "url": "https://developers.easyship.com/docs/how-to-automate-your-shipments"
                          }
                        ],
                        "message": "Your maximum balance limit has been reached. Please contact your account manager.",
                        "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
                        "type": "invalid_request_error"
                      }
                    },
                    "summary": "reached a balance limit"
                  },
                  "default": {
                    "value": {
                      "error": {
                        "code": "insufficient_subscription",
                        "details": [
                          "The DDP RATES feature is not available for free subscription plan, please contact Easyship"
                        ],
                        "links": [
                          {
                            "kind": "documentation",
                            "name": "Errors",
                            "url": "https://developers.easyship.com/reference/errors"
                          },
                          {
                            "kind": "documentation",
                            "name": "Subscriptions",
                            "url": "https://developers.easyship.com/reference/subscription"
                          },
                          {
                            "kind": "documentation",
                            "name": "Create a Shipment",
                            "url": "https://developers.easyship.com/reference/shipments_create"
                          },
                          {
                            "kind": "how-to-guide",
                            "name": "How to Automate your Shipments",
                            "url": "https://developers.easyship.com/docs/how-to-automate-your-shipments"
                          }
                        ],
                        "message": "You don't have access to this feature. Please upgrade your plan",
                        "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
                        "type": "invalid_request_error"
                      }
                    },
                    "summary": "insufficient subscription tier for a specific feature"
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "422": {
            "description": "failed validations",
            "content": {
              "application/json": {
                "examples": {
                  "default": {
                    "value": {
                      "error": {
                        "code": "invalid_content",
                        "details": [
                          "The request does not comply with the OpenAPI Specification.",
                          "#/components/schemas/Address/properties/line_1 does not allow null values"
                        ],
                        "links": [
                          {
                            "kind": "documentation",
                            "name": "Errors",
                            "url": "https://developers.easyship.com/reference/errors"
                          }
                        ],
                        "message": "The request body content is not valid.",
                        "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
                        "type": "invalid_request_error"
                      }
                    },
                    "summary": "failed validations"
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentCreate"
              },
              "examples": {
                "shipment_with_product_id_successfully_created": {
                  "summary": "shipment with product_id successfully created",
                  "value": {
                    "origin_address": {
                      "line_1": "Kennedy Town",
                      "line_2": "Block 3",
                      "line_3": "Unit 1000",
                      "state": "Yuen Long",
                      "city": "Hong Kong",
                      "postal_code": "0000",
                      "country_alpha2": "HK",
                      "contact_name": "Foo Bar",
                      "company_name": "Test Plc.",
                      "contact_phone": "+852-3008-5678",
                      "contact_email": "asd@asd.com"
                    },
                    "destination_address": {
                      "line_1": "Kennedy Town",
                      "line_2": "Block 3",
                      "line_3": "Unit 1000",
                      "state": "Yuen Long",
                      "city": "Hong Kong",
                      "postal_code": "0000",
                      "country_alpha2": "HK",
                      "contact_name": "Foo Bar",
                      "company_name": "Test Plc.",
                      "contact_phone": "+852-3008-5678",
                      "contact_email": "asd@asd.com"
                    },
                    "parcels": [
                      {
                        "total_actual_weight": 1,
                        "box": null,
                        "items": [
                          {
                            "product": {
                              "id": "01563646-58c1-4607-8fe0-cae3e33c0001"
                            },
                            "quantity": 2
                          }
                        ]
                      }
                    ]
                  }
                },
                "shipment_successfully_created_but_taxes_and_duties_excluded_due_to_insufficient_subscription": {
                  "summary": "shipment successfully created but taxes and duties excluded due to insufficient subscription",
                  "value": {
                    "origin_address": {
                      "line_1": "Kennedy Town",
                      "line_2": "Block 3",
                      "line_3": "Unit 1000",
                      "state": "Yuen Long",
                      "city": "Hong Kong",
                      "postal_code": "0000",
                      "country_alpha2": "HK",
                      "contact_name": "Foo Bar",
                      "company_name": "Test Plc.",
                      "contact_phone": "+852-3008-5678",
                      "contact_email": "asd@asd.com"
                    },
                    "destination_address": {
                      "line_1": "Kennedy Town",
                      "line_2": "Block 3",
                      "line_3": "Unit 1000",
                      "state": "Yuen Long",
                      "city": "Hong Kong",
                      "postal_code": "0000",
                      "country_alpha2": "HK",
                      "contact_name": "Foo Bar",
                      "company_name": "Test Plc.",
                      "contact_phone": "+852-3008-5678",
                      "contact_email": "asd@asd.com"
                    },
                    "parcels": [
                      {
                        "total_actual_weight": 1,
                        "box": null,
                        "items": [
                          {
                            "description": "item",
                            "category": null,
                            "hs_code": "123456",
                            "contains_battery_pi966": true,
                            "contains_battery_pi967": true,
                            "contains_liquids": true,
                            "sku": "sku",
                            "origin_country_alpha2": "HK",
                            "quantity": 2,
                            "dimensions": {
                              "length": 1,
                              "width": 2,
                              "height": 3
                            },
                            "actual_weight": 10,
                            "declared_currency": "USD",
                            "declared_customs_value": 20
                          }
                        ]
                      }
                    ]
                  }
                },
                "shipment_successfully_created_with_zpl_format_printing_options": {
                  "summary": "shipment successfully created with zpl format printing options",
                  "value": {
                    "origin_address": {
                      "line_1": "73 CHESTER RD",
                      "line_2": null,
                      "line_3": "Unit 1000",
                      "state": "Massachusetts",
                      "city": "Belmont",
                      "postal_code": "02478",
                      "country_alpha2": "US",
                      "contact_name": "Foo Bar",
                      "company_name": "Test Plc.",
                      "contact_phone": "917-275-6975",
                      "contact_email": "us@testusemail.com"
                    },
                    "destination_address": {
                      "line_1": "73 CHESTER RD",
                      "line_2": null,
                      "line_3": "Unit 1000",
                      "state": "Massachusetts",
                      "city": "Belmont",
                      "postal_code": "02478",
                      "country_alpha2": "US",
                      "contact_name": "Foo Bar",
                      "company_name": "Test Plc.",
                      "contact_phone": "917-275-6975",
                      "contact_email": "us@testusemail.com"
                    },
                    "parcels": [
                      {
                        "total_actual_weight": 1,
                        "box": null,
                        "items": [
                          {
                            "description": "item",
                            "category": null,
                            "hs_code": "123456",
                            "contains_battery_pi966": false,
                            "contains_battery_pi967": false,
                            "contains_liquids": false,
                            "sku": "sku",
                            "origin_country_alpha2": "US",
                            "quantity": 2,
                            "dimensions": {
                              "length": 1,
                              "width": 2,
                              "height": 3
                            },
                            "actual_weight": 10,
                            "declared_currency": "USD",
                            "declared_customs_value": 20
                          }
                        ]
                      }
                    ],
                    "shipping_settings": {
                      "printing_options": {
                        "commercial_invoice": "A4",
                        "format": "zpl",
                        "label": "4x6",
                        "packing_slip": "4x6"
                      },
                      "buy_label": true,
                      "buy_label_synchronous": true
                    }
                  }
                },
                "return_shipment_successfully_created_with_qr_label": {
                  "summary": "return shipment successfully created with QR code and label documents",
                  "value": {
                    "origin_address": {
                      "line_1": "73 CHESTER RD",
                      "line_2": null,
                      "state": "Massachusetts",
                      "city": "Belmont",
                      "postal_code": "02478",
                      "country_alpha2": "US",
                      "contact_name": "Foo Bar",
                      "company_name": "Test Plc.",
                      "contact_phone": "917-275-6975",
                      "contact_email": "us@testusemail.com"
                    },
                    "destination_address": {
                      "line_1": "73 CHESTER RD",
                      "line_2": null,
                      "state": "Massachusetts",
                      "city": "Belmont",
                      "postal_code": "02478",
                      "country_alpha2": "US",
                      "contact_name": "Foo Bar",
                      "company_name": "Test Plc.",
                      "contact_phone": "917-275-6975",
                      "contact_email": "us@testusemail.com"
                    },
                    "parcels": [
                      {
                        "total_actual_weight": 1,
                        "box": null,
                        "items": [
                          {
                            "description": "item",
                            "category": "fashion",
                            "sku": "sku",
                            "origin_country_alpha2": "US",
                            "quantity": 2,
                            "dimensions": {
                              "length": 1,
                              "width": 2,
                              "height": 3
                            },
                            "actual_weight": 10,
                            "declared_currency": "USD",
                            "declared_customs_value": 20
                          }
                        ]
                      }
                    ],
                    "return": true,
                    "courier_settings": {
                      "courier_service_id": "01563646-58c1-4607-8fe0-cae3e33c0004"
                    },
                    "shipping_settings": {
                      "printing_options": {
                        "format": "url"
                      },
                      "additional_services": {
                        "qr_code": "qr_code"
                      },
                      "buy_label": true,
                      "buy_label_synchronous": true
                    }
                  }
                },
                "shipment_successfully_created": {
                  "summary": "shipment successfully created",
                  "value": {
                    "origin_address": {
                      "line_1": "Kennedy Town",
                      "line_2": "Block 3",
                      "line_3": "Unit 1000",
                      "state": "Yuen Long",
                      "city": "Hong Kong",
                      "postal_code": "0000",
                      "country_alpha2": "HK",
                      "contact_name": "Foo Bar",
                      "company_name": "Test Plc.",
                      "contact_phone": "+852-3008-5678",
                      "contact_email": "asd@asd.com"
                    },
                    "destination_address": {
                      "line_1": "Kennedy Town",
                      "line_2": "Block 3",
                      "line_3": "Unit 1000",
                      "state": "Yuen Long",
                      "city": "Hong Kong",
                      "postal_code": "0000",
                      "country_alpha2": "HK",
                      "contact_name": "Foo Bar",
                      "company_name": "Test Plc.",
                      "contact_phone": "+852-3008-5678",
                      "contact_email": "asd@asd.com"
                    },
                    "parcels": [
                      {
                        "total_actual_weight": 1,
                        "box": null,
                        "items": [
                          {
                            "description": "item",
                            "category": null,
                            "hs_code": "123456",
                            "contains_battery_pi966": true,
                            "contains_battery_pi967": true,
                            "contains_liquids": true,
                            "sku": "sku",
                            "origin_country_alpha2": "HK",
                            "quantity": 2,
                            "dimensions": {
                              "length": 1,
                              "width": 2,
                              "height": 3
                            },
                            "actual_weight": 10,
                            "declared_currency": "USD",
                            "declared_customs_value": 20
                          }
                        ]
                      }
                    ],
                    "regulatory_identifiers": {
                      "eori": "DE 123456789 12345",
                      "ioss": "IM1234567890",
                      "vat_number": "EU1234567890"
                    },
                    "buyer_regulatory_identifiers": {
                      "ein": "12-3456789",
                      "vat_number": "EU1234567890",
                      "ssn": "123-45-6789"
                    },
                    "order_data": {
                      "buyer_selected_courier_name": "test_courier",
                      "platform_name": "test plat_form",
                      "order_created_at": "2024-01-31T18:00:00Z"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://public-api.easyship.com",
      "description": "Production"
    }
  ],
  "components": {
    "securitySchemes": {
      "Bearer": {
        "description": "Bearer Token necessary to use API",
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "token"
      }
    },
    "schemas": {
      "shipment_single": {
        "type": "object",
        "description": "Single shipment with all its details",
        "additionalProperties": false,
        "properties": {
          "shipment": {
            "$ref": "#/components/schemas/Shipment"
          },
          "meta": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "status": {
                "type": "string"
              },
              "errors": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "unavailable_couriers": {
                "$ref": "#/components/schemas/UnavailableCouriers"
              },
              "request_id": {
                "$ref": "#/components/schemas/Meta/properties/request_id"
              }
            }
          }
        }
      },
      "CourierService": {
        "type": "object",
        "description": "Courier service",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "ID"
          },
          "name": {
            "type": "string",
            "description": "If the courier service is connected through your own courier account, this will be \"{nickname} - {official_name}\". If the courier service is provided by Easyship, this will be the official name of the courier service."
          },
          "umbrella_name": {
            "type": "string",
            "description": "Human-readable name for the courier company that offers this service."
          },
          "official_name": {
            "type": "string",
            "description": "Official name of the courier service."
          },
          "nickname": {
            "type": "string",
            "description": "Nickname you set when creating/updating the courier service. Only applicable for LYOC services.",
            "nullable": true
          },
          "service_name": {
            "type": "string",
            "description": "Service that offered by the courier company."
          },
          "logo_url": {
            "type": "string",
            "description": "Logo of the courier. Deprecated in favor of `courier_logo_url`.",
            "nullable": true,
            "deprecated": true
          },
          "country_alpha2": {
            "$ref": "#/components/schemas/CountryAlpha2"
          },
          "active": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether the courier is active or not."
          },
          "restricted_to_origin_states": {
            "type": "array",
            "nullable": true,
            "items": {
              "type": "string"
            },
            "description": "List of origin states that the service is available for (US only)."
          },
          "restricted_to_destination_states": {
            "type": "array",
            "nullable": true,
            "items": {
              "type": "string"
            },
            "description": "List of destination states that the service is available for (US only)."
          },
          "supported_incoterms": {
            "description": "Terms of Sale\nDDP: Seller pays all import duties/taxes.\nDDU: Buyer pays all import duties/taxes.\n",
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "DDU",
                "DDP"
              ],
              "default": "DDU"
            }
          },
          "ioss_support": {
            "type": "string",
            "nullable": true,
            "enum": [
              "supported_mandatory",
              "supported_optional",
              "not_supported",
              null
            ]
          },
          "customer_reference_id": {
            "type": "string",
            "nullable": true,
            "description": "An identifier for the customer who owns the account. Available only for selected customers."
          },
          "accepts_outbounds": {
            "deprecated": true,
            "type": "boolean",
            "description": "Whether the courier can be used to generate outbound labels."
          },
          "accepts_prepaid_returns": {
            "deprecated": true,
            "type": "boolean",
            "description": "Returns `true` if returns are billed upon label generation."
          },
          "accepts_pay_on_scan_returns": {
            "deprecated": true,
            "type": "boolean",
            "description": "Returns `true` if returns are billed upon label scan."
          },
          "domestic": {
            "type": "boolean",
            "description": "Returns `true` if the courier service is a domestic service. Both `domestic` and `international` can be `true` at the same time."
          },
          "international": {
            "type": "boolean",
            "description": "Returns `true` if the courier service is an international service. Both `domestic` and `international` can be `true` at the same time."
          },
          "courier_id": {
            "type": "string",
            "format": "uuid",
            "description": "The Courier ID is associated with this service."
          },
          "courier_logo_url": {
            "type": "string",
            "description": "The URL of the Courier logo."
          },
          "courier_icon_url": {
            "type": "string",
            "nullable": true,
            "description": "URL for a small icon-style image of the courier, suitable for UI contexts like lists or filters where the full-size `courier_logo_url` image doesn't fit. Null if no icon is available for this courier."
          },
          "easyship_courier_service": {
            "type": "boolean",
            "description": "Whether the Courier Service belongs to Easyship or not."
          },
          "accepts": {
            "type": "object",
            "description": "Acceptance criteria for the courier.",
            "properties": {
              "outbounds": {
                "type": "boolean",
                "description": "Whether the courier can be used to generate outbound labels."
              },
              "prepaid_returns": {
                "type": "boolean",
                "description": "Returns `true` if returns are billed upon label generation."
              },
              "pay_on_scan_returns": {
                "type": "boolean",
                "description": "Returns `true` if returns are billed upon label scan."
              },
              "pi965_batteries": {
                "type": "boolean",
                "description": "Returns `true` if courier accepts battery (pi965)."
              },
              "pi966_batteries": {
                "type": "boolean",
                "description": "Returns `true` if courier accepts battery (pi966)."
              },
              "pi967_batteries": {
                "type": "boolean",
                "description": "Returns `true` if courier accepts battery (pi967)."
              },
              "liquids": {
                "type": "boolean",
                "description": "Returns `true` if courier accepts liquids."
              },
              "specific_dangerous_goods": {
                "type": "boolean",
                "description": "Returns `true` if courier accepts other dangerous goods that are not batteries (pi966, pi967, or pi968)."
              },
              "documents": {
                "type": "boolean",
                "description": "Returns `true` if courier accepts documents."
              },
              "parcels": {
                "type": "boolean",
                "description": "Returns `true` if courier accepts parcels."
              }
            }
          },
          "available_handover_options": {
            "type": "array",
            "description": "A list of one or more of `dropoff`, `free_pickup`, and `paid_pickup`",
            "items": {
              "type": "string",
              "enum": [
                "dropoff",
                "free_pickup",
                "paid_pickup"
              ]
            }
          },
          "tracking_rating": {
            "type": "number",
            "description": "Quality of tracking information provided by the courier\n\n-1: No tracking number\n0: Limited\n1: Basic\n2: Regular\n3: Excellent\n",
            "enum": [
              -1,
              0,
              1,
              2,
              3
            ]
          }
        }
      },
      "Error": {
        "type": "object",
        "description": "Error",
        "additionalProperties": false,
        "properties": {
          "error": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "code": {
                "type": "string",
                "description": "A short code that represents the error."
              },
              "type": {
                "type": "string",
                "description": "The type of error returned.",
                "enum": [
                  "invalid_request_error",
                  "api_error"
                ]
              },
              "message": {
                "type": "string",
                "description": "A human-readable message providing brief information about the error."
              },
              "links": {
                "type": "array",
                "description": "Link(s) to Easyship developer resources",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Name of Easyship documentation"
                    },
                    "url": {
                      "type": "string",
                      "format": "uri",
                      "description": "URL to Easyship documentation"
                    },
                    "kind": {
                      "type": "string",
                      "description": "The kind of easyship documentation"
                    }
                  }
                }
              },
              "details": {
                "type": "array",
                "description": "An array of human-readable messages providing detailed information about the error.",
                "nullable": true,
                "items": {
                  "type": "string"
                }
              },
              "request_id": {
                "type": "string",
                "description": "An unique ID represent the request."
              }
            }
          }
        }
      },
      "Meta": {
        "type": "object",
        "properties": {
          "request_id": {
            "type": "string",
            "description": "An unique ID represent the request."
          }
        }
      },
      "Address": {
        "type": "object",
        "properties": {
          "line_1": {
            "type": "string",
            "description": "First line of the street address",
            "maximum": 35
          },
          "line_2": {
            "type": "string",
            "nullable": true,
            "description": "Second line of the street address",
            "maximum": 35
          },
          "line_3": {
            "type": "string",
            "nullable": true,
            "description": "Third line of the street address. This value is saved and returned by the API, but not every courier includes it on the label, so it may be ignored if the selected courier does not support a third address line.",
            "maximum": 35
          },
          "state": {
            "type": "string",
            "description": "State, Province, or other top-level administrative region. Mandatory for these countries: AU, CA, CN, ID, MX, MY, TH, US, VN. Use abbreviations for naming the state if possible (2 letters for the US/CA, 2 or 3 letters for AU). For countries using provinces, use the full province names.",
            "maximum": 200
          },
          "city": {
            "type": "string",
            "description": "City or Suburb",
            "maximum": 200
          },
          "postal_code": {
            "type": "string",
            "nullable": true,
            "description": "Postal code. Leave it null or 0 if the country does not have postal codes. Mandatory for these countries: AD, AF, AI, AL, AM, AQ, AR, AS, AT, AU, AX, AZ, BA, BB, BD, BE, BG, BL, BM, BN, BQ, BR, BT, BV, BY, CA, CC, CH, CL, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DK, DO, DZ, EC, EE, EG, EH, ES, ET, FI, FK, FM, FO, FR, GA, GB, GE, GF, GG, GI, GL, GP, GR, GS, GT, GU, GW, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JO, JP, KG, KH, KR, KW, KY, KZ, LA, LB, LI, LK, LR, LS, LT, LU, LV, MA, MC, MD, ME, MF, MG, MH, MK, MM, MN, MP, MQ, MT, MV, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NZ, OM, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, RE, RO, RS, RU, SD, SE, SG, SH, SI, SJ, SK, SM, SN, SS, SV, SX, SZ, TC, TD, TH, TJ, TM, TN, TR, TW, UA, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, WF, WS, YT, ZA, ZM."
          },
          "country_alpha2": {
            "$ref": "#/components/schemas/CountryAlpha2"
          },
          "company_name": {
            "type": "string",
            "nullable": true,
            "description": "The company or organization at the address",
            "maximum": 27
          },
          "contact_name": {
            "type": "string",
            "description": "The full name of a person at the address",
            "maximum": 22
          },
          "contact_phone": {
            "type": "string",
            "description": "Phone number used to reach the person in contact_name (may or may not be SMS-ready)",
            "maximum": 20,
            "nullable": true
          },
          "contact_email": {
            "type": "string",
            "format": "email",
            "description": "Email address used to reach the person in `contact_name\"",
            "maximum": 50
          }
        }
      },
      "DestinationAddress": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "line_1": {
            "type": "string",
            "description": "First line of the street address",
            "maximum": 35
          },
          "line_2": {
            "type": "string",
            "nullable": true,
            "description": "Second line of the street address",
            "maximum": 35
          },
          "line_3": {
            "type": "string",
            "nullable": true,
            "description": "Third line of the street address. Saved and returned on shipments only (ignored by rates and trackings). Not every courier includes it on the label, so it may be ignored if the selected courier does not support a third address line.",
            "maximum": 35
          },
          "state": {
            "type": "string",
            "nullable": true,
            "maximum": 200,
            "description": "State, Province, or other top-level administrative region. Mandatory for these countries: AU, CA, CN, ID, MX, MY, TH, US, VN. Use abbreviations for naming the state if possible (2 letters for the US/CA, 2 or 3 letters for AU). For countries using provinces, use the full province names."
          },
          "city": {
            "type": "string",
            "description": "City or Suburb",
            "maximum": 200
          },
          "postal_code": {
            "type": "string",
            "description": "Postal code. Mandatory for most countries (if not applicable, for example Hong Kong, leave null or 0)"
          },
          "country_alpha2": {
            "$ref": "#/components/schemas/CountryAlpha2"
          },
          "company_name": {
            "type": "string",
            "nullable": true,
            "description": "The company or organization at the address",
            "maximum": 50
          },
          "contact_name": {
            "type": "string",
            "description": "The full name of a person at the address",
            "maximum": 50
          },
          "contact_phone": {
            "type": "string",
            "description": "Phone number used to reach the person in contact_name (may or may not be SMS-ready)",
            "maximum": 20
          },
          "contact_email": {
            "type": "string",
            "format": "email",
            "description": "Email address used to reach the person in `contact_name`",
            "maximum": 50
          },
          "delivery_instructions": {
            "type": "string",
            "description": "Delivery instructions for the address, see [Delivery Instructions](https://developers.easyship.com/page/delivery-instructions).",
            "maximum": 200,
            "nullable": true
          }
        }
      },
      "Box": {
        "type": "object",
        "description": "User-defined details of a box used for shipments",
        "externalDocs": {
          "description": "Saving Shipping Boxes Dimensions - Easyship Support",
          "url": "https://support.easyship.com/hc/en-us/articles/360025430011-Saving-Shipping-Boxes-Dimensions"
        },
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "ID"
          },
          "courier": {
            "type": "object",
            "nullable": true,
            "additionalProperties": false,
            "properties": {
              "umbrella_name": {
                "type": "string",
                "description": "Human-readable name for the courier company that offers this service, when applicable."
              },
              "country_alpha2": {
                "$ref": "#/components/schemas/CountryAlpha2"
              }
            }
          },
          "name": {
            "type": "string",
            "nullable": true,
            "description": "Name"
          },
          "slug": {
            "type": "string",
            "nullable": true,
            "description": "Slug"
          },
          "outer_dimensions": {
            "type": "object",
            "additionalProperties": false,
            "description": "A measure of the space taken by the box itself, in cm.",
            "properties": {
              "length": {
                "type": "number"
              },
              "width": {
                "type": "number"
              },
              "height": {
                "type": "number"
              }
            }
          },
          "weight": {
            "type": "number",
            "description": "The weight of the box's packaging materials (excluding items inside), in kg."
          },
          "type": {
            "type": "string",
            "description": "Box type."
          }
        }
      },
      "CountryAlpha2": {
        "type": "string",
        "description": "Country Code in Alpha-2 format (ISO 3166-1)",
        "enum": [
          "AD",
          "AE",
          "AF",
          "AG",
          "AI",
          "AL",
          "AM",
          "AN",
          "AO",
          "AQ",
          "AR",
          "AS",
          "AT",
          "AU",
          "AW",
          "AX",
          "AZ",
          "BA",
          "BB",
          "BD",
          "BE",
          "BF",
          "BG",
          "BH",
          "BI",
          "BJ",
          "BL",
          "BM",
          "BN",
          "BO",
          "BQ",
          "BR",
          "BS",
          "BT",
          "BV",
          "BW",
          "BY",
          "BZ",
          "CA",
          "CC",
          "CD",
          "CF",
          "CG",
          "CH",
          "CI",
          "CK",
          "CL",
          "CM",
          "CN",
          "CO",
          "CR",
          "CU",
          "CV",
          "CW",
          "CX",
          "CY",
          "CZ",
          "DE",
          "DJ",
          "DK",
          "DM",
          "DO",
          "DZ",
          "EC",
          "EE",
          "EG",
          "EH",
          "ER",
          "ES",
          "ET",
          "FI",
          "FJ",
          "FK",
          "FM",
          "FO",
          "FR",
          "GA",
          "GB",
          "GD",
          "GE",
          "GF",
          "GG",
          "GH",
          "GI",
          "GL",
          "GM",
          "GN",
          "GP",
          "GQ",
          "GR",
          "GS",
          "GT",
          "GU",
          "GW",
          "GY",
          "HK",
          "HM",
          "HN",
          "HR",
          "HT",
          "HU",
          "ID",
          "IE",
          "IL",
          "IM",
          "IN",
          "IO",
          "IQ",
          "IR",
          "IS",
          "IT",
          "JE",
          "JM",
          "JO",
          "JP",
          "KE",
          "KG",
          "KH",
          "KI",
          "KM",
          "KN",
          "KP",
          "KR",
          "KW",
          "KY",
          "KZ",
          "LA",
          "LB",
          "LC",
          "LI",
          "LK",
          "LR",
          "LS",
          "LT",
          "LU",
          "LV",
          "LY",
          "MA",
          "MC",
          "MD",
          "ME",
          "MF",
          "MG",
          "MH",
          "MK",
          "ML",
          "MM",
          "MN",
          "MO",
          "MP",
          "MQ",
          "MR",
          "MS",
          "MT",
          "MU",
          "MV",
          "MW",
          "MX",
          "MY",
          "MZ",
          "NA",
          "NC",
          "NE",
          "NF",
          "NG",
          "NI",
          "NL",
          "NO",
          "NP",
          "NR",
          "NU",
          "NZ",
          "OM",
          "PA",
          "PE",
          "PF",
          "PG",
          "PH",
          "PK",
          "PL",
          "PM",
          "PN",
          "PR",
          "PS",
          "PT",
          "PW",
          "PY",
          "QA",
          "RE",
          "RO",
          "RS",
          "RU",
          "RW",
          "SA",
          "SB",
          "SC",
          "SD",
          "SE",
          "SG",
          "SH",
          "SI",
          "SJ",
          "SK",
          "SL",
          "SM",
          "SN",
          "SO",
          "SR",
          "SS",
          "ST",
          "SV",
          "SX",
          "SY",
          "SZ",
          "TC",
          "TD",
          "TF",
          "TG",
          "TH",
          "TJ",
          "TK",
          "TL",
          "TM",
          "TN",
          "TO",
          "TR",
          "TT",
          "TV",
          "TW",
          "TZ",
          "UA",
          "UG",
          "UM",
          "US",
          "UY",
          "UZ",
          "VA",
          "VC",
          "VE",
          "VG",
          "VI",
          "VN",
          "VU",
          "WF",
          "WS",
          "YE",
          "YT",
          "ZA",
          "ZM",
          "ZW"
        ]
      },
      "CountryAlpha2Nullable": {
        "type": "string",
        "description": "Country Code in Alpha-2 format (ISO 3166-1)",
        "enum": [
          "AD",
          "AE",
          "AF",
          "AG",
          "AI",
          "AL",
          "AM",
          "AN",
          "AO",
          "AQ",
          "AR",
          "AS",
          "AT",
          "AU",
          "AW",
          "AX",
          "AZ",
          "BA",
          "BB",
          "BD",
          "BE",
          "BF",
          "BG",
          "BH",
          "BI",
          "BJ",
          "BL",
          "BM",
          "BN",
          "BO",
          "BQ",
          "BR",
          "BS",
          "BT",
          "BV",
          "BW",
          "BY",
          "BZ",
          "CA",
          "CC",
          "CD",
          "CF",
          "CG",
          "CH",
          "CI",
          "CK",
          "CL",
          "CM",
          "CN",
          "CO",
          "CR",
          "CU",
          "CV",
          "CW",
          "CX",
          "CY",
          "CZ",
          "DE",
          "DJ",
          "DK",
          "DM",
          "DO",
          "DZ",
          "EC",
          "EE",
          "EG",
          "EH",
          "ER",
          "ES",
          "ET",
          "FI",
          "FJ",
          "FK",
          "FM",
          "FO",
          "FR",
          "GA",
          "GB",
          "GD",
          "GE",
          "GF",
          "GG",
          "GH",
          "GI",
          "GL",
          "GM",
          "GN",
          "GP",
          "GQ",
          "GR",
          "GS",
          "GT",
          "GU",
          "GW",
          "GY",
          "HK",
          "HM",
          "HN",
          "HR",
          "HT",
          "HU",
          "ID",
          "IE",
          "IL",
          "IM",
          "IN",
          "IO",
          "IQ",
          "IR",
          "IS",
          "IT",
          "JE",
          "JM",
          "JO",
          "JP",
          "KE",
          "KG",
          "KH",
          "KI",
          "KM",
          "KN",
          "KP",
          "KR",
          "KW",
          "KY",
          "KZ",
          "LA",
          "LB",
          "LC",
          "LI",
          "LK",
          "LR",
          "LS",
          "LT",
          "LU",
          "LV",
          "LY",
          "MA",
          "MC",
          "MD",
          "ME",
          "MF",
          "MG",
          "MH",
          "MK",
          "ML",
          "MM",
          "MN",
          "MO",
          "MP",
          "MQ",
          "MR",
          "MS",
          "MT",
          "MU",
          "MV",
          "MW",
          "MX",
          "MY",
          "MZ",
          "NA",
          "NC",
          "NE",
          "NF",
          "NG",
          "NI",
          "NL",
          "NO",
          "NP",
          "NR",
          "NU",
          "NZ",
          "OM",
          "PA",
          "PE",
          "PF",
          "PG",
          "PH",
          "PK",
          "PL",
          "PM",
          "PN",
          "PR",
          "PS",
          "PT",
          "PW",
          "PY",
          "QA",
          "RE",
          "RO",
          "RS",
          "RU",
          "RW",
          "SA",
          "SB",
          "SC",
          "SD",
          "SE",
          "SG",
          "SH",
          "SI",
          "SJ",
          "SK",
          "SL",
          "SM",
          "SN",
          "SO",
          "SR",
          "SS",
          "ST",
          "SV",
          "SX",
          "SY",
          "SZ",
          "TC",
          "TD",
          "TF",
          "TG",
          "TH",
          "TJ",
          "TK",
          "TL",
          "TM",
          "TN",
          "TO",
          "TR",
          "TT",
          "TV",
          "TW",
          "TZ",
          "UA",
          "UG",
          "UM",
          "US",
          "UY",
          "UZ",
          "VA",
          "VC",
          "VE",
          "VG",
          "VI",
          "VN",
          "VU",
          "WF",
          "WS",
          "YE",
          "YT",
          "ZA",
          "ZM",
          "ZW",
          null
        ],
        "nullable": true
      },
      "Currency": {
        "type": "string",
        "nullable": false,
        "enum": [
          "AED",
          "AFN",
          "ALL",
          "AMD",
          "ANG",
          "AOA",
          "ARS",
          "AUD",
          "AWG",
          "AZN",
          "BAM",
          "BBD",
          "BDT",
          "BGN",
          "BHD",
          "BIF",
          "BMD",
          "BND",
          "BOB",
          "BRL",
          "BSD",
          "BTN",
          "BWP",
          "BYR",
          "BZD",
          "CAD",
          "CDF",
          "CHF",
          "CLF",
          "CLP",
          "CNY",
          "COP",
          "CRC",
          "CUC",
          "CUP",
          "CVE",
          "CZK",
          "DJF",
          "DKK",
          "DOP",
          "DZD",
          "EGP",
          "ERN",
          "ETB",
          "EUR",
          "FJD",
          "FKP",
          "GBP",
          "GEL",
          "GHS",
          "GIP",
          "GMD",
          "GNF",
          "GTQ",
          "GYD",
          "HKD",
          "HNL",
          "HRK",
          "HTG",
          "HUF",
          "IDR",
          "ILS",
          "INR",
          "IQD",
          "IRR",
          "ISK",
          "JMD",
          "JOD",
          "JPY",
          "KES",
          "KGS",
          "KHR",
          "KMF",
          "KPW",
          "KRW",
          "KWD",
          "KYD",
          "KZT",
          "LAK",
          "LBP",
          "LKR",
          "LRD",
          "LSL",
          "LTL",
          "LVL",
          "LYD",
          "MAD",
          "MDL",
          "MGA",
          "MKD",
          "MMK",
          "MNT",
          "MOP",
          "MRO",
          "MUR",
          "MVR",
          "MWK",
          "MXN",
          "MYR",
          "MZN",
          "NAD",
          "NGN",
          "NIO",
          "NOK",
          "NPR",
          "NZD",
          "OMR",
          "PAB",
          "PEN",
          "PGK",
          "PHP",
          "PKR",
          "PLN",
          "PYG",
          "QAR",
          "RON",
          "RSD",
          "RUB",
          "RWF",
          "SAR",
          "SBD",
          "SCR",
          "SDG",
          "SEK",
          "SGD",
          "SHP",
          "SKK",
          "SLL",
          "SOS",
          "SRD",
          "SSP",
          "STD",
          "SVC",
          "SYP",
          "SZL",
          "THB",
          "TJS",
          "TMT",
          "TND",
          "TOP",
          "TRY",
          "TTD",
          "TWD",
          "TZS",
          "UAH",
          "UGX",
          "USD",
          "UYU",
          "UZS",
          "VES",
          "VND",
          "VUV",
          "WST",
          "XAF",
          "XAG",
          "XAU",
          "XCD",
          "XDR",
          "XOF",
          "XPF",
          "YER",
          "ZAR",
          "ZMW",
          "BTC",
          "JEP",
          "EEK",
          "GHC",
          "MTL",
          "TMM",
          "YEN",
          "ZWD",
          "ZWL",
          "ZWN",
          "ZWR"
        ],
        "example": "USD",
        "description": "ISO-4217 three-letter alphabetic currency code (e.g. USD, EUR, GBP)"
      },
      "Parcel": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "ID of the parcel",
            "nullable": true
          },
          "total_actual_weight": {
            "type": "number",
            "description": "Total weight of the shipment, including the box weight. If you provide the total weight of the shipment, then the weight for items can be optional."
          },
          "box": {
            "$ref": "#/components/schemas/Box"
          },
          "items": {
            "type": "array",
            "description": "Array of all shipment items. May be empty for multi-parcel shipments (e.g. additional boxes).",
            "minItems": 0,
            "maxItems": 200,
            "items": {
              "$ref": "#/components/schemas/ParcelItem"
            }
          },
          "tracking_number": {
            "type": "string",
            "nullable": true,
            "description": "Per-parcel tracking number assigned by the courier for multi-parcel shipments.\nOnly present when the courier returns individual tracking numbers per parcel (FedEx, UPS, DHL, DPD GB).\nNull for single-parcel shipments or unsupported couriers."
          }
        }
      },
      "ParcelItem": {
        "type": "object",
        "description": "A line item in a shipment manifest; may be multiple physical objects.",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "ID of the item"
          },
          "description": {
            "type": "string",
            "description": "Description of the item",
            "maximum": 200
          },
          "category": {
            "type": "string",
            "nullable": true,
            "description": "Item Category slug. Use the Item Categories API to retrieve a list of available item categories or use HS Code field.",
            "maximum": 200
          },
          "sku": {
            "type": "string",
            "description": "Item Stock Keeping Unit (SKU) as listed in your store.",
            "maximum": 100,
            "nullable": true
          },
          "platform_product_id": {
            "type": "string",
            "nullable": true,
            "description": "Platform Product ID (PPID). Unique identifier from your store platform (e.g. Shopify variant ID, WooCommerce product ID). Used to link shipment items to product catalog entries for auto-population of product attributes."
          },
          "manufacturer_part_number": {
            "type": "string",
            "nullable": true,
            "description": "Manufacturer Part Number (MPN). The manufacturer's internal code or part number for the product. Useful for wholesale and B2B operations to identify products by their source."
          },
          "global_trade_item_number": {
            "type": "string",
            "nullable": true,
            "description": "Global Trade Item Number (GTIN). Internationally recognized unique identifier for trade items, including UPC (US/Canada), EAN (Europe), JAN (Japan), and ISBN (books). Used by retailers and carriers for product identification and inventory tracking."
          },
          "hs_code": {
            "type": "string",
            "description": "HS Code of the item",
            "nullable": true
          },
          "origin_country_alpha2": {
            "$ref": "#/components/schemas/CountryAlpha2Nullable"
          },
          "contains_battery_pi966": {
            "type": "boolean",
            "description": "Whether the item contains a PI966 battery (applicable when HS code is used).",
            "nullable": true
          },
          "contains_battery_pi967": {
            "type": "boolean",
            "description": "Whether the item contains a PI967 battery (applicable when HS code is used).",
            "nullable": true
          },
          "contains_liquids": {
            "type": "boolean",
            "description": "Whether the item contains liquids (applicable when HS code is used).",
            "nullable": true
          },
          "quantity": {
            "type": "integer",
            "description": "Item quantity",
            "default": 1
          },
          "dimensions": {
            "type": "object",
            "description": "Dimensions of the item",
            "additionalProperties": false,
            "properties": {
              "length": {
                "type": "number",
                "description": "Item length; Optional if the Box dimensions are provided."
              },
              "width": {
                "type": "number",
                "description": "Item width; Optional if the Box dimensions are provided."
              },
              "height": {
                "type": "number",
                "description": "Item height; Optional if the Box dimensions are provided."
              }
            }
          },
          "actual_weight": {
            "type": "number",
            "description": "Item actual weight in `kg`, must be greater than 0; Optional if `total_actual_weight` is provided."
          },
          "origin_currency": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Currency"
              },
              {
                "description": "Item customs value currency. ISO-4217 three-letter alphabetic currency code (e.g. USD, EUR, GBP)."
              }
            ]
          },
          "origin_customs_value": {
            "type": "number",
            "description": "Customs value of the item"
          },
          "declared_currency": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Currency"
              },
              {
                "description": "Currency of the item. ISO-4217 three-letter alphabetic currency code (e.g. USD, EUR, GBP)."
              }
            ]
          },
          "declared_customs_value": {
            "type": "number",
            "description": "Item customs value, must be greater than 0 unless category is `documents`. Please note that this value refers to the unit rather than the total."
          },
          "coc_status": {
            "type": "string",
            "enum": [
              "not_provided",
              "provided",
              "exempted"
            ],
            "description": "Whether this item's CPSC (Consumer Product Safety Commission) compliance data has been provided."
          },
          "cpsc_eligible": {
            "type": "boolean",
            "description": "Whether this item is subject to CPSC compliance rules (US import on a regulated category/HS code). Computed live against current rules on every read."
          },
          "cpsc_compliance": {
            "$ref": "#/components/schemas/CpscCompliance"
          }
        }
      },
      "ParcelReturnItemCreate": {
        "type": "object",
        "description": "Return Item (only available for return shipments)",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Item ID (from the shipment that is being returned)"
          },
          "quantity": {
            "type": "integer",
            "description": "Item quantity",
            "default": 1
          }
        }
      },
      "ShipmentTracking": {
        "type": "object",
        "description": "A source of tracking data for the shipment's journey",
        "additionalProperties": false,
        "properties": {
          "tracking_number": {
            "type": "string",
            "description": "Reference provided by the courier for this leg"
          },
          "local_tracking_number": {
            "type": "string",
            "nullable": true,
            "description": "Local tracking number provided by DHL eCommerce"
          },
          "alternate_tracking_number": {
            "type": "string",
            "nullable": true,
            "description": "Alternate tracking number provided by DHL eCommerce"
          },
          "leg_number": {
            "type": "integer",
            "minimum": 1,
            "description": "Sequential index of the different portions of the shipment's journey. If a shipment is passed to a new courier, it begins a new leg."
          },
          "handler": {
            "type": "string",
            "description": "The service that is handling the tracking process"
          },
          "tracking_state": {
            "type": "string",
            "description": "The current state of the tracking",
            "enum": [
              "created",
              "active",
              "pending",
              "completed",
              "overwritten_by_admin"
            ]
          }
        }
      },
      "ShipmentDocument": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "category": {
            "type": "string",
            "description": "Document category"
          },
          "required": {
            "type": "boolean",
            "description": "Whether the document is required"
          },
          "format": {
            "type": "string",
            "nullable": true,
            "description": "Document format"
          },
          "page_size": {
            "type": "string",
            "nullable": true,
            "description": "Page size"
          },
          "base64_encoded_strings": {
            "type": "array",
            "description": "Base64 encoded strings",
            "items": {
              "type": "string",
              "format": "byte"
            }
          },
          "url": {
            "type": "string",
            "nullable": true,
            "description": "URL of the document"
          },
          "message": {
            "type": "string",
            "description": "Warning message when the requested format is not supported for this document type (e.g. ZPL requested for a non-label document)"
          }
        }
      },
      "Rate": {
        "type": "object",
        "description": "Result of a quote request, including shipping & tax costs for a specific courier service.",
        "additionalProperties": false,
        "properties": {
          "courier_service": {
            "$ref": "#/components/schemas/RateCourierService"
          },
          "min_delivery_time": {
            "type": "integer",
            "description": "The fastest estimate of delivery time for this courier service, in days."
          },
          "max_delivery_time": {
            "type": "integer",
            "description": "The slowest estimate of delivery time for this courier service, in days."
          },
          "value_for_money_rank": {
            "type": "number",
            "description": "Where this courier service ranks among the other offered options. 1 indicates the best value for money."
          },
          "delivery_time_rank": {
            "type": "number",
            "description": "Where this courier service ranks among the other offered options, in minimum delivery time estimate; 1 indicates the fastest option."
          },
          "cost_rank": {
            "type": "number",
            "description": "Where this courier service ranks among the other offered options, in total price; 1 indicates the best value for money."
          },
          "currency": {
            "$ref": "#/components/schemas/Currency"
          },
          "shipment_charge": {
            "type": "number",
            "description": "Base cost of the courier service"
          },
          "fuel_surcharge": {
            "type": "number",
            "description": "A fee added by the courier when fuel costs are high"
          },
          "remote_area_surcharge": {
            "type": "number",
            "description": "Sum of the origin and destination base fees listed in `remote_area_surcharges`"
          },
          "remote_area_surcharges": {
            "description": "Origin and destination remote area surcharges",
            "type": "object",
            "additionalProperties": false,
            "nullable": true,
            "properties": {
              "origin": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "type": "string",
                    "example": "Pickup Area Surcharge"
                  },
                  "base": {
                    "type": "number"
                  }
                }
              },
              "destination": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "type": "string",
                    "example": "Delivery Area Surcharge"
                  },
                  "base": {
                    "type": "number"
                  }
                }
              }
            }
          },
          "other_surcharges": {
            "type": "object",
            "nullable": true,
            "description": "Other surcharges",
            "additionalProperties": false,
            "properties": {
              "total_fee": {
                "type": "number",
                "description": "Sum of the surcharge fees, in the currency specified for the shipment"
              },
              "details": {
                "type": "array",
                "description": "An array of individual surcharges being applied",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Surcharge name, in English, to be displayed to user",
                      "example": "Peak Surcharge"
                    },
                    "fee": {
                      "type": "number",
                      "description": "Surcharge fee in the currency of the shipment"
                    },
                    "origin_fee": {
                      "type": "number",
                      "description": "Surcharge fee in the currency of the shipment's origin country"
                    }
                  }
                }
              }
            }
          },
          "oversized_surcharge": {
            "type": "number",
            "description": "A fee added by the courier when parcels exceed a specified threshold size or weight"
          },
          "additional_services_surcharge": {
            "type": "number",
            "description": "A fee added by the courier when additional services are added (e.g. delivery confirmation)"
          },
          "residential_full_fee": {
            "type": "number",
            "description": "A fee added by the courier when the receiver is at a residential address"
          },
          "residential_discounted_fee": {
            "type": "number",
            "description": "A discounted fee added by the courier when the receiver is at a residential address"
          },
          "shipment_charge_total": {
            "type": "number",
            "description": "Subtotal of `shipment_charge`, `fuel_surcharge`, `residential_*_fee`, `remote_area_surcharge`, `additional_services_surcharge`, & `oversized_surcharge`"
          },
          "warehouse_handling_fee": {
            "type": "number",
            "description": "A fee added by the fulfillment service for managing warehouse operations"
          },
          "insurance_fee": {
            "type": "number",
            "description": "The cost of the insurance policy purchased for this shipment"
          },
          "sales_tax": {
            "type": "number",
            "description": "National government taxes, calculated as a portion of the purchase price"
          },
          "provincial_sales_tax": {
            "type": "number",
            "description": "State, province, or local government taxes, calculated as a portion of the purchase price"
          },
          "ddp_handling_fee": {
            "type": "number",
            "description": "A fee added by the courier when they pay import taxes and duties on the sender's behalf. Null is returned when there is an insufficient subscription tier for feature taxes and duties.",
            "nullable": true
          },
          "import_tax_charge": {
            "type": "number",
            "description": "Import tax charge. Null is returned when there is an insufficient subscription tier for feature taxes and duties.",
            "nullable": true
          },
          "import_tax_non_chargeable": {
            "type": "number",
            "description": "Import tax non-chargeable. Null is returned when there is an insufficient subscription tier for feature taxes and duties.",
            "nullable": true
          },
          "import_duty_charge": {
            "type": "number",
            "description": "Import duty amount collected upfront with the shipment (DDP only). `0` for DDU shipments where the buyer pays duty at customs. Null when the subscription lacks taxes and duties or when `calculate_tax_and_duties` is false.",
            "nullable": true
          },
          "total_charge": {
            "type": "number",
            "description": "The sum of shipping_charge and all applicable fees for this shipment"
          },
          "is_above_threshold": {
            "type": "boolean",
            "nullable": true,
            "description": "True if the purchase price exceeds the threshold set by the import country for customs charges. If `false`, `import_tax_charge`, `import_duty_charge`, `estimated_import_tax`, and `estimated_import_duty` should be zero."
          },
          "is_above_duty_threshold": {
            "type": "boolean",
            "nullable": true,
            "description": "True if the shipment value exceeds the import country's de minimis threshold for duty. Distinct from `is_above_threshold`, which covers the combined tax and duty threshold. May be `true` while `import_duty_charge` is `0` on DDU rates. Null when the subscription lacks taxes and duties or when `calculate_tax_and_duties` is false."
          },
          "import_duty_details": {
            "type": "array",
            "nullable": true,
            "description": "Per line-item duty calculation breakdown in the rate's `currency`, including HS codes used, fallback flags, rates applied, and amounts. On DDU rates, amounts align with `estimated_import_duty`. On DDP rates, amounts align with `import_duty_charge`. Present when a duty calculation was performed, including when the duty amount is zero (e.g. FTA preferential rate). Null when the subscription lacks taxes and duties or when `calculate_tax_and_duties` is false. Only returned on the top-level rate object, not within `rates_in_origin_currency`.",
            "items": {
              "$ref": "#/components/schemas/ImportDutyDetails"
            }
          },
          "incoterms": {
            "$ref": "#/components/schemas/Shipment/properties/incoterms"
          },
          "estimated_import_tax": {
            "type": "number",
            "description": "An estimate of import taxes that will be charged to the buyer when the shipment clears customs (only applicable for DDU incoterms). Null is returned when there is an insufficient subscription tier for feature taxes and duties.",
            "nullable": true
          },
          "estimated_import_duty": {
            "type": "number",
            "description": "An estimate of import duty that will be charged to the buyer when the shipment clears customs (only applicable for DDU incoterms). Null is returned when there is an insufficient subscription tier for feature taxes and duties.",
            "nullable": true
          },
          "minimum_pickup_fee": {
            "type": "number",
            "minimum": 0,
            "description": "The minimum fee applied for `paid_pickup` options, for this courier service"
          },
          "available_handover_options": {
            "type": "array",
            "description": "A list of one or more of `dropoff`, `free_pickup`, and `paid_pickup`",
            "items": {
              "type": "string"
            }
          },
          "tracking_rating": {
            "type": "number",
            "description": "A characterization of the level of detail provided by the courier's tracking data.\n  * -1 - No tracking number\n  * 0 - Infrequent tracking events\n  * 1 - Infrequent tracking events\n  * 2 - Tracking main milestones with delivery confirmation\n  * 3 - Tracking all steps of transit with delivery confirmation\n",
            "minimum": -1,
            "maximum": 3
          },
          "easyship_rating": {
            "type": "number",
            "minimum": 0,
            "maximum": 5,
            "description": "Average of customer ratings of this courier service; provided by Easyship users and their buyers."
          },
          "courier_remarks": {
            "type": "string",
            "nullable": true,
            "description": "Additional details relevant to choosing the appropriate courier service"
          },
          "payment_recipient": {
            "type": "string",
            "description": "Who collects payment for this shipment (and when)",
            "enum": [
              "Easyship",
              "EasyshipPayOnScan",
              "Courier"
            ]
          },
          "discount": {
            "$ref": "#/components/schemas/RateDiscount"
          },
          "rates_in_origin_currency": {
            "type": "object",
            "description": "Rates in origin currency",
            "additionalProperties": false,
            "properties": {
              "currency": {
                "$ref": "#/components/schemas/Currency"
              },
              "shipment_charge": {
                "$ref": "#/components/schemas/Rate/properties/shipment_charge"
              },
              "fuel_surcharge": {
                "$ref": "#/components/schemas/Rate/properties/fuel_surcharge"
              },
              "remote_area_surcharge": {
                "$ref": "#/components/schemas/Rate/properties/remote_area_surcharge"
              },
              "additional_services_surcharge": {
                "$ref": "#/components/schemas/Rate/properties/additional_services_surcharge"
              },
              "oversized_surcharge": {
                "$ref": "#/components/schemas/Rate/properties/oversized_surcharge"
              },
              "shipment_charge_total": {
                "$ref": "#/components/schemas/Rate/properties/shipment_charge_total"
              },
              "warehouse_handling_fee": {
                "$ref": "#/components/schemas/Rate/properties/warehouse_handling_fee"
              },
              "insurance_fee": {
                "$ref": "#/components/schemas/Rate/properties/insurance_fee"
              },
              "ddp_handling_fee": {
                "$ref": "#/components/schemas/Rate/properties/ddp_handling_fee"
              },
              "import_tax_charge": {
                "$ref": "#/components/schemas/Rate/properties/import_tax_charge"
              },
              "import_tax_non_chargeable": {
                "$ref": "#/components/schemas/Rate/properties/import_tax_non_chargeable"
              },
              "import_duty_charge": {
                "$ref": "#/components/schemas/Rate/properties/import_duty_charge"
              },
              "residential_discounted_fee": {
                "$ref": "#/components/schemas/Rate/properties/residential_discounted_fee"
              },
              "residential_full_fee": {
                "$ref": "#/components/schemas/Rate/properties/residential_full_fee"
              },
              "total_charge": {
                "$ref": "#/components/schemas/Rate/properties/total_charge"
              },
              "estimated_import_tax": {
                "$ref": "#/components/schemas/Rate/properties/estimated_import_tax"
              },
              "estimated_import_duty": {
                "$ref": "#/components/schemas/Rate/properties/estimated_import_duty"
              },
              "sales_tax": {
                "$ref": "#/components/schemas/Rate/properties/sales_tax"
              },
              "provincial_sales_tax": {
                "$ref": "#/components/schemas/Rate/properties/provincial_sales_tax"
              },
              "minimum_pickup_fee": {
                "$ref": "#/components/schemas/Rate/properties/minimum_pickup_fee"
              }
            }
          },
          "description": {
            "type": "string",
            "description": "Details that the user should know when preparing to hand over the shipment to the courier (e.g. pick-up or drop-off)"
          },
          "full_description": {
            "type": "string",
            "description": "Full description"
          }
        }
      },
      "RateDiscount": {
        "type": "object",
        "description": "A discount applied to the rate. Amount and percentage should not both be defined at the same time",
        "nullable": true,
        "additionalProperties": false,
        "properties": {
          "amount": {
            "type": "number",
            "description": "A fixed amount to discount from the price"
          },
          "origin_amount": {
            "type": "number",
            "description": "Discount origin amount"
          }
        }
      },
      "RateCourierService": {
        "type": "object",
        "description": "Courier Service for Rate",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "unique identifier for a courier service"
          },
          "name": {
            "type": "string",
            "description": "Human-readable name for the courier service used in this rate."
          },
          "courier_id": {
            "type": "string",
            "format": "uuid",
            "description": "The courier ID that the current courier service is associated with"
          },
          "umbrella_name": {
            "type": "string",
            "description": "Human-readable name for the courier company that offers this service."
          },
          "logo": {
            "$ref": "#/components/schemas/CourierService/properties/logo_url"
          },
          "easyship_courier_service": {
            "type": "boolean",
            "description": "Whether the Courier Service belongs to Easyship or not.",
            "nullable": true
          },
          "icon": {
            "$ref": "#/components/schemas/CourierService/properties/courier_icon_url"
          }
        }
      },
      "Shipment": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "easyship_shipment_id": {
            "type": "string",
            "pattern": "^ES\\w{2}\\d{7,}$",
            "description": "Readable identifier prefixed with ES (Easyship) and destination country code"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "When the shipment record was created in the Easyship system"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "When the shipment record was most recently modified"
          },
          "label_paid_at": {
            "type": "string",
            "nullable": true,
            "format": "date-time",
            "description": "When Easyship was paid for the shipment"
          },
          "label_generated_at": {
            "type": "string",
            "nullable": true,
            "format": "date-time",
            "description": "When label was generated"
          },
          "origin_address": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Address"
              },
              {
                "description": "Origin address"
              }
            ]
          },
          "sender_address": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Address"
              },
              {
                "description": "Sender address"
              }
            ]
          },
          "return_address": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Address"
              },
              {
                "description": "Return address"
              }
            ]
          },
          "destination_address": {
            "$ref": "#/components/schemas/DestinationAddress"
          },
          "order_data": {
            "type": "object",
            "description": "Free-form data related to the eCommerce platform",
            "additionalProperties": false,
            "properties": {
              "platform_name": {
                "type": "string",
                "nullable": true,
                "description": "A display-ready sales channel or platform name",
                "maximum": 200
              },
              "platform_order_number": {
                "type": "string",
                "nullable": true,
                "description": "Order number that was either copied from an order synced from an ecommerce platform or manually edited in Easyship's order from",
                "maximum": 200
              },
              "order_created_at": {
                "type": "string",
                "nullable": true,
                "format": "date-time",
                "description": "When the order was created (e.g. in an online store connected to Easyship)"
              },
              "order_tag_list": {
                "type": "array",
                "description": "Tags that have been assigned to this shipment, either as an order on its e-commerce store or within the Easyship app",
                "items": {
                  "type": "string"
                },
                "maxItems": 500
              },
              "seller_notes": {
                "type": "string",
                "nullable": true,
                "description": "Text added by the merchant. Will not be shown to the receiver."
              },
              "buyer_notes": {
                "type": "string",
                "nullable": true,
                "description": "Text added by the buyer during order checkout. Will be displayed on the packing slip."
              },
              "buyer_selected_courier_name": {
                "type": "string",
                "nullable": true,
                "description": "Courier name for shipping rule condition `match_buyer_selected_courier_name`. If the name matches, actions of this shipping rule would apply to the current shipment."
              }
            }
          },
          "last_failure_http_response_messages": {
            "type": "array",
            "description": "This attribute stores the HTTP response of the most recent unsuccessful attempt to interact with an external service, such as a failed label creation.",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "code": {
                  "type": "string",
                  "nullable": true
                },
                "content": {
                  "type": "string",
                  "nullable": true
                }
              }
            }
          },
          "metadata": {
            "type": "object",
            "description": "Set of key-value pairs that you can attach to a shipment. This can be useful for storing additional information about the object in a structured format"
          },
          "set_as_residential": {
            "type": "boolean",
            "description": "Indicates whether or not the user believes the receiver address qualifies for a residential surcharge."
          },
          "consignee_tax_id": {
            "type": "string",
            "nullable": true,
            "description": "Tax ID for the receiver. Maybe helpful or required for customs clearance, depending on the destination country."
          },
          "eei_reference": {
            "type": "string",
            "nullable": true,
            "description": "References data (Electronic Export Information) filed through one of the systems for goods shipped from the U.S.\nto a foreign country. Currently only used for FedEx shipments. The following possibilities may or may not qualify:\n  * An Automated Export System (AES) citation\n  * A Foreign Trade Regulations (FTR) exemption number\n  * An International Traffic in Arms Reduction (ITAR) exemption code\n  * A US Department of Commerce export license number"
          },
          "regulatory_identifiers": {
            "type": "object",
            "description": "Seller's identifiers for various tax, import and export regulations.",
            "additionalProperties": false,
            "properties": {
              "eori": {
                "type": "string",
                "nullable": true,
                "description": "Economic Operators Registration and Identification (EORI) number."
              },
              "ioss": {
                "type": "string",
                "nullable": true,
                "description": "Import One Stop Shop (IOSS) number."
              },
              "vat_number": {
                "type": "string",
                "nullable": true,
                "description": "Value-Added Tax (VAT) number."
              }
            }
          },
          "buyer_regulatory_identifiers": {
            "type": "object",
            "description": "Buyer's identifiers for various tax, import and export regulations.",
            "additionalProperties": false,
            "properties": {
              "ein": {
                "type": "string",
                "nullable": true,
                "description": "Employer Identification Number (EIN) number."
              },
              "vat_number": {
                "type": "string",
                "nullable": true,
                "description": "Value-Added Tax (VAT) number."
              },
              "ssn": {
                "type": "string",
                "nullable": true,
                "description": "Social Security Number (SSN) number."
              }
            }
          },
          "return": {
            "type": "boolean",
            "description": "Whether the shipment is a return shipment or not"
          },
          "incoterms": {
            "description": "Terms of Sale\nDDP: Seller pays all import duties/taxes.\nDDU: Buyer pays all import duties/taxes.\nnull: No incoterm specified; defaults to DDU.\n",
            "type": "string",
            "enum": [
              "DDU",
              "DDP",
              null
            ],
            "default": "DDU",
            "nullable": true
          },
          "insurance": {
            "type": "object",
            "description": "Insurance",
            "nullable": true,
            "additionalProperties": false,
            "properties": {
              "is_insured": {
                "type": "boolean",
                "description": "Indicates if premium insurance has been purchased for this shipment (either by the merchant or buyer).\nBasic, courier-supplied coverage is not applicable.",
                "default": false
              },
              "insured_amount": {
                "type": "number",
                "description": "Amount to insure with Easyship's insurance provider. If not specified, we'll use the sum of customs values and shipping cost."
              },
              "insured_currency": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Currency"
                  },
                  {
                    "description": "Insurance currency. ISO-4217 three-letter alphabetic currency code (e.g. USD, EUR, GBP). If not specified, we will use the currency of the account country."
                  }
                ]
              }
            }
          },
          "parcels": {
            "type": "array",
            "description": "Parcels",
            "items": {
              "$ref": "#/components/schemas/Parcel"
            }
          },
          "total_customs_value": {
            "type": "number",
            "minimum": 0,
            "description": "Sum of the value assigned to all shipment line items"
          },
          "total_actual_weight": {
            "type": "number",
            "description": "Sum of the specified weights of all *parcels* in the shipment (`parcel.actual_weight`), as measured on a scale in units specified by `company.weight_unit`."
          },
          "shipment_state": {
            "type": "string",
            "description": "The state of the shipment record within the Easyship system",
            "default": "created",
            "nullable": false,
            "enum": [
              "created",
              "draft",
              "calculating",
              "cancelling",
              "cancelled",
              "discarded",
              "deleted"
            ]
          },
          "pickup_state": {
            "type": "string",
            "default": "not_requested",
            "nullable": false,
            "description": "The state of the hand-over from shipper to courier. `pending_handover` applies only to eFulfillment companies."
          },
          "delivery_state": {
            "type": "string",
            "default": "not_created",
            "nullable": false,
            "description": "The state of the hand-over from courier to receiver.",
            "enum": [
              "not_created",
              "pending",
              "info_received",
              "in_transit_to_customer",
              "out_for_delivery",
              "delivered",
              "failed_attempt",
              "exception",
              "expired",
              "lost_by_courier",
              "returned_to_shipper"
            ]
          },
          "label_state": {
            "type": "string",
            "default": "not_created",
            "nullable": false,
            "description": "The state of the label(s) meant to be printed and attached to this shipment's parcels",
            "enum": [
              "not_created",
              "pending",
              "generating",
              "generated",
              "printed",
              "failed",
              "technical_failed",
              "reported",
              "voided",
              "void_failed"
            ]
          },
          "warehouse_state": {
            "type": "string",
            "default": "none",
            "nullable": false,
            "description": "The state of the fulfillment process within the warehouse",
            "enum": [
              "none",
              "pending",
              "created",
              "failed",
              "packed",
              "cancelled",
              "cancelled_no_stock",
              "backorder_no_stock",
              "shipped",
              "returned",
              "awaiting_dispatch"
            ]
          },
          "warehouse_code": {
            "type": "string",
            "description": "Warehouse code (warehouse/eFulfilment only)"
          },
          "original_easyship_shipment_id": {
            "$ref": "#/components/schemas/Shipment/properties/easyship_shipment_id"
          },
          "trackings": {
            "type": "array",
            "description": "Sources of tracking data for this shipment",
            "items": {
              "$ref": "#/components/schemas/ShipmentTracking"
            }
          },
          "tracking_page_url": {
            "type": "string",
            "description": "Tracking page URL"
          },
          "shipping_documents": {
            "type": "array",
            "description": "Shipping documents",
            "items": {
              "$ref": "#/components/schemas/ShipmentDocument"
            }
          },
          "currency": {
            "$ref": "#/components/schemas/Currency"
          },
          "courier_service": {
            "type": "object",
            "nullable": true,
            "description": "Selected courier service for this shipment. May be null if no service has been selected yet, or if the shipment was created without selecting a service.\nMore information about the [courier service](https://developers.easyship.com/reference/courier_services_index)",
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "name": {
                "type": "string"
              },
              "courier_id": {
                "type": "string",
                "format": "uuid",
                "description": "The courier ID that the current courier service is associated with"
              },
              "umbrella_name": {
                "type": "string",
                "description": "Human-readable name for the courier company that offers this service."
              },
              "easyship_courier_service": {
                "$ref": "#/components/schemas/CourierService/properties/easyship_courier_service"
              }
            }
          },
          "rates": {
            "type": "array",
            "description": "Array of available courier services for this shipment, along with the rates charged. Courier services are excluded if the shipment's contents or destination do not meet each service's eligibility requirements.",
            "items": {
              "$ref": "#/components/schemas/Rate"
            }
          },
          "shipping_settings": {
            "type": "object",
            "description": "Shipping settings",
            "additionalProperties": false,
            "properties": {
              "b13a_filing": {
                "type": "object",
                "description": "B13A filing (currently available only for FedEx)",
                "additionalProperties": false,
                "nullable": true,
                "properties": {
                  "option": {
                    "type": "string",
                    "enum": [
                      "not_required",
                      "fedex_to_stamp",
                      "filed_electronically",
                      "manually_attached",
                      "summary_reporting"
                    ]
                  },
                  "option_export_compliance_statement": {
                    "type": "string",
                    "nullable": true,
                    "description": "Export compliance statement"
                  },
                  "permit_number": {
                    "type": "string",
                    "nullable": true,
                    "description": "Permit number"
                  }
                }
              },
              "label_customization_fields": {
                "anyOf": [
                  {
                    "$ref": "#/components/schemas/ShipmentCreate/properties/shipping_settings/properties/label_customization_fields"
                  },
                  {
                    "type": "array",
                    "minItems": 0
                  }
                ]
              },
              "scheduled_ship_date": {
                "$ref": "#/components/schemas/ShipmentCreate/properties/shipping_settings/properties/scheduled_ship_date"
              }
            }
          }
        }
      },
      "ShipmentCreate": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "parcels"
        ],
        "properties": {
          "origin_address": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Address"
              },
              {
                "description": "Origin Address",
                "required": [
                  "line_1",
                  "city",
                  "company_name",
                  "contact_name",
                  "contact_phone",
                  "contact_email"
                ]
              }
            ]
          },
          "origin_address_id": {
            "type": "string",
            "format": "uuid",
            "description": "ID of origin address. Required if the `origin_address` object is not provided. If provided, the origin address will be ignored."
          },
          "sender_address": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Address"
              },
              {
                "description": "Sender Address. Only applies if the courier allows a different address to be displayed on the label. If not specified, the origin address is used by default.",
                "required": [
                  "line_1",
                  "city",
                  "company_name",
                  "contact_name",
                  "contact_phone",
                  "contact_email"
                ]
              }
            ]
          },
          "sender_address_id": {
            "type": "string",
            "format": "uuid",
            "description": "ID of sender address. Required if the `sender_address` object is not provided."
          },
          "return_address": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Address"
              },
              {
                "description": "Return Address. If not specified, the origin address is used by default.",
                "required": [
                  "line_1",
                  "city",
                  "company_name",
                  "contact_name",
                  "contact_phone",
                  "contact_email"
                ]
              }
            ]
          },
          "return_address_id": {
            "type": "string",
            "format": "uuid",
            "description": "ID of return address. Required if the `return_address` object is not provided."
          },
          "destination_address": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DestinationAddress"
              },
              {
                "required": [
                  "line_1",
                  "city",
                  "contact_name",
                  "contact_email",
                  "contact_phone"
                ]
              }
            ]
          },
          "return": {
            "type": "boolean",
            "description": "Set the shipment as a return shipment"
          },
          "metadata": {
            "$ref": "#/components/schemas/Shipment/properties/metadata"
          },
          "set_as_residential": {
            "type": "boolean",
            "description": "US addresses will be automatically validated when not specified. If specified, the validation will be bypassed."
          },
          "consignee_tax_id": {
            "type": "string",
            "description": "The consignee's tax identification number or EIN. This is required for customs clearance when shipping to certain countries, such as China and Brazil."
          },
          "eei_reference": {
            "type": "string",
            "description": "The Electronic Export Identifier (EEI). This is required when shipping goods over USD2500 in value (Applies to US-outbound shipments only)."
          },
          "regulatory_identifiers": {
            "$ref": "#/components/schemas/Shipment/properties/regulatory_identifiers"
          },
          "buyer_regulatory_identifiers": {
            "$ref": "#/components/schemas/Shipment/properties/buyer_regulatory_identifiers"
          },
          "incoterms": {
            "$ref": "#/components/schemas/Shipment/properties/incoterms"
          },
          "insurance": {
            "$ref": "#/components/schemas/Shipment/properties/insurance"
          },
          "order_data": {
            "$ref": "#/components/schemas/Shipment/properties/order_data"
          },
          "courier_settings": {
            "type": "object",
            "properties": {
              "courier_service_id": {
                "type": "string",
                "description": "Select a specific courier service to create the shipment with, only the rates for this courier will be returned. If provided, all other courier lookup parameters (`courier_umbrella`, `courier_service_name`, `courier_account_number`) will be ignored.",
                "nullable": true
              },
              "courier_umbrella": {
                "type": "string",
                "nullable": true,
                "description": "(support LYOC couriers only) The umbrella name of the courier service (e.g., \"FedEx\"). This field is optional; however, if provided, `courier_service_name` and `courier_account_number` must also be included."
              },
              "courier_service_name": {
                "type": "string",
                "nullable": true,
                "description": "(support LYOC couriers only) The official name of the courier service (e.g., \"FedEx International Priority®\"). This field is optional; however, if provided, `courier_umbrella` and `courier_account_number` must also be included."
              },
              "courier_account_number": {
                "type": "string",
                "nullable": true,
                "description": "(support LYOC couriers only) The account number of the courier account. This field is optional; however, if provided, `courier_umbrella` and `courier_service_name` must also be included."
              },
              "allow_fallback": {
                "type": "boolean",
                "default": false,
                "description": "If `courier_service_id` is provided but the courier can’t be selected, allow the shipment to be created and the next best rate to be selected. Default: `false`. When false and rates for the `courier_service_id` can't be found, an error will be raised and the shipment won’t be created."
              },
              "apply_shipping_rules": {
                "type": "boolean",
                "default": true,
                "description": "Apply any [shipping rules](https://support.easyship.com/hc/en-us/articles/115003580152-Automate-Shipping-Process-Shipping-Rules) created on the Easyship dashboard (Default: `true`)"
              },
              "list_unavailable_services": {
                "type": "boolean",
                "description": "Setting this option will return detailed information with reasons for each courier in the response."
              }
            }
          },
          "shipping_settings": {
            "type": "object",
            "properties": {
              "additional_services": {
                "type": "object",
                "description": "Configuration for additional services",
                "additionalProperties": false,
                "properties": {
                  "delivery_confirmation": {
                    "description": "Currently officially supported only for selected customers. **Subject to change.**",
                    "type": "string",
                    "enum": [
                      "ups_delivery_confirmation_adult_signature_required",
                      "ups_delivery_confirmation_signature_required",
                      "dpd_uk_signature_required",
                      "dpd_uk_proof_of_identity",
                      "dpd_uk_proof_of_age",
                      "dpd_uk_pin_required"
                    ]
                  },
                  "qr_code": {
                    "type": "string",
                    "description": "Generate QR code when generating label. If a courier does not support it, label will be generated without the QR code. Currently officially supported only for USPS courier. When set to `qr_code`, both the QR code and the original label are returned. `qr_code_with_label` is deprecated and no longer supported; if provided, it silently falls back to `qr_code`. Label customization is not available for USPS. **Subject to change.**",
                    "default": "none",
                    "enum": [
                      "qr_code",
                      "qr_code_with_label",
                      "none"
                    ]
                  }
                }
              },
              "units": {
                "$ref": "#/components/schemas/Units"
              },
              "buy_label": {
                "type": "boolean",
                "default": false,
                "description": "Create a shipment and buy the label in a single API call instead of two. Default: `false`."
              },
              "buy_label_synchronous": {
                "type": "boolean",
                "default": false,
                "description": "Generate a label synchronously. Returns a label in the response. Default: `false`."
              },
              "b13a_filing": {
                "$ref": "#/components/schemas/Shipment/properties/shipping_settings/properties/b13a_filing"
              },
              "printing_options": {
                "type": "object",
                "description": "Specify the format and page sizes of the shipping documents. This will only be taken into account if buy_label_synchronous is `true`.",
                "properties": {
                  "format": {
                    "type": "string",
                    "description": "Options: `png`, `pdf`, `url`, `zpl` (Default: `png`). Note: `zpl` applies to label documents only; `commercial_invoice` and `packing_slip` will return empty arrays when `zpl` is requested.",
                    "default": "png",
                    "enum": [
                      "png",
                      "pdf",
                      "url",
                      "zpl"
                    ]
                  },
                  "label": {
                    "type": "string",
                    "description": "Label page size. Options: `4x6` / `A4` / `A5` / `letter` (Default: `4x6`)",
                    "default": "4x6",
                    "enum": [
                      "4x6",
                      "A4",
                      "A5",
                      "letter"
                    ]
                  },
                  "commercial_invoice": {
                    "type": "string",
                    "description": "Commercial invoice page size. Options: `4x6` / `A4` / `letter` (Default: `A4`)",
                    "default": "A4",
                    "enum": [
                      "4x6",
                      "A4",
                      "letter"
                    ]
                  },
                  "packing_slip": {
                    "type": "string",
                    "description": "Packing slip page size. Options: `4x6` / `A4` / `letter` (Default: `4x6`)",
                    "default": "4x6",
                    "enum": [
                      "4x6",
                      "A4",
                      "letter",
                      "none"
                    ]
                  },
                  "remarks": {
                    "type": "string",
                    "maxLength": 70,
                    "description": "Customized commercial invoice remarks for current shipment. It has higher priority than remarks from company settings."
                  }
                }
              },
              "label_customization_fields": {
                "description": "Label customization fields for the shipment. This is only applicable for specific couriers. For detailed explanation, please refer to [Label Customization Messages](https://developers.easyship.com/page/label-customization-messages).",
                "type": "array",
                "minItems": 1,
                "items": {
                  "type": "object",
                  "required": [
                    "value"
                  ],
                  "properties": {
                    "code": {
                      "description": "Courier accepted code, see [Label Customization Messages](https://developers.easyship.com/page/label-customization-messages).",
                      "type": "string"
                    },
                    "value": {
                      "type": "string",
                      "description": "Content to display on the label, see [Label Customization Messages](https://developers.easyship.com/page/label-customization-messages)."
                    },
                    "convert_to_barcode": {
                      "description": "Identifying for converting value to barcode, specific application logic applies. See [Label Customization Messages](https://developers.easyship.com/page/label-customization-messages)."
                    }
                  }
                }
              },
              "scheduled_ship_date": {
                "type": "string",
                "format": "date",
                "nullable": true,
                "example": "2026-10-03",
                "description": "Planned ship date as a calendar date (YYYY-MM-DD). This is a planning/note value with no timezone; the date is stored as sent. If omitted on create, Easyship sets a default from the local time of the origin address (today, or tomorrow after 21:00 in that timezone).\n"
              }
            }
          },
          "parcels": {
            "type": "array",
            "description": "Parcels",
            "items": {
              "$ref": "#/components/schemas/ParcelCreate"
            }
          }
        }
      },
      "ParcelCreate": {
        "type": "object",
        "description": "Parcel",
        "additionalProperties": false,
        "properties": {
          "total_actual_weight": {
            "type": "number",
            "description": "Total weight of the shipment, including the box weight. If you provide the total weight of the shipment, then the weight for items can be optional."
          },
          "box": {
            "type": "object",
            "nullable": true,
            "description": "The box dimensions for the shipment. If the box dimensions are provided, then dimensions for items are optional.",
            "additionalProperties": false,
            "properties": {
              "slug": {
                "type": "string",
                "nullable": true,
                "description": "Courier or Custom Box Slug. Use the [Boxes API](https://developers.easyship.com/reference/boxes_index) to retrieve a list of available boxes."
              },
              "length": {
                "type": "number",
                "description": "Length of the box"
              },
              "width": {
                "type": "number",
                "description": "Width of the box"
              },
              "height": {
                "type": "number",
                "description": "Height of the box"
              }
            }
          },
          "items": {
            "type": "array",
            "description": "Array of all shipment items",
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/ParcelItemCreate"
                },
                {
                  "$ref": "#/components/schemas/ParcelProductItemCreate"
                },
                {
                  "$ref": "#/components/schemas/ParcelReturnItemCreate"
                }
              ]
            },
            "minItems": 1,
            "maxItems": 200
          }
        }
      },
      "ParcelItemCreate": {
        "type": "object",
        "description": "A line item in a shipment manifest; may be multiple physical objects.",
        "additionalProperties": false,
        "required": [
          "description",
          "declared_currency",
          "declared_customs_value"
        ],
        "properties": {
          "description": {
            "type": "string",
            "description": "Description of the item",
            "maximum": 200
          },
          "category": {
            "type": "string",
            "nullable": true,
            "description": "Item category name or slug. Required if hs_code is not provided. Use the [Item Categories API](https://developers.easyship.com/reference/item_categories_index) to retrieve a list of available item categories.",
            "maximum": 200
          },
          "hs_code": {
            "type": "string",
            "description": "HS Code of the item. Required if category is not provided."
          },
          "sku": {
            "type": "string",
            "description": "Item Stock Keeping Unit (SKU) as listed in your store.",
            "maximum": 100
          },
          "platform_product_id": {
            "$ref": "#/components/schemas/ParcelItem/properties/platform_product_id"
          },
          "manufacturer_part_number": {
            "$ref": "#/components/schemas/ParcelItem/properties/manufacturer_part_number"
          },
          "global_trade_item_number": {
            "$ref": "#/components/schemas/ParcelItem/properties/global_trade_item_number"
          },
          "contains_battery_pi966": {
            "$ref": "#/components/schemas/ParcelItem/properties/contains_battery_pi966"
          },
          "contains_battery_pi967": {
            "$ref": "#/components/schemas/ParcelItem/properties/contains_battery_pi967"
          },
          "contains_liquids": {
            "$ref": "#/components/schemas/ParcelItem/properties/contains_liquids"
          },
          "origin_country_alpha2": {
            "$ref": "#/components/schemas/CountryAlpha2Nullable"
          },
          "quantity": {
            "type": "integer",
            "description": "Item quantity",
            "default": 1
          },
          "dimensions": {
            "type": "object",
            "description": "Dimensions of the item",
            "additionalProperties": false,
            "properties": {
              "length": {
                "type": "number",
                "description": "Item length; Optional if the Box dimensions are provided."
              },
              "width": {
                "type": "number",
                "description": "Item width; Optional if the Box dimensions are provided."
              },
              "height": {
                "type": "number",
                "description": "Item height; Optional if the Box dimensions are provided."
              }
            }
          },
          "actual_weight": {
            "type": "number",
            "description": "Item actual weight in `kg`. Must be greater than 0.\nOptional when `total_actual_weight` is provided.\n**Required when the shipping rule action `split_parcels_by_sku` is enabled, regardless of the existence of `total_actual_weight`**\n"
          },
          "declared_currency": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Currency"
              },
              {
                "description": "Item currency. ISO-4217 three-letter alphabetic currency code (e.g. USD, EUR, GBP)."
              }
            ]
          },
          "declared_customs_value": {
            "type": "number",
            "description": "Item customs value, must be greater than 0 unless category is `documents`. Please note that this value refers to the unit rather than the total."
          },
          "cpsc_compliance": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CpscComplianceCreate"
              }
            ],
            "description": "CPSC compliance data for this specific item. Optional -- only relevant for items on regulated HTS codes/categories shipping to the US.\n\n**Important: fields are scoped to `coc_type`.** Only the fields relevant to the current (or newly submitted) `coc_type` are ever persisted:\n  - `registered`: certifier_identifier, version_identifier, product_identifier_type\n  - `unregistered`: citation_code, certifier_identity, manufacturing_detail, manufacturing_date, testing_detail, laboratory, records_custodian, product_identifier_type\n  - `exempted`: disclaim_code\n\nAny field outside the resulting `coc_type`'s group is silently cleared to `null`, whether it was left over from a previous update or submitted in the same request. This happens without an error, so a field you send may come back `null` in the response if it doesn't match the `coc_type` you set (or the item's existing `coc_type`, if you didn't change it). If you are switching `coc_type`, submit `coc_type` together with the new path's fields in the same request.\n"
          }
        }
      },
      "ParcelProductItemCreate": {
        "type": "object",
        "description": "A line item in a shipment manifest; may be multiple physical objects.",
        "additionalProperties": false,
        "properties": {
          "product": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid",
                "description": "Product ID. Required if the `sku` is not provided."
              },
              "sku": {
                "type": "string",
                "description": "Product SKU. Required if the `id` is not provided."
              }
            }
          },
          "quantity": {
            "$ref": "#/components/schemas/ParcelItemCreate/properties/quantity"
          },
          "declared_currency": {
            "$ref": "#/components/schemas/ParcelItemCreate/properties/declared_currency"
          },
          "declared_customs_value": {
            "$ref": "#/components/schemas/ParcelItemCreate/properties/declared_customs_value"
          },
          "cpsc_compliance": {
            "$ref": "#/components/schemas/ParcelItemCreate/properties/cpsc_compliance"
          }
        }
      },
      "CpscCompliance": {
        "type": "object",
        "additionalProperties": false,
        "nullable": true,
        "description": "CPSC (Consumer Product Safety Commission) compliance data stored on this product. Required for certain regulated products (e.g. children's products, electronics, furniture, toys) shipped to the US from 8 July 2026.\n\n**Note:** fields are scoped to `coc_type` -- only fields relevant to the current path are ever non-null; see `coc_type`'s description below.\n",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "CPSC compliance record ID"
          },
          "coc_type": {
            "type": "string",
            "enum": [
              "registered",
              "unregistered",
              "exempted"
            ],
            "nullable": true,
            "description": "Defines the Certificate of Conformity (CoC) path. Your selection determines which fields are active (fields outside the selected group evaluate to `null`):\n  - `registered`: certifier_identifier, version_identifier, product_identifier_type\n  - `unregistered`: citation_code, certifier_identity, manufacturing_detail, manufacturing_date, testing_detail, laboratory, records_custodian, product_identifier_type\n  - `exempted`: disclaim_code\n\n**Note on updates:** Changing the `coc_type` automatically clears all fields from the previous path. You must send the fields for the new path in the same request.\n"
          },
          "certifier_identifier": {
            "type": "string",
            "nullable": true,
            "description": "CPSC Product Registry account ID. Applies to the registered path."
          },
          "version_identifier": {
            "type": "string",
            "nullable": true,
            "description": "CPSC Product Registry version ID. Applies to the registered path."
          },
          "citation_code": {
            "type": "string",
            "nullable": true,
            "description": "Applicable CPSC rule citation, e.g. \"16 CFR 1500.3\". Applies to the unregistered path."
          },
          "certifier_identity": {
            "type": "string",
            "nullable": true,
            "description": "Name and contact of the certifying entity. Applies to the unregistered path."
          },
          "manufacturing_detail": {
            "type": "string",
            "nullable": true,
            "description": "Place of manufacture. Applies to the unregistered path."
          },
          "manufacturing_date": {
            "type": "string",
            "format": "date",
            "nullable": true,
            "description": "Date of manufacture. Applies to the unregistered path."
          },
          "testing_detail": {
            "type": "string",
            "nullable": true,
            "description": "Description of testing performed. Applies to the unregistered path."
          },
          "laboratory": {
            "type": "string",
            "nullable": true,
            "description": "Testing laboratory name. Applies to the unregistered path."
          },
          "records_custodian": {
            "type": "string",
            "nullable": true,
            "description": "Records-keeper contact. Applies to the unregistered path."
          },
          "product_identifier_type": {
            "type": "string",
            "enum": [
              "sku",
              "gtin"
            ],
            "nullable": true,
            "description": "Whether product_identifier is a SKU or a GTIN. Applies to the registered and unregistered paths."
          },
          "product_identifier": {
            "type": "string",
            "nullable": true,
            "description": "Read-only. The product's SKU or GTIN value, derived from the product record according to product_identifier_type."
          },
          "disclaim_code": {
            "type": "string",
            "nullable": true,
            "description": "Exemption/disclaim basis code. Applies to the exempted path."
          }
        }
      },
      "CpscComplianceCreate": {
        "type": "object",
        "additionalProperties": false,
        "nullable": true,
        "description": "CPSC compliance data to store on this product. All fields are optional -- partial data is accepted and does not block the product from being saved.\n\n**Important: fields are scoped to `coc_type`.** Only the fields relevant to the current (or newly submitted) `coc_type` are ever persisted:\n  - `registered`: certifier_identifier, version_identifier, product_identifier_type\n  - `unregistered`: citation_code, certifier_identity, manufacturing_detail, manufacturing_date, testing_detail, laboratory, records_custodian, product_identifier_type\n  - `exempted`: disclaim_code\n\nAny field outside the resulting `coc_type`'s group is silently cleared to `null`, whether it was left over from a previous update or submitted in the same request. This happens without an error, so a field you send may come back `null` in the response if it doesn't match the `coc_type` you set (or the product's existing `coc_type`, if you didn't change it). If you are switching `coc_type`, submit `coc_type` together with the new path's fields in the same request.\n",
        "properties": {
          "coc_type": {
            "$ref": "#/components/schemas/CpscCompliance/properties/coc_type"
          },
          "certifier_identifier": {
            "$ref": "#/components/schemas/CpscCompliance/properties/certifier_identifier"
          },
          "version_identifier": {
            "$ref": "#/components/schemas/CpscCompliance/properties/version_identifier"
          },
          "citation_code": {
            "$ref": "#/components/schemas/CpscCompliance/properties/citation_code"
          },
          "certifier_identity": {
            "$ref": "#/components/schemas/CpscCompliance/properties/certifier_identity"
          },
          "manufacturing_detail": {
            "$ref": "#/components/schemas/CpscCompliance/properties/manufacturing_detail"
          },
          "manufacturing_date": {
            "$ref": "#/components/schemas/CpscCompliance/properties/manufacturing_date"
          },
          "testing_detail": {
            "$ref": "#/components/schemas/CpscCompliance/properties/testing_detail"
          },
          "laboratory": {
            "$ref": "#/components/schemas/CpscCompliance/properties/laboratory"
          },
          "records_custodian": {
            "$ref": "#/components/schemas/CpscCompliance/properties/records_custodian"
          },
          "product_identifier_type": {
            "$ref": "#/components/schemas/CpscCompliance/properties/product_identifier_type"
          },
          "disclaim_code": {
            "$ref": "#/components/schemas/CpscCompliance/properties/disclaim_code"
          }
        }
      },
      "Units": {
        "type": "object",
        "description": "Units",
        "additionalProperties": false,
        "properties": {
          "weight": {
            "type": "string",
            "description": "Unit of weight values provided. Options: `kg` / `g` / `lb` / `oz` (Default: `kg`). Unit of values in the response will be in `kg`.",
            "default": "kg",
            "enum": [
              "kg",
              "g",
              "lb",
              "oz"
            ]
          },
          "dimensions": {
            "type": "string",
            "description": "Unit of dimension values provided. Options: `cm` / `in` (Default: `cm`) Unit of values in the response will be in `cm`.",
            "default": "cm",
            "enum": [
              "cm",
              "in"
            ]
          }
        }
      },
      "UnavailableCouriers": {
        "type": "array",
        "items": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "id": {
              "type": "string",
              "format": "uuid",
              "description": "unique identifier for a courier service"
            },
            "name": {
              "type": "string",
              "description": "Unavailable courier name"
            },
            "message": {
              "type": "string",
              "description": "Unavailable reason"
            }
          }
        }
      },
      "ImportDutyAdditionalRate": {
        "type": "object",
        "description": "An additional duty surcharge applied on top of the base duty rate.",
        "additionalProperties": false,
        "properties": {
          "description": {
            "type": "string",
            "nullable": true,
            "description": "Description of the additional duty surcharge."
          },
          "rate": {
            "type": "number",
            "nullable": true,
            "description": "Additional duty rate as a decimal (e.g. `0.025` = 2.5%)."
          },
          "amount": {
            "type": "number",
            "nullable": true,
            "description": "Computed additional duty amount for this surcharge in the response currency."
          }
        }
      },
      "ImportDutyDetails": {
        "type": "object",
        "description": "Duty calculation details for a line item, including HS code fallback and rate breakdown.",
        "additionalProperties": false,
        "properties": {
          "hs_code_provided": {
            "type": "string",
            "nullable": true,
            "description": "Raw HS code as provided in the request, before normalisation or fallback.",
            "example": "42029100"
          },
          "hs_code_applied": {
            "type": "string",
            "nullable": true,
            "description": "HS code used to determine the duty rate after normalising to 10 digits and applying fallback, if any.",
            "example": "4202910010"
          },
          "subheading": {
            "type": "boolean",
            "nullable": true,
            "description": "True if a shorter parent subheading was used to determine the duty rate because no record existed for the full code."
          },
          "duty_origin_country_id_provided": {
            "type": "integer",
            "nullable": true,
            "description": "Country of origin ID explicitly provided on the item. Null when COO was not provided and fell back to the shipment origin."
          },
          "duty_origin_country_id_applied": {
            "type": "integer",
            "nullable": true,
            "description": "Country of origin ID actually used to determine the duty rate (either provided or the shipment origin fallback)."
          },
          "duty_calculation_method": {
            "type": "string",
            "nullable": true,
            "description": "Customs valuation method used for this destination.",
            "enum": [
              "CIF",
              "FOB"
            ]
          },
          "line_item_shipment_value": {
            "type": "number",
            "nullable": true,
            "description": "Shipment value used for duty calculation (customs value × quantity, plus allocated shipping and insurance for CIF destinations). Returned in the response currency."
          },
          "applied_rate_type": {
            "type": "string",
            "nullable": true,
            "description": "Whether the FTA preferential rate or the general rate was applied.",
            "enum": [
              "fta",
              "general"
            ]
          },
          "additional_rates": {
            "type": "array",
            "nullable": true,
            "description": "Additional duty surcharges applied on top of the base duty rate (e.g. anti-dumping duties, section tariffs).",
            "items": {
              "$ref": "#/components/schemas/ImportDutyAdditionalRate"
            }
          },
          "base_duty_rate": {
            "type": "number",
            "nullable": true,
            "description": "Base duty rate as a decimal (e.g. `0.12` = 12%)."
          },
          "base_duty_amount": {
            "type": "number",
            "nullable": true,
            "description": "Computed base duty amount for the line item in the response currency."
          },
          "line_item_total_duty": {
            "type": "number",
            "nullable": true,
            "description": "Total duty for the line item including base and all additional surcharges, in the response currency."
          }
        }
      }
    }
  }
}
```