shipments

Update a shipment

Changed on
<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>

Update an existing shipment's details including addresses, package information, carrier service, and shipping options. Use this endpoint to modify shipment information before purchasing a label.

Note: The following fields are read-only and cannot be updated: shipment_id, created_at, modified_at, shipment_status, tags, total_weight, and batch_ids.

put/v2/shipments/{shipment_id}

Request

  • Base URL
    https://api.shipstation.com
  • URL
    https://api.shipstation.com/v2/shipments/{shipment_id}
  • Auth
    API key in header api-key

Request body

shipment_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

carrier_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

service_codestring

A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.

requested_shipment_servicestring nullable

The requested shipment service

external_order_idstring nullable

ID that the Order Source assigned

hold_until_datestring date-time nullable

Date to hold the shipment until

ship_by_datestring date-time nullable

Date by which the shipment should be shipped

deliver_by_datestring date-time nullable

Date by which the shipment should be delivered

store_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

notes_from_buyerstring nullable

Notes from the buyer

notes_to_buyerstring nullable

Notes to the buyer

notes_for_giftstring nullable

Gift notes

internal_notesstring nullable

Internal notes from the seller

is_giftboolean

Indicates if the shipment is a gift

assigned_userstring nullable

User assigned to the shipment

zoneinteger nullable

Shipping zone

display_schemestring nullable

Display scheme for the shipment

external_shipment_idstring nullable

A user-defined key that identifies the source order. Multiple shipments can share the same external_shipment_id (common in split-shipping scenarios where one order results in multiple shipments). Functionally identical to orderKey in V1 API.

Warning: The external_shipment_id is limited to 50 characters. Any additional characters will be truncated.

shipment_numberstring nullable

A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.

Warning: The shipment_number is limited to 50 characters. Any additional characters will be truncated.

ship_datestring date-time

An ISO 8601 string that represents a date, but not a specific time. The value may contain a time component, but it will be set to 00:00:00 UTC by ShipStation .

created_atstring date-time

An ISO 8601 string that represents a date and time.

modified_atstring date-time

An ISO 8601 string that represents a date and time.

shipment_status'pending' | 'processing' | 'label_purchased' | 'cancelled'

The possible shipment status values

warehouse_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

is_returnboolean nullable

An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.

confirmation'none' | 'delivery' | 'signature' | 'adult_signature' | 'adult_signature_restricted_delivery' | 'direct_signature' | 'delivery_mailed' | 'verbal_confirmation' | 'delivery_code' | 'age_verification_16_plus'

The possible delivery confirmation values

insurance_provider'none' | 'shipsurance' | 'parcelguard' | 'xcover' | 'carrier' | 'third_party'

The possible insurance provider values

order_source_code'amazon_ca' | 'amazon_us' | 'brightpearl' | 'channel_advisor' | 'cratejoy' | 'ebay' | 'etsy' | 'jane' | 'groupon_goods' | 'magento' | 'paypal' | 'seller_active' | 'shopify' | 'stitch_labs' | 'squarespace' | 'three_dcart' | 'tophatter' | 'walmart' | 'woo_commerce' | 'volusion'

The order sources that are supported by ShipStation

batch_idsSeId[]

The unique IDs of any batches that this shipment is associated with. Returns an empty array if the shipment isn't associated with any batch.

If the shipment is associated with more than one batch, the IDs are ordered by batch status priority: open, queued, processing, completed, completed_with_errors, archived, notifying, then invalid.

comparison_rate_typestring nullable

Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS.

validate_address'no_validation' | 'validate_only' | 'validate_and_clean'

The possible validate address values

Example request

