{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["tabs","tab"]},"type":"markdown"},"seo":{"title":"Shipment: Single Parcel and Multi-Parcel Support","description":"itney Bowes Shipping API, developers can integrate features such as comparing shipping rates from multiple carriers, creating and purchasing shipping labels, tracking packages, scheduling pickups, managing returns, and accessing other shipping features. These APIs also offers a variety of shipping services, including international shipping and multi-carrier rate shopping, which allows developers to choose the best carrier and rate for each shipment."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"shipment-single-parcel-and-multi-parcel-support","__idx":0},"children":["Shipment: Single Parcel and Multi-Parcel Support"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Create Shipment API has been enhanced to support both the existing single-parcel request structure and a new ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcels"]},"-based request structure. This enhancement is introduced to preserve backward compatibility for existing integrations while enabling a more flexible and scalable request model for new implementations."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Until now, Create Shipment supported parcel data using the root-level ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcel"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcelType"]}," fields. With this enhancement, the API also supports a new ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcels"]}," array structure. This new structure can be used for creating a shipment with a single parcel as well as a shipment with multiple parcels."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["As a result, the API now supports three valid request patterns for domestic shipment creation:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the existing single-parcel structure using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcel"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcelType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the new single-parcel structure using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcels"]}," array with one parcel"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the new multi-parcel structure using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcels"]}," array with multiple parcels"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This approach allows existing users to continue using their current request format without change, while giving new users a single extensible structure for both single-parcel and multi-parcel shipment creation."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-is-supported-now","__idx":2},"children":["What is supported now"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Rate Shipment and Create Shipment APIs now support the following request structures."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"existing-structure","__idx":3},"children":["Existing structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The existing request format continues to support shipment creation using the following fields at the root level:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcel"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcelType"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the legacy single-parcel structure."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"new-structure","__idx":4},"children":["New structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The new request format supports shipment creation using:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcels"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcels"]}," field is an array. Each item in the array represents one parcel entry and contains:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcel"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcelType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specialServices"]}," - optional"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["references"]}," - optional"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["items"]}," - optional (either pass the object or previously defined ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customsProductId"]},")",{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Read: How to create ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/customproduct/customs-product/addcustomsproduct"},"children":["Customs Product Identifier"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"JSON","header":{"controls":{"copy":{}}},"source":"\"items\": \n [\n {\n \"itemId\": \"sku1\",\n \"description\": \"Book\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"US\",\n \"originStateProvince\": \"TX\",\n \"quantity\": 2,\n \"unitPrice\": 10,\n \"weightUnit\": \"GM\",\n \"weight\": 80,\n \"orderNumber\": \"22\"\n },\n {\n \"customsProductId\": \"cp00000922010\"\n }\n ]\n","lang":"JSON"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This means the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcels"]}," array can now be used in the following ways:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["to create a shipment with one parcel"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["to create a shipment with multiple parcels single label"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["to create a shipment with multiple parcels split labels (using query parameter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["splitContent"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},")"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-choose-between-the-two-structures","__idx":5},"children":["How to choose between the two structures"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you are already integrated with the existing Create Shipment request format and are sending ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcel"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcelType"]},", you can continue using that structure without any change."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you are building a new integration, the recommended approach is to use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcels"]}," array structure. It provides a single consistent model for both single-parcel and multi-parcel shipment creation and is better suited for future extensibility."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The main distinction is simple:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcel"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcelType"]}," if you want to continue with the existing legacy format"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcels"]}," if you want to adopt the new structure"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"existing-single-parcel-request-structure","__idx":6},"children":["Existing single-parcel request structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The existing structure represents parcel information directly at the root level of the request body."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In this model:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcel"]}," contains parcel dimensions, weight, and related details"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcelType"]}," identifies the parcel type for that shipment"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This format remains fully supported for domestic shipment creation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"api-operations","__idx":7},"children":["API Operations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The APIs provide the following operations:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource Path"},"children":["Resource Path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rate Shipment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v2/rates"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create Shipment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["/api/v2/shipments"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"base-url-for-us-region","__idx":8},"children":["Base URL for US Region"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sandbox Server url: \"https://api-sandbox.sendpro360.pitneybowes.com/shipping\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Production Server url: \"https://api.sendpro360.pitneybowes.com/shipping\""]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"base-url-for-ca-region","__idx":9},"children":["Base URL for CA Region"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sandbox Server url: \"https://api-ppd.shipping360.pitneybowes.com/ca/shipping\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Production Server url: \"https://api.shipping360.pitneybowes.com/ca/shipping\""]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"header","__idx":10},"children":["Header:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-PB-LocationId"]},": String. The X-PB-LocationId header identifies the enterprise, division, or partner location under which a shipment is processed and billed. If this header is not provided, the system automatically uses the enterprise-level location that was created during developer account onboarding. This default location is then used for shipment processing, carrier selection, and billing."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"rate-shipment-by-carrier-sample-request-payloads","__idx":11},"children":["Rate Shipment (By Carrier) sample Request Payloads"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Single Parcel","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":" {\n \"fromAddress\": {\n \"addressLine1\": \"24182 Kathy Ave\",\n \"cityTown\": \"Lake Forest\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"92630-1827\",\n \"stateProvince\": \"CA\"\n },\n \"toAddress\": {\n \"addressLine1\": \"55 Pharr Rd NW, Apt E104\",\n \"cityTown\": \"Atlanta\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"30305-2151\",\n \"stateProvince\": \"GA\"\n },\n \"altReturnAddress\": {\n \"addressLine1\": \"47 W 13th St\",\n \"cityTown\": \"New York\",\n \"company\": \"ABC Company\",\n \"countryCode\": \"US\",\n \"email\": \"sender@email.com\",\n \"name\": \"altReturnAddress Name\",\n \"phone\": \"323 555-1212\",\n \"postalCode\": \"10011\",\n \"residential\": false,\n \"stateProvince\": \"NY\"\n },\n \"parcel\": {\n \"length\": 2,\n \"width\": 0.5,\n \"height\": 1,\n \"dimUnit\": \"IN\",\n \"weightUnit\": \"OZ\",\n \"weight\": 2,\n \"packageValue\": 2\n },\n \"parcelType\": \"PKG\",\n \"rateShopBy\": \"carrier\",\n \"byCarrier\": {\n \"carrierAccountId\": \"{{ups_carrier_id}}\",\n \"carrier\": \"UPS\",\n \"service\": \"NDA\"\n },\n\n \"specialServices\": [\n {\n \"specialServiceId\": \"ADD_HDL\"\n },\n {\n \"specialServiceId\": \"ins\",\n \"inputParameters\": [\n {\n \"name\": \"INPUT_VALUE\",\n \"value\": \"101\"\n }\n ]\n },\n {\n \"specialServiceId\": \"DIRECT\"\n }\n ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Single Parcel using Parcels","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":" {\n \"fromAddress\": {\n \"addressLine1\": \"24182 Kathy Ave\",\n \"cityTown\": \"Lake Forest\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"92630-1827\",\n \"stateProvince\": \"CA\"\n },\n \"toAddress\": {\n \"addressLine1\": \"55 Pharr Rd NW, Apt E104\",\n \"cityTown\": \"Atlanta\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"30305-2151\",\n \"stateProvince\": \"GA\"\n },\n \"altReturnAddress\": {\n \"addressLine1\": \"47 W 13th St\",\n \"cityTown\": \"New York\",\n \"company\": \"ABC Company\",\n \"countryCode\": \"US\",\n \"email\": \"sender@email.com\",\n \"name\": \"altReturnAddress Name\",\n \"phone\": \"323 555-1212\",\n \"postalCode\": \"10011\",\n \"residential\": false,\n \"stateProvince\": \"NY\"\n },\n \"parcels\": [\n {\n \"parcel\": {\n \"length\": 2,\n \"width\": 1,\n \"height\": 1,\n \"dimUnit\": \"IN\",\n \"weightUnit\": \"OZ\",\n \"weight\": 2\n },\n \"parcelType\": \"PKG\",\n \"specialServices\": [\n {\n \"inputParameters\": [\n {\n \"name\": \"INPUT_VALUE\",\n \"value\": \"100\"\n }\n ],\n \"specialserviceId\": \"Ins\"\n }\n ]\n }\n ],\n \"rateShopBy\": \"carrier\",\n \"byCarrier\": {\n \"carrierAccountId\": \"{{ups_carrier_id}}\",\n \"carrier\": \"UPS\",\n \"service\": \"NDA\"\n }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Multi-Parcel","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":" {\n \"fromAddress\": {\n \"name\": \"Sender Name\",\n \"addressLine1\": \"1600 Amphitheatre Parkway\",\n \"addressLine2\": \"near abc street\",\n \"addressLine3\": \"near xyz street\",\n \"company\": \"PB\",\n \"email\": \"testuser@gmail.com\",\n \"phone\": \"6502530000\",\n \"cityTown\": \"Mountain View\",\n \"stateProvince\": \"CA\",\n \"postalCode\": \"94043\",\n \"inductionPostalCode\": \"06905\",\n \"countryCode\": \"US\",\n \"residential\": true\n },\n \"toAddress\": {\n \"name\": \"Recipient Name\",\n \"addressLine1\": \"350 Fifth Avenue\",\n \"addressLine2\": \"near abc street\",\n \"addressLine3\": \"near xyz street\",\n \"cityTown\": \"New York\",\n \"stateProvince\": \"NY\",\n \"postalCode\": \"10118\",\n \"countryCode\": \"US\",\n \"company\": \"PB\",\n \"phone\": \"2127363100\",\n \"email\": \"recipient@gmail.com\",\n \"residential\": true,\n \"isPOBox\": true\n },\n \"altReturnAddress\": {\n \"addressLine1\": \"47 W 13th St\",\n \"cityTown\": \"New York\",\n \"company\": \"ABC Company\",\n \"countryCode\": \"US\",\n \"email\": \"sender@email.com\",\n \"name\": \"altReturnAddress Name\",\n \"phone\": \"323 555-1212\",\n \"postalCode\": \"10011\",\n \"residential\": false,\n \"stateProvince\": \"NY\"\n },\n \"parcels\": [\n {\n \"parcel\": {\n \"length\": 2,\n \"width\": 1,\n \"height\": 1,\n \"dimUnit\": \"IN\",\n \"weightUnit\": \"OZ\",\n \"weight\": 2\n },\n \"parcelType\": \"PKG\",\n \"specialServices\": [\n {\n \"inputParameters\": [\n {\n \"name\": \"INPUT_VALUE\",\n \"value\": \"100\"\n }\n ],\n \"specialserviceId\": \"Ins\"\n }\n ],\n\n },\n {\n \"parcel\": {\n \"length\": 5,\n \"width\": 4,\n \"height\": 3,\n \"dimUnit\": \"IN\",\n \"weightUnit\": \"OZ\",\n \"weight\": 8\n },\n \"parcelType\": \"PKG\"\n }\n ],\n \"rateShopBy\": \"carrier\",\n \"byCarrier\": {\n \"carrierAccountId\": \"{{ups_carrier_id}}\",\n \"carrier\": \"UPS\",\n \"service\": \"NDA\"\n }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"rate-shipment-by-carrier-response-payloads","__idx":12},"children":["Rate Shipment (By Carrier) Response Payloads"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Single Parcel","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"fromAddress\": {\n \"addressLine1\": \"24182 Kathy Ave\",\n \"cityTown\": \"Lake Forest\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"92630-1827\",\n \"residential\": false,\n \"stateProvince\": \"CA\"\n },\n \"toAddress\": {\n \"addressLine1\": \"55 Pharr Rd NW, Apt E104\",\n \"cityTown\": \"Atlanta\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"30305-2151\",\n \"residential\": false,\n \"stateProvince\": \"GA\"\n },\n \"rate\": [\n {\n \"baseCharge\": 102.45,\n \"carrier\": \"ups\",\n \"carrierAccount\": \"vO396rorMdxZ8k1\",\n \"currencyCode\": \"USD\",\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-04-27 10:30:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"parcelType\": \"PKG\",\n \"rateTypeId\": \"COMMERCIAL\",\n \"serviceId\": \"NDA\",\n \"specialServices\": [\n {\n \"specialServiceId\": \"ADD_HDL\",\n \"fee\": 33.75\n },\n {\n \"specialServiceId\": \"ins\",\n \"inputParameters\": [\n {\n \"name\": \"INPUT_VALUE\",\n \"value\": \"101\"\n }\n ],\n \"fee\": 0\n },\n {\n \"specialServiceId\": \"DIRECT\",\n \"fee\": 2\n }\n ],\n \"surcharges\": [\n {\n \"fee\": 7,\n \"name\": \"RESIDENTIAL\"\n },\n {\n \"fee\": 43.32,\n \"name\": \"FUEL\"\n }\n ],\n \"totalCarrierCharge\": 151.24,\n \"isHazmat\": true,\n \"publishedTotalCarrierCharge\": 186.52\n }\n ],\n \"shipmentOptions\": {\n \"billingWeight\": \"16.0\"\n },\n \"parcel\": {\n \"length\": 2,\n \"height\": 1,\n \"width\": 0.5,\n \"dimUnit\": \"IN\",\n \"weightUnit\": \"OZ\",\n \"weight\": 2,\n \"packageValue\": 2\n }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Single Parcel using Parcels","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"fromAddress\": {\n \"addressLine1\": \"24182 Kathy Ave\",\n \"cityTown\": \"Lake Forest\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"92630-1827\",\n \"residential\": false,\n \"stateProvince\": \"CA\"\n },\n \"toAddress\": {\n \"addressLine1\": \"55 Pharr Rd NW, Apt E104\",\n \"cityTown\": \"Atlanta\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"30305-2151\",\n \"residential\": false,\n \"stateProvince\": \"GA\"\n },\n \"shipmentOptions\": {\n \"billingWeight\": \"16.0\"\n },\n \"rates\": [\n {\n \"rate\": {\n \"baseCharge\": 102.45,\n \"carrier\": \"ups\",\n \"carrierAccount\": \"vO396rorMdxZ8k1\",\n \"currencyCode\": \"USD\",\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-04-27 10:30:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"parcelType\": \"PKG\",\n \"rateTypeId\": \"COMMERCIAL\",\n \"serviceId\": \"NDA\",\n \"specialServices\": [\n {\n \"specialServiceId\": \"Ins\",\n \"inputParameters\": [\n {\n \"name\": \"INPUT_VALUE\",\n \"value\": \"100\"\n }\n ],\n \"fee\": 0\n }\n ],\n \"surcharges\": [\n {\n \"fee\": 7,\n \"name\": \"RESIDENTIAL\"\n },\n {\n \"fee\": 33.11,\n \"name\": \"FUEL\"\n }\n ],\n \"totalCarrierCharge\": 141.13,\n \"isHazmat\": true,\n \"publishedTotalCarrierCharge\": 142.56\n },\n \"parcels\": [\n {\n \"parcel\": {\n \"length\": 2,\n \"height\": 1,\n \"width\": 1,\n \"dimUnit\": \"IN\",\n \"weightUnit\": \"OZ\",\n \"weight\": 2\n },\n \"parcelRate\": {\n \"baseCharge\": 102.45,\n \"carrier\": \"ups\",\n \"carrierAccount\": \"vO396rorMdxZ8k1\",\n \"currencyCode\": \"USD\",\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-04-27 10:30:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"parcelType\": \"PKG\",\n \"rateTypeId\": \"COMMERCIAL\",\n \"serviceId\": \"NDA\",\n \"specialServices\": [\n {\n \"specialServiceId\": \"Ins\",\n \"inputParameters\": [\n {\n \"name\": \"INPUT_VALUE\",\n \"value\": \"100\"\n }\n ],\n \"fee\": 0\n }\n ],\n \"surcharges\": [\n {\n \"fee\": 7,\n \"name\": \"RESIDENTIAL\"\n },\n {\n \"fee\": 33.11,\n \"name\": \"FUEL\"\n }\n ],\n \"totalCarrierCharge\": 141.13,\n \"isHazmat\": true,\n \"publishedTotalCarrierCharge\": 142.56\n }\n }\n ]\n }\n ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Multi-Parcel","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":" {\n \"fromAddress\": {\n \"name\": \"Sender Name\",\n \"addressLine1\": \"1600 Amphitheatre Parkway\",\n \"addressLine2\": \"near abc street\",\n \"addressLine3\": \"near xyz street\",\n \"company\": \"PB\",\n \"email\": \"testuser@gmail.com\",\n \"phone\": \"6502530000\",\n \"cityTown\": \"Mountain View\",\n \"stateProvince\": \"CA\",\n \"postalCode\": \"94043\",\n \"inductionPostalCode\": \"06905\",\n \"countryCode\": \"US\",\n \"residential\": true\n },\n \"toAddress\": {\n \"name\": \"Recipient Name\",\n \"addressLine1\": \"350 Fifth Avenue\",\n \"addressLine2\": \"near abc street\",\n \"addressLine3\": \"near xyz street\",\n \"cityTown\": \"New York\",\n \"stateProvince\": \"NY\",\n \"postalCode\": \"10118\",\n \"countryCode\": \"US\",\n \"company\": \"PB\",\n \"phone\": \"2127363100\",\n \"email\": \"recipient@gmail.com\",\n \"residential\": true,\n \"isPOBox\": true\n },\n \"altReturnAddress\": {\n \"addressLine1\": \"47 W 13th St\",\n \"cityTown\": \"New York\",\n \"company\": \"ABC Company\",\n \"countryCode\": \"US\",\n \"email\": \"sender@email.com\",\n \"name\": \"altReturnAddress Name\",\n \"phone\": \"323 555-1212\",\n \"postalCode\": \"10011\",\n \"residential\": false,\n \"stateProvince\": \"NY\"\n },\n \"shipmentOptions\": {},\n \"rates\": [\n {\n \"rate\": {\n \"carrier\": \"UPS\",\n \"currencyCode\": \"USD\",\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-04-27 10:30:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"rateTypeId\": \"COMMERCIAL\",\n \"serviceId\": \"NDA\",\n \"surcharges\": [\n {\n \"fee\": 14,\n \"name\": \"RESIDENTIAL\"\n }\n ],\n \"totalCarrierCharge\": 282.27,\n \"isHazmat\": false\n },\n \"parcels\": [\n {\n \"parcelType\": \"PKG\",\n \"parcel\": {\n \"length\": 2,\n \"height\": 1,\n \"width\": 1,\n \"dimUnit\": \"IN\",\n \"weightUnit\": \"OZ\",\n \"weight\": 2\n },\n \"parcelRate\": {\n \"baseCharge\": 102.45,\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-04-27 10:30:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"surcharges\": [\n {\n \"fee\": 33.11,\n \"name\": \"FUEL\"\n }\n ],\n \"isHazmat\": false\n },\n \"specialServices\": [\n {\n \"specialServiceId\": \"Ins\",\n \"inputParameters\": [\n {\n \"name\": \"INPUT_VALUE\",\n \"value\": \"100\"\n }\n ],\n \"fee\": 0\n }\n ]\n },\n {\n \"parcelType\": \"PKG\",\n \"parcel\": {\n \"length\": 5,\n \"height\": 3,\n \"width\": 4,\n \"dimUnit\": \"IN\",\n \"weightUnit\": \"OZ\",\n \"weight\": 8\n },\n \"parcelRate\": {\n \"baseCharge\": 102.45,\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-04-27 10:30:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"surcharges\": [\n {\n \"fee\": 33.11,\n \"name\": \"FUEL\"\n }\n ],\n \"isHazmat\": false\n }\n }\n ]\n }\n ]\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-shipment-by-carrier-sample-request-payloads","__idx":13},"children":["Create Shipment (By Carrier) sample Request Payloads"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Single Parcel","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":" {\n \"toAddress\": {\n \"addressLine1\": \"55 Pharr Rd NW, Apt E104\",\n \"cityTown\": \"Atlanta\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"30305-2151\",\n \"stateProvince\": \"GA\"\n },\n \"fromAddress\": {\n \"addressLine1\": \"24182 Kathy Ave\",\n \"cityTown\": \"Lake Forest\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"92630-1827\",\n \"stateProvince\": \"CA\"\n },\n \"soldToAddress\": {\n \"addressLine1\": \"70 Hanlan RD\",\n \"addressLine2\": \"Suite 101\",\n \"addressLine3\": \"Near central market\",\n \"company\": \"ABC Company\",\n \"name\": \"John Doe\",\n \"phone\": \"905-555-1234\",\n \"email\": \"billing@abccompany.com\",\n \"residential\": false,\n \"cityTown\": \"Woodbridge\",\n \"stateProvince\": \"ON\",\n \"postalCode\": \"L4L 3P6\",\n \"countryCode\": \"CA\",\n \"taxId\": \"string\",\n \"taxIdType\": \"EIN\"\n },\n \"altReturnAddress\": {\n \"addressLine1\": \"24182 Kathy Ave\",\n \"cityTown\": \"Lake Forest\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"92630-1827\",\n \"stateProvince\": \"CA\"\n },\n \"additionalAddresses\": [\n {\n \"address\": {\n \"residential\": false,\n \"phone\": \"732-443-1007\",\n \"countryCode\": \"US\",\n \"company\": \"ABC Company\",\n \"postalCode\": \"08810-1411\",\n \"cityTown\": \"DAYTON\",\n \"name\": \"Warehouse Manager\",\n \"stateProvince\": \"NJ\",\n \"addressLine1\": \"2270 US HIGHWAY 130\"\n },\n \"addressType\": \"SHIPPER\"\n }\n ],\n \"parcel\": {\n \"length\": 2,\n \"width\": 1,\n \"height\": 1,\n \"dimUnit\": \"IN\",\n \"weightUnit\": \"OZ\",\n \"weight\": 2,\n \"packageValue\": 2\n },\n \"parcelType\": \"PKG\",\n \"rateShopBy\": \"carrier\",\n \"byCarrier\": {\n \"carrierAccountId\": \"{{ups_carrier_id}}\",\n \"carrier\": \"UPS\",\n \"service\": \"NDA\"\n },\n \"shipmentOptions\": {\n \"addToManifest\": true,\n \"shipperID\": \"1234567890\"\n },\n \"specialServices\": [\n {\n \"inputParameters\": [\n {\n \"name\": \"INPUT_VALUE\",\n \"value\": \"100\"\n }\n ],\n \"specialserviceId\": \"Ins\"\n }\n ],\n \"metadata\": [\n {\n \"name\": \"costAccountName\",\n \"value\": \"costAccountName\"\n },\n {\n \"name\": \"costAccountId\",\n \"value\": \"costAccountId\"\n },\n {\n \"name\": \"costAccountCode\",\n \"value\": \"Code\"\n },\n {\n \"name\": \"accountCode\",\n \"value\": \"code\"\n },\n {\n \"name\": \"companyCode\",\n \"value\": \"code\"\n }\n ],\n \"carrierPayments\": [\n {\n \"accountNumber\": \"602684342\",\n \"countryCode\": \"US\",\n \"postalCode\": \"30305\",\n \"party\": \"BILL_RECEIVER\",\n \"typeOfCharge\": \"DUTIES_AND_TAXES\"\n }\n ],\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n },\n \"labelSize\": \"DOC_4X6\",\n \"labelType\": \"SHIPPING_LABEL\",\n \"labelFormat\": \"ZPL2\",\n \"printerAliasName\": \"test\",\n \"dateOfShipment\": \"{{todayDate}}\",\n \"deliveryOption\": {\n \"deliverBy\": \"{{tomorrowDate}}\",\n \"useBestNextDate\": false\n }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Single Parcel using Parcels","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":" {\n \"fromAddress\": {\n \"addressLine1\": \"638 Manitoba Ave1\",\n \"addressLine2\": \"638 Manitoba Ave2\",\n \"addressLine3\": \"638 Manitoba Ave3\",\n \"cityTown\": \"Winnipeg\",\n \"countryCode\": \"CA\",\n \"name\": \"Paul Wright\",\n \"company\": \"PB & Company\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"R2W 2H2\",\n \"stateProvince\": \"MB\"\n },\n \"toAddress\": {\n \"addressLine1\": \"947 Hammarskjold Dr1\",\n \"addressLine2\": \"947 Hammarskjold Dr2\",\n \"addressLine3\": \"947 Hammarskjold Dr3\",\n \"cityTown\": \"Burnaby\",\n \"countryCode\": \"CA\",\n \"name\": \"Paul Wright\",\n \"company\": \"QA & Company\",\n \"phone\": \"604-320-7572\",\n \"postalCode\": \"V5B 3C9\",\n \"stateProvince\": \"BC\"\n },\n \"altReturnAddress\": {\n \"company\": \"ABC Company\",\n \"name\": \"Rufous Sirius Canid\",\n \"phone\": \"323 555-1212\",\n \"email\": \"rs.canid@gmail.com\",\n \"addressLine1\": \"2976 Sherbrooke Ouest1\",\n \"addressLine2\": \"2976 Sherbrooke Ouest2\",\n \"addressLine3\": \"2976 Sherbrooke Ouest3\",\n \"cityTown\": \"Montreal\",\n \"stateProvince\": \"QC\",\n \"postalCode\": \"H4A1H3\",\n \"countryCode\": \"CA\"\n },\n \"additionalAddresses\": [\n {\n \"address\": {\n \"residential\": false,\n \"phone\": \"732-443-1007\",\n \"countryCode\": \"US\",\n \"company\": \"PB&Cmpany/Co.\",\n \"postalCode\": \"08810-1411\",\n \"cityTown\": \"DAYTON\",\n \"name\": \"Warehouse Manager\",\n \"stateProvince\": \"NJ\",\n \"addressLine1\": \"2270 US HIGHWAY 130\"\n },\n \"addressType\": \"THIRD_PARTY\"\n }\n ],\n \"soldToAddress\": {\n \"addressLine1\": \"47 W 13th St\",\n \"cityTown\": \"New York\",\n \"company\": \"ABC Company\",\n \"countryCode\": \"US\",\n \"email\": \"soldTo@email.com\",\n \"name\": \"soldToAddress Name\",\n \"phone\": \"323 555-1212\",\n \"postalCode\": \"10011\",\n \"residential\": false,\n \"stateProvince\": \"NY\"\n },\n \"parcels\": [\n {\n \"parcel\": {\n \"length\": 10,\n \"width\": 10,\n \"height\": 10,\n \"dimUnit\": \"CM\",\n \"weightUnit\": \"GM\",\n \"weight\": 2000\n },\n \"parcelType\": \"PKG\",\n \"specialServices\": [\n {\n \"specialServiceId\": \"ADD_HDL\"\n }\n ],\n \"items\": [\n {\n \"itemId\": \"sku1\",\n \"description\": \"Book\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"US\",\n \"originStateProvince\": \"TX\",\n \"quantity\": 2,\n \"unitPrice\": 10,\n \"weightUnit\": \"GM\",\n \"weight\": 80,\n \"orderNumber\": \"22\"\n },\n {\n \"itemId\": \"sku2\",\n \"description\": \"Geometry\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"CA\",\n \"originStateProvince\": \"MB\",\n \"quantity\": 1,\n \"unitPrice\": 101,\n \"weightUnit\": \"GM\",\n \"weight\": 432,\n \"orderNumber\": \"23\"\n }\n ],\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n }\n } \n ],\n \"customs\": {\n \"customsInfo\": {\n \"reasonForExport\": \"DOCUMENTS\",\n \"comments\": \"Test comment\",\n \"invoiceNumber\": \"001189223\",\n \"importerCustomsReference\": \"987654\",\n \"sdrValue\": 23.32,\n \"EELPFC\": \"NOEEI 30.2D2\",\n \"currencyCode\": \"USD\",\n \"fromCustomsReference\": \"EFEFE4554545\",\n \"licenseNumber\": \"456ABC123\",\n \"certificateNumber\": \"987\",\n \"customsDeclaredValue\": 6000,\n \"termsOfSale\": \"DDP\"\n }\n },\n \"parcelType\": \"PKG\",\n \"rateShopBy\": \"carrier\",\n \"byCarrier\": {\n \"carrierAccountId\": \"{{ups_carrier_id}}\",\n \"carrier\": \"UPS\",\n \"service\": \"NDA\"\n },\n \"shipmentOptions\": {\n \"addToManifest\": true,\n \"bypassAddressValidation\": \"toAddress\"\n },\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n },\n \"metadata\": [\n {\n \"name\": \"costAccountName\",\n \"value\": \"cost account 123\"\n }\n ],\n \"labelSize\": \"DOC_4X6\",\n \"labelType\": \"SHIPPING_LABEL\",\n \"labelFormat\": \"PDF\",\n \"dateOfShipment\": \"2026-04-29\",\n \"deliveryOption\": {\n \"deliverBy\": \"2026-05-28\",\n \"useBestNextDate\": false\n }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Multi-Parcel","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":" {\n \"fromAddress\": {\n \"addressLine1\": \"27 Waterview Dr\",\n \"cityTown\": \"Shelton\",\n \"stateProvince\": \"CT\",\n \"postalCode\": \"06484-4301\",\n \"countryCode\": \"US\",\n \"company\": \"ABC Company\",\n \"name\": \"Sasha Sekrotov\",\n \"phone\": \"323 555-1212\",\n \"email\": \"rs.canid@gmail.com\",\n \"residential\": true\n },\n \"toAddress\": {\n \"company\": \"Pitney Bowes Inc.\",\n \"name\": \"sender_fname\",\n \"phone\": \"2032032033\",\n \"email\": \"sender@email.com\",\n \"residential\": true,\n \"addressLine1\": \"27 Waterview Drive\",\n \"cityTown\": \"Shelton\",\n \"stateProvince\": \"CT\",\n \"postalCode\": \"06484-4301\",\n \"countryCode\": \"US\"\n },\n \"parcels\": [\n {\n \"parcel\": {\n \"length\": 10,\n \"width\": 10,\n \"height\": 10,\n \"dimUnit\": \"CM\",\n \"weightUnit\": \"GM\",\n \"weight\": 2000\n },\n \"parcelType\": \"PKG\",\n \"specialServices\": [\n {\n \"specialServiceId\": \"ADD_HDL\"\n }\n ],\n \"items\": [\n {\n \"itemId\": \"sku1\",\n \"description\": \"Book\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"US\",\n \"originStateProvince\": \"TX\",\n \"quantity\": 2,\n \"unitPrice\": 10,\n \"weightUnit\": \"GM\",\n \"weight\": 80,\n \"orderNumber\": \"22\"\n },\n {\n \"itemId\": \"sku2\",\n \"description\": \"Geometry\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"CA\",\n \"originStateProvince\": \"MB\",\n \"quantity\": 1,\n \"unitPrice\": 101,\n \"weightUnit\": \"GM\",\n \"weight\": 432,\n \"orderNumber\": \"23\"\n }\n ],\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n }\n },\n {\n \"parcel\": {\n \"length\": 10,\n \"width\": 10,\n \"height\": 10,\n \"dimUnit\": \"CM\",\n \"weightUnit\": \"GM\",\n \"weight\": 1500\n },\n \"parcelType\": \"PKG\",\n \"items\": [\n {\n \"itemId\": \"sku3\",\n \"description\": \"Jeans\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"US\",\n \"originStateProvince\": \"NY\",\n \"quantity\": 2,\n \"unitPrice\": 40,\n \"weightUnit\": \"GM\",\n \"weight\": 150,\n \"orderNumber\": \"22\"\n },\n {\n \"itemId\": \"sku4\",\n \"description\": \"Shoes\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"CA\",\n \"originStateProvince\": \"ON\",\n \"quantity\": 2,\n \"unitPrice\": 50,\n \"weightUnit\": \"GM\",\n \"weight\": 100,\n \"orderNumber\": \"23\"\n }\n ],\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n }\n }\n ],\n \"specialServices\": [\n {\n \"specialserviceId\": \"INS\",\n \"inputParameters\": [\n {\n \"name\": \"INPUT_VALUE\",\n \"value\": \"5000\"\n }\n ]\n }\n ],\n \"parcelType\": \"PKG\",\n \"rateShopBy\": \"carrier\",\n \"byCarrier\": {\n \"carrierAccountId\": \"{{ups_carrier_id}}\",\n \"carrier\": \"UPS\",\n \"service\": \"NDA\"\n },\n \"shipmentOptions\": {\n \"addToManifest\": true,\n \"bypassAddressValidation\": \"toAddress\"\n },\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n },\n \"metadata\": [\n {\n \"name\": \"costAccountName\",\n \"value\": \"testaccount1727765518\"\n }\n ],\n \"labelSize\": \"DOC_4X6\",\n \"labelType\": \"SHIPPING_LABEL\",\n \"labelFormat\": \"PDF\"\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-shipment-by-carrier-sample-response-payloads","__idx":14},"children":["Create Shipment (By Carrier) sample Response Payloads"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Single Parcel","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":" {\n \"correlationId\": \"de221671ff2c4a84891604c32cdf8221\",\n \"shipmentId\": \"UPS2202640808297347\",\n \"carrierAccountId\": \"vO396rorMdxZ8k1\",\n \"parcelTrackingNumber\": \"UPS2202640808297347\",\n \"labelLayout\": [\n {\n \"contentType\": \"BASE64\",\n \"contents\": \"Cl5YQQ0KXkxSTg0KXk1OWQ0KXk1GTixODQpeTEgxMCwxMg0KXk1DWQ0KXlBPSQ0KXlBXODEyDQpeQ0kyNw0KXkZPMTUsN15BME4sMjAsMjReRlZQQVVMIFdSSUdIVF5GUw0KXkZPMTUsMjdeQTBOLDIwLDI0XkZWMjAzLTU1NS0xMjEzXkZTDQpeRk8xNSw0N15BME4sMjAsMjReRlZQQVVMIFdSSUdIVF5GUw0KXkZPMTUsNjdeQTBOLDIwLDI0XkZWMjQxODIgS0FUSFkgQVZFXkZTDQpeRk8xNSw4N15BME4sMjAsMjReRlZMQUtFIEZPUkVTVCAgQ0EgOTI2MzAtMTgyN15GUw0KXkZPMTUsMTQyXkEwTiwyOCwzMl5GVlNISVAgVE86IF5GUw0KXkZPNjEsMTY2XkEwTiwyOCwzMl5GVlBBVUwgV1JJR0hUXkZTDQpeRk82MSwxOTReQTBOLDI4LDMyXkZWMjAzLTU1NS0xMjEzXkZTDQpeRk82MSwyMjJeQTBOLDI4LDMyXkZWUEFVTCBXUklHSFReRlMNCl5GTzYxLDI1MV...............................0KXkRODQpeWFoNCg==\",\n \"fileFormat\": \"ZPL2\",\n \"size\": \"DOC_4X6\",\n \"type\": \"SHIPPING_LABEL\"\n }\n ],\n \"parcel\": {\n \"length\": 2,\n \"height\": 1,\n \"width\": 1,\n \"dimUnit\": \"IN\",\n \"weightUnit\": \"OZ\",\n \"weight\": 2,\n \"packageValue\": 2\n },\n \"rate\": {\n \"baseCharge\": 102.45,\n \"carrier\": \"UPS\",\n \"currencyCode\": \"USD\",\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-04-27 12:00:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"inductionPostalCode\": \"92630\",\n \"parcelType\": \"PKG\",\n \"rateTypeId\": \"COMMERCIAL\",\n \"serviceId\": \"NDA\",\n \"specialServices\": [\n {\n \"specialServiceId\": \"Ins\",\n \"inputParameters\": [\n {\n \"name\": \"INPUT_VALUE\",\n \"value\": \"100\"\n }\n ],\n \"fee\": 0\n }\n ],\n \"surcharges\": [\n {\n \"fee\": 7,\n \"name\": \"RESIDENTIAL\"\n },\n {\n \"fee\": 33.11,\n \"name\": \"FUEL\"\n }\n ],\n \"totalCarrierCharge\": 141.13,\n \"isHazmat\": false,\n \"publishedTotalCarrierCharge\": 142.56\n },\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"department\": \"Name department\",\n \"poNumber\": \"R2W 2H2\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n },\n \"print\": {\n \"status\": \"error\",\n \"jobId\": \"AE95zYxKW9JKGEQ\",\n },\n \"fromAddress\": {\n \"addressLine1\": \"24182 Kathy Ave\",\n \"cityTown\": \"Lake Forest\",\n \"company\": \"Paul Wright\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"92630-1827\",\n \"residential\": true,\n \"stateProvince\": \"CA\",\n \"status\": \"VALIDATED_AND_NOT_CHANGED\"\n },\n \"toAddress\": {\n \"addressLine1\": \"55 Pharr Rd NW, Apt E104\",\n \"cityTown\": \"Atlanta\",\n \"company\": \"Paul Wright\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"30305-2151\",\n \"residential\": true,\n \"stateProvince\": \"GA\",\n \"status\": \"VALIDATED_AND_NOT_CHANGED\"\n },\n \"altReturnAddress\": {\n \"addressLine1\": \"24182 Kathy Ave\",\n \"cityTown\": \"Lake Forest\",\n \"countryCode\": \"US\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"92630-1827\",\n \"residential\": false,\n \"stateProvince\": \"CA\"\n },\n \"shipmentOptions\": {\n \"billingWeight\": \"16.0\"\n },\n \"soldToAddress\": {\n \"addressLine1\": \"70 Hanlan RD\",\n \"addressLine2\": \"Suite 101\",\n \"addressLine3\": \"Near central market\",\n \"cityTown\": \"Woodbridge\",\n \"company\": \"ABC Company\",\n \"countryCode\": \"CA\",\n \"email\": \"billing@abccompany.com\",\n \"name\": \"John Doe\",\n \"phone\": \"905-555-1234\",\n \"postalCode\": \"L4L 3P6\",\n \"residential\": false,\n \"stateProvince\": \"ON\",\n \"taxId\": \"string\",\n \"taxIdType\": \"EIN\"\n },\n \"carrierPayments\": [\n {\n \"accountNumber\": \"602684342\",\n \"countryCode\": \"US\",\n \"party\": \"BILL_RECEIVER\",\n \"postalCode\": \"30305\",\n \"typeOfCharge\": \"DUTIES_AND_TAXES\"\n }\n ],\n \"additionalAddresses\": [\n {\n \"address\": {\n \"addressLine1\": \"2270 US HIGHWAY 130\",\n \"cityTown\": \"DAYTON\",\n \"company\": \"ABC Company\",\n \"countryCode\": \"US\",\n \"name\": \"Warehouse Manager\",\n \"phone\": \"732-443-1007\",\n \"postalCode\": \"08810-1411\",\n \"residential\": false,\n \"stateProvince\": \"NJ\"\n },\n \"addressType\": \"SHIPPER\"\n }\n ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Single Parcel using Parcels","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":" {\n \"correlationId\": \"418b261f7c344fc8b0a5e14074dcf94a\",\n \"shipmentId\": \"UPS2202642019792180\",\n \"carrierAccountId\": \"ZPeWkjzLXLz3AY8\",\n \"parcelTrackingNumber\": \"UPS2202642019792180\",\n \"labelLayout\": [\n {\n \"contentType\": \"URL\",\n \"contents\": \"https://prv-labels.gcs.pitneycloud.com/418b261f7c344fc8b0a5e14074dcf94a.pdf\",\n \"fileFormat\": \"PDF\",\n \"size\": \"DOC_4X6\",\n \"type\": \"SHIPPING_LABEL\"\n }\n ],\n \"rate\": {\n \"baseCharge\": 96.35,\n \"baseChargeTaxes\": [\n {\n \"displayName\": \"GST\",\n \"name\": \"GST\",\n \"taxAmount\": 8.39\n }\n ],\n \"carrier\": \"UPS\",\n \"currencyCode\": \"CAD\",\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-05-01 10:30:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"parcelType\": \"PKG\",\n \"rateTypeId\": \"COMMERCIAL\",\n \"serviceId\": \"NDA\",\n \"specialServices\": [\n {\n \"specialServiceId\": \"ADD_HDL\",\n \"fee\": 30.05\n }\n ],\n \"surcharges\": [\n {\n \"fee\": 42.98,\n \"name\": \"FUEL\"\n }\n ],\n \"totalCarrierCharge\": 176.07,\n \"totalTaxAmount\": 8.39,\n \"isHazmat\": false\n },\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n },\n \"parcels\": [\n {\n \"parcel\": {\n \"length\": 10,\n \"height\": 10,\n \"width\": 10,\n \"dimUnit\": \"CM\",\n \"weightUnit\": \"GM\",\n \"weight\": 2000\n },\n \"items\": [\n {\n \"itemId\": \"sku1\",\n \"description\": \"Book\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"US\",\n \"originStateProvince\": \"TX\",\n \"quantity\": 2,\n \"unitPrice\": 10,\n \"orderNumber\": \"22\",\n \"weightUnit\": \"GM\",\n \"weight\": 80\n },\n {\n \"itemId\": \"sku2\",\n \"description\": \"Geometry\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"CA\",\n \"originStateProvince\": \"MB\",\n \"quantity\": 1,\n \"unitPrice\": 101,\n \"orderNumber\": \"23\",\n \"weightUnit\": \"GM\",\n \"weight\": 432\n }\n ],\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n }\n }\n ],\n \"fromAddress\": {\n \"addressLine1\": \"638 Manitoba Ave1\",\n \"addressLine2\": \"638 Manitoba Ave2\",\n \"addressLine3\": \"638 Manitoba Ave3\",\n \"cityTown\": \"Winnipeg\",\n \"company\": \"PB & Company\",\n \"countryCode\": \"CA\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"R2W2H2\",\n \"residential\": false,\n \"stateProvince\": \"MB\"\n },\n \"toAddress\": {\n \"addressLine1\": \"947 Hammarskjold Dr1\",\n \"addressLine2\": \"947 Hammarskjold Dr2\",\n \"addressLine3\": \"947 Hammarskjold Dr3\",\n \"cityTown\": \"Burnaby\",\n \"company\": \"QA & Company\",\n \"countryCode\": \"CA\",\n \"name\": \"Paul Wright\",\n \"phone\": \"604-320-7572\",\n \"postalCode\": \"V5B3C9\",\n \"residential\": false,\n \"stateProvince\": \"BC\"\n },\n \"altReturnAddress\": {\n \"addressLine1\": \"2976 Sherbrooke Ouest1\",\n \"addressLine2\": \"2976 Sherbrooke Ouest2\",\n \"addressLine3\": \"2976 Sherbrooke Ouest3\",\n \"cityTown\": \"Montreal\",\n \"company\": \"ABC Company\",\n \"countryCode\": \"CA\",\n \"email\": \"rs.canid@gmail.com\",\n \"name\": \"Rufous Sirius Canid\",\n \"phone\": \"323 555-1212\",\n \"postalCode\": \"H4A1H3\",\n \"residential\": false,\n \"stateProvince\": \"QC\"\n },\n \"shipmentOptions\": {\n \"billingWeight\": \"2200.0\"\n },\n \"customs\": {\n \"customsInfo\": {\n \"EELPFC\": \"NOEEI 30.2D2\",\n \"certificateNumber\": \"987\",\n \"comments\": \"Test comment\",\n \"currencyCode\": \"USD\",\n \"customsDeclaredValue\": 0,\n \"fromCustomsReference\": \"EFEFE4554545\",\n \"importerCustomsReference\": \"987654\",\n \"insuredAmount\": 0,\n \"invoiceNumber\": \"001189223\",\n \"licenseNumber\": \"456ABC123\",\n \"reasonForExport\": \"DOCUMENTS\",\n \"sdrValue\": 23.32,\n \"termsOfSale\": \"DDP\"\n }\n },\n \"soldToAddress\": {\n \"addressLine1\": \"47 W 13th St\",\n \"cityTown\": \"New York\",\n \"company\": \"ABC Company\",\n \"countryCode\": \"US\",\n \"email\": \"soldTo@email.com\",\n \"name\": \"soldToAddress Name\",\n \"phone\": \"323 555-1212\",\n \"postalCode\": \"10011\",\n \"residential\": false,\n \"stateProvince\": \"NY\"\n },\n \"carrierPayments\": [\n {\n \"accountNumber\": \"4YE336\",\n \"countryCode\": \"CA\",\n \"party\": \"BILL_SENDER\",\n \"postalCode\": \"R2W2H2\",\n \"typeOfCharge\": \"TRANSPORTATION_CHARGES\"\n },\n {\n \"accountNumber\": \"4YE336\",\n \"countryCode\": \"CA\",\n \"party\": \"BILL_SENDER\",\n \"postalCode\": \"R2W2H2\",\n \"typeOfCharge\": \"DUTIES_AND_TAXES\"\n }\n ],\n \"additionalAddresses\": [\n {\n \"address\": {\n \"addressLine1\": \"2270 US HIGHWAY 130\",\n \"cityTown\": \"DAYTON\",\n \"company\": \"PB&Cmpany/Co.\",\n \"countryCode\": \"US\",\n \"name\": \"Warehouse Manager\",\n \"phone\": \"732-443-1007\",\n \"postalCode\": \"08810-1411\",\n \"residential\": false,\n \"stateProvince\": \"NJ\"\n },\n \"addressType\": \"THIRD_PARTY\"\n }\n ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Multi-Parcel","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":" {\n \"correlationId\": \"5f38f427c35e4f1783e32e3f67be7a76\",\n \"shipmentId\": \"UPS2202641925153954\",\n \"carrierAccountId\": \"ZPeWkjzLXLz3AY8\",\n \"parcelTrackingNumber\": \"UPS2202641925153954P0\",\n \"labelLayout\": [\n {\n \"contentType\": \"URL\",\n \"contents\": \"https://225934331380-sending-service-dev.s3.us-east-1.amazonaws.com/temp-labels/UPS2202641925153954P0.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Checksum-Mode=ENABLED&X-Amz-Credential=ASIATJGV4JX2MFQ5KGYP%........................70c1747a034e5c1f5b5bb6a6\",\n \"fileFormat\": \"PDF\",\n \"size\": \"DOC_4X6\",\n \"type\": \"SHIPPING_LABEL\"\n }\n ],\n \"rate\": {\n \"baseCharge\": 116.1,\n \"baseChargeTaxes\": [\n {\n \"displayName\": \"GST\",\n \"name\": \"GST\",\n \"taxAmount\": 11\n }\n ],\n \"carrier\": \"UPS\",\n \"currencyCode\": \"CAD\",\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-05-01 10:30:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"rateTypeId\": \"commercial\",\n \"serviceId\": \"NDA\",\n \"surcharges\": [\n {\n \"fee\": 73.9,\n \"name\": \"FUEL\"\n }\n ],\n \"totalCarrierCharge\": 228.74,\n \"totalTaxAmount\": 11,\n \"isHazmat\": false\n },\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n },\n \"parcels\": [\n {\n \"parcelType\": \"PKG\",\n \"parcel\": {\n \"length\": 10,\n \"height\": 10,\n \"width\": 10,\n \"dimUnit\": \"CM\",\n \"weightUnit\": \"GM\",\n \"weight\": 2000\n },\n \"parcelTrackingNumber\": \"UPS2202641925153954P0\",\n \"parcelRate\": {\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-05-01 10:30:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"isHazmat\": false\n },\n \"specialServices\": [\n {\n \"specialServiceId\": \"ADD_HDL\",\n \"fee\": 30.05,\n \"brandedName\": \"Additional Handling\"\n }\n ],\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n },\n \"items\": [\n {\n \"itemId\": \"sku1\",\n \"description\": \"Book\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"US\",\n \"originStateProvince\": \"TX\",\n \"quantity\": 2,\n \"unitPrice\": 10,\n \"orderNumber\": \"22\",\n \"weightUnit\": \"GM\",\n \"weight\": 80\n },\n {\n \"itemId\": \"sku2\",\n \"description\": \"Geometry\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"CA\",\n \"originStateProvince\": \"MB\",\n \"quantity\": 1,\n \"unitPrice\": 101,\n \"orderNumber\": \"23\",\n \"weightUnit\": \"GM\",\n \"weight\": 432\n }\n ]\n },\n {\n \"parcelType\": \"PKG\",\n \"parcel\": {\n \"length\": 10,\n \"height\": 10,\n \"width\": 10,\n \"dimUnit\": \"CM\",\n \"weightUnit\": \"GM\",\n \"weight\": 1500\n },\n \"parcelTrackingNumber\": \"UPS2202641925153954P1\",\n \"parcelRate\": {\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-05-01 10:30:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"isHazmat\": false\n },\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n },\n \"items\": [\n {\n \"itemId\": \"sku3\",\n \"description\": \"Jeans\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"US\",\n \"originStateProvince\": \"NY\",\n \"quantity\": 2,\n \"unitPrice\": 40,\n \"orderNumber\": \"22\",\n \"weightUnit\": \"GM\",\n \"weight\": 150\n },\n {\n \"itemId\": \"sku4\",\n \"description\": \"Shoes\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"CA\",\n \"originStateProvince\": \"ON\",\n \"quantity\": 2,\n \"unitPrice\": 50,\n \"orderNumber\": \"23\",\n \"weightUnit\": \"GM\",\n \"weight\": 100\n }\n ]\n }\n ],\n \"fromAddress\": {\n \"addressLine1\": \"638 Manitoba Ave1\",\n \"addressLine2\": \"638 Manitoba Ave2\",\n \"addressLine3\": \"638 Manitoba Ave3\",\n \"cityTown\": \"Winnipeg\",\n \"company\": \"PB & Company\",\n \"countryCode\": \"CA\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"R2W2H2\",\n \"residential\": false,\n \"stateProvince\": \"MB\"\n },\n \"toAddress\": {\n \"addressLine1\": \"947 Hammarskjold Dr1\",\n \"addressLine2\": \"947 Hammarskjold Dr2\",\n \"addressLine3\": \"947 Hammarskjold Dr3\",\n \"cityTown\": \"Burnaby\",\n \"company\": \"QA & Company\",\n \"countryCode\": \"CA\",\n \"name\": \"Paul Wright\",\n \"phone\": \"604-320-7572\",\n \"postalCode\": \"V5B3C9\",\n \"residential\": false,\n \"stateProvince\": \"BC\"\n },\n \"altReturnAddress\": {\n \"addressLine1\": \"2976 Sherbrooke Ouest1\",\n \"addressLine2\": \"2976 Sherbrooke Ouest2\",\n \"addressLine3\": \"2976 Sherbrooke Ouest3\",\n \"cityTown\": \"Montreal\",\n \"company\": \"ABC Company\",\n \"countryCode\": \"CA\",\n \"email\": \"rs.canid@gmail.com\",\n \"name\": \"Rufous Sirius Canid\",\n \"phone\": \"323 555-1212\",\n \"postalCode\": \"H4A1H3\",\n \"residential\": false,\n \"stateProvince\": \"QC\"\n },\n \"shipmentOptions\": {\n \"bypassAddressValidation\": \"toAddress\",\n \"billingWeight\": \"144.0\"\n },\n \"customs\": {\n \"customsInfo\": {\n \"EELPFC\": \"NOEEI 30.2D2\",\n \"certificateNumber\": \"987\",\n \"comments\": \"Test comment\",\n \"currencyCode\": \"USD\",\n \"customsDeclaredValue\": 0,\n \"fromCustomsReference\": \"EFEFE4554545\",\n \"importerCustomsReference\": \"987654\",\n \"insuredAmount\": 0,\n \"invoiceNumber\": \"001189223\",\n \"licenseNumber\": \"456ABC123\",\n \"reasonForExport\": \"DOCUMENTS\",\n \"sdrValue\": 23.32,\n \"termsOfSale\": \"DDP\"\n }\n },\n \"soldToAddress\": {\n \"addressLine1\": \"47 W 13th St\",\n \"cityTown\": \"New York\",\n \"company\": \"ABC Company\",\n \"countryCode\": \"US\",\n \"email\": \"soldTo@email.com\",\n \"name\": \"soldToAddress Name\",\n \"phone\": \"323 555-1212\",\n \"postalCode\": \"10011\",\n \"residential\": false,\n \"stateProvince\": \"NY\"\n },\n \"carrierPayments\": [\n {\n \"accountNumber\": \"4YE336\",\n \"countryCode\": \"CA\",\n \"party\": \"BILL_SENDER\",\n \"postalCode\": \"R2W2H2\",\n \"typeOfCharge\": \"TRANSPORTATION_CHARGES\"\n },\n {\n \"accountNumber\": \"4YE336\",\n \"countryCode\": \"CA\",\n \"party\": \"BILL_SENDER\",\n \"postalCode\": \"R2W2H2\",\n \"typeOfCharge\": \"DUTIES_AND_TAXES\"\n }\n ],\n \"additionalAddresses\": [\n {\n \"address\": {\n \"addressLine1\": \"2270 US HIGHWAY 130\",\n \"cityTown\": \"DAYTON\",\n \"company\": \"PB&Cmpany/Co.\",\n \"countryCode\": \"US\",\n \"name\": \"Warehouse Manager\",\n \"phone\": \"732-443-1007\",\n \"postalCode\": \"08810-1411\",\n \"residential\": false,\n \"stateProvince\": \"NJ\"\n },\n \"addressType\": \"THIRD_PARTY\"\n }\n ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Multi-Parcel (split labels)","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":" {\n \"correlationId\": \"2e44c3496d784501bd23a82bc35f2350\",\n \"shipmentId\": \"UPS2202642019578998\",\n \"carrierAccountId\": \"ZPeWkjzLXLz3AY8\",\n \"parcelTrackingNumber\": \"UPS2202642019578998P0\",\n \"rate\": {\n \"baseCharge\": 116.1,\n \"baseChargeTaxes\": [\n {\n \"displayName\": \"GST\",\n \"name\": \"GST\",\n \"taxAmount\": 11\n }\n ],\n \"carrier\": \"UPS\",\n \"currencyCode\": \"CAD\",\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-05-01 10:30:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"rateTypeId\": \"commercial\",\n \"serviceId\": \"NDA\",\n \"surcharges\": [\n {\n \"fee\": 73.9,\n \"name\": \"FUEL\"\n }\n ],\n \"totalCarrierCharge\": 228.74,\n \"totalTaxAmount\": 11,\n \"isHazmat\": false\n },\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n },\n \"parcels\": [\n {\n \"parcelType\": \"PKG\",\n \"parcel\": {\n \"length\": 10,\n \"height\": 10,\n \"width\": 10,\n \"dimUnit\": \"CM\",\n \"weightUnit\": \"GM\",\n \"weight\": 2000\n },\n \"parcelTrackingNumber\": \"UPS2202642019578998P0\",\n \"parcelRate\": {\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-05-01 10:30:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"isHazmat\": false\n },\n \"specialServices\": [\n {\n \"specialServiceId\": \"ADD_HDL\",\n \"fee\": 30.05,\n \"brandedName\": \"Additional Handling\"\n }\n ],\n \"document\": {\n \"contentType\": \"URL\",\n \"contents\": \"https://prv-labels.gcs.pitneycloud.com/2e44c3496d784501bd23a82bc35f2350-0-0.pdf\",\n \"fileFormat\": \"PDF\",\n \"size\": \"DOC_4X6\",\n \"type\": \"SHIPPING_LABEL\"\n },\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n },\n \"items\": [\n {\n \"itemId\": \"sku1\",\n \"description\": \"Book\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"US\",\n \"originStateProvince\": \"TX\",\n \"quantity\": 2,\n \"unitPrice\": 10,\n \"orderNumber\": \"22\",\n \"weightUnit\": \"GM\",\n \"weight\": 80\n },\n {\n \"itemId\": \"sku2\",\n \"description\": \"Geometry\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"CA\",\n \"originStateProvince\": \"MB\",\n \"quantity\": 1,\n \"unitPrice\": 101,\n \"orderNumber\": \"23\",\n \"weightUnit\": \"GM\",\n \"weight\": 432\n }\n ]\n },\n {\n \"parcelType\": \"PKG\",\n \"parcel\": {\n \"length\": 10,\n \"height\": 10,\n \"width\": 10,\n \"dimUnit\": \"CM\",\n \"weightUnit\": \"GM\",\n \"weight\": 1500\n },\n \"parcelTrackingNumber\": \"UPS2202642019578998P1\",\n \"parcelRate\": {\n \"deliveryCommitment\": {\n \"estimatedDeliveryDateTime\": \"2026-05-01 10:30:00\",\n \"guarantee\": \"FULL\",\n \"maxEstimatedNumberOfDays\": \"1\",\n \"minEstimatedNumberOfDays\": \"1\"\n },\n \"isHazmat\": false\n },\n \"document\": {\n \"contentType\": \"URL\",\n \"contents\": \"https://prv-labels.gcs.pitneycloud.com/2e44c3496d784501bd23a82bc35f2350-1-0.pdf\",\n \"fileFormat\": \"PDF\",\n \"size\": \"DOC_4X6\",\n \"type\": \"SHIPPING_LABEL\"\n },\n \"references\": {\n \"reference1\": \"123456\",\n \"reference2\": \"SendTech\",\n \"reference3\": \"98437\",\n \"reference4\": \"UPS Shipping\",\n \"poNumber\": \"R2W 2H2\",\n \"department\": \"Name department\",\n \"additionalReference1\": \"612987641\",\n \"additionalReference2\": \"989\",\n \"shippingNotes\": \"Handle with care\",\n \"ShipperReference\": \"REF123456789\",\n \"transportationReference\": \"TRANSREF987654321\"\n },\n \"items\": [\n {\n \"itemId\": \"sku3\",\n \"description\": \"Jeans\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"US\",\n \"originStateProvince\": \"NY\",\n \"quantity\": 2,\n \"unitPrice\": 40,\n \"orderNumber\": \"22\",\n \"weightUnit\": \"GM\",\n \"weight\": 150\n },\n {\n \"itemId\": \"sku4\",\n \"description\": \"Shoes\",\n \"hSTariffCode\": \"490191\",\n \"originCountryCode\": \"CA\",\n \"originStateProvince\": \"ON\",\n \"quantity\": 2,\n \"unitPrice\": 50,\n \"orderNumber\": \"23\",\n \"weightUnit\": \"GM\",\n \"weight\": 100\n }\n ]\n }\n ],\n \"fromAddress\": {\n \"addressLine1\": \"638 Manitoba Ave1\",\n \"addressLine2\": \"638 Manitoba Ave2\",\n \"addressLine3\": \"638 Manitoba Ave3\",\n \"cityTown\": \"Winnipeg\",\n \"company\": \"PB & Company\",\n \"countryCode\": \"CA\",\n \"name\": \"Paul Wright\",\n \"phone\": \"203-555-1213\",\n \"postalCode\": \"R2W2H2\",\n \"residential\": false,\n \"stateProvince\": \"MB\"\n },\n \"toAddress\": {\n \"addressLine1\": \"947 Hammarskjold Dr1\",\n \"addressLine2\": \"947 Hammarskjold Dr2\",\n \"addressLine3\": \"947 Hammarskjold Dr3\",\n \"cityTown\": \"Burnaby\",\n \"company\": \"QA & Company\",\n \"countryCode\": \"CA\",\n \"name\": \"Paul Wright\",\n \"phone\": \"604-320-7572\",\n \"postalCode\": \"V5B3C9\",\n \"residential\": false,\n \"stateProvince\": \"BC\"\n },\n \"altReturnAddress\": {\n \"addressLine1\": \"2976 Sherbrooke Ouest1\",\n \"addressLine2\": \"2976 Sherbrooke Ouest2\",\n \"addressLine3\": \"2976 Sherbrooke Ouest3\",\n \"cityTown\": \"Montreal\",\n \"company\": \"ABC Company\",\n \"countryCode\": \"CA\",\n \"email\": \"rs.canid@gmail.com\",\n \"name\": \"Rufous Sirius Canid\",\n \"phone\": \"323 555-1212\",\n \"postalCode\": \"H4A1H3\",\n \"residential\": false,\n \"stateProvince\": \"QC\"\n },\n \"shipmentOptions\": {\n \"bypassAddressValidation\": \"toAddress\",\n \"billingWeight\": \"144.0\"\n },\n \"customs\": {\n \"customsInfo\": {\n \"EELPFC\": \"NOEEI 30.2D2\",\n \"certificateNumber\": \"987\",\n \"comments\": \"Test comment\",\n \"currencyCode\": \"USD\",\n \"customsDeclaredValue\": 0,\n \"fromCustomsReference\": \"EFEFE4554545\",\n \"importerCustomsReference\": \"987654\",\n \"insuredAmount\": 0,\n \"invoiceNumber\": \"001189223\",\n \"licenseNumber\": \"456ABC123\",\n \"reasonForExport\": \"DOCUMENTS\",\n \"sdrValue\": 23.32,\n \"termsOfSale\": \"DDP\"\n }\n },\n \"soldToAddress\": {\n \"addressLine1\": \"47 W 13th St\",\n \"cityTown\": \"New York\",\n \"company\": \"ABC Company\",\n \"countryCode\": \"US\",\n \"email\": \"soldTo@email.com\",\n \"name\": \"soldToAddress Name\",\n \"phone\": \"323 555-1212\",\n \"postalCode\": \"10011\",\n \"residential\": false,\n \"stateProvince\": \"NY\"\n },\n \"carrierPayments\": [\n {\n \"accountNumber\": \"4YE336\",\n \"countryCode\": \"CA\",\n \"party\": \"BILL_SENDER\",\n \"postalCode\": \"R2W2H2\",\n \"typeOfCharge\": \"TRANSPORTATION_CHARGES\"\n },\n {\n \"accountNumber\": \"4YE336\",\n \"countryCode\": \"CA\",\n \"party\": \"BILL_SENDER\",\n \"postalCode\": \"R2W2H2\",\n \"typeOfCharge\": \"DUTIES_AND_TAXES\"\n }\n ],\n \"additionalAddresses\": [\n {\n \"address\": {\n \"addressLine1\": \"2270 US HIGHWAY 130\",\n \"cityTown\": \"DAYTON\",\n \"company\": \"PB&Cmpany/Co.\",\n \"countryCode\": \"US\",\n \"name\": \"Warehouse Manager\",\n \"phone\": \"732-443-1007\",\n \"postalCode\": \"08810-1411\",\n \"residential\": false,\n \"stateProvince\": \"NJ\"\n },\n \"addressType\": \"THIRD_PARTY\"\n }\n ]\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-behavior-and-rules","__idx":15},"children":["Key behavior and rules"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A request must use only one parcel structure. Do not include both parcel and parcels in the same request."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The parcels array can be used for both single-parcel and multi-parcel shipments. There is no restriction on using it only for multiple parcels."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Shipment-level specialServices continue to work as before and apply to the entire shipment. In addition, parcel-level specialServices can be defined within each parcel item when using the parcels structure."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All other fields in the Create Shipment request remain unchanged and behave consistently across both structures."]}]}]}]},"headings":[{"value":"Shipment: Single Parcel and Multi-Parcel Support","id":"shipment-single-parcel-and-multi-parcel-support","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"What is supported now","id":"what-is-supported-now","depth":2},{"value":"Existing structure","id":"existing-structure","depth":3},{"value":"New structure","id":"new-structure","depth":3},{"value":"How to choose between the two structures","id":"how-to-choose-between-the-two-structures","depth":2},{"value":"Existing single-parcel request structure","id":"existing-single-parcel-request-structure","depth":2},{"value":"API Operations","id":"api-operations","depth":3},{"value":"Base URL for US Region","id":"base-url-for-us-region","depth":4},{"value":"Base URL for CA Region","id":"base-url-for-ca-region","depth":4},{"value":"Header:","id":"header","depth":4},{"value":"Rate Shipment (By Carrier) sample Request Payloads","id":"rate-shipment-by-carrier-sample-request-payloads","depth":3},{"value":"Rate Shipment (By Carrier) Response Payloads","id":"rate-shipment-by-carrier-response-payloads","depth":3},{"value":"Create Shipment (By Carrier) sample Request Payloads","id":"create-shipment-by-carrier-sample-request-payloads","depth":3},{"value":"Create Shipment (By Carrier) sample Response Payloads","id":"create-shipment-by-carrier-sample-response-payloads","depth":3},{"value":"Key behavior and rules","id":"key-behavior-and-rules","depth":2}],"frontmatter":{"title":"Single Parcel and Multi-Parcel Support","description":"The Create Shipment API now supports both the existing single-parcel request structure and a new parcels-based structure for single-parcel and multi-parcel shipment creation.","seo":{"title":"Shipment: Single Parcel and Multi-Parcel Support"}},"lastModified":"2026-06-24T09:51:54.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/shipping/shipment/multiparcel","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}