{
  "shipment_id": "se-28529731",
  "carrier_id": "se-28529731",
  "service_code": "usps_first_class_mail",
  "requested_shipment_service": "usps_priority_mail",
  "external_order_id": "1232434",
  "hold_until_date": "2025-01-15T00:00:00.000Z",
  "ship_by_date": "2025-01-15T00:00:00.000Z",
  "deliver_by_date": "2025-01-20T00:00:00.000Z",
  "retail_rate": {
    "amount": 12
  },
  "store_id": "se-28529731",
  "items": [
    {
      "name": "box",
      "sales_order_id": "8c1f2a5e-3b7d-4e9a-a6c2-1d4f5e6a7b8c",
      "sales_order_item_id": "2e7b9c4d-6a1f-4c3e-8b5d-9f0a1b2c3d4e",
      "quantity": 1,
      "sku": "sku-1234",
      "bundle_sku": "bundle-123",
      "external_order_id": "123445",
      "external_order_item_id": "12",
      "asin": "B00005N5PF",
      "item_id": "1402291169813",
      "allocation_status": "allocated",
      "image_url": "https://example.com/image.jpg",
      "weight": {
        "value": 23
      },
      "unit_price": 88,
      "tax_amount": 5.5,
      "shipping_amount": 10,
      "inventory_location": "warehouse-a",
      "options": [
        {
          "name": "Color",
          "value": "Red"
        }
      ],
      "product_id": "10408926",
      "fullfilment_sku": "fulfill-123",
      "upc": "123456789012"
    }
  ],
  "notes_from_buyer": "Please handle with care",
  "notes_to_buyer": "Thank you for your order!",
  "notes_for_gift": "Happy Birthday!",
  "internal_notes": "Check packaging before shipping",
  "is_gift": true,
  "assigned_user": "user@example.com",
  "amount_paid": {
    "amount": 12
  },
  "shipping_paid": {
    "amount": 12
  },
  "tax_paid": {
    "amount": 12
  },
  "zone": 1,
  "display_scheme": "label",
  "tax_identifiers": [
    {
      "issuing_authority": "US",
      "value": "value"
    }
  ],
  "external_shipment_id": "1234556",
  "shipment_number": "10001",
  "ship_date": "2018-09-23T00:00:00Z",
  "created_at": "2018-09-23T15:00:00.000Z",
  "modified_at": "2018-09-23T15:00:00.000Z",
  "ship_to": {
    "name": "John Doe",
    "phone": "+1 204-253-9411 ext. 123",
    "email": "example@example.com",
    "company_name": "The Home Depot",
    "address_line1": "1999 Bishop Grandin Blvd.",
    "address_line2": "Unit 408",
    "address_line3": "Building #7",
    "city_locality": "Winnipeg",
    "state_province": "Manitoba",
    "postal_code": "78756-3717",
    "country_code": "CA",
    "instructions": "any instruction",
    "geolocation": [
      {
        "type": "what3words",
        "value": "cats.with.thumbs"
      }
    ]
  },
  "ship_from": {
    "name": "John Doe",
    "phone": "+1 204-253-9411 ext. 123",
    "email": "example@example.com",
    "company_name": "The Home Depot",
    "address_line1": "1999 Bishop Grandin Blvd.",
    "address_line2": "Unit 408",
    "address_line3": "Building #7",
    "city_locality": "Winnipeg",
    "state_province": "Manitoba",
    "postal_code": "78756-3717",
    "country_code": "CA",
    "instructions": "any instructions",
    "geolocation": [
      {
        "type": "what3words",
        "value": "cats.with.thumbs"
      }
    ]
  },
  "warehouse_id": "se-28529731",
  "return_to": {
    "name": "John Doe",
    "phone": "+1 204-253-9411 ext. 123",
    "email": "example@example.com",
    "company_name": "The Home Depot",
    "address_line1": "1999 Bishop Grandin Blvd.",
    "address_line2": "Unit 408",
    "address_line3": "Building #7",
    "city_locality": "Winnipeg",
    "state_province": "Manitoba",
    "postal_code": "78756-3717",
    "country_code": "CA",
    "instructions": "any instructions",
    "geolocation": [
      {
        "type": "what3words",
        "value": "cats.with.thumbs"
      }
    ]
  },
  "is_return": true,
  "customs": {
    "terms_of_trade_code": "ddp",
    "contents": "gift",
    "non_delivery": "return_to_sender"
  },
  "advanced_options": {
    "bill_to_account": "123456789",
    "bill_to_country_code": "CA",
    "bill_to_postal_code": "28005",
    "contains_alcohol": true,
    "delivered_duty_paid": true,
    "dry_ice": true,
    "dry_ice_weight": {
      "value": 23
    },
    "non_machinable": true,
    "saturday_delivery": true,
    "fedex_freight": {
      "shipper_load_and_count": "shipper_load_and_count",
      "booking_confirmation": "today"
    },
    "use_ups_ground_freight_pricing": true,
    "freight_class": "77.5",
    "custom_field1": "custom field 1",
    "custom_field2": "custom field 2",
    "custom_field3": "custom field 3",
    "additional_handling": true,
    "shipper_release": true,
    "collect_on_delivery": {
      "payment_amount": {
        "amount": 12
      }
    },
    "third_party_consignee": true,
    "dangerous_goods": true,
    "dangerous_goods_contact": {
      "name": "Michael Robinson",
      "phone": "123456578789"
    },
    "movement_indicator": "b2b",
    "windsor_framework_details": {
      "movement_indicator": "b2b",
      "not_at_risk": true
    },
    "ancillary_endorsements_option": "forward",
    "return_pickup_attempts": 3,
    "netstamps_options": {
      "row": 1,
      "column": 1
    },
    "suppress_carrier_generated_documents": [
      "commercial_invoice"
    ],
    "transparency_codes": [
      {
        "order_item_id": "12345678901234",
        "codes": [
          "AZ:XXXXXXXXXXXX"
        ]
      }
    ]
  },
  "tags": [
    {
      "name": "Fragile"
    }
  ],
  "packages": [
    {
      "shipment_package_id": "se-28529731",
      "package_id": "se-28529731",
      "package_code": "small_flat_rate_box",
      "package_name": "Flat Rate Envelope",
      "weight": {
        "value": 23
      },
      "dimensions": {
        "length": 2,
        "width": 2,
        "height": 1
      },
      "insured_value": {
        "amount": 12
      },
      "label_messages": {
        "reference1": "Reference",
        "reference2": "Reference 2",
        "reference3": "Reference 3"
      },
      "external_package_id": "se-1234545",
      "content_description": "Hand knitted wool socks",
      "products": [
        {
          "description": "a minimum description",
          "quantity": 1,
          "value": {
            "amount": 12
          },
          "weight": {
            "value": 23
          },
          "harmonized_tariff_code": "3926.10",
          "country_of_origin": "CA",
          "unit_of_measure": "pound",
          "sku": "sku-1223344",
          "sku_description": "this is a description",
          "mid_code": "GBCOM15BRI",
          "product_url": "https://myproduct.com",
          "vat_rate": 0.2,
          "dangerous_goods": [
            {
              "id_number": "1234r1",
              "shipping_name": "things with dangerous goods",
              "technical_name": "chloric acid",
              "product_class": "1987",
              "product_class_subsidiary": "1987",
              "packaging_group": "ii",
              "dangerous_amount": {
                "amount": 12,
                "unit": "GBP"
              },
              "quantity": 1,
              "packaging_instruction": "Packaging materials and containers that are in contact with food products must comply with the provisions established by Regulation ",
              "packaging_instruction_section": "section_1",
              "packaging_type": "X",
              "transport_mean": "ground",
              "transport_category": "6.1",
              "regulation_authority": "AEAT",
              "regulation_level": "excepted_quantity",
              "tunnel_code": "all",
              "additional_description": "any description"
            }
          ],
          "manufacturer_product_id": "012345678905",
          "manufacturer_ns_product_id": "MY-SKU-12345",
          "cpsc_certificates": [
            {
              "certifier_id": "CERT-12345",
              "certificate_version_id": "v1.0"
            }
          ],
          "cpsc_disclaim": {
            "disclaim_code": "B",
            "intended_use_code": "130.006"
          }
        }
      ]
    }
  ],
  "total_weight": {
    "value": 3
  },
  "batch_ids": [
    "se-9581628",
    "se-1935182"
  ],
  "comparison_rate_type": "retail"
}

Response

The shipment was updated successfully.

shipment_idstring required

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

carrier_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

service_codestring

A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.

requested_shipment_servicestring nullable

The requested shipment service

external_order_idstring nullable

ID that the Order Source assigned

hold_until_datestring date-time nullable

Date to hold the shipment until

ship_by_datestring date-time nullable

Date by which the shipment should be shipped

deliver_by_datestring date-time nullable

Date by which the shipment should be delivered

store_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

notes_from_buyerstring nullable

Notes from the buyer

notes_to_buyerstring nullable

Notes to the buyer

notes_for_giftstring nullable

Gift notes

internal_notesstring nullable

Internal notes from the seller

is_giftboolean

Indicates if the shipment is a gift

assigned_userstring nullable

User assigned to the shipment

zoneinteger nullable

Shipping zone

display_schemestring nullable

Display scheme for the shipment

external_shipment_idstring nullable

A user-defined key that identifies the source order. Multiple shipments can share the same external_shipment_id (common in split-shipping scenarios where one order results in multiple shipments). Functionally identical to orderKey in V1 API.

Warning: The external_shipment_id is limited to 50 characters. Any additional characters will be truncated.

shipment_numberstring nullable

A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.

Warning: The shipment_number is limited to 50 characters. Any additional characters will be truncated.

ship_datestring date-time

An ISO 8601 string that represents a date, but not a specific time. The value may contain a time component, but it will be set to 00:00:00 UTC by ShipStation .

created_atstring date-time required

An ISO 8601 string that represents a date and time.

modified_atstring date-time required

An ISO 8601 string that represents a date and time.

shipment_status'pending' | 'processing' | 'label_purchased' | 'cancelled' required

The possible shipment status values

warehouse_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

is_returnboolean nullable

An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.

confirmation'none' | 'delivery' | 'signature' | 'adult_signature' | 'adult_signature_restricted_delivery' | 'direct_signature' | 'delivery_mailed' | 'verbal_confirmation' | 'delivery_code' | 'age_verification_16_plus'

The possible delivery confirmation values

insurance_provider'none' | 'shipsurance' | 'parcelguard' | 'xcover' | 'carrier' | 'third_party' required

The possible insurance provider values

order_source_code'amazon_ca' | 'amazon_us' | 'brightpearl' | 'channel_advisor' | 'cratejoy' | 'ebay' | 'etsy' | 'jane' | 'groupon_goods' | 'magento' | 'paypal' | 'seller_active' | 'shopify' | 'stitch_labs' | 'squarespace' | 'three_dcart' | 'tophatter' | 'walmart' | 'woo_commerce' | 'volusion'

The order sources that are supported by ShipStation

batch_idsSeId[] required

The unique IDs of any batches that this shipment is associated with. Returns an empty array if the shipment isn't associated with any batch.

If the shipment is associated with more than one batch, the IDs are ordered by batch status priority: open, queued, processing, completed, completed_with_errors, archived, notifying, then invalid.

comparison_rate_typestring nullable

Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS.

sales_order_idsstring[]

The IDs of the sales orders that the shipment is linked to. The array is empty if the shipment isn't linked to a sales order. This field is read-only and is ignored in requests.

A shipment must be linked to a sales order before it can be split or merged.

Note: After a split, the original shipment can still list a sales order even if all of that sales order's items have moved to other shipments. To see which sales order each item belongs to, use items[].sales_order_id.

Example response

{
  "shipment_id": "se-28529731",
  "carrier_id": "se-28529731",
  "service_code": "usps_first_class_mail",
  "requested_shipment_service": "usps_priority_mail",
  "external_order_id": "1232434",
  "hold_until_date": "2025-01-15T00:00:00.000Z",
  "ship_by_date": "2025-01-15T00:00:00.000Z",
  "deliver_by_date": "2025-01-20T00:00:00.000Z",
  "retail_rate": {
    "amount": 12
  },
  "store_id": "se-28529731",
  "items": [
    {
      "name": "box",
      "sales_order_id": "8c1f2a5e-3b7d-4e9a-a6c2-1d4f5e6a7b8c",
      "sales_order_item_id": "2e7b9c4d-6a1f-4c3e-8b5d-9f0a1b2c3d4e",
      "quantity": 1,
      "sku": "sku-1234",
      "bundle_sku": "bundle-123",
      "external_order_id": "123445",
      "external_order_item_id": "12",
      "asin": "B00005N5PF",
      "item_id": "1402291169813",
      "allocation_status": "allocated",
      "image_url": "https://example.com/image.jpg",
      "weight": {
        "value": 23
      },
      "unit_price": 88,
      "tax_amount": 5.5,
      "shipping_amount": 10,
      "inventory_location": "warehouse-a",
      "options": [
        {
          "name": "Color",
          "value": "Red"
        }
      ],
      "product_id": "10408926",
      "fullfilment_sku": "fulfill-123",
      "upc": "123456789012"
    }
  ],
  "notes_from_buyer": "Please handle with care",
  "notes_to_buyer": "Thank you for your order!",
  "notes_for_gift": "Happy Birthday!",
  "internal_notes": "Check packaging before shipping",
  "is_gift": true,
  "assigned_user": "user@example.com",
  "amount_paid": {
    "amount": 12
  },
  "shipping_paid": {
    "amount": 12
  },
  "tax_paid": {
    "amount": 12
  },
  "zone": 1,
  "display_scheme": "label",
  "tax_identifiers": [
    {
      "issuing_authority": "US",
      "value": "value"
    }
  ],
  "external_shipment_id": "1234556",
  "shipment_number": "10001",
  "ship_date": "2018-09-23T00:00:00Z",
  "created_at": "2018-09-23T15:00:00.000Z",
  "modified_at": "2018-09-23T15:00:00.000Z",
  "ship_to": {
    "name": "John Doe",
    "phone": "+1 204-253-9411 ext. 123",
    "email": "example@example.com",
    "company_name": "The Home Depot",
    "address_line1": "1999 Bishop Grandin Blvd.",
    "address_line2": "Unit 408",
    "address_line3": "Building #7",
    "city_locality": "Winnipeg",
    "state_province": "Manitoba",
    "postal_code": "78756-3717",
    "country_code": "CA",
    "instructions": "any instruction",
    "geolocation": [
      {
        "type": "what3words",
        "value": "cats.with.thumbs"
      }
    ]
  },
  "ship_from": {
    "name": "John Doe",
    "phone": "+1 204-253-9411 ext. 123",
    "email": "example@example.com",
    "company_name": "The Home Depot",
    "address_line1": "1999 Bishop Grandin Blvd.",
    "address_line2": "Unit 408",
    "address_line3": "Building #7",
    "city_locality": "Winnipeg",
    "state_province": "Manitoba",
    "postal_code": "78756-3717",
    "country_code": "CA",
    "instructions": "any instructions",
    "geolocation": [
      {
        "type": "what3words",
        "value": "cats.with.thumbs"
      }
    ]
  },
  "warehouse_id": "se-28529731",
  "return_to": {
    "name": "John Doe",
    "phone": "+1 204-253-9411 ext. 123",
    "email": "example@example.com",
    "company_name": "The Home Depot",
    "address_line1": "1999 Bishop Grandin Blvd.",
    "address_line2": "Unit 408",
    "address_line3": "Building #7",
    "city_locality": "Winnipeg",
    "state_province": "Manitoba",
    "postal_code": "78756-3717",
    "country_code": "CA",
    "instructions": "any instructions",
    "geolocation": [
      {
        "type": "what3words",
        "value": "cats.with.thumbs"
      }
    ]
  },
  "is_return": true,
  "customs": {
    "terms_of_trade_code": "ddp",
    "contents": "gift",
    "non_delivery": "return_to_sender"
  },
  "advanced_options": {
    "bill_to_account": "123456789",
    "bill_to_country_code": "CA",
    "bill_to_postal_code": "28005",
    "contains_alcohol": true,
    "delivered_duty_paid": true,
    "dry_ice": true,
    "dry_ice_weight": {
      "value": 23
    },
    "non_machinable": true,
    "saturday_delivery": true,
    "fedex_freight": {
      "shipper_load_and_count": "shipper_load_and_count",
      "booking_confirmation": "today"
    },
    "use_ups_ground_freight_pricing": true,
    "freight_class": "77.5",
    "custom_field1": "custom field 1",
    "custom_field2": "custom field 2",
    "custom_field3": "custom field 3",
    "additional_handling": true,
    "shipper_release": true,
    "collect_on_delivery": {
      "payment_amount": {
        "amount": 12
      }
    },
    "third_party_consignee": true,
    "dangerous_goods": true,
    "dangerous_goods_contact": {
      "name": "Michael Robinson",
      "phone": "123456578789"
    },
    "movement_indicator": "b2b",
    "windsor_framework_details": {
      "movement_indicator": "b2b",
      "not_at_risk": true
    },
    "ancillary_endorsements_option": "forward",
    "return_pickup_attempts": 3,
    "netstamps_options": {
      "row": 1,
      "column": 1
    },
    "suppress_carrier_generated_documents": [
      "commercial_invoice"
    ],
    "transparency_codes": [
      {
        "order_item_id": "12345678901234",
        "codes": [
          "AZ:XXXXXXXXXXXX"
        ]
      }
    ]
  },
  "tags": [
    {
      "name": "Fragile"
    }
  ],
  "packages": [
    {
      "shipment_package_id": "se-28529731",
      "package_id": "se-28529731",
      "package_code": "small_flat_rate_box",
      "package_name": "Flat Rate Envelope",
      "weight": {
        "value": 23
      },
      "dimensions": {
        "length": 2,
        "width": 2,
        "height": 1
      },
      "insured_value": {
        "amount": 12
      },
      "label_messages": {
        "reference1": "Reference",
        "reference2": "Reference 2",
        "reference3": "Reference 3"
      },
      "external_package_id": "se-1234545",
      "content_description": "Hand knitted wool socks",
      "products": [
        {
          "description": "a minimum description",
          "quantity": 1,
          "value": {
            "amount": 12
          },
          "weight": {
            "value": 23
          },
          "harmonized_tariff_code": "3926.10",
          "country_of_origin": "CA",
          "unit_of_measure": "pound",
          "sku": "sku-1223344",
          "sku_description": "this is a description",
          "mid_code": "GBCOM15BRI",
          "product_url": "https://myproduct.com",
          "vat_rate": 0.2,
          "dangerous_goods": [
            {
              "id_number": "1234r1",
              "shipping_name": "things with dangerous goods",
              "technical_name": "chloric acid",
              "product_class": "1987",
              "product_class_subsidiary": "1987",
              "packaging_group": "ii",
              "dangerous_amount": {
                "amount": 12,
                "unit": "GBP"
              },
              "quantity": 1,
              "packaging_instruction": "Packaging materials and containers that are in contact with food products must comply with the provisions established by Regulation ",
              "packaging_instruction_section": "section_1",
              "packaging_type": "X",
              "transport_mean": "ground",
              "transport_category": "6.1",
              "regulation_authority": "AEAT",
              "regulation_level": "excepted_quantity",
              "tunnel_code": "all",
              "additional_description": "any description"
            }
          ],
          "manufacturer_product_id": "012345678905",
          "manufacturer_ns_product_id": "MY-SKU-12345",
          "cpsc_certificates": [
            {
              "certifier_id": "CERT-12345",
              "certificate_version_id": "v1.0"
            }
          ],
          "cpsc_disclaim": {
            "disclaim_code": "B",
            "intended_use_code": "130.006"
          }
        }
      ]
    }
  ],
  "total_weight": {
    "value": 3
  },
  "batch_ids": [
    "se-9581628",
    "se-1935182"
  ],
  "comparison_rate_type": "retail",
  "sales_order_ids": [
    "8c1f2a5e-3b7d-4e9a-a6c2-1d4f5e6a7b8c"
  ]
}

Changes

  • 4e29670aa28dRevision changes
    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • info

      added subschema #2: shipment_sales_order_fields to the response body allOf list for the response status

  • bf3618aaf7e1Revision changes
    • breaking

      the ///// request property type changed from string to no type

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property ///////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      added subschema #2 to the /// response property oneOf list for the response status

    • breaking

      added subschema #2 to the /// response property oneOf list for the response status

    • breaking

      added subschema #2 to the ///// response property oneOf list for the response status

    • breaking

      added subschema #2 to the / response property oneOf list for the response status

    • breaking

      added subschema #2 to the / response property oneOf list for the response status

    • breaking

      added subschema #2 to the ///// response property oneOf list for the response status

    • breaking

      added subschema #2 to the / response property oneOf list for the response status

    • breaking

      added subschema #2 to the /// response property oneOf list for the response status

    • breaking

      added subschema #2 to the /// response property oneOf list for the response status

    • breaking

      added subschema #2 to the / response property oneOf list for the response status

    • breaking

      added subschema #2 to the / response property oneOf list for the response status

    • breaking

      added subschema #2 to the / response property oneOf list for the response status

    • breaking

      added subschema #2 to the /// response property oneOf list for the response status

    • breaking

      the ///// response's property type changed from string to no type for status

    • warning

      removed from the /// request property allOf list

    • warning

      removed from the /// request property allOf list

    • warning

      removed from the ///// request property allOf list

    • warning

      removed from the / request property allOf list

    • warning

      removed from the / request property allOf list

    • warning

      removed from the ///// request property allOf list

    • warning

      removed from the / request property allOf list

    • warning

      removed from the /// request property allOf list

    • warning

      removed from the /// request property allOf list

    • warning

      removed from the / request property allOf list

    • warning

      removed from the / request property allOf list

    • warning

      removed from the / request property allOf list

    • warning

      removed from the /// request property allOf list

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property /// became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property /// became nullable

    • info

      the request property //// became nullable

    • info

      the request property //// became nullable

    • info

      the request property //// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ////// became nullable

    • info

      the request property /////// became nullable

    • info

      the request property ///////// became nullable

    • info

      the request property /////// became nullable

    • info

      the request property /////// became nullable

    • info

      the request property /////// became nullable

    • info

      the request property /////// became nullable

    • info

      the request property /////// became nullable

    • info

      the request property /////// became nullable

    • info

      the request property /////// became nullable

    • info

      the request property /////// became nullable

    • info

      the request property /////// became nullable

    • info

      the request property /////// became nullable

    • info

      the request property /////// became nullable

    • info

      the request property /////// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property / became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property //// became nullable

    • info

      the request property / became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property //// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property ///// became nullable

    • info

      the request property //// became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      the request property / became nullable

    • info

      added subschema #2 to the /// request property oneOf list

    • info

      added subschema #2 to the /// request property oneOf list

    • info

      added subschema #2 to the ///// request property oneOf list

    • info

      added subschema #2 to the / request property oneOf list

    • info

      added subschema #2 to the / request property oneOf list

    • info

      added subschema #2 to the ///// request property oneOf list

    • info

      added subschema #2 to the / request property oneOf list

    • info

      added subschema #2 to the /// request property oneOf list

    • info

      added subschema #2 to the /// request property oneOf list

    • info

      added subschema #2 to the / request property oneOf list

    • info

      added subschema #2 to the / request property oneOf list

    • info

      added subschema #2 to the / request property oneOf list

    • info

      added subschema #2 to the /// request property oneOf list

    • info

      removed from the /// response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status