{"items":[{"type":"link","label":"Overview","link":"/openapi/shipping","routeSlug":"/openapi/shipping","content":{"contentType":"overview","meta":{"name":"Overview"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"shipping.json","url":"/_bundle/openapi/shipping.json?download"},{"kind":"download","label":"shipping.yaml","url":"/_bundle/openapi/shipping.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Overview (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Shipping APIs provide a unified, multi-carrier platform to rate shipments, generate labels, manage pickups, and track parcel movement from creation through delivery. These APIs support a wide range of carriers and services, enabling developers to integrate shipping functionalities into their applications with ease. The Shipping APIs are designed to handle single-parcel, multi-parcel, and high-volume workflows. They also include features for managing carrier accounts, configuring defaults, and handling post-shipment operations like reprints, cancellations, and tracking updates. With comprehensive documentation, sample code, and a sandbox environment for testing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are integrating for the first time, follow this path:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate before calling Shipping APIs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/auth/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auth API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an OAuth access token."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the token in the Authorization header for every request: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":2,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start with account and carrier setup"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Get Carrier Accounts to identify available carrierAccountId values."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Get Carriers, Get Services, Get Parcel Types, and Get Special Services to discover what is valid for your scenario."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":3,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate shipment inputs before creating labels"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm address quality with the Address APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For international shipments, prepare customs data and upload Electronic Trade Documents when required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":4,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate first, then ship"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Rate Shipment to compare options by carrier, rate group, rule set, Ship Via Code, or external system code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Create Shipment to generate the label once the preferred option is selected."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":5,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage post-shipment operations"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reprint or cancel labels when needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve shipment details and tracking updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schedule pickups, check pickup availability, and generate pickup documents."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":6,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Batch Shipments for high-volume processing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Batch Shipment APIs when creating large shipment volumes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Choose synchronous bulk creation or asynchronous CSV import, then process and monitor using batchId."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use batch status, shipment-level details, and batch void operations to manage exceptions at scale."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":7,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optimize for production scale"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Defaults to reduce repeated request fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Multipiece Shipment for multi-parcel workflows."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use metadata, references, manifests, and reports for operational control and reconciliation."},"children":[]}]}]}]}]}],"sectionId":"/openapi/shipping"}],"sectionId":"/openapi/shipping"}]}]}},{"type":"group","label":"Shipment","link":"/openapi/shipping/shipment","routeSlug":"/openapi/shipping/shipment","items":[{"label":"Get Carriers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getcarriers","routeSlug":"/openapi/shipping/shipment/getcarriers","metadata":{"seo":{"title":"Get Carriers","description":"The operation fetches all supported carriers. This service is used to get list of supported carriers and their properties."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCarriers","name":"Get Carriers","isWebhook":false,"pointer":"/paths/~1api~1v1~1carriers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Carriers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The operation fetches all supported carriers. This service is used to get list of supported carriers and their properties."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1carriers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/carriers","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/carriers","href":"shipment/getcarriers","openApiOperationId":"getCarriers","summary":"Get Carriers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The available carriers have been fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/carriers"}},"schemaId":"components/schemas/carriers","headers":{"X-PB-TransactionId":{"description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system.","schema":{"type":"string"}}},"headerSchemaId":"schema_346"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1carriers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/carriers","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/carriers"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/getcarriers"}],"panels":[]}]},"httpPath":"/api/v1/carriers"},{"label":"Carrier facilities","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/carrierfacility","routeSlug":"/openapi/shipping/shipment/carrierfacility","metadata":{"seo":{"title":"Carrier facilities","description":"This operation locates Post Offices and other facilities for a given carrier. You can use this operation, for example, to locate all USPS Post Offices near a given postal code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"carrierFacility","name":"Carrier facilities","isWebhook":false,"pointer":"/paths/~1api~1v1~1carrier-facility/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Carrier facilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation locates Post Offices and other facilities for a given carrier. You can use this operation, for example, to locate all USPS Post Offices near a given postal code.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CarrierFacilityRequest"}},"schemaId":"components/schemas/CarrierFacilityRequest","pointer":"/paths/~1api~1v1~1carrier-facility/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/carrier-facility","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CarrierFacilityRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/carrier-facility","href":"shipment/carrierfacility","openApiOperationId":"carrierFacility","summary":"Carrier facilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/CarrierFacilityRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CarrierFacilityRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Facilities available at the specified location have been fetched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CarrierFacilityResponse","exampleIds":["paths/~1api~1v1~1carrier-facility/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CarrierFacilityResponse","exampleIds":["paths/~1api~1v1~1carrier-facility/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1carrier-facility/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CarrierFacilityResponse","exampleIds":["paths/~1api~1v1~1carrier-facility/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CarrierFacilityResponse","exampleIds":["paths/~1api~1v1~1carrier-facility/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/carrierfacility"}],"panels":[]}]},"httpPath":"/api/v1/carrier-facility"},{"label":"Get Countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getcountries","routeSlug":"/openapi/shipping/shipment/getcountries","metadata":{"seo":{"title":"Get Countries","description":"The operation fetches list of supported destination countries for a provided carrier and origin country. If query parameters are not provided, it will default to USPS as carrier and US as origin country."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCountries","name":"Get Countries","isWebhook":false,"pointer":"/paths/~1api~1v1~1countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Countries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation fetches list of supported destination countries for a provided carrier and origin country. If query parameters are not provided, it will default to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as carrier and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as origin country."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"carrier","in":"query","schemaId":"schema_345","description":"The carrierID, a unique identifier given to an individual carrier."},{"name":"originCountryCode","in":"query","schemaId":"schema_345","description":"The Source Country. The two-character ISO country code for the country where the Shipment originates."}],"pointer":"/paths/~1api~1v1~1countries/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1countries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/countries","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"carrier","in":"query","required":false,"schemaId":"schema_345"},{"name":"originCountryCode","in":"query","required":false,"schemaId":"schema_345"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/countries","href":"shipment/getcountries","openApiOperationId":"getCountries","summary":"Get Countries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Countries has been fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/countries","exampleIds":["paths/~1api~1v1~1countries/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/countries","exampleIds":["paths/~1api~1v1~1countries/get/responses/200/content/application~1json/example"],"headers":{"X-PB-TransactionId":{"description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system.","schema":{"type":"string","example":"GmeMZJ9YDK5z87b"}}},"headerSchemaId":"schema_347"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/countries","exampleIds":["paths/~1api~1v1~1countries/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/countries","exampleIds":["paths/~1api~1v1~1countries/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/getcountries"}],"panels":[]}]},"httpPath":"/api/v1/countries"},{"label":"Get Services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getservices","routeSlug":"/openapi/shipping/shipment/getservices","metadata":{"seo":{"title":"Get Services","description":"The operation fetches a list of supported services for a carrier with respect to specific origin and destination country. If query parameters are not provided, this will default to USPS as carrier, US as both origin and destination country code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getServices","name":"Get Services","isWebhook":false,"pointer":"/paths/~1api~1v1~1services/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation fetches a list of supported services for a carrier with respect to specific origin and destination country. If query parameters are not provided, this will default to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as carrier, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as both origin and destination country code."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"carrier","in":"query","schemaId":"schema_345","description":"The CarrierID, a unique identifier provided to an individual carrier. It can be referred from the response of Get Carriers API"},{"name":"originCountryCode","in":"query","schemaId":"schema_345","description":"The Source Country. The two-character ISO country code for the country where the Shipment originates."},{"name":"destinationCountryCode","in":"query","schemaId":"schema_345","description":"The Destination Country for the Shipment. The two-character ISO country code for the country where the shipment is to be delivered."}],"pointer":"/paths/~1api~1v1~1services/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1services/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/services","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"carrier","in":"query","required":false,"schemaId":"schema_345"},{"name":"originCountryCode","in":"query","required":false,"schemaId":"schema_345"},{"name":"destinationCountryCode","in":"query","required":false,"schemaId":"schema_345"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/services","href":"shipment/getservices","openApiOperationId":"getServices","summary":"Get Services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of services has been fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/services","exampleIds":["paths/~1api~1v1~1services/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/services","exampleIds":["paths/~1api~1v1~1services/get/responses/200/content/application~1json/example"],"headers":{"X-PB-TransactionId":{"description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system.","schema":{"type":"string","example":"XbxjOb5BR7lwMAe"}}},"headerSchemaId":"schema_348"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1services/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/services","exampleIds":["paths/~1api~1v1~1services/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/services","exampleIds":["paths/~1api~1v1~1services/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/getservices"}],"panels":[]}]},"httpPath":"/api/v1/services"},{"label":"Get Parcel Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getparceltypes","routeSlug":"/openapi/shipping/shipment/getparceltypes","metadata":{"seo":{"title":"Get Parcel Types","description":"The operation fetches Parcel Types based on the provided carrier, origin county, and the destination country. If query parameters are not provided, this will default to USPS as carrier, US as both origin and destination country code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getParcelTypes","name":"Get Parcel Types","isWebhook":false,"pointer":"/paths/~1api~1v1~1parcelTypes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Parcel Types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation fetches Parcel Types based on the provided carrier, origin county, and the destination country. If query parameters are not provided, this will default to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as carrier, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as both origin and destination country code."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"carrier","in":"query","schemaId":"schema_345","description":"The CarrierID, a unique identifier given to an individual carrier. It can be referred from the response of Get Carriers API"},{"name":"originCountryCode","in":"query","schemaId":"schema_345","description":"The Source Country. The two-character ISO country code for the country where the Shipment originates."},{"name":"destinationCountryCode","in":"query","schemaId":"schema_345","description":"The Destination Country for the Shipment. The two-character ISO country code for the country where the shipment is to be delivered."}],"pointer":"/paths/~1api~1v1~1parcelTypes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1parcelTypes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/parcelTypes","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"carrier","in":"query","required":false,"schemaId":"schema_345"},{"name":"originCountryCode","in":"query","required":false,"schemaId":"schema_345"},{"name":"destinationCountryCode","in":"query","required":false,"schemaId":"schema_345"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/parcelTypes","href":"shipment/getparceltypes","openApiOperationId":"getParcelTypes","summary":"Get Parcel Types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Parcel Types has been fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/parcelTypes","exampleIds":["paths/~1api~1v1~1parcelTypes/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/parcelTypes","exampleIds":["paths/~1api~1v1~1parcelTypes/get/responses/200/content/application~1json/example"],"headers":{"X-PB-TransactionId":{"description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system.","schema":{"type":"string"}}},"headerSchemaId":"schema_346"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1parcelTypes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/parcelTypes","exampleIds":["paths/~1api~1v1~1parcelTypes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/parcelTypes","exampleIds":["paths/~1api~1v1~1parcelTypes/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/getparceltypes"}],"panels":[]}]},"httpPath":"/api/v1/parcelTypes"},{"label":"Get Special Services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getspecialservices","routeSlug":"/openapi/shipping/shipment/getspecialservices","metadata":{"seo":{"title":"Get Special Services","description":"The operation fetches Special Services for a given carrier, service, origin country, and the destination country. If query parameters are not provided, it will default to USPS as carrier, US as both origin, and destination country and will show for all service and parcel types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSpecialServices","name":"Get Special Services","isWebhook":false,"pointer":"/paths/~1api~1v1~1specialServices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Special Services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation fetches Special Services for a given carrier, service, origin country, and the destination country. If query parameters are not provided, it will default to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as carrier, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as both origin, and destination country and will show for all service and parcel types"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"service","in":"query","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The serviceId. It can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API"},"children":[]}]}]}]},{"name":"parcel","in":"query","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parcel Id, a unique identifier named to individual package. It can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Parcel Types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API"},"children":[]}]}]}]},{"name":"carrier","in":"query","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The CarrierID, a unique identifier given to an individual carrier. It can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carriers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API"},"children":[]}]}]}]},{"name":"originCountryCode","in":"query","schemaId":"schema_345","description":"The Source Country. The two-character ISO country code for the country where the Shipment originates."},{"name":"destinationCountryCode","in":"query","schemaId":"schema_345","description":"The Destination Country for the Shipment. The two-character ISO country code for the country where the shipment is to be delivered."}],"pointer":"/paths/~1api~1v1~1specialServices/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1specialServices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/specialServices","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"service","in":"query","required":false,"schemaId":"schema_345"},{"name":"parcel","in":"query","required":false,"schemaId":"schema_345"},{"name":"carrier","in":"query","required":false,"schemaId":"schema_345"},{"name":"originCountryCode","in":"query","required":false,"schemaId":"schema_345"},{"name":"destinationCountryCode","in":"query","required":false,"schemaId":"schema_345"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/specialServices","href":"shipment/getspecialservices","openApiOperationId":"getSpecialServices","summary":"Get Special Services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Special Service has been fetched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/specialServices"}},"schemaId":"components/schemas/specialServices","headers":{"X-PB-TransactionId":{"description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system.","schema":{"type":"string"}}},"headerSchemaId":"schema_346"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1specialServices/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/specialServices","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/specialServices"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/getspecialservices"}],"panels":[]}]},"httpPath":"/api/v1/specialServices"},{"label":"Get Carrier Accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getcarrieraccount","routeSlug":"/openapi/shipping/shipment/getcarrieraccount","metadata":{"seo":{"title":"Get Carrier Accounts","description":"The operation retrieves onboarded Carriers with their Carrier Account IDs which uniquely identify multiple accounts of same carrier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCarrierAccount","name":"Get Carrier Accounts","isWebhook":false,"pointer":"/paths/~1api~1v1~1carrierAccounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Carrier Accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The operation retrieves onboarded Carriers with their Carrier Account IDs which uniquely identify multiple accounts of same carrier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is provided, the API returns only the carrier accounts associated with the specified Location ID. If the header is not provided, API will return all carrier accounts."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1carrierAccounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/carrierAccounts","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/carrierAccounts","href":"shipment/getcarrieraccount","openApiOperationId":"getCarrierAccount","summary":"Get Carrier Accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Carrier Accounts has been fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349","exampleIds":["paths/~1api~1v1~1carrierAccounts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_349","exampleIds":["paths/~1api~1v1~1carrierAccounts/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1carrierAccounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_349","exampleIds":["paths/~1api~1v1~1carrierAccounts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349","exampleIds":["paths/~1api~1v1~1carrierAccounts/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/getcarrieraccount"}],"panels":[]}]},"httpPath":"/api/v1/carrierAccounts"},{"label":"Get All Shipments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getallshipments","routeSlug":"/openapi/shipping/shipment/getallshipments","metadata":{"seo":{"title":"Get All Shipments","description":"The operation fetches all created Shipments. If query parameters are not provided, it will default endDate as current date, page as 1 and size as 10."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllShipments","name":"Get All Shipments","isWebhook":false,"pointer":"/paths/~1api~1v1~1shipments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get All Shipments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The operation fetches all created Shipments. If query parameters are not provided, it will default endDate as current date, page as 1 and size as 10."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_350","description":"The start date of the date range used to filter shipments by their transaction creation date (the date the shipment record was created in the system). The date format must be: YYYY-MM-DD."},{"name":"endDate","in":"query","schemaId":"schema_351","description":"The end date of the date range used to filter shipments by their transaction creation date (the date the shipment record was created in the system). The date format must be: YYYY-MM-DD."},{"name":"page","in":"query","schemaId":"schema_345","description":"The page of the Shipments search result list."},{"name":"size","in":"query","schemaId":"schema_345","description":"The size/count of the searched result list."},{"name":"carrier","in":"query","schemaId":"schema_352","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter shipments transaction report by carrier code (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FEDEX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"insured","in":"query","schemaId":"schema_353","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter shipments by insurance status. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for insured shipments, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}]},{"name":"returnLabel","in":"query","schemaId":"schema_354","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter shipments that include return labels. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return only shipments with return labels, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}]},{"name":"isInternational","in":"query","schemaId":"schema_353","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter shipments by type. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for international shipments, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for domestic shipments."},"children":[]}]}]}]},{"name":"refundEligible","in":"query","schemaId":"schema_353","description":"Filter shipments eligible for refund."},{"name":"merchant","in":"query","schemaId":"schema_353","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter merchant shipments transaction report."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → Returns shipment transaction reports for all merchants associated with the developer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the transaction report for a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include the header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-Developer-Partner-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the value set to that merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"shipmentType","in":"query","schemaId":"schema_355","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by shipment type. Accepted values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipiece"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": multi-piece shipments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Adjusted Postage Value (APV) shipments"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If omitted, all shipment types are returned."},"children":[]}]}]}]}]},{"name":"fromShipmentDate","in":"query","schemaId":"schema_350","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date of the date range used to filter shipments by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfShipment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the actual ship date set on the shipment). Only shipments that have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfShipment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value are returned when this filter is applied. The date format must be: YYYY-MM-DD."},"children":[]}]}]}]},{"name":"toShipmentDate","in":"query","schemaId":"schema_351","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date of the date range used to filter shipments by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfShipment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the actual ship date set on the shipment). Only shipments that have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfShipment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value are returned when this filter is applied. The date format must be: YYYY-MM-DD."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1shipments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the Location ID associated with the shipment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided, the response is filtered based on the specified Location ID."},"children":[]}]}]}]}]}],"pointer":"/paths/~1api~1v1~1shipments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/shipments","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"startDate","in":"query","example":"2026-06-01","schemaId":"schema_350"},{"name":"endDate","in":"query","example":"2026-06-10","schemaId":"schema_351"},{"name":"page","in":"query","schemaId":"schema_345"},{"name":"size","in":"query","schemaId":"schema_345"},{"name":"carrier","in":"query","required":false,"example":"UPS","schemaId":"schema_352"},{"name":"insured","in":"query","required":false,"example":true,"schemaId":"schema_353"},{"name":"returnLabel","in":"query","required":false,"example":false,"schemaId":"schema_354"},{"name":"isInternational","in":"query","required":false,"example":true,"schemaId":"schema_353"},{"name":"refundEligible","in":"query","required":false,"example":true,"schemaId":"schema_353"},{"name":"merchant","in":"query","required":false,"example":true,"schemaId":"schema_353"},{"name":"shipmentType","in":"query","required":false,"example":"apv","schemaId":"schema_355"},{"name":"fromShipmentDate","in":"query","example":"2026-06-01","schemaId":"schema_350"},{"name":"toShipmentDate","in":"query","example":"2026-06-10","schemaId":"schema_351"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/shipments","href":"shipment/getallshipments","openApiOperationId":"getAllShipments","summary":"Get All Shipments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of shipments.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}},"schemaId":"schema_356"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1shipments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_356","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/getallshipments"}],"panels":[]}]},"httpPath":"/api/v1/shipments"},{"label":"Create Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/createshipmentv2","routeSlug":"/openapi/shipping/shipment/createshipmentv2","metadata":{"seo":{"title":"Create Shipment","description":"Note: This Request sample includes the full set of supported fields across all carriers. However, not all fields are applicable to every carrier. When making API calls from the doc portal, ensure you include only the parameters supported by the specific carrier you are integrating with. If unsupported fields are included, the request may fail. To simplify integration and avoid errors, refer to the Postman Collection. To explore which label types, label formats, label sizes, parcel types, services, and special services are supported by each carrier, see the Carrier Catalog. Detailed field descriptions are also provided below."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createShipmentV2","name":"Create Shipment","isWebhook":false,"pointer":"/paths/~1api~1v2~1shipments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This Request sample includes the full set of supported fields across all carriers. However, not all fields are applicable to every carrier. When making API calls from the doc portal, ensure you include only the parameters supported by the specific carrier you are integrating with. If unsupported fields are included, the request may fail. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To simplify integration and avoid errors, refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/resources/postman"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To explore which label types, label formats, label sizes, parcel types, services, and special services are supported by each carrier, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/shipping/carriers/carrier-catalog"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier Catalog"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Detailed field descriptions are also provided below."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Create Shipment API is used to create shipments and generate shipment labels. A shipment refers to the process of packing and transporting an item from a source location to a destination location using a carrier service. The API supports both domestic and international shipments."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domestic Shipments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" addresses must be within the same country."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires carrier services and associated special services."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Shipments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be in a different country than the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires international carrier services, special services, and customs information."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The V2 Create Shipment API compares shipping rates, services, and options across multiple carriers. It selects the best shipping solution based on criteria such as cost, delivery speed, or other business rules. This automates decision-making and eliminates the need for manual analysis of carrier data. It supports following RateShop types: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1. By Carrier:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manually specify the carrier and service for shipment creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides more customization than V1 Create Shipment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2. By RuleSet"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically select the best carrier and service based on predefined rules (e.g., cheapest, fastest). For example: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipments weighing up to 3kg use a \"Standard\" service type with carrier A."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipments exceeding 3kg use an \"Over-weight\" service type with carrier B."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rules are fully client-defined, allowing for dynamic decision-making based on shipment parameters like weight, dimensions, and destination."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3. By RateGroup"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use predefined rate groups to select a carrier and service dynamically.For example:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients can choose between the fastest delivery or the cheapest service rate among a predefined group of carriers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system automatically determines and selects the best carrier and service, without the need for manual comparisons."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4. By ShipViaCode"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instead of passing multiple fields (carrier, carrier account, parcel type, service, and special services) every time in your request payload, you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipviacode/ship-via-code/createshipviacode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ship Via Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once, with all those values defined."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use that single code in your create shipment requests."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The carrier, account, service, parcel type, and special service values from that code will then automatically apply."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If parcel type, service, or special services are also passed in the request payload, they will be overridden by the values defined in the Custom Carrier Code."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5. By byExternalSystemCode"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This enables shipment creation using an external System Code (For SPE users)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExternalSystemCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed in the request, the system retrieves all shipment configuration details (carrier, account, parcel type, service, and special services) linked to that code in the legacy system."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rateShopBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field determines the variant to use ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleSet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rateGroup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure that variant-specific fields are correctly populated:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"byCarrier:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"byRuleSet:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value of shipOption is "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ship Via Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Ship Via Code is configured as part of the automation rule."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"byRateGroup:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rateGroupId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"byShipViaCode:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"byExternalSystemCode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalSystemCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parcelTypeCode"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define special services in one of two ways - by using a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specialServiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or by specifying  special service objects such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryConfirmation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"handling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insurance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". These two cannot be used together in the same request."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isReturn","in":"query","schemaId":"schema_357","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies only to USPS, UPS, FedEx, Purolator, and CPC carriers."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For UPS: If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isReturn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set, either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object must be provided (when using individual service objects) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceId: PRL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be specified (when using specialService). Otherwise, the request will fail."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FedEx, Purolator, and CPC: If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isReturn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object is optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For USPS: For USPS returns, the account is not charged when the return label is created. Charges for the return shipment are applied only after the Scan-Based Return is inducted."},"children":[]}]}]}]}]},{"name":"includeDeliveryCommitment","in":"query","schemaId":"schema_358","description":"When set to true (default), the response includes delivery commitment information. Set to false to exclude delivery commitment details from the response."}],"pointer":"/paths/~1api~1v2~1shipments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, division, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location Scope"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier accounts and services available in a request must belong to the specified location or the default enterprise location."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempting to use carriers or services that are not configured for the resolved location will result in a validation error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is optional when the shipment origin country code matches the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required when the shipment origin country code differs from the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is required but not provided, the API returns a validation error indicating that the location must be specified for the given shipment origin."},"children":[]}]}]}]}]},{"name":"X-PB-TransactionId","in":"header","schemaId":"schema_345","description":"A unique Transaction ID provided by the partner, which is used to enable debugging and linking between the client's transaction and the system."},{"name":"X-PB-Default-ID","in":"header","schemaId":"schema_345","description":"A unique identifier assigned to the Default while its creation using CreateDefaults API."}],"pointer":"/paths/~1api~1v2~1shipments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359","pointer":"/paths/~1api~1v2~1shipments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/shipments","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"isReturn","in":"query","required":false,"schemaId":"schema_357"},{"name":"includeDeliveryCommitment","in":"query","required":false,"schemaId":"schema_358"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-Default-ID","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_359"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v2/shipments","href":"shipment/createshipmentv2","openApiOperationId":"createShipmentV2","summary":"Create Shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_359"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipment has been created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360"}},"schemaId":"schema_360"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v2~1shipments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_360","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/createshipmentv2"}],"panels":[]}]},"httpPath":"/api/v2/shipments"},{"label":"Rate Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/rateshipment","routeSlug":"/openapi/shipping/shipment/rateshipment","metadata":{"seo":{"title":"Rate Shipment","description":"This operation generates rate Shop for a specified shipment without generating the labels."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rateShipment","name":"Rate Shipment","isWebhook":false,"pointer":"/paths/~1api~1v2~1rates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rate Shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation generates rate Shop for a specified shipment without generating the labels."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isReturn","in":"query","schemaId":"schema_357","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that rates should be calculated for a return shipment. Applies only to USPS, UPS, FedEx, and Purolator carriers."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isReturn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object must be provided (when using individual service objects) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serviceId: PRL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be specified (when using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specialServices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Otherwise, the request will fail."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx and Purolator:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isReturn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object is optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isReturn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", return-shipment rates are returned. (Billing for USPS Scan-Based Returns occurs only after the return is inducted, and applies at shipment creation, not at rating.)"},"children":[]}]}]}]}]}],"pointer":"/paths/~1api~1v2~1rates/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, developer, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is not provided, the system defaults to the enterprise-level location that was created during developer account onboarding. This default location is automatically used for shipment processing and billing. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is optional when the shipment origin country code matches the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required when the shipment origin country code differs from the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is required but not provided, the API will return a validation error "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"invalid origin countryCode\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"pointer":"/paths/~1api~1v2~1rates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_361"}},"schemaId":"schema_361","pointer":"/paths/~1api~1v2~1rates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/rates","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"isReturn","in":"query","required":false,"schemaId":"schema_357"}],"querystring":[],"header":[{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_361"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v2/rates","href":"shipment/rateshipment","openApiOperationId":"rateShipment","summary":"Rate Shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"schema_361","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_361"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rate Shop has been generated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v2~1rates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/rateshipment"}],"panels":[]}]},"httpPath":"/api/v2/rates"},{"label":"Create ERR Single Coversheet","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/createerrcoversheet","routeSlug":"/openapi/shipping/shipment/createerrcoversheet","metadata":{"seo":{"title":"Create ERR Single Coversheet","description":"This API generates Electronic Return Receipt (ERR) artifacts for a parcel, including a coversheet, ERR barcode, and ERR stamp. The response output can be configured using the type parameter to return a coversheet, barcode and stamp images, or all outputs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createErrCoversheet","name":"Create ERR Single Coversheet","isWebhook":false,"pointer":"/paths/~1api~1v1~1err~1coverSheet/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create ERR Single Coversheet","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API generates Electronic Return Receipt (ERR) artifacts for a parcel, including a coversheet, ERR barcode, and ERR stamp. The response output can be configured using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to return a coversheet, barcode and stamp images, or all outputs."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, division, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location Scope"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier accounts and services available in a request must belong to the specified location or the default enterprise location."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempting to use carriers or services that are not configured for the resolved location will result in a validation error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is optional when the shipment origin country code matches the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required when the shipment origin country code differs from the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is required but not provided, the API returns a validation error indicating that the location must be specified for the given shipment origin."},"children":[]}]}]}]}]}],"pointer":"/paths/~1api~1v1~1err~1coverSheet/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ErrCoversheetRequest"}},"schemaId":"components/schemas/ErrCoversheetRequest","pointer":"/paths/~1api~1v1~1err~1coverSheet/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/err/coverSheet","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ErrCoversheetRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/err/coverSheet","href":"shipment/createerrcoversheet","openApiOperationId":"createErrCoversheet","summary":"Create ERR Single Coversheet"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/ErrCoversheetRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ErrCoversheetRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The ERR coversheet has been successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrCoversheetResponse"}},"schemaId":"components/schemas/ErrCoversheetResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1err~1coverSheet/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ErrCoversheetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrCoversheetResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/createerrcoversheet"}],"panels":[]}]},"httpPath":"/api/v1/err/coverSheet"},{"label":"Get Shipment by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/shipmentbyid","routeSlug":"/openapi/shipping/shipment/shipmentbyid","metadata":{"seo":{"title":"Get Shipment by Id","description":"The operation retrieves shipment details using shipmentId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"shipmentById","name":"Get Shipment by Id","isWebhook":false,"pointer":"/paths/~1api~1v1~1shipments~1{shipmentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Shipment by Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The operation retrieves shipment details using shipmentId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shipmentId","in":"path","schemaId":"schema_345","description":"The shipmentId, a unique identifier for an individual Shipment.","required":true}],"pointer":"/paths/~1api~1v1~1shipments~1{shipmentId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required."}],"pointer":"/paths/~1api~1v1~1shipments~1{shipmentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/shipments/{shipmentId}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"shipmentId","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/api/v1/shipments/{shipmentId}","href":"shipment/shipmentbyid","openApiOperationId":"shipmentById","summary":"Get Shipment by Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipment has been retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}},"schemaId":"components/schemas/notFoundErrors"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1shipments~1{shipmentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"404","schemaId":"components/schemas/notFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/shipmentbyid"}],"panels":[]}]},"httpPath":"/api/v1/shipments/{shipmentId}"},{"label":"Reprint Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/reprintshipmentbyidv2","routeSlug":"/openapi/shipping/shipment/reprintshipmentbyidv2","metadata":{"seo":{"title":"Reprint Shipment","description":"This operation retrieves an existing shipping label associated with a shipment. The API uses the shipmentId returned by the original Create Shipment request. Use this API only if the original shipping label has been lost or damaged. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reprintShipmentByIdV2","name":"Reprint Shipment","isWebhook":false,"pointer":"/paths/~1api~1v2~1shipments~1reprint/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reprint Shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation retrieves an existing shipping label associated with a shipment. The API uses the shipmentId returned by the original Create Shipment request. Use this API only if the original shipping label has been lost or damaged. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Considerations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is applicable only if the original shipment was successfully created. It cannot be used if the initial Create Shipment request resulted in no response or encountered an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS allows only 1 reprint."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GoFor does not allow reprint."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RMG allows 3 reprints."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other carriers allow up to 8 reprints."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reprints are valid for 24 hours from the time the label was first created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reprinting should only be used when necessary. Excessive reprint attempts are restricted and monitored."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Follow the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/support/troubleshooting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Troubleshooting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in case you are facing any issues creating a shipment."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, developer, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is not provided, the system defaults to the enterprise-level location that was created during developer account onboarding. This default location is automatically used for shipment processing and billing. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is optional when the shipment origin country code matches the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required when the shipment origin country code differs from the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is required but not provided, the API will return a validation error "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"invalid origin countryCode\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"X-PB-TransactionId","in":"header","schemaId":"schema_345","description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system."}],"pointer":"/paths/~1api~1v2~1shipments~1reprint/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/shipmentReprintV2"}},"schemaId":"components/schemas/shipmentReprintV2","pointer":"/paths/~1api~1v2~1shipments~1reprint/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/shipments/reprint","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/shipmentReprintV2"}},"responseCodes":["200","400","401","404","500"],"pointer":"/api/v2/shipments/reprint","href":"shipment/reprintshipmentbyidv2","openApiOperationId":"reprintShipmentByIdV2","summary":"Reprint Shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/shipmentReprintV2","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/shipmentReprintV2"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipment has been reprinted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reprintShipmentV2"}},"schemaId":"components/schemas/reprintShipmentV2"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}},"schemaId":"components/schemas/notFoundErrors"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v2~1shipments~1reprint/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/reprintShipmentV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reprintShipmentV2"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"404","schemaId":"components/schemas/notFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/reprintshipmentbyidv2"}],"panels":[]}]},"httpPath":"/api/v2/shipments/reprint"},{"label":"Cancel Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/cancelshipmentbyidv2","routeSlug":"/openapi/shipping/shipment/cancelshipmentbyidv2","metadata":{"seo":{"title":"Cancel Shipment","description":"This operation cancels or voids a shipment label that has not been processed by the carrier. When you cancel an unused prepaid shipment label, the API initiates a request for an electronic refund."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelShipmentByIdV2","name":"Cancel Shipment","isWebhook":false,"pointer":"/paths/~1api~1v2~1shipments~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation cancels or voids a shipment label that has not been processed by the carrier. When you cancel an unused prepaid shipment label, the API initiates a request for an electronic refund."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Considerations"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancelation must occur before the shipment is picked up or processed by the carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunds are only applicable for unused labels. Voiding a used label may result in penalties or billing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel unused USPS prepaid labels within 30 days of printing to start the refund process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund requests are processed within 14 business days from the date the refund was requested, provided the label has not been used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved refunds are automatically credited to the account you used to pay for the label."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": USPS considers it a federal offense to induct a label that has already been refunded."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Refunds are not available for First-Class Mail letters and flats."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Refunds are subject to the policies of the applicable carrier."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For unused post-paid labels, you must void them. Voiding avoids billing for the label and allows the carrier to maintain an accurate count for pickups."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always destroy voided labels to prevent accidental use. If a voided label is shipped, you will be billed for the label."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once a refund has been claimed, you cannot use the shipping label for sending packages. It will be rejected."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment Cancelation Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipmentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parcelTrackingNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to cancel a shipment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both are provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipmentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes precedence and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parcelTrackingNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parcelTrackingNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the shipment associated with that parcel tracking number is canceled."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, developer, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is not provided, the system defaults to the enterprise-level location that was created during developer account onboarding. This default location is automatically used for shipment processing and billing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is optional when the shipment origin country code matches the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required when the shipment origin country code differs from the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is required but not provided, the API will return a validation error "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"invalid origin countryCode\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"X-PB-TransactionId","in":"header","schemaId":"schema_345","description":"A unique Transaction ID provided by the partner which is used to enable debugging and linking between the client's transaction and the system."}],"pointer":"/paths/~1api~1v2~1shipments~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/shipmentCancelV2"}},"schemaId":"components/schemas/shipmentCancelV2","pointer":"/paths/~1api~1v2~1shipments~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/shipments/cancel","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/shipmentCancelV2"}},"responseCodes":["200","400","401","404","500"],"pointer":"/api/v2/shipments/cancel","href":"shipment/cancelshipmentbyidv2","openApiOperationId":"cancelShipmentByIdV2","summary":"Cancel Shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/shipmentCancelV2","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/shipmentCancelV2"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Shipment has been cancelled.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cancelShipmentV2"}},"schemaId":"components/schemas/cancelShipmentV2"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}},"schemaId":"components/schemas/notFoundErrors"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v2~1shipments~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/cancelShipmentV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cancelShipmentV2"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"404","schemaId":"components/schemas/notFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/cancelshipmentbyidv2"}],"panels":[]}]},"httpPath":"/api/v2/shipments/cancel"},{"label":"Signature Image ERR","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getsignatureimageerr","routeSlug":"/openapi/shipping/shipment/getsignatureimageerr","metadata":{"seo":{"title":"Signature Image ERR","description":"This API provides a downloadable link containing the signature image for a specific ERR (Electronic Return Receipt) shipment. This signature image serves as Proof of Delivery (POD). What is Proof of Delivery (POD)?Proof of Delivery is a document or file that acts as evidence of successful shipment delivery. This file contains a digital copy of the recipient's signature, provided as a downloadable link or URL."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSignatureImageERR","name":"Signature Image ERR","isWebhook":false,"pointer":"/paths/~1api~1v1~1err~1shipments~1{shipmentId}~1signaturefile/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Signature Image ERR","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API provides a downloadable link containing the signature image for a specific ERR (Electronic Return Receipt) shipment. This signature image serves as Proof of Delivery (POD). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What is Proof of Delivery (POD)?"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of Delivery is a document or file that acts as evidence of successful shipment delivery. This file contains a digital copy of the recipient's signature, provided as a downloadable link or URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Considerations:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It provides the recipient's signature image captured at the time of delivery as proof that the shipment was successfully delivered."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API provides the recipient's signature image as Proof of Delivery (POD) to confirm successful shipment delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A request requires the mandatory "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipmentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a signature is captured by the carrier, the API returns it as a downloadable link of the PDF in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signatureFileURL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signatureFileURL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the API response expires after 60 minutes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no signature is available, the API returns an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature Image ERR is supported for USPS carrier only."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shipmentId","in":"path","schemaId":"schema_345","description":"Shipment ID is a unique identifier for an individual shipment.","required":true}],"pointer":"/paths/~1api~1v1~1err~1shipments~1{shipmentId}~1signaturefile/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1err~1shipments~1{shipmentId}~1signaturefile/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/err/shipments/{shipmentId}/signaturefile","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"shipmentId","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/err/shipments/{shipmentId}/signaturefile","href":"shipment/getsignatureimageerr","openApiOperationId":"GetSignatureImageERR","summary":"Signature Image ERR"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Signature image as proof of delivered shipment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignatureFileResponse"}},"schemaId":"components/schemas/SignatureFileResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1err~1shipments~1{shipmentId}~1signaturefile/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SignatureFileResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignatureFileResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/getsignatureimageerr"}],"panels":[]}]},"httpPath":"/api/v1/err/shipments/{shipmentId}/signaturefile"},{"label":"Cancel Stamps ERR","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/cancelstampserr","routeSlug":"/openapi/shipping/shipment/cancelstampserr","metadata":{"seo":{"title":"Cancel Stamps ERR","description":"This operation cancels (voids) stamps generated for ERR (Electronic Return Receipt)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CancelStampsERR","name":"Cancel Stamps ERR","isWebhook":false,"pointer":"/paths/~1api~1v1~1err~1stamps~1void/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Stamps ERR","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation cancels (voids) stamps generated for ERR (Electronic Return Receipt)."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User needs to provide *Shipment IDs in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stampIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array to cancel those specific ERR stamps."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User can download the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund Form"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" having details of generated Postage."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At once, maximum 1000 stamps can be requested for cancelation."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1err~1stamps~1void/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelStampsRequestERR"}},"schemaId":"components/schemas/CancelStampsRequestERR","pointer":"/paths/~1api~1v1~1err~1stamps~1void/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/err/stamps/void","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CancelStampsRequestERR"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/err/stamps/void","href":"shipment/cancelstampserr","openApiOperationId":"CancelStampsERR","summary":"Cancel Stamps ERR"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/CancelStampsRequestERR","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelStampsRequestERR"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Stamps Refund Form has been generated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancelStampsResponseERR"}},"schemaId":"components/schemas/CancelStampsResponseERR"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1err~1stamps~1void/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CancelStampsResponseERR","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancelStampsResponseERR"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/cancelstampserr"}],"panels":[]}]},"httpPath":"/api/v1/err/stamps/void"},{"label":"Download BPOD Files","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/downloadbpodfiles","routeSlug":"/openapi/shipping/shipment/downloadbpodfiles","metadata":{"seo":{"title":"Download BPOD Files","description":"This API operation is used to download bulk of ERR (Electronic Return Receipt) - POD (Proof of Delivery) files, which are specific to USPS carrier. User can download BPOD (Bulk Proof of Delivery) files either using Shipment IDs or Date Range. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DownloadBpodFiles","name":"Download BPOD Files","isWebhook":false,"pointer":"/paths/~1api~1v1~1err~1shipments~1bpod/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download BPOD Files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API operation is used to download bulk of ERR ("},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic Return Receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - POD ("},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of Delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") files, which are specific to USPS carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User can download BPOD ("},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Proof of Delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") files either using "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment IDs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date Range"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get the records based on dates and download BPOD files accordingly, "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start Date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End Date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" need to be passed in the request body as a query filter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To get a downloadable link of BPOD files on the basis of date range provided, an empty JSON body {} must be passed in the request body.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When both the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date range"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and  "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment IDs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided in the request, "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment IDs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will take precedance. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User is restricted to download 1000 BPOD files as max limit."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_364","description":"The BPOD files to be downloaded from which Date is the startDate in the Date Range filter. This field is not required if the Shipment IDs provided in the request body. Format: YYYY-MM-DD."},{"name":"endDate","in":"query","schemaId":"schema_364","description":"The BPOD files to be downloaded till which Date is the endDate in the Date Range filter. This field is not required if the Shipment IDs provided in the request body. Format: YYYY-MM-DD."}],"pointer":"/paths/~1api~1v1~1err~1shipments~1bpod/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1err~1shipments~1bpod/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BPODDownloadRequest"}},"schemaId":"components/schemas/BPODDownloadRequest","pointer":"/paths/~1api~1v1~1err~1shipments~1bpod/post/requestBody","description":"This is the request body to download BPOD files. Request body supports max of 1000 ShipmentIDs in a request."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/err/shipments/bpod","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"startDate","in":"query","required":false,"example":"2026-03-12","schemaId":"schema_364"},{"name":"endDate","in":"query","required":false,"example":"2026-03-12","schemaId":"schema_364"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BPODDownloadRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/err/shipments/bpod","href":"shipment/downloadbpodfiles","openApiOperationId":"DownloadBpodFiles","summary":"Download BPOD Files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/BPODDownloadRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BPODDownloadRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The ZIP URL for BPOD files has been created for download.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BPODDownloadResponse"}},"schemaId":"components/schemas/BPODDownloadResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1err~1shipments~1bpod/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BPODDownloadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BPODDownloadResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipment/downloadbpodfiles"}],"panels":[]}]},"httpPath":"/api/v1/err/shipments/bpod"}],"content":{"contentType":"group","meta":{"name":"Shipment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipment","showPageActions":true},{"nodeType":"markdoc","content":"The Shipment APIs provide a unified interface to create, manage, and track shipments across multiple carriers. These APIs support the complete shipment lifecycle, including carrier configuration, rate retrieval, shipment creation, label generation, and post-shipment operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/carriers","summary":"Get Carriers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/getcarriers","deprecated":false},{"title":"/api/v1/carrier-facility","summary":"Carrier facilities","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/carrierfacility","deprecated":false},{"title":"/api/v1/countries","summary":"Get Countries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/getcountries","deprecated":false},{"title":"/api/v1/services","summary":"Get Services","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/getservices","deprecated":false},{"title":"/api/v1/parcelTypes","summary":"Get Parcel Types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/getparceltypes","deprecated":false},{"title":"/api/v1/specialServices","summary":"Get Special Services","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/getspecialservices","deprecated":false},{"title":"/api/v1/carrierAccounts","summary":"Get Carrier Accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/getcarrieraccount","deprecated":false},{"title":"/api/v1/shipments","summary":"Get All Shipments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/getallshipments","deprecated":false},{"title":"/api/v2/shipments","summary":"Create Shipment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/createshipmentv2","deprecated":false},{"title":"/api/v2/rates","summary":"Rate Shipment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/rateshipment","deprecated":false},{"title":"/api/v1/err/coverSheet","summary":"Create ERR Single Coversheet","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/createerrcoversheet","deprecated":false},{"title":"/api/v1/shipments/{shipmentId}","summary":"Get Shipment by Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/shipmentbyid","deprecated":false},{"title":"/api/v2/shipments/reprint","summary":"Reprint Shipment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/reprintshipmentbyidv2","deprecated":false},{"title":"/api/v2/shipments/cancel","summary":"Cancel Shipment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/cancelshipmentbyidv2","deprecated":false},{"title":"/api/v1/err/shipments/{shipmentId}/signaturefile","summary":"Signature Image ERR","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/getsignatureimageerr","deprecated":false},{"title":"/api/v1/err/stamps/void","summary":"Cancel Stamps ERR","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/cancelstampserr","deprecated":false},{"title":"/api/v1/err/shipments/bpod","summary":"Download BPOD Files","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/downloadbpodfiles","deprecated":false}]}]}]}]}},{"type":"group","label":"Electronic Trade Document","link":"/openapi/shipping/electronic-trade-document","routeSlug":"/openapi/shipping/electronic-trade-document","items":[{"label":"Upload Electronic Trade Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/electronic-trade-document/uploadetd","routeSlug":"/openapi/shipping/electronic-trade-document/uploadetd","metadata":{"seo":{"title":"Upload Electronic Trade Document","description":"Electronic Trade Documents Upload API is an international shipping document upload solution that simplifies global shipping needs and allows you to electronically upload customs documentation required for international shipments.You can submit most of your trade documents electronically relieving yourself from printing or attaching trade documents with the shipment. This API simplifies and accelerates customs clearance by replacing physical paperwork with electronic documentation.The customs and other agencies receive electronically sent documents faster than paper copies attached with your shipment. The customs clearance process is also optimized as capturing and sharing of critical trade information is done at earlier stages of shipping."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadETD","name":"Upload Electronic Trade Document","isWebhook":false,"pointer":"/paths/~1api~1v1~1importUrl/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Electronic Trade Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic Trade Documents Upload API is an international shipping document upload solution that simplifies global shipping needs and allows you to electronically upload customs documentation required for international shipments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can submit most of your trade documents electronically relieving yourself from printing or attaching trade documents with the shipment. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API simplifies and accelerates customs clearance by replacing physical paperwork with electronic documentation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customs and other agencies receive electronically sent documents faster than paper copies attached with your shipment. The customs clearance process is also optimized as capturing and sharing of critical trade information is done at earlier stages of shipping."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx supports ETD with the special service "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ELECTRONIC_TRADE_DOCUMENTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express supports ETD with the special service "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAPERLESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In certain scenarios, the originals of specific international documents still need to be attached to the package."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For smooth customs clearance and to avoid delays, ensure that the documents are visually clear and not distorted in any way."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the Workflow Operates"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 1: Submit Electronic Trade Document Metadata"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiate the process by making a POST request to the ETD Upload API with the document metadata (e.g., file name, document type, and content type)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In response, the system returns:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A pre-signed S3 upload URL (url)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fileName"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A relative "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"s3FileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to reference the uploaded document later"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 2: Upload the Document File"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After receiving the response, you must perform a separate HTTP PUT request to the provided "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.shipping360.pitneybowes.com/openapi/shipping/operation/uploadETD/#!c=200&path=url&t=response"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This request must upload the binary content of the file (e.g., PDF or image)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload the same file whose metadata was submitted in step-1 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 3: Reference the Document in Shipment Creation"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once the ETD uploaded successfully, the document is stored in the S3 bucket."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once uploaded, the document is stored in the S3 bucket and can later be referenced via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"s3FileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.shipping360.pitneybowes.com/openapi/shipping/operation/createShipment/#!path=1/customs/customsDocuments&t=request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create International Shipment API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customsDocuments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_365"}},"schemaId":"schema_365","pointer":"/paths/~1api~1v1~1importUrl/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/importUrl","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_365"}},"responseCodes":["200","400","401","404","500"],"pointer":"/api/v1/importUrl","href":"electronic-trade-document/uploadetd","openApiOperationId":"uploadETD","summary":"Upload Electronic Trade Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"schema_365","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_365"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pre-signed S3 upload url is generated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}},"schemaId":"components/schemas/notFoundErrors"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1importUrl/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"404","schemaId":"components/schemas/notFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/electronic-trade-document/uploadetd"}],"panels":[]}]},"httpPath":"/api/v1/importUrl"}],"content":{"contentType":"group","meta":{"name":"Electronic Trade Document"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Electronic Trade Document","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Electronic Trade Document API facilitates uploading electronic trade documents for international shipments."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These APIs support faster customs processing by enabling required trade information to be captured and shared electronically at earlier stages of the shipment."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/importUrl","summary":"Upload Electronic Trade Document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/electronic-trade-document/uploadetd","deprecated":false}]}]}]}]}},{"type":"group","label":"Pickups","link":"/openapi/shipping/pickups","routeSlug":"/openapi/shipping/pickups","items":[{"label":"Schedule Pickup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/pickups/schedulepickup","routeSlug":"/openapi/shipping/pickups/schedulepickup","metadata":{"seo":{"title":"Schedule Pickup","description":"Pickups endpoint allows you to schedule pickups with USPS, DHL Express, UPS and FedEx carriers for eligible shipments.The pickup schedule scope is determined by what you provide in the request:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"schedulePickup","name":"Schedule Pickup","isWebhook":false,"pointer":"/paths/~1api~1v1~1pickups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schedule Pickup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pickups endpoint allows you to schedule pickups with USPS, DHL Express, UPS and FedEx carriers for eligible shipments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pickup schedule scope is determined by what you provide in the request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If pickupSummary is provided:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a pickup is scheduled for the packages described in the summary."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If shipmentIds are provided:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a pickup is scheduled for the specified shipments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both pickupSummary and shipmentIds are provided:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a pickup is scheduled for all shipments including by both inputs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If neither is provided:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a pickup is scheduled for all shipments created on the given carrier account by that time of the day."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"carrierAccountId handling:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required to schedule a pickup. Either provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request payload, or provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a location that has only one carrier account configured for the selected carrier."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The sender's first name and last name are required for USPS. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"name\": \"John Doe\""},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, division, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selection Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided and the location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one carrier with one account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The available carrier account is selected and the manifest is created."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided and the default location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one carrier with one account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The available carrier account is selected and the manifest is created."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided and the location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one carrier with multiple accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected and the manifest is created."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided and the default location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one carrier with multiple accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected and the manifest is created."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided and the location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple carriers with one account each"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and its associated account are selected and the manifest is created."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided and the default location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple carriers with one account each"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and its associated account are selected and the manifest is created."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided and the location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple carriers with multiple accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected and the manifest is created."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided and the default location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple carriers with multiple accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected and the manifest is created."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"pointer":"/paths/~1api~1v1~1pickups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_367"}},"schemaId":"schema_367","pointer":"/paths/~1api~1v1~1pickups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/pickups","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_367"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/pickups","href":"pickups/schedulepickup","openApiOperationId":"schedulePickup","summary":"Schedule Pickup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"schema_367","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_367"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Pickup has been created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}},"schemaId":"schema_368"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1pickups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_368","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pickups/schedulepickup"}],"panels":[]}]},"httpPath":"/api/v1/pickups"},{"label":"Get Pickups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/pickups/getpickups","routeSlug":"/openapi/shipping/pickups/getpickups","metadata":{"seo":{"title":"Get Pickups","description":"Get Pickups"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPickups","name":"Get Pickups","isWebhook":false,"pointer":"/paths/~1api~1v1~1pickups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Pickups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Pickups"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"carrier","in":"query","schemaId":"schema_345","description":"Name of the carrier to retrieve pickups for."},{"name":"startDate","in":"query","schemaId":"schema_345","description":"The start date for filtering pickups. Format: YYYY-MM-DD."},{"name":"endDate","in":"query","schemaId":"schema_345","description":"The end date for filtering pickups. Format: YYYY-MM-DD."},{"name":"status","in":"query","schemaId":"schema_345","description":"The status of the pickups to retrieve (scheduled or cancelled)."}],"pointer":"/paths/~1api~1v1~1pickups/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1pickups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/pickups","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"carrier","in":"query","required":false,"schemaId":"schema_345"},{"name":"startDate","in":"query","required":false,"schemaId":"schema_345"},{"name":"endDate","in":"query","required":false,"schemaId":"schema_345"},{"name":"status","in":"query","required":false,"schemaId":"schema_345"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/pickups","href":"pickups/getpickups","openApiOperationId":"getPickups","summary":"Get Pickups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of pickups.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getAllPickups"}},"schemaId":"components/schemas/getAllPickups"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1pickups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/getAllPickups","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getAllPickups"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pickups/getpickups"}],"panels":[]}]},"httpPath":"/api/v1/pickups"},{"label":"Cancel Pickups","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/pickups/cancelpickups","routeSlug":"/openapi/shipping/pickups/cancelpickups","metadata":{"seo":{"title":"Cancel Pickups","description":"Cancel Pickups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelPickups","name":"Cancel Pickups","isWebhook":false,"pointer":"/paths/~1api~1v1~1pickups~1cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Pickups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancel Pickups."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1pickups~1cancel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/schedulePickupCancelRequest"}},"schemaId":"components/schemas/schedulePickupCancelRequest","pointer":"/paths/~1api~1v1~1pickups~1cancel/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/pickups/cancel","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/schedulePickupCancelRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/pickups/cancel","href":"pickups/cancelpickups","openApiOperationId":"cancelPickups","summary":"Cancel Pickups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/schedulePickupCancelRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/schedulePickupCancelRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pick up cancelled successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/schedulePickupCancelResponse"}},"schemaId":"components/schemas/schedulePickupCancelResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1pickups~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/schedulePickupCancelResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/schedulePickupCancelResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pickups/cancelpickups"}],"panels":[]}]},"httpPath":"/api/v1/pickups/cancel"},{"label":"Get Pickup Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/pickups/getpickupdocument","routeSlug":"/openapi/shipping/pickups/getpickupdocument","metadata":{"seo":{"title":"Get Pickup Document","description":"The API retrieves the document for a scheduled pickup receipt using the pickupId, generated when the pickup is successfully scheduled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPickupDocument","name":"Get Pickup Document","isWebhook":false,"pointer":"/paths/~1api~1v1~1pickups~1{pickupId}~1document/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Pickup Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The API retrieves the document for a scheduled pickup receipt using the pickupId, generated when the pickup is successfully scheduled."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pickupId","in":"path","schemaId":"schema_345","description":"Unique identifier for the scheduled pickup.","required":true}],"pointer":"/paths/~1api~1v1~1pickups~1{pickupId}~1document/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1pickups~1{pickupId}~1document/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/pickups/{pickupId}/document","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"pickupId","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/pickups/{pickupId}/document","href":"pickups/getpickupdocument","openApiOperationId":"getPickupDocument","summary":"Get Pickup Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pick up document have been fetched.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getPickupDocument"}},"schemaId":"components/schemas/getPickupDocument","headers":{"X-PB-TransactionId":{"description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system.","schema":{"type":"string"}}},"headerSchemaId":"schema_346"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1pickups~1{pickupId}~1document/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/getPickupDocument","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getPickupDocument"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pickups/getpickupdocument"}],"panels":[]}]},"httpPath":"/api/v1/pickups/{pickupId}/document"},{"label":"Cancelled Pickup Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/pickups/cancelledpickupdocument","routeSlug":"/openapi/shipping/pickups/cancelledpickupdocument","metadata":{"seo":{"title":"Cancelled Pickup Document","description":"This operation generates a PDF receipt for pickup cancellations. It supports creating receipts for multiple cancelled pickups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelledPickupDocument","name":"Cancelled Pickup Document","isWebhook":false,"pointer":"/paths/~1api~1v1~1pickups~1document/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancelled Pickup Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation generates a PDF receipt for pickup cancellations. It supports creating receipts for multiple cancelled pickups."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_345","description":"Specifies the type of document being retrieved. Use 'cancelled' to generate a receipt for cancelled pickups.","required":true}],"pointer":"/paths/~1api~1v1~1pickups~1document/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1pickups~1document/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/getPickupCancelledDocumentRequest"}},"schemaId":"components/schemas/getPickupCancelledDocumentRequest","pointer":"/paths/~1api~1v1~1pickups~1document/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/pickups/document","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"type","in":"query","required":true,"schemaId":"schema_345"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/getPickupCancelledDocumentRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/pickups/document","href":"pickups/cancelledpickupdocument","openApiOperationId":"cancelledPickupDocument","summary":"Cancelled Pickup Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/getPickupCancelledDocumentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/getPickupCancelledDocumentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pickup has been cancelled.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getPickupCancelledDocumentResponse"}},"schemaId":"components/schemas/getPickupCancelledDocumentResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1pickups~1document/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/getPickupCancelledDocumentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getPickupCancelledDocumentResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pickups/cancelledpickupdocument"}],"panels":[]}]},"httpPath":"/api/v1/pickups/document"},{"label":"Check Pickup Availability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/pickups/checkpickupavailability","routeSlug":"/openapi/shipping/pickups/checkpickupavailability","metadata":{"seo":{"title":"Check Pickup Availability","description":"Validates if the requested carrier can perform a pickup at the provided address,given the shipment details and requested pickup date/time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkPickupAvailability","name":"Check Pickup Availability","isWebhook":false,"pointer":"/paths/~1api~1v1~1pickups~1availability/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check Pickup Availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates if the requested carrier can perform a pickup at the provided address,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"given the shipment details and requested pickup date/time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response also indicates:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If pickup is available at the location."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What types of pickup (residential, on-demand, scheduled) are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cutoff times and valid pickup time windows."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Language","in":"header","schemaId":"schema_369","description":"Locale for response messages, BCP-47 format (language-region), e.g., en-US.\n","required":true}],"pointer":"/paths/~1api~1v1~1pickups~1availability/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PickupAvailabilityRequest"}},"schemaId":"components/schemas/PickupAvailabilityRequest","pointer":"/paths/~1api~1v1~1pickups~1availability/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/pickups/availability","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Language","in":"header","required":true,"example":"en-US","schemaId":"schema_369"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PickupAvailabilityRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/pickups/availability","href":"pickups/checkpickupavailability","openApiOperationId":"checkPickupAvailability","summary":"Check Pickup Availability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/PickupAvailabilityRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PickupAvailabilityRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pickup availability details returned successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupAvailabilityResponse"}},"schemaId":"components/schemas/PickupAvailabilityResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1pickups~1availability/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PickupAvailabilityResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PickupAvailabilityResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pickups/checkpickupavailability"}],"panels":[]}]},"httpPath":"/api/v1/pickups/availability"}],"content":{"contentType":"group","meta":{"name":"Pickups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pickups","showPageActions":true},{"nodeType":"markdoc","content":"APIs to create and manage pickup requests, check availability, cancel scheduled pickups, and generate or retrieve pickup documents."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/pickups","summary":"Schedule Pickup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pickups/schedulepickup","deprecated":false},{"title":"/api/v1/pickups","summary":"Get Pickups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pickups/getpickups","deprecated":false},{"title":"/api/v1/pickups/cancel","summary":"Cancel Pickups","prefix":{"name":"put","color":"put"},"badges":[],"link":"/pickups/cancelpickups","deprecated":false},{"title":"/api/v1/pickups/{pickupId}/document","summary":"Get Pickup Document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pickups/getpickupdocument","deprecated":false},{"title":"/api/v1/pickups/document","summary":"Cancelled Pickup Document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pickups/cancelledpickupdocument","deprecated":false},{"title":"/api/v1/pickups/availability","summary":"Check Pickup Availability","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pickups/checkpickupavailability","deprecated":false}]}]}]}]}},{"type":"group","label":"Multipiece Shipment","link":"/openapi/shipping/multipiece-shipment","routeSlug":"/openapi/shipping/multipiece-shipment","items":[{"label":"Multipiece Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/multipiece-shipment/multipieceshipment","routeSlug":"/openapi/shipping/multipiece-shipment/multipieceshipment","metadata":{"seo":{"title":"Multipiece Shipment","description":"The operation creates Multipiece Shipments. Shipments with multiple parcels sent to the same destination can be grouped together in a multipiece shipment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"multipieceShipment","name":"Multipiece Shipment","isWebhook":false,"pointer":"/paths/~1api~1v1~1multipiece~1shipments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Multipiece Shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation creates Multipiece Shipments. Shipments with multiple parcels sent to the same destination can be grouped together in a multipiece shipment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS, FedEx, DHL Express, Suprmsys, Purolator, Apple Express, Tforce Mile, Loomis and Canpar are supported for Multipiece Shipments."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum Parcels Allowed per Carrier:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL: 75"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx: 40"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS: 50"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator: 100"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Express: 75"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tforce Mile: 75"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loomis: 75"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canpar: 25"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For UPS- multipiece shipment with Envelopes (having parcel Type as LTR) is not supported."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FedEx Multipiece, all parcels must be of same packaging type while creating multipiece shipment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS does not support multi-piece parcels in a single shipment at this time."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeDeliveryCommitment","in":"query","schemaId":"schema_358","description":"When set to true (default), the response includes delivery commitment information. Set to false to exclude delivery commitment details from the response."},{"name":"splitContent","in":"query","schemaId":"schema_370","description":"Include this parameter only if you want to generate separate labels for each parcel in a multi-piece shipment. As of now, individual parcel labels supported for carriers FedEx and UPS."}],"pointer":"/paths/~1api~1v1~1multipiece~1shipments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, developer, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is not provided, the system defaults to the enterprise-level location that was created during developer account onboarding. This default location is automatically used for shipment processing and billing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is optional when the shipment origin country code matches the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required when the shipment origin country code differs from the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is required but not provided, the API will return a validation error "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"invalid origin countryCode\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"pointer":"/paths/~1api~1v1~1multipiece~1shipments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_371"}},"schemaId":"schema_371","pointer":"/paths/~1api~1v1~1multipiece~1shipments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/multipiece/shipments","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"includeDeliveryCommitment","in":"query","required":false,"schemaId":"schema_358"},{"name":"splitContent","in":"query","required":false,"schemaId":"schema_370"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_371"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/multipiece/shipments","href":"multipiece-shipment/multipieceshipment","openApiOperationId":"multipieceShipment","summary":"Multipiece Shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"schema_371","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_371"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Multipiece Shipment created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1multipiece~1shipments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/multipiece-shipment/multipieceshipment"}],"panels":[]}]},"httpPath":"/api/v1/multipiece/shipments"},{"label":"Multipiece Rates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/multipiece-shipment/multipiecerates","routeSlug":"/openapi/shipping/multipiece-shipment/multipiecerates","metadata":{"seo":{"title":"Multipiece Rates","description":"The operation is used for rateshop and to get specific rate based on serviceId for Multipiece."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"multipieceRates","name":"Multipiece Rates","isWebhook":false,"pointer":"/paths/~1api~1v1~1multipiece~1rates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Multipiece Rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The operation is used for rateshop and to get specific rate based on serviceId for Multipiece."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeDeliveryCommitment","in":"query","schemaId":"schema_358","description":"When set to true (default), the response includes delivery commitment information. Set to false to exclude delivery commitment details from the response."}],"pointer":"/paths/~1api~1v1~1multipiece~1rates/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, developer, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is not provided, the system defaults to the enterprise-level location that was created during developer account onboarding. This default location is automatically used for shipment processing and billing. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is optional when the shipment origin country code matches the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required when the shipment origin country code differs from the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is required but not provided, the API will return a validation error "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"invalid origin countryCode\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"pointer":"/paths/~1api~1v1~1multipiece~1rates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_373"}},"schemaId":"schema_373","pointer":"/paths/~1api~1v1~1multipiece~1rates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/multipiece/rates","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"includeDeliveryCommitment","in":"query","required":false,"schemaId":"schema_358"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_373"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/multipiece/rates","href":"multipiece-shipment/multipiecerates","openApiOperationId":"multipieceRates","summary":"Multipiece Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"schema_373","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_373"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Multipiece Rates created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}},"schemaId":"schema_374"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1multipiece~1rates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_374","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/multipiece-shipment/multipiecerates"}],"panels":[]}]},"httpPath":"/api/v1/multipiece/rates"},{"label":"Reprint Multipiece Shipment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/multipiece-shipment/multipieceshipmentreprint","routeSlug":"/openapi/shipping/multipiece-shipment/multipieceshipmentreprint","metadata":{"seo":{"title":"Reprint Multipiece Shipment","description":"The operation is used to reprint the multipiece label. It takes the shipmentId of the multipiece shipment done. All supported carriers (UPS, FedEx, DHL Express, Suprmsys, Purolator, and Apple Express) allow up to 8 reprint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"multipieceShipmentReprint","name":"Reprint Multipiece Shipment","isWebhook":false,"pointer":"/paths/~1api~1v1~1multipiece~1shipments~1{shipmentId}~1reprint/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reprint Multipiece Shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The operation is used to reprint the multipiece label. It takes the shipmentId of the multipiece shipment done. All supported carriers (UPS, FedEx, DHL Express, Suprmsys, Purolator, and Apple Express) allow up to 8 reprint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shipmentId","in":"path","schemaId":"schema_345","description":"It specifies the shipmentId of onward shipment against which return label has to be created.","required":true}],"pointer":"/paths/~1api~1v1~1multipiece~1shipments~1{shipmentId}~1reprint/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1multipiece~1shipments~1{shipmentId}~1reprint/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/multipiece/shipments/{shipmentId}/reprint","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"shipmentId","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/multipiece/shipments/{shipmentId}/reprint","href":"multipiece-shipment/multipieceshipmentreprint","openApiOperationId":"multipieceShipmentReprint","summary":"Reprint Multipiece Shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Multipiece Shipment created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReprintMultipieceShipmentResponse"}},"schemaId":"components/schemas/ReprintMultipieceShipmentResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1multipiece~1shipments~1{shipmentId}~1reprint/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReprintMultipieceShipmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReprintMultipieceShipmentResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/multipiece-shipment/multipieceshipmentreprint"}],"panels":[]}]},"httpPath":"/api/v1/multipiece/shipments/{shipmentId}/reprint"},{"label":"Cancel Multipiece Shipment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/multipiece-shipment/multipieceshipmentcancel","routeSlug":"/openapi/shipping/multipiece-shipment/multipieceshipmentcancel","metadata":{"seo":{"title":"Cancel Multipiece Shipment","description":"The operation is used to cancel the multipiece label. It takes the shipmentId of the multipiece shipment done."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"multipieceShipmentCancel","name":"Cancel Multipiece Shipment","isWebhook":false,"pointer":"/paths/~1api~1v1~1multipiece~1shipments~1{shipmentId}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Multipiece Shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The operation is used to cancel the multipiece label. It takes the shipmentId of the multipiece shipment done."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shipmentId","in":"path","schemaId":"schema_345","description":"It specifies the shipmentId of onward shipment against which return label has to be created.","required":true}],"pointer":"/paths/~1api~1v1~1multipiece~1shipments~1{shipmentId}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1multipiece~1shipments~1{shipmentId}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/multipiece/shipments/{shipmentId}/cancel","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"shipmentId","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/multipiece/shipments/{shipmentId}/cancel","href":"multipiece-shipment/multipieceshipmentcancel","openApiOperationId":"multipieceShipmentCancel","summary":"Cancel Multipiece Shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Multipiece Shipment created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cancelShipment"}},"schemaId":"components/schemas/cancelShipment"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1multipiece~1shipments~1{shipmentId}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/cancelShipment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cancelShipment"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/multipiece-shipment/multipieceshipmentcancel"}],"panels":[]}]},"httpPath":"/api/v1/multipiece/shipments/{shipmentId}/cancel"}],"content":{"contentType":"group","meta":{"name":"Multipiece Shipment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Multipiece Shipment","showPageActions":true},{"nodeType":"markdoc","content":"APIs to rate and create shipments with multiple parcels under a single shipment, and to manage them through reprint and cancellation operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/multipiece/shipments","summary":"Multipiece Shipment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/multipiece-shipment/multipieceshipment","deprecated":false},{"title":"/api/v1/multipiece/rates","summary":"Multipiece Rates","prefix":{"name":"post","color":"post"},"badges":[],"link":"/multipiece-shipment/multipiecerates","deprecated":false},{"title":"/api/v1/multipiece/shipments/{shipmentId}/reprint","summary":"Reprint Multipiece Shipment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/multipiece-shipment/multipieceshipmentreprint","deprecated":false},{"title":"/api/v1/multipiece/shipments/{shipmentId}/cancel","summary":"Cancel Multipiece Shipment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/multipiece-shipment/multipieceshipmentcancel","deprecated":false}]}]}]}]}},{"type":"group","label":"Print","link":"/openapi/shipping/print","routeSlug":"/openapi/shipping/print","items":[{"label":"Print Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/print/printdocument","routeSlug":"/openapi/shipping/print/printdocument","metadata":{"seo":{"title":"Print Document","description":"It contains information about a label or a document, e.g., a shipping label, a customs form, manifest report etc., that pertains to a shipment or manifest."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"printDocument","name":"Print Document","isWebhook":false,"pointer":"/paths/~1api~1v1~1document~1print/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Print Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"It contains information about a label or a document, e.g., a shipping label, a customs form, manifest report etc., that pertains to a shipment or manifest."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, developer, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is not provided, the system defaults to the enterprise-level location that was created during developer account onboarding. This default location is automatically used for shipment processing and billing. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is optional when the shipment origin country code matches the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required when the shipment origin country code differs from the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is required but not provided, the API will return a validation error "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"invalid origin countryCode\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"X-PB-TransactionId","in":"header","schemaId":"schema_345","description":"A unique Transaction ID provided by the partner, which is used to enable debugging and linking between the client's transaction and the system."}],"pointer":"/paths/~1api~1v1~1document~1print/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PrintDocumentRequest"}},"schemaId":"components/schemas/PrintDocumentRequest","pointer":"/paths/~1api~1v1~1document~1print/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/document/print","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PrintDocumentRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/document/print","href":"print/printdocument","openApiOperationId":"printDocument","summary":"Print Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/PrintDocumentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PrintDocumentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The document has been printed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrintDocumentResponse"}},"schemaId":"components/schemas/PrintDocumentResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1document~1print/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PrintDocumentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrintDocumentResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/print/printdocument"}],"panels":[]}]},"httpPath":"/api/v1/document/print"},{"label":"Printer mapping","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/print/printermapping","routeSlug":"/openapi/shipping/print/printermapping","metadata":{"seo":{"title":"Printer mapping","description":"printer mapping document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"printerMapping","name":"Printer mapping","isWebhook":false,"pointer":"/paths/~1api~1v1~1printer~1mapping/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Printer mapping","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"printer mapping document"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, developer, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is not provided, the system defaults to the enterprise-level location that was created during developer account onboarding. This default location is automatically used for shipment processing and billing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is optional when the shipment origin country code matches the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required when the shipment origin country code differs from the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is required but not provided, the API will return a validation error "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"invalid origin countryCode\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"X-PB-TransactionId","in":"header","schemaId":"schema_345","description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system."}],"pointer":"/paths/~1api~1v1~1printer~1mapping/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PrinterMappingRequest"}},"schemaId":"components/schemas/PrinterMappingRequest","pointer":"/paths/~1api~1v1~1printer~1mapping/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/printer/mapping","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PrinterMappingRequest"}},"responseCodes":["201","401"],"pointer":"/api/v1/printer/mapping","href":"print/printermapping","openApiOperationId":"printerMapping","summary":"Printer mapping"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/PrinterMappingRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PrinterMappingRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully mapped printer","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrinterMappingResponse"}},"schemaId":"components/schemas/PrinterMappingResponse"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"}],"pointer":"/paths/~1api~1v1~1printer~1mapping/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PrinterMappingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrinterMappingResponse"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/print/printermapping"}],"panels":[]}]},"httpPath":"/api/v1/printer/mapping"},{"label":"Get Printer mapping","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/print/getprintermapping","routeSlug":"/openapi/shipping/print/getprintermapping","metadata":{"seo":{"title":"Get Printer mapping","description":"Get printer mapping document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPrinterMapping","name":"Get Printer mapping","isWebhook":false,"pointer":"/paths/~1api~1v1~1printer~1mapping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Printer mapping","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get printer mapping document"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"alias","in":"query","schemaId":"schema_345","description":"Refers to a printer connected (directly or via network) to a computer.","required":true}],"pointer":"/paths/~1api~1v1~1printer~1mapping/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, developer, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is not provided, the system defaults to the enterprise-level location that was created during developer account onboarding. This default location is automatically used for shipment processing and billing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is optional when the shipment origin country code matches the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required when the shipment origin country code differs from the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is required but not provided, the API will return a validation error "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"invalid origin countryCode\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"X-PB-TransactionId","in":"header","schemaId":"schema_345","description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system."}],"pointer":"/paths/~1api~1v1~1printer~1mapping/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/printer/mapping","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"alias","in":"query","required":true,"schemaId":"schema_345"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/printer/mapping","href":"print/getprintermapping","openApiOperationId":"getPrinterMapping","summary":"Get Printer mapping"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Mapping printer Get Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrinterMappingGetResponse"}},"schemaId":"components/schemas/PrinterMappingGetResponse"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"}],"pointer":"/paths/~1api~1v1~1printer~1mapping/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PrinterMappingGetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrinterMappingGetResponse"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/print/getprintermapping"}],"panels":[]}]},"httpPath":"/api/v1/printer/mapping"},{"label":"Delete Printer mapping","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/print/deleteprintermapping","routeSlug":"/openapi/shipping/print/deleteprintermapping","metadata":{"seo":{"title":"Delete Printer mapping","description":"delete printer mapping document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePrinterMapping","name":"Delete Printer mapping","isWebhook":false,"pointer":"/paths/~1api~1v1~1printer~1mapping/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Printer mapping","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"delete printer mapping document"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"alias","in":"query","schemaId":"schema_345","description":"Refers to a printer connected (directly or via network) to a computer.","required":true}],"pointer":"/paths/~1api~1v1~1printer~1mapping/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, developer, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is not provided, the system defaults to the enterprise-level location that was created during developer account onboarding. This default location is automatically used for shipment processing and billing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is optional when the shipment origin country code matches the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required when the shipment origin country code differs from the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is required but not provided, the API will return a validation error "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"invalid origin countryCode\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"X-PB-TransactionId","in":"header","schemaId":"schema_345","description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system."}],"pointer":"/paths/~1api~1v1~1printer~1mapping/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/printer/mapping","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"alias","in":"query","required":true,"schemaId":"schema_345"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/printer/mapping","href":"print/deleteprintermapping","openApiOperationId":"deletePrinterMapping","summary":"Delete Printer mapping"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted printer mapping"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"}],"pointer":"/paths/~1api~1v1~1printer~1mapping/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/print/deleteprintermapping"}],"panels":[]}]},"httpPath":"/api/v1/printer/mapping"},{"label":"Job status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/print/jobstatus","routeSlug":"/openapi/shipping/print/jobstatus","metadata":{"seo":{"title":"Job status","description":"job status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"jobStatus","name":"Job status","isWebhook":false,"pointer":"/paths/~1api~1v1~1jobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Job status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"job status"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_345","description":"The jobId, a unique identifier assigned for the job.","required":true}],"pointer":"/paths/~1api~1v1~1jobs~1{jobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-Id","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_345","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, developer, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is not provided, the system defaults to the enterprise-level location that was created during developer account onboarding. This default location is automatically used for shipment processing and billing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is optional when the shipment origin country code matches the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required when the shipment origin country code differs from the enterprise's default address country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the header is required but not provided, the API will return a validation error "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"invalid origin countryCode\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"X-PB-TransactionId","in":"header","schemaId":"schema_345","description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system."}],"pointer":"/paths/~1api~1v1~1jobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jobs/{jobId}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-Id","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_345"},{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/jobs/{jobId}","href":"print/jobstatus","openApiOperationId":"jobStatus","summary":"Job status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The document has been printed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobStatus"}},"schemaId":"components/schemas/JobStatus"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1jobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobStatus"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/print/jobstatus"}],"panels":[]}]},"httpPath":"/api/v1/jobs/{jobId}"}],"content":{"contentType":"group","meta":{"name":"Print"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Print","showPageActions":true},{"nodeType":"markdoc","content":"APIs to print shipping labels and documents, configure and manage printer mappings, and retrieve print job status."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/document/print","summary":"Print Document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/print/printdocument","deprecated":false},{"title":"/api/v1/printer/mapping","summary":"Printer mapping","prefix":{"name":"post","color":"post"},"badges":[],"link":"/print/printermapping","deprecated":false},{"title":"/api/v1/printer/mapping","summary":"Get Printer mapping","prefix":{"name":"get","color":"get"},"badges":[],"link":"/print/getprintermapping","deprecated":false},{"title":"/api/v1/printer/mapping","summary":"Delete Printer mapping","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/print/deleteprintermapping","deprecated":false},{"title":"/api/v1/jobs/{jobId}","summary":"Job status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/print/jobstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Defaults","link":"/openapi/shipping/defaults","routeSlug":"/openapi/shipping/defaults","items":[{"label":"Create Defaults","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/defaults/createdefaults","routeSlug":"/openapi/shipping/defaults/createdefaults","metadata":{"seo":{"title":"Create Defaults","description":"While creating shipment, a few columns/ fields information are used mandatorily, and if the value for those columns are used repetitively, then it is always better to save last used values. And hence, this API has been introduced. Using this API, default values can be set up for frequently used columns/fields information like carrier and linked services. Setting up the defaults will save both time and efforts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDefaults","name":"Create Defaults","isWebhook":false,"pointer":"/paths/~1api~1v1~1defaults/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Defaults","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"While creating shipment, a few columns/ fields information are used mandatorily, and if the value for those columns are used repetitively, then it is always better to save last used values.\nAnd hence, this API has been introduced. Using this API, default values can be set up for frequently used columns/fields information like carrier and linked services. \nSetting up the defaults will save both time and efforts.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDefaults"}},"schemaId":"components/schemas/CreateDefaults","pointer":"/paths/~1api~1v1~1defaults/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/defaults","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateDefaults"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/defaults","href":"defaults/createdefaults","openApiOperationId":"createDefaults","summary":"Create Defaults"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/CreateDefaults","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDefaults"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Defaults (i.e., default values) have been created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateDefaultsResponse"}},"schemaId":"components/schemas/CreateDefaultsResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1defaults/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateDefaultsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateDefaultsResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/defaults/createdefaults"}],"panels":[]}]},"httpPath":"/api/v1/defaults"},{"label":"Get All Defaults","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/defaults/getalldefaults","routeSlug":"/openapi/shipping/defaults/getalldefaults","metadata":{"seo":{"title":"Get All Defaults","description":"The operation fetches all created Defaults. If query parameters are not provided, it will consider default page as 1 and default size as 10."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllDefaults","name":"Get All Defaults","isWebhook":false,"pointer":"/paths/~1api~1v1~1defaults/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get All Defaults","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The operation fetches all created Defaults. If query parameters are not provided, it will consider default page as 1 and default size as 10."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_345","description":"The page of the Defaults search result list."},{"name":"size","in":"query","schemaId":"schema_345","description":"The size/count of the searched result list."}],"pointer":"/paths/~1api~1v1~1defaults/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_345","description":"The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required."}],"pointer":"/paths/~1api~1v1~1defaults/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/defaults","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_345"},{"name":"size","in":"query","schemaId":"schema_345"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_345"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/defaults","href":"defaults/getalldefaults","openApiOperationId":"getAllDefaults","summary":"Get All Defaults"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Defaults.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AllDefaults"}},"schemaId":"components/schemas/AllDefaults"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1defaults/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AllDefaults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AllDefaults"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/defaults/getalldefaults"}],"panels":[]}]},"httpPath":"/api/v1/defaults"},{"label":"Update Defaults","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/defaults/putdefaultsbyid","routeSlug":"/openapi/shipping/defaults/putdefaultsbyid","metadata":{"seo":{"title":"Update Defaults","description":"This operation updates the values set for Defaults."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putDefaultsById","name":"Update Defaults","isWebhook":false,"pointer":"/paths/~1api~1v1~1defaults~1{defaultID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Defaults","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation updates the values set for Defaults."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"defaultID","in":"path","schemaId":"schema_345","description":"This is unique identifier assigned to Defaults while its creation using CreateDefaults API.","required":true}],"pointer":"/paths/~1api~1v1~1defaults~1{defaultID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDefaults"}},"schemaId":"components/schemas/CreateDefaults","pointer":"/paths/~1api~1v1~1defaults~1{defaultID}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/defaults/{defaultID}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"defaultID","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateDefaults"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/defaults/{defaultID}","href":"defaults/putdefaultsbyid","openApiOperationId":"putDefaultsById","summary":"Update Defaults"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/CreateDefaults","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateDefaults"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Defaults (i.e., default values) have been updated successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1defaults~1{defaultID}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/defaults/putdefaultsbyid"}],"panels":[]}]},"httpPath":"/api/v1/defaults/{defaultID}"},{"label":"Get Defaults By ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/defaults/getdefaultsbyid","routeSlug":"/openapi/shipping/defaults/getdefaultsbyid","metadata":{"seo":{"title":"Get Defaults By ID","description":"This operation fetches the values set for the Defaults."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDefaultsById","name":"Get Defaults By ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1defaults~1{defaultID}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Defaults By ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation fetches the values set for the Defaults."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"defaultID","in":"path","schemaId":"schema_345","description":"This is unique identifier assigned to Defaults while its creation using CreateDefaults API.","required":true}],"pointer":"/paths/~1api~1v1~1defaults~1{defaultID}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/defaults/{defaultID}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"defaultID","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/defaults/{defaultID}","href":"defaults/getdefaultsbyid","openApiOperationId":"getDefaultsById","summary":"Get Defaults By ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Defaults values have been retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DefaultResponse"}},"schemaId":"components/schemas/DefaultResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1defaults~1{defaultID}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DefaultResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DefaultResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/defaults/getdefaultsbyid"}],"panels":[]}]},"httpPath":"/api/v1/defaults/{defaultID}"},{"label":"Delete Defaults by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/defaults/deletedefaultsbyid","routeSlug":"/openapi/shipping/defaults/deletedefaultsbyid","metadata":{"seo":{"title":"Delete Defaults by ID","description":"This operation deletes the existing Defaults."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDefaultsById","name":"Delete Defaults by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1defaults~1{defaultID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Defaults by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation deletes the existing Defaults."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"defaultID","in":"path","schemaId":"schema_345","description":"This is unique identifier assigned to Defaults while its creation using CreateDefaults API.","required":true}],"pointer":"/paths/~1api~1v1~1defaults~1{defaultID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/defaults/{defaultID}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"defaultID","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/defaults/{defaultID}","href":"defaults/deletedefaultsbyid","openApiOperationId":"deleteDefaultsById","summary":"Delete Defaults by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Defaults (i.e., default values) have been deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1defaults~1{defaultID}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/defaults/deletedefaultsbyid"}],"panels":[]}]},"httpPath":"/api/v1/defaults/{defaultID}"}],"content":{"contentType":"group","meta":{"name":"Defaults"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Defaults","showPageActions":true},{"nodeType":"markdoc","content":"APIs to create, retrieve, update, and delete default shipment settings for frequently used fields such as carrier, service, sender address, label preferences, and parcel details."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/defaults","summary":"Create Defaults","prefix":{"name":"post","color":"post"},"badges":[],"link":"/defaults/createdefaults","deprecated":false},{"title":"/api/v1/defaults","summary":"Get All Defaults","prefix":{"name":"get","color":"get"},"badges":[],"link":"/defaults/getalldefaults","deprecated":false},{"title":"/api/v1/defaults/{defaultID}","summary":"Update Defaults","prefix":{"name":"put","color":"put"},"badges":[],"link":"/defaults/putdefaultsbyid","deprecated":false},{"title":"/api/v1/defaults/{defaultID}","summary":"Get Defaults By ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/defaults/getdefaultsbyid","deprecated":false},{"title":"/api/v1/defaults/{defaultID}","summary":"Delete Defaults by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/defaults/deletedefaultsbyid","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/shipmentDomestic":{"id":"components/schemas/shipmentDomestic","kind":"json-schema","title":"shipmentDomestic","data":{"type":"object","required":["size","type","fromAddress","parcel","toAddress","carrierAccountId","serviceId","parcelType","thirdPartyAddress"],"properties":{"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (4' X 6' or 8.5' X 11'). RMG b2b shipment support only 4x6 and 8x11 label sizes.","enum":["DOC_8X11","DOC_4X6"],"example":"DOC_4X6"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the Shipment, e.g., Shipping Label.QR_CODE supported for carrier USPS only as of now."},"children":[]}]}]}],"example":"SHIPPING_LABEL","enum":["SHIPPING_LABEL","QR_CODE"]},"format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the shipment label that is printed. QR_CODE can be generated only in GIF format."},"children":[]}]}]}],"example":"PDF","enum":["PDF","ZPL2","PNG","GIF"]},"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the label content is encoded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" BASE64 is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZPL2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PNG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"URL","enum":["URL","BASE64"]},"dateOfShipment":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when shipment is created/shipped. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: For FedEx US shipments, when a shipment date is provided in the request, the specified value is used for shipment processing. If no shipment date is provided, Carrier processes it as per their system."},"children":[]}]}]}],"example":"2024-03-20"},"fromAddress":{"type":"object","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the sender address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. This field is required for RMG b2b shipment. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.","example":"06905"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by FedEx, UPS, and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}},"parcel":{"type":"object","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is a part of Dimension object having highest numeric value out of three required parameters (length, width, and height) of Dimension. It helps determine a parcel’s girth."},"children":[]}]}]}],"example":2},"width":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Width is a part of Dimension object having lowest numeric value out of three required parameters of dimension (length, width, and height). This helps determine a parcel’s girth."},"children":[]}]}]}],"example":1},"height":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Height is a part of Dimension object where it helps determine a parcel’s girth."},"children":[]}]}]}],"example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","enum":["OZ"],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":1}}},"carrierAccountId":{"type":"string","example":"asas2223","description":" A unique identifier associated with the Carrier account used by client users during shipment process.","x-go-name":"carrierAccountId"},"parcelType":{"type":"string","example":"PKG","description":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. It has categories like Package, Envelopes, Paks, Boxes, Tube, defined per specific carrier and used in abbreviated form, e.g., FRPKG, LGENV, TUBE, PKG.","x-go-name":"ParcelType"},"serviceId":{"type":"string","example":"PM","description":"A unique identifier given to the carrier-specific service. This is required for creating a shipment, while it is optional for rating a parcel.","x-go-name":"serviceId"},"specialServices":{"type":"array","description":" It provides a carrier-service based special or extra service.","items":{"$ref":"#/components/schemas/SpecialService"},"x-go-name":"SpecialServices"},"shipmentOptions":{"allOf":[{"$ref":"#/components/schemas/shipmentOptions"},{"type":"object","properties":{"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"}}},{"type":"object","properties":{"b2b":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RMG carrier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate a business-to-business (B2B) shipment."},"children":[]}]}]}]}}},{"type":"object","properties":{"senderEORI":{"type":"string","example":"GB123456789101","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's Economic Operators Registration and Identification number. EORI is a unique identification number used for customs clearance in the European Union. This Number can be 14 characters long in Alphanumeric format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for RMG B2B shipments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},{"type":"object","properties":{"recipientEORI":{"type":"string","example":"GB123456789101","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient's EORI number. ORI is a unique identification number used for customs clearance in the European Union. This Number can be 14 characters long in Alphanumeric format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for RMG B2B shipments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},{"type":"object","properties":{"senderUKIMSNumber":{"type":"string","example":"GBUKIM12345678910100000000000000","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UKIMS (UK Internal Market Scheme) is an authorization that allows businesses to move goods between Great Britain (GB) and Northern Ireland (NI) without paying EU (European) duty. UKIMS Number can be 32 characters long in Alphanumeric format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if the package value value is over £135."},"children":[]}]}]}]}}},{"type":"object","properties":{"exportLicenceRequired":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the shipment includes goods that require an official export license."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applies to both RMG B2B and B2C shipments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required as part of customs compliance under the Windsor Agreement"},"children":[]}]}]}]}]}}}]},"docTab":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option is used to provide additional information into the label's additional space."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported for carrier FedEx as of now."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported format is ZPL2 and doc size is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4x6_75"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for fedEx."},"children":[]}]}]}]}],"properties":{"templateName":{"type":"string","description":"This is an optional field and will be used when the client has multiple doctab options.","example":"1"},"toAddressName":{"$ref":"#/components/schemas/docTabItem"},"parcelTrackingNumber":{"$ref":"#/components/schemas/docTabItem"},"carrier":{"$ref":"#/components/schemas/docTabItem"},"serviceId":{"$ref":"#/components/schemas/docTabItem"},"dateOfShipment":{"$ref":"#/components/schemas/docTabItem"},"pieceNumber":{"$ref":"#/components/schemas/docTabItem"},"packageTotalCarrierCharge":{"$ref":"#/components/schemas/docTabItem"},"totalCarrierCharge":{"$ref":"#/components/schemas/docTabItem"},"packageWeight":{"$ref":"#/components/schemas/docTabItem"},"totalWeight":{"$ref":"#/components/schemas/docTabItem"},"customField1":{"$ref":"#/components/schemas/docTabItem"},"customField2":{"$ref":"#/components/schemas/docTabItem"},"customField3":{"$ref":"#/components/schemas/docTabItem"},"customField4":{"$ref":"#/components/schemas/docTabItem"}},"example":{"templateName":"1","toAddressName":{"displayName":"CUS","value":"","row":1,"column":1},"parcelTrackingNumber":{"displayName":"TRK","value":"","row":2,"column":1},"carrier":{"displayName":"CAR","value":"","row":3,"column":1},"serviceId":{"displayName":"SER","value":"","row":1,"column":2},"dateOfShipment":{"displayName":"DATE","value":"","row":2,"column":2},"pieceNumber":{"displayName":"PKG#","value":"","row":3,"column":2},"packageTotalCarrierCharge":{"displayName":"PCHG","value":"","row":3,"column":3},"totalCarrierCharge":{"displayName":"TCHG","value":"","row":2,"column":3},"packageWeight":{"displayName":"PWGT","value":"","row":1,"column":3},"totalWeight":{"displayName":"TWGT","value":"","row":1,"column":4},"customField1":{"displayName":"INV","value":"010610000388302031320259999950","row":2,"column":4}}},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","example":"costAccountName"},"value":{"type":"string","example":"cost account 123"}}}},"toAddress":{"type":"object","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"countryCode":{"type":"string","description":"The two-character ISO Code of the destination country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits. ","example":"203-555-1213"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the receiver address is not residential. Required for B2B shipments when using the RMG carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"soldToAddress":{"$ref":"#/components/schemas/soldToAddress"},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"},"customs":{"type":"object","required":["customsInfo","customsItems"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customs declaration details for international or carrier-specific domestic shipments."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only for RMG carrier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in domestic shipment requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must include customsItems and customsInfo objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other carriers do not require this object for domestic shipments."},"children":[]}]}]}]}],"properties":{"customsItems":{"type":"array","items":{"type":"object","required":["description","quantity","unitPrice","weight","weightUnit"],"properties":{"description":{"type":"string","description":"A detailed description of the commodity, up to 255 characters. The description will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Each description will appear on the form.","example":"T-shirt"},"hSTariffCode":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination country's tariff-classification number (HS code) for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and then add digits for more detail. The maximum length for an HS code is 14 characters. The HS code will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required for RMG carrier."},"children":[]}]}]}],"example":"610910"},"originCountryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two-character ISO country code of the shipment’s origin country. Use ISO 3166-1 Alpha-2 standard values."},"children":[]}]}]}],"example":"US"},"quantity":{"type":"number","description":"Enter the total number of items of this type of commodity.","example":1},"unitPrice":{"type":"number","description":"The price of one item of this type of commodity.","example":10},"weightUnit":{"type":"string","enum":["OZ"],"description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"The weight of the item.","example":1}}}},"customsInfo":{"type":"object","description":"This is additional customs information required along with item details.","required":["reasonForExport","customsDeclaredValue","currencyCode"],"properties":{"reasonForExport":{"type":"string","enum":["GIFT","COMMERCIAL_SAMPLE","MERCHANDISE","DOCUMENTS","RETURNED_GOODS","OTHER"],"description":"The reason the commodity is being exported.","example":"GIFT"},"customsDeclaredValue":{"description":"Item value in mentioned currencyCode","type":"number","example":10},"currencyCode":{"description":"The currency used for declared value. Use three uppercase letters, per ISO 4217","example":"USD","type":"string"},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"certificateNumber":{"type":"string","description":"The certificate number associated with the commodity","example":"123456"},"comments":{"type":"string","description":"Free-form comments regarding the exported shipment.","example":"This is a sample comment"},"fromCustomsReference":{"type":"string","description":"Free-form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.","example":"EFEFE4554545"},"importerCustomsReference":{"type":"string","description":"A reference number used by the importer, such as a VAT number, PO number, or insured number.","example":"dff3433"},"invoiceNumber":{"type":"string","description":"The commercial invoice number assigned by the exporter.","example":"123456"},"licenseNumber":{"type":"string","description":"The export license number associated with the commodity.","example":"123456"},"sdrValue":{"type":"number","description":"When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values.","example":10},"termsOfSale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the delivery and payment terms between the shipper and recipient.Currenty supported by carriers - UPS, FedEx and DHL. - Common values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CIP: Carriage and Insurance Paid to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPT: Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAP: Delivered at Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAT: Delivered at Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DDP: Delivered Duty Paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXW: Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FCA: Free Carrier"},"children":[]}]}]}]}],"example":"DDP","enum":["CIP","CPT","DAP","DAT","DDP","EXW","FCA"]}}}}}}}},"components/schemas/MilitaryMailAddress":{"id":"components/schemas/MilitaryMailAddress","kind":"json-schema","title":"MilitaryMailAddress","data":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"UNIT 35007"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"APO"},"countryCode":{"type":"string","description":"The two-character ISO Code of the destination country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Recipient Name"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits. ","example":"518-727-4964"},"company":{"type":"string","description":"The name of the company, in case if the receiver address is not residential.","example":"PB"},"email":{"type":"string","description":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier.","example":"testuser@gmail.com"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"96376-5007"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"AP"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false}}}},"components/schemas/MilitaryMailShipments":{"id":"components/schemas/MilitaryMailShipments","kind":"json-schema","title":"MilitaryMailShipments","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For domestic USPS Military Mail shipments (APO/FPO/DPO Address), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object is required if any of the following are true:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Weight is greater than or equal to 16 ounces."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Weight is less than 16 ounces AND shipment contains items other than documents. Specify the items in customs.customsInfo.reasonForExport."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment uses Priority Mail Express (EM). A customs form is always required for Priority Mail Express."},"children":[]}]}]}]}],"required":["size","type","fromAddress","parcel","toAddress","carrierAccountId","serviceId","parcelType"],"properties":{"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (4' X 6' or 8.5' X 11').","enum":["DOC_8X11","DOC_4X6"],"example":"DOC_8x11"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the Shipment, e.g., Shipping Label.QR_CODE supported for carrier USPS only as of now."},"children":[]}]}]}],"example":"SHIPPING_LABEL","enum":["SHIPPING_LABEL","QR_CODE"]},"format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the shipment label that is printed. QR_CODE can be generated only in GIF format."},"children":[]}]}]}],"example":"PDF","enum":["PDF","ZPL2","PNG","GIF"]},"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the label content is encoded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" BASE64 is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZPL2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PNG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"URL","enum":["URL","BASE64"]},"dateOfShipment":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when shipment is created/shipped. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: For FedEx US shipments, when a shipment date is provided in the request, the specified value is used for shipment processing. If no shipment date is provided, Carrier processes it as per their system."},"children":[]}]}]}],"example":"2025-04-04"},"fromAddress":{"type":"object","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"8 Abc Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Beals"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Sender Name"},"company":{"type":"string","description":"The name of the company, in case if the sender address is not residential.","example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits. ","example":"323 555-1212"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"04611-3214"},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"ME"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false}}},"parcel":{"type":"object","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is a part of Dimension object having highest numeric value out of three required parameters (length, width, and height) of Dimension. It helps determine a parcel’s girth."},"children":[]}]}]}],"example":10},"width":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Width is a part of Dimension object having lowest numeric value out of three required parameters of dimension (length, width, and height). This helps determine a parcel’s girth."},"children":[]}]}]}],"example":10},"height":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Height is a part of Dimension object where it helps determine a parcel’s girth."},"children":[]}]}]}],"example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","enum":["OZ"],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":1}}},"carrierAccountId":{"type":"string","example":"asas2223","description":" A unique identifier associated with the Carrier account used by client users during shipment process.","x-go-name":"carrierAccountId"},"parcelType":{"type":"string","example":"LP","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. It has categories like Package, Envelopes, Paks, Boxes, Tube, defined per specific carrier and used in abbreviated form, e.g., FRPKG, LGENV, TUBE, PKG."},"children":[]}]}]}]}],"x-go-name":"ParcelType"},"serviceId":{"type":"string","example":"PM","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-A unique identifier given to the carrier-specific service. This is required for creating a shipment, while it is optional for rating a parcel."},"children":[]}]}]}]}],"x-go-name":"serviceId"},"specialServices":{"type":"array","description":" It provides a carrier-service based special or extra service.","items":{"$ref":"#/components/schemas/SpecialService"},"x-go-name":"SpecialServices"},"shipmentOptions":{"$ref":"#/components/schemas/shipmentOptions"},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","example":"costAccountName"},"value":{"type":"string","example":"cost account 123"}}}},"toAddress":{"type":"object","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"UNIT 35007"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"APO"},"countryCode":{"type":"string","description":"The two-character ISO Code of the destination country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Recipient Name"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits. ","example":"518-727-4964"},"company":{"type":"string","description":"The name of the company, in case if the receiver address is not residential.","example":"PB"},"email":{"type":"string","description":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier.","example":"testuser@gmail.com"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"96376-5007"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"AP"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false}}},"soldToAddress":{"$ref":"#/components/schemas/soldToAddress"},"customs":{"type":"object","required":["customsInfo","customsItems"],"properties":{"customsItems":{"type":"array","items":{"type":"object","required":["description","quantity","unitPrice","weight","weightUnit"],"properties":{"description":{"type":"string","description":"A detailed description of the commodity, up to 255 characters. The description will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Each description will appear on the form.","example":"T-shirt"},"hSTariffCode":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination country’s tariff-classification number (HS code) for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and then add digits for more detail. The maximum length for an HS code is 14 characters. The HS code will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each."},"children":[]}]}]}],"example":"610910"},"originCountryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two-character ISO country code of the shipment’s origin country. Use ISO 3166-1 Alpha-2 standard values."},"children":[]}]}]}],"example":"US"},"quantity":{"type":"number","description":"Enter the total number of items of this type of commodity.","example":1},"unitPrice":{"type":"number","description":"The price of one item of this type of commodity.","example":10},"weightUnit":{"type":"string","enum":["OZ"],"description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"The weight of the item.","example":1}}}},"customsInfo":{"type":"object","description":"This is additional customs information required along with item details.","required":["reasonForExport","customsDeclaredValue","currencyCode"],"properties":{"reasonForExport":{"type":"string","enum":["GIFT","COMMERCIAL_SAMPLE","MERCHANDISE","DOCUMENTS","RETURNED_GOODS","OTHER"],"description":"The reason the commodity is being exported.","example":"GIFT"},"customsDeclaredValue":{"description":"Item value in mentioned currencyCode","type":"number","example":10},"currencyCode":{"description":"The currency used for declared value. Use three uppercase letters, per ISO 4217","example":"USD","type":"string"},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"certificateNumber":{"type":"string","description":"The certificate number associated with the commodity.","example":"123456"},"comments":{"type":"string","description":"Free-form comments regarding the exported shipment.","example":"This is a sample comment"},"fromCustomsReference":{"type":"string","description":"Free-form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.","example":"EFEFE4554545"},"importerCustomsReference":{"type":"string","description":"A reference number used by the importer, such as a VAT number, PO number, or insured number.","example":"dff3433"},"invoiceNumber":{"type":"string","description":"The commercial invoice number assigned by the exporter.","example":"123456"},"licenseNumber":{"type":"string","description":"The export license number associated with the commodity.","example":"123456"},"sdrValue":{"type":"number","description":"When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values.","example":10},"termsOfSale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the delivery and payment terms between the shipper and recipient. Currenty supported by carriers - UPS, FedEx and DHL. - Common values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CIP: Carriage and Insurance Paid to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPT: Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAP: Delivered at Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAT: Delivered at Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DDP: Delivered Duty Paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXW: Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FCA: Free Carrier"},"children":[]}]}]}]}],"example":"DDP","enum":["CIP","CPT","DAP","DAT","DDP","EXW","FCA"]}}}}}}}},"components/schemas/IMbLabelSampleRequest":{"id":"components/schemas/IMbLabelSampleRequest","kind":"json-schema","title":"IMbLabelSampleRequest","data":{"type":"object","required":["serviceId","parcelType","size","fromAddress","toAddress"],"properties":{"serviceId":{"type":"string","description":"Service identifier. For IMB, use 'FCM' (First-Class Mail).","example":"FCM"},"parcelType":{"type":"string","description":"Type of USPS package (e.g., LETTER, FLAT, IRRPKG, NMLETTER).","example":"FLAT"},"size":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Label size. For IMB labels, use 'DOC_6X4' or 'DOC_9X4' (LETTER only)."},"children":[]}]}]}],"example":"DOC_6X4"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document type to be generated (e.g., SHIPPING_LABEL)."},"children":[]}]}]}],"example":"SHIPPING_LABEL"},"format":{"type":"string","description":"File format for the label (e.g., PDF, PNG, ZPL2).","example":"PDF"},"carrierAccountId":{"type":"string","description":"The account ID associated with the USPS carrier.","example":"80KLN17qMJM"},"metadata":{"type":"array","items":{"type":"object"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}]},"fromAddress":{"$ref":"#/components/schemas/fromAddressV2","example":{"addressLine1":"5100 S Main St,Ste 500","cityTown":"Los Angeles","countryCode":"US","name":"Steve Smith","phone":"203-555-1213","postalCode":"90037-3840","stateProvince":"CA"}},"toAddress":{"$ref":"#/components/schemas/toAddressV2","example":{"addressLine1":"8 Abc Dr","cityTown":"Beals","company":"ABC Company","countryCode":"US","email":"sender@email.com","name":"Sasha Sekrotov","phone":"323 555-1212","postalCode":"04611-3214","residential":false,"stateProvince":"ME"}},"parcel":{"type":"object","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"number","format":"float","example":1},"width":{"type":"number","format":"float","example":0.025},"height":{"type":"number","format":"float","example":1},"dimUnit":{"type":"string","example":"IN"},"weight":{"type":"number","format":"float","example":1},"weightUnit":{"type":"string","example":"OZ"}}}},"example":{"size":"DOC_6X4","type":"SHIPPING_LABEL","format":"PDF","fromAddress":{"addressLine1":"5100 S Main St,Ste 500","cityTown":"Los Angeles","countryCode":"US","name":"Steve Smith","phone":"203-555-1213","postalCode":"90037-3840","stateProvince":"CA"},"parcel":{"length":1,"width":0.025,"height":1,"dimUnit":"IN","weightUnit":"OZ","weight":1},"carrierAccountId":"80KLN17qMJM","serviceId":"FCM","parcelType":"FLAT","metadata":[],"toAddress":{"addressLine1":"8 Abc Dr","cityTown":"Beals","company":"ABC Company","countryCode":"US","email":"sender@email.com","name":"Sasha Sekrotov","phone":"323 555-1212","postalCode":"04611-3214","residential":false,"stateProvince":"ME"}}}},"components/schemas/MilitaryMailShipmentsRequestV2":{"id":"components/schemas/MilitaryMailShipmentsRequestV2","kind":"json-schema","title":"Military Mail Shipment","data":{"title":"Military Mail Shipment","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For domestic USPS Military Mail shipments (APO/FPO/DPO Address), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object is required if any of the following are true:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Weight is greater than or equal to 16 ounces."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Weight is less than 16 ounces AND shipment contains items other than documents. Specify the items in customs.customsInfo.reasonForExport."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment uses Priority Mail Express (EM). A customs form is always required for Priority Mail Express."},"children":[]}]}]}]}],"required":["toAddress","parcelType","rateShopBy","labelSize","labelType","labelFormat","customs"],"properties":{"fromAddress":{"$ref":"#/components/schemas/fromAddressV2"},"toAddress":{"$ref":"#/components/schemas/MilitaryMailAddress"},"parcel":{"$ref":"#/components/schemas/parcelV2"},"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ParcelType can have categories like Package, Envelopes, Paks, Boxes, Tube, etc. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"PKG"},"rateShopBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RateShop, which is attached to an Enterprise or Location, is done through four approaches: by Carrier, by RateGroup, by RuleSet and by shipViaCode. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  Through Carrier, customers can choose the carriers as per requirement, based on which services, parcel types, and special services can be selected, and RateShop is done. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RateGroup, customers can select the RateGroup, which has been divided into two categories: Cheapest (w.r.t. price) and Fastest (w.r.t. delivery hours). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RuleSet, customers can define the Condition/rule for selecting carriers and their services, so they do not need to worry for Rate Shopping every time they create Shipment. For example, For a particular location, they can set one definite carrier, or apply RateGroup - Cheapest/Fastest. Similarly, for a particular amount like below $1000 Dollars, they can select a definite carrier service, based on RateGroup. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through shipViaCode, customers can create a shipment using a single code (Custom Carrier Code) that represents a specific combination of carrier, carrier account, parcel type, service, and special services."},"children":[]}]}]}],"example":"carrier","enum":["carrier","rateGroup","ruleSet","shipViaCode"]},"byCarrier":{"$ref":"#/components/schemas/byCarrierV2"},"shipmentOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment Options have an added feature that is Manifest."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" With Manifest, the Mail Center agent can print the Manifest (End of day records of all created shipment) of selected carrier."},"children":[]}]}]}],"properties":{"addToManifest":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option asks if the shipment is to be added for Manifest, so that the shipment will reflect in the Manifest Form while compilation. Supported for CPC and USPS carriers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value can be 'true' or 'false'."},"children":[]}]}]}],"example":true},"shipperID":{"type":"string","description":"The unique identifier of the known shipper associated with this shipment.","example":"1234567890"}}},"deliveryConfirmation":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the supporting special service or document as an evidence of shipment delivery."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the delivery confirmation, user can select any of the following special services, but they may vary as per the carrier selection. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature Required/ Indirect Signature Required : SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery confirmation: DELIVERY_CONFIRMATION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of age required (18 years) Adult Signature Required: ADULT_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of age required (19 years): ADULT_SIGNATURE_19"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Signature Required: NO_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Signature Required: DIRECT_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain of Signature: CHAIN_OF_SIGNATURE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE and ADULT_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE, ADULT_SIGNATURE, NO_SIGNATURE, and DIRECT_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ADULT_SIGNATURE, NO_SIGNATURE, and CHAIN_OF_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GoFor supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPC supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE, DELIVERY_CONFIRMATION, ADULT_SIGNATURE, ADULT_SIGNATURE_19, and NO_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The delivery confirmation Type.","example":"ADULT_SIGNATURE","enum":["NO_SIGNATURE","SIGNATURE","ADULT_SIGNATURE","ADULT_SIGNATURE_19","DIRECT_SIGNATURE","DELIVERY_CONFIRMATION","CHAIN_OF_SIGNATURE"]}}},"handling":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Few shipments need a special handling, and the reason can be fragile items or highly secured shipments. There might be other case scenarios. In a simple term, this field defines shipment handling, which provides users a capability to select handling options. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User can select any of the following handling options (special services), but they may vary as per the carrier selection."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hold For Pickup: HOLD_FOR_PICKUP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saturday Delivery: SATURDAY_DELIVERY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Premium Care: PREMIUM_CARE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Delivery Only: DIRECT_DELIVERY_ONLY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Handling: ADDITIONAL_HANDLING"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS supports all handling options mentioned above."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOLD_FOR_PICKUP, SATURDAY_DELIVERY, and ADDITIONAL_HANDLING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOLD_FOR_PICKUP, SATURDAY_DELIVERY, and ADDITIONAL_HANDLING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The special handling type.","example":"ADDITIONAL_HANDLING","enum":["HOLD_FOR_PICKUP","SATURDAY_DELIVERY","PREMIUM_CARE","DIRECT_DELIVERY_ONLY","ADDITIONAL_HANDLING"]}}},"insurance":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the insurance coverage, which is selected by users while create shipment - rate shopping. User can select below-mentioned special service for insurance:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declared Value Surcharge: INSURANCE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS, FedEx, Purolator, and CPC support special service "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSURANCE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The insurance type.","example":"INSURANCE","enum":["INSURANCE"]},"amount":{"type":"number","description":"The insurance amount in the currency specified for the shipment.","example":200}}},"references":{"$ref":"#/components/schemas/referenceV2"},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","description":"The data that provides information about other inter-related/ required data.","properties":{"name":{"type":"string","description":"Name of the Cost Account which are linked to Shipment.","example":"costAccountName"},"value":{"type":"string","description":"Indicates the value for the CostAccount.","example":"cost1"}}}},"labelSize":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the label size of the Shipment, that is, the Shipping Label is available in different Doc Size. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]}]}]}],"enum":["DOC_8X11","DOC_4X8","DOC_4X6"],"example":"DOC_4X6"},"labelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the Shipment. QR_CODE supported for carrier USPS only as of now. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]}]}]}],"enum":["SHIPPING_LABEL","QR_CODE"],"example":"SHIPPING_LABEL"},"labelFormat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Defines the file/format in which the label is printed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For ZPL2, DOC_4X6 will be supported, while for PDF, both the sizes are supported. QR_CODE can be generated only in GIF format. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"enum":["PDF","ZPL2","PNG","GIF"],"example":"ZPL2"},"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the label content is encoded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" BASE64 is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZPL2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PNG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"BASE64","enum":["URL","BASE64"]},"printerAliasName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to a printer connected (directly or via network) to a computer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 60"},"children":[]}]}]}],"example":"test"},"dateOfShipment":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when shipment is created/shipped. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: For FedEx US shipments, when a shipment date is provided in the request, the specified value is used for shipment processing. If no shipment date is provided, Carrier processes it as per their system."},"children":[]}]}]}],"example":"2024-03-20"},"deliveryOption":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two options of delivery: deliverBy and useBestNextDate, where customer can schedule the delivery date in deliverBy. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In case if the customer's scheduled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date falls under Holiday, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useBestNextDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used by our system. Then, we will mark the second option and deliver the same."},"children":[]}]}]}],"properties":{"deliverBy":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery date is the data when shipment is to be delivered, which is scheduled by sender. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field will be mandatory to provide, if the customer chooses ruleType is deliverBy."},"children":[]}]}]}],"example":"2024-03-20"},"useBestNextDate":{"type":"boolean","description":"When this is set to true, if the scheduled delivery date falls on a Holiday, then the next business day will be considered to deliver the shipment.","example":false}}},"customs":{"type":"object","required":["customsInfo","customsItems"],"properties":{"customsItems":{"type":"array","items":{"type":"object","required":["description","quantity","unitPrice","weight","weightUnit"],"properties":{"description":{"type":"string","description":"A detailed description of the commodity, up to 255 characters. The description will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Each description will appear on the form.","example":"T-shirt"},"hSTariffCode":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination country’s tariff-classification number (HS code) for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and then add digits for more detail. The maximum length for an HS code is 14 characters. The HS code will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each."},"children":[]}]}]}],"example":"610910"},"originCountryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two-character ISO country code of the shipment’s origin country. Use ISO 3166-1 Alpha-2 standard values."},"children":[]}]}]}],"example":"US"},"quantity":{"type":"number","description":"Enter the total number of items of this type of commodity.","example":1},"unitPrice":{"type":"number","description":"The price of one item of this type of commodity.","example":10},"weightUnit":{"type":"string","enum":["OZ"],"description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"The weight of the item.","example":1}}}},"customsInfo":{"type":"object","description":"This is additional customs information required along with item details.","required":["reasonForExport","customsDeclaredValue","currencyCode"],"properties":{"reasonForExport":{"type":"string","enum":["GIFT","COMMERCIAL_SAMPLE","MERCHANDISE","DOCUMENTS","RETURNED_GOODS","OTHER"],"description":"The reason the commodity is being exported.","example":"GIFT"},"customsDeclaredValue":{"description":"Item value in mentioned currencyCode","type":"number","example":10},"currencyCode":{"description":"The currency used for declared value. Use three uppercase letters, per ISO 4217","example":"USD","type":"string"},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"certificateNumber":{"type":"string","description":"The certificate number associated with the commodity.","example":"123456"},"comments":{"type":"string","description":"Free-form comments regarding the exported shipment.","example":"This is a sample comment"},"fromCustomsReference":{"type":"string","description":"Free-form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.","example":"EFEFE4554545"},"importerCustomsReference":{"type":"string","description":"A reference number used by the importer, such as a VAT number, PO number, or insured number.","example":"dff3433"},"invoiceNumber":{"type":"string","description":"The commercial invoice number assigned by the exporter.","example":"123456"},"licenseNumber":{"type":"string","description":"The export license number associated with the commodity.","example":"123456"},"sdrValue":{"type":"number","description":"When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values.","example":10}}}}}},"example":{"fromAddress":{"addressLine1":"1600 Amphitheatre Parkway","addressLine2":"near abc street","addressLine3":"near xyz street","company":"PB","name":"Sender Name","email":"testuser@gmail.com","phone":"6502530000","cityTown":"Mountain View","stateProvince":"CA","postalCode":"94043","countryCode":"US","residential":true},"toAddress":{"addressLine1":"UNIT 35007","addressLine2":"near abc street","addressLine3":"near xyz street","cityTown":"APO","countryCode":"US","name":"Recipient Name","phone":"518-727-4964","company":"PB","email":"testuser@gmail.com","postalCode":"96376-5007","stateProvince":"AP","residential":false},"parcel":{"length":2,"width":1,"height":1,"dimUnit":"IN","weightUnit":"OZ","weight":2,"packageValue":2},"parcelType":"PKG","rateShopBy":"carrier","byCarrier":{"carrierAccountId":"{{uspscarrierid}}","carrier":"USPS","service":"PM"},"shipmentOptions":{"addToManifest":true,"shipperId":"2000084646"},"references":{"reference1":"custome message","reference2":"SendTech"},"metadata":[{"name":"costAccountName","value":"cost1"}],"labelSize":"DOC_4X6","labelType":"SHIPPING_LABEL","labelFormat":"PDF","contentType":"URL","printerAliasName":"test","dateOfShipment":"2025-09-04","deliveryOption":{"deliverBy":"2025-09-10","useBestNextDate":false},"customs":{"customsItems":[{"description":"T-shirt","hSTariffCode":"610910","originCountryCode":"US","quantity":1,"unitPrice":10,"weightUnit":"OZ","weight":1}],"customsInfo":{"reasonForExport":"GIFT","customsDeclaredValue":10,"currencyCode":"USD","EELPFC":"NOEEI 30.2D2","certificateNumber":"123456","comments":"This is a sample comment","fromCustomsReference":"EFEFE4554545","importerCustomsReference":"dff3433","invoiceNumber":"123456","licenseNumber":"123456","sdrValue":10,"termsOfSale":"DDP"}}}}},"components/schemas/ShipmentDomesticByCarrier":{"id":"components/schemas/ShipmentDomesticByCarrier","kind":"json-schema","title":"By Carrier","data":{"title":"By Carrier","type":"object","required":["toAddress","parcelType","rateShopBy","labelSize","labelType","labelFormat"],"properties":{"fromAddress":{"$ref":"#/components/schemas/fromAddressV2"},"toAddress":{"$ref":"#/components/schemas/toAddressV2"},"soldToAddress":{"$ref":"#/components/schemas/soldToAddressV2"},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"},"altReturnAddress":{"$ref":"#/components/schemas/altReturnAddress"},"parcel":{"$ref":"#/components/schemas/parcelV2"},"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ParcelType can have categories like Package, Envelopes, Paks, Boxes, Tube, etc. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"PKG"},"rateTypeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of rate requested like COMMERCIAL, ONE_RATE, RETAIL,"},"children":[]}]}]}]},"rateShopBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RateShop, which is attached to an Enterprise or Location, is done through four approaches: by Carrier, by RateGroup, by RuleSet and by shipViaCode**. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  Through Carrier, customers can choose the carriers as per requirement, based on which services, parcel types, and special services can be selected, and RateShop is done. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RateGroup, customers can select the RateGroup, which has been divided into two categories: Cheapest (w.r.t. price) and Fastest (w.r.t. delivery hours). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RuleSet, customers can define the Condition/rule for selecting carriers and their services, so they do not need to worry for Rate Shopping every time they create Shipment. For example, For a particular location, they can set one definite carrier, or apply RateGroup - Cheapest/Fastest. Similarly, for a particular amount like below $1000 Dollars, they can select a definite carrier service, based on RateGroup. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through shipViaCode, customers can create a shipment using a single code (Custom Carrier Code) that represents a specific combination of carrier, carrier account, parcel type, service, and special services."},"children":[]}]}]}],"example":"carrier","enum":["carrier","rateGroup","ruleSet","shipViaCode"]},"byCarrier":{"$ref":"#/components/schemas/byCarrierV2"},"shipmentOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment Options have an added feature that is Manifest."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" With Manifest, the Mail Center agent can print the Manifest (End of day records of all created shipment) of selected carrier."},"children":[]}]}]}],"properties":{"addToManifest":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option asks if the shipment is to be added for Manifest, so that the shipment will reflect in the Manifest Form while compilation. Supported for CPC and USPS carriers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value can be 'true' or 'false'."},"children":[]}]}]}],"example":true},"minimalAddressValidation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows performing minimal address validation during shipment creation. the addressLine1 field is not validated if set to true."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimal address validation is supported only for these APIs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Shipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Bulk Shipments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Multipiece Shipment"},"children":[]}]}]}]}],"example":true,"enum":[true,false]},"bookingConfirmationNumber":{"type":"string","example":"1085test","description":"This field specifies the booking confirmation number for Freight International services."},"b2b":{"type":"boolean","example":true,"description":"Required only for RMG carrier. Must be set to true to indicate a business-to-business (B2B) shipment."},"senderEORI":{"type":"string","example":"GB123456789101","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's Economic Operators Registration and Identification number. EORI is a unique identification number used for customs clearance in the European Union. This Number can be 14 characters long in Alphanumeric format. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for RMG B2B shipments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"recipientEORI":{"type":"string","example":"GB123456789102","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient's EORI number. ORI is a unique identification number used for customs clearance in the European Union. This Number can be 14 characters long in Alphanumeric format. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for RMG B2B shipments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"senderUKIMSNumber":{"type":"string","example":"GBUKIM12345678910100000000000000","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UKIMS (UK Internal Market Scheme) is an authorization that allows businesses to move goods between Great Britain (GB) and Northern Ireland (NI) without paying EU (European) duty. UKIMS Number can be 32 characters long in Alphanumeric format. Required if the package value value is over £135."},"children":[]}]}]}]},"exportLicenceRequired":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the shipment includes goods that require an official export license."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applies to both RMG B2B and B2C shipments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required as part of customs compliance under the Windsor Agreement"},"children":[]}]}]}]}]},"declarationId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for CPC shipments originating in Canada and destined for the US when X_ACCESS_KEY was not provided during CPC carrier onboarding; if X_ACCESS_KEY is configured, omit this field. Each declarationId is unique to a single shipment."},"children":[]}]}]}],"example":"USA1006189"},"shipperID":{"type":"string","description":"The unique identifier of the known shipper associated with this shipment.","example":"1234567890"}}},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"docTab":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option is used to provide additional information into the label's additional space. It is supported only for doc size "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4x6_75"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"templateName":{"type":"string","description":"This is an optional field and will be used when the client has multiple doctab options.","example":"1"},"toAddressName":{"$ref":"#/components/schemas/docTabItem"},"parcelTrackingNumber":{"$ref":"#/components/schemas/docTabItem"},"carrier":{"$ref":"#/components/schemas/docTabItem"},"serviceId":{"$ref":"#/components/schemas/docTabItem"},"dateOfShipment":{"$ref":"#/components/schemas/docTabItem"},"pieceNumber":{"$ref":"#/components/schemas/docTabItem"},"packageTotalCarrierCharge":{"$ref":"#/components/schemas/docTabItem"},"totalCarrierCharge":{"$ref":"#/components/schemas/docTabItem"},"packageWeight":{"$ref":"#/components/schemas/docTabItem"},"totalWeight":{"$ref":"#/components/schemas/docTabItem"},"customField1":{"$ref":"#/components/schemas/docTabItem"},"customField2":{"$ref":"#/components/schemas/docTabItem"},"customField3":{"$ref":"#/components/schemas/docTabItem"},"customField4":{"$ref":"#/components/schemas/docTabItem"}},"example":{"templateName":"1","toAddressName":{"displayName":"CUS","value":"","row":1,"column":1},"parcelTrackingNumber":{"displayName":"TRK","value":"","row":2,"column":1},"carrier":{"displayName":"CAR","value":"","row":3,"column":1},"serviceId":{"displayName":"SER","value":"","row":1,"column":2},"dateOfShipment":{"displayName":"DATE","value":"","row":2,"column":2},"pieceNumber":{"displayName":"PKG#","value":"","row":3,"column":2},"packageTotalCarrierCharge":{"displayName":"PCHG","value":"","row":3,"column":3},"totalCarrierCharge":{"displayName":"TCHG","value":"","row":2,"column":3},"packageWeight":{"displayName":"PWGT","value":"","row":1,"column":3},"totalWeight":{"displayName":"TWGT","value":"","row":1,"column":4},"customField1":{"displayName":"INV","value":"010610000388302031320259999950","row":2,"column":4}}},"specialServices":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It provides a carrier based special or extra service, which also varies as per selected service and parcel type. User can override this value by defining it at shipment level."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either the specialserviceId or the specialservice objects such as deliveryConfirmation, handling, insurance and returnOptions, but not both."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/SpecialService"}},"deliveryConfirmation":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the supporting special service or document as an evidence of shipment delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either the specialserviceId or the specialservice objects such as deliveryConfirmation, handling, insurance and returnOptions, but not both."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the delivery confirmation, user can select any of the following special services, but they may vary as per the carrier selection. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature Required/ Indirect Signature Required : SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery confirmation: DELIVERY_CONFIRMATION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of age required (18 years) Adult Signature Required: ADULT_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of age required (19 years): ADULT_SIGNATURE_19"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Signature Required: NO_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Signature Required: DIRECT_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain of Signature: CHAIN_OF_SIGNATURE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE and ADULT_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE, ADULT_SIGNATURE, NO_SIGNATURE, and DIRECT_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ADULT_SIGNATURE, NO_SIGNATURE, and CHAIN_OF_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GoFor supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPC supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE, DELIVERY_CONFIRMATION, ADULT_SIGNATURE, ADULT_SIGNATURE_19, and NO_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The delivery confirmation Type.","example":"ADULT_SIGNATURE","enum":["NO_SIGNATURE","SIGNATURE","ADULT_SIGNATURE","ADULT_SIGNATURE_19","DIRECT_SIGNATURE","DELIVERY_CONFIRMATION","CHAIN_OF_SIGNATURE"]}}},"handling":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Few shipments need a special handling, and the reason can be fragile items or highly secured shipments. There might be other case scenarios. In a simple term, this field defines shipment handling, which provides users a capability to select handling options."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either the specialserviceId or the specialservice objects such as deliveryConfirmation, handling, insurance and returnOptions, but not both."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User can select any of the following handling options (special services), but they may vary as per the carrier selection."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hold For Pickup: HOLD_FOR_PICKUP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saturday Delivery: SATURDAY_DELIVERY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Premium Care: PREMIUM_CARE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Delivery Only: DIRECT_DELIVERY_ONLY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Handling: ADDITIONAL_HANDLING"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS supports all handling options mentioned above."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOLD_FOR_PICKUP, SATURDAY_DELIVERY, and ADDITIONAL_HANDLING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOLD_FOR_PICKUP, SATURDAY_DELIVERY, and ADDITIONAL_HANDLING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The special handling type.","example":"ADDITIONAL_HANDLING","enum":["HOLD_FOR_PICKUP","SATURDAY_DELIVERY","PREMIUM_CARE","DIRECT_DELIVERY_ONLY","ADDITIONAL_HANDLING"]}}},"insurance":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the insurance coverage, which is selected by users while create shipment - rate shopping. User can select below-mentioned special service for insurance:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declared Value Surcharge: INSURANCE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS, FedEx, Purolator, and CPC support special service "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSURANCE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either the specialserviceId or the specialservice objects such as deliveryConfirmation, handling, insurance and returnOptions, but not both."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The insurance type.","example":"INSURANCE","enum":["INSURANCE"]},"amount":{"type":"number","description":"The insurance amount in the currency specified for the shipment.","example":200}}},"references":{"$ref":"#/components/schemas/referenceV2"},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","description":"The data that provides information about other inter-related/ required data.","properties":{"name":{"type":"string","description":"Name of the Cost Account which are linked to Shipment.","example":"costAccountName"},"value":{"type":"string","description":"Indicates the value for the CostAccount.","example":"cost1"}}},"example":[{"name":"costAccountName","value":"costAccountName"},{"name":"costAccountId","value":"costAccountId"},{"name":"costAccountCode","value":"Code"},{"name":"accountCode","value":"code"},{"name":"companyCode","value":"code"}]},"labelSize":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the label size of the Shipment, that is, the Shipping Label is available in different Doc Size. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]}]}]}],"enum":["DOC_8X11","DOC_4X8","DOC_4X6"],"example":"DOC_4X6"},"labelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the Shipment. QR_CODE supported for carrier USPS only as of now. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]}]}]}],"enum":["SHIPPING_LABEL","QR_CODE"],"example":"SHIPPING_LABEL"},"labelFormat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Defines the file/format in which the label is printed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For ZPL2, DOC_4X6 will be supported, while for PDF, both the sizes are supported. QR_CODE can be generated only in GIF format. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"enum":["PDF","ZPL2","PNG","GIF"],"example":"ZPL2"},"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the label content is encoded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" BASE64 is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZPL2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PNG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"BASE64","enum":["URL","BASE64"]},"printerAliasName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to a printer connected (directly or via network) to a computer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 60"},"children":[]}]}]}],"example":"test"},"dateOfShipment":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when shipment is created/shipped. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: For FedEx US shipments, when a shipment date is provided in the request, the specified value is used for shipment processing. If no shipment date is provided, Carrier processes it as per their system."},"children":[]}]}]}],"example":"2024-03-20"},"deliveryOption":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two options of delivery: deliverBy and useBestNextDate, where customer can schedule the delivery date in deliverBy. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In case if the customer's scheduled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date falls under Holiday, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useBestNextDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used by our system. Then, we will mark the second option and deliver the same."},"children":[]}]}]}],"properties":{"deliverBy":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery date is the data when shipment is to be delivered, which is scheduled by sender. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field will be mandatory to provide, if the customer chooses ruleType is deliverBy."},"children":[]}]}]}],"example":"2024-03-20"},"useBestNextDate":{"type":"boolean","description":"When this is set to true, if the scheduled delivery date falls on a Holiday, then the next business day will be considered to deliver the shipment.","example":false}}},"returnOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object defines return shipment options. It should be passed when requesting return labels. Supported only for carriers UPS and FedEx as of now."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For UPS, this object is required. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For FedEx, this object is optional. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object must be sent with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isReturn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either the specialserviceId or the specialservice objects such as deliveryConfirmation, handling, insurance and returnOptions, but not both."},"children":[]}]}]}]}],"required":["type","inputParameters"],"properties":{"type":{"type":"string","example":"RETURN_BY_PRL","description":"Specifies the return type. This is the value of special service code for the carrier-supported return service."},"inputParameters":{"type":"array","description":"List of input parameters required for return processing.","items":{"type":"object","properties":{"name":{"type":"string","example":"RMA_NUMBER","description":"The name of the parameter."},"value":{"type":"string","example":"123","description":"The corresponding value for the parameter."}}}}}},"customs":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customs information required for international shipments and optional for domestic shipments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only for RMG carrier in domestic shipment requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must include customsItems and customsInfo objects."},"children":[]}]}]}]}],"required":["customsInfo","customsItems"],"properties":{"customsInfo":{"type":"object","description":"This is additional customs information required along with item details.","required":["reasonForExport","customsDeclaredValue","currencyCode"],"properties":{"reasonForExport":{"type":"string","description":"Reason for exporting the items.","example":"DOCUMENTS","enum":["GIFT","COMMERCIAL_SAMPLE","MERCHANDISE","DOCUMENTS","RETURNED_GOODS","OTHER"]},"comments":{"type":"string","description":"Free-form comments regarding the exported shipment.","example":"Test comment"},"invoiceNumber":{"type":"string","description":"The commercial invoice number assigned by the exporter.","example":"001189223"},"importerCustomsReference":{"type":"string","description":"A reference number used by the importer, such as a VAT number, PO number, or insured number.","example":"987654"},"sdrValue":{"type":"number","format":"float","description":"When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values.","example":23.32},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"currencyCode":{"type":"string","description":"The currency used for declared value. Use three uppercase letters, per ISO 4217.","example":"USD"},"fromCustomsReference":{"type":"string","description":"Free-form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.","example":"EFEFE4554545"},"licenseNumber":{"type":"string","description":"The export license number associated with the commodity.","example":"456ABC123"},"certificateNumber":{"type":"string","description":"The certificate number associated with the commodity.","example":"987"},"customsDeclaredValue":{"type":"number","description":"Item value in mentioned currencyCode.","example":6000},"termsOfSale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the delivery and payment terms between the shipper and recipient. Currenty supported by carriers - UPS, FedEx and DHL. - Common values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CIP: Carriage and Insurance Paid to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPT: Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAP: Delivered at Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAT: Delivered at Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DDP: Delivered Duty Paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXW: Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FCA: Free Carrier"},"children":[]}]}]}]}],"example":"DDP","enum":["CIP","CPT","DAP","DAT","DDP","EXW","FCA"]}}},"customsItems":{"type":"array","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items included in the customs declaration."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Either use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customsProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item properties"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" individually."},"children":[]}]}]}]}],"required":["description","quantity","unitPrice","weight","weightUnit"],"items":{"type":"object","properties":{"customsProductId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this identifier to prefill customs item fields (HS tariff code, origin country, unit price, weight, quantity). Generate custom product identifier using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/customproduct/customs-product/addcustomsproduct"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add Customs Product API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: When creating a single shipment, either provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customsProductId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or individual values of an item within the item object."},"children":[]}]}]}]}]},"description":{"type":"string","description":"A detailed description of the commodity, up to 255 characters. The description will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Each description will appear on the form.","example":"Books"},"itemId":{"type":"string","description":"Unique identifier for the commodity.","example":"item1"},"orderNumber":{"type":"string","description":"The unique identifier for the order.","example":"ORD1"},"quantity":{"type":"number","description":"Enter the total number of items of this type of commodity.","example":1},"unitPrice":{"type":"number","format":"float","description":"The price of one item of this type of commodity.","example":3000},"weightUnit":{"type":"string","description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"Weight of the item.","example":0.1},"hSTariffCode":{"type":"string","description":"The destination country's tariff-classification number (HS code) for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and then add digits for more detail. The maximum length for an HS code is 14 characters. The HS code will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. HS Code is required for RMG b2b shipment.","example":"AST559"},"originCountryCode":{"type":"string","description":"The two-character ISO country code of the shipment's origin country. Use ISO 3166-1 Alpha-2 standard values.","example":"US"}}}},"customsDocuments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to attach Electronic Trade Documents (ETDs) to your DHL international shipment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item should represent a document uploaded previously using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For DHL, if you pass this field, ensure the selected service type is PAPERLESS."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"s3FileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be taken from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic trade document must upload before shipment label creation."},"children":[]}]}]}]}],"items":{"type":"object","required":["fileName","s3FileId","documentType"],"properties":{"fileName":{"type":"string","description":"The name of the uploaded trade document file.","example":"invoice.pdf"},"s3FileId":{"type":"string","description":"The relative file path where the document is stored in the S3 bucket.","example":"uploads/shipping/intl_docs/sa58a03/0oa2bxnhu03i48mh50h8/NJ3ww7gv73kwDJK/DRNgGjEraOvV8ZB_invoice.pdf"},"documentType":{"type":"string","enum":["INVOICE","COMMERCIAL_INVOICE","PROFORMA_INVOICE","CERTIFICATE_OF_ORIGIN","NAFTA_CERTIFICATE_OF_ORIGIN","CUSTOMS_DECLARATION_FORM","AIR_WAYBILL_AND_WAYBILL"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the uploaded document. This value is referenced when generating customs declarations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must match the type used during document upload."},"children":[]}]}]}],"example":"INVOICE"}}}}}}},"example":{"fromAddress":{"name":"Sender Name","addressLine1":"1600 Amphitheatre Parkway","addressLine2":"near abc street","addressLine3":"near xyz street","company":"PB","email":"testuser@gmail.com","phone":"6502530000","cityTown":"Mountain View","stateProvince":"CA","postalCode":"94043","inductionPostalCode":"06905","countryCode":"US","residential":true},"toAddress":{"name":"Recipient Name","addressLine1":"350 Fifth Avenue","addressLine2":"near abc street","addressLine3":"near xyz street","cityTown":"New York","stateProvince":"NY","postalCode":"10118","countryCode":"US","company":"PB","phone":"2127363100","email":"recipient@gmail.com","residential":true,"isPOBox":true},"parcel":{"length":10,"width":10,"height":10,"dimUnit":"IN","weightUnit":"OZ","weight":10,"packageValue":10},"parcelType":"PKG","rateShopBy":"carrier","byCarrier":{"carrierAccountId":"YNp3883Bap3L","carrier":"USPS","service":"EM"},"shipmentOptions":{"addToManifest":true,"shipperID":"1234567890"},"specialServices":[{"inputParameters":[{"name":"INPUT_VALUE","value":"100"}],"specialserviceId":"Ins"}],"metadata":[{"name":"costAccountName","value":"costAccountName"},{"name":"costAccountId","value":"costAccountId"},{"name":"costAccountCode","value":"Code"},{"name":"accountCode","value":"code"},{"name":"companyCode","value":"code"}],"references":{"reference1":"custome message","reference2":"SendTech","reference3":"98437","reference4":"Overnight Shipping","poNumber":"R2W 2H2","department":"Name department","additionalReference1":"612987641","additionalReference2":"989","shippingNotes":"Handle with care.","ShipperReference":"REF123456789","transportationReference":"TRANSREF987654321"},"labelSize":"DOC_4X6","labelType":"SHIPPING_LABEL","labelFormat":"PDF","contentType":"URL","dateOfShipment":"2025-10-28","deliveryOption":{"deliverBy":"2025-10-30","useBestNextDate":false}}}},"components/schemas/shipmentInternational":{"id":"components/schemas/shipmentInternational","kind":"json-schema","title":"shipmentInternational","data":{"type":"object","required":["size","type","fromAddress","parcel","toAddress","carrierAccountId","serviceId","parcelType","customs"],"properties":{"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (8' X 11' or 4' X 8' ).","enum":["DOC_8X11","DOC_4X8"],"example":"DOC_8X11"},"type":{"type":"string","description":"Defines the type of the Shipment, e.g., Shipping Label.","example":"SHIPPING_LABEL","enum":["SHIPPING_LABEL"]},"format":{"type":"string","description":"Defines the type of the shipment label that is printed.","example":"PDF"},"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the label content is encoded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" BASE64 is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZPL2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PNG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"URL","enum":["URL","BASE64"]},"dateOfShipment":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when shipment is created/shipped. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: For FedEx US shipments, when a shipment date is provided in the request, the specified value is used for shipment processing. If no shipment date is provided, Carrier processes it as per their system."},"children":[]}]}]}],"example":"2024-03-20"},"fromAddress":{"type":"object","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"company":{"type":"string","description":"The name of the company, in case if the sender address is not residential. ","example":"PB"},"email":{"type":"string","description":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. This field is required for RMG b2b shipment.","example":"testuser@gmail.com"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used. IPC supported only for carrier USPS.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"taxId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tax Identification Number (TIN). TIN Number is supported for FedEx as of now."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max character length = 18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOSS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EORI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_UNION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 12 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 13 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"taxIdType":{"type":"string","description":"Specifies the type of tax identification being provided.","enum":["EIN","GST","VAT","IOSS","RFC","EORI"]}}},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by USPS, FedEx, UPS, and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}},"parcel":{"type":"object","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is a part of Dimension object having highest numeric value out of three required parameters (length, width, and height) of Dimension. It helps determine a parcel’s girth."},"children":[]}]}]}],"example":2},"width":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Width is a part of Dimension object having lowest numeric value out of three required parameters of dimension (length, width, and height). This helps determine a parcel’s girth."},"children":[]}]}]}],"example":1},"height":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Height is a part of Dimension object where it helps determine a parcel’s girth."},"children":[]}]}]}],"example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","enum":["OZ"],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":1}}},"carrierAccountId":{"type":"string","example":"asas2223","description":"The unique identifier associated with the Carrier account used by client users during shipment process.","x-go-name":"carrierAccountId"},"parcelType":{"type":"string","example":"PKG","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. It has categories like Package, Envelopes, Paks, Boxes, Tube, defined per specific carrier and used in abbreviated form, e.g., FRPKG, LGENV, TUBE, PKG."},"children":[]}]}]}]}],"x-go-name":"ParcelType"},"serviceId":{"type":"string","example":"PMI","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-A unique identifier given to the carrier-specific service. This is required for creating a shipment, while it is optional for rating a parcel."},"children":[]}]}]}]}],"x-go-name":"serviceId"},"specialServices":{"type":"array","description":"It provides a carrier-service based special or extra service.","items":{"$ref":"#/components/schemas/SpecialService"},"x-go-name":"SpecialServices"},"shipmentOptions":{"allOf":[{"$ref":"#/components/schemas/shipmentOptions"},{"type":"object","properties":{"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"}}},{"type":"object","properties":{"b2b":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RMG carrier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate a business-to-business (B2B) shipment."},"children":[]}]}]}]}}},{"type":"object","properties":{"senderEORI":{"type":"string","example":"GB123456789101","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's Economic Operators Registration and Identification number. EORI is a unique identification number used for customs clearance in the European Union. This Number can be 14 characters long in Alphanumeric format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for RMG B2B shipments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},{"type":"object","properties":{"recipientEORI":{"type":"string","example":"GB123456789101","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient's EORI number. ORI is a unique identification number used for customs clearance in the European Union. This Number can be 14 characters long in Alphanumeric format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for RMG B2B shipments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},{"type":"object","properties":{"senderUKIMSNumber":{"type":"string","example":"GBUKIM12345678910100000000000000","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UKIMS (UK Internal Market Scheme) is an authorization that allows businesses to move goods between Great Britain (GB) and Northern Ireland (NI) without paying EU (European) duty. UKIMS Number can be 32 characters long in Alphanumeric format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if the package value value is over £135."},"children":[]}]}]}]}}},{"type":"object","properties":{"exportLicenceRequired":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the shipment includes goods that require an official export license."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applies to both RMG B2B and B2C shipments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required as part of customs compliance under the Windsor Agreement"},"children":[]}]}]}]}]}}}]},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","example":"costAccountName"},"value":{"type":"string","example":"cost account 123"}}}},"toAddress":{"type":"object","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"70 Hanlan RD"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Woodbridge"},"countryCode":{"type":"string","description":"The two-character ISO Code of the destination country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"CA"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"company":{"type":"string","description":"The name of the company, in case if the receiver address is not residential. This field is required for RMG b2b shipment.","example":"PB"},"email":{"type":"string","description":"This must be receivers's valid email. Email is required if the customer is using GoFor Carrier.","example":"testuser@gmail.com"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"L4L3P6"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"ON"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"taxId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tax Identification Number (TIN). TIN Number is supported for FedEx as of now."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max character length = 18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOSS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EORI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_UNION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 12 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 13 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"taxIdType":{"type":"string","description":"Specifies the type of tax identification being provided.","enum":["EIN","GST","VAT","IOSS","RFC","EORI"]}}},"soldToAddress":{"$ref":"#/components/schemas/soldToAddress"},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"},"customs":{"type":"object","required":["customsInfo","customsItems"],"properties":{"customsItems":{"type":"array","items":{"type":"object","required":["description","quantity","unitPrice","weight","weightUnit"],"properties":{"description":{"type":"string","description":"A detailed description of the commodity, up to 255 characters. The description will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Each description will appear on the form.","example":"T-shirt"},"hSTariffCode":{"type":"object","description":"The destination country's tariff-classification number (HS code) for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and then add digits for more detail. The maximum length for an HS code is 14 characters. The HS code will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Required for RMG carrier.","example":"610910"},"originCountryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two-character ISO country code of the shipment’s origin country. Use ISO 3166-1 Alpha-2 standard values."},"children":[]}]}]}],"example":"US"},"quantity":{"type":"number","description":"Enter the total number of items of this type of commodity.","example":1},"unitPrice":{"type":"number","description":"The price of one item of this type of commodity.","example":10},"weightUnit":{"type":"string","enum":["OZ"],"description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"The weight of the item.","example":1}}}},"customsInfo":{"type":"object","description":"This is additional customs information required along with item details.","required":["reasonForExport","customsDeclaredValue","currencyCode"],"properties":{"reasonForExport":{"type":"string","enum":["GIFT","COMMERCIAL_SAMPLE","MERCHANDISE","DOCUMENTS","RETURNED_GOODS","OTHER"],"description":"The reason the commodity is being exported.","example":"GIFT"},"customsDeclaredValue":{"description":"Item value in mentioned currencyCode","type":"number","example":10},"currencyCode":{"description":"The currency used for declared value. Use three uppercase letters, per ISO 4217","example":"USD","type":"string"},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"certificateNumber":{"type":"string","description":"The certificate number associated with the commodity.","example":"123456"},"comments":{"type":"string","description":"Free-form comments regarding the exported shipment.","example":"This is a sample comment"},"fromCustomsReference":{"type":"string","description":"Free-form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.","example":"EFEFE4554545"},"importerCustomsReference":{"type":"string","description":"A reference number used by the importer, such as a VAT number, PO number, or insured number.","example":"dff3433"},"invoiceNumber":{"type":"string","description":"The commercial invoice number assigned by the exporter.","example":"123456"},"licenseNumber":{"type":"string","description":"The export license number associated with the commodity.","example":"123456"},"sdrValue":{"type":"number","description":"When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values.","example":10},"termsOfSale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the delivery and payment terms between the shipper and recipient.Currenty supported by carriers - UPS, FedEx and DHL. - Common values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CIP: Carriage and Insurance Paid to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPT: Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAP: Delivered at Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAT: Delivered at Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DDP: Delivered Duty Paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXW: Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FCA: Free Carrier"},"children":[]}]}]}]}],"example":"DDP","enum":["CIP","CPT","DAP","DAT","DDP","EXW","FCA"]}}},"customsDocuments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to attach Electronic Trade Documents (ETDs) to your DHL international shipment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item should represent a document uploaded previously using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For DHL, if you pass this field, ensure the selected service type is PAPERLESS."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"s3FileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be taken from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic trade document must upload before shipment label creation."},"children":[]}]}]}]}],"items":{"type":"object","required":["fileName","s3FileId","documentType"],"properties":{"fileName":{"type":"string","description":"The name of the uploaded trade document file.","example":"invoice.pdf"},"s3FileId":{"type":"string","description":"The relative file path where the document is stored in the S3 bucket.","example":"uploads/shipping/intl_docs/sa58a03/0oa2bxnhu03i48mh50h8/NJ3ww7gv73kwDJK/DRNgGjEraOvV8ZB_invoice.pdf"},"documentType":{"type":"string","enum":["INVOICE","COMMERCIAL_INVOICE","PROFORMA_INVOICE","CERTIFICATE_OF_ORIGIN","NAFTA_CERTIFICATE_OF_ORIGIN","CUSTOMS_DECLARATION_FORM","AIR_WAYBILL_AND_WAYBILL"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the uploaded document. This value is referenced when generating customs declarations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must match the type used during document upload."},"children":[]}]}]}],"example":"INVOICE"}}}}}}}}},"components/schemas/shipmentDomesticByShipViaCode":{"id":"components/schemas/shipmentDomesticByShipViaCode","kind":"json-schema","title":"By ShipCode","data":{"title":"By ShipCode","type":"object","required":["toAddress","rateShopBy","labelSize","labelType","labelFormat"],"properties":{"fromAddress":{"$ref":"#/components/schemas/fromAddressV2"},"toAddress":{"$ref":"#/components/schemas/toAddressV2"},"soldToAddress":{"$ref":"#/components/schemas/soldToAddressV2"},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by FedEx, UPS, and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"500 Terry Francois Blvd"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"San Francisco"},"countryCode":{"type":"string","description":"The two-letter ISO country code for the alternate return address.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"415-555-7890"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"94158"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CA"}}},"parcel":{"$ref":"#/components/schemas/parcelV2"},"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ParcelType can have categories like Package, Envelopes, Paks, Boxes, Tube, etc. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Rate Shop by Custom Carrier Code, the parcelType field in the request payload is optional:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the parcel type is defined in the Custom Carrier Code metadata, it does not need to be provided in the request payload."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the parcel type is not defined in the Custom Carrier Code, it must be provided in the request payload."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If parcel type is provided in both the request payload and Custom Carrier Code, then  request payload value will be overridden by the values defined in the Custom Carrier Code."},"children":[]}]}]}]}]}]}]}],"example":"PKG"},"rateShopBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RateShop, which is attached to an Enterprise or Location, is done through four approaches: by Carrier, by RateGroup, by RuleSet  and by ShipViaCode. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  Through Carrier, customers can choose the carriers as per requirement, based on which services, parcel types, and special services can be selected, and RateShop is done. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RateGroup, customers can select the RateGroup, which has been divided into two categories: Cheapest (w.r.t. price) and Fastest (w.r.t. delivery hours). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RuleSet, customers can define the Condition/rule for selecting carriers and their services, so they do not need to worry for Rate Shopping every time they create Shipment. For example, For a particular location, they can set one definite carrier, or apply RateGroup - Cheapest/Fastest. Similarly, for a particular amount like below $1000 Dollars, they can select a definite carrier service, based on RateGroup. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through ShipViaCode, customers can create a shipment using a single code (Custom Carrier Code) that represents a specific combination of carrier, carrier account, parcel type, service, and special services."},"children":[]}]}]}],"example":"carrier","enum":["carrier","rateGroup","ruleSet","shipViaCode"]},"byShipViaCode":{"$ref":"#/components/schemas/byShipViaCodeV2"},"shipmentOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment Options have an added feature that is Manifest."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" With Manifest, the Mail Center agent can print the Manifest (End of day records of all created shipment) of selected carrier."},"children":[]}]}]}],"properties":{"addToManifest":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option asks if the shipment is to be added for Manifest, so that the shipment will reflect in the Manifest Form while compilation. Supported for CPC and USPS carriers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value can be 'true' or 'false'."},"children":[]}]}]}],"example":true},"minimalAddressValidation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows performing minimal address validation during shipment creation. the addressLine1 field is not validated if set to true."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimal address validation is supported only for these APIs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Shipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Bulk Shipments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Multipiece Shipment"},"children":[]}]}]}]}],"example":true,"enum":[true,false]},"bookingConfirmationNumber":{"type":"string","example":"1085test","description":"This field specifies the booking confirmation number for Freight International services."},"b2b":{"type":"boolean","example":true,"description":"Required only for RMG carrier. Must be set to true to indicate a business-to-business (B2B) shipment."},"senderEORI":{"type":"string","example":"GB123456789101","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's Economic Operators Registration and Identification number. EORI is a unique identification number used for customs clearance in the European Union. This Number can be 14 characters long in Alphanumeric format. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for RMG B2B shipments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"recipientEORI":{"type":"string","example":"GB123456789102","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient's EORI number. ORI is a unique identification number used for customs clearance in the European Union. This Number can be 14 characters long in Alphanumeric format. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for RMG B2B shipments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"senderUKIMSNumber":{"type":"string","example":"GBUKIM12345678910100000000000000","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UKIMS (UK Internal Market Scheme) is an authorization that allows businesses to move goods between Great Britain (GB) and Northern Ireland (NI) without paying EU (European) duty. UKIMS Number can be 32 characters long in Alphanumeric format. Required if the package value value is over £135."},"children":[]}]}]}]},"exportLicenceRequired":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the shipment includes goods that require an official export license."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applies to both RMG B2B and B2C shipments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required as part of customs compliance under the Windsor Agreement"},"children":[]}]}]}]}]},"declarationId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for CPC shipments originating in Canada and destined for the US when X_ACCESS_KEY was not provided during CPC carrier onboarding; if X_ACCESS_KEY is configured, omit this field. Each declarationId is unique to a single shipment."},"children":[]}]}]}],"example":"USA1006189"},"shipperID":{"type":"string","description":"The unique identifier of the known shipper associated with this shipment.","example":"1234567890"}}},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"docTab":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option is used to provide additional information into the label's additional space. It is supported only for doc size "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4x6_75"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"templateName":{"type":"string","description":"This is an optional field and will be used when the client has multiple doctab options.","example":"1"},"toAddressName":{"$ref":"#/components/schemas/docTabItem"},"parcelTrackingNumber":{"$ref":"#/components/schemas/docTabItem"},"carrier":{"$ref":"#/components/schemas/docTabItem"},"serviceId":{"$ref":"#/components/schemas/docTabItem"},"dateOfShipment":{"$ref":"#/components/schemas/docTabItem"},"pieceNumber":{"$ref":"#/components/schemas/docTabItem"},"packageTotalCarrierCharge":{"$ref":"#/components/schemas/docTabItem"},"totalCarrierCharge":{"$ref":"#/components/schemas/docTabItem"},"packageWeight":{"$ref":"#/components/schemas/docTabItem"},"totalWeight":{"$ref":"#/components/schemas/docTabItem"},"customField1":{"$ref":"#/components/schemas/docTabItem"},"customField2":{"$ref":"#/components/schemas/docTabItem"},"customField3":{"$ref":"#/components/schemas/docTabItem"},"customField4":{"$ref":"#/components/schemas/docTabItem"}},"example":{"templateName":"1","toAddressName":{"displayName":"CUS","value":"","row":1,"column":1},"parcelTrackingNumber":{"displayName":"TRK","value":"","row":2,"column":1},"carrier":{"displayName":"CAR","value":"","row":3,"column":1},"serviceId":{"displayName":"SER","value":"","row":1,"column":2},"dateOfShipment":{"displayName":"DATE","value":"","row":2,"column":2},"pieceNumber":{"displayName":"PKG#","value":"","row":3,"column":2},"packageTotalCarrierCharge":{"displayName":"PCHG","value":"","row":3,"column":3},"totalCarrierCharge":{"displayName":"TCHG","value":"","row":2,"column":3},"packageWeight":{"displayName":"PWGT","value":"","row":1,"column":3},"totalWeight":{"displayName":"TWGT","value":"","row":1,"column":4},"customField1":{"displayName":"INV","value":"010610000388302031320259999950","row":2,"column":4}}},"specialServices":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It provides a carrier based special or extra service, which also varies as per selected service and parcel type. User can override this value by defining it at shipment level."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either the specialserviceId or the specialservice objects such as deliveryConfirmation, handling, insurance and returnOptions, but not both."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/SpecialService"}},"deliveryConfirmation":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the supporting special service or document as an evidence of shipment delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either the specialserviceId or the specialservice objects such as deliveryConfirmation, handling, insurance and returnOptions, but not both."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the delivery confirmation, user can select any of the following special services, but they may vary as per the carrier selection. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature Required/ Indirect Signature Required : SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery confirmation: DELIVERY_CONFIRMATION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of age required (18 years) Adult Signature Required: ADULT_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of age required (19 years): ADULT_SIGNATURE_19"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Signature Required: NO_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Signature Required: DIRECT_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain of Signature: CHAIN_OF_SIGNATURE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE and ADULT_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE, ADULT_SIGNATURE, NO_SIGNATURE, and DIRECT_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ADULT_SIGNATURE, NO_SIGNATURE, and CHAIN_OF_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GoFor supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPC supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE, DELIVERY_CONFIRMATION, ADULT_SIGNATURE, ADULT_SIGNATURE_19, and NO_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The delivery confirmation Type.","example":"ADULT_SIGNATURE","enum":["NO_SIGNATURE","SIGNATURE","ADULT_SIGNATURE","ADULT_SIGNATURE_19","DIRECT_SIGNATURE","DELIVERY_CONFIRMATION","CHAIN_OF_SIGNATURE"]}}},"handling":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Few shipments need a special handling, and the reason can be fragile items or highly secured shipments. There might be other case scenarios. In a simple term, this field defines shipment handling, which provides users a capability to select handling options."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either the specialserviceId or the specialservice objects such as deliveryConfirmation, handling, insurance and returnOptions, but not both."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User can select any of the following handling options (special services), but they may vary as per the carrier selection."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hold For Pickup: HOLD_FOR_PICKUP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saturday Delivery: SATURDAY_DELIVERY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Premium Care: PREMIUM_CARE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Delivery Only: DIRECT_DELIVERY_ONLY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Handling: ADDITIONAL_HANDLING"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS supports all handling options mentioned above."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOLD_FOR_PICKUP, SATURDAY_DELIVERY, and ADDITIONAL_HANDLING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOLD_FOR_PICKUP, SATURDAY_DELIVERY, and ADDITIONAL_HANDLING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The special handling type.","example":"ADDITIONAL_HANDLING","enum":["HOLD_FOR_PICKUP","SATURDAY_DELIVERY","PREMIUM_CARE","DIRECT_DELIVERY_ONLY","ADDITIONAL_HANDLING"]}}},"insurance":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the insurance coverage, which is selected by users while create shipment - rate shopping. User can select below-mentioned special service for insurance:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declared Value Surcharge: INSURANCE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS, FedEx, Purolator, and CPC support special service "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSURANCE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either the specialserviceId or the specialservice objects such as deliveryConfirmation, handling, insurance and returnOptions, but not both."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The insurance type.","example":"INSURANCE","enum":["INSURANCE"]},"amount":{"type":"number","description":"The insurance amount in the currency specified for the shipment.","example":200}}},"references":{"$ref":"#/components/schemas/referenceV2"},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","description":"The data that provides information about other inter-related/ required data.","properties":{"name":{"type":"string","description":"Name of the Cost Account which are linked to Shipment.","example":"costAccountName"},"value":{"type":"string","description":"Indicates the value for the CostAccount.","example":"cost1"}},"example":[{"name":"costAccountName","value":"costAccountName"},{"name":"costAccountId","value":"costAccountId"},{"name":"costAccountCode","value":"Code"},{"name":"accountCode","value":"code"},{"name":"companyCode","value":"code"}]}},"labelSize":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the label size of the Shipment, that is, the Shipping Label is available in different Doc Size. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]}]}]}],"enum":["DOC_8X11","DOC_4X8","DOC_4X6"],"example":"DOC_4X6"},"labelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the Shipment. QR_CODE supported for carrier USPS only as of now. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]}]}]}],"enum":["SHIPPING_LABEL","QR_CODE"],"example":"SHIPPING_LABEL"},"labelFormat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Defines the file/format in which the label is printed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For ZPL2, DOC_4X6 will be supported, while for PDF, both the sizes are supported. QR_CODE can be generated only in GIF format. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"enum":["PDF","ZPL2","PNG","GIF"],"example":"ZPL2"},"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the label content is encoded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" BASE64 is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZPL2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PNG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"BASE64","enum":["URL","BASE64"]},"printerAliasName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to a printer connected (directly or via network) to a computer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 60"},"children":[]}]}]}],"example":"test"},"dateOfShipment":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when shipment is created/shipped. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: For FedEx US shipments, when a shipment date is provided in the request, the specified value is used for shipment processing. If no shipment date is provided, Carrier processes it as per their system."},"children":[]}]}]}],"example":"2024-03-20"},"deliveryOption":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two options of delivery: deliverBy and useBestNextDate, where customer can schedule the delivery date in deliverBy. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In case if the customer's scheduled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date falls under Holiday, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useBestNextDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used by our system. Then, we will mark the second option and deliver the same."},"children":[]}]}]}],"properties":{"deliverBy":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery date is the data when shipment is to be delivered, which is scheduled by sender. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field will be mandatory to provide, if the customer chooses ruleType is deliverBy."},"children":[]}]}]}],"example":"2024-03-20"},"useBestNextDate":{"type":"boolean","description":"When this is set to true, if the scheduled delivery date falls on a Holiday, then the next business day will be considered to deliver the shipment.","example":false}}},"returnOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object defines return shipment options. It should be passed when requesting return labels. Supported only for carriers UPS and FedEx as of now."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For UPS, this object is required. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For FedEx, this object is optional. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"returnOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object must be sent with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isReturn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either the specialserviceId or the specialservice objects such as deliveryConfirmation, handling, insurance and returnOptions, but not both."},"children":[]}]}]}]}],"required":["type","inputParameters"],"properties":{"type":{"type":"string","example":"RETURN_BY_PRL","description":"Specifies the return type. This is the value of special service code for the carrier-supported return service."},"inputParameters":{"type":"array","description":"List of input parameters required for return processing.","items":{"type":"object","properties":{"name":{"type":"string","example":"RMA_NUMBER","description":"The name of the parameter."},"value":{"type":"string","example":"123","description":"The corresponding value for the parameter."}}}}}},"customs":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customs information required for international shipments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only for RMG carrier in domestic shipment requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must include customsItems and customsInfo objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other carriers do not require this object for domestic shipments."},"children":[]}]}]}]}],"required":["customsInfo","customsItems"],"properties":{"customsInfo":{"type":"object","description":"This is additional customs information required along with item details.","required":["reasonForExport","customsDeclaredValue","currencyCode"],"properties":{"reasonForExport":{"type":"string","description":"Reason for exporting the items.","example":"DOCUMENTS","enum":["GIFT","COMMERCIAL_SAMPLE","MERCHANDISE","DOCUMENTS","RETURNED_GOODS","OTHER"]},"comments":{"type":"string","description":"Free-form comments regarding the exported shipment.","example":"Test comment"},"invoiceNumber":{"type":"string","description":"The commercial invoice number assigned by the exporter.","example":"001189223"},"importerCustomsReference":{"type":"string","description":"A reference number used by the importer, such as a VAT number, PO number, or insured number.","example":"987654"},"sdrValue":{"type":"number","format":"float","description":"When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values.","example":23.32},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"currencyCode":{"type":"string","description":"The currency used for declared value. Use three uppercase letters, per ISO 4217.","example":"USD"},"fromCustomsReference":{"type":"string","description":"Free-form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.","example":"EFEFE4554545"},"licenseNumber":{"type":"string","description":"The export license number associated with the commodity.","example":"456ABC123"},"certificateNumber":{"type":"string","description":"The certificate number associated with the commodity.","example":"987"},"customsDeclaredValue":{"type":"number","description":"Item value in mentioned currencyCode.","example":6000},"termsOfSale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the delivery and payment terms between the shipper and recipient. Currenty supported by carriers - UPS, FedEx and DHL. - Common values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CIP: Carriage and Insurance Paid to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPT: Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAP: Delivered at Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAT: Delivered at Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DDP: Delivered Duty Paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXW: Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FCA: Free Carrier"},"children":[]}]}]}]}],"example":"DDP","enum":["CIP","CPT","DAP","DAT","DDP","EXW","FCA"]}}},"customsItems":{"type":"array","description":"Items included in the customs declaration.","required":["description","quantity","unitPrice","weight","weightUnit"],"items":{"type":"object","properties":{"description":{"type":"string","description":"A detailed description of the commodity, up to 255 characters. The description will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Each description will appear on the form.","example":"Books"},"itemId":{"type":"string","description":"Unique identifier for the commodity.","example":"item1"},"orderNumber":{"type":"string","description":"The unique identifier for the order.","example":"ORD1"},"quantity":{"type":"number","description":"Enter the total number of items of this type of commodity.","example":1},"unitPrice":{"type":"number","format":"float","description":"The price of one item of this type of commodity.","example":3000},"weightUnit":{"type":"string","description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"Weight of the item.","example":0.1},"hSTariffCode":{"type":"string","description":"The destination country's tariff-classification number (HS code) for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and then add digits for more detail. The maximum length for an HS code is 14 characters. The HS code will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. HS Code is required for RMG b2b shipment.","example":"AST559"},"originCountryCode":{"type":"string","description":"The two-character ISO country code of the shipment's origin country. Use ISO 3166-1 Alpha-2 standard values.","example":"US"}}}},"customsDocuments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to attach Electronic Trade Documents (ETDs) to your DHL international shipment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item should represent a document uploaded previously using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For DHL, if you pass this field, ensure the selected service type is PAPERLESS."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"s3FileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be taken from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic trade document must upload before shipment label creation."},"children":[]}]}]}]}],"items":{"type":"object","required":["fileName","s3FileId","documentType"],"properties":{"fileName":{"type":"string","description":"The name of the uploaded trade document file.","example":"invoice.pdf"},"s3FileId":{"type":"string","description":"The relative file path where the document is stored in the S3 bucket.","example":"uploads/shipping/intl_docs/sa58a03/0oa2bxnhu03i48mh50h8/NJ3ww7gv73kwDJK/DRNgGjEraOvV8ZB_invoice.pdf"},"documentType":{"type":"string","enum":["INVOICE","COMMERCIAL_INVOICE","PROFORMA_INVOICE","CERTIFICATE_OF_ORIGIN","NAFTA_CERTIFICATE_OF_ORIGIN","CUSTOMS_DECLARATION_FORM","AIR_WAYBILL_AND_WAYBILL"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the uploaded document. This value is referenced when generating customs declarations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must match the type used during document upload."},"children":[]}]}]}],"example":"INVOICE"}}}}}}},"example":{"fromAddress":{"addressLine1":"24182 Kathy Ave","cityTown":"Lake Forest","countryCode":"US","name":"Paul Wright","phone":"203-555-1213","postalCode":"92630-1827","stateProvince":"CA"},"toAddress":{"addressLine1":"55 Pharr Rd NW, Apt E104","cityTown":"Atlanta","countryCode":"US","name":"Paul Wright","phone":"203-555-1213","postalCode":"30305-2151","stateProvince":"GA"},"altReturnAddress":{"addressLine1":"27 Waterview Dr","cityTown":"Shelton","countryCode":"US","name":"Paul Wright","phone":"203-555-1213","postalCode":"06484","stateProvince":"CT"},"parcel":{"length":2,"width":1,"height":1,"dimUnit":"IN","weightUnit":"OZ","weight":2,"packageValue":2},"rateShopBy":"shipViaCode","byShipViaCode":{"code":"FEDEX-custom-code1"},"shipmentOptions":{"minimalAddressValidation":true,"bypassAddressValidation":"toAddress","bookingConfirmationNumber":"XXXX56789812"},"references":{"reference1":"custome message","reference2":"SendTech","reference3":"98437","reference4":"Overnight Shipping","poNumber":"R2W 2H2","department":"Name department","additionalReference1":"612987641","additionalReference2":"989","shippingNotes":"Handle with care.","ShipperReference":"REF123456789","transportationReference":"TRANSREF987654321"},"carrierPayments":[{"typeOfCharge":"TRANSPORTATION_CHARGES","party":"BILL_THIRD_PARTY","accountNumber":"602684342","postalCode":"14609","countryCode":"US"}],"docTab":{"templateName":"1","toAddressName":{"displayName":"TO","value":"Test1","row":1,"column":1},"parcelTrackingNumber":{"displayName":"TO","value":"Test1","row":1,"column":1},"carrier":{"displayName":"TO","value":"Test1","row":1,"column":1},"serviceId":{"displayName":"TO","value":"Test1","row":1,"column":1},"dateOfShipment":{"displayName":"TO","value":"Test1","row":1,"column":1},"pieceNumber":{"displayName":"TO","value":"Test1","row":1,"column":1},"packageTotalCarrierCharge":{"displayName":"TO","value":"Test1","row":1,"column":1},"totalCarrierCharge":{"displayName":"TO","value":"Test1","row":1,"column":1},"packageWeight":{"displayName":"TO","value":"Test1","row":1,"column":1},"totalWeight":{"displayName":"TO","value":"Test1","row":1,"column":1},"customField1":{"displayName":"TO","value":"Test1","row":1,"column":1},"customField2":{"displayName":"TO","value":"Test1","row":1,"column":1},"customField3":{"displayName":"TO","value":"Test1","row":1,"column":1},"customField4":{"displayName":"TO","value":"Test1","row":1,"column":1}},"metadata":[{"name":"costAccountName","value":"costAccountName"},{"name":"costAccountId","value":"costAccountId"},{"name":"costAccountCode","value":"Code"},{"name":"accountCode","value":"code"},{"name":"companyCode","value":"code"}],"deliveryConfirmation":{"type":"ADULT_SIGNATURE","value":"amit"},"handling":{"type":"ADDITIONAL_HANDLING","value":"HOLD"},"insurance":{"type":"INSURANCE","amount":200},"labelSize":"DOC_4X6_75","labelType":"SHIPPING_LABEL","labelFormat":"ZPL2","printerAliasName":"test","dateOfShipment":"{{todayDate}}","deliveryOption":{"deliverBy":"{{tomorrowDate}}","useBestNextDate":false}}}},"components/schemas/shipmentDomesticByExternalSystemCode":{"id":"components/schemas/shipmentDomesticByExternalSystemCode","kind":"json-schema","title":"By ExternalCode","data":{"title":"By ExternalCode","type":"object","required":["toAddress","rateShopBy","labelSize","labelType","labelFormat"],"properties":{"fromAddress":{"$ref":"#/components/schemas/fromAddressV2"},"toAddress":{"$ref":"#/components/schemas/toAddressV2"},"parcel":{"$ref":"#/components/schemas/parcelV2"},"rateShopBy":{"type":"string","description":"Specifies that shipment creation uses a predefined configuration from an external system. When externalSystemCode is selected, the system retrieves carrier, account, service, and parcel details based on the external system codes provided in the request. ","example":"externalSystemCode","enum":["carrier","rateGroup","ruleSet","shipViaCode","externalSystemCode"]},"byExternalSystemCode":{"$ref":"#/components/schemas/byExternalSystemCodeV2"},"specialServices":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It provides a carrier based special or extra service, which also varies as per selected service and parcel type. User can override this value by defining it at shipment level."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either the specialserviceId or the specialservice objects such as deliveryConfirmation, handling, insurance and returnOptions, but not both."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/SpecialService"}},"shipmentOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment Options have an added feature that is Manifest."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" With Manifest, the Mail Center agent can print the Manifest (End of day records of all created shipment) of selected carrier."},"children":[]}]}]}],"properties":{"addToManifest":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option asks if the shipment is to be added for Manifest, so that the shipment will reflect in the Manifest Form while compilation. Supported for CPC and USPS carriers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value can be 'true' or 'false'."},"children":[]}]}]}],"example":true}}},"references":{"$ref":"#/components/schemas/referenceV2"},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","description":"The data that provides information about other inter-related/ required data.","properties":{"name":{"type":"string","description":"Name of the Cost Account which are linked to Shipment.","example":"costAccountName"},"value":{"type":"string","description":"Indicates the value for the CostAccount.","example":"cost1"}}},"example":[{"name":"costAccountName","value":"costAccountName"},{"name":"costAccountId","value":"costAccountId"},{"name":"costAccountCode","value":"Code"},{"name":"accountCode","value":"code"},{"name":"companyCode","value":"code"}]},"labelSize":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the label size of the Shipment, that is, the Shipping Label is available in different Doc Size. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]}]}]}],"enum":["DOC_8X11","DOC_4X8","DOC_4X6"],"example":"DOC_4X6"},"labelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the Shipment. QR_CODE supported for carrier USPS only as of now. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]}]}]}],"enum":["SHIPPING_LABEL","QR_CODE"],"example":"SHIPPING_LABEL"},"labelFormat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Defines the file/format in which the label is printed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For ZPL2, DOC_4X6 will be supported, while for PDF, both the sizes are supported. QR_CODE can be generated only in GIF format. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"enum":["PDF","ZPL2","PNG","GIF"],"example":"ZPL2"},"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the label content is encoded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" BASE64 is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZPL2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PNG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"BASE64","enum":["URL","BASE64"]},"dateOfShipment":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when shipment is created/shipped. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: For FedEx US shipments, when a shipment date is provided in the request, the specified value is used for shipment processing. If no shipment date is provided, Carrier processes it as per their system."},"children":[]}]}]}],"example":"2025-11-20"},"deliveryOption":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two options of delivery: deliverBy and useBestNextDate, where customer can schedule the delivery date in deliverBy. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In case if the customer's scheduled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date falls under Holiday, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useBestNextDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used by our system. Then, we will mark the second option and deliver the same."},"children":[]}]}]}],"properties":{"deliverBy":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery date is the data when shipment is to be delivered, which is scheduled by sender. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field will be mandatory to provide, if the customer chooses ruleType is deliverBy."},"children":[]}]}]}],"example":"2024-03-20"},"useBestNextDate":{"type":"boolean","description":"When this is set to true, if the scheduled delivery date falls on a Holiday, then the next business day will be considered to deliver the shipment.","example":false}}}}}},"components/schemas/CarrierFacilityRequest":{"id":"components/schemas/CarrierFacilityRequest","kind":"json-schema","title":"CarrierFacilityRequest","data":{"type":"object","description":"Request payload to locate carrier facilities near a given address.\n","properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"carrier":{"type":"string","description":"The carrier for which to locate facilities. This operation currently supports searching for USPS facilities.\n","example":"USPS"},"carrierFacilityOptions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the types of facilities returned. Each object in the array is a name-value pair that specifies a carrier facility option. Each object contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field (the option) and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field (the option value). Both fields take strings."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CarrierFacilityOptions"},"example":[{"name":"FACILITY_TYPE","value":"POST_OFFICE"},{"name":"FACILITY_TYPE_SERVICE","value":"LABEL_BROKER_RETAIL"},{"name":"FACILITY_WITHIN_RADIUS","value":"10"},{"name":"NUMBER_OF_FACILITIES","value":"1"}]}},"required":["address","carrier"]}},"components/schemas/FacilityAddress":{"id":"components/schemas/FacilityAddress","kind":"json-schema","title":"FacilityAddress","data":{"type":"object","required":["postalCode","countryCode"],"description":"Address details used as the reference point for the facility search or returned\nas part of a carrier facility suggestion.\n","properties":{"addressLine1":{"type":"string","description":"The primary street address line.","example":"24182 Kathy Ave"},"addressLine2":{"type":"string","description":"Additional address information such as building, floor, or nearby landmark.","example":"near abc street"},"addressLine3":{"type":"string","description":"Optional third line for additional address details.","example":"near xyz street"},"company":{"type":"string","description":"Company or organization name at the address.","example":"Pitney Bowes Inc."},"email":{"type":"string","description":"Email address associated with the contact at this address.","example":"testuser@gmail.com"},"phone":{"type":"string","description":"Phone number associated with the contact at this address.","example":"6502530000"},"cityTown":{"type":"string","description":"City or town name.","example":"Lake Forest"},"stateProvince":{"type":"string","description":"State or province code.","example":"CA"},"postalCode":{"type":"string","description":"Postal or ZIP code.","example":"92630"},"countryCode":{"type":"string","description":"The two-letter ISO country code.","example":"US"}}}},"components/schemas/CarrierFacilityOptions":{"id":"components/schemas/CarrierFacilityOptions","kind":"json-schema","title":"CarrierFacilityOptions","data":{"type":"object","description":"","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The option name that controls a specific aspect of the facility search."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Facility Options"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FACILITY_TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of facility to return. By default, the API returns type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST_OFFICE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST_OFFICE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FACILITY_TYPE_SERVICE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A service the facility must offer. The API returns only facilities that provide this service."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LABEL_BROKER_RETAIL, LABEL_BROKER_SELF_SERVICE_KIOSK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FACILITY_WITHIN_RADIUS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Distance from the buyer in miles."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default: 5, Max: 25"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NUMBER_OF_FACILITIES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of facilities to return. To return only the closest one, set this to 1."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default: 5, Max: 50"},"children":[]}]}]}]}]}]}]},"value":{"type":"string","description":"The value for the given option name."}}}},"components/schemas/Customs":{"id":"components/schemas/Customs","kind":"json-schema","title":"Customs","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customs information required for international shipments and optional for domestic shipments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only for RMG carrier in domestic shipment requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must include customsItems and customsInfo objects."},"children":[]}]}]}]}],"required":["customsInfo","customsItems"],"properties":{"customsInfo":{"type":"object","description":"This is additional customs information required along with item details.","required":["reasonForExport","customsDeclaredValue","currencyCode"],"properties":{"reasonForExport":{"type":"string","description":"Reason for exporting the items.","example":"DOCUMENTS","enum":["GIFT","COMMERCIAL_SAMPLE","MERCHANDISE","DOCUMENTS","RETURNED_GOODS","OTHER"]},"comments":{"type":"string","description":"Free-form comments regarding the exported shipment.","example":"Test comment"},"invoiceNumber":{"type":"string","description":"The commercial invoice number assigned by the exporter.","example":"001189223"},"importerCustomsReference":{"type":"string","description":"A reference number used by the importer, such as a VAT number, PO number, or insured number.","example":"987654"},"sdrValue":{"type":"number","format":"float","description":"When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values.","example":23.32},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"currencyCode":{"type":"string","description":"The currency used for declared value. Use three uppercase letters, per ISO 4217.","example":"USD"},"fromCustomsReference":{"type":"string","description":"Free-form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.","example":"EFEFE4554545"},"licenseNumber":{"type":"string","description":"The export license number associated with the commodity.","example":"456ABC123"},"certificateNumber":{"type":"string","description":"The certificate number associated with the commodity.","example":"987"},"customsDeclaredValue":{"type":"number","description":"Item value in mentioned currencyCode.","example":6000},"termsOfSale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the delivery and payment terms between the shipper and recipient. Currenty supported by carriers - UPS, FedEx and DHL. - Common values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CIP: Carriage and Insurance Paid to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPT: Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAP: Delivered at Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAT: Delivered at Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DDP: Delivered Duty Paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXW: Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FCA: Free Carrier"},"children":[]}]}]}]}],"example":"DDP","enum":["CIP","CPT","DAP","DAT","DDP","EXW","FCA"]}}},"customsItems":{"type":"array","description":"Items included in the customs declaration.","required":["description","quantity","unitPrice","weight","weightUnit"],"items":{"type":"object","properties":{"description":{"type":"string","description":"A detailed description of the commodity, up to 255 characters. The description will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Each description will appear on the form.","example":"Books"},"itemId":{"type":"string","description":"Unique identifier for the commodity.","example":"item1"},"orderNumber":{"type":"string","description":"The unique identifier for the order.","example":"ORD1"},"quantity":{"type":"number","description":"Enter the total number of items of this type of commodity.","example":1},"unitPrice":{"type":"number","format":"float","description":"The price of one item of this type of commodity.","example":3000},"weightUnit":{"type":"string","description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"Weight of the item.","example":0.1},"hSTariffCode":{"type":"string","description":"The destination country's tariff-classification number (HS code) for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and then add digits for more detail. The maximum length for an HS code is 14 characters. The HS code will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. HS Code is required for RMG b2b shipment.","example":"AST559"},"originCountryCode":{"type":"string","description":"The two-character ISO country code of the shipment's origin country. Use ISO 3166-1 Alpha-2 standard values.","example":"US"}}}},"customsDocuments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to attach Electronic Trade Documents (ETDs) to your DHL international shipment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item should represent a document uploaded previously using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For DHL, if you pass this field, ensure the selected service type is PAPERLESS."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"s3FileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be taken from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic trade document must upload before shipment label creation."},"children":[]}]}]}]}],"items":{"type":"object","required":["fileName","s3FileId","documentType"],"properties":{"fileName":{"type":"string","description":"The name of the uploaded trade document file.","example":"invoice.pdf"},"s3FileId":{"type":"string","description":"The relative file path where the document is stored in the S3 bucket.","example":"uploads/shipping/intl_docs/sa58a03/0oa2bxnhu03i48mh50h8/NJ3ww7gv73kwDJK/DRNgGjEraOvV8ZB_invoice.pdf"},"documentType":{"type":"string","enum":["INVOICE","COMMERCIAL_INVOICE","PROFORMA_INVOICE","CERTIFICATE_OF_ORIGIN","NAFTA_CERTIFICATE_OF_ORIGIN","CUSTOMS_DECLARATION_FORM","AIR_WAYBILL_AND_WAYBILL"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the uploaded document. This value is referenced when generating customs declarations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must match the type used during document upload."},"children":[]}]}]}],"example":"INVOICE"}}}}}}},"components/schemas/CarrierFacilityResponse":{"id":"components/schemas/CarrierFacilityResponse","kind":"json-schema","title":"CarrierFacilityResponse","data":{"type":"object","description":"Response payload containing the original request context and suggested facilities\nthat match the search criteria.\n","properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"carrier":{"type":"string","description":"The carrier used for the facility lookup.","example":"USPS"},"carrierFacilityOptions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the types of facilities returned. Each object in the array is a name-value pair that specifies a carrier facility option. Each object contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field (the option) and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field (the option value). Both fields take strings."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CarrierFacilityOptions"}},"carrierFacilitySuggestions":{"type":"array","description":"List of facilities that match the search criteria\n","items":{"$ref":"#/components/schemas/CarrierFacilitySuggestion"}}}}},"components/schemas/CarrierFacilitySuggestion":{"id":"components/schemas/CarrierFacilitySuggestion","kind":"json-schema","title":"CarrierFacilitySuggestion","data":{"type":"object","description":"A suggested carrier facility that matches the search criteria.\n","properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"carrierFacilityAttributes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of facility attributes that describe the services available at this location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This array is populated only when:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You did not specify a FACILITY_TYPE_SERVICE value in the request, and"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A FACILITY_TYPE_SERVICE value applies for the facility."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each object in the array is a name–value pair describing a facility service."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are strings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: If you specified a FACILITY_TYPE_SERVICE value in the request,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this array does not populate in the response."},"children":[]}]}]}],"readOnly":true,"items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the facility attribute or service.\n","example":"FACILITY_TYPE_SERVICE"},"value":{"type":"string","description":"Value for the facility attribute or service.\n","example":"LABEL_BROKER_RETAIL"}}}},"facilityHours":{"type":"array","description":"Days and hours of operation for the facility. Each object in the array defines\nthe hours for a specific day of the week.\n","items":{"$ref":"#/components/schemas/FacilityHours"}},"facilityParking":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of parking available at the facility."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NONE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STREET"},"children":[]}]}]}]}],"example":"LOT"}}}},"components/schemas/FacilityHours":{"id":"components/schemas/FacilityHours","kind":"json-schema","title":"FacilityHours","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opening hours for a facility on a particular day of the week. Returned in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierFacilitySuggestions.facilityHours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}],"properties":{"day":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the week for the facility's operating hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUNDAY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONDAY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TUESDAY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WEDNESDAY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"THURSDAY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FRIDAY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SATURDAY"},"children":[]}]}]}]}],"example":"MONDAY"},"facilityTimings":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A specific opening and closing time range for a facility on a given day.Returned as part of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"facilityTimings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}],"items":{"type":"object"},"properties":{"opensAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time the facility opens, using a 24-hour clock. The time is local to the facility."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM:SS"},"children":[]}]}]}],"example":"09:00:00"},"closesAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time the facility closes, using a 24-hour clock. The time is local to the facility."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM:SS"},"children":[]}]}]}],"example":"17:00:00"}}}}}},"components/schemas/fromAddressV2":{"id":"components/schemas/fromAddressV2","kind":"json-schema","title":"fromAddressV2","data":{"type":"object","required":["name","addressLine1","cityTown","stateProvince","postalCode","countryCode","phone"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The complete address of the Sender. Read: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/defaults/createdefaults"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to create Defaults"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected using the following order of precedence:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Body → Default ID → Location ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request payload is used if available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not available in request payload, The Default ID ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defined in Default API) is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If provided neither in the request nor in the default, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the resolved location is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be resolved from any source, the request fails with a validation error."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}]}],"properties":{"name":{"type":"string","description":"The name of the Sender to which this address points.","example":"Sender Name"},"addressLine1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1600 Amphitheatre Parkway"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":"The name of the company, in case if the senders address is not residential.","example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be senders's valid email. Email is required if the customer is using GoFor Carrier. Sender email is required for RMG b2b shipment. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 50"},"children":[]}]}]}],"example":"testuser@gmail.com"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits. ","example":"6502530000"},"cityTown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the city or town the Sender's address belongs to. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Mountain View"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The name of the State or Province the Sender belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US or Canadian address(es)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please switch to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" radio button, enter the required country name or country code, and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#iso:code:3166:CA","description":"List of Province with their Province/State Codes."},"example":"CA"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code or ZIP Code of the address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For CA addresses, use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"six-character"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alphanumeric string Postal Code in this format: 'A1A 1A1'. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" While for US addresses, use either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code in one of the following formats: '12345' or '12345-6789'. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]}]}]}],"example":"94043"},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.\n","example":"06905"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The country in which the sender's address is located. The value will be the two-character ISO Code of the country from the ISO country list. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink, please select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#search","description":"List of Countries with their ISO Codes"},"example":"US"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}}},"components/schemas/fromAddressDefault":{"id":"components/schemas/fromAddressDefault","kind":"json-schema","title":"fromAddressDefault","data":{"type":"object","required":["name","addressLine1","cityTown","stateProvince","postalCode","countryCode","phone"],"description":"The complete address of the Sender.\n","properties":{"name":{"type":"string","description":"The name of the Sender to which this address points.","example":"Sender Name"},"addressLine1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1600 Amphitheatre Parkway"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":"The name of the company, in case if the senders address is not residential.","example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be senders's valid email. Email is required if the customer is using GoFor Carrier. Sender email is required for RMG b2b shipment. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 50"},"children":[]}]}]}],"example":"testuser@gmail.com"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits. ","example":"6502530000"},"cityTown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the city or town the Sender's address belongs to. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Mountain View"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The name of the State or Province the Sender belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US or Canadian address(es)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please switch to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" radio button, enter the required country name or country code, and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#iso:code:3166:CA","description":"List of Province with their Province/State Codes."},"example":"CA"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code or ZIP Code of the address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For CA addresses, use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"six-character"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alphanumeric string Postal Code in this format: 'A1A 1A1'. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" While for US addresses, use either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code in one of the following formats: '12345' or '12345-6789'. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]}]}]}],"example":"94043"},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.\n","example":"06905"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The country in which the sender's address is located. The value will be the two-character ISO Code of the country from the ISO country list. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink, please select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#search","description":"List of Countries with their ISO Codes"},"example":"US"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}}},"components/schemas/toAddressV2":{"id":"components/schemas/toAddressV2","kind":"json-schema","title":"toAddressV2","data":{"type":"object","required":["name","addressLine1","cityTown","stateProvince","postalCode","countryCode","phone"],"description":"The complete address of the Recipient or Department (in case if the address is not pointed to any individual recipient).","properties":{"name":{"type":"string","description":"The name of the Recipient.","example":"Recipient Name"},"addressLine1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Recipient. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"350 Fifth Avenue"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the city or town the Recipient belongs to. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"New York"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The name of the State or Province the Sender belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US or Canadian address(es)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please switch to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" radio button, enter the required country name or country code, and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button . "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#iso:code:3166:CA","description":"List of Province with their Province/State Codes."},"example":"NY"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The Postal Code or ZIP Code of the address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For CA addresses, use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"six-character"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alphanumeric string Postal Code in this format: 'A1A 1A1'."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" While for US addresses, use either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code in one of the following formats: '12345' or '12345-6789'."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"example":"10118"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The country in which the recipient's address is located. The value will be the two-character ISO Code of the country from the ISO country list. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink, please select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#search","description":"List of Countries with their ISO Codes"},"example":"US"},"company":{"type":"string","description":"The name of the company, in case if the recipient address is not residential. Recipient company is required for RMG b2b shipment.","example":"PB"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is Recipient's phone number. Enter the digits with or without spaces or hyphens. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2127363100"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be recipient's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 50"},"children":[]}]}]}],"example":"recipient@gmail.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"isPOBox":{"type":"boolean","description":"Checks if the specified address has the PO Box. In case if Yes, the boolean value will be 'true', else it will take 'false'.","example":true}}}},"components/schemas/soldToAddressV2":{"id":"components/schemas/soldToAddressV2","kind":"json-schema","title":"soldToAddressV2","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing address of the buyer responsible for the shipment payment. It can be domestic or international address."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the importer is the same as the final recipient, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must match."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the importer is different from the final recipient, enter the importer address in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and enter the final recipient's address in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"addressLine1":{"type":"string","example":"1600 Amphitheatre Parkway","description":"Primary street address of the billing entity."},"addressLine2":{"type":"string","example":"Suite 101","description":"Additional address information such as apartment, suite, or unit number."},"addressLine3":{"type":"string","example":"Near central market","description":"Optional extra address details."},"company":{"type":"string","example":"ABC Company","description":"The name of the company associated with the SoldTo address."},"name":{"type":"string","example":"John Doe","description":"The contact person's full name for the billing entity."},"phone":{"type":"string","example":"650-253-0000","description":"Phone number of the SoldTo entity."},"email":{"type":"string","example":"billing@abccompany.com","description":"Email address of the SoldTo entity."},"residential":{"type":"boolean","example":false,"description":"Indicates whether the SoldTo address is a residential location (true/false)."},"cityTown":{"type":"string","example":"Mountain View","description":"City or town of the billing address."},"stateProvince":{"type":"string","example":"CA","description":"State or province of the billing address."},"postalCode":{"type":"string","example":"94043","description":"Postal or ZIP code of the billing address."},"countryCode":{"type":"string","example":"US","description":"Two-letter country code of the billing address (ISO 3166-1 alpha-2)."},"taxId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tax Identification Number (TIN). TIN Number is supported for FedEx as of now."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max character length = 18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOSS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EORI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_UNION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 12 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 13 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"taxIdType":{"type":"string","description":"Specifies the type of tax identification being provided.","enum":["EIN","GST","VAT","IOSS","RFC","EORI"]}}}},"components/schemas/altReturnAddress":{"id":"components/schemas/altReturnAddress","kind":"json-schema","title":"altReturnAddress","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by FedEx, UPS, and Purolator."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"altReturnAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected using the following order of precedence:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Body → Location ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"altReturnAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request payload is used if available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided in the request, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"altReturnAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the resolved location is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"altReturnAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not available from any source, it is treated as optional and is not included in the request. In this case, package will be returened to the Shipper address."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"altReturnAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not supported in Default ID."},"children":[]}]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"500 Terry Francois Blvd"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"San Francisco"},"countryCode":{"type":"string","description":"The two-letter ISO country code for the alternate return address.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"415-555-7890"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"94158"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CA"}}}},"components/schemas/altReturnAddressDefault":{"id":"components/schemas/altReturnAddressDefault","kind":"json-schema","title":"altReturnAddressDefault","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by FedEx, UPS, and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"500 Terry Francois Blvd"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"San Francisco"},"countryCode":{"type":"string","description":"The two-letter ISO country code for the alternate return address.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"415-555-7890"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"94158"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CA"}}}},"components/schemas/parcelV2":{"id":"components/schemas/parcelV2","kind":"json-schema","title":"parcelV2","data":{"type":"object","required":["weightUnit"],"description":"The details of the Parcel.","properties":{"length":{"type":"number","format":"float","description":"Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"number","format":"float","description":"There is no strict rule as to which element is the width or the height, but the width is the second greatest dimension of a parcel by convention.","example":1},"height":{"type":"number","format":"float","description":"By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The valid values are: Inch and Centimeter."},"children":[]}]}]}],"example":"IN","enum":["IN","CM"]},"weightUnit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WeightUnit is a standard for measuring the physical quantities of specified weight."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The valid values are: Ounces and Grams."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For USPS shipments, set this to OZ."},"children":[]}]}]}],"example":"OZ","enum":["OZ","GM"]},"weight":{"type":"number","format":"float","description":"Weight measures the heaviness of an object (how heavy an object is) .","example":2},"packageValue":{"type":"number","format":"float","description":"Indicates value of the package.","example":2}}}},"components/schemas/byCarrierV2":{"id":"components/schemas/byCarrierV2","kind":"json-schema","title":"byCarrierV2","data":{"type":"object","required":["service"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Groups a shipment by carrier and service to determine rating, label generation, and routing behavior."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of the following fields must be provided in the byCarrier object:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both fields are provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes precedence and any carrier-level properties are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If neither field is provided, the request fails validation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, it must be associated with the resolved location (the provided X-PB-LocationId, or the enterprise default location if location is omitted). Otherwise, the request fails."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, it must be associated with the resolved location (the provided X-PB-LocationId, or the enterprise default location if location is omitted). Otherwise, the request fails."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location and Carrier Resolution"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier accounts used for shipment processing are resolved based on the location identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request header. If the header is not provided, the enterprise default location created during developer onboarding is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location Used"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carriers Configured at Location/Division/Enterprise"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier Accounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provided Location ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One account"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The available account is selected and the shipment is created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provided Location ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple accounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The oldest onboarded account is selected and the shipment is created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provided Location ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple carriers"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request fails validation. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be specified."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provided Location ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One carrier at each level"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple accounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The oldest onboarded account across all levels is selected, and the shipment is created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise Default Location"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One account"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The available account is selected and the shipment is created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise Default Location"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple accounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The oldest onboarded account is selected and the shipment is created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise Default Location"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple carriers"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request fails validation. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be specified."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise Default Location"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One carrier at each level"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple accounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The oldest onboarded account across all levels is selected, and the shipment is created."},"children":[]}]}]}]}]}]}],"properties":{"carrierAccountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a unique identifier associated with the specific sub-carrier account, which must be valid."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This is used in the shipment creation (if this value is defined, Carrier properties will be skipped)."},"children":[]}]}]}],"example":"zmOKKBAn0X1"},"carrier":{"type":"string","description":"A unique identifier associated with the specific carrier, i.e. CarrierID, which must be valid.","example":"FedEx"},"service":{"type":"string","description":"Indicates a unique identifier associated with the carrier specific service, which is ServiceID, which must be valid.","example":"NDA"}}}},"components/schemas/byShipViaCodeV2":{"id":"components/schemas/byShipViaCodeV2","kind":"json-schema","title":"byShipViaCodeV2","data":{"type":"object","required":["code"],"description":"The shipment is generated by using a predefined custom Carrier Code.","properties":{"code":{"type":"string","description":"Pre-generated code (Custom Carrier Code) that bundles carrier, carrier account, parcel type, service, and special services. When provided, it overrides the corresponding fields in the request payload, eliminating the need to pass them individually."}}}},"components/schemas/byExternalSystemCodeV2":{"id":"components/schemas/byExternalSystemCodeV2","kind":"json-schema","title":"byExternalSystemCodeV2","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines shipment creation parameters based on an external system reference."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided, the system automatically retrieves and applies carrier,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"service, and parcel details mapped to the specified external system code. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For now, External System Codes supported only for carriers UPS, USPS and FedEx."},"children":[]}]}]}],"properties":{"externalSystemCode":{"type":"string","description":"Unique identifier or code defined in an external system used to retrieve shipment configuration. For now, Only SendPro Enterprise (SPE) is supported as an external system.","example":"SPE"},"carrierCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier code associated with the external system configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx Web Services"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"49"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Consolidated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"87"},"children":[]}]}]}]}]}]}],"example":"87"},"serviceCode":{"type":"string","example":"746","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service code mapped under the specified external system."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedExServiceCode"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier Service"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx Priority Overnight®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"371"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx Standard Overnight®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"372"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx First Overnight®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"373"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx 2Day®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"374"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx Express Saver®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"375"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx Ground®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"383"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPSServiceCode"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier Service"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Express Mail International"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"92"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First-Class Mail®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"85"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First-Class Mail International"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"289"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Library Mail (Basic)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"299"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Media Mail (Basic)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"297"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority Mail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"86"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority Mail Cubic"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"413"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority Mail International"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"94"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPSServiceCode"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier Service"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Next Day Air® Early A.M.®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"742"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Next Day Air®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"743"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Next Day Air Saver®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"744"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS 2nd Day Air A.M.®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"745"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS 2nd Day Air®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"746"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS 3 Day Select®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"747"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS® Ground"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"748"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Express Early"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"750"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Express®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"753"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Express Saver®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"754"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Expedited®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"755"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Standard®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"756"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Worldwide Express Freight®"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"757"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS SurePost® Bound Printed Matter"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"759"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS SurePost® Media"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"760"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS SurePost® 1 lb or Greater"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"761"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS SurePost® Less than 1 lb"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"762"},"children":[]}]}]}]}]}]}]},"parcelTypeCode":{"example":"570","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel type code mapped under the specified external system."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedExPackageType"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Package Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Package"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"390"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPSPackageType"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Package Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Package"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"33"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Letter"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"55"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority Mail Flat Rate Box (12\" x 3.5\" x 14\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"57"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority Mail Flat Rate Box (11\" x 8.5\" x 5.5\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"58"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority Mail Small Flat Rate Box (6\" x 9\" x 2\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"444"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority Mail Large Flat-Rate Box (12\"x12\"x5.5\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"484"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority Mail Large Flat-Rate Box (24\"x12\"x3\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"485"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority Mail Flat Rate Padded Envelope"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"486"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority Mail Legal Flat Rate Envelope"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"490"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority Mail Regional Rate Box A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"491"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority Mail Regional Rate Box B"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"492"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Express Mail Legal Flat Rate Envelope"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"494"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Express Mail Padded Flat Rate Envelope"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"495"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flat Rate Envelope"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPSPackageType"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Package Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"570"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pak"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"572"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Box"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"573"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tube"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"574"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Letter"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"575"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS US Express Box Small"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"579"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS US Express Box Medium"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"580"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS US Express Box Large"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"581"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}}}},"components/schemas/carrierPayments":{"id":"components/schemas/carrierPayments","kind":"json-schema","title":"carrierPayments","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how carrier charges are billed to a third party. Use this field to specify"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account and charge type details for transportation and/or duties and taxes. This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field is optional and currently supported for FedEx, UPS, DHL Express and Purolator."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"party"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (who will pay for TRANSPORTATION_CHARGES or duties and taxes) is explicitly specified during shipment creation, the charges will automatically default to the sender (shipper). To direct charges to a different party, the appropriate bill-to details must be provided in the request."},"children":[]}]}]}]}],"items":{"anyOf":[{"title":"FedEx Carrier Payment","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx Billing Rules:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no bill-to party (who will pay for TRANSPORTATION_CHARGES or duties and taxes) is explicitly defined, FedEx will default billing to the sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If sender provides the receiver's account number, Duties and taxes will be charged directly from the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no account number is provided, FedEx will attempt to collect payment from the receiver at the time of import."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of DDU (Delivery Duty Unpaid) and no bill-to party provided:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pitney Bowes does not prompt for BILL_PARTY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx attempts to collect duties and taxes in the destination country via its billing team."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In cases where FedEx is unable to collect these charges, the sender (in the origin country) will be billed as a fallback."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient must be an authorized collect recipient"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal code and country code are not required for any party."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx Billing Scenarios:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal/Country Code"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECT/CONSIGNEE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER_CONTRACT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender & Receiver split"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper & 3rd Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]}]}]}],"properties":{"accountNumber":{"type":"string","description":"The FedEx account number of the party to be billed.","example":"602684342"},"countryCode":{"type":"string","description":"Two-letter ISO country code of the party to be billed.","example":"US"},"postalCode":{"type":"string","description":"Postal code of the party to be billed.","example":"30305"},"party":{"type":"string","enum":["BILL_RECEIVER","BILL_SENDER","BILL_THIRD_PARTY","BILL_RECEIVER_CONTRACT"],"description":"Billing party for the shipment charges.","example":"BILL_RECEIVER"},"typeOfCharge":{"type":"string","enum":["TRANSPORTATION_CHARGES","DUTIES_AND_TAXES","ALL_CHARGES"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of charge billed to the specified party. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES: Transportation-related charges only. When billing transportation charges to the sender (BILL_SENDER), the accountNumber must match the account used to initiate the shipment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES: Duties and taxes only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES: All Shipment Charges (Transportatio and Duties and Taxes)Required when using BILL_RECEIVER_CONTRACT (FedEx COLLECT); includes all charges"},"children":[]}]}]}]}],"example":"ALL_CHARGES"}}},{"title":"UPS Carrier Payment","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Billing Rules:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When only sender or only receiver is specified as the payer, the same account number must be used for both TRANSPORTATION_CHARGES and duties/taxes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no bill-to party (who will pay for TRANSPORTATION_CHARGES or duties and taxes) is explicitly defined, UPS will default billing to the sender/shipper."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of DDU (Delivery Duty Unpaid) and no bill-to party provided:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pitney Bowes does not prompt for BILL_PARTY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS attempts to collect duties and taxes in the destination country via its billing team or the ICOD (Import Collect on Delivery) process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In cases where UPS is unable to collect these charges, the sender (in the origin country) will be billed as a fallback."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Third Party can be assigned to pay TRANSPORTATION_CHARGES charges only. Duties and taxes cannot be billed to a third party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ALL_CHARGES billing type is not supported by UPS. Charges must be split explicitly between TRANSPORTATION_CHARGES and DUTIES_AND_TAXES."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Billing Scenarios:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal/Country Code"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECT/CONSIGNEE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender & Receiver split"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal: Required"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country: Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper & 3rd Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal + Country"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]}]}]}]}],"properties":{"accountNumber":{"type":"string","description":"The UPS account number of the party to be billed.","example":"1Z999AA10123456784"},"countryCode":{"type":"string","description":"Two-letter ISO country code of the party to be billed.","example":"US"},"postalCode":{"type":"string","description":"Postal code of the party to be billed.","example":"30305"},"party":{"type":"string","enum":["BILL_RECEIVER","BILL_SENDER","BILL_THIRD_PARTY"],"description":"Party to be billed.","example":"BILL_SENDER"},"typeOfCharge":{"type":"string","enum":["TRANSPORTATION_CHARGES","DUTIES_AND_TAXES"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of charge billed to the specified party. UPS requires split charges. ALL_CHARGES is not supported."},"children":[]}]}]}],"example":"TRANSPORTATION_CHARGES"}}},{"title":"DHL Express Carrier Payment","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express Billing Rules:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account number is required for all billing scenarios."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of DDU (Delivery Duty Unpaid) and no bill-to party provided:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pitney Bowes does not prompt for BILL_PARTY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL attempts to collect duties and taxes in the destination country via its billing team."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If DHL is unable to collect these charges from the receiver, the sender will be billed, and DHL may request instructions to deliver, return, or abandon the shipment."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid freight payer account required (Impex or origin match)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express Billing Scenarios:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal/Country Code"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECT/CONSIGNEE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER_CONTRACT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender & Receiver split"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper & 3rd Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]}]}]}],"properties":{"accountNumber":{"type":"string","description":"The DHL Express account number of the party to be billed.","example":"DHL123456"},"countryCode":{"type":"string","description":"Two-letter ISO country code of the party to be billed.","example":"US"},"postalCode":{"type":"string","description":"Postal code of the party to be billed.","example":"30305"},"party":{"type":"string","enum":["BILL_RECEIVER","BILL_SENDER","BILL_THIRD_PARTY","BILL_RECEIVER_CONTRACT"],"description":"Billing party for DHL Express. Account number is required for all scenarios.","example":"BILL_THIRD_PARTY"},"typeOfCharge":{"type":"string","enum":["TRANSPORTATION_CHARGES","DUTIES_AND_TAXES","ALL_CHARGES"],"description":"The type of charge billed to the specified party.","example":"DUTIES_AND_TAXES"}}},{"title":"Purolator Carrier Payment","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator Billing Rules:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of DDU (Delivery Duty Unpaid) and no bill-to party provided:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pitney Bowes does not prompt for BILL_PARTY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Third Party"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can pay "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for both "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"domestic and international"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" shipments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can pay "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"domestic shipments only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For an "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"international shipment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if a third party is billed, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address must be included in the request payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Purolator is unable to collect these charges from the receiver, the sender will be billed."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator Billing Scenarios:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal/Country Code"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender & Receiver split"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper & 3rd Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]}]}]}],"properties":{"accountNumber":{"type":"string","description":"The DHL Express account number of the party to be billed.","example":"DHL123456"},"countryCode":{"type":"string","description":"Two-letter ISO country code of the party to be billed.","example":"US"},"postalCode":{"type":"string","description":"Postal code of the party to be billed.","example":"30305"},"party":{"type":"string","enum":["BILL_RECEIVER","BILL_SENDER","BILL_THIRD_PARTY","BILL_RECEIVER_CONTRACT"],"description":"Billing party for DHL Express. Account number is required for all scenarios.","example":"BILL_THIRD_PARTY"},"typeOfCharge":{"type":"string","enum":["TRANSPORTATION_CHARGES","DUTIES_AND_TAXES","ALL_CHARGES"],"description":"The type of charge billed to the specified party.","example":"DUTIES_AND_TAXES"}}}]}}},"components/schemas/docTabItem":{"id":"components/schemas/docTabItem","kind":"json-schema","title":"docTabItem","data":{"type":"object","properties":{"displayName":{"type":"string","description":"This is a mandatory field. It will be displayed on the label","example":"TO"},"value":{"type":"string","description":"If the field is part of a request or response, the value will be picked up from there. In the case of custom fields, the user-provided value will be printed.","example":"Test1"},"row":{"type":"integer","description":"Row Position of the Item. The min value is 1.","example":1},"column":{"type":"integer","description":"Column Position of the Item. The min value is 1.","example":1}}}},"components/schemas/referenceV2":{"id":"components/schemas/referenceV2","kind":"json-schema","title":"referenceV2","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"References are tags or information that is printed on Shipping Label based on the customer's requirement. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Reference Fields can have values/indication like department name, invoice no., package description, purchase order no., carrier note, cost account no., transportation no., or PO no., print custom message etc."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Each of the reference field can have only one indication/value."},"children":[]}]}]}],"properties":{"reference1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference 1 can have one of the above-indicated values/information, which is printed on Label. For FedEx, it is a Reference number in the invoice. For USPS, it is a print custom message that will be printed vertically at the top of the label. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"custome message"},"reference2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference 2 can have other details as indicated in the example values above. This is also printed on Label. For FedEx, this is the department. For USPS, it is a print custom message that will be printed horizontally at the bottom of the label. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"SendTech"},"reference3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference 3 can have the information which were not fulfilled in Ref1 and Ref2. For FedEx, this is the invoice number. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"98437"},"reference4":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference 4 can have more information which were not provided in Ref1, Ref2, or Ref3. For FedEx, this is the PO number. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Overnight Shipping"},"poNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Purchase Order Number. For FedEx, the PO number is passed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"R2W 2H2"},"department":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The department of the Recipient.For FedEx, the Department is passed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Name department"},"additionalReference1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Reference is hardly used, but sender can mention anything as per requirement, just for Recipient's information. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"612987641"},"additionalReference2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any tags or information that to be shown to Recipient, can be mentioned by Sender, which is not indicated on AdditionalReference1 field, e.g., PO No, Order No. etc."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"989"},"shippingNotes":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping notes are the instructions or messages that the sender wants to communicate to the carrier or the recipient regarding the handling, delivery, or any special requirements for the shipment. These notes can include specific delivery instructions, handling precautions, or any other relevant information that can assist in ensuring the safe and accurate delivery of the package. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Handle with care."},"ShipperReference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper Reference is a unique identifier or code assigned by the shipper to a specific shipment or package. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"REF123456789"},"transportationReference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transportation Reference is a unique identifier or code used to track and manage the transportation of a shipment or package throughout the shipping process. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"TRANSREF987654321"}}}},"components/schemas/shipmentReprintV2":{"id":"components/schemas/shipmentReprintV2","kind":"json-schema","title":"shipmentReprintV2","data":{"type":"object","required":["shipmentId"],"properties":{"shipmentId":{"type":"string","description":"The shipmentId is a unique identifier for an individual Shipment.","example":"PUROLATOR2200626353009030"},"printerAliasName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to a printer connected (directly or via network) to a computer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 60"},"children":[]}]}]}],"example":"ZPLtoSheltonTest"},"references":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains key value map for passing references which is printed on Shipping Label. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example Department Name, Invoice No., PO No., Package description, Order No./ Purchase Order No., Carrier note, Cost Account No., Transportation No., etc. . Max references allowed here is 2."},"children":[]}]}]}],"properties":{"additionalReference1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Reference is hardly used, but sender can mention anything as per requirement, just for Recipient's information. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"612987641"},"additionalReference2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any tags or information that to be shown to Recipient, can be mentioned by Sender, which is not indicated on AdditionalReference1 field, e.g., PO No, Order No. etc."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 50"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"989"}}}}}},"components/schemas/shipmentCancelV2":{"id":"components/schemas/shipmentCancelV2","kind":"json-schema","title":"shipmentCancelV2","data":{"type":"object","properties":{"shipmentId":{"type":"string","description":"The shipmentId is a unique identifier for an individual Shipment.","example":"PUROLATOR2200626353009030"},"parcelTrackingNumber":{"type":"string","description":"The tracking number associated with one parcel in a shipment. The parcel tracking number can be used to track one specific parcel.","example":"1234sjhgf"},"references":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains key value map for passing references which is printed on Shipping Label. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example Department Name, Invoice No., PO No., Package description, Order No./ Purchase Order No., Carrier note, Cost Account No., Transportation No., etc. . Max references allowed here is 2, and max length of each Reference field is 30. [IN/OUT]."},"children":[]}]}]}],"properties":{"additionalReference1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Reference is hardly used, but sender can mention anything as per requirement, just for Recipient's information. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"612987641"},"additionalReference2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any tags or information that to be shown to Recipient, can be mentioned by Sender, which is not indicated on AdditionalReference1 field, e.g., PO No, Order No. etc."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"989"}}}}}},"components/schemas/shipmentDomesticByRateGroup":{"id":"components/schemas/shipmentDomesticByRateGroup","kind":"json-schema","title":"By RateGroup","data":{"title":"By RateGroup","type":"object","required":["toAddress","labelType","labelFormat","labelSize","parcelType"],"properties":{"fromAddress":{"$ref":"#/components/schemas/fromAddressV2"},"toAddress":{"$ref":"#/components/schemas/toAddressV2"},"soldToAddress":{"$ref":"#/components/schemas/soldToAddressV2"},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by FedEx, UPS, and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"3010 Summer Street"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"OTTAWA"},"countryCode":{"type":"string","description":"The two-letter ISO country code for the alternate return address.","example":"CA"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"4161234567"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"K1A0B2"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"ON"}}},"parcel":{"$ref":"#/components/schemas/parcelV2"},"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ParcelType can have categories like Package, Envelopes, Paks, Boxes, Tube, etc. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"PKG"},"rateShopBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RateShop, which is attached to an Enterprise or Location, is done through four approaches: by Carrier, by RateGroup, by RuleSet and by ShipViaCode. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  Through Carrier, customers can choose the carriers as per requirement, based on which services, parcel types, and special services can be selected, and RateShop is done. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RateGroup, customers can select the RateGroup, which has been divided into two categories: Cheapest (w.r.t. price) and Fastest (w.r.t. delivery hours). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RuleSet, customers can define the Condition/rule for selecting carriers and their services, so they do not need to worry for Rate Shopping every time they create Shipment. For example, For a particular location, they can set one definite carrier, or apply RateGroup - Cheapest/Fastest. Similarly, for a particular amount like below $1000 Dollars, they can select a definite carrier service, based on RateGroup. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through ShipViaCode, customers can create a shipment using a single code (Custom Carrier Code) that represents a specific combination of carrier, carrier account, parcel type, service, and special services."},"children":[]}]}]}],"example":"rateGroup","enum":["carrier","rateGroup","ruleSet","shipViaCode"]},"byRateGroup":{"type":"object","required":["ruleType","rateGroupId"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the category to select how cheap the carrier service is, or which carrier has fastest service. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It displays the list of those services."},"children":[]}]}]}],"properties":{"ruleType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Rule Type is a condition applied to RateGroup by Product side as per the customer requirement, which can have following options: Cheapest, Fastest, and deliverBy."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If ruleType is deliverBy, then deliverBy date under deliveryOption will be mandatory to provide."},"children":[]}]}]}],"example":"Cheapest","enum":["Cheapest","Fastest","DeliverBy"]},"rateGroupId":{"type":"string","description":"This is a unique identifier assigned to the created RateGroup, which is used in the shipment creation.","example":"9bzUUq2w70h7"}}},"shipmentOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment Options have an option of Manifest."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" With Manifest, the Mail Center agent can print the Manifest (End of day records of all created shipment) of selected carrier."},"children":[]}]}]}],"properties":{"addToManifest":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option asks if the shipment is to be added for Manifest, so that the shipment will reflect in the Manifest Form while compilation. Supported for CPC and USPS carriers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value can be 'true' or 'false'."},"children":[]}]}]}],"example":true},"minimalAddressValidation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows performing minimal address validation during shipment creation. the addressLine1 field is not validated if set to true."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimal address validation is supported only for these APIs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Shipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Bulk Shipments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Multipiece Shipment"},"children":[]}]}]}]}],"example":true,"enum":[true,false]},"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"},"shipperID":{"type":"string","description":"The unique identifier of the known shipper associated with this shipment.","example":"1234567890"}}},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"docTab":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option is used to provide additional information into the label's additional space. It is supported only for doc size "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4x6_75"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"templateName":{"type":"string","description":"This is an optional field and will be used when the client has multiple doctab options.","example":"1"},"toAddressName":{"$ref":"#/components/schemas/docTabItem"},"parcelTrackingNumber":{"$ref":"#/components/schemas/docTabItem"},"carrier":{"$ref":"#/components/schemas/docTabItem"},"serviceId":{"$ref":"#/components/schemas/docTabItem"},"dateOfShipment":{"$ref":"#/components/schemas/docTabItem"},"pieceNumber":{"$ref":"#/components/schemas/docTabItem"},"packageTotalCarrierCharge":{"$ref":"#/components/schemas/docTabItem"},"totalCarrierCharge":{"$ref":"#/components/schemas/docTabItem"},"packageWeight":{"$ref":"#/components/schemas/docTabItem"},"totalWeight":{"$ref":"#/components/schemas/docTabItem"},"customField1":{"$ref":"#/components/schemas/docTabItem"},"customField2":{"$ref":"#/components/schemas/docTabItem"},"customField3":{"$ref":"#/components/schemas/docTabItem"},"customField4":{"$ref":"#/components/schemas/docTabItem"}},"example":{"templateName":"1","toAddressName":{"displayName":"CUS","value":"","row":1,"column":1},"parcelTrackingNumber":{"displayName":"TRK","value":"","row":2,"column":1},"carrier":{"displayName":"CAR","value":"","row":3,"column":1},"serviceId":{"displayName":"SER","value":"","row":1,"column":2},"dateOfShipment":{"displayName":"DATE","value":"","row":2,"column":2},"pieceNumber":{"displayName":"PKG#","value":"","row":3,"column":2},"packageTotalCarrierCharge":{"displayName":"PCHG","value":"","row":3,"column":3},"totalCarrierCharge":{"displayName":"TCHG","value":"","row":2,"column":3},"packageWeight":{"displayName":"PWGT","value":"","row":1,"column":3},"totalWeight":{"displayName":"TWGT","value":"","row":1,"column":4},"customField1":{"displayName":"INV","value":"010610000388302031320259999950","row":2,"column":4}}},"deliveryConfirmation":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the supporting special service or document as an evidence of shipment delivery."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the delivery confirmation, user can select any of the following special services, but they may vary as per the carrier selection. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature Required/ Indirect Signature Required : SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery confirmation: DELIVERY_CONFIRMATION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of age required (18 years) Adult Signature Required: ADULT_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of age required (19 years): ADULT_SIGNATURE_19"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Signature Required: NO_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Signature Required: DIRECT_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain of Signature: CHAIN_OF_SIGNATURE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE and ADULT_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE, ADULT_SIGNATURE, NO_SIGNATURE, and DIRECT_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ADULT_SIGNATURE, NO_SIGNATURE, and CHAIN_OF_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GoFor supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPC supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE, DELIVERY_CONFIRMATION, ADULT_SIGNATURE, ADULT_SIGNATURE_19, and NO_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The delivery confirmation Type.","example":"ADULT_SIGNATURE","enum":["NO_SIGNATURE","SIGNATURE","ADULT_SIGNATURE","ADULT_SIGNATURE_19","DIRECT_SIGNATURE","DELIVERY_CONFIRMATION","CHAIN_OF_SIGNATURE"]}}},"handling":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Few shipments need a special handling, and the reason can be fragile items or highly secured shipments. There might be other case scenarios. In a simple term, this field defines shipment handling, which provides users a capability to select handling options. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User can select any of the following handling options (special services), but they may vary as per the carrier selection."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hold For Pickup: HOLD_FOR_PICKUP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saturday Delivery: SATURDAY_DELIVERY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Premium Care: PREMIUM_CARE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Delivery Only: DIRECT_DELIVERY_ONLY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Handling: ADDITIONAL_HANDLING"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS supports all handling options mentioned above."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOLD_FOR_PICKUP, SATURDAY_DELIVERY, and ADDITIONAL_HANDLING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOLD_FOR_PICKUP, SATURDAY_DELIVERY, and ADDITIONAL_HANDLING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The special handling type.","example":"ADDITIONAL_HANDLING","enum":["HOLD_FOR_PICKUP","SATURDAY_DELIVERY","PREMIUM_CARE","DIRECT_DELIVERY_ONLY","ADDITIONAL_HANDLING"]}}},"insurance":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the insurance coverage, which is selected by users while create shipment - rate shopping. User can select below-mentioned special service for insurance:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declared Value Surcharge: INSURANCE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS, FedEx, Purolator, and CPC support special service "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSURANCE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The insurance type.","example":"INSURANCE","enum":["INSURANCE"]},"amount":{"type":"number","description":"The insurance amount in the currency specified for the shipment.","example":200}}},"references":{"$ref":"#/components/schemas/referenceV2"},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","description":"The data that provides information about other inter-related/ required data.","properties":{"name":{"type":"string","description":"Name of the Cost Account which are linked to Shipment.","example":"costAccountName"},"value":{"type":"string","description":"Indicates the value for the CostAccount.","example":"cost1"}},"example":[{"name":"costAccountName","value":"costAccountName"},{"name":"costAccountId","value":"costAccountId"},{"name":"costAccountCode","value":"Code"},{"name":"accountCode","value":"code"},{"name":"companyCode","value":"code"}]}},"labelSize":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the label size of the Shipment, that is, the Shipping Label is available in different Doc Size. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]}]}]}],"enum":["DOC_8X11","DOC_4X8","DOC_4X6"],"example":"DOC_4X6"},"labelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the Shipment. QR_CODE supported for carrier USPS only as of now. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]}]}]}],"enum":["SHIPPING_LABEL","QR_CODE"],"example":"SHIPPING_LABEL"},"labelFormat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Defines the file/format in which the label is printed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" QR_CODE can be generated only in GIF format. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"enum":["PDF","ZPL2","PNG","GIF"],"example":"ZPL2"},"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the label content is encoded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" BASE64 is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZPL2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PNG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"URL","enum":["URL","BASE64"]},"printerAliasName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to a printer connected (directly or via network) to a computer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 60"},"children":[]}]}]}],"example":"test"},"dateOfShipment":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when shipment is created/shipped. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: For FedEx US shipments, when a shipment date is provided in the request, the specified value is used for shipment processing. If no shipment date is provided, Carrier processes it as per their system."},"children":[]}]}]}],"example":"2024-03-20"},"deliveryOption":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two options of delivery: deliverBy and useBestNextDate, where customer can schedule the delivery date in deliverBy."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In case if the customer's scheduled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date falls under Holiday, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useBestNextDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used by our system. Then, we will mark the second option and deliver the same."},"children":[]}]}]}],"properties":{"deliverBy":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery date is the data when shipment is to be delivered, which is scheduled by sender. The format of the Date is YYYY-MM-DD."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field will be mandatory to provide, if the customer chooses ruleType is deliverBy."},"children":[]}]}]}],"example":"2024-03-20"},"useBestNextDate":{"type":"boolean","description":"When this is set to true, if the scheduled delivery date falls on a Holiday, then the next business day will be considered to deliver the shipment.","example":false}}},"customs":{"$ref":"#/components/schemas/Customs"}},"example":{"fromAddress":{"name":"Sender Name","addressLine1":"1600 Amphitheatre Parkway","addressLine2":"near abc street","addressLine3":"near xyz street","company":"PB","email":"testuser@gmail.com","phone":"6502530000","cityTown":"Mountain View","stateProvince":"CA","postalCode":"94043","inductionPostalCode":"06905","countryCode":"US","residential":true},"toAddress":{"name":"Recipient Name","addressLine1":"350 Fifth Avenue","addressLine2":"near abc street","addressLine3":"near xyz street","cityTown":"New York","stateProvince":"NY","postalCode":"10118","countryCode":"US","company":"PB","phone":"2127363100","email":"recipient@gmail.com","residential":true,"isPOBox":true},"altReturnAddress":{"name":"User Name","addressLine1":"1600 Amphitheatre Parkway","addressLine2":"near abc street","addressLine3":"near xyz street","company":"PB","email":"testuser@gmail.com","phone":"6502530000","cityTown":"Mountain View","stateProvince":"CA","postalCode":"94043","inductionPostalCode":"06905","countryCode":"US","residential":true},"soldToAddress":{"name":"John Doe","addressLine1":"1600 Amphitheatre Parkway","addressLine2":"Suite 101","addressLine3":"Near central market","company":"ABC Company","phone":"650-253-0000","email":"billing@abccompany.com","residential":false,"cityTown":"Mountain View","stateProvince":"CA","postalCode":"94043","countryCode":"US","taxId":"string","taxIdType":"EIN"},"additionalAddresses":[{"address":{"name":"Warehouse Manager","residential":false,"phone":"732-443-1007","countryCode":"US","company":"ABC Company","postalCode":"08810-1411","cityTown":"DAYTON","stateProvince":"NJ","addressLine1":"2270 US HIGHWAY 130"},"addressType":"EXPORTER"}],"parcel":{"length":2,"width":1,"height":1,"dimUnit":"IN","weightUnit":"OZ","weight":2,"packageValue":2},"parcelType":"PKG","rateShopBy":"rateGroup","byRateGroup":{"ruleType":"Cheapest","rateGroupId":"5GW1NZ9Q7Av5n6B"},"shipmentOptions":{"minimalAddressValidation":true,"bypassAddressValidation":"toAddress","bookingConfirmationNumber":"XXXX56789812"},"references":{"reference1":"custome message","reference2":"SendTech","reference3":"98437","reference4":"Overnight Shipping","poNumber":"R2W 2H2","department":"Name department","additionalReference1":"612987641","additionalReference2":"989","shippingNotes":"Handle with care.","ShipperReference":"REF123456789","transportationReference":"TRANSREF987654321"},"carrierPayments":[{"typeOfCharge":"TRANSPORTATION_CHARGES","party":"BILL_THIRD_PARTY","accountNumber":"602684342","postalCode":"14609","countryCode":"US"}],"docTab":{"templateName":"1","toAddressName":{"displayName":"TO","value":"Test1","row":1,"column":1},"parcelTrackingNumber":{"displayName":"TO","value":"Test1","row":1,"column":1},"carrier":{"displayName":"TO","value":"Test1","row":1,"column":1},"serviceId":{"displayName":"TO","value":"Test1","row":1,"column":1},"dateOfShipment":{"displayName":"TO","value":"Test1","row":1,"column":1},"pieceNumber":{"displayName":"TO","value":"Test1","row":1,"column":1},"packageTotalCarrierCharge":{"displayName":"TO","value":"Test1","row":1,"column":1},"totalCarrierCharge":{"displayName":"TO","value":"Test1","row":1,"column":1},"packageWeight":{"displayName":"TO","value":"Test1","row":1,"column":1},"totalWeight":{"displayName":"TO","value":"Test1","row":1,"column":1},"customField1":{"displayName":"TO","value":"Test1","row":1,"column":1},"customField2":{"displayName":"TO","value":"Test1","row":1,"column":1},"customField3":{"displayName":"TO","value":"Test1","row":1,"column":1},"customField4":{"displayName":"TO","value":"Test1","row":1,"column":1}},"metadata":[{"name":"costAccountName","value":"costAccountName"},{"name":"costAccountId","value":"costAccountId"},{"name":"costAccountCode","value":"Code"},{"name":"accountCode","value":"code"},{"name":"companyCode","value":"code"}],"deliveryConfirmation":{"type":"ADULT_SIGNATURE","value":"amit"},"handling":{"type":"ADDITIONAL_HANDLING","value":"HOLD"},"insurance":{"type":"INSURANCE","amount":200},"labelSize":"DOC_4X6_75","labelType":"SHIPPING_LABEL","labelFormat":"ZPL2","dateOfShipment":"{{todayDate}}","deliveryOption":{"deliverBy":"{{tomorrowDate}}","useBestNextDate":false}}}},"components/schemas/shipmentDomesticByRuleset":{"id":"components/schemas/shipmentDomesticByRuleset","kind":"json-schema","title":"By RuleSet","data":{"title":"By RuleSet","type":"object","required":["toAddress","labelType","labelFormat","labelSize","parcelType"],"properties":{"fromAddress":{"$ref":"#/components/schemas/fromAddressV2"},"toAddress":{"$ref":"#/components/schemas/toAddressV2"},"soldToAddress":{"$ref":"#/components/schemas/soldToAddressV2"},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by FedEx, UPS, and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the alternate return address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the valid email address associated with the alternate return address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"The two-letter ISO country code for the alternate return address.","example":"CA"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"Paul Wright"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}},"parcel":{"$ref":"#/components/schemas/parcelV2"},"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ParcelType can have categories like Package, Envelopes, Paks, Boxes, Tube, etc. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"PKG"},"rateShopBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RateShop, which is attached to an Enterprise or Location, is done through four approaches: by Carrier, by RateGroup, by RuleSet and by ShipViaCode. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  Through Carrier, customers can choose the carriers as per requirement, based on which services, parcel types, and special services can be selected, and RateShop is done. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RateGroup, customers can select the RateGroup, which has been divided into two categories: Cheapest (w.r.t. price) and Fastest (w.r.t. delivery hours). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RuleSet, customers can define the Condition/rule for selecting carriers and their services, so they do not need to worry for Rate Shopping every time they create Shipment. For example, For a particular location, they can set one definite carrier, or apply RateGroup - Cheapest/Fastest. Similarly, for a particular amount like below $1000 Dollars, they can select a definite carrier service, based on RateGroup. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through shipViaCode, customers can create a shipment using a single code (Custom Carrier Code) that represents a specific combination of carrier, carrier account, parcel type, service, and special services."},"children":[]}]}]}],"example":"ruleSet","enum":["carrier","rateGroup","ruleSet","shipViaCode"]},"byRuleSet":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User can create the Shipment using Rule Set."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" By Rule Set means a rule that is defined as one or more conditions resulting in an action (or more than one action). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The conditions and actions can vary widely."},"children":[]}]}]}],"properties":{"ruleType":{"type":"string","description":"The Rule Type is a condition applied to RateGroup by Product side, which can be applicable for a client or set of client users.","example":"Cheapest","enum":["Cheapest","Fastest"]},"hazmat":{"type":"string","description":"This is for Hazardous material.","example":"test"},"shipOption":{"type":"string","description":"The options for shipment configured as part of the automation rule. For example: Ship Via Code","example":"xxxxxxxx"}}},"shipmentOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment Options have an option of Manifest. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" With Manifest, the Mail Center agent can print the Manifest (End of day records of all created shipment) of selected carrier."},"children":[]}]}]}],"properties":{"addToManifest":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option asks if the shipment is to be added for Manifest, so that the shipment will reflect in the Manifest Form while compilation. Supported for CPC and USPS carriers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value can be 'true' or 'false'."},"children":[]}]}]}],"example":true},"minimalAddressValidation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows performing minimal address validation during shipment creation. the addressLine1 field is not validated if set to true."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimal address validation is supported only for these APIs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Shipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Bulk Shipments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Multipiece Shipment"},"children":[]}]}]}]}],"example":true,"enum":[true,false]},"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"},"shipperID":{"type":"string","description":"The unique identifier of the known shipper associated with this shipment.","example":"1234567890","enum":["fromAddress","toAddress","fromAndToAddress"]}}},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"docTab":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option is used to provide additional information into the label's additional space. It is supported only for doc size "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4x6_75"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"templateName":{"type":"string","description":"This is an optional field and will be used when the client has multiple doctab options.","example":"1"},"toAddressName":{"$ref":"#/components/schemas/docTabItem"},"parcelTrackingNumber":{"$ref":"#/components/schemas/docTabItem"},"carrier":{"$ref":"#/components/schemas/docTabItem"},"serviceId":{"$ref":"#/components/schemas/docTabItem"},"dateOfShipment":{"$ref":"#/components/schemas/docTabItem"},"pieceNumber":{"$ref":"#/components/schemas/docTabItem"},"packageTotalCarrierCharge":{"$ref":"#/components/schemas/docTabItem"},"totalCarrierCharge":{"$ref":"#/components/schemas/docTabItem"},"packageWeight":{"$ref":"#/components/schemas/docTabItem"},"totalWeight":{"$ref":"#/components/schemas/docTabItem"},"customField1":{"$ref":"#/components/schemas/docTabItem"},"customField2":{"$ref":"#/components/schemas/docTabItem"},"customField3":{"$ref":"#/components/schemas/docTabItem"},"customField4":{"$ref":"#/components/schemas/docTabItem"}},"example":{"templateName":"1","toAddressName":{"displayName":"CUS","value":"","row":1,"column":1},"parcelTrackingNumber":{"displayName":"TRK","value":"","row":2,"column":1},"carrier":{"displayName":"CAR","value":"","row":3,"column":1},"serviceId":{"displayName":"SER","value":"","row":1,"column":2},"dateOfShipment":{"displayName":"DATE","value":"","row":2,"column":2},"pieceNumber":{"displayName":"PKG#","value":"","row":3,"column":2},"packageTotalCarrierCharge":{"displayName":"PCHG","value":"","row":3,"column":3},"totalCarrierCharge":{"displayName":"TCHG","value":"","row":2,"column":3},"packageWeight":{"displayName":"PWGT","value":"","row":1,"column":3},"totalWeight":{"displayName":"TWGT","value":"","row":1,"column":4},"customField1":{"displayName":"INV","value":"010610000388302031320259999950","row":2,"column":4}}},"deliveryConfirmation":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the supporting special service or document as an evidence of shipment delivery."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the delivery confirmation, user can select any of the following special services, but they may vary as per the carrier selection. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature Required/ Indirect Signature Required : SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery confirmation: DELIVERY_CONFIRMATION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of age required (18 years) Adult Signature Required: ADULT_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of age required (19 years): ADULT_SIGNATURE_19"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Signature Required: NO_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Signature Required: DIRECT_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain of Signature: CHAIN_OF_SIGNATURE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE and ADULT_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE, ADULT_SIGNATURE, NO_SIGNATURE, and DIRECT_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ADULT_SIGNATURE, NO_SIGNATURE, and CHAIN_OF_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GoFor supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPC supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SIGNATURE, DELIVERY_CONFIRMATION, ADULT_SIGNATURE, ADULT_SIGNATURE_19, and NO_SIGNATURE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The delivery confirmation Type.","example":"ADULT_SIGNATURE","enum":["NO_SIGNATURE","SIGNATURE","ADULT_SIGNATURE","ADULT_SIGNATURE_19","DIRECT_SIGNATURE","DELIVERY_CONFIRMATION","CHAIN_OF_SIGNATURE"]}}},"handling":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Few shipments need a special handling, and the reason can be fragile items or highly secured shipments. There might be other case scenarios. In a simple term, this field defines shipment handling, which provides users a capability to select handling options. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User can select any of the following handling options (special services), but they may vary as per the carrier selection."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hold For Pickup: HOLD_FOR_PICKUP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saturday Delivery: SATURDAY_DELIVERY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Premium Care: PREMIUM_CARE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Delivery Only: DIRECT_DELIVERY_ONLY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Handling: ADDITIONAL_HANDLING"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS supports all handling options mentioned above."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOLD_FOR_PICKUP, SATURDAY_DELIVERY, and ADDITIONAL_HANDLING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator supports "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOLD_FOR_PICKUP, SATURDAY_DELIVERY, and ADDITIONAL_HANDLING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The special handling type.","example":"ADDITIONAL_HANDLING","enum":["HOLD_FOR_PICKUP","SATURDAY_DELIVERY","PREMIUM_CARE","DIRECT_DELIVERY_ONLY","ADDITIONAL_HANDLING"]}}},"insurance":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the insurance coverage, which is selected by users while create shipment - rate shopping. User can select below-mentioned special service for insurance:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declared Value Surcharge: INSURANCE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier specific options:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS, FedEx, Purolator, and CPC support special service "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INSURANCE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"type":{"type":"string","description":"The insurance type.","example":"INSURANCE","enum":["INSURANCE"]},"amount":{"type":"number","description":"The insurance amount in the currency specified for the shipment.","example":200}}},"references":{"$ref":"#/components/schemas/referenceV2"},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","description":"The data that provides information about other inter-related/ required data.","properties":{"name":{"type":"string","description":"Name of the Cost Account which are linked to Shipment.","example":"costAccountName"},"value":{"type":"string","description":"Indicates the value for the CostAccount.","example":"cost1"}},"example":[{"name":"costAccountName","value":"costAccountName"},{"name":"costAccountId","value":"costAccountId"},{"name":"costAccountCode","value":"Code"},{"name":"accountCode","value":"code"},{"name":"companyCode","value":"code"}]}},"labelSize":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the label size of the Shipment, that is, the Shipping Label is available in different Doc Size. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]}]}]}],"enum":["DOC_8X11","DOC_4X8","DOC_4X6"],"example":"DOC_4X6"},"labelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the Shipment. QR_CODE supported for carrier USPS only as of now. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]}]}]}],"enum":["SHIPPING_LABEL","QR_CODE"],"example":"SHIPPING_LABEL"},"labelFormat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Defines the file/format in which the label is printed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  QR_CODE can be generated only in GIF format. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"enum":["PDF","ZPL2","PNG","GIF"],"example":"ZPL2"},"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the label content is encoded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" BASE64 is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZPL2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PNG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"URL","enum":["URL","BASE64"]},"printerAliasName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to a printer connected (directly or via network) to a computer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 60"},"children":[]}]}]}],"example":"test"},"dateOfShipment":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when shipment is created/shipped. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: For FedEx US shipments, when a shipment date is provided in the request, the specified value is used for shipment processing. If no shipment date is provided, Carrier processes it as per their system."},"children":[]}]}]}],"example":"2024-03-20"},"deliveryOption":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two options of delivery: deliverBy and useBestNextDate, where customer can schedule the delivery date in deliverBy."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In case if the customer's scheduled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date falls under Holiday, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useBestNextDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used by our system. Then, we will mark the second option and deliver the same."},"children":[]}]}]}],"properties":{"deliverBy":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery date is the data when shipment is to be delivered, which is scheduled by sender. The format of the Date is YYYY-MM-DD."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field will be mandatory to provide, if the customer chooses ruleType is deliverBy."},"children":[]}]}]}],"example":"2024-03-20"},"useBestNextDate":{"type":"boolean","description":"When this is set to true, if the scheduled delivery date falls on a Holiday or there is no carrier to deliver on the deliverby date, then the next business day will be considered to deliver the shipment.","example":false}}},"customs":{"$ref":"#/components/schemas/customs"}}}},"components/schemas/shipmentInternationalByCarrier":{"id":"components/schemas/shipmentInternationalByCarrier","kind":"json-schema","title":"International Shipment","data":{"title":"International Shipment","type":"object","required":["size","type","toAddress","byCarrier","parcelType","rateShopBy","labelSize","labelType","labelFormat","customs"],"properties":{"fromAddress":{"type":"object","description":"The complete address of the Sender.","properties":{"name":{"type":"string","description":"The name of the Sender to which this address points.","example":"Sender Name"},"addressLine1":{"type":"string","description":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender. ","example":"24182 Kathy Ave"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town the Sender's address belongs to. ","example":"Lake Forest"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the State or Province the Sender belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US or Canadian address(es). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please switch to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" radio button, enter the required country name or country code, and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button."},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#iso:code:3166:CA","description":"List of Province with their Province/State Codes."},"example":"CA"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code or ZIP Code of the address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For CA addresses, it is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"six-character"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alphanumeric string Postal Code in this format: 'A1A 1A1'. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" While for US addresses, it is either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code in one of the following formats: '12345' or '12345-6789'."},"children":[]}]}]}],"example":"92630-1827"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country in which the sender's address is located. The value is the two-character ISO Code of the country from the ISO country list. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is ISO 3166-1 Alpha-2 standard values. This is included for the best results of search, especially if the country name does not appear in any of the unparsedAddressLines. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink, please select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button."},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#search","description":"List of Countries with their ISO Codes"},"example":"US"},"company":{"type":"string","description":"The name of the company, in case if the sender address is not residential. ","example":"PB"},"phone":{"type":"string","description":"This is sender's phone number. The digits can be with or without spaces or hyphens. ","example":"203-555-1214"},"email":{"type":"string","description":"This is sender's valid email. Email is required if the customer is using GoFor Carrier. Sender email is required for RMG b2b shipment. ","example":"test2user@gmail.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value is 'true', else it is 'false'.","example":true},"taxId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tax Identification Number (TIN). TIN Number is supported for FedEx as of now."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max character length = 18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOSS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EORI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_UNION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 12 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 13 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"taxIdType":{"type":"string","description":"Specifies the type of tax identification being provided.","enum":["EIN","GST","VAT","IOSS","RFC","EORI"]}}},"toAddress":{"type":"object","required":["name","addressLine1","cityTown","stateProvince","postalCode","countryCode","phone"],"description":"The complete address of the Recipient or Department (in case if the address is not pointed to any individual recipient).","properties":{"name":{"type":"string","description":"The name of the Recipient.","example":"Recipient Name"},"addressLine1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Recipient. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"771 Atlantic Ave"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the city or town the Recipient belongs to. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"BRAMPTON"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The name of the State or Province the Sender belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US or Canadian address(es)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please switch to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" radio button, enter the required country name or country code, and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button . "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#iso:code:3166:CA","description":"List of Province with their Province/State Codes."},"example":"ON"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The Postal Code or ZIP Code of the address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For CA addresses, use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"six-character"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alphanumeric string Postal Code in this format: 'A1A 1A1'."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" While for US addresses, use either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code in one of the following formats: '12345' or '12345-6789'."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"example":"L6Y 2N4"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The country in which the recipient's address is located. The value will be the two-character ISO Code of the country from the ISO country list. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink, please select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#search","description":"List of Countries with their ISO Codes"},"example":"CA"},"company":{"type":"string","description":"The name of the company, in case if the recipient address is not residential. Recipient company is required for RMG b2b shipment.","example":"PB"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is Recipient's phone number. Enter the digits with or without spaces or hyphens. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"332 555-1212"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be recipient's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"recipient@gmail.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"isPOBox":{"type":"boolean","description":"Checks if the specified address has the PO Box. In case if Yes, the boolean value will be 'true', else it will take 'false'.","example":true},"taxId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tax Identification Number (TIN). TIN Number is supported for FedEx as of now."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max character length = 18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOSS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EORI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_UNION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 12 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 13 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"taxIdType":{"type":"string","description":"Specifies the type of tax identification being provided.","enum":["EIN","GST","VAT","IOSS","RFC","EORI"]}}},"soldToAddress":{"$ref":"#/components/schemas/soldToAddressV2"},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by USPS, FedEx, UPS, and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}},"parcel":{"type":"object","$ref":"#/components/schemas/parcelV2"},"parcelType":{"type":"string","description":"Type of parcel, such as Package, Envelope, Box, etc.","example":"PKG"},"rateShopBy":{"type":"string","description":"Determines the rate shopping method.","example":"carrier","enum":["carrier","rateGroup","ruleSet"]},"byCarrier":{"type":"object","description":"Carrier-specific options for creating a shipment.","$ref":"#/components/schemas/byCarrierV2"},"shipmentOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment Options have an added feature that is Manifest."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" With Manifest, the Mail Center agent can print the Manifest (End of day records of all created shipment) of selected carrier."},"children":[]}]}]}],"properties":{"addToManifest":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option asks if the shipment is to be added for Manifest, so that the shipment will reflect in the Manifest Form while compilation. Supported for CPC and USPS carriers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value can be 'true' or 'false'."},"children":[]}]}]}],"example":true},"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"},"shipperID":{"type":"string","description":"The unique identifier of the known shipper associated with this shipment.","example":"1234567890"},"b2b":{"type":"boolean","example":true,"description":"Required only for RMG carrier. Must be set to true to indicate a business-to-business (B2B) shipment."},"senderEORI":{"type":"string","example":"GB123456789101","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's Economic Operators Registration and Identification number. EORI is a unique identification number used for customs clearance in the European Union. This Number can be 14 characters long in Alphanumeric format. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for RMG B2B shipments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"recipientEORI":{"type":"string","example":"GB123456789102","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient's EORI number. ORI is a unique identification number used for customs clearance in the European Union. This Number can be 14 characters long in Alphanumeric format. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for RMG B2B shipments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"senderUKIMSNumber":{"type":"string","example":"GBUKIM12345678910100000000000000","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UKIMS (UK Internal Market Scheme) is an authorization that allows businesses to move goods between Great Britain (GB) and Northern Ireland (NI) without paying EU (European) duty. UKIMS Number can be 32 characters long in Alphanumeric format. Required if the package value value is over £135."},"children":[]}]}]}]},"exportLicenceRequired":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the shipment includes goods that require an official export license."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applies to both RMG B2B and B2C shipments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required as part of customs compliance under the Windsor Agreement"},"children":[]}]}]}]}]},"additionalShipmentOptions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional carrier-specific shipment options provided as name/value pairs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express International"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": When creating a document-only shipment with DHL Express International (for example when the selected service is a documents service), pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENTS_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate that the shipment contains documents only. This bypasses customs clearance processing that would otherwise apply to non-document international shipments."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the additional shipment option. For DHL document-only shipments, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENTS_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"DOCUMENTS_ONLY"},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value for the additional shipment option. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENTS_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to mark the shipment as documents only."},"children":[]}]}]}],"example":"true"}}},"example":[{"name":"DOCUMENTS_ONLY","value":"true"}]}}},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"specialServices":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It provides a carrier based special or extra service, which also varies as per selected service and parcel type. User can override this value by defining it at shipment level."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either the specialserviceId or the specialservice objects such as deliveryConfirmation, handling, insurance and returnOptions, but not both."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/SpecialService"}},"references":{"type":"object","description":"Reference details to be printed on the shipping label.","$ref":"#/components/schemas/referenceV2"},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","description":"The data that provides information about other inter-related/ required data.","properties":{"name":{"type":"string","description":"Name of the Cost Account which are linked to Shipment.","example":"costAccountName"},"value":{"type":"string","description":"Indicates the value for the CostAccount.","example":"cost1"}},"example":[{"name":"costAccountName","value":"costAccountName"},{"name":"costAccountId","value":"costAccountId"},{"name":"costAccountCode","value":"Code"},{"name":"accountCode","value":"code"},{"name":"companyCode","value":"code"}]}},"labelSize":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the label size of the Shipment, that is, the Shipping Label is available in different Doc Size. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]}]}]}],"example":"DOC_4X6"},"labelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the Shipment. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]}]}]}],"enum":["SHIPPING_LABEL"],"example":"SHIPPING_LABEL"},"labelFormat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the file/format in which the label is printed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For ZPL2, DOC_4X6 will be supported, while for PDF, both the sizes are supported. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 14"},"children":[]}]}]}],"enum":["PDF","ZPL2","PNG","GIF"],"example":"PDF"},"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the label content is encoded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" BASE64 is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZPL2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PNG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"URL","enum":["URL","BASE64"]},"printerAliasName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to a printer connected (directly or via network) to a computer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 60"},"children":[]}]}]}],"example":"test"},"dateOfShipment":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when shipment is created/shipped. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: For FedEx US shipments, when a shipment date is provided in the request, the specified value is used for shipment processing. If no shipment date is provided, Carrier processes it as per their system."},"children":[]}]}]}],"example":"2024-11-20"},"deliveryOption":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two options of delivery: deliverBy and useBestNextDate, where customer can schedule the delivery date in deliverBy."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In case if the customer's scheduled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date falls under Holiday, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useBestNextDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used by our system. Then, we will mark the second option and deliver the same."},"children":[]}]}]}],"properties":{"deliverBy":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery date is the data when shipment is to be delivered, which is scheduled by sender. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field will be mandatory to provide, if the customer chooses ruleType is deliverBy."},"children":[]}]}]}],"example":"2024-12-30"},"useBestNextDate":{"type":"boolean","description":"When this is set to true, if the scheduled delivery date falls on a Holiday, then the next business day will be considered to deliver the shipment.","example":false}}},"customs":{"type":"object","description":"Customs information required for international shipments.","required":["customsInfo","customsItems"],"properties":{"customsInfo":{"type":"object","description":"This is additional customs information required along with item details.","required":["reasonForExport","customsDeclaredValue","currencyCode"],"properties":{"reasonForExport":{"type":"string","description":"Reason for exporting the items.","example":"DOCUMENTS","enum":["GIFT","COMMERCIAL_SAMPLE","MERCHANDISE","DOCUMENTS","RETURNED_GOODS","OTHER"]},"comments":{"type":"string","description":"Free-form comments regarding the exported shipment.","example":"Test comment"},"invoiceNumber":{"type":"string","description":"The commercial invoice number assigned by the exporter.","example":"001189223"},"importerCustomsReference":{"type":"string","description":"A reference number used by the importer, such as a VAT number, PO number, or insured number.","example":"987654"},"sdrValue":{"type":"number","format":"float","description":"When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values.","example":23.32},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"currencyCode":{"type":"string","description":"The currency used for declared value. Use three uppercase letters, per ISO 4217.","example":"USD"},"fromCustomsReference":{"type":"string","description":"Free-form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.","example":"EFEFE4554545"},"licenseNumber":{"type":"string","description":"The export license number associated with the commodity.","example":"456ABC123"},"certificateNumber":{"type":"string","description":"The certificate number associated with the commodity.","example":"987"},"customsDeclaredValue":{"type":"number","description":"Item value in mentioned currencyCode.","example":6000},"termsOfSale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the delivery and payment terms between the shipper and recipient. Currenty supported by carriers - UPS, FedEx and DHL. - Common values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CIP: Carriage and Insurance Paid to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPT: Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAP: Delivered at Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAT: Delivered at Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DDP: Delivered Duty Paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXW: Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FCA: Free Carrier"},"children":[]}]}]}]}],"example":"DDP","enum":["CIP","CPT","DAP","DAT","DDP","EXW","FCA"]}}},"customsItems":{"type":"array","description":"Items included in the customs declaration.","required":["description","quantity","unitPrice","weight","weightUnit"],"items":{"type":"object","properties":{"description":{"type":"string","description":"A detailed description of the commodity, up to 255 characters. The description will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Each description will appear on the form.","example":"Books"},"itemId":{"type":"string","description":" This is the unique identifier for the commodity.","example":"item1234"},"orderNumber":{"type":"string","description":"The unique identifier for the order.","example":"ORD1234"},"quantity":{"type":"number","description":"Enter the total number of items of this type of commodity.","example":1},"unitPrice":{"type":"number","format":"float","description":"The price of one item of this type of commodity.","example":3000},"weightUnit":{"type":"string","description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"Weight of the item.","example":0.1},"hSTariffCode":{"type":"string","description":"The destination country's tariff-classification number (HS code) for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and then add digits for more detail. The maximum length for an HS code is 14 characters. The HS code will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. HS Code is required for RMG b2b shipment.","example":"AST559"},"originCountryCode":{"type":"string","description":"The two-character ISO country code of the shipment's origin country. Use ISO 3166-1 Alpha-2 standard values.","example":"US"}}}},"customsDocuments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to attach Electronic Trade Documents (ETDs) to your DHL international shipment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item should represent a document uploaded previously using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For DHL, if you pass this field, ensure the selected service type is PAPERLESS."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"s3FileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be taken from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic trade document must upload before shipment label creation."},"children":[]}]}]}]}],"items":{"type":"object","required":["fileName","s3FileId","documentType"],"properties":{"fileName":{"type":"string","description":"The name of the uploaded trade document file.","example":"invoice.pdf"},"s3FileId":{"type":"string","description":"The relative file path where the document is stored in the S3 bucket.","example":"uploads/shipping/intl_docs/sa58a03/0oa2bxnhu03i48mh50h8/NJ3ww7gv73kwDJK/DRNgGjEraOvV8ZB_invoice.pdf"},"documentType":{"type":"string","enum":["INVOICE","COMMERCIAL_INVOICE","PROFORMA_INVOICE","CERTIFICATE_OF_ORIGIN","NAFTA_CERTIFICATE_OF_ORIGIN","CUSTOMS_DECLARATION_FORM","AIR_WAYBILL_AND_WAYBILL"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the uploaded document. This value is referenced when generating customs declarations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must match the type used during document upload."},"children":[]}]}]}],"example":"INVOICE"}}}}}}}}},"components/schemas/internationalShipmentResponseV2":{"id":"components/schemas/internationalShipmentResponseV2","kind":"json-schema","title":"internationalShipmentResponseV2","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"5ecfa0ecc6454caeb90cxxxxxxxxxxx"},"shipmentId":{"type":"string","description":"A unique identifier shipment tracking number.","example":"USPS2200692189973693"},"parcelTrackingNumber":{"type":"string","description":"The unique tracking number assigned to the parcel for tracking purposes.","example":"CE956743785US"},"labelLayout":{"type":"array","description":"Details about the shipping label generated.","items":{"type":"object","properties":{"contentType":{"type":"string","description":"Specifies how the label content is encoded.","enum":["BASE64","URL"],"example":"URL"},"contents":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL to access the label document if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the Base64-encoded data if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASE64"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://prv-labels-cls.gcs.pitneycloud.com/usps/910187923/outbound/label/5ecfa0ecc6454caeb90c55d35229de90.pdf"},"fileFormat":{"type":"string","description":"Defines the format of the label document.","example":"PDF"},"size":{"type":"string","description":"Specifies the label size of the shipment.","example":"DOC_4X6"},"type":{"type":"string","description":"Defines the type of the shipment.","enum":["SHIPPING_LABEL"],"example":"SHIPPING_LABEL"}}}},"parcel":{"type":"object","description":"Details of the parcel being shipped.","properties":{"length":{"type":"integer","format":"int32","description":"Length of the parcel. Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"height":{"type":"integer","format":"int32","description":"Height of the parcel. By convention, the height is the smallest dimension of the parcel.","example":1},"width":{"type":"integer","format":"int32","description":"Width of the parcel. There is no strict rule as to which element is the width or the height, but typically, by convention the width is the second greatest dimension of a parcel.","example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","example":"OZ","enum":["OZ"]},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":2},"packageValue":{"type":"number","description":"Declared value of the package.","example":2}}},"rate":{"type":"object","description":"Details of the shipping rate.","properties":{"baseCharge":{"type":"number","format":"float","description":"The base service charge is payable to the carrier, excluding special service charges.","example":40.91},"carrier":{"type":"string","description":"The carrier used for the shipment. Carrier is a service used to transport the parcels or couriers from one place to another.","example":"USPS"},"currencyCode":{"type":"string","description":"Currency used for the shipping charges. It is a three-character (all uppercase letter) symbol of a currency according to the international ISO standard. As a rule, the first two letters denote the name of the country, and the third letter, the name of the currency thereof. For example, for US - the currency is Dollars and code is USD. Similarly for Canada, the currencycode is CAD, and for India, it is INR.","example":"USD"},"deliveryCommitment":{"type":"object","description":"Check for estimated delivery date, guarantee (if any), and number of days for shipment to be delivered.","properties":{"additionalDetails":{"type":"string","description":"Additional information about the delivery.","example":"6 - 10 business days to many major markets"},"guarantee":{"type":"string","description":"Checks if there is any guarantee or committment for shipment delivery.","example":"NONE"},"maxEstimatedNumberOfDays":{"type":"string","description":"Maximum number of estimated days for delivery.","example":"10"},"minEstimatedNumberOfDays":{"type":"string","description":"Minimum number of estimated days for delivery.","example":"6"}}},"inductionPostalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used."},"children":[]}]}]}],"example":"92630"},"parcelType":{"type":"string","description":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. ParcelType have categories like Package, Envelopes, Paks, Boxes, Tube, etc.","example":"PKG"},"rateTypeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate type identifier. Its value can be CONTRACT_RATES, COMMERCIAL or COMMERCIAL_BASE for USPS and COMMERCIAL for other carriers depending on the Pitney Bowes contract/subscription."},"children":[]}]}]}],"example":"CONTRACT_RATES"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"PMI"},"totalCarrierCharge":{"type":"number","format":"float","description":"Total charges for the carrier service including special service fees, surcharges, and any international taxes and duties.","example":40.91},"publishedTotalCarrierCharge":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount based on the carrier's standard (published) rates, including base charges, surcharges, special services, discounts, and applicable taxes. This value reflects the amount the carrier would charge without any negotiated discounts or platform-specific rate adjustments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only when supported by the carrier (e.g., FedEx, UPS, DHL, USPS).\""},"children":[]}]}]}]}],"example":73.12}}},"references":{"type":"object","description":"References associated with the shipment.","properties":{"reference1":{"type":"string","description":"Reference 1.","example":"123456"},"reference2":{"type":"string","description":"Reference 2.","example":"SendTech"},"reference3":{"type":"string","description":"Reference 3.","example":"98437"},"reference4":{"type":"string","description":"Reference 4.","example":"FedEx Overnight Shipping"},"department":{"type":"string","description":"Department name associated with the shipment.","example":"Name department"},"poNumber":{"type":"string","description":"Purchase order number.","example":"R2W 2H2"},"additionalReference1":{"type":"string","description":"Additional reference 1.","example":"612987641"},"additionalReference2":{"type":"string","description":"Additional reference 2.","example":"989"}}},"print":{"type":"object","description":"Details of the print operation.","properties":{"status":{"type":"string","description":"Status of the print operation.","example":"error"},"jobId":{"type":"string","description":"Job ID for the print operation.","example":"0244nOWpqlgzE2n"},"error":{"type":"object","description":"Details of the print error.","properties":{"code":{"type":"string","description":"Error code for the print operation.","example":"not_found"},"message":{"type":"string","description":"Error message for the print operation.","example":"printer not found for given alias: test"},"additionalCode":{"type":"string","description":"Additional error code.","example":"DH_NF_20002"},"additionalInfo":{"type":"string","description":"Additional information about the error.","example":"Alias name not found, please create a printer mapping"}}}}},"fromAddress":{"$ref":"#/components/schemas/fromAddressV2internationalResponse"},"toAddress":{"$ref":"#/components/schemas/toAddressV2internationalResponse"},"soldToAddress":{"$ref":"#/components/schemas/soldToAddressV2"},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by USPS, FedEx, UPS, and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}},"shipmentOptions":{"type":"object","description":"Options for the shipment.","properties":{"addToManifest":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The option asks if the shipment is to be added for Manifest, so that the shipment will reflect in the Manifest Form while compilation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value can be 'true' or 'false'. Applicable for USPS and CPC carriers."},"children":[]}]}]}],"example":true},"billingWeight":{"type":"string","description":"The weight used by the carrier to calculate the shipping cost. This value is determined as the greater of the actual weight and the dimensional weight.\n","example":"128.0"},"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"}}},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"customs":{"type":"object","description":"Customs information required for international shipments.","required":["customsInfo","customsItems"],"properties":{"customsInfo":{"type":"object","description":"This is additional customs information required along with item details.","required":["reasonForExport","customsDeclaredValue","currencyCode"],"properties":{"reasonForExport":{"type":"string","description":"Reason for exporting the items.","example":"DOCUMENTS","enum":["GIFT","COMMERCIAL_SAMPLE","MERCHANDISE","DOCUMENTS","RETURNED_GOODS","OTHER"]},"comments":{"type":"string","description":"Free-form comments regarding the exported shipment.","example":"Test comment"},"invoiceNumber":{"type":"string","description":"The commercial invoice number assigned by the exporter.","example":"001189223"},"importerCustomsReference":{"type":"string","description":"A reference number used by the importer, such as a VAT number, PO number, or insured number.","example":"987654"},"sdrValue":{"type":"number","format":"float","description":"When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values.","example":23.32},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"currencyCode":{"type":"string","description":"The currency used for declared value. Use three uppercase letters, per ISO 4217.","example":"USD"},"fromCustomsReference":{"type":"string","description":"Free-form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.","example":"EFEFE4554545"},"licenseNumber":{"type":"string","description":"The export license number associated with the commodity.","example":"456ABC123"},"certificateNumber":{"type":"string","description":"The certificate number associated with the commodity.","example":"987"},"customsDeclaredValue":{"type":"number","description":"Item value in mentioned currencyCode.","example":6000},"termsOfSale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the delivery and payment terms between the shipper and recipient. Currenty supported by carriers - UPS, FedEx and DHL. - Common values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CIP: Carriage and Insurance Paid to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPT: Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAP: Delivered at Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAT: Delivered at Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DDP: Delivered Duty Paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXW: Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FCA: Free Carrier"},"children":[]}]}]}]}],"example":"DDP","enum":["CIP","CPT","DAP","DAT","DDP","EXW","FCA"]}}},"customsItems":{"type":"array","description":"Items included in the customs declaration.","required":["description","quantity","unitPrice","weight","weightUnit"],"items":{"type":"object","properties":{"description":{"type":"string","description":"A detailed description of the commodity, up to 255 characters. The description will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Each description will appear on the form.","example":"Books"},"itemId":{"type":"string","description":" This is the unique identifier for the commodity.","example":"item1234"},"orderNumber":{"type":"string","description":"The unique identifier for the order.","example":"ORD1234"},"quantity":{"type":"number","description":"Enter the total number of items of this type of commodity.","example":1},"unitPrice":{"type":"number","format":"float","description":"The price of one item of this type of commodity.","example":3000},"weightUnit":{"type":"string","description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"Weight of the item.","example":0.1},"hSTariffCode":{"type":"string","description":"The destination country's tariff-classification number (HS code) for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and then add digits for more detail. The maximum length for an HS code is 14 characters. The HS code will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. HS Code is required for RMG b2b shipment.","example":"AST559"},"originCountryCode":{"type":"string","description":"The two-character ISO country code of the shipment's origin country. Use ISO 3166-1 Alpha-2 standard values.","example":"US"}}}},"customsDocuments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to attach Electronic Trade Documents (ETDs) to your DHL international shipment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item should represent a document uploaded previously using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For DHL, if you pass this field, ensure the selected service type is PAPERLESS."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"s3FileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be taken from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic trade document must upload before shipment label creation."},"children":[]}]}]}]}],"items":{"type":"object","required":["fileName","s3FileId","documentType"],"properties":{"fileName":{"type":"string","description":"The name of the uploaded trade document file.","example":"invoice.pdf"},"s3FileId":{"type":"string","description":"The relative file path where the document is stored in the S3 bucket.","example":"uploads/shipping/intl_docs/sa58a03/0oa2bxnhu03i48mh50h8/NJ3ww7gv73kwDJK/DRNgGjEraOvV8ZB_invoice.pdf"},"documentType":{"type":"string","enum":["INVOICE","COMMERCIAL_INVOICE","PROFORMA_INVOICE","CERTIFICATE_OF_ORIGIN","NAFTA_CERTIFICATE_OF_ORIGIN","CUSTOMS_DECLARATION_FORM","AIR_WAYBILL_AND_WAYBILL"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the uploaded document. This value is referenced when generating customs declarations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must match the type used during document upload."},"children":[]}]}]}],"example":"INVOICE"}}}}}}}}},"components/schemas/fromAddressV2internationalResponse":{"id":"components/schemas/fromAddressV2internationalResponse","kind":"json-schema","title":"fromAddressV2internationalResponse","data":{"type":"object","description":"The complete address of the Sender.","properties":{"name":{"type":"string","description":"The name of the Sender to which this address points.","example":"Sender Name"},"addressLine1":{"type":"string","description":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender. ","example":"24182 Kathy Ave"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town the Sender's address belongs to. ","example":"Lake Forest"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the State or Province the Sender belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US or Canadian address(es). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please switch to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" radio button, enter the required country name or country code, and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button."},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#iso:code:3166:CA","description":"List of Province with their Province/State Codes."},"example":"CA"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code or ZIP Code of the address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For CA addresses, it is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"six-character"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alphanumeric string Postal Code in this format: 'A1A 1A1'. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" While for US addresses, it is either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code in one of the following formats: '12345' or '12345-6789'."},"children":[]}]}]}],"example":"92630-1827"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country in which the sender's address is located. The value is the two-character ISO Code of the country from the ISO country list. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is ISO 3166-1 Alpha-2 standard values. This is included for the best results of search, especially if the country name does not appear in any of the unparsedAddressLines. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink, please select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button."},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#search","description":"List of Countries with their ISO Codes"},"example":"US"},"company":{"type":"string","description":"The name of the company, in case if the sender address is not residential. ","example":"PB"},"phone":{"type":"string","description":"This is sender's phone number. The digits can be with or without spaces or hyphens. ","example":"203-555-1214"},"email":{"type":"string","description":"This is sender's valid email. Email is required if the customer is using GoFor Carrier.  ","example":"test2user@gmail.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value is 'true', else it is 'false'.","example":true},"status":{"type":"string","description":"The validation status of the sender's address.","example":"VALIDATED_AND_NOT_CHANGED"}}}},"components/schemas/toAddressV2internationalResponse":{"id":"components/schemas/toAddressV2internationalResponse","kind":"json-schema","title":"toAddressV2internationalResponse","data":{"type":"object","description":"The complete address of the Sender.","properties":{"name":{"type":"string","description":"The name of the Sender to which this address points.","example":"Recipient Name"},"addressLine1":{"type":"string","description":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender. ","example":"771 Atlantic Ave"},"cityTown":{"type":"string","description":"The name of the city or town the Sender's address belongs to. ","example":"BRAMPTON"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the State or Province the Sender belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US or Canadian address(es). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please switch to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" radio button, enter the required country name or country code, and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button."},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#iso:code:3166:CA","description":"List of Province with their Province/State Codes."},"example":"ON"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code or ZIP Code of the address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For CA addresses, use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"six-character"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alphanumeric string Postal Code in this format: 'A1A 1A1'. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" While for US addresses, use either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code in one of the following formats: '12345' or '12345-6789'."},"children":[]}]}]}],"example":"L6Y 2N4"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country in which the sender's address is located. The value will be the two-character ISO Code of the country from the ISO country list. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink, please select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button."},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#search","description":"List of Countries with their ISO Codes"},"example":"CA"},"company":{"type":"string","description":"The name of the company, in case if the recipient address is not residential. Recipient company is required for RMG b2b shipment.","example":"PB"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is Recipient's phone number. Enter the digits with or without spaces or hyphens. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"332 555-1212"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be recipient's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"recipient@gmail.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"isPOBox":{"type":"boolean","description":"Checks if the specified address has the PO Box. In case if Yes, the boolean value will be 'true', else it will take 'false'.","example":true},"taxId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tax Identification Number (TIN). TIN Number is supported for FedEx as of now."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max character length = 18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOSS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EORI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_UNION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 12 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 13 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"taxIdType":{"type":"string","description":"Specifies the type of tax identification being provided.","enum":["EIN","GST","VAT","IOSS","RFC","EORI"]}}}},"components/schemas/RateShopbyCarrier":{"id":"components/schemas/RateShopbyCarrier","kind":"json-schema","title":"By Carrier","data":{"title":"By Carrier","type":"object","required":["toAddress","parcel","parcelType","rateShopBy","labelSize","labelType","labelFormat"],"properties":{"fromAddress":{"$ref":"#/components/schemas/fromAddressV2"},"toAddress":{"$ref":"#/components/schemas/toAddressV2"},"parcel":{"$ref":"#/components/schemas/parcelV2"},"specialServices":{"$ref":"#/components/schemas/SpecialService"},"parcelType":{"type":"string","description":"Parcel type for a single-parcel request.","example":"PKG"},"rateShopBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RateShop, which is attached to an Enterprise or Location, is done through four approaches: by Carrier, by RateGroup, by RuleSet and by ShipViaCode.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  Through Carrier, customers can choose the carriers as per requirement, based on which services, parcel types, and special services can be selected, and RateShop is done. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RateGroup, customers can select the RateGroup, which has been divided into two categories: Cheapest (w.r.t. price) and Fastest (w.r.t. delivery hours).  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RuleSet, customers can define the Condition/rule for selecting carriers and their services, so they do not need to worry for Rate Shopping every time they create Shipment. For example, For a particular location, they can set one definite carrier, or apply RateGroup - Cheapest/Fastest.   Similarly, for a particular amount like below $1000 Dollars, they can select a definite carrier service, based on RateGroup."},"children":[]}]}]}],"example":"carrier","enum":["carrier","rateGroup","ruleSet"]},"byCarrier":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the carrier and service configuration used for rate retrieval in Rate Shipment V2"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object enables the following use cases:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Shop for a Single Carrier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve all available rates from the specified carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single Rate Retrieval by Service ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Provide both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve a single rate corresponding to the specified service."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Shop Across Carriers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Omit this object to retrieve rates from all carriers available under the current subscription."},"children":[]}]}]}]}],"properties":{"carrierAccountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a unique identifier associated with the specific sub-carrier account, which must be valid."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This is used in the shipment creation (if this value is defined, Carrier properties will be skipped)."},"children":[]}]}]}],"example":"JjjbmYyAz9B3"},"carrier":{"type":"string","description":"A unique identifier associated with the specific carrier, i.e. CarrierID, which must be valid.","example":"Fedex"},"service":{"type":"string","description":"Indicates a unique identifier associated with the carrier specific service, which is ServiceID, which must be valid. Required only when requesting a specific service rate from the given carrier.","example":"3DA"}}},"deliveryOption":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two options of delivery: deliverBy and useBestNextDate, where customer can schedule the delivery date in deliverBy. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In case if the customer's scheduled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date falls under Holiday, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useBestNextDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used by our system. Then, we will mark the second option and deliver the same."},"children":[]}]}]}],"properties":{"deliverBy":{"type":"string","format":"date","description":"Delivery date is the target delivery date for the shipment. When specified, the API returns only those rate quotes that can commit to delivering the shipment on or before this date. The value must be in the YYYY-MM-DD format.","example":"2024-03-20"},"useBestNextDate":{"type":"boolean","description":"When set to true, if the specified Deliver By date falls on a holiday, the API will return rate quotes based on the next available business day delivery commitment.","example":false}}}}}},"components/schemas/RateShopbyShipViaCode":{"id":"components/schemas/RateShopbyShipViaCode","kind":"json-schema","title":"By ShipCode","data":{"title":"By ShipCode","type":"object","required":["toAddress","parcel","rateShopBy","labelSize","labelType","labelFormat"],"properties":{"fromAddress":{"$ref":"#/components/schemas/fromAddressV2"},"toAddress":{"$ref":"#/components/schemas/toAddressV2"},"parcel":{"type":"object","description":"Parcel details, including dimensions and weight.","properties":{"length":{"type":"number","description":"Length of the parcel. ength is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"number","description":"Width of the parcel. There is no strict rule as to which element is the width or the height, but the width is the second greatest dimension of a parcel by convention.","example":1},"height":{"type":"number","description":"Height of the parcel. By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"Unit for dimensions.","enum":["IN","CM"],"example":"IN"},"weightUnit":{"type":"string","description":"Unit for weight.","example":"OZ","enum":["OZ","GM"]},"weight":{"type":"number","description":"Weight of the parcel.","example":2},"packageValue":{"type":"number","description":"Declared value of the parcel.","example":2}}},"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ParcelType can have categories like Package, Envelopes, Paks, Boxes, Tube, etc. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Rate Shop by Custom Carrier Code, the parcelType field in the request payload is optional:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the parcel type is defined in the Custom Carrier Code metadata, it does not need to be provided in the request payload."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the parcel type is not defined in the Custom Carrier Code, it must be provided in the request payload."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If parcel type is provided in both the request payload and Custom Carrier Code, then  request payload value will be overridden by the values defined in the Custom Carrier Code."},"children":[]}]}]}]}]}],"example":"PKG"},"specialServices":{"$ref":"#/components/schemas/SpecialService"},"rateShopBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RateShop, which is attached to an Enterprise or Location, is done through four approaches: by Carrier, by RateGroup, by RuleSet and by ShipViaCode.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  Through Carrier, customers can choose the carriers as per requirement, based on which services, parcel types, and special services can be selected, and RateShop is done. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RateGroup, customers can select the RateGroup, which has been divided into two categories: Cheapest (w.r.t. price) and Fastest (w.r.t. delivery hours).  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RuleSet, customers can define the Condition/rule for selecting carriers and their services, so they do not need to worry for Rate Shopping every time they create Shipment. For example, For a particular location, they can set one definite carrier, or apply RateGroup - Cheapest/Fastest.   Similarly, for a particular amount like below $1000 Dollars, they can select a definite carrier service, based on RateGroup."},"children":[]}]}]}],"example":"shipViaCode","enum":["carrier","rateGroup","ruleSet","shipViaCode"]},"byShipViaCode":{"type":"object","required":["code"],"description":"The rates are fetched by using a predefined custom Carrier Code.","properties":{"code":{"type":"string","description":"Pre-generated code (Custom Carrier Code) that bundles carrier, carrier account, parcel type, service, and special services. When provided, it overrides the corresponding fields in the request payload, eliminating the need to pass them individually."}}},"deliveryOption":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two options of delivery: deliverBy and useBestNextDate, where customer can schedule the delivery date in deliverBy. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In case if the customer's scheduled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date falls under Holiday, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useBestNextDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used by our system. Then, we will mark the second option and deliver the same."},"children":[]}]}]}],"properties":{"deliverBy":{"type":"string","format":"date","description":"Delivery date is the target delivery date for the shipment. When specified, the API returns only those rate quotes that can commit to delivering the shipment on or before this date. The value must be in the YYYY-MM-DD format.","example":"2024-03-20"},"useBestNextDate":{"type":"boolean","description":"When set to true, if the specified Deliver By date falls on a holiday, the API will return rate quotes based on the next available business day delivery commitment.","example":false}}}}}},"components/schemas/RateShopbyExternalSystemCode":{"id":"components/schemas/RateShopbyExternalSystemCode","kind":"json-schema","title":"By ExternalCode","data":{"title":"By ExternalCode","type":"object","required":["toAddress","parcel","rateShopBy"],"properties":{"fromAddress":{"$ref":"#/components/schemas/fromAddressV2"},"toAddress":{"$ref":"#/components/schemas/toAddressV2"},"parcel":{"type":"object","description":"Parcel details, including dimensions and weight.","properties":{"length":{"type":"number","description":"Length of the parcel. ength is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"number","description":"Width of the parcel. There is no strict rule as to which element is the width or the height, but the width is the second greatest dimension of a parcel by convention.","example":1},"height":{"type":"number","description":"Height of the parcel. By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"Unit for dimensions.","enum":["IN","CM"],"example":"IN"},"weightUnit":{"type":"string","description":"Unit for weight.","example":"OZ","enum":["OZ","GM"]},"weight":{"type":"number","description":"Weight of the parcel.","example":2},"packageValue":{"type":"number","description":"Declared value of the parcel.","example":2}}},"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ParcelType can have categories like Package, Envelopes, Paks, Boxes, Tube, etc. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \""},"children":[]}]}]}],"example":"PKG"},"specialServices":{"$ref":"#/components/schemas/SpecialService"},"rateShopBy":{"type":"string","description":"Specifies that shipment creation uses a predefined configuration from an external system. When externalSystemCode is selected, the system retrieves carrier, account, service, and parcel details based on the external system codes provided in the request. ","example":"externalSystemCode","enum":["carrier","rateGroup","ruleSet","shipViaCode","externalSystemCode"]},"byExternalSystemCode":{"$ref":"#/components/schemas/byExternalSystemCodeV2"}}}},"components/schemas/RateShopbyRategroup":{"id":"components/schemas/RateShopbyRategroup","kind":"json-schema","title":"By rateGroup","data":{"title":"By rateGroup","type":"object","required":["toAddress","parcel","parcelType","rateShopBy","byRateGroup","labelSize","labelType","labelFormat"],"properties":{"fromAddress":{"$ref":"#/components/schemas/fromAddressV2"},"toAddress":{"$ref":"#/components/schemas/toAddressV2"},"parcel":{"type":"object","description":"Parcel details, including dimensions and weight.","properties":{"length":{"type":"number","description":"Length of the parcel. ength is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"number","description":"Width of the parcel. There is no strict rule as to which element is the width or the height, but the width is the second greatest dimension of a parcel by convention.","example":1},"height":{"type":"number","description":"Height of the parcel. By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"Unit for dimensions.","enum":["IN","CM"],"example":"IN"},"weightUnit":{"type":"string","description":"Unit for weight.","example":"OZ","enum":["OZ","GM"]},"weight":{"type":"number","description":"Weight of the parcel.","example":2},"packageValue":{"type":"number","description":"Declared value of the parcel.","example":2}}},"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ParcelType can have categories like Package, Envelopes, Paks, Boxes, Tube, etc. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \""},"children":[]}]}]}],"example":"PKG"},"specialServices":{"$ref":"#/components/schemas/SpecialService"},"rateShopBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RateShop, which is attached to an Enterprise or Location, is done through four approaches: by Carrier, by RateGroup, by RuleSet and by ShipViaCode.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  Through Carrier, customers can choose the carriers as per requirement, based on which services, parcel types, and special services can be selected, and RateShop is done. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RateGroup, customers can select the RateGroup, which has been divided into two categories: Cheapest (w.r.t. price) and Fastest (w.r.t. delivery hours).  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RuleSet, customers can define the Condition/rule for selecting carriers and their services, so they do not need to worry for Rate Shopping every time they create Shipment. For example, For a particular location, they can set one definite carrier, or apply RateGroup - Cheapest/Fastest.   Similarly, for a particular amount like below $1000 Dollars, they can select a definite carrier service, based on RateGroup."},"children":[]}]}]}],"example":"rateGroup","enum":["carrier","rateGroup","ruleSet"]},"byRateGroup":{"type":"object","required":["ruleType","rateGroupId"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the category to select how cheap the carrier service is, or which carrier has fastest service. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It displays the list of those services."},"children":[]}]}]}],"properties":{"ruleType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Rule Type is a condition applied to RateGroup by Product side as per the customer requirement, which can have following options: Cheapest, Fastest, and deliverBy."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If ruleType is deliverBy, then deliverBy date under deliveryOption will be mandatory to provide."},"children":[]}]}]}],"example":"Cheapest","enum":["Cheapest","Fastest","ALL","DeliverBy"]},"rateGroupId":{"type":"string","description":"This is a unique identifier assigned to the created RateGroup, which is used in the shipment creation.","example":"9bzUUq2w70h7"}}},"deliveryOption":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two options of delivery: deliverBy and useBestNextDate, where customer can schedule the delivery date in deliverBy. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In case if the customer's scheduled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date falls under Holiday, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useBestNextDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used by our system. Then, we will mark the second option and deliver the same."},"children":[]}]}]}],"properties":{"deliverBy":{"type":"string","format":"date","description":"Delivery date is the target delivery date for the shipment. When specified, the API returns only those rate quotes that can commit to delivering the shipment on or before this date. The value must be in the YYYY-MM-DD format.","example":"2024-03-20"},"useBestNextDate":{"type":"boolean","description":"When set to true, if the specified Deliver By date falls on a holiday, the API will return rate quotes based on the next available business day delivery commitment.","example":false}}}}}},"components/schemas/RateShopbyRuleset":{"id":"components/schemas/RateShopbyRuleset","kind":"json-schema","title":"By RuleSet","data":{"title":"By RuleSet","type":"object","required":["toAddress","parcel","parcelType","rateShopBy","byRuleSet","labelSize","labelType","labelFormat"],"properties":{"fromAddress":{"$ref":"#/components/schemas/fromAddressV2"},"toAddress":{"$ref":"#/components/schemas/toAddressV2"},"parcel":{"type":"object","description":"Parcel details, including dimensions and weight.","properties":{"length":{"type":"number","description":"Length of the parcel. ength is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"number","description":"Width of the parcel. There is no strict rule as to which element is the width or the height, but the width is the second greatest dimension of a parcel by convention.","example":1},"height":{"type":"number","description":"Height of the parcel. By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"Unit for dimensions.","enum":["IN","CM"],"example":"IN"},"weightUnit":{"type":"string","description":"Unit for weight.","example":"OZ","enum":["OZ","GM"]},"weight":{"type":"number","description":"Weight of the parcel.","example":2},"packageValue":{"type":"number","description":"Declared value of the parcel.","example":2}}},"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ParcelType can have categories like Package, Envelopes, Paks, Boxes, Tube, etc. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \""},"children":[]}]}]}],"example":"PKG"},"specialServices":{"$ref":"#/components/schemas/SpecialService"},"rateShopBy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RateShop, which is attached to an Enterprise or Location, is done through four approaches: by Carrier, by RateGroup, by RuleSet and by ShipViaCode.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  Through Carrier, customers can choose the carriers as per requirement, based on which services, parcel types, and special services can be selected, and RateShop is done. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RateGroup, customers can select the RateGroup, which has been divided into two categories: Cheapest (w.r.t. price) and Fastest (w.r.t. delivery hours).  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Through RuleSet, customers can define the Condition/rule for selecting carriers and their services, so they do not need to worry for Rate Shopping every time they create Shipment. For example, For a particular location, they can set one definite carrier, or apply RateGroup - Cheapest/Fastest.   Similarly, for a particular amount like below $1000 Dollars, they can select a definite carrier service, based on RateGroup."},"children":[]}]}]}],"example":"ruleSet","enum":["carrier","rateGroup","ruleSet"]},"byRuleSet":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User can create the Shipment using Rule Set."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" By Rule Set means a rule that is defined as one or more conditions resulting in an action (or more than one action). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The conditions and actions can vary widely."},"children":[]}]}]}],"properties":{"ruleType":{"type":"string","description":"The Rule Type is a condition applied to RateGroup by Product side, which can be applicable for a client or set of client users.","example":"Cheapest","enum":["Cheapest","Fastest"]},"shipOption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A user-defined label to categorize shipments based on delivery priority, speed, or service level.This field is  used to define internal shipping strategies such as:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STANDARD,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPRESS,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAMEDAY,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TWODAY,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OVERNIGHT, etc."},"children":[]}]}]}]}],"example":"STANDARD"}}}}}},"components/schemas/SubscriptionCapabilitiesRequest":{"id":"components/schemas/SubscriptionCapabilitiesRequest","kind":"json-schema","title":"SubscriptionCapabilitiesRequest","data":{"type":"object","required":["originCountryCode","capabilities"],"additionalProperties":false,"properties":{"originCountryCode":{"type":"string","description":"Two-letter ISO 3166-1 alpha-2 country code (shipment origin country) to which the allowlist applies.","example":"US"},"capabilities":{"type":"object","description":"Carrier-specific capability codes to allow for the subscription and origin country.","properties":{"parcelTypes":{"type":"array","description":"Package codes allowed in shipment calls for this subscription. Only these codes will be accepted by Rate Shipment and Create Shipment calls. Set only what you intend to use; others will be rejected. If omitted, the current allowlist (or carrier-supported defaults) remains in effect.","items":{"type":"string"},"example":["LP"]},"services":{"type":"array","description":"Service codes allowed in shipment calls for this subscription. Only these codes will be accepted in Rate Shipment and Create Shipment calls. Set only what you intend to use; others will be rejected. If omitted, the current allowlist (or carrier-supported defaults) remains in effect.","items":{"type":"string"},"example":["NDA"]},"specialServices":{"type":"array","description":"Special service codes allowed in shipment calls for this subscription. Only these codes will be accepted by Rate Shipment and Create Shipment calls. Set only what you intend to use; others will be rejected. If omitted, the current allowlist (or carrier-supported defaults) remains in effect.","items":{"type":"string"},"example":["INS"]}}}}}},"components/schemas/returnLabel":{"id":"components/schemas/returnLabel","kind":"json-schema","title":"returnLabel","data":{"type":"object","properties":{"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (8' X 11').","enum":["DOC_8X11"],"example":"DOC_8X11"},"type":{"type":"string","description":"Defines the type of the Shipment, e.g., Shipping Label.","example":"SHIPPING_LABEL","enum":["SHIPPING_LABEL"]},"fromAddress":{"type":"object","required":["addressLine1"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the sender address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"email id ","example":"watervw@gmail.com"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'."}}},"parcel":{"type":"object","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"integer","format":"int32","description":"Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"integer","format":"int32","description":"There is no strict rule as to which element is the width or the height, but typically, by convention the width is the second greatest dimension of a parcel.","example":1},"height":{"type":"integer","format":"int32","description":"By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","enum":["OZ"],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":1}}},"carrierAccountId":{"type":"string","example":"asas2223","description":"The unique identifier associated with the Carrier account used by client users during shipment process.","x-go-name":"carrierAccountId"},"parcelType":{"type":"string","example":"LTR","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. It has categories like Package, Envelopes, Paks, Boxes, Tube, defined per specific carrier and used in abbreviated form, e.g., FRPKG, LGENV, TUBE, PKG."},"children":[]}]}]}]}],"x-go-name":"ParcelType"},"parcelId":{"type":"string","description":"A unique identifier associated with the Parcel.","example":"LR"},"serviceId":{"type":"string","example":"NDA","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-A unique identifier given to the carrier-specific service. This is required for creating a shipment, while it is optional for rating a parcel."},"children":[]}]}]}]}],"x-go-name":"serviceId"},"specialServices":{"type":"array","items":{"type":"object","description":"This object is required to pass when to create UPS return label and is optional for FedEx","properties":{"specialServiceId":{"type":"string","example":"PRL","description":"PRL is the return label special service"},"inputParameters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"RETURN_PKG_DESCRIPTION","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It takes the input parameters. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURN_PKG_DESCRIPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for UPS and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RMA_NUMBER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for FedEx"},"children":[]}]}]}]},"value":{"type":"string","example":"test","description":"It specifies the input value"}}}}}}},"shipmentOptions":{"$ref":"#/components/schemas/shipmentOptions"},"metadata":{"type":"array","description":"Additional metadata that needs to be stored for this shipment can be added here. For now, 'Cost Account Name' is supported.","items":{"type":"object","properties":{"name":{"type":"string","example":"costAccountName"},"value":{"type":"string","example":"cost account 123"}}}},"toAddress":{"type":"object","required":["addressLine1"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"762 Atlantic Ave"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"email":{"type":"string","description":"Email id","example":"email@gmail.com"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Rochester"},"countryCode":{"type":"string","description":"The two-character ISO Code of the destination country from this ISO country list.\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Rufous Sirius Canid"},"company":{"type":"string","description":"The name of the company, in case if the sender address is not residential.","example":"ABC Company"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"14609"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"NY"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}}}}},"components/schemas/returnLabelResponse":{"id":"components/schemas/returnLabelResponse","kind":"json-schema","title":"returnLabelResponse","data":{"type":"object","properties":{"fromAddress":{"type":"object","required":["addressLine1"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the sender address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"email id ","example":"watervw@gmail.com"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'."}}},"parcel":{"type":"object","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"integer","format":"int32","description":"Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"integer","format":"int32","description":"There is no strict rule as to which element is the width or the height, but typically, by convention the width is the second greatest dimension of a parcel.","example":1},"height":{"type":"integer","format":"int32","description":"By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","enum":["OZ"],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":1}}},"correlationId":{"type":"string","example":"asas2223","description":"Key assigned by the shipping system to the transaction.","x-go-name":"correlationId"},"serviceId":{"type":"string","example":"PMI","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-A unique identifier given to the carrier-specific service. This is required for creating a shipment, while it is optional for rating a parcel."},"children":[]}]}]}]}],"x-go-name":"serviceId"},"parcelTrackingNumber":{"type":"string","example":"UPS2200616731485645","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-A unique identifier parcel tracking number"},"children":[]}]}]}]}],"x-go-name":"parcelTrackingNumber"},"shipmentId":{"type":"string","example":"UPS2200616731485645","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-A unique identifier shipment tracking number"},"children":[]}]}]}]}],"x-go-name":"shipmentId"},"shipmentOptions":{"$ref":"#/components/schemas/shipmentOptions"},"labelLayout":{"type":"array","description":"labelLayout details","items":{"type":"object","properties":{"contentType":{"type":"string","example":"URL"},"contents":{"type":"string","example":"https://prv-labels.gcs.pitneycloud.com/f27ab422546045ae95d10fa810586e29.pdf"},"fileFormat":{"type":"string","example":"PDF"},"size":{"type":"string","example":"DOC_8X11"},"type":{"type":"string","example":"SHIPPING_LABEL"}}}},"toAddress":{"type":"object","required":["addressLine1"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"70 Hanlan RD"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the receiver address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"Email id","example":"email@gmail.com"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Woodbridge"},"countryCode":{"type":"string","description":"The two-character ISO Code of the destination country from this ISO country list.\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"CA"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"L4L3P6"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"ON"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"rate":{"type":"object","properties":{"baseCharge":{"type":"number","example":30.1,"description":"Description"},"carrier":{"type":"string","example":"UPS","description":"Description"},"currencyCode":{"type":"string","example":"USD","description":"Description"},"parcelType":{"type":"string","example":"LTR","description":"Description"},"rateTypeId":{"type":"string","example":"COMMERCIAL","description":"Description"},"serviceId":{"type":"string","example":"NDA","description":"Description"},"specialServices":{"type":"array","items":{"type":"object","properties":{"specialServiceId":{"type":"string","example":"PRL","description":"Description"},"inputParameters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"RETURN_PKG_DESCRIPTION","description":"Description"},"value":{"type":"string","example":"test","description":"Description"}}}},"fee":{"type":"number","example":1.05,"description":"Description"}}}},"surcharges":{"type":"array","items":{"type":"object","properties":{"fee":{"type":"number","example":5.88,"description":"Description"},"name":{"type":"string","example":"UPS","description":"Description"}}}},"totalCarrierCharge":{"type":"number","example":39.56,"description":"Description"}}}}}},"components/schemas/SignatureFileResponse":{"id":"components/schemas/SignatureFileResponse","kind":"json-schema","title":"SignatureFileResponse","data":{"type":"object","properties":{"shipmentId":{"type":"string","description":"Indicates the shipment identifier, a unique identifier for an individual shipment.","example":"USPS2200592809609000","x-go-name":"Name"},"signatureFileURL":{"type":"string","description":"A link or URL that consists of Proof of Delivery (POD) - Recipient's Signature image file. Clicking the link will download the POD Signature.","example":"https://api-sandbox.pitneybowes.com/shippingservices/v1/shipments/210000000000000000/sig.jpg","x-go-name":"Name"}}}},"components/schemas/CancelStampsRequestERR":{"id":"components/schemas/CancelStampsRequestERR","kind":"json-schema","title":"CancelStampsRequestERR","data":{"type":"object","properties":{"stampIds":{"type":"array","description":" This is a list of StampIDs which is used for cancelling ERR postage.","items":{"type":"string","example":"USPS2200000000000008"}}}}},"components/schemas/CancelStampsResponseERR":{"id":"components/schemas/CancelStampsResponseERR","kind":"json-schema","title":"CancelStampsResponseERR","data":{"type":"object","properties":{"refundFormUrl":{"type":"string","description":"This is the Refund Form having postage details","example":"https://api-sandbox.pitneybowes.com/shippingservices/refund-form/210000000000000000/Stamps_Refund_Form.pdf","x-go-name":"Name"}}}},"components/schemas/BPODDownloadRequest":{"id":"components/schemas/BPODDownloadRequest","kind":"json-schema","title":"BPODDownloadRequest","data":{"type":"object","properties":{"shipmentIds":{"type":"array","x-go-name":"ShipmentIds","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This shows the list of Shipment IDs. If this is present, then user does not need to provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Date Range"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter. Else "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" need to be passed in the Query Parameters."},"children":[]}]}]}]}]}],"items":{"type":"string","example":"USPS09998889999038"}}}}},"components/schemas/BPODDownloadResponse":{"id":"components/schemas/BPODDownloadResponse","kind":"json-schema","title":"BPODDownloadResponse","data":{"type":"object","properties":{"fileURL":{"type":"string","description":"This is the URL for the BPOD (Bulk Proof of Delivery) ZIP file.","example":"https://api-sandbox.pitneybowes.com/shippingservices/v1/bpod/210000000000000000/bpod-WodOGmplw0W3kR5.zip","x-go-name":"FileUrl"}}}},"components/schemas/singleRate":{"id":"components/schemas/singleRate","kind":"json-schema","title":"singleRate","data":{"type":"object","required":["parcelType","serviceId","fromAddress","parcel","toAddress","carrierAccounts"],"properties":{"fromAddress":{"type":"object","description":"Sender address details","required":["postalCode","countryCode","addressLine1"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the sender's address belongs.","example":"Beals"},"company":{"type":"string","description":"The name of the company, in case if the sender address is not residential.","example":"Pitney Bowes Inc."},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":"sender@email.com"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Sasha Sekrotov"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"323 555-1212"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"04611-3214"},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"ME"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false}}},"parcel":{"type":"object","description":"Parcel dimension, weight and respective unit of measurement","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"integer","format":"int32","description":"Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"integer","format":"int32","description":"There is no strict rule as to which element is the width or the height, but typically, by convention the width is the second greatest dimension of a parcel.","example":1},"height":{"type":"integer","format":"int32","description":"By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","enum":["OZ"],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is","example":1}}},"carrierAccounts":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It provides a single carrier account Id in case of single rate request. It can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carrier Accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}],"items":{"type":"string","example":"123abcd1"},"example":["12prrs1"]},"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel Type its value can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Parcel Types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}],"example":"PKG"},"serviceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service to be used for rating, it can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API"},"children":[]}]}]}],"example":"EM"},"specialServices":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special services to be used for rating, it can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Special Services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SpecialService"},"x-go-name":"SpecialServices"},"toAddress":{"type":"object","description":"Recipient address details","required":["postalCode","countryCode","addressLine1"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Westford"},"company":{"type":"string","description":"The name of the company, in case if the recipient address is not residential.","example":"Pitney Bowes Inc."},"countryCode":{"type":"string","description":"The two-character ISO Code of the destination country from this ISO country list.\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"receiver@email.com"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"sender_fname"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"2032032033"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"01886-6502"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"MA"}}}}}},"components/schemas/rateShopResponse":{"id":"components/schemas/rateShopResponse","kind":"json-schema","title":"rateShopResponse","data":{"type":"object","properties":{"fromAddress":{"type":"object","description":"Sender address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the sender's address belongs.","example":"Beals"},"company":{"type":"string","description":"The name of the company, in case if the sender address is not residential.","example":"ABC Company"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":"sender@email.com"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Sasha Sekrotov"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"323 555-1212"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"04611-3214"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"ME"}}},"parcel":{"type":"object","description":"Parcel dimension, weight and unit of measurement details","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"integer","format":"int32","description":"Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"integer","format":"int32","description":"There is no strict rule as to which element is the width or the height, but typically, by convention the width is the second greatest dimension of a parcel.","example":1},"height":{"type":"integer","format":"int32","description":"By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","enum":["OZ"],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":1}}},"rates":{"type":"array","description":"It displays all available rates for each service","items":{"type":"object","properties":{"baseCharge":{"type":"number","description":"The base service charge is payable to the carrier, excluding special service charges.","example":28.07},"carrier":{"type":"string","description":"Carrier is a service used to transport the parcels or couriers from one place to another.","example":"ups"},"carrierAccount":{"type":"string","description":"Carrier Account is the account associated to specific carrier service.","example":"as1233234s"},"deliveryCommitment":{"type":"object","description":"It specifies the delivery commitment provided by carrier for this shipment","properties":{"additionalDetails":{"type":"string","description":"It specifies the additional details for the delivery commitment","example":"By end of Day"},"estimatedDeliveryDateTime":{"type":"string","description":"It specifies estimated delivery date time","example":"2023-12-01"},"guarantee":{"type":"string","description":"It specifies if guarantee is provided.","example":"NONE"},"maxEstimatedNumberOfDays":{"type":"string","description":"It specifies the maximum estimated number of days","example":"3"},"minEstimatedNumberOfDays":{"type":"string","description":"It specifies the minimum estimated number of days","example":"3"}}},"currencyCode":{"type":"string","description":"A three-character (all uppercase letter) symbol of a currency according to the international ISO standard. As a rule, the first two letters denote the name of the country, and the third letter, the name of the currency thereof. For example, for US - the currency is Dollars and code is USD. Similarly for Canada, the currencycode is CAD, and for India, it is INR. ","example":"USD"},"parcelType":{"type":"string","description":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. ParcelType have categories like Package, Envelopes, Paks, Boxes, Tube, etc. ","example":"PKG"},"rateTypeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Its value can be CONTRACT_RATES, COMMERCIAL or COMMERCIAL_BASE for USPS and COMMERCIAL for other carriers depending on the Pitney Bowes contract/subscription"},"children":[]}]}]}],"example":"COMMERCIAL"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"3DA"},"surcharges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fees or surcharges applied to the shipment. Each object in the array represents a specific surcharge and its associated fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be one of the supported surcharge types from the respective carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Surcharge Names by Carrier:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge Names"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FUEL, GO_GREEN_BASIC, OVERSIZE, PREMIUM, RURAL, TOLL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANCILLARY_FEE, CANADIAN_DESTINATION, DELIVERY_AREA, DELIVERY_CONFIRMATION, FUEL, NON_MACHINABLE, OTHER, OUT_OF_DELIVERY_AREA, OUT_OF_PICKUP_AREA, OVERSIZE, RESIDENTIAL_DELIVERY, RESIDENTIAL_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERY_AREA, EXTENDED_AREA, FUEL, LARGE_PACKAGE, RESIDENTIAL, SHIPPER_PAYS_DUTY_TAX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nonmachinable, oversize"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":5.85},"name":{"type":"string","description":"The type of surcharge.","example":"RESIDENTIAL"}}},"example":[{"fee":5.85,"name":"RESIDENTIAL"},{"fee":4.66,"name":"FUEL"}]},"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier, including special service fees, surcharges, and any international taxes and duties","example":38.58},"destinationZone":{"type":"string","description":"This is the postal or delivery zone assigned to the shipment's destination by the carrier. This field is returned for USPS as of now.","example":1}}}},"toAddress":{"type":"object","description":"Recipient address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Westford"},"company":{"type":"string","description":"The name of the company, in case if the Recipient address is not residential.","example":"Pitney Bowes Inc."},"countryCode":{"type":"string","description":"The two-character ISO Code of the destination country from this ISO country list.\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"receiver@email.com"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"receiver_name"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"2032032033"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"01886-6502"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"MA"}}},"isHazmat":{"type":"boolean","description":"isHazmat if set to true, only services which support Hazardous material shipment would be visible in the response","example":false},"errors":{"type":"array","description":"It display any error while getting rates","items":{"type":"object","properties":{"code":{"type":"string","description":"This is the error code, which varies as per the case. It reflects or alerts user in case if there is any error while performing RateShop. ","example":"validation_error"},"message":{"type":"string","description":"This is the error message reflects to user, in case if the user misses or enters incorrect information while performing RateShop.","example":"error while getting rates for carrier with carrierAccount eRMnRx4mzPP : "}}},"example":[{"code":"validation_error","message":"error while getting rates for carrier with carrierAccount eRMnRx4mzPP : "}]}}}},"components/schemas/singleRateResponse":{"id":"components/schemas/singleRateResponse","kind":"json-schema","title":"singleRateResponse","data":{"type":"object","properties":{"fromAddress":{"type":"object","description":"Sender address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the sender's address belongs.","example":"Beals"},"company":{"type":"string","description":"The name of the company, in case if the sender address is not residential.","example":"ABC Company"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Sasha Sekrotov"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"04611-3214"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"ME"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'."}}},"parcel":{"type":"object","description":"It provides details of parcel its weight, dimension and respective unit of measurement","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"integer","format":"int32","description":"Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"integer","format":"int32","description":"There is no strict rule as to which element is the width or the height, but typically, by convention the width is the second greatest dimension of a parcel.","example":1},"height":{"type":"integer","format":"int32","description":"By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","enum":["OZ"],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":1}}},"rates":{"type":"array","description":"It displays the rate for the required carrier-service and/or special service combination","items":{"type":"object","properties":{"baseCharge":{"type":"number","description":"The base service charge is payable to the carrier, excluding special service charges.","example":28.07},"carrier":{"type":"string","description":"Carrier is a service used to transport the parcels or couriers from one place to another.","example":"ups"},"carrierAccount":{"type":"string","description":"Carrier Account is the account associated to specific carrier service.","example":"as1233234s"},"deliveryCommitment":{"type":"object","description":"It specifies the delivery commitment provided by carrier for this shipment","properties":{"additionalDetails":{"type":"string","description":"It specifies the additional details for the delivery commitment","example":"By end of Day"},"estimatedDeliveryDateTime":{"type":"string","description":"It specifies estimated delivery date time","example":"2023-12-01"},"guarantee":{"type":"string","description":"It specifies if guarantee is provided.","example":"NONE"},"maxEstimatedNumberOfDays":{"type":"string","description":"It specifies the maximum estimated number of days","example":"3"},"minEstimatedNumberOfDays":{"type":"string","description":"It specifies the minimum estimated number of days","example":"3"}}},"parcelType":{"type":"string","description":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. ParcelType have categories like Package, Envelopes, Paks, Boxes, Tube, etc. ","example":"PKG"},"rateTypeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Its value can be CONTRACT_RATES, COMMERCIAL or COMMERCIAL_BASE for USPS and COMMERCIAL for other carriers depending on the Pitney Bowes contract/subscription"},"children":[]}]}]}],"example":"COMMERCIAL"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"3DA"},"specialServices":{"type":"array","description":" It provides a carrier-service based special or extra service.","items":{"type":"object","properties":{"fee":{"type":"number","description":"The amount of the specialService.","example":5.85},"specialserviceId":{"type":"string","description":"This is the unique identifier given to various special services, which is used while Rating.","example":"LIBRARY MAIL"}}}},"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier, including special service fees, surcharges, and any international taxes and duties.","example":38.58}}}},"toAddress":{"type":"object","description":"Recipient address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"test_user"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Westford"},"company":{"type":"string","description":"The name of the company, in case if the Recipient address is not residential.","example":"Pitney Bowes Inc."},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be recipient's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits. ","example":"203-555-1213"},"countryCode":{"type":"string","description":"The two-character ISO Code of the destination country from this ISO country list.\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"01886-6502"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"MA"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"shipmentOptions":{"type":"object","description":"Additional options associated with the shipment.","properties":{"billingWeight":{"type":"string","description":"The weight used by the carrier to calculate the shipping cost. This value is determined as the greater of the actual weight and the dimensional weight.\n","example":"128.0"}}}}}},"components/schemas/rateShop":{"id":"components/schemas/rateShop","kind":"json-schema","title":"rateShop","data":{"type":"object","required":["fromAddress","parcel","toAddress"],"properties":{"dateOfShipment":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date when shipment is created/shipped. The format of the Date is YYYY-MM-DD. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: For FedEx US shipments, when a shipment date is provided in the request, the specified value is used for shipment processing. If no shipment date is provided, Carrier processes it as per their system."},"children":[]}]}]}],"example":"2024-03-20"},"fromAddress":{"type":"object","description":"Sender address details","required":["postalCode","countryCode","addressLine1"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the sender's address belongs.","example":"Beals"},"company":{"type":"string","description":"The name of the company, in case if the sender address is not residential.","example":"ABC Company"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":"sender@email.com"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Sasha Sekrotov"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"323 555-1212"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"04611-3214"},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"ME"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false}}},"parcel":{"type":"object","description":"It provides Parcel dimension, weight and respective unit of measurement details","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"integer","format":"int32","description":"Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"integer","format":"int32","description":"There is no strict rule as to which element is the width or the height, but typically, by convention the width is the second greatest dimension of a parcel.","example":1},"height":{"type":"integer","format":"int32","description":"By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","enum":["OZ"],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":1}}},"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel Type required for rating, it's value can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Parcel Types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API"},"children":[]}]}]}],"example":"PKG"},"toAddress":{"type":"object","description":"Recipient address details","required":["postalCode","countryCode","addressLine1"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Westford"},"company":{"type":"string","description":"The name of the company, in case if the recipient address is not residential.","example":"Pitney Bowes Inc."},"countryCode":{"type":"string","description":"The two-character ISO Code of the destination country from this ISO country list.\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"receiver@email.com"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"test_user"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"2032032033"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"01886-6502"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"MA"}}},"isHazmat":{"type":"boolean","description":"isHazmat if set to true, only services which support Hazardous material shipment would be visible in the response","example":false}}}},"components/schemas/countries":{"id":"components/schemas/countries","kind":"json-schema","title":"countries","data":{"type":"object","properties":{"countries":{"type":"array","items":{"type":"object","properties":{"countryCode":{"type":"string","description":"The two-character ISO Code of the country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"TV"},"countryName":{"type":"string","description":"The name of the country.","example":"Tuvalu"}}}}}}},"components/schemas/carriers":{"id":"components/schemas/carriers","kind":"json-schema","title":"carriers","data":{"type":"object","properties":{"carriers":{"type":"array","items":{"type":"object","properties":{"carrierID":{"type":"string","description":"A unique identifier associated with the specific carrier.","example":"USPS"},"name":{"type":"string","description":"This is the name of the Carrier, a shipping service which is used to carry shipment (e.g., parcels/packages/envelopes) from one place to other.","example":"United States Postal Service"},"originCountry":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.","example":"US"},"properties":{"type":"object","properties":{"domesticNotSupported":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines if the carrier is domestic supported or not. For Not Supported, will take "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a boolean value, else it will take "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":false},"futureShipmentSupported":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines if the carrier supports future shipment. If yes, it will take the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", else it will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"example":true},"internationalSupported":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines if the carrier is international supported or not. If Yes, it will take "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as boolean value, else it will take "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true}}}}}}}}},"components/schemas/services":{"id":"components/schemas/services","kind":"json-schema","title":"services","data":{"type":"object","properties":{"services":{"type":"array","items":{"type":"object","properties":{"brandedName":{"type":"string","description":"The branded name of service."},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service."}}}}}}},"components/schemas/specialServices":{"id":"components/schemas/specialServices","kind":"json-schema","title":"specialServices","data":{"type":"object","properties":{"services":{"type":"array","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"LIB"},"brandedName":{"type":"string","description":"The branded name of the service","example":"Library Mail®"},"parcelTypeRules":{"type":"array","description":"It displays special services for specific parcel type","items":{"type":"object","properties":{"brandedName":{"type":"string","description":"The branded name of Parcel Type","example":"Package"},"parcelType":{"type":"string","description":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. Here, it reflects as per the defined ParcelType Rules. ParcelType have categories like Package, Envelopes, Paks, Boxes, Tube, etc. ","example":"PKG"},"trackable":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether this parcel type is trackable. Valid Values are: TRACKABLE, NON_TRACKABLE, REQUIRES_TRACKABLE_SPECIAL_SERVICE"},"children":[]}]}]}],"example":"REQUIRES_TRACKABLE_SPECIAL_SERVICE"},"suggestedTrackableSpecialService":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If trackable is set to REQUIRES_TRACKABLE_SPECIAL_SERVICE, this is a free or low-cost special service that allows the shipper to track the shipment."},"children":[]}]}]}],"example":"DelCon"},"specialServiceRules":{"type":"array","description":"It displays all the available special services, their details and prerequisites and/or incompatible details with other special services","items":{"type":"object","properties":{"specialserviceId":{"type":"string","description":"It display the unique id of the special service","example":"COD"},"brandedName":{"type":"string","description":"The brand name of the special service.","example":"Collect on Delivery"},"categoryId":{"type":"string","description":"The unique identifier associated with the special service based on the category.","example":"COD"},"categoryName":{"type":"string","description":"The special service is categorized with some name and rules, It indicates the category name of the special service.","example":"Collect on Delivery"},"incompatibleSpecialServices":{"type":"array","description":"Indicates non-compatible special services with this special service","items":{"type":"string","example":"CODRD"},"example":["CODRD","Ins","InsRD","SigRD"]},"inputParameterRules":{"type":"array","description":"The rules defined for input parameters for this special service","items":{"type":"object","properties":{"brandedName":{"type":"string","description":"The branded name of the input parameter for the special service","example":"COD Amount"},"maxValue":{"type":"number","description":"Max value for the input.","example":1000},"minValue":{"type":"number","description":"Minimum value for the input.","example":1},"name":{"type":"string","description":"Name of the input parameters required for the special service","example":"INPUT_VALUE"},"required":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If all the input parameters are correct will display "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value, else it will return `false'."},"children":[]}]}]}],"example":true}}},"example":[{"brandedName":"COD Amount","maxValue":1000,"minValue":1,"name":"INPUT_VALUE","required":true}]},"prerequisiteRules":{"type":"array","description":"It displays other pre-requisite special services for this special service","items":{"type":"object","properties":{"specialserviceId":{"type":"string","example":"COD"}}},"example":[{"specialserviceId":"COD"},{"specialserviceId":"CODRD"}]},"trackable":{"type":"boolean","description":"If this special service is trackable or not","example":true}}},"example":[{"brandedName":"Collect on Delivery","categoryId":"COD","categoryName":"Collect on Delivery","incompatibleSpecialServices":["CODRD","Ins","InsRD","SigRD"],"inputParameterRules":[{"brandedName":"COD Amount","maxValue":1000,"minValue":1,"name":"INPUT_VALUE","required":true}],"specialserviceId":"COD","trackable":true},{"brandedName":"COD Restricted Delivery","categoryId":"COD","categoryName":"Collect on Delivery","incompatibleSpecialServices":["COD","Ins","InsRD","SigRD"],"inputParameterRules":[{"brandedName":"COD Amount","maxValue":1000,"minValue":1,"name":"INPUT_VALUE","required":true}],"specialserviceId":"CODRD","trackable":true},{"brandedName":"USPS Tracking™","specialserviceId":"DelCon","trackable":true},{"brandedName":"Return Receipt Electronic","categoryId":"RR","categoryName":"Return Receipt","incompatibleSpecialServices":["InsRD","Sig","SigRD"],"prerequisiteRules":[{"specialserviceId":"COD"},{"specialserviceId":"CODRD"}],"specialserviceId":"ERR"},{"brandedName":"Insurance","categoryId":"IM","categoryName":"Insurance","incompatibleSpecialServices":["COD","CODRD","InsRD","SigRD"],"inputParameterRules":[{"brandedName":"Insurance","maxValue":5000,"minValue":1,"name":"INPUT_VALUE","required":true}],"specialserviceId":"Ins","trackable":true},{"brandedName":"Insurance Restricted Delivery","categoryId":"IM","categoryName":"Insurance","incompatibleSpecialServices":["COD","CODRD","ERR","Ins","Sig","SigRD"],"inputParameterRules":[{"brandedName":"Insurance","maxValue":5000,"minValue":500.01,"name":"INPUT_VALUE","required":true}],"specialserviceId":"InsRD","trackable":true},{"brandedName":"Return Receipt","categoryId":"RR","categoryName":"Return Receipt","incompatibleSpecialServices":["Sig","SigRD"],"inputParameterRules":[{"brandedName":"Return Receipt Number","description":"Return Receipt Tracking Number","format":"^[0-9]{22,22}$","name":"RETURN_RECEIPT_NUMBER","required":true}],"prerequisiteRules":[{"specialserviceId":"COD"},{"specialserviceId":"CODRD"},{"minInputValue":501,"specialserviceId":"Ins"},{"minInputValue":501,"specialserviceId":"InsRD"}],"specialserviceId":"RR"},{"brandedName":"Signature Confirmation™","categoryId":"SIG","categoryName":"Signature","incompatibleSpecialServices":["ERR","InsRD","RR","SigRD"],"specialserviceId":"Sig","trackable":true},{"brandedName":"Signature Confirmation Restricted Delivery","categoryId":"SIG","categoryName":"Signature","incompatibleSpecialServices":["COD","CODRD","ERR","Ins","InsRD","RR","Sig"],"specialserviceId":"SigRD","trackable":true}]}}}}}}}}}},"components/schemas/schedulePickupDHLEXPRequest":{"id":"components/schemas/schedulePickupDHLEXPRequest","kind":"json-schema","title":"DHLExpress","data":{"type":"object","title":"DHLExpress","required":["pickupAddress","packageLocation","pickupOptions"],"properties":{"packageLocation":{"type":"string","description":"The location where the parcel will be available for pickup at the specified pickup address.","example":"None","enum":["Front","Back","Reception","Loading Dock"]},"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"X4pqLKjQ5XX"},"pickupAddress":{"type":"object","required":["name","addressLine1","postalCode","countryCode","phone"],"properties":{"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"John Doe"},"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"27 Waterview Dr"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Shelton"},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"US"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"1234567890"},"company":{"type":"string","description":"The name of the company at the pickup address, if the recipient address is not residential.","example":"PB"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"ankita.chaurasia@pb.com"}}},"pickupSummary":{"type":"array","required":["serviceId","packageCount","totalWeight","weightUnit","currencyCode","packageDetails"],"description":"An array of the pickup details, including the number of packages, total weight, and carrier service information and package details.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The abbreviated name of the carrier-specific service.","example":"NDA"},"packageCount":{"type":"number","description":"The total number of packages being picked up.","example":2},"totalWeight":{"type":"number","description":"The total weight of all packages to be picked up, measured in units supported by the carrier in the origin country. The value is a decimal with up to 2 decimal places.","example":15},"weightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"},"currencyCode":{"type":"string","description":"The currency code (e.g., 'USD') for the cost of the pickup service, if applicable.","example":"USD"},"totalCustomsDeclaredValue":{"type":"number","description":"Total customs declared value"},"packageDetails":{"type":"array","description":"Details of each package being picked up, including package dimensions and weight.","items":{"type":"object","properties":{"width":{"type":"number","description":"The width of the package in the unit specified by dimUnit.","example":1},"height":{"type":"number","description":"The height of the package in the unit specified by dimUnit.","example":15},"length":{"type":"number","description":"The length of the package in the unit specified by dimUnit.","example":10},"dimUnit":{"type":"string","description":"The unit of measurement for the package dimensions.","example":"IN"},"weightUnit":{"type":"string","description":"The unit of measurement for the package weight.","example":"OZ"},"weight":{"type":"number","description":"The weight of the package in the unit specified by weightUnit.","example":1}}}}}}},"additionalnotes":{"type":"string","description":"Additional instructions or notes for the carrier regarding the pickup.","example":"Call before pickup"},"reference":{"type":"string","description":"An optional Reference related to the pickup.","example":"zscsdc"},"shipmentIds":{"type":"array","description":"List of shipment IDs for which pickup needs to be scheduled.","items":{"type":"string","description":"Shipment identifier.","example":"DHLEXP2201736600235437"}},"pickupOptions":{"type":"object","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"The start date and time for the pickup in ISO 8601 format. This indicates when the pickup window begins.","example":"2024-10-10T17:03:05Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"The end date and time for the pickup in ISO 8601 format. This indicates when the pickup window closes.","example":"2024-10-10T17:05:05Z"},"overweight":{"type":"integer","description":"The number of overweight packages in the pickup. This represents the number of packages that exceed the carrier's weight limit.","example":2},"carrierType":{"type":"string","description":"The type of carrier used for the pickup.","example":"EXPRESS","enum":["EXPRESS","GROUND"]}}}},"example":{"packageLocation":"Reception","carrierAccountId":"wgjYXvYjD0V4","pickupAddress":{"name":"Test","addressLine1":"27 Waterview Dr","cityTown":"Shelton","stateProvince":"CT","postalCode":"06484-4301","countryCode":"US","phone":"1234567890","company":"PB","email":"ankita.chaurasia@pb.com"},"pickupSummary":[{"serviceId":"NDA","packageCount":1,"totalWeight":15,"weightUnit":"OZ","packageDetails":[{"width":1,"height":15,"length":10,"dimUnit":"IN","weightUnit":"OZ","weight":15}],"currencyCode":"USD","totalCustomsDeclaredValue":5}],"shipmentIds":["DHLEXP2201736600235437","DHLEXP2201736600264906"],"pickupOptions":{"pickupStartDateTime":"2025-09-29T09:05:05Z","pickupEndDateTime":"2025-09-29T18:30:00Z","carrierType":"EXPRESS","overweight":2},"reference":"reference"}}},"components/schemas/schedulePickupDHLEXPResponse":{"id":"components/schemas/schedulePickupDHLEXPResponse","kind":"json-schema","title":"DHLExpress","data":{"type":"object","title":"DHLExpress","properties":{"packageLocation":{"type":"string","description":"The location where the parcel will be available for pickup at the specified pickup address.","example":"None","enum":["Front","Back","Reception","Loading Dock"]},"pickupConfirmationNumber":{"type":"string","description":"The confirmation number generated when the pickup request is successfully processed.","example":"CAME241011000909"},"pickupId":{"type":"string","description":"A unique identifier for the scheduled pickup.","example":"DHLEXP10111728640015873"},"carrier":{"type":"string","description":"The carrier being used for the pickup.","example":"dhlexp"},"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"j4pqLKjQ5dn"},"pickupAddress":{"type":"object","properties":{"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"Test"},"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"27 Waterview Dr"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Shelton"},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"US"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"1234567890"},"company":{"type":"string","description":"The name of the company at the pickup address, if the recipient address is not residential.","example":"PB"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"ankita.chaurasia@pb.com"},"residential":{"type":"boolean","description":"Indicates whether the pickup address is a residential location. Set to 'false' for commercial addresses.","example":false}}},"pickupSummary":{"type":"array","description":"An array of the pickup details, including the number of packages, total weight, and carrier service information.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The abbreviated name of the carrier-specific service.","example":"NDA"},"packageCount":{"type":"number","description":"The total number of packages being picked up.","example":2},"totalWeight":{"type":"number","description":"The total weight of all packages to be picked up, measured in units supported by the carrier in the origin country. The value is a decimal with up to 2 decimal places.","example":15},"weightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"},"currencyCode":{"type":"string","description":"The currency code (e.g., 'USD') for the cost of the pickup service, if applicable.","example":"USD"}}}},"additionalNotes":{"type":"string","description":"Additional instructions or notes for the carrier regarding the pickup.","example":"absdhda"},"pickupDateTime":{"type":"string","description":"The sdate and time of the pickup window.","example":"2024-10-10T17:05:05Z"},"pickupTotalWeight":{"type":"number","description":"The total weight of all packages being picked up.","example":16},"pickupTotalWeightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"},"reference":{"type":"string","description":"An optional Reference related to the pickup.","example":"zscsdc"},"pickupOptions":{"type":"object","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"The start date and time for the pickup in ISO 8601 format. This indicates when the pickup window begins.","example":"2024-10-10T17:03:05Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"The end date and time for the pickup in ISO 8601 format. This indicates when the pickup window closes.","example":"2024-10-10T17:05:05Z"},"overweight":{"type":"integer","description":"The number of overweight packages in the pickup. This represents the number of packages that exceed the carrier's weight limit.","example":2},"carrierType":{"type":"integer","description":"The type of carrier is being used for pickup.","example":"EXPRESS"}}}},"example":{"carrierAccountId":"wgjYXvYjD0V4","carrier":"dhlexp","pickupAddress":{"addressLine1":"27 Waterview Dr","cityTown":"Shelton","company":"PB","countryCode":"US","email":"ankita.chaurasia@pb.com","name":"Test","phone":"1234567890","postalCode":"06484-4301","residential":false,"stateProvince":"CT"},"packageLocation":"RECEPTION","shipmentIds":["DHLEXP2201736600235437","DHLEXP2201736600264906"],"pickupSummary":[{"serviceId":"NDA","packageCount":1,"totalWeight":15,"weightUnit":"OZ","totalCustomsDeclaredValue":5,"currencyCode":"USD"},{"serviceId":"NDA","packageCount":2,"totalWeight":20,"weightUnit":"OZ"}],"reference":"reference","pickupDateTime":"2025-09-29T09:05:00Z","pickupConfirmationNumber":"AME250929000197","pickupId":"DHLEXP09261758885311045","pickupOptions":{"pickupStartDateTime":"2025-09-29T09:05:05Z","pickupEndDateTime":"2025-09-29T18:30:00Z","overweight":2,"carrierType":"EXPRESS"},"pickupTotalWeight":35,"pickupTotalWeightUnit":"OZ"}}},"components/schemas/schedulePickupUSPSRequest":{"id":"components/schemas/schedulePickupUSPSRequest","kind":"json-schema","title":"USPS","data":{"type":"object","title":"USPS","required":["pickupAddress","packageLocation"],"properties":{"packageLocation":{"type":"string","description":"The location where the parcel will be available for pickup at the specified pickup address.","example":"None","enum":["Front Door","Back Door","Side Door","Knock on Door/Ring Bell","Mail Room","Office","Reception","In/At Mailbox","Other"]},"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"xxxx_carrier_id"},"pickupAddress":{"type":"object","required":["name","addressLine1","postalCode","countryCode","phone"],"properties":{"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"Test"},"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"27 Waterview Dr"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Shelton"},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"US"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"1234567890"},"company":{"type":"string","description":"The name of the company at the pickup address, if the recipient address is not residential.","example":"PB"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"ankita.chaurasia@pb.com"}}},"pickupSummary":{"type":"array","required":["serviceId","packageCount","totalWeight","weightUnit"],"description":"An array of the pickup details, including the number of packages, total weight, and carrier service information.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The abbreviated name of the carrier-specific service.","example":"NDA"},"packageCount":{"type":"number","description":"The total number of packages being picked up.","example":2},"totalWeight":{"type":"number","description":"The total weight of all packages to be picked up, measured in units supported by the carrier in the origin country. The value is a decimal with up to 2 decimal places.","example":15},"weightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"}}}},"additionalnotes":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional instructions or notes for the carrier regarding the pickup. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Value is required when packageLocation is set to other."},"children":[]}]}]}],"example":"absdhda"},"reference":{"type":"string","description":"An optional Reference related to the pickup.","example":"zscsdc"},"shipmentIds":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of shipment IDs associated with the pickup request. ","example":["USPS12345","USPS567890"]},"pickupOptions":{"type":"object","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"The start date and time for the pickup in ISO 8601 format. This indicates when the pickup window begins.","example":"2024-10-10T17:03:05Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"The end date and time for the pickup in ISO 8601 format. This indicates when the pickup window closes.","example":"2024-10-10T17:05:05Z"},"overweight":{"type":"integer","description":"The number of overweight packages in the pickup. This represents the number of packages that exceed the carrier's weight limit.","example":2}}}},"example":{"additionalnotes":"notes","carrierAccountId":"En9jM8bB8eAZ","packageLocation":"Back Door","pickupAddress":{"addressLine1":"27 Waterview Dr","cityTown":"Shelton","company":"PB","countryCode":"US","email":"sender@email.com","name":"Test","phone":"2124567890","postalCode":"06484-4301","stateProvince":"CT"},"pickupSummary":[{"packageCount":111,"serviceId":"EM","totalWeight":45435,"weightUnit":"GM"}],"reference":"reference","shipmentIds":["USPS2201674200253944"]}}},"components/schemas/schedulePickupUSPSResponse":{"id":"components/schemas/schedulePickupUSPSResponse","kind":"json-schema","title":"USPS","data":{"type":"object","title":"USPS","properties":{"packageLocation":{"type":"string","description":"The location where the parcel will be available for pickup at the specified pickup address.","example":"None"},"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"j4pqLKjQ5dn"},"pickupConfirmationNumber":{"type":"string","description":"The confirmation number generated when the pickup request is successfully processed.","example":"CBJ180121002626"},"pickupId":{"type":"string","description":"A unique identifier for the scheduled pickup.","example":"USPSXXX10191697701225617"},"carrier":{"type":"string","description":"The carrier being used for the pickup.","example":"USPS"},"pickupAddress":{"type":"object","properties":{"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"Test"},"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"27 Waterview Dr"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Shelton"},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"US"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"1234567890"},"company":{"type":"string","description":"The name of the company at the pickup address, if the recipient address is not residential.","example":"PB"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"ankita.chaurasia@pb.com"},"residential":{"type":"boolean","description":"Indicates whether the pickup address is a residential location. Set to 'false' for commercial addresses.","example":false}}},"pickupSummary":{"type":"array","description":"An array of the pickup details, including the number of packages, total weight, and carrier service information.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The abbreviated name of the carrier-specific service.","example":"EM"},"packageCount":{"type":"number","description":"The total number of packages being picked up.","example":2},"totalWeight":{"type":"number","description":"The total weight of all packages to be picked up, measured in units supported by the carrier in the origin country. The value is a decimal with up to 2 decimal places.","example":15},"weightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"}}}},"additionalNotes":{"type":"string","description":"Additional instructions or notes for the carrier regarding the pickup.","example":"absdhda"},"reference":{"type":"string","description":"An optional Reference related to the pickup.","example":"zscsdc"},"shipmentIds":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of shipment IDs.","example":["USPS12345","USPS567890"]},"pickupDateTime":{"type":"string","description":"The date and time of the pickup.","example":"10/12/2024"},"pickupTotalWeight":{"type":"number","description":"The total weight of all packages being picked up.","example":16},"pickupTotalWeightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"}},"example":{"carrierAccountId":"En9jM8bB8eAZ","carrier":"usps","pickupAddress":{"addressLine1":"27 WATERVIEW DR","cityTown":"SHELTON","company":"PB","countryCode":"US","email":"sender@email.com","name":"Test","phone":"2124567890","postalCode":"06484","residential":false,"stateProvince":"CT"},"packageLocation":"Back Door","shipmentIds":["USPS2201674200253944"],"pickupSummary":[{"serviceId":"EM","packageCount":111,"totalWeight":45435,"weightUnit":"GM"}],"additionalNotes":"notes","reference":"reference","pickupDateTime":"09/20/2025","pickupConfirmationNumber":"WTC65273674","pickupId":"USPSSKV539D3F8Z8","pickupTotalWeight":45559.35,"pickupTotalWeightUnit":"GM"}}},"components/schemas/schedulePickupUPSRequest":{"id":"components/schemas/schedulePickupUPSRequest","kind":"json-schema","title":"UPS","data":{"type":"object","title":"UPS","required":["pickupAddress","packageLocation","pickupOptions","pickupStartTime"],"properties":{"packageLocation":{"type":"string","description":"The location where the parcel will be available for pickup at the specified pickup address.","example":"None","enum":["Front Door","Back Door","Side Door","Knock on Door/Ring Bell","Mail Room","Office","Reception","In/At Mailbox","Other","Garage","Downstairs","Third Party","Warehouse"]},"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"j4pqLKjQ5dn"},"pickupAddress":{"type":"object","required":["name","addressLine1","postalCode","countryCode","phone"],"properties":{"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"Test"},"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"27 Waterview Dr"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Shelton"},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"US"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"1234567890"},"company":{"type":"string","description":"The name of the company at the pickup address, if the recipient address is not residential.","example":"PB"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"ankita.chaurasia@pb.com"}}},"pickupSummary":{"type":"array","required":["serviceId","packageCount","totalWeight","weightUnit","toAddressCountryCode","parcelType"],"description":"An array of the pickup details, including the number of packages, total weight, and carrier service information.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The abbreviated name of the carrier-specific service.","example":"NDA"},"packageCount":{"type":"number","description":"The total number of packages being picked up.","example":2},"totalWeight":{"type":"number","description":"The total weight of all packages to be picked up, measured in units supported by the carrier in the origin country. The value is a decimal with up to 2 decimal places.","example":15},"weightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"},"parcelType":{"type":"string","description":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. Here, it reflects as per the defined ParcelType Rules. ParcelType have categories like Package, Envelopes, Paks, Boxes, Tube, etc. ","example":"PKG"},"toAddressCountryCode":{"type":"string","description":"The two-letter country code of the destination country for the shipment.","example":"US"}}}},"additionalnotes":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional instructions or notes for the carrier regarding the pickup. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Value is required when packageLocation is set to other."},"children":[]}]}]}],"example":"Call before pickup"},"reference":{"type":"string","description":"An optional Reference related to the pickup.","example":"zscsdc"},"pickupOptions":{"type":"object","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"The start date and time for the pickup in ISO 8601 format. This indicates when the pickup window begins.","example":"2024-10-10T17:03:05Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"The end date and time for the pickup in ISO 8601 format. This indicates when the pickup window closes.","example":"2024-10-10T17:05:05Z"},"overweight":{"type":"integer","description":"The number of overweight packages in the pickup. This represents the number of packages that exceed the carrier's weight limit.","example":2}}}}}},"components/schemas/schedulePickupUPSResponse":{"id":"components/schemas/schedulePickupUPSResponse","kind":"json-schema","title":"UPS","data":{"type":"object","title":"UPS","properties":{"packageLocation":{"type":"string","description":"The location where the parcel will be available for pickup at the specified pickup address.","example":"None"},"pickupConfirmationNumber":{"type":"string","description":"The confirmation number generated when the pickup request is successfully processed.","example":"2929602E9CP"},"pickupId":{"type":"string","description":"A unique identifier for the scheduled pickup.","example":"UPS10191697701340901"},"carrier":{"type":"string","description":"The carrier being used for the pickup.","example":"ups"},"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"j4pqLKjQ5dn"},"pickupAddress":{"type":"object","properties":{"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"Test"},"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"27 Waterview Dr"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Shelton"},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"US"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"1234567890"},"company":{"type":"string","description":"The name of the company at the pickup address, if the recipient address is not residential.","example":"PB"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"ankita.chaurasia@pb.com"},"residential":{"type":"boolean","description":"Indicates whether the pickup address is a residential location. Set to 'false' for commercial addresses.","example":false}}},"pickupSummary":{"type":"array","description":"An array of the pickup details, including the number of packages, total weight, and carrier service information.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The abbreviated name of the carrier-specific service.","example":"NDA"},"packageCount":{"type":"number","description":"The total number of packages being picked up.","example":2},"totalWeight":{"type":"number","description":"The total weight of all packages to be picked up, measured in units supported by the carrier in the origin country. The value is a decimal with up to 2 decimal places.","example":15},"weightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"},"toAddressCountryCode":{"type":"string","description":"The two-letter country code of the destination country for the shipment.","example":"US"},"parcelType":{"type":"string","description":"description","example":"PKG"}}}},"additionalnotes":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional instructions or notes for the carrier regarding the pickup. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Value is required when packageLocation is set to other."},"children":[]}]}]}],"example":"Call before pickup"},"reference":{"type":"string","description":"An optional Reference related to the pickup.","example":"zscsdc"},"pickupDateTime":{"type":"string","description":"The date and time of the pickup.","example":"2024-10-10T17:05:05Z"},"pickupTotalWeight":{"type":"number","description":"The total weight of all packages being picked up.","example":16},"pickupTotalWeightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"},"pickupOptions":{"type":"object","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"The start date and time for the pickup in ISO 8601 format. This indicates when the pickup window begins.","example":"2024-10-10T17:03:05Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"The end date and time for the pickup in ISO 8601 format. This indicates when the pickup window closes.","example":"2024-10-10T17:05:05Z"},"overweight":{"type":"integer","description":"The number of overweight packages in the pickup. This represents the number of packages that exceed the carrier's weight limit.","example":2}}}}}},"components/schemas/schedulePickupCancelRequest":{"id":"components/schemas/schedulePickupCancelRequest","kind":"json-schema","title":"schedulePickupCancelRequest","data":{"type":"object","required":["pickupIds","options"],"properties":{"pickupIds":{"type":"array","description":"Unique identifiers for scheduled pickups.","items":{"type":"string","example":"UPS10191697701340901"}},"options":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of key-value pairs specifying additional parameters for the cancellation request. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are three required keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUESTOR_NAME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REASON_FOR_CANCEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REMARKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Different carriers required different keys and values for"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" required?"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required keys"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUESTOR_NAME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REASON_FOR_CANCEL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUESTOR_NAME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value required; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REASON_FOR_CANCEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value optional."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REMARKS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REMARKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value required."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keys are case-sensitive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide only the keys relevant to the selected carrier."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the parameter.","example":"REQUESTOR_NAME"},"value":{"type":"string","description":"The corresponding value for the parameter.","example":"John Doe"}}}}},"example":{"pickupIds":["DHLEXP10141728895444413"],"options":[{"name":"REQUESTOR_NAME","value":"LMPod1"},{"name":"REASON_FOR_CANCEL","value":"Not required any more"},{"name":"REMARKS","value":"Customer requested cancellation"}]}}},"components/schemas/schedulePickupCancelResponse":{"id":"components/schemas/schedulePickupCancelResponse","kind":"json-schema","title":"schedulePickupCancelResponse","data":{"type":"object","properties":{"pickups":{"type":"object","description":"Details of the cancelled pickups and their status.","properties":{"UPS10191697701340901":{"type":"object","description":"Pickup ID requested for cancelation.","properties":{"status":{"type":"string","description":"The status of the pickup.","example":"cancelled"},"cancellationDate":{"type":"string","format":"date-time","description":"The date and time when the pickup was cancelled.","example":"2024-10-19T07:47:22.760623684Z"}}}}}}}},"components/schemas/getPickupDocument":{"id":"components/schemas/getPickupDocument","kind":"json-schema","title":"getPickupDocument","data":{"type":"object","properties":{"pickupId":{"type":"string","description":"Unique ID of the scheduled pickup.","example":"USPSRL7VG8U2WMEC"},"url":{"type":"string","description":"The URL for accessing the generated PDF document.","example":"https://22593******-sending-service-**.s3-fips.us-east-1.amazonaws.com/scheduled-pickup/USPSRL7VG8U2WMEC.pdf"}}}},"components/schemas/getPickupCancelledDocumentRequest":{"id":"components/schemas/getPickupCancelledDocumentRequest","kind":"json-schema","title":"getPickupCancelledDocumentRequest","data":{"type":"object","properties":{"pickupIds":{"type":"array","description":"The pickup Ids which are cancelled and for which receipt is required.","items":{"type":"string","example":"UPS10181697635567196"}}}}},"components/schemas/getPickupCancelledDocumentResponse":{"id":"components/schemas/getPickupCancelledDocumentResponse","kind":"json-schema","title":"getPickupCancelledDocumentResponse","data":{"type":"object","properties":{"url":{"type":"string","description":"The URL for accessing the generated PDF document.","example":"https://22593*****-sending-service-**.s3-fips.us-east-1.amazonaws.com/scheduled-pickup/UPS10181697635567196cancelled.pdf"}}}},"components/schemas/getAllPickups":{"id":"components/schemas/getAllPickups","kind":"json-schema","title":"getAllPickups","data":{"type":"object","properties":{"pageInfo":{"type":"object","properties":{"total":{"type":"integer","example":78,"description":"Total number of records for pickups."},"pages":{"type":"integer","example":8,"description":"Total number of pages available."},"page":{"type":"integer","example":1,"description":"Current page number."}}},"data":{"type":"object","properties":{"packageLocation":{"type":"string","description":"The location where the parcel will be available for pickup.","example":"None"},"confirmationNumber":{"type":"string","description":"The confirmation number generated when the pickup request is successfully processed.","example":"2929602E9CP"},"pickupId":{"type":"string","description":"Unique identifiers for scheduled pickups.","example":"UPS10191697701340901"},"carrier":{"type":"string","description":"The carrier is beng used for the pickup.","example":"ups"},"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"j4pqLKjQ5dn"},"pickupAddress":{"type":"object","properties":{"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"Test"},"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"27 Waterview Dr"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Shelton"},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"US"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"1234567890"},"company":{"type":"string","description":"The name of the company at the pickup address, if the recipient address is not residential.","example":"PB"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"ankita.chaurasia@pb.com"}}},"pickupSummary":{"type":"array","description":"An array of the pickup details, including the number of packages, total weight, and carrier service information.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The abbreviated name of the carrier-specific service.","example":"NDA"},"packageCount":{"type":"number","description":"The total number of packages being picked up.","example":2},"totalWeight":{"type":"number","description":"The total weight of all packages to be picked up, measured in units supported by the carrier in the origin country. The value is a decimal with up to 2 decimal places.","example":15},"weightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"},"currencyCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency code in which the rates are calculated. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is supported for FEDEX carrier only."},"children":[]}]}]}],"example":"USD"},"parcelType":{"type":"string","description":"The type of parcel used for the shipment, as defined by the carrier. Supported for UPS and FedEx carriers.","example":"PKG"},"packageDetails":{"type":"array","description":"Details of each package in the parcel being picked up. Supported for DHLEXP carrier only.","items":{"type":"object","properties":{"width":{"type":"number","description":"The width of the package in the unit specified by dimUnit.","example":1},"height":{"type":"number","description":"The height of the package in the unit specified by dimUnit.","example":15},"length":{"type":"number","description":"The length of the package in the unit specified by dimUnit.","example":10},"dimUnit":{"type":"string","description":"The unit of measurement for the package dimensions.","example":"IN"},"weightUnit":{"type":"string","description":"The unit of measurement for the package weight.","example":"OZ"},"weight":{"type":"number","description":"The weight of the package in the unit specified by weightUnit.","example":1}}}}}}},"specialInstructions":{"type":"string","description":"Any special instructions or notes for the carrier regarding the pickup.","example":"Call befor pickup"},"totalWeight":{"type":"number","description":"The total weight of all packages being picked up.","example":16},"pickupTotalWeightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"},"totalCount":{"type":"integer","description":"The total number of packages being picked up.","example":2},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the pickup request. Values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"scheduled"},"reference":{"type":"string","description":"An optional Reference related to the pickup.","example":"zscsdc"},"pickupDateTime":{"type":"string","description":"The date and time of the pickup.","example":"2024-10-10T17:05:05Z"},"pickupOptions":{"type":"object","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"The start date and time for the pickup in ISO 8601 format. This indicates when the pickup window begins.","example":"2024-10-10T17:03:05Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"The end date and time for the pickup in ISO 8601 format. This indicates when the pickup window closes.","example":"2024-10-10T17:05:05Z"}}}}}}}},"components/schemas/schedulePickupFedexRequest":{"id":"components/schemas/schedulePickupFedexRequest","kind":"json-schema","title":"FedEx","data":{"type":"object","title":"FedEx","required":["pickupAddress","packageLocation","pickupOptions"],"properties":{"packageLocation":{"type":"string","description":"The location where the parcel will be available for pickup at the specified pickup address.","example":"None","enum":["Front","None","Side","REAR"]},"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"j4pqLKjQ5dn"},"pickupAddress":{"type":"object","required":["name","addressLine1","postalCode","countryCode","phone"],"properties":{"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"Test"},"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"27 Waterview Dr"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Shelton"},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"US"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"1234567890"},"company":{"type":"string","description":"The name of the company at the pickup address, if the recipient address is not residential.","example":"PB"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"ankita.chaurasia@pb.com"}}},"pickupSummary":{"type":"array","required":["serviceId","packageCount","totalWeight","weightUnit"],"description":"An array of the pickup details, including the number of packages, total weight, and carrier service information.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The abbreviated name of the carrier-specific service.","example":"NDA"},"packageCount":{"type":"number","description":"The total number of packages being picked up.","example":2},"totalWeight":{"type":"number","description":"The total weight of all packages to be picked up, measured in units supported by the carrier in the origin country. The value is a decimal with up to 2 decimal places.","example":15},"weightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"},"parcelType":{"type":"string","description":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. Here, it reflects as per the defined ParcelType Rules. ParcelType have categories like Package, Envelopes, Paks, Boxes, Tube, etc. ","example":"PKG"}}}},"additionalnotes":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional instructions or notes for the carrier regarding the pickup. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Value is required when packageLocation is set to other."},"children":[]}]}]}],"example":"absdhda"},"reference":{"type":"string","description":"An optional Reference related to the pickup.","example":"zscsdc"},"pickupOptions":{"type":"object","required":["pickupStartDateTime","pickupEndDateTime","carrierType"],"description":"Pickup window options","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"The start date and time for the pickup in ISO 8601 format. This indicates when the pickup window begins.","example":"2024-10-10T17:03:05Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"The end date and time for the pickup in ISO 8601 format. This indicates when the pickup window closes.","example":"2024-10-10T17:05:05Z"},"overweight":{"type":"integer","description":"The number of overweight packages in the pickup. This represents the number of packages that exceed the carrier's weight limit.","example":2},"carrierType":{"type":"string","description":"The type of carrier used for the pickup.","example":"EXPRESS"}}}},"example":{"carrierAccountId":"OVJMdgGYNvrx","packageLocation":"SIDE","pickupAddress":{"name":"Test","addressLine1":"27 Waterview Dr","cityTown":"Shelton","stateProvince":"CT","postalCode":"06484-4301","countryCode":"US","phone":"1234567890","company":"PB","email":"sender@email.com"},"pickupSummary":[{"serviceId":"2DA","packageCount":1,"totalWeight":15,"weightUnit":"OZ","totalCustomsDeclaredValue":5}],"shipmentIds":["FEDEX2201736700381083","FEDEX2201736800144529"],"pickupOptions":{"pickupStartDateTime":"2025-09-29T12:04:05Z","pickupEndDateTime":"2025-09-29T18:30:00Z","overweight":1,"carrierType":"EXPRESS"},"additionalnotes":"notes","reference":"reference"}}},"components/schemas/schedulePickupFedexResponse":{"id":"components/schemas/schedulePickupFedexResponse","kind":"json-schema","title":"FedEx","data":{"type":"object","title":"FedEx","properties":{"packageLocation":{"type":"string","description":"The location where the parcel will be available for pickup at the specified pickup address.","example":"None"},"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"j4pqLKjQ5dn"},"pickupConfirmationNumber":{"type":"string","description":"The confirmation number generated when the pickup request is successfully processed.","example":"CBJ180121002626"},"pickupId":{"type":"string","description":"A unique identifier for the scheduled pickup.","example":"FEDEXXXX10191697701225617"},"carrier":{"type":"string","description":"The carrier being used for the pickup.","example":"FedEv"},"pickupAddress":{"type":"object","properties":{"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"Test"},"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"27 Waterview Dr"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Shelton"},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"US"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"1234567890"},"company":{"type":"string","description":"The name of the company at the pickup address, if the recipient address is not residential.","example":"PB"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"ankita.chaurasia@pb.com"},"residential":{"type":"boolean","description":"Indicates whether the pickup address is a residential location. Set to 'false' for commercial addresses.","example":false}}},"pickupSummary":{"type":"array","description":"An array of the pickup details, including the number of packages, total weight, and carrier service information.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The abbreviated name of the carrier-specific service.","example":"NDA"},"packageCount":{"type":"number","description":"The total number of packages being picked up.","example":2},"totalWeight":{"type":"number","description":"The total weight of all packages to be picked up, measured in units supported by the carrier in the origin country. The value is a decimal with up to 2 decimal places.","example":15},"weightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"},"parcelType":{"type":"string","description":"The type of parcel used for the shipment, as defined by the carrier. Common values include 'PKG' for package, 'ENVELOPE', 'BOX', etc.","example":"PKG"}}}},"additionalNotes":{"type":"string","description":"Additional instructions or notes for the carrier regarding the pickup.","example":"absdhda"},"reference":{"type":"string","description":"An optional Reference related to the pickup.","example":"zscsdc"},"pickupDateTime":{"type":"string","description":"The date and time of the pickup in ISO 8601 format.","example":"2024-10-10T17:05:05Z"},"pickupTotalWeight":{"type":"number","description":"The total weight of all packages being picked up.","example":16},"pickupTotalWeightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"OZ"},"pickupOptions":{"type":"object","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"The start date and time for the pickup in ISO 8601 format. This indicates when the pickup window begins.","example":"2024-10-10T17:03:05Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"The end date and time for the pickup in ISO 8601 format. This indicates when the pickup window closes.","example":"2024-10-10T17:05:05Z"},"overweight":{"type":"integer","description":"The number of overweight packages in the pickup. This represents the number of packages that exceed the carrier's weight limit.","example":2},"carrierType":{"type":"string","description":"The type of carrier used for the pickup.","example":"EXPRESS"}}}},"example":{"carrierAccountId":"OVJMdgGYNvrx","carrier":"fedex","pickupAddress":{"addressLine1":"27 Waterview Dr","cityTown":"Shelton","company":"PB","countryCode":"US","email":"sender@email.com","name":"Test","phone":"1234567890","postalCode":"06484-4301","residential":false,"stateProvince":"CT"},"packageLocation":"SIDE","shipmentIds":["FEDEX2201736700381083","FEDEX2201736800144529"],"pickupSummary":[{"serviceId":"2DA","packageCount":1,"totalWeight":15,"weightUnit":"OZ","totalCustomsDeclaredValue":5},{"serviceId":"3DA","packageCount":2,"totalWeight":4,"weightUnit":"OZ"}],"additionalNotes":"notes","reference":"reference","pickupDateTime":"2025-09-29T12:04:00Z","pickupConfirmationNumber":"CPU0068152722","pickupId":"FEDEX09261758885130715","pickupOptions":{"pickupStartDateTime":"2025-09-29T12:04:05Z","pickupEndDateTime":"2025-09-29T18:30:00Z","overweight":1,"carrierType":"EXPRESS"},"pickupTotalWeight":19,"pickupTotalWeightUnit":"OZ"}}},"components/schemas/PickupAvailabilityRequest":{"id":"components/schemas/PickupAvailabilityRequest","kind":"json-schema","title":"PickupAvailabilityRequest","data":{"type":"object","required":["carrierAccountId","pickupAddress","pickupSummary","pickupDateTime","pickupOptions"],"properties":{"carrierAccountId":{"type":"string","description":"Unique identifier of the carrier account under which pickup is requested.","example":"GkvvOE7vX1QxQkm"},"pickupAddress":{"type":"object","required":["name","addressLine1","cityTown","stateProvince","postalCode","countryCode","phone"],"description":"Address where pickup is requested.","properties":{"name":{"type":"string","example":"John Doe","description":"Contact person name at the pickup location"},"addressLine1":{"type":"string","example":"27 Waterview Dr","description":"Primary street address line"},"cityTown":{"type":"string","example":"Shelton","description":"City or town of the pickup location"},"stateProvince":{"type":"string","example":"CT","description":"State or province of the pickup location"},"postalCode":{"type":"string","example":"06484-4301","description":"Postal or ZIP code of the pickup location"},"countryCode":{"type":"string","example":"US","description":"Two-letter ISO country code"},"phone":{"type":"string","example":"1234567890","description":"Contact phone number at the pickup location"},"company":{"type":"string","example":"PB","description":"Company name associated with the pickup locatio"},"email":{"type":"string","example":"user@pb.com","description":"Contact email at the pickup location"},"residential":{"type":"boolean","description":"Indicates if the address is residential.","example":false}}},"pickupSummary":{"type":"array","description":"Summary of shipments for which pickup is requested.","items":{"type":"object","properties":{"toAddressCountryCode":{"type":"string","example":"CA","description":"Destination country code of the shipment"},"serviceId":{"type":"string","example":"2DA","description":"Identifier of the shipping service requested (e.g., GND)."},"parcelType":{"type":"string","example":"PKG","description":"Type of parcel (e.g., PKG, LTR)"},"packageDetails":{"type":"array","items":{"type":"object","description":"Dimensions of packages to be picked up.","properties":{"height":{"type":"number","example":5},"length":{"type":"number","example":6},"width":{"type":"number","example":4},"weight":{"type":"number","example":100,"description":"Weight of the package for pickup"},"weightUnit":{"type":"string","example":"OZ","description":"Unit of measurement for weight"},"dimUnit":{"type":"string","example":"IN"}}}}}}},"pickupDateTime":{"type":"string","format":"date-time","description":"Requested pickup date and time in ISO 8601 format.","example":"2025-08-25T17:05:05Z"},"pickupOptions":{"type":"object","description":"Additional options for pickup eligibility.","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"Start time of the pickup window.","example":"2025-09-15T12:45:00Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"End time of the pickup window.","example":"2025-09-15T13:15:00Z"},"carrierType":{"type":"string","description":"Type of carrier service requested for the pickup.","example":"EXPRESS"},"scheduleDay":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates when the pickup is scheduled (e.g., SAME_DAY, FUTURE_DAY)."},"children":[]}]}]}],"example":"SAME_DAY"}}}},"example":{"carrierAccountId":"97wroboxVgbzK4N","pickupAddress":{"name":"Test","addressLine1":"27 Waterview Dr","cityTown":"Shelton","stateProvince":"CT","postalCode":"06484-4301","countryCode":"US","phone":"1234567890","company":"PB","email":"abc@test.com","residential":false},"pickupSummary":[{"toAddressCountryCode":"CA","serviceId":"","parcelType":"PKG","packageDetails":[{"height":5,"length":6,"width":4,"dimUnit":"IN","weight":34,"weightUnit":"OZ"}]}],"pickupDateTime":"2025-09-15T13:00:00Z","pickupOptions":{"pickupStartDateTime":"2025-09-15T12:45:00Z","pickupEndDateTime":"2025-09-15T13:15:00Z","carrierType":"EXPRESS","scheduleDay":"SAME_DAY"}}}},"components/schemas/PickupAvailabilityResponse":{"id":"components/schemas/PickupAvailabilityResponse","kind":"json-schema","title":"PickupAvailabilityResponse","data":{"type":"object","properties":{"carrierAccountId":{"type":"string","description":"Carrier account ID returned for the request.","example":"xxxxxxxxx"},"carrier":{"type":"string","description":"Carrier that was validated for pickup availability.","example":"UPS"},"pickupAddress":{"type":"object","description":"Validated pickup address returned by the carrier/system.","properties":{"name":{"type":"string","example":"John Doe","description":"Contact person name at the pickup location"},"addressLine1":{"type":"string","example":"27 Waterview Dr","description":"Primary street address line"},"cityTown":{"type":"string","example":"Shelton","description":"City or town of the pickup location"},"stateProvince":{"type":"string","example":"CT","description":"State or province of the pickup location"},"postalCode":{"type":"string","example":"06484-4301","description":"Postal or ZIP code of the pickup location"},"countryCode":{"type":"string","example":"US","description":"Two-letter ISO country code"},"phone":{"type":"string","example":"1234567890","description":"Contact phone number at the pickup location"},"company":{"type":"string","example":"PB","description":"Company name associated with the pickup locatio"},"email":{"type":"string","example":"user@pb.com","description":"Contact email at the pickup location"},"residential":{"type":"boolean","description":"Indicates if the address is residential.","example":false}}},"pickupDateTime":{"type":"string","format":"date-time","description":"The pickup date/time","example":"2025-08-26T10:00:00Z"},"pickupOptions":{"type":"object","description":"Additional options for pickup eligibility.","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"Start time of the pickup window.","example":"2025-09-15T12:45:00Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"End time of the pickup window.","example":"2025-09-15T13:15:00Z"},"carrierType":{"type":"string","description":"Type of carrier service requested for the pickup.","example":"EXPRESS"},"scheduleDay":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates when the pickup is scheduled (e.g., SAME_DAY, FUTURE_DAY)."},"children":[]}]}]}],"example":"SAME_DAY"}}},"pickupAvailable":{"type":"boolean","description":"If pickup is available for the requested location and shipment..","example":true},"pickupInformation":{"type":"object","description":"Detailed pickup availability options as returned by the requested carrier.","properties":{"cutoffTime":{"type":"string","description":"Latest cutoff time for submitting pickup requests (HH:MM:SS).","example":"13:00:00"},"startCloseTimeOptions":{"type":"object","description":"Available start and close time options for scheduling pickups.","properties":{"startTimeOptions":{"type":"array","description":"List of selectable pickup start times (HH:MM:SS).","items":{"type":"string"},"example":["08:00:00"]},"closeTimeOptions":{"type":"array","description":"List of selectable pickup close times (HH:MM:SS).","items":{"type":"string"},"example":["14:00:00"]}}},"timeRangeOptions":{"type":"object","description":"Container for default/available time ranges; may be empty depending on carrier.","example":{}}}}},"example":{"carrierAccountId":"97wroboxVgbzK4N","carrier":"fedex","pickupAddress":{"addressLine1":"27 Waterview Dr","cityTown":"Shelton","company":"PB","countryCode":"US","email":"abc@test.com","name":"Test","phone":"1234567890","postalCode":"06484-4301","residential":false,"stateProvince":"CT"},"pickupDateTime":"2025-09-15T13:00:00Z","pickupOptions":{"pickupStartDateTime":"2025-09-15T12:45:00Z","pickupEndDateTime":"2025-09-15T13:15:00Z","carrierType":"EXPRESS","scheduleDay":"SAME_DAY"},"pickupAvailable":true,"pickupInformation":{"cutoffTime":"16:15:00","startCloseTimeOptions":{"startTimeOptions":["12:30:00","13:00:00"],"closeTimeOptions":["12:30:00","13:00:00","13:30:00"]},"timeRangeOptions":{}}}}},"components/schemas/schedulePickupFreightCarriersRequest":{"id":"components/schemas/schedulePickupFreightCarriersRequest","kind":"json-schema","title":"Freight Carriers","data":{"type":"object","title":"Freight Carriers","required":["pickupAddress","carrierAccountId","packageLocation","shipmentIds","pickupOptions"],"properties":{"packageLocation":{"type":"string","description":"The location where the shipment will be available for pickup at the specified pickup address.","example":"NONE"},"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"GkYM3AdrM8nE7P5"},"pickupAddress":{"type":"object","required":["name","addressLine1","postalCode","countryCode","phone"],"properties":{"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"Test"},"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"27 Waterview Dr"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Shelton"},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, use the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, an error is returned.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"US"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"2124567890"},"company":{"type":"string","description":"The company name at the pickup address, if applicable.","example":"PB"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"sender@email.com"}}},"shipmentIds":{"type":"array","description":"The list of shipment IDs included in the pickup request.","items":{"type":"string"},"example":["794797605985"]},"pickupOptions":{"type":"object","required":["pickupStartDateTime","pickupEndDateTime"],"description":"Pickup window and freight-specific pickup details.","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"The start date and time for the pickup in ISO 8601 format.","example":"2026-04-01T09:00:00Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"The end date and time for the pickup in ISO 8601 format.","example":"2026-04-01T17:00:00Z"},"overweight":{"type":"integer","description":"The number of overweight packages in the pickup.","example":2},"directDetailType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The direct detail type for the freight pickup."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directDetailType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for carrier FedEx Freight."},"children":[]}]}]}]}],"example":"BASIC"},"directDetailTransportationType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transportation type for the freight pickup."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directDetailTransportationType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for carrier FedEx Freight."},"children":[]}]}]}]}],"example":"PICKUP"},"directDetailEmail":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address of the contact person available at the pickup location."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directDetailEmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for carrier FedEx Freight."},"children":[]}]}]}]}],"example":"ritesh.pawar@pb.com"},"directDetailPhoneNumberType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of phone number provided for the pickup contact."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directDetailPhoneNumberType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for carrier FedEx Freight."},"children":[]}]}]}]}],"example":"MOBILE"},"directDetailPhone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number of the contact person available at the pickup location."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directDetailPhone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for carrier FedEx Freight."},"children":[]}]}]}]}],"example":"4406539321"}}}}}},"components/schemas/schedulePickupPurolatorRequest":{"id":"components/schemas/schedulePickupPurolatorRequest","kind":"json-schema","title":"Purolator","data":{"type":"object","title":"Purolator","required":["pickupAddress","packageLocation","pickupOptions"],"properties":{"packageLocation":{"type":"string","description":"The location where the shipment will be available for pickup at the specified pickup address.","example":"NONE","enum":["NONE","Front Door","Back Door","Side Door","Shipping","Receiving","Mail Room","Garage","Office","Reception","In/At Mailbox","Warehouse","Basement","Between Doors","Counter","Desk","Front Desk","Front Porch","Gate House","Kiosk","Lab","Loading Dock","Lobby","Mailbox","Outside Door","Parts Department","Pharmacy","Pro Shop","Security","Service Counter","Switchboard","Vault"]},"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"worba68A1zDr"},"pickupAddress":{"type":"object","required":["name","addressLine1","postalCode","countryCode","phone"],"properties":{"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"Paul Wright"},"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"638 Manitoba Ave1"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Winnipeg"},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, use the 2-letter state or province code.","example":"MB"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, an error is returned.","example":"R2W 2H2"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"CA"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"203-555-1213"},"company":{"type":"string","description":"The company name at the pickup address, if applicable.","example":"PB"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"sender@email.com"}}},"pickupSummary":{"type":"array","description":"An array of the pickup details, including the number of packages, total weight, and carrier service information.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The abbreviated name of the carrier-specific service.","example":"NDA_AM"},"packageCount":{"type":"number","description":"The total number of packages being picked up.","example":12},"totalWeight":{"type":"number","description":"The total weight of all packages to be picked up, measured in units supported by the carrier in the origin country. The value is a decimal with up to 2 decimal places.","example":320},"weightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"GM"},"parcelType":{"type":"string","description":"The type of parcel used for the shipment, as defined by the carrier. Common values include 'PKG' for package, 'ENVELOPE', 'BOX', etc.","example":"PKG"},"toAddressCountryCode":{"type":"string","description":"Destination country code.","example":"CA"}}}},"reference":{"type":"string","description":"An optional Reference related to the pickup.","example":"reference"},"pickupOptions":{"type":"object","required":["pickupStartDateTime","pickupEndDateTime"],"description":"Pickup window and freight-specific pickup details.","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"The start date and time for the pickup in ISO 8601 format.","example":"2026-05-07T14:04:05Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"The end date and time for the pickup in ISO 8601 format.","example":"2026-05-07T16:30:00Z"}}}}}},"components/schemas/schedulePickupPurolatorResponse":{"id":"components/schemas/schedulePickupPurolatorResponse","kind":"json-schema","title":"Purolator","data":{"type":"object","title":"Purolator","properties":{"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"worba68A1zDr"},"carrier":{"type":"string","description":"The carrier being used for the pickup.","example":"PUROLATOR"},"pickupAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"638 Manitoba Ave"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Winnipeg"},"company":{"type":"string","description":"The name of the company at the pickup address, if the recipient address is not residential.","example":"PB & Company"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"CA"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"sender@email.com"},"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"Paul Wright"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address.","example":"R2W2H2"},"residential":{"type":"boolean","description":"Indicates whether the pickup address is a residential location. Set to 'false' for commercial addresses.","example":false},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, it is the 2-letter state or province code.","example":"MB"}}},"packageLocation":{"type":"string","description":"The location where the parcel will be available for pickup at the specified pickup address.","example":"NONE"},"shipmentIds":{"type":"array","description":"An array of shipment identifiers associated with the pickup request.","items":{"type":"string"},"example":["PUROLATOR2202644757566914"]},"pickupSummary":{"type":"array","description":"An array of the pickup details, including the number of packages, total weight, and carrier service information.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The abbreviated name of the carrier-specific service.","example":"NDA_AM"},"packageCount":{"type":"number","description":"The total number of packages being picked up.","example":12},"totalWeight":{"type":"number","description":"The total weight of all packages to be picked up, measured in units supported by the carrier in the origin country. The value is a decimal with up to 2 decimal places.","example":320},"weightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"GM"},"toAddressCountryCode":{"type":"string","description":"The destination country code for the shipment associated with the pickup.","example":"CA"},"parcelType":{"type":"string","description":"The type of parcel used for the shipment, as defined by the carrier. Common values include 'PKG' for package, 'ENVELOPE', 'BOX', etc.","example":"PKG"}}}},"reference":{"type":"string","description":"An optional Reference related to the pickup.","example":"reference"},"pickupDateTime":{"type":"string","description":"The date and time of the pickup in ISO 8601 format.","example":"2026-05-07T14:04:05Z"},"pickupConfirmationNumber":{"type":"string","description":"The confirmation number generated when the pickup request is successfully processed.","example":"00006293"},"pickupId":{"type":"string","description":"A unique identifier for the scheduled pickup.","example":"PUROLATOR05071778149208326"},"pickupOptions":{"type":"object","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"The start date and time for the pickup in ISO 8601 format. This indicates when the pickup window begins.","example":"2026-05-07T14:04:05Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"The end date and time for the pickup in ISO 8601 format. This indicates when the pickup window closes.","example":"2026-05-07T16:30:00Z"}}},"pickupTotalWeight":{"type":"number","description":"The total weight of all packages being picked up.","example":420},"pickupTotalWeightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"GM"}}}},"components/schemas/schedulePickupCPCRequest":{"id":"components/schemas/schedulePickupCPCRequest","kind":"json-schema","title":"CPC","data":{"type":"object","title":"CPC","required":["pickupAddress","pickupOptions","additionalNotes"],"properties":{"packageLocation":{"type":"string","description":"The location where the shipment will be available for pickup at the specified pickup address.","example":"Front Door","enum":["NONE","Front Door","Back Door","Side Door","Shipping","Receiving","Knock on Door/Ring Bell","Mail Room","Garage","Office","Downstairs","Reception","In/At Mailbox","Third Party","Warehouse","Other"]},"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"wljXGR2pRqyB"},"pickupAddress":{"type":"object","required":["name","addressLine1","postalCode","countryCode","phone"],"properties":{"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"638 Manitoba Ave1"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Winnipeg"},"company":{"type":"string","description":"The name of the company at the pickup address, if the recipient address is not residential.","example":"PB & Company"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"CA"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"sender@email.com"},"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"Paul Wright"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address.","example":"R2W2H2"},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, it is the 2-letter state or province code.","example":"MB"}}},"shipmentIds":{"type":"array","description":"An array of shipment identifiers associated with the pickup request.","items":{"type":"string"},"example":["CPC2202644757662548"]},"pickupSummary":{"type":"array","description":"An array of the pickup details, including the number of packages, total weight, and carrier service information.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The abbreviated name of the carrier-specific service.","example":"NDA"},"packageCount":{"type":"number","description":"The total number of packages being picked up.","example":5},"totalWeight":{"type":"number","description":"The total weight of all packages to be picked up, measured in units supported by the carrier in the origin country. The value is a decimal with up to 2 decimal places.","example":320},"weightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"GM"},"parcelType":{"type":"string","description":"The type of parcel used for the shipment, as defined by the carrier. Common values include 'PKG' for package, 'ENVELOPE', 'BOX', etc.","example":"PKG"}}}},"additionalNotes":{"type":"string","description":"Additional instructions or notes for the carrier regarding the pickup.","example":"notes"},"reference":{"type":"string","description":"An optional Reference related to the pickup.","example":"reference"},"pickupOptions":{"type":"object","required":["pickupStartDateTime","pickupEndDateTime"],"description":"Pickup window and freight-specific pickup details.","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"The start date and time for the pickup in ISO 8601 format.","example":"2026-05-07T14:00:00Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"The end date and time for the pickup in ISO 8601 format.","example":"2026-05-07T15:00:00Z"}}}}}},"components/schemas/schedulePickupCPCResponse":{"id":"components/schemas/schedulePickupCPCResponse","kind":"json-schema","title":"CPC","data":{"type":"object","title":"CPC","properties":{"carrierAccountId":{"type":"string","description":"The unique identifier of the carrier account being used to process the pickup.","example":"wljXGR2pRqyB"},"carrier":{"type":"string","description":"The carrier being used for the pickup.","example":"CPC"},"pickupAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"First line of the address where the pickup will occur.","example":"638 Manitoba Ave1"},"cityTown":{"type":"string","description":"The city or town where the pickup address is located.","example":"Winnipeg"},"company":{"type":"string","description":"The name of the company at the pickup address, if the recipient address is not residential.","example":"PB & Company"},"countryCode":{"type":"string","description":"The two-letter country code for the pickup address.","example":"CA"},"email":{"type":"string","description":"The email address associated with the pickup location.","example":"sender@email.com"},"name":{"type":"string","description":"The name of the person or entity at the pickup address.","example":"Paul Wright"},"phone":{"type":"string","description":"The contact phone number for the pickup location.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address.","example":"R2W2H2"},"residential":{"type":"boolean","description":"Indicates whether the pickup address is a residential location. Set to 'false' for commercial addresses.","example":false},"stateProvince":{"type":"string","description":"The state or province of the pickup address. For a US or Canadian address, it is the 2-letter state or province code.","example":"MB"}}},"packageLocation":{"type":"string","description":"The location where the parcel will be available for pickup at the specified pickup address.","example":"Front Door"},"shipmentIds":{"type":"array","description":"An array of shipment identifiers associated with the pickup request.","items":{"type":"string"},"example":["CPC2202644757662548"]},"pickupSummary":{"type":"array","description":"An array of the pickup details, including the number of packages, total weight, and carrier service information.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"The abbreviated name of the carrier-specific service.","example":"NDA"},"packageCount":{"type":"number","description":"The total number of packages being picked up.","example":5},"totalWeight":{"type":"number","description":"The total weight of all packages to be picked up, measured in units supported by the carrier in the origin country. The value is a decimal with up to 2 decimal places.","example":320},"weightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"GM"},"parcelType":{"type":"string","description":"The type of parcel used for the shipment, as defined by the carrier. Common values include 'PKG' for package, 'ENVELOPE', 'BOX', etc.","example":"PKG"}}}},"additionalNotes":{"type":"string","description":"Additional instructions or notes for the carrier regarding the pickup.","example":"notes"},"reference":{"type":"string","description":"An optional Reference related to the pickup.","example":"reference"},"pickupDateTime":{"type":"string","description":"The date and time of the pickup in ISO 8601 format.","example":"2026-05-07T14:00:00Z"},"pickupConfirmationNumber":{"type":"string","description":"The confirmation number generated when the pickup request is successfully processed.","example":"27241"},"pickupId":{"type":"string","description":"A unique identifier for the scheduled pickup.","example":"CPC05071778149330531"},"pickupOptions":{"type":"object","properties":{"pickupStartDateTime":{"type":"string","format":"date-time","description":"The start date and time for the pickup in ISO 8601 format. This indicates when the pickup window begins.","example":"2026-05-07T14:00:00Z"},"pickupEndDateTime":{"type":"string","format":"date-time","description":"The end date and time for the pickup in ISO 8601 format. This indicates when the pickup window closes.","example":"2026-05-07T15:00:00Z"}}},"pickupRate":{"type":"object","description":"The pickup rate details returned for the scheduled pickup.","properties":{"baseCharge":{"type":"number","description":"The base pickup charge applied by the carrier.","example":1.7},"pickupTaxes":{"type":"array","description":"An array of taxes applied to the pickup charge.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the tax applied to the pickup.","example":"GST"},"taxAmount":{"type":"number","description":"The tax amount applied for the specified tax type.","example":0.13}}}},"totalCarrierCharge":{"type":"number","description":"The total pickup charge including all applicable taxes.","example":2.53}}},"pickupTotalWeight":{"type":"number","description":"The total weight of all packages being picked up.","example":420},"pickupTotalWeightUnit":{"type":"string","description":"The unit of measurement for the total package weight.","example":"GM"}}}},"components/schemas/additionalAddresses":{"id":"components/schemas/additionalAddresses","kind":"json-schema","title":"additionalAddresses","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of additional addresses associated with the shipment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each object includes an address and its designated type, such as BROKER or other parties involved in customs or shipping processes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional address could be domestic or International both."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"address":{"type":"object","description":"The additional address details.","properties":{"residential":{"type":"boolean","example":false,"description":"If the address is residential."},"phone":{"type":"string","example":"732-443-1007","description":"Contact phone number for the address."},"countryCode":{"type":"string","example":"US","description":"The ISO 2-letter country code."},"company":{"type":"string","example":"ABC Company","description":"The name of the company associated with the address."},"postalCode":{"type":"string","example":"08810-1411","description":"ZIP or postal code."},"cityTown":{"type":"string","example":"DAYTON","description":"Name of the city or town."},"name":{"type":"string","example":"Warehouse Manager","description":"Name of the contact person."},"stateProvince":{"type":"string","example":"NJ","description":"State or province code."},"addressLine1":{"type":"string","example":"2270 US HIGHWAY 130","description":"Primary street address line."}}},"addressType":{"type":"string","example":"EXPORTER","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the additional address (e.g., BROKER). This is required if passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalAddresses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The addressType "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHIPPER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned only in USPS responses."},"children":[]}]}]}],"enum":["HOLD","BROKER","THIRD_PARTY","PICKUP","EXPORTER","ALT_DELIVERY","SHIPPER"]}}}}},"components/schemas/soldToAddress":{"id":"components/schemas/soldToAddress","kind":"json-schema","title":"soldToAddress","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing address of the buyer responsible for the shipment payment. It can be domestic or international address. This is a required field for carrier UPS."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the importer is the same as the final recipient, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must match."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the importer is different from the final recipient, enter the importer address in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldToAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and enter the final recipient's address in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"addressLine1":{"type":"string","example":"70 Hanlan RD","description":"Primary street address of the billing entity."},"addressLine2":{"type":"string","example":"Suite 101","description":"Additional address information such as apartment, suite, or unit number."},"addressLine3":{"type":"string","example":"Near central market","description":"Optional extra address details."},"company":{"type":"string","example":"ABC Company","description":"The name of the company associated with the SoldTo address."},"name":{"type":"string","example":"John Doe","description":"The contact person's full name for the billing entity."},"phone":{"type":"string","example":"905-555-1234","description":"Phone number of the SoldTo entity."},"email":{"type":"string","example":"billing@abccompany.com","description":"Email address of the SoldTo entity."},"residential":{"type":"boolean","example":false,"description":"Indicates whether the SoldTo address is a residential location (true/false)."},"cityTown":{"type":"string","example":"Woodbridge","description":"City or town of the billing address."},"stateProvince":{"type":"string","example":"ON","description":"State or province of the billing address."},"postalCode":{"type":"string","example":"L4L 3P6","description":"Postal or ZIP code of the billing address."},"countryCode":{"type":"string","example":"CA","description":"Two-letter country code of the billing address (ISO 3166-1 alpha-2)."}}}},"components/schemas/MultipieceShipmentRequest":{"id":"components/schemas/MultipieceShipmentRequest","kind":"json-schema","title":"MultipieceShipmentRequest","data":{"type":"object","required":["carrierAccountId","size","fromAddress","toAddress","multiPieceParcels","serviceId"],"properties":{"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (4' X 8' or 8.5' X 11'). It supports the document sizes as per the eligible carrier size support.","enum":["DOC_8X11","DOC_4X8","DOC_4X6"],"example":"DOC_4X8"},"format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the multipiece shipment label that is printed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PDF supports content type URL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZPL2 supports content type BASE64."},"children":[]}]}]}],"enum":["PDF","ZPL2"],"example":"PDF"},"type":{"type":"string","description":"Defines the type of the Shipment, e.g., Shipping Label.","example":"SHIPPING_LABEL","enum":["SHIPPING_LABEL"]},"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the label content is encoded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" . "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" BASE64 is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZPL2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"URL","enum":["URL","BASE64"]},"fromAddress":{"type":"object","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the sender address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"countryCode":{"type":"string","description":"The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"carrierAccountId":{"type":"string","description":" A unique identifier associated with the Carrier account used by client users during shipment process.","example":"4J67bLB62BG"},"serviceId":{"type":"string","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-A unique identifier given to the carrier-specific service. This is required for creating a shipment, while it is optional for rating a parcel."},"children":[]}]}]}]}],"example":"NDA"},"shipmentOptions":{"type":"object","description":"Additional options for the shipment.","properties":{"printCustomMessage":{"type":"string","description":"A custom message to be printed on each parcel label of the shipment.","example":"custom message"},"printDepartment":{"type":"string","description":"Department Name to be printed on each parcel label of the shipment.","example":"DepartmentABC"},"printInvoiceNumber":{"type":"string","description":"Invoice number to be printed on each parcel label of the shipment.","example":"NV2345"},"printPONumber":{"type":"string","description":"PO number to be printed on each parcel label of the shipment.","example":"PO4567"},"minimalAddressValidation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows performing minimal address validation during shipment creation. the addressLine1 field is not validated if set to true."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimal address validation is supported only for these APIs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Shipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Bulk Shipments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Multipiece Shipment"},"children":[]}]}]}]}],"example":false,"enum":[true,false]},"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"}}},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"metadata":{"type":"array","description":"An array containing custom metadata for the shipment.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the metadata field.","example":"costAccountName"},"value":{"type":"string","description":"The value of the metadata field.","example":"cost account 123"}}}},"multiPieceParcels":{"type":"array","description":"Details of each parcel in the shipment.","items":{"type":"object","properties":{"parcelType":{"type":"string","description":"The type of parcel.","enum":["PKG"]},"parcel":{"type":"object","description":"Information about the parcel's dimensions and weight.","properties":{"weight":{"type":"number","description":"The weight of the parcel."},"weightUnit":{"type":"string","description":"The unit used to measure the parcel's weight."},"width":{"type":"number","description":"The width of the parcel."},"length":{"type":"number","description":"The length of the parcel."},"height":{"type":"number","description":"The height of the parcel."},"dimUnit":{"type":"string","description":"The unit used to measure the dimensions of the parcel."}}},"specialServices":{"type":"array","description":"Special services applied to the shipment.","items":{"type":"object","properties":{"specialServiceId":{"type":"string","description":"Special service identifier.","example":"ADULT_SIG"},"fee":{"type":"number","description":"Fee for the special service.","example":9.35},"inputParameters":{"type":"array","description":"Input parameters for the special service (if applicable).","items":{"type":"object","properties":{"name":{"type":"string","example":"INPUT_VALUE"},"value":{"type":"string","example":"200.00"}}}}}}},"parcelShipmentOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel-level references are supported for carrier FedEx as of now. These references override shipment-level values and will be printed on the specific parcel label where provided. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If only shipment-level references are provided, these references will be printed on all parcel labels.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If only parcel-level references are provided, each parcel label will be printed with its own parcel-specific references. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\tIf both shipment-level and parcel-level references are provided, the parcel-level references take precedence and will be printed on the corresponding parcel labels. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\tIf shipment-level references are provided along with parcel-level references for some parcels, parcel-level references will be printed where provided; shipment-level references will be printed for the remaining parcels."},"children":[]}]}]}],"properties":{"printCustomMessage":{"type":"string","description":"Custom message to be printed on the specific parcel label.","example":"Handle with care - Parcel 1"},"printDepartment":{"type":"string","description":"Department name to be printed on the specific parcel label.","example":"Dept-A1"},"printInvoiceNumber":{"type":"string","description":"Invoice number to be printed on the specific parcel label.","example":"INV-1001"},"printPONumber":{"type":"string","description":"Purchase order number to be printed on the specific parcel label.","example":"PO-2001"}}}}},"example":[{"parcelType":"PKG","parcel":{"weight":10,"weightUnit":"OZ","width":10,"length":10,"height":10,"dimUnit":"IN"},"parcelShipmentOptions":{"printCustomMessage":"custom message 1","printDepartment":"Department 1","printInvoiceNumber":"invoice number 1","printPONumber":"ponumber 1"}},{"parcelType":"PKG","parcel":{"weight":8,"weightUnit":"OZ","width":8,"length":8,"height":8,"dimUnit":"IN"},"specialServices":[{"specialServiceId":"ADULT_SIG"}]}]},"toAddress":{"type":"object","description":"The recipient's address information.","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"28 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Receiver name"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the receiver address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be recipient’s valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by FedEx, UPS and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"29 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"}}}},"components/schemas/MultipieceShipmentInternationalRequest":{"id":"components/schemas/MultipieceShipmentInternationalRequest","kind":"json-schema","title":"MultipieceShipmentInternationalRequest","data":{"type":"object","properties":{"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size ( 8' X 11'). It supports the document sizes as per the eligible carrier size support.","enum":["DOC_8X11","DOC_4X8","DOC_4X6"],"example":"DOC_8X11"},"format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of the multipiece shipment label that is printed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PDF supports content type URL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZPL2 supports content type BASE64."},"children":[]}]}]}],"enum":["PDF","ZPL2"],"example":"PDF"},"type":{"type":"string","description":"Defines the type of the Shipment, e.g., Shipping Label.","example":"SHIPPING_LABEL","enum":["SHIPPING_LABEL"]},"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the label content is encoded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" . "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" BASE64 is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ZPL2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"URL","enum":["URL","BASE64"]},"fromAddress":{"type":"object","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the sender address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"countryCode":{"type":"string","description":"The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"taxId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tax Identification Number (TIN). TIN Number is supported for FedEx as of now."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max character length = 18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOSS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EORI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_UNION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 12 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 13 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"taxIdType":{"type":"string","description":"Specifies the type of tax identification being provided.","enum":["EIN","GST","VAT","IOSS","RFC","EORI"]}}},"carrierAccountId":{"type":"string","description":" A unique identifier associated with the Carrier account used by client users during shipment process.","example":"4J67bLB62BG"},"serviceId":{"type":"string","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-A unique identifier given to the carrier-specific service. This is required for creating a shipment, while it is optional for rating a parcel."},"children":[]}]}]}]}],"example":"EXP"},"shipmentOptions":{"type":"object","description":"Additional options for shipment.","properties":{"printCustomMessage":{"type":"string","description":"A custom message to be printed on each parcel label of the shipment.","example":"custom message"},"printDepartment":{"type":"string","description":"Department Name to be printed on each parcel label of the shipment.","example":"DepartmentABC"},"printInvoiceNumber":{"type":"string","description":"Invoice number to be printed on each parcel label of the shipment.","example":"NV2345"},"printPONumber":{"type":"string","description":"PO number to be printed on each parcel label of the shipment.","example":"PO4567"},"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"}}},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"metadata":{"type":"array","description":"An array containing custom metadata for the shipment.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the metadata field.","example":"costAccountName"},"value":{"type":"string","description":"The value of the metadata field.","example":"cost account 123"}}}},"multiPieceParcels":{"type":"array","description":"Details of each parcel in the shipment.","items":{"type":"object","properties":{"parcelType":{"type":"string","description":"The type of parcel.","example":"PKG","enum":["PKG"]},"parcel":{"type":"object","description":"Information about the parcel's dimensions and weight.","properties":{"weight":{"type":"number","description":"The weight of the parcel."},"weightUnit":{"type":"string","description":"The unit used to measure the parcel's weight."},"width":{"type":"number","description":"The width of the parcel."},"length":{"type":"number","description":"The length of the parcel."},"height":{"type":"number","description":"The height of the parcel."},"dimUnit":{"type":"string","description":"The unit used to measure the dimensions of the parcel."}}},"parcelShipmentOptions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel-level references are supported for carrier FedEx as of now. These references override shipment-level values and will be printed on the specific parcel label where provided. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If only shipment-level references are provided, these references will be printed on all parcel labels.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If only parcel-level references are provided, each parcel label will be printed with its own parcel-specific references. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\tIf both shipment-level and parcel-level references are provided, the parcel-level references take precedence and will be printed on the corresponding parcel labels. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\tIf shipment-level references are provided along with parcel-level references for some parcels, parcel-level references will be printed where provided; shipment-level references will be printed for the remaining parcels."},"children":[]}]}]}],"properties":{"printCustomMessage":{"type":"string","description":"Custom message to be printed on the specific parcel label.","example":"Handle with care - Parcel 1"},"printDepartment":{"type":"string","description":"Department name to be printed on the specific parcel label.","example":"Dept-A1"},"printInvoiceNumber":{"type":"string","description":"Invoice number to be printed on the specific parcel label.","example":"INV-1001"},"printPONumber":{"type":"string","description":"Purchase order number to be printed on the specific parcel label.","example":"PO-2001"}}}}},"example":[{"parcelType":"PKG","parcel":{"weight":10,"weightUnit":"OZ","width":10,"length":10,"height":10,"dimUnit":"IN"},"parcelShipmentOptions":{"printCustomMessage":"custom message 1","printDepartment":"Department 1","printInvoiceNumber":"invoice number 1","printPONumber":"ponumber 1"}},{"parcelType":"PKG","parcel":{"weight":8,"weightUnit":"OZ","width":8,"length":8,"height":8,"dimUnit":"IN"}}]},"toAddress":{"type":"object","description":"The recipient's address information.","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"638 Manitoba Ave"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Winnipeg"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"CA"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Recipient Name"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the receiver address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be recipient's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"R2W 2H2"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"MB"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"taxId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tax Identification Number (TIN). TIN Number is supported for FedEx as of now."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max character length = 18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOSS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EORI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_UNION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 12 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 13 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"taxIdType":{"type":"string","description":"Specifies the type of tax identification being provided.","enum":["EIN","GST","VAT","IOSS","RFC","EORI"]}}},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by FedEx, UPS and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"29 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}},"customs":{"required":["customsInfo","customsItems"],"type":"object","properties":{"customsInfo":{"required":["currencyCode"],"type":"object","properties":{"reasonForExport":{"type":"string","example":"GIFT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason the commodity is being exported. Valid values are: Valid Values: [GIFT COMMERCIAL_SAMPLE MERCHANDISE DOCUMENTS RETURNED_GOODS OTHER SOLD NOT_SOLD]"},"children":[]}]}]}]},"customsDeclaredValue":{"type":"number","example":200,"description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the value to declare in customs for the shipment. Enter the value in the currency specified in the currencyCode field."},"children":[]}]}]}]}]}],"format":"double","x-go-name":"CustomsDeclaredValue"},"currencyCode":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-The type of currency used for the monetary values in this API request. Use three uppercase letters, per ISO 4217. For example, use USD for US Dollars, CAD for Canadian Dollars, and EUR for Euros."},"children":[]}]}]}]}],"x-go-name":"CurrencyCode"},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"certificateNumber":{"type":"string","example":"98788877","description":"The certificate number associated with the commodity."},"comments":{"type":"string","example":"Gift for birthday","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-Free form comments regarding the exported shipment entered by the shipper."},"children":[]}]}]}]}],"x-go-name":"Comments"},"fromCustomsReference":{"type":"string","example":"123456789","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-Free form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents."},"children":[]}]}]}]}],"x-go-name":"FromCustomsReference"},"importerCustomsReference":{"type":"string","example":"55454","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A reference number used by the importer, such as a VAT number, PO number, or insured number. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shipments to the EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchants  shipping to the European Union (EU) from outside the EU must provide a VAT or IOSS number. Enter the number in this field and specify the reference type in the importerCustomsReferenceType field."},"children":[]}]}]}]}]}],"x-go-name":"ImporterCustomsReference"},"invoiceNumber":{"type":"string","example":"123456789","description":"The commercial invoice number assigned by the exporter.","x-go-name":"InvoiceNumber"},"licenseNumber":{"type":"string","example":"456ABC123","description":"The export license number associated with the commodity."},"sdrValue":{"type":"number","example":200,"description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values. E.g., $100 USD = 66.87 SDR."},"children":[]}]}]}]}],"format":"double","x-go-name":"SdrValue"},"termsOfSale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the delivery and payment terms between the shipper and recipient. Currenty supported by carriers - UPS, FedEx and DHL. - Common values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CIP: Carriage and Insurance Paid to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPT: Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAP: Delivered at Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAT: Delivered at Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DDP: Delivered Duty Paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXW: Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FCA: Free Carrier"},"children":[]}]}]}]}],"example":"DDP","enum":["CIP","CPT","DAP","DAT","DDP","EXW","FCA"]}}},"customsItems":{"required":["description","quantity","unitPrice","weight","weightUnit"],"type":"array","items":{"type":"object","properties":{"description":{"type":"object","description":"A detailed description of the commodity."},"itemId":{"type":"string","description":"Unique identifier for the commodity.","example":"item1"},"orderNumber":{"type":"string","description":"The unique identifier for the order.","example":"ORD1"},"hSTariffCode":{"type":"string","example":"490191","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination country's tariff-classification number for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and add additional digits for more detail. The maximum length is 14 characters. If you are issuing the HS Code API, you can use this field to help with the HS code prediction by entering the commodity's HS code from another country, such as from the origin country. Enter the country that theode comes from in the hSTariffCodeCountry field."},"children":[]}]}]}]}]}],"x-go-name":"HSTariffCode"},"originCountryCode":{"type":"string","example":"US"},"quantity":{"type":"integer","example":1,"description":"Enter the total number of items of this type of commodity.","format":"int32","x-go-name":"Quantity"},"unitPrice":{"type":"number","example":200,"description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of one item of this type of commodity. Currency should be declared under customsInfo."},"children":[]}]}]}]}]}],"format":"double","x-go-name":"UnitPrice"},"weightUnit":{"type":"string","enum":["OZ"],"description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"The weight of the item.","example":1}}}}}}}}},"components/schemas/MultipieceShipmentResponse":{"id":"components/schemas/MultipieceShipmentResponse","kind":"json-schema","title":"MultipieceShipmentResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"00da5e928af44bcc9e5c092163e036f9"},"labelLayout":{"type":"array","description":"Defines the layout and content details of the shipping label.","items":{"type":"object","description":"Specific details of the shipping label document.","properties":{"contentType":{"type":"string","description":"Specifies how the label content is encoded. If the file format is 'PDF', 'URL' is used to reference the document's location. For 'ZPL2' files, 'BASE64' encoding is used to represent the binary data as printable text.","example":"URL","enum":["URL","BASE64"]},"contents":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL to access the label document if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the Base64-encoded data if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASE64"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://225934331380-sending-service-qa.s3-fips.us-east-1.amazonaws.com/temp-labels/UPS2200619919802570P0.pdf"},"fileFormat":{"type":"string","description":"The format of the label document file the print takes.","example":"PDF","enum":["PDF","ZPL2"]},"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (4' X 6' or 8' X 11').","enum":["DOC_8X11","DOC_4X6"],"example":"DOC_8X11"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of label document, such as 'SHIPPING_LABEL'."},"children":[]}]}]}],"example":"SHIPPING_LABEL","enum":["SHIPPING_LABEL"]}}}},"fromAddress":{"type":"object","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the sender address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"countryCode":{"type":"string","description":"The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"multiPieceRates":{"type":"array","description":"Details of the rates for multipiece shipments, including carrier information and parcel-specific charges.","items":{"type":"object","description":"Individual rate information for a multipiece shipment.","properties":{"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier for the entire shipment, including base charges, special service fees, surcharges, and any applicable international taxes and duties.","example":217.11},"carrier":{"type":"string","description":"The name of the carrier providing the shipping service.","example":"UPS"},"currencyCode":{"type":"string","description":"The currency code in which the rates are calculated.","example":"USD"},"deliveryCommitment":{"type":"object","description":"It specifies the delivery commitment provided by carrier for this shipment","properties":{"estimatedDeliveryDateTime":{"type":"string","description":"It specifies estimated delivery date time","example":"2024-12-17 13:30:00"},"guarantee":{"type":"string","description":"It specifies if guarantee is provided for this shipment.","example":"full"}}},"rateTypeId":{"type":"string","description":"The identifier for the type of rate applied.","example":"commercial"},"serviceId":{"type":"string","description":"The identifier for the shipping service used.","example":"NDA"},"serviceName":{"type":"string","description":"The name of the shipping service.","example":"NDA"},"multiPieceParcels":{"type":"array","description":"Details of each parcel within the multi-piece shipment.","items":{"type":"object","description":"Information about an individual parcel in the shipment.","properties":{"parcelType":{"type":"string","description":"The type of parcel.","example":"PKG"},"parcel":{"type":"object","description":"The dimensions and weight information for the parcel.","properties":{"length":{"type":"number","description":"The length of the parcel in the specified unit of measurement.","example":10},"height":{"type":"number","description":"The height of the parcel in the specified unit of measurement.","example":10},"width":{"type":"number","description":"The width of the parcel in the specified unit of measurement.","example":10},"dimUnit":{"type":"string","description":"The unit of measurement for the parcel's dimensions.","example":"IN"},"weightUnit":{"type":"string","description":"The unit of measurement for the parcel's weight.","example":"OZ"},"weight":{"type":"number","description":"The weight of the parcel in the specified weight unit.","example":10}}},"parcelRate":{"type":"object","description":"Details of the charges applicable to the individual parcel.","properties":{"baseCharge":{"type":"number","description":"The base charge for shipping the parcel.","example":88.67},"surcharges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fees or surcharges applied to the shipment. Each object in the array represents a specific surcharge and its associated fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be one of the supported surcharge types from the respective carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Surcharge Names by Carrier:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge Names"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FUEL, GO_GREEN_BASIC, OVERSIZE, PREMIUM, RURAL, TOLL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANCILLARY_FEE, CANADIAN_DESTINATION, DELIVERY_AREA, DELIVERY_CONFIRMATION, FUEL, NON_MACHINABLE, OTHER, OUT_OF_DELIVERY_AREA, OUT_OF_PICKUP_AREA, OVERSIZE, RESIDENTIAL_DELIVERY, RESIDENTIAL_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERY_AREA, EXTENDED_AREA, FUEL, LARGE_PACKAGE, RESIDENTIAL, SHIPPER_PAYS_DUTY_TAX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nonmachinable, oversize"},"children":[]}]}]}]}]}]}],"items":{"type":"object","description":"Details of each surcharge applied.","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":15.33},"name":{"type":"string","description":"The name or type of surcharge.","example":"FUEL"}}}}}},"parcelTrackingNumber":{"type":"string","description":"The tracking number assigned to the individual parcel.","example":"UPS2200619919802570P0"},"parcelShipmentOptions":{"type":"object","description":"Parcel-level references are supported for carrier FedEx as of now. These references override shipment-level values and will be printed on the specific parcel label where provided.\n","properties":{"printCustomMessage":{"type":"string","description":"Custom message to be printed on the specific parcel label.","example":"Handle with care - Parcel 1"},"printDepartment":{"type":"string","description":"Department name to be printed on the specific parcel label.","example":"Dept-A1"},"printInvoiceNumber":{"type":"string","description":"Invoice number to be printed on the specific parcel label.","example":"INV-1001"},"printPONumber":{"type":"string","description":"Purchase order number to be printed on the specific parcel label.","example":"PO-2001"}},"example":[{"parcelType":"PKG","parcel":{"weight":10,"weightUnit":"OZ","width":10,"length":10,"height":10,"dimUnit":"IN"},"parcelShipmentOptions":{"printCustomMessage":"custom message 1","printDepartment":"Department 1","printInvoiceNumber":"invoice number 1","printPONumber":"ponumber 1"}},{"parcelType":"PKG","parcel":{"weight":8,"weightUnit":"OZ","width":8,"length":8,"height":8,"dimUnit":"IN"}}]}}}},"surcharges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fees or surcharges applied to the shipment. Each object in the array represents a specific surcharge and its associated fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be one of the supported surcharge types from the respective carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Surcharge Names by Carrier:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge Names"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FUEL, GO_GREEN_BASIC, OVERSIZE, PREMIUM, RURAL, TOLL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANCILLARY_FEE, CANADIAN_DESTINATION, DELIVERY_AREA, DELIVERY_CONFIRMATION, FUEL, NON_MACHINABLE, OTHER, OUT_OF_DELIVERY_AREA, OUT_OF_PICKUP_AREA, OVERSIZE, RESIDENTIAL_DELIVERY, RESIDENTIAL_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERY_AREA, EXTENDED_AREA, FUEL, LARGE_PACKAGE, RESIDENTIAL, SHIPPER_PAYS_DUTY_TAX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nonmachinable, oversize"},"children":[]}]}]}]}]}]}],"items":{"type":"object","description":"Details of each surcharge applied to the shipment.","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":11.3},"name":{"type":"string","description":"The name or type of surcharge.","example":"RESIDENTIAL"}}}},"publishedTotalCarrierCharge":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount based on the carrier's standard (published) rates, including base charges, surcharges, special services, discounts, and applicable taxes. This value reflects the amount the carrier would charge without any negotiated discounts or platform-specific rate adjustments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only when supported by the carrier (e.g., FedEx, UPS, DHL, USPS).\""},"children":[]}]}]}]}],"example":73.12}}}},"parcelTrackingNumber":{"type":"string","description":"The tracking number assigned to the entire shipment.","example":"UPS2200619919802570P0"},"shipmentId":{"type":"string","description":"A unique identifier for the shipment.","example":"UPS2200619919802570"},"shipmentOptions":{"type":"object","description":"Additional options associated with the shipment.","properties":{"printCustomMessage":{"type":"string","description":"A custom message to be printed on each parcel label of the shipment.","example":"custom message"},"printDepartment":{"type":"string","description":"Department Name to be printed on each parcel label of the shipment.","example":"DepartmentABC"},"printInvoiceNumber":{"type":"string","description":"Invoice number to be printed on each parcel label of the shipment.","example":"NV2345"},"printPONumber":{"type":"string","description":"PO number to be printed on each parcel label of the shipment.","example":"PO4567"},"billingWeight":{"type":"string","description":"The weight used by the carrier to calculate the shipping cost. This value is determined as the greater of the actual weight and the dimensional weight.\n","example":"128.0"},"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"}}},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"toAddress":{"type":"object","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"28 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Recipient Name"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the receiver address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be recipient’s valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"recipient@yopmail.com"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by FedEx, UPS and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"29 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"}}}},"components/schemas/MultipieceShipmentSplitParcelLabelResponse":{"id":"components/schemas/MultipieceShipmentSplitParcelLabelResponse","kind":"json-schema","title":"MultipieceShipmentSplitParcelLabelResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"00da5e928af44bcc9e5c092163e036f9"},"labelLayout":{"type":"array","description":"Defines the layout and content details of the shipping label.","items":{"type":"object","description":"Specific details of the shipping label document.","properties":{"contentType":{"type":"string","description":"Specifies how the label content is encoded. If the file format is 'PDF', 'URL' is used to reference the document's location. For 'ZPL2' files, 'BASE64' encoding is used to represent the binary data as printable text.","example":"URL","enum":["URL","BASE64"]},"contents":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL to access the label document if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the Base64-encoded data if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASE64"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://225934331380-sending-service-qa.s3-fips.us-east-1.amazonaws.com/temp-labels/UPS2200619919802570P0.pdf"},"fileFormat":{"type":"string","description":"The format of the label document file the print takes.","example":"PDF","enum":["PDF","ZPL2"]},"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (4' X 6' or 8' X 11').","enum":["DOC_8X11","DOC_4X6"],"example":"DOC_8X11"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of label document, such as 'SHIPPING_LABEL'."},"children":[]}]}]}],"example":"SHIPPING_LABEL","enum":["SHIPPING_LABEL"]}}}},"fromAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the sender address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"countryCode":{"type":"string","description":"The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"multiPieceRates":{"type":"array","description":"Details of the rates for multipiece shipments, including carrier information and parcel-specific charges.","items":{"type":"object","description":"Individual rate information for a multipiece shipment.","properties":{"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier for the entire shipment, including base charges, special service fees, surcharges, and any applicable international taxes and duties.","example":217.11},"carrier":{"type":"string","description":"The name of the carrier providing the shipping service.","example":"UPS"},"currencyCode":{"type":"string","description":"The currency code in which the rates are calculated.","example":"USD"},"deliveryCommitment":{"type":"object","description":"It specifies the delivery commitment provided by carrier for this shipment","properties":{"estimatedDeliveryDateTime":{"type":"string","description":"It specifies estimated delivery date time","example":"2024-12-17 13:30:00"},"guarantee":{"type":"string","description":"It specifies if guarantee is provided for this shipment.","example":"full"}}},"rateTypeId":{"type":"string","description":"The identifier for the type of rate applied.","example":"commercial"},"serviceId":{"type":"string","description":"The identifier for the shipping service used.","example":"NDA"},"serviceName":{"type":"string","description":"The name of the shipping service.","example":"NDA"},"multiPieceParcels":{"type":"array","description":"Details of each parcel within the multi-piece shipment.","items":{"type":"object","description":"Information about an individual parcel in the shipment.","properties":{"parcelType":{"type":"string","description":"The type of parcel.","example":"PKG"},"parcel":{"type":"object","description":"The dimensions and weight information for the parcel.","properties":{"length":{"type":"number","description":"The length of the parcel in the specified unit of measurement.","example":10},"height":{"type":"number","description":"The height of the parcel in the specified unit of measurement.","example":10},"width":{"type":"number","description":"The width of the parcel in the specified unit of measurement.","example":10},"dimUnit":{"type":"string","description":"The unit of measurement for the parcel's dimensions.","example":"IN"},"weightUnit":{"type":"string","description":"The unit of measurement for the parcel's weight.","example":"OZ"},"weight":{"type":"number","description":"The weight of the parcel in the specified weight unit.","example":10}}},"parcelRate":{"type":"object","description":"Details of the charges applicable to the individual parcel.","properties":{"baseCharge":{"type":"number","description":"The base charge for shipping the parcel.","example":88.67},"surcharges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fees or surcharges applied to the shipment. Each object in the array represents a specific surcharge and its associated fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be one of the supported surcharge types from the respective carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Surcharge Names by Carrier:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge Names"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FUEL, GO_GREEN_BASIC, OVERSIZE, PREMIUM, RURAL, TOLL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANCILLARY_FEE, CANADIAN_DESTINATION, DELIVERY_AREA, DELIVERY_CONFIRMATION, FUEL, NON_MACHINABLE, OTHER, OUT_OF_DELIVERY_AREA, OUT_OF_PICKUP_AREA, OVERSIZE, RESIDENTIAL_DELIVERY, RESIDENTIAL_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERY_AREA, EXTENDED_AREA, FUEL, LARGE_PACKAGE, RESIDENTIAL, SHIPPER_PAYS_DUTY_TAX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nonmachinable, oversize"},"children":[]}]}]}]}]}]}],"items":{"type":"object","description":"Details of each surcharge applied.","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":15.33},"name":{"type":"string","description":"The name or type of surcharge.","example":"FUEL"}}}}}},"parcelTrackingNumber":{"type":"string","description":"The tracking number assigned to the individual parcel.","example":"UPS2200619919802570P0"},"parcelShipmentOptions":{"type":"object","description":"Parcel-level references are supported for carrier FedEx as of now. These references override shipment-level values and will be printed on the specific parcel label where provided.\n","properties":{"printCustomMessage":{"type":"string","description":"Custom message to be printed on the specific parcel label.","example":"Handle with care - Parcel 1"},"printDepartment":{"type":"string","description":"Department name to be printed on the specific parcel label.","example":"Dept-A1"},"printInvoiceNumber":{"type":"string","description":"Invoice number to be printed on the specific parcel label.","example":"INV-1001"},"printPONumber":{"type":"string","description":"Purchase order number to be printed on the specific parcel label.","example":"PO-2001"}}},"document":{"type":"object","description":"Details of the shipping label for an individual parcel in a multipiece shipment.","properties":{"contentType":{"type":"string","description":"Specifies how the label content is encoded. If the file format is 'PDF', 'URL' is used to reference the document's location. For 'ZPL2' files, 'BASE64' encoding is used to represent the binary data as printable text.","example":"URL","enum":["URL","BASE64"]},"contents":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL to access the label document if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the Base64-encoded data if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASE64"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://225934331380-sending-service-qa.s3-fips.us-east-1.amazonaws.com/temp-labels/UPS2200619919802570P0.pdf"},"fileFormat":{"type":"string","description":"The format of the label document file the print takes.","example":"PDF","enum":["PDF","ZPL2"]},"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (4' X 6' or 8' X 11').","enum":["DOC_8X11","DOC_4X6"],"example":"DOC_8X11"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of label document, such as 'SHIPPING_LABEL'."},"children":[]}]}]}],"example":"SHIPPING_LABEL","enum":["SHIPPING_LABEL"]}}}}}},"surcharges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fees or surcharges applied to the shipment. Each object in the array represents a specific surcharge and its associated fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be one of the supported surcharge types from the respective carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Surcharge Names by Carrier:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge Names"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FUEL, GO_GREEN_BASIC, OVERSIZE, PREMIUM, RURAL, TOLL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANCILLARY_FEE, CANADIAN_DESTINATION, DELIVERY_AREA, DELIVERY_CONFIRMATION, FUEL, NON_MACHINABLE, OTHER, OUT_OF_DELIVERY_AREA, OUT_OF_PICKUP_AREA, OVERSIZE, RESIDENTIAL_DELIVERY, RESIDENTIAL_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERY_AREA, EXTENDED_AREA, FUEL, LARGE_PACKAGE, RESIDENTIAL, SHIPPER_PAYS_DUTY_TAX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nonmachinable, oversize"},"children":[]}]}]}]}]}]}],"items":{"type":"object","description":"Details of each surcharge applied to the shipment.","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":11.3},"name":{"type":"string","description":"The name or type of surcharge.","example":"RESIDENTIAL"}}}},"publishedTotalCarrierCharge":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount based on the carrier's standard (published) rates, including base charges, surcharges, special services, discounts, and applicable taxes. This value reflects the amount the carrier would charge without any negotiated discounts or platform-specific rate adjustments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only when supported by the carrier (e.g., FedEx, UPS, DHL, USPS).\""},"children":[]}]}]}]}],"example":73.12}}}},"parcelTrackingNumber":{"type":"string","description":"The tracking number assigned to the entire shipment.","example":"UPS2200619919802570P0"},"shipmentId":{"type":"string","description":"A unique identifier for the shipment.","example":"UPS2200619919802570"},"shipmentOptions":{"type":"object","description":"Additional options associated with the shipment.","properties":{"billingWeight":{"type":"string","description":"The weight used by the carrier to calculate the shipping cost. This value is determined as the greater of the actual weight and the dimensional weight.\n","example":"128.0"},"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"}}},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"toAddress":{"type":"object","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"28 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Recipient Name"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the receiver address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be recipient’s valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"recipient@yopmail.com"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by FedEx, UPS and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"29 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"}}}},"components/schemas/MultipieceShipmentInternationalResponse":{"id":"components/schemas/MultipieceShipmentInternationalResponse","kind":"json-schema","title":"MultipieceShipmentInternationalResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"00da5e928af44bcc9e5c092163e036f9"},"labelLayout":{"type":"array","description":"Defines the layout and content details of the shipping label.","items":{"type":"object","description":"Specific details of the shipping label document.","properties":{"contentType":{"type":"string","description":"Specifies how the label content is encoded. If the file format is 'PDF', 'URL' is used to reference the document's location. For 'ZPL2' files, 'BASE64' encoding is used to represent the binary data as printable text.","example":"URL","enum":["URL","BASE64"]},"contents":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL to access the label document if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the Base64-encoded data if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASE64"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://225934331380-sending-service-qa.s3-fips.us-east-1.amazonaws.com/temp-labels/UPS2200619919802570P0.pdf"},"fileFormat":{"type":"string","description":"The format of the label document file the print takes.","example":"PDF","enum":["PDF","ZPL2"]},"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (4' X 6' or 8' X 11').","enum":["DOC_8X11","DOC_4X6"],"example":"DOC_8X11"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of label document, such as 'SHIPPING_LABEL'."},"children":[]}]}]}],"example":"SHIPPING_LABEL","enum":["SHIPPING_LABEL"]}}}},"fromAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the sender address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"countryCode":{"type":"string","description":"The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"taxId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tax Identification Number (TIN). TIN Number is supported for FedEx as of now."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max character length = 18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOSS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EORI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_UNION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 12 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 13 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"taxIdType":{"type":"string","description":"Specifies the type of tax identification being provided.","enum":["EIN","GST","VAT","IOSS","RFC","EORI"]}}},"multiPieceRates":{"type":"array","description":"Details of the rates for multipiece shipments, including carrier information and parcel-specific charges.","items":{"type":"object","description":"Individual rate information for a multipiece shipment.","properties":{"baseCharge":{"type":"number","description":"","example":193.84},"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier for the entire shipment, including base charges, special service fees, surcharges, and any applicable international taxes and duties.","example":217.11},"carrier":{"type":"string","description":"The name of the carrier providing the shipping service.","example":"UPS"},"currencyCode":{"type":"string","description":"The currency code in which the rates are calculated.","example":"USD"},"deliveryCommitment":{"type":"object","description":"It specifies the delivery commitment provided by carrier for this shipment","properties":{"guarantee":{"type":"string","description":"It specifies if guarantee is provided for this shipment.","example":"full"}}},"rateTypeId":{"type":"string","description":"The identifier for the type of rate applied.","example":"commercial"},"serviceId":{"type":"string","description":"The identifier for the shipping service used.","example":"NDA"},"multiPieceParcels":{"type":"array","description":"Details of each parcel within the multi-piece shipment.","items":{"type":"object","description":"Information about an individual parcel in the shipment.","properties":{"parcelType":{"type":"string","description":"The type of parcel.","example":"PKG"},"parcel":{"type":"object","description":"The dimensions and weight information for the parcel.","properties":{"length":{"type":"number","description":"The length of the parcel in the specified unit of measurement.","example":10},"height":{"type":"number","description":"The height of the parcel in the specified unit of measurement.","example":10},"width":{"type":"number","description":"The width of the parcel in the specified unit of measurement.","example":10},"dimUnit":{"type":"string","description":"The unit of measurement for the parcel's dimensions.","example":"IN"},"weightUnit":{"type":"string","description":"The unit of measurement for the parcel's weight.","example":"OZ"},"weight":{"type":"number","description":"The weight of the parcel in the specified weight unit.","example":10}}},"parcelRate":{"type":"object","description":"Details of the charges applicable to the individual parcel.","properties":{"baseCharge":{"type":"number","description":"The base charge for shipping the parcel.","example":88.67},"surcharges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fees or surcharges applied to the shipment. Each object in the array represents a specific surcharge and its associated fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be one of the supported surcharge types from the respective carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Surcharge Names by Carrier:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge Names"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FUEL, GO_GREEN_BASIC, OVERSIZE, PREMIUM, RURAL, TOLL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANCILLARY_FEE, CANADIAN_DESTINATION, DELIVERY_AREA, DELIVERY_CONFIRMATION, FUEL, NON_MACHINABLE, OTHER, OUT_OF_DELIVERY_AREA, OUT_OF_PICKUP_AREA, OVERSIZE, RESIDENTIAL_DELIVERY, RESIDENTIAL_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERY_AREA, EXTENDED_AREA, FUEL, LARGE_PACKAGE, RESIDENTIAL, SHIPPER_PAYS_DUTY_TAX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nonmachinable, oversize"},"children":[]}]}]}]}]}]}],"items":{"type":"object","description":"Details of each surcharge applied.","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":15.33},"name":{"type":"string","description":"The name or type of surcharge.","example":"FUEL"}}}}}},"parcelTrackingNumber":{"type":"string","description":"The tracking number assigned to the individual parcel.","example":"UPS2200619919802570P0"},"parcelShipmentOptions":{"type":"object","description":"Parcel-level references are supported for carrier FedEx as of now. These references override shipment-level values and will be printed on the specific parcel label where provided.\n","properties":{"printCustomMessage":{"type":"string","description":"Custom message to be printed on the specific parcel label.","example":"Handle with care - Parcel 1"},"printDepartment":{"type":"string","description":"Department name to be printed on the specific parcel label.","example":"Dept-A1"},"printInvoiceNumber":{"type":"string","description":"Invoice number to be printed on the specific parcel label.","example":"INV-1001"},"printPONumber":{"type":"string","description":"Purchase order number to be printed on the specific parcel label.","example":"PO-2001"}},"example":[{"parcelType":"PKG","parcel":{"weight":10,"weightUnit":"OZ","width":10,"length":10,"height":10,"dimUnit":"IN"},"parcelShipmentOptions":{"printCustomMessage":"custom message 1","printDepartment":"Department 1","printInvoiceNumber":"invoice number 1","printPONumber":"ponumber 1"}},{"parcelType":"PKG","parcel":{"weight":8,"weightUnit":"OZ","width":8,"length":8,"height":8,"dimUnit":"IN"}}]}}}},"surcharges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fees or surcharges applied to the shipment. Each object in the array represents a specific surcharge and its associated fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be one of the supported surcharge types from the respective carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Surcharge Names by Carrier:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge Names"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FUEL, GO_GREEN_BASIC, OVERSIZE, PREMIUM, RURAL, TOLL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANCILLARY_FEE, CANADIAN_DESTINATION, DELIVERY_AREA, DELIVERY_CONFIRMATION, FUEL, NON_MACHINABLE, OTHER, OUT_OF_DELIVERY_AREA, OUT_OF_PICKUP_AREA, OVERSIZE, RESIDENTIAL_DELIVERY, RESIDENTIAL_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERY_AREA, EXTENDED_AREA, FUEL, LARGE_PACKAGE, RESIDENTIAL, SHIPPER_PAYS_DUTY_TAX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nonmachinable, oversize"},"children":[]}]}]}]}]}]}],"items":{"type":"object","description":"Details of each surcharge applied to the shipment.","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":11.3},"name":{"type":"string","description":"The name or type of surcharge.","example":"RESIDENTIAL"}}}},"publishedTotalCarrierCharge":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount based on the carrier's standard (published) rates, including base charges, surcharges, special services, discounts, and applicable taxes. This value reflects the amount the carrier would charge without any negotiated discounts or platform-specific rate adjustments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only when supported by the carrier (e.g., FedEx, UPS, DHL, USPS).\""},"children":[]}]}]}]}],"example":73.12}}}},"parcelTrackingNumber":{"type":"string","description":"The tracking number assigned to the entire shipment.","example":"UPS2200619919802570P0"},"shipmentId":{"type":"string","description":"A unique identifier for the shipment.","example":"UPS2200619919802570"},"shipmentOptions":{"type":"object","description":"Additional options associated with the shipment.","properties":{"printCustomMessage":{"type":"string","description":"A custom message to be printed on each parcel label of the shipment.","example":"custom message"},"printDepartment":{"type":"string","description":"Department Name to be printed on each parcel label of the shipment.","example":"DepartmentABC"},"printInvoiceNumber":{"type":"string","description":"Invoice number to be printed on each parcel label of the shipment.","example":"NV2345"},"printPONumber":{"type":"string","description":"PO number to be printed on each parcel label of the shipment.","example":"PO4567"},"billingWeight":{"type":"string","description":"The weight used by the carrier to calculate the shipping cost. This value is determined as the greater of the actual weight and the dimensional weight.\n","example":"128.0"},"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"}}},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"toAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"638 Manitoba Ave"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Winnipeg"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"CA"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Recipient Name"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the receiver address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be recipient’s valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"R2W 2H2"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"MB"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"taxId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tax Identification Number (TIN). TIN Number is supported for FedEx as of now."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max character length = 18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOSS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EORI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_UNION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 12 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 13 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"taxIdType":{"type":"string","description":"Specifies the type of tax identification being provided.","enum":["EIN","GST","VAT","IOSS","RFC","EORI"]}}},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by FedEx, UPS and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"29 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"},"customs":{"type":"object","properties":{"customsInfo":{"type":"object","properties":{"reasonForExport":{"type":"string","example":"GIFT","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-The reason the commodity is being exported. Valid values are: Valid Values: [GIFT COMMERCIAL_SAMPLE MERCHANDISE DOCUMENTS RETURNED_GOODS OTHER SOLD NOT_SOLD]"},"children":[]}]}]}]}],"x-go-name":"ReasonForExport"},"customsDeclaredValue":{"type":"number","example":200,"description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the value to declare in customs for the shipment. Enter the value in the currency specified in the currencyCode field."},"children":[]}]}]}]}]}],"format":"double"},"currencyCode":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-The type of currency used for the monetary values in this API request. Use three uppercase letters, per ISO 4217. For example, use USD for US Dollars, CAD for Canadian Dollars, and EUR for Euros."},"children":[]}]}]}]}]},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"certificateNumber":{"type":"string","example":"98788877","description":"The certificate number associated with the commodity."},"comments":{"type":"string","example":"Gift for birthday","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-Free form comments regarding the exported shipment entered by the shipper."},"children":[]}]}]}]}],"x-go-name":"Comments"},"fromCustomsReference":{"type":"string","example":"123456789","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-Free form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents."},"children":[]}]}]}]}],"x-go-name":"FromCustomsReference"},"importerCustomsReference":{"type":"string","example":"55454","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A reference number used by the importer, such as a VAT number, PO number, or insured number. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shipments to the EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Merchants  shipping to the European Union (EU) from outside the EU must provide a VAT or IOSS number. Enter the number in this field and specify the reference type in the importerCustomsReferenceType field."},"children":[]}]}]}]}]}],"x-go-name":"ImporterCustomsReference"},"invoiceNumber":{"type":"string","example":"123456789","description":"The commercial invoice number assigned by the exporter.","x-go-name":"InvoiceNumber"},"licenseNumber":{"type":"string","example":"456ABC123","description":"The export license number associated with the commodity."},"sdrValue":{"type":"number","example":200,"description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values. E.g., $100 USD = 66.87 SDR."},"children":[]}]}]}]}],"format":"double","x-go-name":"SdrValue"},"termsOfSale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the delivery and payment terms between the shipper and recipient. Currenty supported by carriers - UPS, FedEx and DHL. - Common values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CIP: Carriage and Insurance Paid to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPT: Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAP: Delivered at Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAT: Delivered at Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DDP: Delivered Duty Paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXW: Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FCA: Free Carrier"},"children":[]}]}]}]}],"example":"DDP","enum":["CIP","CPT","DAP","DAT","DDP","EXW","FCA"]}}},"customsItems":{"type":"array","items":{"type":"object","description":"A detailed description of the commodity.","properties":{"hSTariffCode":{"type":"string","example":"AST559","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination country's tariff-classification number for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and add additional digits for more detail. The maximum length is 14 characters. If you are issuing the HS Code API, you can use this field to help with the HS code prediction by entering the commodity's HS code from another country, such as from the origin country. Enter the country that theode comes from in the hSTariffCodeCountry field."},"children":[]}]}]}]}]}],"x-go-name":"HSTariffCode"},"originCountryCode":{"type":"string","description":"Origin country code.","x-go-name":"US"},"quantity":{"type":"integer","example":1,"description":"Enter the total number of items of this type of commodity.","format":"int32","x-go-name":"Quantity"},"unitPrice":{"type":"number","example":200,"description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of one item of this type of commodity. Currency should be declared under customsInfo."},"children":[]}]}]}]}]}],"format":"double","x-go-name":"UnitPrice"},"weightUnit":{"type":"string","enum":["OZ"],"description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"The weight of the item.","example":1}}}}}}}}},"components/schemas/ReprintMultipieceShipmentResponse":{"id":"components/schemas/ReprintMultipieceShipmentResponse","kind":"json-schema","title":"ReprintMultipieceShipmentResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"00da5e928af44bcc9e5c092163e036f9"},"labelLayout":{"type":"array","description":"Defines the layout and content details of the shipping label.","items":{"type":"object","description":"Specific details of the shipping label document.","properties":{"contentType":{"type":"string","description":"Specifies how the label content is encoded. If the file format is 'PDF', 'URL' is used to reference the document's location. For 'ZPL2' files, 'BASE64' encoding is used to represent the binary data as printable text.","example":"URL","enum":["URL","BASE64"]},"contents":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL to access the label document if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the Base64-encoded data if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASE64"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://225934331380-sending-service-qa.s3-fips.us-east-1.amazonaws.com/temp-labels/UPS2200619919802570P0.pdf"},"fileFormat":{"type":"string","description":"The format of the label document file the print takes.","example":"PDF","enum":["PDF","ZPL2"]},"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (4' X 6' or 8' X 11').","enum":["DOC_8X11","DOC_4X6"],"example":"DOC_8X11"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of label document, such as 'SHIPPING_LABEL'."},"children":[]}]}]}],"example":"SHIPPING_LABEL","enum":["SHIPPING_LABEL"]}}}},"fromAddress":{"type":"object","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the sender address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"sender@yopmail.com"},"countryCode":{"type":"string","description":"The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Sender Name"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"multiPieceRates":{"type":"array","description":"Details of the rates for multipiece shipments, including carrier information and parcel-specific charges.","items":{"type":"object","description":"Individual rate information for a multipiece shipment.","properties":{"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier for the entire shipment, including base charges, special service fees, surcharges, and any applicable international taxes and duties.","example":217.11},"carrier":{"type":"string","description":"The name of the carrier providing the shipping service.","example":"UPS"},"currencyCode":{"type":"string","description":"The currency code in which the rates are calculated.","example":"USD"},"rateTypeId":{"type":"string","description":"The identifier for the type of rate applied.","example":"commercial"},"serviceId":{"type":"string","description":"The identifier for the shipping service used.","example":"NDA"},"serviceName":{"type":"string","description":"The name of the shipping service.","example":"NDA"},"multiPieceParcels":{"type":"array","description":"Details of each parcel within the multi-piece shipment.","items":{"type":"object","description":"Information about an individual parcel in the shipment.","properties":{"parcelType":{"type":"string","description":"The type of parcel.","example":"PKG"},"parcel":{"type":"object","description":"The dimensions and weight information for the parcel.","properties":{"length":{"type":"number","description":"The length of the parcel in the specified unit of measurement.","example":10},"height":{"type":"number","description":"The height of the parcel in the specified unit of measurement.","example":10},"width":{"type":"number","description":"The width of the parcel in the specified unit of measurement.","example":10},"dimUnit":{"type":"string","description":"The unit of measurement for the parcel's dimensions.","example":"IN"},"weightUnit":{"type":"string","description":"The unit of measurement for the parcel's weight.","example":"OZ"},"weight":{"type":"number","description":"The weight of the parcel in the specified weight unit.","example":10}}},"parcelRate":{"type":"object","description":"Details of the charges applicable to the individual parcel.","properties":{"baseCharge":{"type":"number","description":"The base charge for shipping the parcel.","example":88.67},"surcharges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fees or surcharges applied to the shipment. Each object in the array represents a specific surcharge and its associated fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be one of the supported surcharge types from the respective carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Surcharge Names by Carrier:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge Names"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FUEL, GO_GREEN_BASIC, OVERSIZE, PREMIUM, RURAL, TOLL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANCILLARY_FEE, CANADIAN_DESTINATION, DELIVERY_AREA, DELIVERY_CONFIRMATION, FUEL, NON_MACHINABLE, OTHER, OUT_OF_DELIVERY_AREA, OUT_OF_PICKUP_AREA, OVERSIZE, RESIDENTIAL_DELIVERY, RESIDENTIAL_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERY_AREA, EXTENDED_AREA, FUEL, LARGE_PACKAGE, RESIDENTIAL, SHIPPER_PAYS_DUTY_TAX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nonmachinable, oversize"},"children":[]}]}]}]}]}]}],"items":{"type":"object","description":"Details of each surcharge applied.","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":15.33},"name":{"type":"string","description":"The name or type of surcharge.","example":"FUEL"}}}}}},"parcelTrackingNumber":{"type":"string","description":"The tracking number assigned to the individual parcel.","example":"UPS2200619919802570P0"}}}},"surcharges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fees or surcharges applied to the shipment. Each object in the array represents a specific surcharge and its associated fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be one of the supported surcharge types from the respective carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Surcharge Names by Carrier:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge Names"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FUEL, GO_GREEN_BASIC, OVERSIZE, PREMIUM, RURAL, TOLL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANCILLARY_FEE, CANADIAN_DESTINATION, DELIVERY_AREA, DELIVERY_CONFIRMATION, FUEL, NON_MACHINABLE, OTHER, OUT_OF_DELIVERY_AREA, OUT_OF_PICKUP_AREA, OVERSIZE, RESIDENTIAL_DELIVERY, RESIDENTIAL_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERY_AREA, EXTENDED_AREA, FUEL, LARGE_PACKAGE, RESIDENTIAL, SHIPPER_PAYS_DUTY_TAX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nonmachinable, oversize"},"children":[]}]}]}]}]}]}],"items":{"type":"object","description":"Details of each surcharge applied to the shipment.","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":11.3},"name":{"type":"string","description":"The name or type of surcharge.","example":"RESIDENTIAL"}}}}}}},"parcelTrackingNumber":{"type":"string","description":"The tracking number assigned to the entire shipment.","example":"UPS2200619919802570P0"},"shipmentId":{"type":"string","description":"A unique identifier for the shipment.","example":"UPS2200619919802570"},"shipmentOptions":{"type":"object","description":"Additional options associated with the shipment.","properties":{"printCustomMessage":{"type":"string","description":"A custom message to be printed on the label.","example":"custom message"}}},"toAddress":{"type":"object","required":["addressLine1","postalCode","countryCode","stateProvince"],"properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the receiver address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be recipient’s valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}}}}},"components/schemas/MultipieceRatesRequest":{"id":"components/schemas/MultipieceRatesRequest","kind":"json-schema","title":"MultipieceRatesRequest","data":{"type":"object","description":"Request body for multipiece shipments, including details of each package such as dimensions, weight, and other attributes for rate quoting and tracking.","properties":{"fromAddress":{"type":"object","description":"Details of the sender's address.","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Shelton"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"company":{"type":"string","description":"The company name associated with the sender's address.","example":"ABC Company"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Sasha Sekrotov"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits.","example":"323 555-1212"},"email":{"type":"string","description":"Sender's email address.","example":"rs.canid@gmail.com"},"residential":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the address is residential ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}}},"multiPieceParcels":{"type":"array","description":"Details of each parcel within the multi-piece shipment.","items":{"type":"object","description":"Details of individual parcel in the multipiece shipment.","properties":{"parcelType":{"type":"string","description":"The type of parcel.","example":"PACK"},"parcelId":{"type":"string","description":"A unique identifier associated with the Parcel.","example":"PACK"},"parcel":{"type":"object","description":"Details of the parcel's dimensions and weight.","properties":{"weightUnit":{"type":"string","description":"The unit of measurement for the parcel's weight.","example":"OZ"},"weight":{"type":"integer","description":"The weight of the parcel in the specified unit of measurement.","example":16},"dimUnit":{"type":"string","description":"The unit of measurement for the parcel's dimensions.","example":"IN"},"length":{"type":"integer","description":"The length of the parcel in the specified dimension unit.","example":10},"width":{"type":"integer","description":"The width of the parcel in the specified dimension unit.","example":10},"height":{"type":"integer","description":"The height of the parcel in the specified dimension unit.","example":10}}}}}},"carrierAccounts":{"type":"array","description":"A list of identifiers for the carrier accounts used for shipping.","items":{"type":"string","description":"A unique identifier for a carrier account.","example":"fsduygqy6"}},"serviceId":{"type":"string","description":"The identifier for the shipping service to be used.","example":"NDA"},"toAddress":{"type":"object","description":"Details of the recipient's address.","properties":{"company":{"type":"string","description":"The company name associated with the recipient's address.","example":"Pitney Bowes Inc."},"name":{"type":"string","description":"The name of the recipient.","example":"sender_fname"},"phone":{"type":"string","description":"The recipient's phone number.","example":"2032032033"},"email":{"type":"string","description":"The recipient's email address.","example":"sender@email.com"},"residential":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the address is residential ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Drive"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Shelton"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"}}}}}},"components/schemas/MultipieceRateShopRequest":{"id":"components/schemas/MultipieceRateShopRequest","kind":"json-schema","title":"MultipieceRateShopRequest","data":{"type":"object","properties":{"fromAddress":{"type":"object","description":"Details of the sender's address.","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Shelton"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"company":{"type":"string","description":"The company name associated with the sender's address.","example":"ABC Company"},"name":{"type":"string","description":"Name of the sender.","example":"Sasha Sekrotov"},"phone":{"type":"string","description":"Phone number of the sender.","example":"323 555-1212"},"email":{"type":"string","description":"Email of the sender.","example":"rs.canid@gmail.com"},"residential":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the address is residential ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}}},"multiPieceParcels":{"type":"array","description":"Details of each parcel within the multi-piece shipment.","items":{"type":"object","description":"Details of individual parcel in the multipiece shipment.","properties":{"parcelType":{"type":"string","description":"The type of parcel.","example":"PACK"},"parcel":{"type":"object","description":"Details of the parcel's dimensions and weight.","properties":{"weightUnit":{"type":"string","description":"The unit of measurement for the parcel's weight.","example":"OZ"},"weight":{"type":"number","description":"The weight of the parcel in the specified weight unit.","example":16},"dimUnit":{"type":"string","description":"The unit of measurement for the parcel's dimensions.","example":"IN"},"length":{"type":"number","description":"The length of the parcel in the specified dimension unit.","example":10},"width":{"type":"number","description":"The width of the parcel in the specified dimension unit.","example":10},"height":{"type":"number","description":"The height of the parcel in the specified dimension unit.","example":0.5}}}}}},"carrierAccounts":{"type":"array","description":"A list of identifiers for the carrier accounts used for shipping.","items":{"type":"string","description":"A unique identifier for a carrier account.","example":"fsduygqy6"}},"toAddress":{"type":"object","description":"Details of the recipient's address.","properties":{"company":{"type":"string","description":"The company name associated with the recipient's address.","example":"Pitney Bowes Inc."},"name":{"type":"string","description":"Name of the recipient.","example":"sender_fname"},"phone":{"type":"string","description":"Phone number of the recipient.","example":"2032032033"},"email":{"type":"string","description":"Email address of the recipient.","example":"sender@email.com"},"residential":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the address is residential ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Drive"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Shelton"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"}}}}}},"components/schemas/MultipieceRatesResponse":{"id":"components/schemas/MultipieceRatesResponse","kind":"json-schema","title":"MultipieceRatesResponse","data":{"type":"object","properties":{"fromAddress":{"type":"object","description":"Details of the sender's address.","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Shelton"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from this ISO country list.  The country in which the address is located.","example":"US"},"company":{"type":"string","description":"The company name associated with the sender's address.","example":"ABC Company"},"name":{"type":"string","description":"Name of the sender.","example":"Sasha Sekrotov"},"phone":{"type":"string","description":"Phone number of the sender.","example":"323 555-1212"},"email":{"type":"string","description":"Email address of the Sender.","example":"rs.canid@gmail.com"},"residential":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the address is residential ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}}},"toAddress":{"type":"object","description":"Details of the recipient's address.","properties":{"company":{"type":"string","description":"The company name associated with the recipient's address.","example":"Pitney Bowes Inc."},"name":{"type":"string","description":"Name of the recipient.","example":"user_name"},"phone":{"type":"string","description":"Phone number of the recipient.","example":2032032033},"email":{"type":"string","description":"Email address of the recipient.","example":"sender@email.com"},"residential":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the Recipient's address is residential ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Drive"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Shelton"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from the ISO country list. The country in which the address is located."}}},"serviceId":{"type":"string","description":"The identifier for the shipping service used.","example":"NDA"},"rates":{"type":"array","description":"A list of shipping rates for the multipiece shipment.","items":{"type":"object","description":"Details of each rate, including charges, service, and parcel information.","properties":{"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier, including base charges, surcharges, and any additional fees.","example":172.68},"carrier":{"type":"string","description":"The name of the carrier providing the shipping service.","example":"UPS"},"currencyCode":{"type":"string","description":"The currency code in which the charges are calculated.","example":"USD"},"rateTypeId":{"type":"string","description":"The type of rate applied.","example":"COMMERCIAL"},"serviceId":{"type":"string","description":"The identifier for the shipping service used.","example":"NDA"},"multiPieceParcels":{"type":"array","description":"Details of each parcel within the multi-piece shipment.","items":{"type":"object","description":"Details about an individual parcel in the shipment.","properties":{"parcelType":{"type":"string","description":"Type of the parcel.","example":"PKG"},"parcel":{"type":"object","description":"The dimensions and weight details for the parcel.","properties":{"length":{"type":"integer","description":"Length of the parcel in the specified unit.","example":10},"height":{"type":"integer","description":"Height of the parcel in the specified unit.","example":10},"width":{"type":"integer","description":"Width of the parcel in the specified unit.","example":10},"dimUnit":{"type":"string","description":"The unit of measurement for the parcel's dimensions.","example":"IN"},"weightUnit":{"type":"string","description":"The unit of measurement for the parcel's weight.","example":"OZ"},"weight":{"type":"integer","description":"The weight of the parcel in the specified unit.","example":16}}},"parcelRate":{"type":"object","description":"Details of the charges applicable to the parcel.","properties":{"baseCharge":{"type":"number","description":"The base charge for shipping the parcel.","example":145.36},"deliveryCommitment":{"type":"object","description":"It specifies the delivery commitment provided by carrier for this shipment","properties":{"additionalDetails":{"type":"string","description":"It specifies the additional details for the delivery commitment","example":"By end of Day"},"estimatedDeliveryDateTime":{"type":"string","description":"It specifies estimated delivery date time","example":"2024-12-18 18:00:00.000"},"guarantee":{"type":"string","description":"It specifies if guarantee is provided for this shipment.","example":"NONE"}}},"surcharges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fees or surcharges applied to the shipment. Each object in the array represents a specific surcharge and its associated fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be one of the supported surcharge types from the respective carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Surcharge Names by Carrier:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge Names"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FUEL, GO_GREEN_BASIC, OVERSIZE, PREMIUM, RURAL, TOLL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANCILLARY_FEE, CANADIAN_DESTINATION, DELIVERY_AREA, DELIVERY_CONFIRMATION, FUEL, NON_MACHINABLE, OTHER, OUT_OF_DELIVERY_AREA, OUT_OF_PICKUP_AREA, OVERSIZE, RESIDENTIAL_DELIVERY, RESIDENTIAL_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERY_AREA, EXTENDED_AREA, FUEL, LARGE_PACKAGE, RESIDENTIAL, SHIPPER_PAYS_DUTY_TAX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nonmachinable, oversize"},"children":[]}]}]}]}]}]}],"items":{"type":"object","description":"Details of each surcharge applied to the parcel.","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":23.41},"name":{"type":"string","description":"The type of surcharge.","example":"FUEL"}}}}}}}}},"surcharges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fees or surcharges applied to the shipment. Each object in the array represents a specific surcharge and its associated fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be one of the supported surcharge types from the respective carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Surcharge Names by Carrier:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge Names"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FUEL, GO_GREEN_BASIC, OVERSIZE, PREMIUM, RURAL, TOLL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANCILLARY_FEE, CANADIAN_DESTINATION, DELIVERY_AREA, DELIVERY_CONFIRMATION, FUEL, NON_MACHINABLE, OTHER, OUT_OF_DELIVERY_AREA, OUT_OF_PICKUP_AREA, OVERSIZE, RESIDENTIAL_DELIVERY, RESIDENTIAL_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERY_AREA, EXTENDED_AREA, FUEL, LARGE_PACKAGE, RESIDENTIAL, SHIPPER_PAYS_DUTY_TAX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nonmachinable, oversize"},"children":[]}]}]}]}]}]}],"items":{"type":"object","description":"Details of each surcharge applied to the shipment.","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":5.65},"name":{"type":"string","description":"The type of surcharge.\"","example":"RESIDENTIAL"}}}},"publishedTotalCarrierCharge":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount based on the carrier's standard (published) rates, including base charges, surcharges, special services, discounts, and applicable taxes. This value reflects the amount the carrier would charge without any negotiated discounts or platform-specific rate adjustments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only when supported by the carrier (e.g., FedEx, UPS, DHL, USPS).\""},"children":[]}]}]}]}],"example":73.12}}}}}}},"components/schemas/MultipieceRateShopResponse":{"id":"components/schemas/MultipieceRateShopResponse","kind":"json-schema","title":"MultipieceRateShopResponse","data":{"type":"object","properties":{"fromAddress":{"type":"object","description":"Details of the sender's address.","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Shelton"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from the ISO country list. The country in which the address is located.","example":"US"},"company":{"type":"string","description":"The company name associated with the sender's address.","example":"ABC Company"},"name":{"type":"string","description":"Name of the sender.","example":"Sasha Sekrotov"},"phone":{"type":"string","description":"Phone number of the sender.","example":"323 555-1212"},"email":{"type":"string","description":"Email address of the sender.","example":"rs.canid@gmail.com"},"residential":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the Recipient's address is residential ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}}},"toAddress":{"type":"object","description":"Details of the recipient's address.","properties":{"company":{"type":"string","description":"The company name associated with the recipient's address.","example":"Pitney Bowes Inc."},"name":{"type":"string","description":"Name of the recipient.","example":"user_name"},"phone":{"type":"string","description":"Phone number of the recipient.","example":2032032033},"email":{"type":"string","description":"Email address of the recipient.","example":"sender@email.com"},"residential":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the recipient's address is residential ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Drive"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Shelton"},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code.","example":"CT"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address.","example":"06484-4301"},"countryCode":{"type":"string","description":"The two-character ISO Code of the source country from the ISO country list. The country in which the address is located.","example":"US"}}},"serviceId":{"type":"string","description":"The identifier for the shipping service to be used.","example":"NDA"},"rates":{"type":"array","description":"A list of shipping rates for the multipiece shipment.","items":{"type":"object","description":"Details of each rate, including charges, service, and parcel information.","properties":{"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier, including base charges, surcharges, and other fees.","example":172.68},"carrier":{"type":"string","description":"The name of the carrier providing the shipping service.","example":"UPS"},"currencyCode":{"type":"string","description":"The currency in which the rates are calculated.","example":"USD"},"deliveryCommitment":{"type":"object","description":"It specifies the delivery commitment provided by carrier for this shipment","properties":{"additionalDetails":{"type":"string","description":"It specifies the additional details for the delivery commitment","example":"By end of Day"},"estimatedDeliveryDateTime":{"type":"string","description":"It specifies estimated delivery date time","example":"2024-12-18 18:00:00.000"},"guarantee":{"type":"string","description":"It specifies if guarantee is provided for this shipment.","example":"NONE"},"maxEstimatedNumberOfDays":{"type":"string","description":"It specifies the maximum estimated number of days for the delivery of this shipment.","example":"3"},"minEstimatedNumberOfDays":{"type":"string","description":"It specifies the minimum estimated number of days for the delivery of this shipment.","example":"3"}}},"rateTypeId":{"type":"string","description":"description","example":"COMMERCIAL"},"serviceId":{"type":"string","description":"The identifier for the shipping service to be used.","example":"NDA"},"multiPieceParcels":{"type":"array","description":"Details of each parcel within the multipiece shipment.","items":{"type":"object","description":"Details about an individual parcel in the shipment.","properties":{"parcelType":{"type":"string","description":"Type of the parcel.","example":"PKG"},"parcel":{"type":"object","description":"The dimensions and weight information for the parcel.","properties":{"length":{"type":"integer","description":"Length of the parcel in the specified unit.","example":10},"height":{"type":"integer","description":"Height of the parcel in the specified unit.","example":10},"width":{"type":"integer","description":"Width of the parcel in the specified unit.","example":10},"dimUnit":{"type":"string","description":"The unit of measurement for the parcel's dimensions.","example":"IN"},"weightUnit":{"type":"string","description":"The unit of measurement for the parcel's weight.","example":"OZ"},"weight":{"type":"integer","description":"The weight of the parcel in the specified unit.","example":16}}},"parcelRate":{"type":"object","description":"Details of the charges applicable to the parcel.","properties":{"baseCharge":{"type":"number","description":"The base charge for shipping the parcel.","example":145.36},"surcharges":{"type":"array","description":"A list of additional fees applied to the parcel.","items":{"type":"object","description":"Details of each surcharge applied to the parcel.","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":23.41},"name":{"type":"string","description":"The type of surcharge.","example":"FUEL"}}}}}}}}},"surcharges":{"type":"array","description":"A list of surcharges applied to the entire shipment.","items":{"type":"object","description":"Details of each surcharge applied to the shipment.","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":5.65},"name":{"type":"string","description":"The type of surcharge.","example":"RESIDENTIAL"}}}},"publishedTotalCarrierCharge":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount based on the carrier's standard (published) rates, including base charges, surcharges, special services, discounts, and applicable taxes. This value reflects the amount the carrier would charge without any negotiated discounts or platform-specific rate adjustments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only when supported by the carrier (e.g., FedEx, UPS, DHL, USPS).\""},"children":[]}]}]}]}],"example":73.12}}}},"errors":{"type":"array","description":"It display any error while getting rates","items":{"type":"object","properties":{"code":{"type":"string","description":"This is the error code, which varies as per the case. It reflects or alerts user in case if there is any error while performing RateShop. ","example":"validation_error"},"message":{"type":"string","description":"This is the error message reflects to user, in case if the user misses or enters incorrect information while performing RateShop.","example":"error while getting rates for carrier with carrierAccount eRMnRx4mzPP : "}}},"example":[{"code":"validation_error","message":"error while getting rates for carrier with carrierAccount eRMnRx4mzPP : "}]}}}},"components/schemas/customs":{"id":"components/schemas/customs","kind":"json-schema","title":"customs","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customs information required for international shipments and optional for domestic shipments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only for RMG carrier in domestic shipment requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must include customsItems and customsInfo objects."},"children":[]}]}]}]}],"required":["customsInfo","customsItems"],"properties":{"customsInfo":{"type":"object","description":"This is additional customs information required along with item details.","required":["reasonForExport","customsDeclaredValue","currencyCode"],"properties":{"reasonForExport":{"type":"string","description":"Reason for exporting the items.","example":"DOCUMENTS","enum":["GIFT","COMMERCIAL_SAMPLE","MERCHANDISE","DOCUMENTS","RETURNED_GOODS","OTHER"]},"comments":{"type":"string","description":"Free-form comments regarding the exported shipment.","example":"Test comment"},"invoiceNumber":{"type":"string","description":"The commercial invoice number assigned by the exporter.","example":"001189223"},"importerCustomsReference":{"type":"string","description":"A reference number used by the importer, such as a VAT number, PO number, or insured number.","example":"987654"},"sdrValue":{"type":"number","format":"float","description":"When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values.","example":23.32},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"currencyCode":{"type":"string","description":"The currency used for declared value. Use three uppercase letters, per ISO 4217.","example":"USD"},"fromCustomsReference":{"type":"string","description":"Free-form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.","example":"EFEFE4554545"},"licenseNumber":{"type":"string","description":"The export license number associated with the commodity.","example":"456ABC123"},"certificateNumber":{"type":"string","description":"The certificate number associated with the commodity.","example":"987"},"customsDeclaredValue":{"type":"number","description":"Item value in mentioned currencyCode.","example":6000},"termsOfSale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the delivery and payment terms between the shipper and recipient. Currenty supported by carriers - UPS, FedEx and DHL. - Common values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CIP: Carriage and Insurance Paid to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPT: Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAP: Delivered at Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAT: Delivered at Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DDP: Delivered Duty Paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXW: Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FCA: Free Carrier"},"children":[]}]}]}]}],"example":"DDP","enum":["CIP","CPT","DAP","DAT","DDP","EXW","FCA"]}}},"customsItems":{"type":"array","description":"Items included in the customs declaration.","required":["description","quantity","unitPrice","weight","weightUnit"],"items":{"type":"object","properties":{"description":{"type":"string","description":"A detailed description of the commodity, up to 255 characters. The description will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Each description will appear on the form.","example":"Books"},"itemId":{"type":"string","description":"Unique identifier for the commodity.","example":"item1"},"orderNumber":{"type":"string","description":"The unique identifier for the order.","example":"ORD1"},"quantity":{"type":"number","description":"Enter the total number of items of this type of commodity.","example":1},"unitPrice":{"type":"number","format":"float","description":"The price of one item of this type of commodity.","example":3000},"weightUnit":{"type":"string","description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"Weight of the item.","example":0.1},"hSTariffCode":{"type":"string","description":"The destination country's tariff-classification number (HS code) for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and then add digits for more detail. The maximum length for an HS code is 14 characters. The HS code will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. HS Code is required for RMG b2b shipment.","example":"AST559"},"originCountryCode":{"type":"string","description":"The two-character ISO country code of the shipment's origin country. Use ISO 3166-1 Alpha-2 standard values.","example":"US"}}}},"customsDocuments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field to attach Electronic Trade Documents (ETDs) to your DHL international shipment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item should represent a document uploaded previously using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For DHL, if you pass this field, ensure the selected service type is PAPERLESS."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"s3FileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value must be taken from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/electronic-trade-document/uploadetd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload ETD API response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic trade document must upload before shipment label creation."},"children":[]}]}]}]}],"items":{"type":"object","required":["fileName","s3FileId","documentType"],"properties":{"fileName":{"type":"string","description":"The name of the uploaded trade document file.","example":"invoice.pdf"},"s3FileId":{"type":"string","description":"The relative file path where the document is stored in the S3 bucket.","example":"uploads/shipping/intl_docs/sa58a03/0oa2bxnhu03i48mh50h8/NJ3ww7gv73kwDJK/DRNgGjEraOvV8ZB_invoice.pdf"},"documentType":{"type":"string","enum":["INVOICE","COMMERCIAL_INVOICE","PROFORMA_INVOICE","CERTIFICATE_OF_ORIGIN","NAFTA_CERTIFICATE_OF_ORIGIN","CUSTOMS_DECLARATION_FORM","AIR_WAYBILL_AND_WAYBILL"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the uploaded document. This value is referenced when generating customs declarations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must match the type used during document upload."},"children":[]}]}]}],"example":"INVOICE"}}}}},"example":{"fromAddress":{"name":"Sender Name","addressLine1":"1600 Amphitheatre Parkway","addressLine2":"near abc street","addressLine3":"near xyz street","company":"PB","email":"testuser@gmail.com","phone":"6502530000","cityTown":"Mountain View","stateProvince":"CA","postalCode":"94043","inductionPostalCode":"06905","countryCode":"US","residential":true},"toAddress":{"name":"Recipient Name","addressLine1":"350 Fifth Avenue","addressLine2":"near abc street","addressLine3":"near xyz street","cityTown":"New York","stateProvince":"NY","postalCode":"10118","countryCode":"US","company":"PB","phone":"2127363100","email":"recipient@gmail.com","residential":true,"isPOBox":true},"parcel":{"length":10,"width":10,"height":10,"dimUnit":"IN","weightUnit":"OZ","weight":10,"packageValue":10},"parcelType":"PKG","rateShopBy":"carrier","byCarrier":{"carrierAccountId":"YNp3883Bap3L","carrier":"USPS","service":"EM"},"shipmentOptions":{"addToManifest":true,"shipperID":"1234567890"},"specialServices":[{"inputParameters":[{"name":"INPUT_VALUE","value":"100"}],"specialserviceId":"Ins"}],"metadata":[{"name":"costAccountName","value":"costAccountName"},{"name":"costAccountId","value":"costAccountId"},{"name":"costAccountCode","value":"Code"},{"name":"accountCode","value":"code"},{"name":"companyCode","value":"code"}],"references":{"reference1":"custome message","reference2":"SendTech"},"labelSize":"DOC_4X6","labelType":"SHIPPING_LABEL","labelFormat":"PDF","contentType":"URL","dateOfShipment":"2025-10-28","deliveryOption":{"deliverBy":"2025-10-30","useBestNextDate":false}}}},"components/schemas/CustomsItem":{"id":"components/schemas/CustomsItem","kind":"json-schema","title":"CustomsItem","data":{"required":["description","quantity","unitPrice","weight","weightUnit"],"type":"object","properties":{"description":{"type":"string","description":"A detailed description of the commodity.","x-go-name":"Description"},"itemId":{"type":"string","description":"Unique identifier for the commodity.","example":"item1"},"orderNumber":{"type":"string","description":"The unique identifier for the order.","example":"ORD1"},"hSTariffCode":{"type":"string","example":"AST559","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination country's tariff-classification number for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and add additional digits for more detail. The maximum length is 14 characters. If you are issuing the HS Code API, you can use this field to help with the HS code prediction by entering the commodity's HS code from another country, such as from the origin country. Enter the country that the code comes from in the hSTariffCodeCountry field."},"children":[]}]}]}]}]}],"x-go-name":"HSTariffCode"},"quantity":{"type":"integer","example":1,"description":"Enter the total number of items of this type of commodity.","format":"int32","x-go-name":"Quantity"},"unitPrice":{"type":"number","example":200,"description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of one item of this type of commodity. Currency should be declared under customsInfo."},"children":[]}]}]}]}]}],"format":"double","x-go-name":"UnitPrice"},"weightUnit":{"type":"string","enum":["OZ"],"description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"The weight of the item.","example":1}},"x-go-package":"batch-apis"}},"components/schemas/Parameter":{"id":"components/schemas/Parameter","kind":"json-schema","title":"Parameter","data":{"required":["name","value"],"type":"object","properties":{"name":{"type":"string","example":"INPUT_VALUE","description":"The name of the parameter i.e. key.","x-go-name":"Name"},"value":{"type":"string","example":"100","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter value is as per the carrier specifications. It provides blank value, when presence of parameter is sufficient, and no value is associated."},"children":[]}]}]}]}]}],"x-go-name":"Value"}},"x-go-package":"batch-apis"}},"components/schemas/SpecialService":{"id":"components/schemas/SpecialService","kind":"json-schema","title":"SpecialService","data":{"required":["specialserviceId"],"type":"object","properties":{"inputParameters":{"type":"array","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parameters to set for the special service, such as an insurance value or a receipt-number format. This is required if the special service requires input parameters. If a special service does not require input parameters, you can either leave out the array or pass an empty array."},"children":[]}]}]}]}]}],"items":{"$ref":"#/components/schemas/Parameter"},"x-go-name":"InputParameters"},"specialserviceId":{"type":"string","example":"Ins","description":"A unique identifier associate to the special service, which is to be applied.","x-go-name":"SpecialserviceId"}}}},"components/schemas/ReturnLabelSpecialService":{"id":"components/schemas/ReturnLabelSpecialService","kind":"json-schema","title":"ReturnLabelSpecialService","data":{"required":["specialserviceId"],"type":"object","properties":{"inputParameters":{"type":"array","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parameters to set for the special service, such as an insurance value or a receipt-number format. This is required if the special service requires input parameters. If a special service does not require input parameters, you can either leave out the array or pass an empty array."},"children":[]}]}]}]}]}],"items":{"$ref":"#/components/schemas/Parameter"},"x-go-name":"InputParameters"},"specialserviceId":{"type":"string","example":"PRL","description":"A unique identifier associate to the special service, which is to be applied.","x-go-name":"SpecialserviceId"}},"x-go-package":"batch-apis"}},"components/schemas/parcelTypes":{"id":"components/schemas/parcelTypes","kind":"json-schema","title":"parcelTypes","data":{"type":"object","properties":{"parcels":{"type":"array","items":{"type":"object","properties":{"brandedName":{"type":"string","description":"The branded name of parcel type","example":"Box 1092"},"carrier":{"type":"string","description":"A unique identifier associated with the specific carrier.","example":"USPS"},"dimensionRules":{"type":"array","description":"Defines the maximum and minimum dimension supported for given parcel type.","items":{"type":"object","properties":{"maxLengthPlusGirth":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This measures the parcel's maximum length and determine parcel’s girth."},"children":[]}]}]}],"example":58},"maxParcelDimensions":{"type":"object","properties":{"length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is a part of Dimension object having highest numeric value out of three required parameters (length, width, and height) of Dimension. It helps determine a parcel’s girth."},"children":[]}]}]}],"example":18},"width":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Width is a part of Dimension object having lowest numeric value out of three required parameters of dimension (length, width, and height). This helps determine a parcel’s girth."},"children":[]}]}]}],"example":2},"height":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Height is a part of Dimension object where it helps determine a parcel’s girth."},"children":[]}]}]}],"example":18},"unitOfMeasurement":{"type":"string","description":"UnitofMeasurement is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN"}}},"minLengthPlusGirth":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This measures the parcel's minimum length and determine parcel’s girth."},"children":[]}]}]}],"example":0.001},"minParcelDimensions":{"type":"object","properties":{"length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is a part of Dimension object having highest numeric value out of three required parameters (length, width, and height) of Dimension. It helps determine a parcel’s girth."},"children":[]}]}]}],"example":0.001},"width":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Width is a part of Dimension object having lowest numeric value out of three required parameters of dimension (length, width, and height). This helps determine a parcel’s girth."},"children":[]}]}]}],"example":0.001},"height":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Height is a part of Dimension object where it helps determine a parcel’s girth."},"children":[]}]}]}],"example":0.001},"unitOfMeasurement":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN"}}},"required":{"type":"boolean","example":true},"unitOfMeasurement":{"type":"string","description":"UnitofMesurement is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN"}}},"example":[{"maxLengthPlusGirth":58,"maxParcelDimensions":{"length":18,"width":2,"height":18,"unitOfMeasurement":"IN"},"minLengthPlusGirth":0.001,"minParcelDimensions":{"length":0.001,"width":0.001,"height":0.001,"unitOfMeasurement":"IN"},"required":true,"unitOfMeasurement":"IN"}]},"groupName":{"type":"string","example":"Specialty Boxes and Envelopes"},"brandedDimensions":{"type":"object","description":"This will be available for parcels with Parcel Type as branded.","properties":{"girth":{"type":"number","description":"This is the measure around parcel by area or circumference.","example":0},"length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is a part of Dimension object having highest numeric value out of three required parameters (length, width, and height) of Dimension. It helps determine a parcel’s girth."},"children":[]}]}]}],"example":12.25},"width":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Width is a part of Dimension object having lowest numeric value out of three required parameters of dimension (length, width, and height). This helps determine a parcel’s girth."},"children":[]}]}]}],"example":2.875},"height":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Height is a part of Dimension object where it helps determine a parcel’s girth."},"children":[]}]}]}],"example":13.6875},"unitOfMeasurement":{"type":"string","description":"UnitofMesurements is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN"}}},"parcelId":{"type":"string","description":"A unique identifier associated with the Parcel.","example":"B1092"},"isBranded":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Parcel is Branded. If yes, it will take "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", else will take "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true},"parcelType":{"type":"string","description":"Defines the type of Parcel.","example":"LP"},"serviceId":{"type":"string","description":"A unique identifier associated with the carrier-based service.","example":"PM"},"serviceName":{"type":"string","description":"Name of the Carrier Service.","example":"Priority Mail®"},"suggestedTrackableSpecialserviceId":{"type":"string","description":"Defines the parcel has feature to track special serviceID.","example":"DelCon"},"weightRules":{"type":"array","description":"Defines the maximum and minimum weight supported for given parcel type.","items":{"type":"object","properties":{"maxWeight":{"type":"number","description":"Defines maximum weight, which can be considered.","example":1120},"minWeight":{"type":"number","description":"Defines minimum weight, which can be considered.","example":0.01},"required":{"type":"boolean","example":true},"unitOfMeasurement":{"type":"string","description":"UnitOfMeasurement is a standard for measuring the physical quantities of specified dimension parameters.","example":"OZ"}}},"example":[{"maxWeight":1120,"minWeight":0.01,"required":true,"unitOfMeasurement":"OZ"}]}}}}}}},"components/schemas/GetAllShipments":{"id":"components/schemas/GetAllShipments","kind":"json-schema","title":"GetAllShipments","data":{"type":"object","properties":{"pageInfo":{"type":"object","properties":{"total":{"type":"integer","example":78,"description":"Defines Total number of records."},"pages":{"type":"integer","example":8,"description":"Defines Total number of pages."},"page":{"type":"integer","example":1,"description":"Defines Current page number."}}},"data":{"type":"array","items":{"type":"object","properties":{"correlationId":{"type":"string","description":"Unique identifier assigned by the shipping system to the transaction.","example":"49ce304a251447539c84b204d968d7c4"},"subId":{"type":"string","description":"Subscription identifier associated with the shipment.","example":"sac735d"},"fromAddress":{"$ref":"#/components/schemas/fromAddressV2Response"},"toAddress":{"$ref":"#/components/schemas/fromAddressV2Response"},"altReturnAddress":{"type":"object","description":"Alternate return address for the shipment, if provided.","properties":{"name":{"type":"string","example":"Paul Wright"},"addressLine1":{"type":"string","example":"24182 Kathy Ave"},"cityTown":{"type":"string","example":"Lake Forest"},"stateProvince":{"type":"string","example":"CA"},"postalCode":{"type":"string","example":"92630-1827"},"countryCode":{"type":"string","example":"US"},"phone":{"type":"string","example":"203-555-1213"},"residential":{"type":"boolean","example":false}}},"parcelTrackingNumber":{"type":"string","description":"Tracking number assigned to the parcel by the carrier.","example":"UPS2202625646462636"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"NDA"},"rates":{"type":"array","description":"Rate details applied to the shipment.","items":{"type":"object","properties":{"baseCharge":{"type":"number","description":"Base service charge applied by the carrier.","example":102.45},"carrier":{"type":"string","description":"Name of the carrier providing the rate.","example":"UPS"},"currencyCode":{"type":"string","description":"Currency code for the rate amounts.","example":"USD"},"parcelType":{"type":"string","description":"Parcel/package type.","example":"PKG"},"rateTypeId":{"type":"string","description":"Rate type identifier.","example":"COMMERCIAL"},"serviceId":{"type":"string","description":"Identifier of the carrier's service.","example":"NDA"},"specialServices":{"type":"array","description":"Special services applied to the shipment.","items":{"type":"object","properties":{"specialServiceId":{"type":"string","description":"Special service identifier.","example":"ADULT_SIG"},"fee":{"type":"number","description":"Fee for the special service.","example":9.35},"inputParameters":{"type":"array","description":"Input parameters for the special service (if applicable).","items":{"type":"object","properties":{"name":{"type":"string","example":"INPUT_VALUE"},"value":{"type":"string","example":"200.00"}}}}}}},"surcharges":{"type":"array","description":"List of surcharges applied to the rate.","items":{"type":"object","properties":{"fee":{"type":"number","description":"Amount of the surcharge.","example":32.32},"name":{"type":"string","description":"Type of surcharge.","example":"FUEL"}}}},"totalCarrierCharge":{"type":"number","description":"Total amount payable to the carrier, including surcharges.","example":140.35},"isHazmat":{"type":"boolean","description":"Indicates if the shipment contains hazardous materials.","example":false}}}},"shipmentId":{"type":"string","description":"Unique identifier of the shipment.","example":"UPS2202625646462636"},"shipmentOptions":{"type":"object","description":"Additional shipment options.","properties":{"billingWeight":{"type":"string","description":"Billable weight used for rating.","example":"16.00"}}},"customs":{"allOf":[{"$ref":"#/components/schemas/Customs"},{"type":"object","properties":{"customsDocuments":{"type":"array","description":"This is the Electronic Trade Documents (ETDs) uploaded to your DHL international shipment.\n","items":{"type":"object","properties":{"fileName":{"type":"string","description":"The name of the uploaded trade document file.","example":"invoice.pdf"},"s3FileId":{"type":"string","description":"The relative file path where the document is stored in the S3 bucket.","example":"uploads/shipping/intl_docs/sa58a03/0oa2bxnhu03i48mh50h8/NJ3ww7gv73kwDJK/DRNgGjEraOvV8ZB_invoice.pdf"},"documentType":{"type":"string","enum":["INVOICE","COMMERCIAL_INVOICE","PROFORMA_INVOICE","CERTIFICATE_OF_ORIGIN","NAFTA_CERTIFICATE_OF_ORIGIN","CUSTOMS_DECLARATION_FORM","AIR_WAYBILL_AND_WAYBILL"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the uploaded document. This value is referenced when generating customs declarations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must match the type used during document upload."},"children":[]}]}]}],"example":"INVOICE"}}}}}}]},"status":{"type":"string","description":"Current status of the shipment.","example":"Label Printed"},"carrier":{"type":"string","description":"Carrier code/name used for the shipment.","example":"ups"},"carrierAccountId":{"type":"string","description":"Carrier account Id used for the shipment.","example":"EQ7Ar2dmXXX"},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","example":"costAccountName"},"value":{"type":"string","example":"cost account 123"}}}},"parcel":{"$ref":"#/components/schemas/parcelV2"},"dispenseClient":{"type":"string","description":"Client/system used to create the shipment.","example":"api"},"refundStatus":{"type":"string","description":"Refund status of the shipment."},"isInternational":{"type":"boolean","description":"Indicates whether the shipment is international.","example":true},"isReturnLblRequested":{"type":"boolean","description":"Indicates whether a return label was requested.","example":false},"insured":{"type":"boolean","description":"Indicates if the shipment is insured.","example":true},"carrierCode":{"type":"string","description":"Code of the carrier handling the shipment."},"transactionCreateDate":{"type":"string","format":"date-time","description":"Date and time when the shipment transaction was created.","example":"2026-02-09T07:22:05.457Z"},"locationId":{"type":"string","description":"Identifier of the location where the shipment originated.","example":"zLwdWnZ7LyVWknO"},"customerLocationId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a customer-defined location identifier in addition to the system-generated LocationId created during developer onboarding. If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerLocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not defined, the system assigns a default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locationID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In responses, both identifiers are returned, if a customer-defined value is not set, both fields return the same system-generated LocationID"},"children":[]}]}]}],"example":"zLwdWnZ7LyVWknO"},"references":{"$ref":"#/components/schemas/referenceV2"},"ecommerceProvider":{"type":"object","description":"E-commerce platform details associated with the shipment. This object will only be return in case of using Order Management APIs.","properties":{"customer":{"type":"object","description":"Customer details received from the e-commerce system.","properties":{"id":{"type":"string","description":"Unique identifier of the customer.","example":"CUST12345"},"email":{"type":"string","description":"Customer email address.","example":"john.doe@example.com"},"first_name":{"type":"string","description":"Customer first name.","example":"John"},"last_name":{"type":"string","description":"Customer last name.","example":"Doe"}}},"orderNumber":{"type":"string","description":"Order number from the e-commerce system.","example":"3865"}}}}}}}}},"components/schemas/GetAllShipmentsLTL":{"id":"components/schemas/GetAllShipmentsLTL","kind":"json-schema","title":"GetAllShipmentsLTL","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response returned when the shipment is a Less-Than-Truckload (LTL) freight shipment. Includes LTL-specific fields such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bolNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"proNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfShipment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ltlRates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"pageInfo":{"type":"object","properties":{"total":{"type":"integer","example":78,"description":"Defines Total number of records."},"pages":{"type":"integer","example":8,"description":"Defines Total number of pages."},"page":{"type":"integer","example":1,"description":"Defines Current page number."}}},"data":{"type":"array","items":{"type":"object","properties":{"correlationId":{"type":"string","description":"Unique identifier assigned by the shipping system to the transaction.","example":"PUR-1782456585497766062"},"subId":{"type":"string","description":"Subscription identifier associated with the shipment.","example":"sa55xxx"},"fromAddress":{"$ref":"#/components/schemas/fromAddressV2Response"},"toAddress":{"$ref":"#/components/schemas/fromAddressV2Response"},"parcelTrackingNumber":{"type":"string","description":"Tracking number assigned to the parcel by the carrier.","example":"8889966795"},"bolNumber":{"type":"string","description":"Bill of Lading (BOL) number assigned to the LTL freight shipment.","example":"8889966795"},"proNumber":{"type":"string","description":"PRO (Progressive) number assigned by the LTL carrier to track the freight shipment.","example":"8889966795"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"S"},"rates":{"type":"array","description":"Rate details applied to the shipment.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"Identifier of the carrier's service.","example":"S"},"serviceName":{"type":"string","description":"Human-readable name of the carrier's service.","example":"Purolator Expedited TL/LT"},"isHazmat":{"type":"boolean","description":"Indicates if the shipment contains hazardous materials.","example":false}}}},"shipmentId":{"type":"string","description":"Unique identifier of the shipment.","example":"8889966795"},"shipmentOptions":{"type":"object","description":"Additional shipment options."},"status":{"type":"string","description":"Current status of the shipment.","example":"Label Printed"},"carrier":{"type":"string","description":"Carrier code/name used for the shipment.","example":"purolatorfreight"},"carrierAccountId":{"type":"string","description":"Carrier account Id used for the shipment.","example":"O4zxnXVNArj8"},"locationId":{"type":"string","description":"Identifier of the location where the shipment originated.","example":"loc_auto_sa5559e"},"customerLocationId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a customer-defined location identifier in addition to the system-generated LocationId created during developer onboarding. If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerLocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not defined, the system assigns a default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locationID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In responses, both identifiers are returned, if a customer-defined value is not set, both fields return the same system-generated LocationID"},"children":[]}]}]}],"example":"customer_location"},"parcel":{"$ref":"#/components/schemas/parcelV2"},"dispenseClient":{"type":"string","description":"Client/system used to create the shipment.","example":"api"},"isInternational":{"type":"boolean","description":"Indicates whether the shipment is international.","example":false},"isReturnLblRequested":{"type":"boolean","description":"Indicates whether a return label was requested.","example":false},"insured":{"type":"boolean","description":"Indicates if the shipment is insured.","example":false},"transactionCreateDate":{"type":"string","format":"date-time","description":"Date and time when the shipment transaction was created.","example":"2026-06-26T06:49:45.555Z"},"dateOfShipment":{"type":"string","format":"date","description":"The actual date the freight shipment is scheduled to be shipped (YYYY-MM-DD).","example":"2026-06-26"},"references":{"$ref":"#/components/schemas/referenceV2"},"ltlRates":{"type":"array","description":"LTL freight rate details, including per-handling-unit parcel information such as freight class and PRO number.","items":{"type":"object","properties":{"carrier":{"type":"string","description":"LTL carrier providing the rate.","example":"PUROLATORFREIGHT"},"deliveryCommitment":{"type":"object","description":"Estimated delivery commitment for the LTL shipment.","properties":{"estimatedDeliveryDateTime":{"type":"string","description":"Estimated delivery date provided by the carrier.","example":"2026-06-29"},"maxEstimatedNumberOfDays":{"type":"string","description":"Maximum estimated number of days for delivery.","example":"1"}}},"serviceId":{"type":"string","description":"Identifier of the carrier's service.","example":"S"},"serviceName":{"type":"string","description":"Human-readable name of the carrier's service.","example":"Purolator Expedited™ TL/LT"},"isHazmat":{"type":"boolean","description":"Indicates if the shipment contains hazardous materials.","example":false},"parcels":{"type":"array","description":"Details of each handling unit (e.g., pallet) included in the LTL shipment.","items":{"type":"object","properties":{"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of handling unit used for the freight shipment (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PALLET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"PALLET"},"parcel":{"$ref":"#/components/schemas/parcelV2"},"parcelBrandedName":{"type":"string","description":"Branded/display name of the handling unit type.","example":"Pallet"},"proNumber":{"type":"string","description":"PRO (Progressive) number assigned to this specific handling unit.","example":"8889966795"},"freightClass":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NMFC freight class assigned to the handling unit (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLASS200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"CLASS200"}}}},"handlingUnitCount":{"type":"integer","description":"Total number of handling units included in the LTL shipment.","example":0}}}}}}}}}},"components/schemas/getAllShipments":{"id":"components/schemas/getAllShipments","kind":"json-schema","title":"getAllShipments","data":{"type":"object","properties":{"pageInfo":{"type":"object","properties":{"total":{"type":"integer","example":78,"description":"Defines Total number of records."},"pages":{"type":"integer","example":8,"description":"Defines Total number of pages."},"page":{"type":"integer","example":1,"description":"Defines Current page number."}}},"data":{"type":"array","items":{"type":"object","properties":{"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"5471c111c60e4b1f9410a434caf3fbd2"},"fromAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Woodbridge"},"company":{"type":"string","description":"The name of the company, in case if the sender address is not residential.","example":"ABC Company"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"CA"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":"rec1@yopmail.com"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"TestRec"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"8377777777"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"L4L 3P6"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"ON"}}},"parcel":{"type":"object","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length is a part of Dimension object having highest numeric value out of three required parameters (length, width, and height) of Dimension. It helps determine a parcel’s girth."},"children":[]}]}]}],"example":2},"width":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Width is a part of Dimension object having lowest numeric value out of three required parameters of dimension (length, width, and height). This helps determine a parcel’s girth."},"children":[]}]}]}],"example":1},"height":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Height is a part of Dimension object where it helps determine a parcel’s girth."},"children":[]}]}]}],"example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","enum":["OZ"],"example":"OZ"},"weight":{"type":"number","example":1}}},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the MetaData.","example":"costAccountName"},"value":{"type":"string","description":"Value for the MetaData.","example":"test"}}},"example":[{"name":"costAccountName","value":"test"}]},"parcelId":{"type":"string","description":"A unique identifier associated with the Parcel.","example":"B1092"},"parcelTrackingNumber":{"type":"string","description":"The Tracking number given to the Parcel for tracking purpose.","example":"EP863905659US"},"rate":{"type":"object","properties":{"baseCharge":{"type":"number","description":"The base service charge is payable to the carrier, excluding special service charges.","example":53.07},"carrier":{"type":"string","description":"Carrier is a service used to transport the parcels or couriers from one place to another.","example":"USPS"},"currencyCode":{"type":"string","description":"A three-character (all uppercase letter) symbol of a currency according to the international ISO standard. As a rule, the first two letters denote the name of the country, and the third letter, the name of the currency thereof. For example, for US - the currency is Dollars and code is USD. Similarly for Canada, the currencycode is CAD, and for India, it is INR. ","example":"USD"},"inductionPostalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code where a shipment or shipments are tendered to a carrier. This can be different from the Sender’s address."},"children":[]}]}]}],"example":"06905"},"parcelType":{"type":"string","description":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. ParcelType have categories like Package, Envelopes, Paks, Boxes, Tube, etc.","example":"LGENV"},"rateTypeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Its value can be CONTRACT_RATES, COMMERCIAL or COMMERCIAL_BASE for USPS and COMMERCIAL for other carriers depending on the Pitney Bowes contract/subscription"},"children":[]}]}]}],"example":"CONTRACT_RATES"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"EMI"},"specialServices":{"type":"array","description":"It provides a carrier-service based special or extra service.","items":{"type":"object","properties":{"fee":{"type":"number","description":"The amount of the specialService.","example":0},"inputParameters":{"type":"array","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-The parameters to set for the special service, such as an insurance value or a receipt-number format. This is required if the special service requires input parameters. If a special service does not require input parameters, you can either leave out the array or pass an empty array."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the input parameters.","example":"INPUT_VALUE"},"value":{"type":"string","description":"The value for the input parameters.","example":"10"}}},"example":[{"name":"INPUT_VALUE","value":"10"}]},"specialServiceId":{"type":"string","description":"A unique identifier associated to the Special Service, which depends on the carrier-based service.","example":"Ins"}}},"example":[{"fee":0,"inputParameters":[{"name":"INPUT_VALUE","value":"10"}],"specialServiceId":"Ins"}]},"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier, including special service fees, surcharges, and any international taxes and duties, except as noted below:","example":53.07}},"example":{"baseCharge":53.07,"carrier":"USPS","currencyCode":"USD","parcelType":"LGENV","rateTypeId":"CONTRACT_RATES","serviceId":"EMI","specialServices":[{"fee":0,"inputParameters":[{"name":"INPUT_VALUE","value":"10"}],"specialServiceId":"Ins"}],"totalCarrierCharge":53.07}},"service":{"type":"string","example":"EMI"},"shipmentId":{"type":"string","description":"A unique identifier associated with the Shipment.","example":"XXXX2200579576496921"},"shipmentOptions":{"allOf":[{"$ref":"#/components/schemas/shipmentOptions"},{"type":"object","properties":{"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"}}},{"type":"object","properties":{"billingWeight":{"type":"string","description":"The weight used by the carrier to calculate the shipping cost. This value is determined as the greater of the actual weight and the dimensional weight.\n","example":"128.0"}}}]},"status":{"type":"string","example":"COMPLETE"},"toAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Shelton"},"company":{"type":"string","description":"The name of the company, in case if the Recipient address is not residential.","example":"Pitney Bowes Inc."},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"sender1@yopmail.com"},"name":{"type":"string","description":"Name of the recipient. to which this address points.","example":"Paucal"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"9888777777"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484-4361"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"}}},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by USPS, FedEx, UPS, and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}}}}}}}},"components/schemas/getSingleShipment":{"id":"components/schemas/getSingleShipment","kind":"json-schema","title":"getSingleShipment","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Unique identifier assigned by the shipping system to the transaction.","example":"49ce304a251447539c84b204d968d7c4"},"subId":{"type":"string","description":"Subscription identifier associated with the shipment.","example":"sac735d"},"fromAddress":{"$ref":"#/components/schemas/fromAddressV2Response"},"toAddress":{"$ref":"#/components/schemas/fromAddressV2Response"},"altReturnAddress":{"type":"object","description":"Alternate return address for the shipment, if provided.","properties":{"name":{"type":"string","example":"Paul Wright"},"addressLine1":{"type":"string","example":"24182 Kathy Ave"},"cityTown":{"type":"string","example":"Lake Forest"},"stateProvince":{"type":"string","example":"CA"},"postalCode":{"type":"string","example":"92630-1827"},"countryCode":{"type":"string","example":"US"},"phone":{"type":"string","example":"203-555-1213"},"residential":{"type":"boolean","example":false}}},"parcelTrackingNumber":{"type":"string","description":"Tracking number assigned to the parcel by the carrier.","example":"UPS2202625646462636"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"NDA"},"rates":{"type":"array","description":"Rate details applied to the shipment.","items":{"type":"object","properties":{"baseCharge":{"type":"number","description":"Base service charge applied by the carrier.","example":102.45},"carrier":{"type":"string","description":"Name of the carrier providing the rate.","example":"UPS"},"currencyCode":{"type":"string","description":"Currency code for the rate amounts.","example":"USD"},"parcelType":{"type":"string","description":"Parcel/package type.","example":"PKG"},"rateTypeId":{"type":"string","description":"Rate type identifier.","example":"COMMERCIAL"},"serviceId":{"type":"string","description":"Identifier of the carrier's service.","example":"NDA"},"specialServices":{"type":"array","description":"Special services applied to the shipment.","items":{"type":"object","properties":{"specialServiceId":{"type":"string","description":"Special service identifier.","example":"ADULT_SIG"},"fee":{"type":"number","description":"Fee for the special service.","example":9.35},"inputParameters":{"type":"array","description":"Input parameters for the special service (if applicable).","items":{"type":"object","properties":{"name":{"type":"string","example":"INPUT_VALUE"},"value":{"type":"string","example":"200.00"}}}}}}},"surcharges":{"type":"array","description":"List of surcharges applied to the rate.","items":{"type":"object","properties":{"fee":{"type":"number","description":"Amount of the surcharge.","example":32.32},"name":{"type":"string","description":"Type of surcharge.","example":"FUEL"}}}},"totalCarrierCharge":{"type":"number","description":"Total amount payable to the carrier, including surcharges.","example":140.35},"isHazmat":{"type":"boolean","description":"Indicates if the shipment contains hazardous materials.","example":false}}}},"shipmentId":{"type":"string","description":"Unique identifier of the shipment.","example":"UPS2202625646462636"},"shipmentOptions":{"type":"object","description":"Additional shipment options.","properties":{"billingWeight":{"type":"string","description":"Billable weight used for rating.","example":"16.00"}}},"customs":{"$ref":"#/components/schemas/Customs"},"status":{"type":"string","description":"Current status of the shipment.","example":"Label Printed"},"carrier":{"type":"string","description":"Carrier code/name used for the shipment.","example":"ups"},"carrierAccountId":{"type":"string","description":"Carrier account Id used for the shipment.","example":"EQ7Ar2dmXXX"},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","example":"costAccountName"},"value":{"type":"string","example":"cost account 123"}}}},"parcel":{"$ref":"#/components/schemas/parcelV2"},"dispenseClient":{"type":"string","description":"Client/system used to create the shipment.","example":"api"},"refundStatus":{"type":"string","description":"Refund status of the shipment."},"isInternational":{"type":"boolean","description":"Indicates whether the shipment is international.","example":true},"isReturnLblRequested":{"type":"boolean","description":"Indicates whether a return label was requested.","example":false},"insured":{"type":"boolean","description":"Indicates if the shipment is insured.","example":true},"carrierCode":{"type":"string","description":"Code of the carrier handling the shipment."},"transactionCreateDate":{"type":"string","format":"date-time","description":"Date and time when the shipment transaction was created.","example":"2026-02-09T07:22:05.457Z"},"locationId":{"type":"string","description":"Identifier of the location where the shipment originated.","example":"zLwdWnZ7LyVWknO"},"references":{"$ref":"#/components/schemas/referenceV2"},"ecommerceProvider":{"type":"object","description":"E-commerce platform details associated with the shipment. This object will only be return in case of using Order Management APIs.","properties":{"customer":{"type":"object","description":"Customer details received from the e-commerce system.","properties":{"id":{"type":"string","description":"Unique identifier of the customer.","example":"CUST12345"},"email":{"type":"string","description":"Customer email address.","example":"john.doe@example.com"},"first_name":{"type":"string","description":"Customer first name.","example":"John"},"last_name":{"type":"string","description":"Customer last name.","example":"Doe"}}},"orderNumber":{"type":"string","description":"Order number from the e-commerce system.","example":"3865"}}}}}},"components/schemas/getSingleShipmentLTL":{"id":"components/schemas/getSingleShipmentLTL","kind":"json-schema","title":"getSingleShipmentLTL","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response returned when the shipment is a Less-Than-Truckload (LTL) freight shipment. Includes LTL-specific fields such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfShipment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ltlRates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"correlationId":{"type":"string","description":"Unique identifier assigned by the shipping system to the transaction.","example":"49ce304a251447539c84b204d968d7c4"},"subId":{"type":"string","description":"Subscription identifier associated with the shipment.","example":"sa5501a"},"fromAddress":{"$ref":"#/components/schemas/fromAddressV2Response"},"toAddress":{"$ref":"#/components/schemas/fromAddressV2Response"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"SVC_xDzkRdJL24KG"},"rates":{"type":"array","description":"Rate details applied to the shipment.","items":{"type":"object","properties":{"serviceId":{"type":"string","description":"Identifier of the carrier's service.","example":"SVC_xDzkRdJL24KG"},"serviceName":{"type":"string","description":"Human-readable name of the carrier's service.","example":"GRD"},"isHazmat":{"type":"boolean","description":"Indicates if the shipment contains hazardous materials.","example":false}}}},"shipmentId":{"type":"string","description":"Unique identifier of the shipment.","example":"XG38WGBJLOL41784097872849633820"},"shipmentOptions":{"type":"object","description":"Additional shipment options."},"status":{"type":"string","description":"Current status of the shipment.","example":"Label Printed"},"carrier":{"type":"string","description":"Carrier code/name used for the shipment.","example":"xg38wgbjlol4"},"carrierAccountId":{"type":"string","description":"Carrier account Id used for the shipment.","example":"rMv0rQVp89p7Vgp"},"locationId":{"type":"string","description":"Identifier of the location where the shipment originated.","example":"loc_auto_sa5501a"},"customerLocationId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a customer-defined location identifier in addition to the system-generated LocationId created during developer onboarding. If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerLocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not defined, the system assigns a default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locationID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In responses, both identifiers are returned, if a customer-defined value is not set, both fields return the same system-generated LocationID"},"children":[]}]}]}],"example":"loc_auto_sa5501a"},"parcel":{"$ref":"#/components/schemas/parcelV2"},"dispenseClient":{"type":"string","description":"Client/system used to create the shipment.","example":"api"},"isInternational":{"type":"boolean","description":"Indicates whether the shipment is international.","example":false},"isReturnLblRequested":{"type":"boolean","description":"Indicates whether a return label was requested.","example":false},"insured":{"type":"boolean","description":"Indicates if the shipment is insured.","example":false},"transactionCreateDate":{"type":"string","format":"date-time","description":"Date and time when the shipment transaction was created.","example":"2026-07-15T06:44:33.123Z"},"dateOfShipment":{"type":"string","format":"date","description":"The actual date the freight shipment is scheduled to be shipped (YYYY-MM-DD).","example":"2026-07-15"},"references":{"$ref":"#/components/schemas/referenceV2"},"ltlRates":{"type":"array","description":"LTL freight rate details, including per-handling-unit parcel information such as freight class, sequence, and billable weight.","items":{"type":"object","properties":{"carrier":{"type":"string","description":"LTL carrier providing the rate.","example":"XG38WGBJLOL4"},"serviceId":{"type":"string","description":"Identifier of the carrier's service.","example":"SVC_xDzkRdJL24KG"},"serviceName":{"type":"string","description":"Human-readable name of the carrier's service.","example":"GRD"},"isHazmat":{"type":"boolean","description":"Indicates if the shipment contains hazardous materials.","example":false},"parcels":{"type":"array","description":"Details of each handling unit (e.g., pallet) included in the LTL shipment.","items":{"type":"object","properties":{"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of handling unit used for the freight shipment (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PALLET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"PKG_xO6M1DKBaaXM"},"parcel":{"type":"object","description":"Physical dimensions and weight of the handling unit.","properties":{"length":{"type":"number","example":11},"height":{"type":"number","example":11},"width":{"type":"number","example":11},"dimUnit":{"type":"string","example":"IN"},"weightUnit":{"type":"string","example":"OZ"},"weight":{"type":"number","example":1500}}},"sequenceNumber":{"type":"string","description":"Sequence number of this handling unit within the LTL shipment.","example":"1"},"pieceCount":{"type":"string","description":"Number of pieces contained within this handling unit.","example":"1"},"parcelBrandedName":{"type":"string","description":"Branded/display name of the handling unit type.","example":"Pallet"},"freightClass":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NMFC freight class assigned to the handling unit (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLASS200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"CLASS200"},"billableWeight":{"type":"object","description":"Billable weight of the handling unit used for rating.","properties":{"weightUnit":{"type":"string","example":"OZ"},"weight":{"type":"number","example":1500}}}}}},"handlingUnitCount":{"type":"integer","description":"Total number of handling units included in the LTL shipment.","example":0},"carrierBrandedName":{"type":"string","description":"Branded/display name of the LTL carrier.","example":"customLTL1"}}}}}}},"components/schemas/reprintShipment":{"id":"components/schemas/reprintShipment","kind":"json-schema","title":"reprintShipment","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"00adf56ed852487ba9caec62b7ab2635"},"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (8' X 11').","enum":["DOC_8X11"],"example":"DOC_8X11"},"type":{"type":"string","description":"Defines the type of the Shipment, e.g., Shipping Label.","example":"SHIPPING_LABEL","enum":["SHIPPING_LABEL"]},"format":{"type":"string","description":"Defines the type of the shipment which is printed. For example, Shipping label prints in PDF form.","example":"PDF","enum":["PDF"]},"fromAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"company":{"type":"string","description":"The name of the company, in case if the sender address is not residential.","example":"Pitney Bowes Inc."},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":"john.publica@pb.com"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905-4317"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"}}},"parcel":{"type":"object","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"integer","format":"int32","description":"Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"integer","format":"int32","description":"There is no strict rule as to which element is the width or the height, but typically, by convention the width is the second greatest dimension of a parcel.","example":1},"height":{"type":"integer","format":"int32","description":"By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WeightUnit is a standard for measuring the physical quantities of specified weight. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The valid values are: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- OZ: Ounces "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- GM: Grams "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- LB: Pounds "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- KG: Kilograms For USPS shipments, set this to OZ."},"children":[]}]}]}],"enum":["OZ"],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":1}}},"parcelTrackingNumber":{"type":"string","description":"The Tracking number given to the Parcel for tracking purpose.","example":"9471309105156000826739"},"rate":{"type":"object","properties":{"baseCharge":{"type":"number","description":"The base service charge is payable to the carrier, excluding special service charges.","example":25.5},"carrier":{"type":"string","description":"Carrier is a service used to transport the parcels or couriers from one place to another.","example":"USPS"},"currencyCode":{"type":"string","description":"A three-character (all uppercase letter) symbol of a currency according to the international ISO standard. As a rule, the first two letters denote the name of the country, and the third letter, the name of the currency thereof. For example, for US - the currency is Dollars and code is USD. Similarly for Canada, the currencycode is CAD, and for India, it is INR. ","example":"USD"},"parcelType":{"type":"string","description":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. ParcelType have categories like Package, Envelopes, Paks, Boxes, Tube, etc. ","example":"PKG"},"rateTypeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Its value can be CONTRACT_RATES, COMMERCIAL or COMMERCIAL_BASE for USPS and COMMERCIAL for other carriers depending on the Pitney Bowes contract/subscription"},"children":[]}]}]}],"example":"CONTRACT_RATES"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"EM"},"specialServices":{"type":"array","description":"It provides a carrier-service based special or extra service.","items":{"type":"object","properties":{"fee":{"type":"number","description":"The amount of the specialService.","example":88.5},"inputParameters":{"type":"array","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-The parameters to set for the special service, such as an insurance value or a receipt-number format. This is required if the special service requires input parameters. If a special service does not require input parameters, you can either leave out the array or pass an empty array."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the input parameters.","example":"INPUT_VALUE"},"value":{"type":"string","description":"The value for the input parameters.","example":"5000"}}},"example":[{"name":"INPUT_VALUE","value":"5000"}]},"specialServiceId":{"type":"string","description":"A unique identifier associated to the Special Service, which depends on the carrier-based service.","example":"Ins"}},"example":[{"fee":88.5,"inputParameters":[{"name":"INPUT_VALUE","value":"5000"}],"specialServiceId":"Ins"},{"fee":0,"specialServiceId":"PO to Addressee"},{"fee":3.35,"inputParameters":[{"name":"INPUT_VALUE","value":"12345"}],"specialServiceId":"RR"},{"fee":0,"specialServiceId":"Sig"},{"fee":0,"specialServiceId":"liveanimal"}]}},"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier, including special service fees, surcharges, and any international taxes and duties, except as noted below:","example":117.35},"destinationZone":{"type":"string","description":"This is the postal or delivery zone assigned to the shipment's destination by the carrier. This field is returned for USPS as of now.","example":1}},"example":{"baseCharge":25.5,"carrier":"USPS","currencyCode":"USD","parcelType":"PKG","rateTypeId":"CONTRACT_RATES","serviceId":"EM","specialServices":[{"fee":88.5,"inputParameters":[{"name":"INPUT_VALUE","value":"5000"}],"specialServiceId":"Ins"},{"fee":0,"specialServiceId":"PO to Addressee"},{"fee":3.35,"inputParameters":[{"name":"INPUT_VALUE","value":"12345"}],"specialServiceId":"RR"},{"fee":0,"specialServiceId":"Sig"},{"fee":0,"specialServiceId":"liveanimal"}],"totalCarrierCharge":117.35,"destinationZone":1}},"shipmentId":{"type":"string","description":"A unique identifier associated with Shipment ID, which is used for Reprint and Cancel.","example":"USPS2200579677758143"},"shipmentOptions":{"allOf":[{"$ref":"#/components/schemas/shipmentOptions"},{"type":"object","properties":{"billingWeight":{"type":"string","description":"The weight used by the carrier to calculate the shipping cost. This value is determined as the greater of the actual weight and the dimensional weight.\n","example":"128.0"}}},{"type":"object","properties":{"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"}}}]},"toAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Rochester"},"company":{"type":"string","description":"The name of the company, in case if the Recipient address is not residential.","example":"ABC Company"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"rs.canid@gmail.com"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Rufous Sirius Canid"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"323 555-1212"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"14609-7418"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"NY"}}},"soldToAddress":{"$ref":"#/components/schemas/soldToAddress"},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"}}}},"components/schemas/domesticShipmentResponse":{"id":"components/schemas/domesticShipmentResponse","kind":"json-schema","title":"domesticShipmentResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"00adf56ed852487ba9caec62b7ab2635"},"fromAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"company":{"type":"string","example":"Pitney Bowes Inc."},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":"john.publica@pb.com"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905-4317"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.","example":"06905"}}},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. The alternate address will be printed on the label. Use this object to specify a return address different from the fromAddress. Supported by USPS, FedEx, UPS, and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}},"parcel":{"type":"object","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"integer","format":"int32","description":"Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"integer","format":"int32","description":"There is no strict rule as to which element is the width or the height, but typically, by convention the width is the second greatest dimension of a parcel.","example":1},"height":{"type":"integer","format":"int32","description":"By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","enum":["OZ"],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":1}}},"parcelTrackingNumber":{"type":"string","description":"The Tracking number given to the Parcel for tracking purpose.","example":"9471309105156000826739"},"labelLayout":{"type":"array","items":{"type":"object","properties":{"contentType":{"type":"string","description":"Specifies how the label content is encoded.","example":"BASE64","enum":["BASE64","URL"]},"contents":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL to access the label document if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the Base64-encoded data if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASE64"},"children":[]}]}]}],"example":"XlhBCl5MSDE2LDEyCl5MTDEyMTIKXkZUIDU4MSwgNDAzIF5BVU4gIF5GRDAwMDNeRlMgXkZYIENvbmZpZ3VyYWJsZSBUZXh0IDEK..."},"fileFormat":{"type":"string","description":"Defines the type of the shipment which is printed. For example, Shipping label prints in PDF form.","example":"ZPL2"},"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (4' X 6' or 8.5' X 11').","example":"DOC_8X11"},"type":{"type":"string","description":"Defines the type of the Shipment, e.g., Shipping Label.","example":"SHIPPING_LABEL"}}}},"rate":{"type":"object","properties":{"baseCharge":{"type":"number","description":"The base service charge is payable to the carrier, excluding special service charges.","example":25.5},"baseChargeTaxes":{"type":"array","description":"List of taxes applied to the base charge. Returned in case of Canada carriers, such as: purolator, Canpar and Fedex.","items":{"type":"object","properties":{"displayName":{"type":"string","description":"Name of the tax applied.","example":"Canada goods and services"},"name":{"type":"string","description":"Short code or identifier of the tax.","example":"GST"},"taxAmount":{"type":"number","format":"float","description":"Amount charged for this tax.","example":2.69}}}},"carrier":{"type":"string","description":"Carrier is a service used to transport the parcels or couriers from one place to another.","example":"USPS"},"currencyCode":{"type":"string","description":"A three-character (all uppercase letter) symbol of a currency according to the international ISO standard. As a rule, the first two letters denote the name of the country, and the third letter, the name of the currency thereof. For example, for US - the currency is Dollars and code is USD. Similarly for Canada, the currencycode is CAD, and for India, it is INR. ","example":"USD"},"deliveryCommitment":{"type":"object","description":"It specifies the delivery commitment provided by carrier for this shipment","properties":{"additionalDetails":{"type":"string","description":"It specifies the additional details for the delivery commitment","example":"By end of Day"},"estimatedDeliveryDateTime":{"type":"string","description":"It specifies estimated delivery date time","example":"2024-12-18 18:00:00.000"},"guarantee":{"type":"string","description":"It specifies if guarantee is provided for this shipment.","example":"NONE"},"maxEstimatedNumberOfDays":{"type":"string","description":"It specifies the maximum estimated number of days for the delivery of this shipment.","example":"3"},"minEstimatedNumberOfDays":{"type":"string","description":"It specifies the minimum estimated number of days for the delivery of this shipment.","example":"3"}}},"parcelType":{"type":"string","description":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. ParcelType have categories like Package, Envelopes, Paks, Boxes, Tube, etc. ","example":"PKG"},"rateTypeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Its value can be CONTRACT_RATES, COMMERCIAL or COMMERCIAL_BASE for USPS and COMMERCIAL for other carriers depending on the Pitney Bowes contract/subscription"},"children":[]}]}]}],"example":"CONTRACT_RATES"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"EM"},"specialServices":{"type":"array","description":"It provides a carrier-service based special or extra service.","items":{"type":"object","properties":{"fee":{"type":"number","description":"The amount of the special service.","example":88.5},"inputParameters":{"type":"array","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-The parameters to set for the special service, such as an insurance value or a receipt-number format. This is required if the special service requires input parameters. If a special service does not require input parameters, you can either leave out the array or pass an empty array."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"Name or ID of the Input Parameters.","example":"INPUT_VALUE"},"value":{"type":"string","description":"Value of the Input Parameters.","example":"5000"}}},"example":[{"name":"INPUT_VALUE","value":"5000"}]},"specialServiceId":{"type":"string","description":"A unique identifier associated to the Special Service, which depends on the carrier-based service.","example":"Ins"}},"example":[{"fee":88.5,"inputParameters":[{"name":"INPUT_VALUE","value":"5000"}],"specialServiceId":"Ins"},{"fee":0,"specialServiceId":"PO to Addressee"},{"fee":3.35,"inputParameters":[{"name":"INPUT_VALUE","value":"12345"}],"specialServiceId":"RR"},{"fee":0,"specialServiceId":"Sig"},{"fee":0,"specialServiceId":"liveanimal"}]}},"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier, including special service fees, surcharges, and any international taxes and duties, except as noted below:","example":117.35},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.","example":"06905"},"totalTaxAmount":{"type":"number","format":"float","description":"Total tax amount applied to the shipment. Returned in case of canada carriers.","example":2.69},"destinationZone":{"type":"string","description":"This is the postal or delivery zone assigned to the shipment's destination by the carrier. This field is returned for USPS as of now.","example":1}},"example":{"baseCharge":25.5,"carrier":"USPS","currencyCode":"USD","parcelType":"PKG","rateTypeId":"CONTRACT_RATES","serviceId":"EM","specialServices":[{"fee":88.5,"inputParameters":[{"name":"INPUT_VALUE","value":"5000"}],"specialServiceId":"Ins"},{"fee":0,"specialServiceId":"PO to Addressee"},{"fee":3.35,"inputParameters":[{"name":"INPUT_VALUE","value":"12345"}],"specialServiceId":"RR"},{"fee":0,"specialServiceId":"Sig"},{"fee":0,"specialServiceId":"liveanimal"}],"totalCarrierCharge":117.35,"destinationZone":1}},"shipmentId":{"type":"string","description":"A unique identifier for the shipment, generated by the system in response to shipment purchase.","example":"USPS2200579677758143"},"shipmentOptions":{"allOf":[{"$ref":"#/components/schemas/shipmentOptions"},{"type":"object","properties":{"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"}}},{"type":"object","properties":{"billingWeight":{"type":"string","description":"The weight used by the carrier to calculate the shipping cost. This value is determined as the greater of the actual weight and the dimensional weight.\n","example":"128.0"}}}]},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"toAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Rochester"},"company":{"type":"string","description":"The name of the company, in case if the recipient address is not residential.","example":"ABC Company"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"rs.canid@gmail.com"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Rufous Sirius Canid"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"323 555-1212"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"14609-7418"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"NY"}}},"soldToAddress":{"$ref":"#/components/schemas/soldToAddress"},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"}}}},"components/schemas/MilitaryMailShipmentsResponse":{"id":"components/schemas/MilitaryMailShipmentsResponse","kind":"json-schema","title":"MilitaryMailShipmentsResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"00adf56ed852487ba9caec62b7ab2635"},"fromAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"8 Abc Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Beals"},"company":{"type":"string","example":"Pitney Bowes Inc."},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":"john.publica@pb.com"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Sender Name"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"323 555-1212"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"04611-3214"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"ME"},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.","example":"06905"}}},"parcel":{"type":"object","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"integer","format":"int32","description":"Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"integer","format":"int32","description":"There is no strict rule as to which element is the width or the height, but typically, by convention the width is the second greatest dimension of a parcel.","example":1},"height":{"type":"integer","format":"int32","description":"By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","enum":["OZ"],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":1}}},"parcelTrackingNumber":{"type":"string","description":"The Tracking number given to the Parcel for tracking purpose.","example":"9471309105156000826739"},"labelLayout":{"type":"array","items":{"type":"object","properties":{"contentType":{"type":"string","description":"Specifies how the label content is encoded.","example":"BASE64","enum":["BASE64","URL"]},"contents":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL to access the label document if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the Base64-encoded data if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASE64"},"children":[]}]}]}],"example":"XlhBCl5MSDE2LDEyCl5MTDEyMTIKXkZUIDU4MSwgNDAzIF5BVU4gIF5GRDAwMDNeRlMgXkZYIENvbmZpZ3VyYWJsZSBUZXh0IDEK..."},"fileFormat":{"type":"string","description":"Defines the type of the shipment which is printed. For example, Shipping label prints in PDF form.","example":"ZPL2"},"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (4' X 6' or 8.5' X 11').","example":"DOC_8X11"},"type":{"type":"string","description":"Defines the type of the Shipment, e.g., Shipping Label.","example":"SHIPPING_LABEL"}}}},"rate":{"type":"object","properties":{"baseCharge":{"type":"number","description":"The base service charge is payable to the carrier, excluding special service charges.","example":25.5},"carrier":{"type":"string","description":"Carrier is a service used to transport the parcels or couriers from one place to another.","example":"USPS"},"currencyCode":{"type":"string","description":"A three-character (all uppercase letter) symbol of a currency according to the international ISO standard. As a rule, the first two letters denote the name of the country, and the third letter, the name of the currency thereof. For example, for US - the currency is Dollars and code is USD. Similarly for Canada, the currencycode is CAD, and for India, it is INR. ","example":"USD"},"deliveryCommitment":{"type":"object","description":"It specifies the delivery commitment provided by carrier for this shipment","properties":{"additionalDetails":{"type":"string","description":"It specifies the additional details for the delivery commitment","example":"By end of Day"},"estimatedDeliveryDateTime":{"type":"string","description":"It specifies estimated delivery date time","example":"2024-12-18 18:00:00.000"},"guarantee":{"type":"string","description":"It specifies if guarantee is provided for this shipment.","example":"NONE"},"maxEstimatedNumberOfDays":{"type":"string","description":"It specifies the maximum estimated number of days for the delivery of this shipment.","example":"3"},"minEstimatedNumberOfDays":{"type":"string","description":"It specifies the minimum estimated number of days for the delivery of this shipment.","example":"3"}}},"parcelType":{"type":"string","description":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. ParcelType have categories like Package, Envelopes, Paks, Boxes, Tube, etc. ","example":"PKG"},"rateTypeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Its value can be CONTRACT_RATES, COMMERCIAL or COMMERCIAL_BASE for USPS and COMMERCIAL for other carriers depending on the Pitney Bowes contract/subscription"},"children":[]}]}]}],"example":"CONTRACT_RATES"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"EM"},"specialServices":{"type":"array","description":"It provides a carrier-service based special or extra service.","items":{"type":"object","properties":{"fee":{"type":"number","description":"The amount of the special service.","example":88.5},"inputParameters":{"type":"array","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-The parameters to set for the special service, such as an insurance value or a receipt-number format. This is required if the special service requires input parameters. If a special service does not require input parameters, you can either leave out the array or pass an empty array."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"Name or ID of the Input Parameters.","example":"INPUT_VALUE"},"value":{"type":"string","description":"Value of the Input Parameters.","example":"5000"}}},"example":[{"name":"INPUT_VALUE","value":"5000"}]},"specialServiceId":{"type":"string","description":"A unique identifier associated to the Special Service, which depends on the carrier-based service.","example":"Ins"}},"example":[{"fee":88.5,"inputParameters":[{"name":"INPUT_VALUE","value":"5000"}],"specialServiceId":"Ins"},{"fee":0,"specialServiceId":"PO to Addressee"},{"fee":3.35,"inputParameters":[{"name":"INPUT_VALUE","value":"12345"}],"specialServiceId":"RR"},{"fee":0,"specialServiceId":"Sig"},{"fee":0,"specialServiceId":"liveanimal"}]}},"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier, including special service fees, surcharges, and any international taxes and duties, except as noted below:","example":117.35},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.","example":"06905"},"destinationZone":{"type":"string","description":"This is the postal or delivery zone assigned to the shipment's destination by the carrier. This field is returned for USPS as of now.","example":1}},"example":{"baseCharge":25.5,"carrier":"USPS","currencyCode":"USD","parcelType":"PKG","rateTypeId":"CONTRACT_RATES","serviceId":"EM","specialServices":[{"fee":88.5,"inputParameters":[{"name":"INPUT_VALUE","value":"5000"}],"specialServiceId":"Ins"},{"fee":0,"specialServiceId":"PO to Addressee"},{"fee":3.35,"inputParameters":[{"name":"INPUT_VALUE","value":"12345"}],"specialServiceId":"RR"},{"fee":0,"specialServiceId":"Sig"},{"fee":0,"specialServiceId":"liveanimal"}],"totalCarrierCharge":117.35,"destinationZone":1}},"shipmentId":{"type":"string","description":"A unique identifier for the shipment, generated by the system in response to shipment purchase.","example":"USPS2200579677758143"},"shipmentOptions":{"$ref":"#/components/schemas/shipmentOptions"},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"toAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"UNIT 35007"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"APO"},"company":{"type":"string","description":"The name of the company, in case if the recipient address is not residential.","example":"ABC Company"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"rs.canid@gmail.com"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Recipient Name"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"518-727-4964"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"96376-5007"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"AP"}}},"soldToAddress":{"$ref":"#/components/schemas/soldToAddress"},"customs":{"type":"object","required":["customsInfo","customsItems"],"properties":{"customsItems":{"type":"array","items":{"type":"object","required":["description","quantity","unitPrice","weight","weightUnit"],"properties":{"description":{"type":"string","description":"A detailed description of the commodity, up to 255 characters. The description will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Each description will appear on the form.","example":"T-shirt"},"hSTariffCode":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination country’s tariff-classification number (HS code) for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and then add digits for more detail. The maximum length for an HS code is 14 characters. The HS code will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each."},"children":[]}]}]}],"example":"610910"},"originCountryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two-character ISO country code of the shipment’s origin country. Use ISO 3166-1 Alpha-2 standard values."},"children":[]}]}]}],"example":"US"},"quantity":{"type":"number","description":"Enter the total number of items of this type of commodity.","example":1},"unitPrice":{"type":"number","description":"The price of one item of this type of commodity.","example":10},"weightUnit":{"type":"string","enum":["OZ"],"description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"The weight of the item.","example":1}}}},"customsInfo":{"type":"object","description":"This is additional customs information required along with item details.","required":["reasonForExport","customsDeclaredValue","currencyCode"],"properties":{"reasonForExport":{"type":"string","enum":["GIFT","COMMERCIAL_SAMPLE","MERCHANDISE","DOCUMENTS","RETURNED_GOODS","OTHER"],"description":"The reason the commodity is being exported.","example":"GIFT"},"customsDeclaredValue":{"description":"Item value in mentioned currencyCode","type":"number","example":10},"currencyCode":{"description":"The currency used for declared value. Use three uppercase letters, per ISO 4217","example":"USD","type":"string"},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"certificateNumber":{"type":"string","description":"The certificate number associated with the commodity.","example":"123456"},"comments":{"type":"string","description":"Free-form comments regarding the exported shipment.","example":"This is a sample comment"},"fromCustomsReference":{"type":"string","description":"Free-form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.","example":"EFEFE4554545"},"importerCustomsReference":{"type":"string","description":"A reference number used by the importer, such as a VAT number, PO number, or insured number.","example":"dff3433"},"invoiceNumber":{"type":"string","description":"The commercial invoice number assigned by the exporter.","example":"123456"},"licenseNumber":{"type":"string","description":"The export license number associated with the commodity.","example":"123456"},"sdrValue":{"type":"number","description":"When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values.","example":10},"termsOfSale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the delivery and payment terms between the shipper and recipient. Currenty supported by carriers - UPS, FedEx and DHL. - Common values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CIP: Carriage and Insurance Paid to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPT: Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAP: Delivered at Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAT: Delivered at Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DDP: Delivered Duty Paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXW: Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FCA: Free Carrier"},"children":[]}]}]}]}],"example":"DDP","enum":["CIP","CPT","DAP","DAT","DDP","EXW","FCA"]}}}}}}}},"components/schemas/MilitaryMailShipmentResponseV2":{"id":"components/schemas/MilitaryMailShipmentResponseV2","kind":"json-schema","title":"MilitaryMailShipmentResponseV2","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"3e2a71cc421e40b7970db9d540b1c7f2"},"shipmentId":{"type":"string","description":"The shipmentId, a unique identifier for an individual Shipment.","example":"FEDEX2200626443337314"},"parcelTrackingNumber":{"type":"string","description":"The Tracking number given to the Parcel for tracking purpose.","example":329039098457},"labelLayout":{"type":"array","items":{"type":"object","properties":{"contentType":{"type":"string","description":"Specifies how the label content is encoded.","example":"BASE64","enum":["BASE64","URL"]},"contents":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL to access the label document if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the Base64-encoded data if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASE64"},"children":[]}]}]}],"example":"XlhBCl5MSDE2LDEyCl5MTDEyMTIKXkZUIDU4MSwgNDAzIF5BVU4gIF5GRDAwMDNeRlMgXkZYIENvbmZpZ3VyYWJsZSBUZXh0IDEK..."},"fileFormat":{"type":"string","description":"Defines the type of the shipment which is printed. For example, Shipping label prints in PDF form.","example":"ZPL2"},"size":{"type":"string","description":"Defines the label size of the Shipment, that is, the Shipping Label is available in different Doc Size.","example":"DOC_4X6"},"type":{"type":"string","description":"Defines the type of the Shipment.","enum":["SHIPPING_LABEL"],"example":"SHIPPING_LABEL"}}}},"parcel":{"$ref":"#/components/schemas/parcelV2"},"rate":{"allOf":[{"$ref":"#/components/schemas/rateResponseV2"}]},"references":{"$ref":"#/components/schemas/referenceV2"},"printStatus":{"type":"string","description":"Status of the Printed Label.","example":"submitted"},"printError":{"type":"object","properties":{"code":{"type":"string","description":"indicates error code of print","example":"validation_error"},"message":{"type":"string","description":"Error message if print failed ","example":"Api is not supported for your 1.10.15 version please install latest dh version"}}},"fromAddress":{"$ref":"#/components/schemas/fromAddressV2Response"},"toAddress":{"$ref":"#/components/schemas/toAddressV2Response"},"shipmentOptions":{"allOf":[{"$ref":"#/components/schemas/shipmentOptions"},{"type":"object","properties":{"billingWeight":{"type":"string","description":"The weight used by the carrier to calculate the shipping cost. This value is determined as the greater of the actual weight and the dimensional weight.\n","example":"128.0"}}}]},"customs":{"type":"object","properties":{"customsItems":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"A detailed description of the commodity, up to 255 characters. The description will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Each description will appear on the form.","example":"T-shirt"},"hSTariffCode":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination country’s tariff-classification number (HS code) for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and then add digits for more detail. The maximum length for an HS code is 14 characters. The HS code will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each."},"children":[]}]}]}],"example":"610910"},"originCountryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two-character ISO country code of the shipment’s origin country. Use ISO 3166-1 Alpha-2 standard values."},"children":[]}]}]}],"example":"US"},"quantity":{"type":"number","description":"Enter the total number of items of this type of commodity.","example":1},"unitPrice":{"type":"number","description":"The price of one item of this type of commodity.","example":10},"weightUnit":{"type":"string","enum":["OZ"],"description":"The unit of measurement. This field is required by the unitWeight object.","example":"OZ"},"weight":{"type":"number","description":"The weight of the item.","example":1}}}},"customsInfo":{"type":"object","description":"This is additional customs information required along with item details.","properties":{"reasonForExport":{"type":"string","enum":["GIFT","COMMERCIAL_SAMPLE","MERCHANDISE","DOCUMENTS","RETURNED_GOODS","OTHER"],"description":"The reason the commodity is being exported.","example":"GIFT"},"customsDeclaredValue":{"description":"Item value in mentioned currencyCode","type":"number","example":10},"currencyCode":{"description":"The currency used for declared value. Use three uppercase letters, per ISO 4217","example":"USD","type":"string"},"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"certificateNumber":{"type":"string","description":"The certificate number associated with the commodity.","example":"123456"},"comments":{"type":"string","description":"Free-form comments regarding the exported shipment.","example":"This is a sample comment"},"fromCustomsReference":{"type":"string","description":"Free-form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.","example":"EFEFE4554545"},"importerCustomsReference":{"type":"string","description":"A reference number used by the importer, such as a VAT number, PO number, or insured number.","example":"dff3433"},"invoiceNumber":{"type":"string","description":"The commercial invoice number assigned by the exporter.","example":"123456"},"licenseNumber":{"type":"string","description":"The export license number associated with the commodity.","example":"123456"},"sdrValue":{"type":"number","description":"When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values.","example":10}}}}}},"example":{"correlationId":"c68db9dd73114910910661b354667d16","shipmentId":"USPS2200608348653900","parcelTrackingNumber":"9405509109628000023076","labelLayout":[{"contentType":"URL","contents":"https://stg-labels-cls.gcs.pitneybowes.com/usps/164770160/outbound/label/c68db9dd73114910910661b354667d16.pdf","fileFormat":"PDF","size":"DOC_4X6","type":"SHIPPING_LABEL"}],"parcel":{"length":2,"height":1,"width":1,"dimUnit":"IN","weightUnit":"OZ","weight":2,"packageValue":2},"rate":{"baseCharge":12.17,"carrier":"USPS","currencyCode":"USD","deliveryCommitment":{"additionalDetails":"By end of Day","estimatedDeliveryDateTime":"2025-09-08","guarantee":"NONE","maxEstimatedNumberOfDays":"3","minEstimatedNumberOfDays":"3"},"inductionPostalCode":"94043","parcelType":"PKG","rateTypeId":"COMMERCIAL","serviceId":"PM","totalCarrierCharge":12.17,"destinationZone":"8","isHazmat":false},"references":{"reference1":"custome message","reference2":"SendTech"},"print":{"status":"error","jobId":"2R7An27MQnJODvA","error":{"code":"not_found","message":"printer not found for given alias: test","additionalCode":"DH_NF_20002","additionalInfo":"Alias name not found, please create a printer mapping"}},"fromAddress":{"addressLine1":"1600 Amphitheatre Pkwy","addressLine2":"Near Abc Street Near Xyz Street","cityTown":"Mountain View","company":"PB","countryCode":"US","email":"testuser@gmail.com","name":"Sender Name","phone":"6502530000","postalCode":"94043-1351","residential":false,"stateProvince":"CA","status":"VALIDATED_AND_NOT_CHANGED"},"toAddress":{"addressLine1":"Unit 35007","addressLine2":"Near Abc Street Near Xyz Street","cityTown":"APO","company":"PB","countryCode":"US","email":"testuser@gmail.com","name":"Recipient Name","phone":"518-727-4964","postalCode":"96376-5007","residential":false,"stateProvince":"AP","status":"VALIDATED_AND_NOT_CHANGED"},"shipmentOptions":{"addToManifest":true,"receiptOption":"noOptions","shipperId":"2000084646"}}}},"components/schemas/internationalShipmentResponse":{"id":"components/schemas/internationalShipmentResponse","kind":"json-schema","title":"internationalShipmentResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"00adf56ed852487ba9caec62b7ab2635"},"size":{"type":"string","description":"Defines the label size of the Shipment, e.g., Shipping Label having Doc Size (8' X 11').","enum":["DOC_8X11","DOC_4X8"],"example":"DOC_8X11"},"type":{"type":"string","description":"Defines the type of the Shipment, e.g., Shipping Label.","example":"SHIPPING_LABEL","enum":["SHIPPING_LABEL"]},"format":{"type":"string","description":"Defines the type of the shipment which is printed. For example, Shipping label prints in PDF form.","example":"PDF","enum":["PDF"]},"fromAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"company":{"type":"string","description":"The name of the company, in case if the sender address is not residential.","example":"Pitney Bowes Inc."},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":"john.publica@pb.com"},"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"203-555-1213"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06905-4317"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"taxId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tax Identification Number (TIN). TIN Number is supported for FedEx as of now."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max character length = 18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOSS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EORI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_UNION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 12 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RFC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a length of 13 characters is mapped to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERSONAL_NATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"taxIdType":{"type":"string","description":"Specifies the type of tax identification being provided.","enum":["EIN","GST","VAT","IOSS","RFC","EORI"]}}},"altReturnAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an optional field. if a package shipped from Location_A to Location_B needs to return to Location_C. Use this object to specify a return address different from the fromAddress. Supported by FedEx, UPS, and Purolator."},"children":[]}]}]}],"properties":{"addressLine1":{"type":"string","description":"The first line of the alternate return address, such as a street address or PO Box.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company for the alternate return address, in case if the recipient's address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"user@email.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"cityTown":{"type":"string","description":"The city or town for the alternate return address.","example":"Shelton"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"name":{"type":"string","description":"The name of the recipient or organization for the alternate return address.","example":"User Name"},"phone":{"type":"string","description":"The phone number associated with the alternate return address.","example":"203-555-1213"},"postalCode":{"type":"string","description":"The postal or ZIP code for the alternate return address.","example":"06484"},"stateProvince":{"type":"string","description":"The 2-letter state or province code for the alternate return address.","example":"CT"}}},"parcel":{"type":"object","required":["length","width","height","dimUnit","weight","weightUnit"],"properties":{"length":{"type":"integer","format":"int32","description":"Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"integer","format":"int32","description":"There is no strict rule as to which element is the width or the height, but typically, by convention the width is the second greatest dimension of a parcel.","example":1},"height":{"type":"integer","format":"int32","description":"By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN","enum":["IN"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","enum":["OZ"],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":1}}},"parcelTrackingNumber":{"type":"string","description":"The Tracking number given to the Parcel for tracking purpose.","example":"9471309105156000826739"},"rate":{"type":"object","properties":{"baseCharge":{"type":"number","description":"The base service charge is payable to the carrier, excluding special service charges.","example":25.5},"carrier":{"type":"string","description":"Carrier is a service used to transport the parcels or couriers from one place to another.","example":"USPS"},"currencyCode":{"type":"string","description":"A three-character (all uppercase letter) symbol of a currency according to the international ISO standard. As a rule, the first two letters denote the name of the country, and the third letter, the name of the currency thereof. For example, for US - the currency is Dollars and code is USD. Similarly for Canada, the currencycode is CAD, and for India, it is INR. ","example":"USD"},"deliveryCommitment":{"type":"object","description":"It specifies the delivery commitment provided by carrier for this shipment","properties":{"additionalDetails":{"type":"string","description":"It specifies the additional details for the delivery commitment","example":"By end of Day"},"guarantee":{"type":"string","description":"It specifies if guarantee is provided for this shipment.","example":"NONE"},"maxEstimatedNumberOfDays":{"type":"string","description":"It specifies the maximum estimated number of days for the delivery of this shipment.","example":"3"},"minEstimatedNumberOfDays":{"type":"string","description":"It specifies the minimum estimated number of days for the delivery of this shipment.","example":"3"}}},"parcelType":{"type":"string","description":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. ParcelType have categories like Package, Envelopes, Paks, Boxes, Tube, etc. ","example":"PKG"},"rateTypeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Its value can be CONTRACT_RATES, COMMERCIAL or COMMERCIAL_BASE for USPS and COMMERCIAL for other carriers depending on the Pitney Bowes contract/subscription"},"children":[]}]}]}],"example":"CONTRACT_RATES"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"EM"},"specialServices":{"type":"array","description":" It provides a carrier-service based special or extra service.","items":{"type":"object","properties":{"fee":{"type":"number","description":"The amount of the special service.","example":88.5},"inputParameters":{"type":"array","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-The parameters to set for the special service, such as an insurance value or a receipt-number format. This is required if the special service requires input parameters. If a special service does not require input parameters, you can either leave out the array or pass an empty array."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the input parameters.","example":"INPUT_VALUE"},"value":{"type":"string","description":"Value for the input parameters.","example":"5000"}}},"example":[{"name":"INPUT_VALUE","value":"5000"}]},"specialServiceId":{"type":"string","description":"This is the unique identifier given to various special service, which is used while Rating.","example":"Ins"}},"example":[{"fee":88.5,"inputParameters":[{"name":"INPUT_VALUE","value":"5000"}],"specialServiceId":"Ins"},{"fee":0,"specialServiceId":"PO to Addressee"},{"fee":3.35,"inputParameters":[{"name":"INPUT_VALUE","value":"12345"}],"specialServiceId":"RR"},{"fee":0,"specialServiceId":"Sig"},{"fee":0,"specialServiceId":"liveanimal"}]}},"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier, including special service fees, surcharges, and any international taxes and duties, except as noted below:","example":117.35}},"example":{"baseCharge":25.5,"carrier":"USPS","currencyCode":"USD","parcelType":"PKG","rateTypeId":"CONTRACT_RATES","serviceId":"EM","specialServices":[{"fee":88.5,"inputParameters":[{"name":"INPUT_VALUE","value":"5000"}],"specialServiceId":"Ins"},{"fee":0,"specialServiceId":"PO to Addressee"},{"fee":3.35,"inputParameters":[{"name":"INPUT_VALUE","value":"12345"}],"specialServiceId":"RR"},{"fee":0,"specialServiceId":"Sig"},{"fee":0,"specialServiceId":"liveanimal"}],"totalCarrierCharge":117.35}},"shipmentId":{"type":"string","description":"A unique identifier associated with the Shipment.","example":"USPS2200579677758143"},"shipmentOptions":{"allOf":[{"$ref":"#/components/schemas/shipmentOptions"},{"type":"object","properties":{"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"}}},{"type":"object","properties":{"billingWeight":{"type":"string","description":"The weight used by the carrier to calculate the shipping cost. This value is determined as the greater of the actual weight and the dimensional weight.\n","example":"128.0"}}}]},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"},"toAddress":{"type":"object","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Rochester"},"company":{"type":"string","description":"The name of the company, in case if the Recipient address is not residential.","example":"ABC Company"},"countryCode":{"type":"string","description":"\tThe country in which the address is located. Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines.","example":"US"},"email":{"type":"string","description":"The email address of the recipient. It can be person's email address or company email address (for non-residential).","example":"rs.canid@gmail.com"},"name":{"type":"string","description":"Name of the recipient to which this address points.","example":"Rufous Sirius Canid"},"phone":{"type":"string","description":"This is recipient's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number is 10 digits. ","example":"323 555-1212"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"14609-7418"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":false},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"NY"}}},"customs":{"type":"object","properties":{"customsInfo":{"type":"object","properties":{"EELPFC":{"type":"string","example":"NOEEI 30.2D2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A number provided by the Automated Export System (AES). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if the item is more than $2,500 USD, per Schedule B export codes. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Required if EELPFC  is AES ITN."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AES ITN is a unique transaction number generated by the Automated Export System (AES) when export data is filed for international shipments from the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ITN format is AES XYYYYMMDDNNNNNN, where X indicates the type, YYYYMMDD is the filing date, and NNNNNN is a 6-digit number. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AES X20250327123456"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the ITN is not available, an exemption format may be used: AESDOWN [Filer ID] [mm/dd/yyyy]. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AESDOWN 12345678912 03/27/2025"},"children":[]}]}]}]}]},"certificateNumber":{"type":"string","description":"The certificate number associated with the commodity.","example":"98788877"},"comments":{"type":"string","description":"Free-form comments regarding the exported shipment.","example":"test comment"},"currencyCode":{"type":"string","description":"The currency used for declared value. Use three uppercase letters, per ISO 4217.","example":"CAD"},"customsDeclaredValue":{"type":"number","description":"Item value in mentioned currencyCode.","example":10},"fromCustomsReference":{"type":"string","description":"Free-form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.","example":"11111"},"importerCustomsReference":{"type":"string","description":"A reference number used by the importer, such as a VAT number, PO number, or insured number.","example":"987654"},"invoiceNumber":{"type":"string","description":"The commercial invoice number assigned by the exporter.","example":1189223},"licenseNumber":{"type":"string","description":"The export license number associated with the commodity.","example":"456ABC123"},"reasonForExport":{"type":"string","description":"The reason the commodity is being exported.","example":"DOCUMENTS"},"sdrValue":{"type":"number","description":"When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values.","example":23.32},"termsOfSale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the delivery and payment terms between the shipper and recipient. Currenty supported by carriers - UPS, FedEx and DHL. - Common values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CIP: Carriage and Insurance Paid to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CPT: Carriage Paid To"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAP: Delivered at Place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAT: Delivered at Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DDP: Delivered Duty Paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXW: Ex Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FCA: Free Carrier"},"children":[]}]}]}]}],"example":"DDP","enum":["CIP","CPT","DAP","DAT","DDP","EXW","FCA"]}}},"customsItems":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"A detailed description of the commodity, up to 255 characters. The description will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each. Each description will appear on the form.","example":"Books"},"hSTariffCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination country’s tariff-classification number (HS code) for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and then add digits for more detail. The maximum length for an HS code is 14 characters. The HS code will appear on the customs form. If the shipment has multiple types of items, create a separate customsItems object for each."},"children":[]}]}]}],"example":"AST559"},"originCountryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two-character ISO country code of the shipment’s origin country. Use ISO 3166-1 Alpha-2 standard values."},"children":[]}]}]}],"example":"US"},"quantity":{"type":"number","description":"Enter the total number of items of this type of commodity.","example":1},"unitPrice":{"type":"number","description":"The price of one item of this type of commodity.","example":10},"weightUnit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WeightUnit is a standard for measuring the physical quantities of specified weight. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The valid values are: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- OZ: Ounces "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- GM: Grams "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- LB: Pounds "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- KG: Kilograms For USPS shipments, set this to OZ."},"children":[]}]}]}],"example":"OZ"},"weight":{"type":"number","description":"Weight is the measure of how heavy an object is.","example":1}}},"example":[{"description":"Books","hSTariffCode":"AST559","originCountryCode":"US","quantity":1,"unitPrice":10,"unitWeight":{"unitOfMeasurement":"OZ","weight":1}}]}}},"soldToAddress":{"$ref":"#/components/schemas/soldToAddress"},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"}}}},"components/schemas/cancelShipment":{"id":"components/schemas/cancelShipment","kind":"json-schema","title":"cancelShipment","data":{"type":"object","properties":{"carrier":{"type":"string","description":"The name of the Carrier.","example":"USPS"},"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier, including special service fees, surcharges, and any international taxes and duties, except as noted below:","example":0},"parcelTrackingNumber":{"type":"string","description":"The Tracking number given to the Parcel for tracking purpose.","example":"9471309105156000624885"},"status":{"type":"string","description":"Status of the Shipment.","example":"INITIATED"}}}},"components/schemas/reprintShipmentV2":{"id":"components/schemas/reprintShipmentV2","kind":"json-schema","title":"reprintShipmentV2","data":{"type":"object","properties":{"shipmentId":{"type":"string","description":"The shipmentId, a unique identifier for an individual Shipment, which is used for Reprint or Cancel.","example":"PUROLATOR2200626443337314"},"parcelTrackingNumber":{"type":"string","description":"The Tracking number given to the Parcel for tracking purpose.","example":329039098457},"labelLayout":{"type":"array","description":"It defines the layout of the shipping label.","items":{"type":"object","properties":{"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is used to encode binary data as printable text."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ContentType of the document is URL if the fileformat is PDF, while it will be BASE64 if the fileFormat is ZPL2."},"children":[]}]}]}],"example":"BASE64","enum":["URL","BASE64"]},"contents":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content/Identifier of document e.g., DOCUMENT_REFERECE_ID."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Actual document name e.g., abc.pdf. [IN]."},"children":[]}]}]}],"example":"Xhsafiuis"},"fileFormat":{"type":"string","description":"Defines the format of the document file the print takes.","example":"ZPL2","enum":["PDF","ZPL2"]},"size":{"type":"string","description":"Defines the label size of the Shipment, that is, the Shipping Label is available in different Doc Size.","example":"DOC_4X6","enum":["DOC_8X11","DOC_4X6"]},"type":{"type":"string","description":"Defines the type of the Shipment.","enum":["SHIPPING_LABEL"],"example":"SHIPPING_LABEL"}}}},"parcel":{"$ref":"#/components/schemas/parcelV2"},"rate":{"$ref":"#/components/schemas/rateResponseV2"},"references":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains key value map for passing references which is printed on Shipping Label. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example Department Name, Invoice No., PO No., Package description, Order No./ Purchase Order No., Carrier note, Cost Account No., Transportation No., etc. . Max references allowed here is 2."},"children":[]}]}]}],"properties":{"additionalReference1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Reference is hardly used, but sender can mention anything as per requirement, just for Recipient's information. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"612987641"},"additionalReference2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any tags or information that to be shown to Recipient, can be mentioned by Sender, which is not indicated on AdditionalReference1 field, e.g., PO No, Order No. etc."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"989"}}},"printStatus":{"type":"string","description":"Status of the Printed Label.","example":"submitted"}}}},"components/schemas/rateResponseV2":{"id":"components/schemas/rateResponseV2","kind":"json-schema","title":"rateResponseV2","data":{"type":"object","properties":{"baseCharge":{"type":"number","description":"The base service charge is payable to the carrier, excluding special service charges.","example":16.15},"carrier":{"type":"string","description":"Carrier is a service used to transport the parcels or couriers from one place to another.","example":"PUROLATOR"},"currencyCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A three-character (all uppercase letter) symbol of a currency according to the international ISO standard."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" As a rule, the first two letters denote the name of the country, and the third letter, the name of the currency thereof. For example, for US - the currency is Dollars and code is USD. Similarly for Canada, the currencycode is CAD, and for India, it is INR."},"children":[]}]}]}],"example":"CAD"},"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ParcelType have categories like Package, Envelopes, Paks, Boxes, Tube, etc."},"children":[]}]}]}],"example":"PKG"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"GRD"},"surcharges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fees or surcharges applied to the shipment. Each object in the array represents a specific surcharge and its associated fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be one of the supported surcharge types from the respective carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Surcharge Names by Carrier:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge Names"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FUEL, GO_GREEN_BASIC, OVERSIZE, PREMIUM, RURAL, TOLL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANCILLARY_FEE, CANADIAN_DESTINATION, DELIVERY_AREA, DELIVERY_CONFIRMATION, FUEL, NON_MACHINABLE, OTHER, OUT_OF_DELIVERY_AREA, OUT_OF_PICKUP_AREA, OVERSIZE, RESIDENTIAL_DELIVERY, RESIDENTIAL_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERY_AREA, EXTENDED_AREA, FUEL, LARGE_PACKAGE, RESIDENTIAL, SHIPPER_PAYS_DUTY_TAX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nonmachinable, oversize"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":2.95},"name":{"type":"string","description":"The name of surcharge.","example":"ResidentialDelivery"}}}},"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier, including special service fees, surcharges, and any international taxes and duties, except as noted below:","example":22.46},"deliveryCommitment":{"type":"object","description":"Check for estimated delivery date, guarantee (if any), and number of days for shipment to be delivered.","properties":{"estimatedDeliveryDateTime":{"type":"string","description":"Estimated Delivery Date.","example":"2024-03-25"},"maxEstimatedNumberOfDays":{"type":"string","description":"Max days to deliver shipment.","example":5},"guarantee":{"type":"string","description":"Checks if there is any guarantee or committment for shipment delivery.","example":"None"}}},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.","example":"06905"},"destinationZone":{"type":"string","description":"This is the postal or delivery zone assigned to the shipment's destination by the carrier. This field is returned for USPS as of now.","example":1}}}},"components/schemas/domesticShipmentResponseV2":{"id":"components/schemas/domesticShipmentResponseV2","kind":"json-schema","title":"domesticShipmentResponseV2","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"3e2a71cc421e40b7970db9d540b1c7f2"},"shipmentId":{"type":"string","description":"The shipmentId, a unique identifier for an individual Shipment.","example":"FEDEX2200626443337314"},"parcelTrackingNumber":{"type":"string","description":"The Tracking number given to the Parcel for tracking purpose.","example":329039098457},"carrierAccountId":{"type":"string","description":"Unique identifier of the carrier account under which shipments is processed.","example":"GOaVO7vExxxx"},"labelLayout":{"type":"array","items":{"type":"object","properties":{"contentType":{"type":"string","description":"Specifies how the label content is encoded.","example":"BASE64","enum":["BASE64","URL"]},"contents":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL to access the label document if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"URL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the Base64-encoded data if the content type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASE64"},"children":[]}]}]}],"example":"XlhBCl5MSDE2LDEyCl5MTDEyMTIKXkZUIDU4MSwgNDAzIF5BVU4gIF5GRDAwMDNeRlMgXkZYIENvbmZpZ3VyYWJsZSBUZXh0IDEK..."},"fileFormat":{"type":"string","description":"Defines the type of the shipment which is printed. For example, Shipping label prints in PDF form.","example":"ZPL2"},"size":{"type":"string","description":"Defines the label size of the Shipment, that is, the Shipping Label is available in different Doc Size.","example":"DOC_4X6"},"type":{"type":"string","description":"Defines the type of the Shipment.","enum":["SHIPPING_LABEL"],"example":"SHIPPING_LABEL"}}}},"parcel":{"$ref":"#/components/schemas/parcelV2"},"rate":{"allOf":[{"$ref":"#/components/schemas/rateResponseV2"},{"type":"object","properties":{"baseChargeTaxes":{"type":"array","description":"List of taxes applied to the base charge. Returned in case of Canada carriers, such as: purolator, Canpar and Fedex.","items":{"type":"object","properties":{"displayName":{"type":"string","description":"Name of the tax applied.","example":"Canada goods and services"},"name":{"type":"string","description":"Short code or identifier of the tax.","example":"GST"},"taxAmount":{"type":"number","format":"float","description":"Amount charged for this tax.","example":2.69}}}},"totalTaxAmount":{"type":"number","format":"float","description":"Total tax amount applied to the shipment. Returned in case of canada carriers.","example":2.69},"publishedTotalCarrierCharge":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount based on the carrier's standard (published) rates, including base charges, surcharges, special services, discounts, and applicable taxes. This value reflects the amount the carrier would charge without any negotiated discounts or platform-specific rate adjustments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only when supported by the carrier (e.g., FedEx, UPS, DHL, USPS).\""},"children":[]}]}]}]}],"example":73.12}}}]},"references":{"$ref":"#/components/schemas/referenceV2"},"printStatus":{"type":"string","description":"Status of the Printed Label.","example":"submitted"},"printError":{"type":"object","properties":{"code":{"type":"string","description":"indicates error code of print","example":"validation_error"},"message":{"type":"string","description":"Error message if print failed ","example":"Api is not supported for your 1.10.15 version please install latest dh version"}}},"fromAddress":{"$ref":"#/components/schemas/fromAddressV2Response"},"toAddress":{"$ref":"#/components/schemas/toAddressV2Response"},"soldToAddress":{"$ref":"#/components/schemas/soldToAddress"},"additionalAddresses":{"$ref":"#/components/schemas/additionalAddresses"},"shipmentOptions":{"allOf":[{"$ref":"#/components/schemas/shipmentOptions"},{"type":"object","properties":{"billingWeight":{"type":"string","description":"The weight used by the carrier to calculate the shipping cost. This value is determined as the greater of the actual weight and the dimensional weight.\n","example":"128.0"}}},{"type":"object","properties":{"bookingConfirmationNumber":{"type":"string","minLength":5,"maxLength":12,"example":"XXXX56789812","description":"This is an advanced booking number required for FedEx Express Freight shipments. It must be obtained through the appropriate channel in the shipment's origin country. Without a valid booking confirmation number, pickup and space allocation for the shipment are not guaranteed. The booking number must be between 5 and 12 digits.\n"}}}]},"carrierPayments":{"$ref":"#/components/schemas/carrierPayments"}},"example":{"correlationId":"6270e32715df4c4884a2008f943fe179","shipmentId":"USPS2200613202723337","parcelTrackingNumber":"9470109109628000114503","carrierAccountId":"GOaVO7vERQxO","labelLayout":[{"contentType":"URL","contents":"https://prv-labels-cls.gcs.pitneybowes.com/usps/910187923/outbound/label/5ecfa0ecc6454caeb90c55d35229de90.pdf","fileFormat":"PDF","size":"DOC_4X6","type":"SHIPPING_LABEL"}],"parcel":{"length":10,"height":10,"width":10,"dimUnit":"IN","weightUnit":"OZ","weight":10,"packageValue":10},"rate":{"baseCharge":27.6,"carrier":"USPS","currencyCode":"USD","deliveryCommitment":{},"inductionPostalCode":"06905","parcelType":"PKG","rateTypeId":"CONTRACT_RATES","serviceId":"EM","specialServices":[],"totalCarrierCharge":27.6,"destinationZone":"1","isHazmat":false},"references":{"reference1":"custome message","reference2":"SendTech"},"fromAddress":{"addressLine1":"1600 Amphitheatre Pkwy","addressLine2":"Near Abc Street Near Xyz Street","cityTown":"Mountain View","company":"PB","countryCode":"US","email":"testuser@gmail.com","name":"Sender Name","phone":"6502530000","postalCode":"94043-1351","residential":false,"stateProvince":"CA","inductionPostalCode":"06905","status":"VALIDATED_AND_NOT_CHANGED"},"toAddress":{"addressLine1":"350 5th Ave","addressLine2":"Near Abc Street Near Xyz Street","cityTown":"New York","company":"PB","countryCode":"US","email":"recipient@gmail.com","name":"Recipient Name","phone":"2127363100","postalCode":"10118-0110","residential":false,"stateProvince":"NY","status":"VALIDATED_AND_NOT_CHANGED","isPOBox":true},"shipmentOptions":{"addToManifest":true,"receiptOption":"noOptions","shipperId":"2000084646","billingWeight":"16.00"}}}},"components/schemas/fromAddressV2Response":{"id":"components/schemas/fromAddressV2Response","kind":"json-schema","title":"fromAddressV2Response","data":{"type":"object","description":"The complete address of the Sender.","properties":{"name":{"type":"string","description":"The name of the Sender to which this address points.","example":"Sender Name"},"addressLine1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1600 Amphitheatre Parkway"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":"The name of the company, in case if the senders address is not residential.","example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be senders's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits. ","example":"6502530000"},"cityTown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the city or town the Sender's address belongs to. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Mountain View"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The name of the State or Province the Sender belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US or Canadian address(es)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please switch to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" radio button, enter the required country name or country code, and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#iso:code:3166:CA","description":"List of Province with their Province/State Codes."},"example":"CA"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code or ZIP Code of the address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For CA addresses, use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"six-character"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alphanumeric string Postal Code in this format: 'A1A 1A1'. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" While for US addresses, use either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code in one of the following formats: '12345' or '12345-6789'. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]}]}]}],"example":"94043"},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.\n","example":"06905"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The country in which the sender's address is located. The value will be the two-character ISO Code of the country from the ISO country list. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink, please select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#search","description":"List of Countries with their ISO Codes"},"example":"US"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}}},"components/schemas/toAddressV2Response":{"id":"components/schemas/toAddressV2Response","kind":"json-schema","title":"toAddressV2Response","data":{"type":"object","description":"The complete address of the Reciepient.","properties":{"name":{"type":"string","description":"The name of the Recipient.","example":"Recipient Name"},"addressLine1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Recipient. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"350 Fifth Avenue"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the city or town the Recipient belongs to. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"New York"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The name of the State or Province the Sender belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US or Canadian address(es)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please switch to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" radio button, enter the required country name or country code, and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button . "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#iso:code:3166:CA","description":"List of Province with their Province/State Codes."},"example":"NY"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The Postal Code or ZIP Code of the address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For CA addresses, use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"six-character"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alphanumeric string Postal Code in this format: 'A1A 1A1'."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" While for US addresses, use either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code in one of the following formats: '12345' or '12345-6789'."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"example":"10118"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The country in which the recipient's address is located. The value will be the two-character ISO Code of the country from the ISO country list. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink, please select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#search","description":"List of Countries with their ISO Codes"},"example":"US"},"company":{"type":"string","description":"The name of the company, in case if the recipient address is not residential.","example":"PB"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is Recipient's phone number. Enter the digits with or without spaces or hyphens. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"332 555-1212"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be recipient's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"recipient@gmail.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"isPOBox":{"type":"boolean","description":"Checks if the specified address has the PO Box. In case if Yes, the boolean value will be 'true', else it will take 'false'.","example":true}}}},"components/schemas/parcelV2Response":{"id":"components/schemas/parcelV2Response","kind":"json-schema","title":"parcelV2Response","data":{"type":"object","required":["weightUnit"],"description":"The details of the Parcel.","properties":{"length":{"type":"number","description":"Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"number","description":"There is no strict rule as to which element is the width or the height, but the width is the second greatest dimension of a parcel by convention.","example":1},"height":{"type":"number","description":"By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters.","example":"IN"},"weightUnit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WeightUnit is a standard for measuring the physical quantities of specified weight. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For USPS shipments, this is OZ."},"children":[]}]}]}],"example":"OZ"},"weight":{"type":"number","description":"Weight measures the heaviness of an object (how heavy an object is) .","example":2},"packageValue":{"type":"number","description":"Indicates value of the package.","example":2}}}},"components/schemas/cancelShipmentV2":{"id":"components/schemas/cancelShipmentV2","kind":"json-schema","title":"cancelShipmentV2","data":{"type":"object","properties":{"carrier":{"type":"string","description":"The name of the Carrier.","example":"USPS"},"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier, including special service fees, surcharges, and any international taxes and duties.","example":0},"parcelTrackingNumber":{"type":"string","description":"The Tracking number given to the Parcel for tracking purpose.","example":"9471309105156000624885"},"status":{"type":"string","description":"Status of the Shipment.","example":"INITIATED","enum":["INITIATED","APPROVED"]},"references":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains key value map for passing references which is printed on Shipping Label. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example Department Name, Invoice No., PO No., Package description, Order No./ Purchase Order No., Carrier note, Cost Account No., Transportation No., etc. . Max references allowed here is 2."},"children":[]}]}]}],"properties":{"additionalReference1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Reference is hardly used, but sender can mention anything as per requirement, just for Recipient's information. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"612987641"},"additionalReference2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any tags or information that to be shown to Recipient, can be mentioned by Sender, which is not indicated on AdditionalReference1 field, e.g., PO No, Order No. etc."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"989"}}}}}},"components/schemas/shipmentOptions":{"id":"components/schemas/shipmentOptions","kind":"json-schema","title":"shipmentOptions","data":{"type":"object","properties":{"addToManifest":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The option asks if the shipment is to be added for Manifest, so that the shipment will reflect in the Manifest Form while compilation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value can be 'true' or 'false'. Applicable for USPS and CPC carriers."},"children":[]}]}]}],"example":true},"printCustomMessage":{"type":"string","description":"It prints a custom message on shipping label. Custom messages are not supported for RMG shipments.","example":"Print Message 1"},"receiptOption":{"type":"string","description":"It provides options to print receipt with shipping label. Only applicable for USPS, and it can have the indicated possible/ enum values.","example":"RECEIPT_WITH_INSTRUCTIONS","enum":["RECEIPT_ONLY","RECEIPT_WITH_INSTRUCTIONS","or NO_OPTIONS"]},"printDepartment":{"type":"string","description":"It prints the Department on Shipping Label, applicable for FedEx.","example":"department"},"printInvoiceNumber":{"type":"string","description":"It prints Invoice Number on Shipping Label, applicable for FedEx.","example":"invoicenumber"},"printPONumber":{"type":"string","description":"It prints Product Order number on Shipping Label, applicable for FedEx.","example":"ponumber"},"shipperId":{"type":"string","description":"The unique identifier of the known shipper.","example":"1234567890"},"minimalAddressValidation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows performing minimal address validation during shipment creation. the addressLine1 field is not validated if set to true."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimal address validation is supported only for these APIs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Shipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Bulk Shipments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Multipiece Shipment"},"children":[]}]}]}]}],"example":true,"enum":[true,false]}}}},"components/schemas/PrintDocumentRequest":{"id":"components/schemas/PrintDocumentRequest","kind":"json-schema","title":"PrintDocumentRequest","data":{"type":"object","required":["printerAliasName","data","dataType","documentType","formName"],"properties":{"printerAliasName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the Printer connected (directly or via network) to a Computer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"Pitney Bowes Printer"},"data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content/Identifier of document e.g., DOCUMENT_REFERECE_ID. Actual document name e.g., abc.pdf. [IN] i.e base64 string, URL, file path"},"children":[]}]}]}],"example":"<<base64string>>"},"dataType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Type of the document e.g., DOCUMENT_REFERENCE. [IN/OUT]"},"children":[]}]}]}],"example":"BASE64","enum":["BASE64","URL"]},"documentType":{"type":"string","description":"The format of the document file the print takes.","example":"ZPL2","enum":["ZPL2","ZPL","PDF"]},"formName":{"type":"string","description":"The name of the Document Form.","example":"ENV10","enum":["8x11","4x6","2x1","ENV10","ENV9","A1"]},"orientation":{"type":"string","description":"The orientation of the document layout: Portrait or Landscape.","example":"PORTRAIT"},"reference":{"type":"object","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains key value map for passing references. Max references allowed is 6. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - References are tags or information that is printed on Shipping Label based on the customer's requirement."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Reference Fields can have values/indication like department name, invoice no., package description, purchase order no., carrier note, cost account no., transportation no., or PO No., etc. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Each of the reference field can have only one indication/value."},"children":[]}]}]}]}],"properties":{"reference1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference 1 can have one of the above-indicated values/information, which is printed on Label, e.g., Cost Account No. (if any) or Invoice Number. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"123456"},"reference2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference 2 can have other details as indicated in the list above. This is also printed on Label, e.g., Package Description . "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"SendTech"},"reference3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference 3 can have the information which were not fulfilled in Ref1 and Ref2, e.g., Order No. or Purchase Order ID. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"65439"},"reference4":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference 4 can have more information which were not provided in Ref1, Ref2, or Ref3 e.g., Carrier Note. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"FedEx First Overnight"}}}}}},"components/schemas/PrintDocumentResponse":{"id":"components/schemas/PrintDocumentResponse","kind":"json-schema","title":"PrintDocumentResponse","data":{"type":"object","properties":{"jobId":{"type":"string","description":"Job ID of the printed document.","example":"accc"}}}},"components/schemas/PrinterMappingResponse":{"id":"components/schemas/PrinterMappingResponse","kind":"json-schema","title":"PrinterMappingResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"A Unique ID for the Printer mapper.","example":"65cdce754189e0177c728c8c"}}}},"components/schemas/PrinterMappingRequest":{"id":"components/schemas/PrinterMappingRequest","kind":"json-schema","title":"PrinterMappingRequest","data":{"type":"object","required":["alias","serialNumber","printerName"],"properties":{"alias":{"type":"string","description":"Name of the printer connected (directly or via network) to a computer.","example":"rohit2"},"serialNumber":{"type":"string","description":"A Device Serial number.","example":"AP-DP1LZH3-0x919e698164-dev"},"printerName":{"type":"string","description":"The Printer name which is used for mapping.","example":"Brother QL-1110NWB"}}}},"components/schemas/PrinterMappingGetResponse":{"id":"components/schemas/PrinterMappingGetResponse","kind":"json-schema","title":"PrinterMappingGetResponse","data":{"type":"object","properties":{"alias":{"type":"string","description":"The printer connected (directly or via network) to a computer.","example":"rohit2"},"serialNumber":{"type":"string","description":"A Device Serial number.","example":"AP-DP1LZH3-0x919e698164-dev"},"printerName":{"type":"string","description":"The Printer name which is used for mapping.","example":"Brother QL-1110NWB"},"subId":{"type":"string","description":"The subscription ID used for mapping.","example":"rohit2"},"insertTimeStamp":{"type":"string","description":"It records saved Timestamp.","format":"date-time","example":"2024-02-02T11:51:00.479Z"},"updateTimeStamp":{"type":"string","description":"It records updated Timestamp.","format":"date-time","example":"2024-02-02T11:51:00.479Z"}}}},"components/schemas/JobStatus":{"id":"components/schemas/JobStatus","kind":"json-schema","title":"JobStatus","data":{"type":"object","properties":{"jobId":{"type":"string","description":"Job ID  can be used to check the status of the print request.","example":"LkolBjvmy3mBzyp"},"status":{"type":"string","description":"Refers to the status of Print Job.","example":"SUCCESS"},"printStatusTransaction":{"type":"array","items":{"type":"object","description":"The Array containing print statuses.","properties":{"name":{"type":"string","description":"The status transaction ID of the Print document.","example":"LkolBjvmy3mBzyp"},"status":{"type":"string","description":"Status of the Print document.","example":"COMPLETED"}}}}}}},"components/schemas/CreateDefaults":{"id":"components/schemas/CreateDefaults","kind":"json-schema","title":"CreateDefaults","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Default.","example":"FedEx-Defaults"},"defaultID":{"type":"string","description":"A unique identifier to be assigned to the Default. ","example":"0d4f3c51-059b-4c28-a83b-a8defa2962cc"},"sendingOptions":{"$ref":"#/components/schemas/sendingOptions"}}}},"components/schemas/GetDefaultsById":{"id":"components/schemas/GetDefaultsById","kind":"json-schema","title":"GetDefaultsById","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the created Default. For example: Domestic.","example":"Domestic"},"defaultID":{"type":"string","description":"Unique identifier assigned to the Default while its creation using CreateDefaults API.","example":"0d4f3c51-059b-4c28-a83b-a8defa2962cc"},"createdDate":{"type":"string","format":"date-time","description":"The timestamp when the Default is created.","example":"2024-08-06T06:12:46.258Z"},"updatedDate":{"type":"string","format":"date-time","description":"The timestamp when the Default is updated.","example":"2024-08-06T06:12:46.258Z"},"sendingOptions":{"$ref":"#/components/schemas/sendingOptions"}}}},"components/schemas/DefaultResponse":{"id":"components/schemas/DefaultResponse","kind":"json-schema","title":"DefaultResponse","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the created Default. For example: Domestic.","example":"Domestic"},"defaultID":{"type":"string","description":"Unique identifier assigned to the Default while its creation using CreateDefaults API.","example":"0d4f3c51-059b-4c28-a83b-a8defa2962cc"},"createdDate":{"type":"string","description":"The timestamp when the Default is created.","example":"2024-08-06T06:12:46.258Z"},"updatedDate":{"type":"string","description":"The timestamp when the Default is updated.","example":"2024-08-06T06:12:46.258Z"},"sendingOptions":{"$ref":"#/components/schemas/sendingOptionsResponse"}}}},"components/schemas/sendingOptions":{"id":"components/schemas/sendingOptions","kind":"json-schema","title":"sendingOptions","data":{"type":"object","description":"Sending Options will include carrier and its account details, sender details, and parcel details.","properties":{"carrier":{"type":"string","description":"Name of the carrier. E.g., FedEx.","enum":["FedEx","USPS"],"example":"FedEx"},"service":{"type":"string","description":"Name of the carrier-based service. E.g., 2DA.","example":"2DA"},"carrierAccounts":{"type":"object","description":"Name of the carrier account which is provided while adding carrier.","properties":{"key":{"type":"string","description":"This is the key mapped with the name of the carrier."},"value":{"type":"string","description":"This is the value mapped with the CarrierAccount of the carrier.","example":null}},"example":{"USPS":"JYKEb4VQvoVx!","FEDEX":"WRF4VFUUJDx!"}},"labelSize":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Size of the label, e.g., DOC_4X6."},"children":[]}]}]}],"enum":["DOC_4X6"],"example":"DOC_4X6"},"labelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the Label, e.g., Shipping_Label."},"children":[]}]}]}],"example":"SHIPPING_LABEL"},"labelFormat":{"type":"string","description":"Format of the Label, e.g., PDF.","example":"PDF"},"fromAddress":{"$ref":"#/components/schemas/fromAddressDefault"}}}},"components/schemas/sendingOptionsResponse":{"id":"components/schemas/sendingOptionsResponse","kind":"json-schema","title":"sendingOptionsResponse","data":{"type":"object","description":"Sending Options includes used carrier related details, sender details, and parcel details.","properties":{"carrier":{"type":"string","description":"Name of the carrier. E.g., FedEx.","example":"FedEx"},"service":{"type":"string","description":"Name of the carrier-based service. E.g., 2DA.","example":"2DA"},"carrierAccounts":{"type":"object","description":"Name of the carrier account which is provided while adding carrier.","properties":{"key":{"type":"string","description":"Key mapped with the name of the carrier."},"value":{"type":"string","description":"Value mapped with the CarrierAccount of the used carrier.","example":null}},"example":{"USPS":"JYKEb4VQvoVx!","FEDEX":"WRF4VFUUJDx!"}},"labelSize":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Size of the label, e.g., DOC_4X6."},"children":[]}]}]}],"enum":["DOC_4X6"],"example":"DOC_4X6"},"labelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the Label, e.g., Shipping_Label."},"children":[]}]}]}],"example":"SHIPPING_LABEL"},"labelFormat":{"type":"string","description":"Format of the Label, e.g., PDF.","example":"PDF"},"fromAddress":{"$ref":"#/components/schemas/fromAddressV2Response"},"altReturnAddress":{"$ref":"#/components/schemas/altReturnAddressDefault"},"parcel":{"$ref":"#/components/schemas/parcelV2Response"}}}},"components/schemas/CreateDefaultsResponse":{"id":"components/schemas/CreateDefaultsResponse","kind":"json-schema","title":"CreateDefaultsResponse","data":{"type":"object","description":"This is the response for created Default.","properties":{"id":{"type":"string","description":"Unique identifier used in Database for Default, for mapping purpose.","example":"66b1b6d6a2c763f9d0bd5396"},"defaultId":{"type":"string","description":"Assigned unique identifier for the created Default.","example":"1c7937cf-fc56-4fc6-95bf-0465ae9acd4f"}}}},"components/schemas/AllDefaults":{"id":"components/schemas/AllDefaults","kind":"json-schema","title":"AllDefaults","data":{"type":"object","properties":{"pageInfo":{"type":"object","properties":{"total":{"type":"integer","example":78,"description":"Defines Total number of records."},"pages":{"type":"integer","example":8,"description":"Defines Total number of pages."},"page":{"type":"integer","example":1,"description":"Defines Current page number."}}},"data":{"type":"array","items":{"type":"object","properties":{"defaultsResponse":{"$ref":"#/components/schemas/DefaultResponse"}}}}}}},"components/schemas/unauthorizedError":{"id":"components/schemas/unauthorizedError","kind":"json-schema","title":"unauthorizedError","data":{"type":"object","properties":{"message":{"type":"string","description":"This is HTTP 401 Unauthorized response status code, which indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource."}},"required":["message"]}},"components/schemas/serverError":{"id":"components/schemas/serverError","kind":"json-schema","title":"serverError","data":{"type":"object","properties":{"message":{"type":"string","description":"This is HTTP 500 Internal Server Error response status code, which indicates that the server encountered an unexpected condition that prevented it from fulfilling the request."}},"required":["message"]}},"components/schemas/invalidErrors":{"id":"components/schemas/invalidErrors","kind":"json-schema","title":"invalidErrors","data":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code(s) that appear due to HTTP  400- Invalid or Bad Request, e.g., validation-error.","example":"validation_error"},"errorDescription":{"type":"string","description":"The HTTP 400 Bad Request response status code indicates that the server cannot process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","example":"string"},"additionalCode":{"type":"string","description":"A unique identifier for the error, for example 1101055, 0100008, or 1021126."},"additionalInfo":{"type":"string","description":"This is an additional information about the error. This error 'Invalid Request' might appear due to invalid dimension, weight, or serviceID, or if the information is missing."},"additionalParameters":{"type":"array","items":{"type":"string","description":"The field(s) that might be incorrect in the request."}}}}}},"components/schemas/notFoundErrors":{"id":"components/schemas/notFoundErrors","kind":"json-schema","title":"notFoundErrors","data":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","example":"not_found","description":"Error code(s) that appear due HTTP 404 Page or File not found."},"errorDescription":{"type":"string","example":"resource not found","description":"The HTTP 404 Not Found response status code indicates that the server cannot find the requested resource."},"additionalCode":{"type":"string","description":"A unique identifier for the error, for example 0100025, 1110017, or 1090001."},"additionalInfo":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information about the error. This error 'Not Found' might appear due to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shipment Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No Shipments to close"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Original Transaction not found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"additionalParameters":{"type":"array","items":{"type":"string","description":"The field(s) that might be incorrect in the request."}}}}}},"components/schemas/ErrCoversheetRequest":{"id":"components/schemas/ErrCoversheetRequest","kind":"json-schema","title":"ErrCoversheetRequest","data":{"type":"object","required":["type","carrierAccountId","parcelType","serviceId","fromAddress","parcel","toAddress","specialServices"],"properties":{"format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file format of the coversheet. For coversheet, supported format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For barcode and stamp, supported format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GIF"},"children":[]}]}]}],"example":"PDF","enum":["PDF","GIF"]},"size":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The size of the coversheet. Default size is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is applicable only for coversheet."},"children":[]}]}]}],"example":"6X9.5","enum":["10","6X9.5","6X9","9.5x12"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the output."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COVERSHEET: Returns coversheet output (backward compatible)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BARCODE.STAMP: Returns separate outputs for the ERR barcode and ERR stamp."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL: Returns three outputs:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"coversheet (Content Type: URL, Format: PDF)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ERR barcode (Content Type: BASE64, Format: GIF)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ERR stamp (Content Type: URL, Format: GIF)"},"children":[]}]}]}]}]}]}],"example":"ALL","enum":["COVERSHEET","ALL","BARCODE.STAMP"]},"carrierAccountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier assigned to the specific carrier account. Its value can be referred from the response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carrier Accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}],"example":"JPZlE8DldKwx"},"parcelType":{"type":"string","description":"Type of the parcel, such as Letter or Envelope.","example":"LGENV","enum":["LGENV","PKG","LTR"]},"serviceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier given to the carrier specific service, such as First Class Mail (FCM). It can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}],"example":"FCM"},"specialServices":{"type":"array","description":"List of special services applied.","items":{"type":"object","properties":{"specialServiceId":{"type":"string","description":"The ID of the special service. Cert is mandatory special service.","enum":["Cert","ERR"]}}},"example":[{"specialServiceId":"Cert"},{"specialServiceId":"ERR"}]},"fromAddress":{"type":"object","properties":{"name":{"type":"string","description":"Name of the person or entity.","example":"Ankush Monga"},"addressLine1":{"type":"string","description":"First line of the address.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"City or town of the address.","example":"Shelton"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State or province of the address. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US address(es)."},"children":[]}]}]}],"example":"CT"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code or ZIP Code of the address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For US addresses, use only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code."},"children":[]}]}]}],"example":"06484-4361"},"countryCode":{"type":"string","description":"Country code of the address.","example":"US"},"phone":{"type":"string","description":"Phone number associated with the address.","example":"203-555-1213"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the sender address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.","example":"06905"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"parcel":{"type":"object","properties":{"weight":{"type":"number","description":"The weight of the parcel.","example":0.1},"weightUnit":{"type":"string","description":"The unit of the parcel weight.","example":"OZ"},"length":{"type":"number","description":"The length of the parcel.","example":1},"height":{"type":"number","description":"The height of the parcel.","example":1},"width":{"type":"number","description":"The width of the parcel.","example":0.1},"dimUnit":{"type":"string","description":"The dimensional unit of the parcel.","example":"IN"}}},"toAddress":{"type":"object","properties":{"name":{"type":"string","description":"Name of the person or entity.","example":"test_user"},"addressLine1":{"type":"string","description":"First line of the address.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"City or town of the address.","example":"Shelton"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State or province of the address. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US address(es)."},"children":[]}]}]}],"example":"CT"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code or ZIP Code of the address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For US addresses, use only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code."},"children":[]}]}]}],"example":"06484-4361"},"countryCode":{"type":"string","description":"Country code of the address.","example":"US"},"phone":{"type":"string","description":"Phone number associated with the address.","example":"203-555-1213"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the receiver address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be recipient’s valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"shipmentOptions":{"type":"object","properties":{"printCustomMessage":{"type":"string","description":"A custom message printed on the coversheet. You can pass either print custom message or reference1 under shippingReference. If both are supplied, they will be concatenated.","example":"thankyou"},"addToManifest":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The option asks if the shipment is to be added for Manifest, so that the shipment will reflect in the Manifest Form while compilation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value can be 'true' or 'false'. Applicable for USPS and CPC carriers."},"children":[]}]}]}],"example":true}}},"metadata":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata that needs to be stored for this shipment can be added here."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported values are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/costaccount/cost-account-management/addcostaccount"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost Account Name, Cost Account Id, Cost Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/account-code/createaccountcode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/billingcodes/company-code/createcompanycode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Cost Account metadata is provided, all three Cost Account fields are required."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the metadata field.","example":"costAccountName"},"value":{"type":"string","description":"The value of the metadata field.","example":"cost account 123"}}},"example":[{"name":"costAccountName","value":"costAccountName"},{"name":"costAccountId","value":"costAccountId"},{"name":"costAccountCode","value":"Code"}]},"shippingReferences":{"type":"object","description":"Contains additional reference fields that can be passed with an ERR request (single piece or batch). While USPS only accepts a single reference, these fields are used for internal tracking, exports, and reporting.","properties":{"reference1":{"type":"string","example":"reference1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary reference field, printed on the coversheet under the label "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shipper Ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"printCustomMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are both supplied, they will be concatenated and printed on the coversheet under the label "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shipper Ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"reference2":{"type":"string","example":"reference2","description":"Secondary reference field."},"reference3":{"type":"string","example":"reference3","description":"Tertiary reference field."},"reference4":{"type":"string","example":"reference4","description":"Additional reference field."},"shipperReference":{"type":"string","example":"Shipper123","description":"Reference provided by the shipper."},"transportationReference":{"type":"string","example":"TransRef2025","description":"Reference related to transportation."},"shipperNotes":{"type":"string","example":"Handle with care","description":"Optional notes from the shipper."}}}}}},"components/schemas/ErrCoversheetResponse":{"id":"components/schemas/ErrCoversheetResponse","kind":"json-schema","title":"ErrCoversheetResponse","data":{"type":"object","properties":{"fromAddress":{"type":"object","properties":{"name":{"type":"string","description":"Name of the person or entity.","example":"Ankush Monga"},"addressLine1":{"type":"string","description":"First line of the address.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"City or town of the address.","example":"Shelton"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State or province of the address. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US address(es)."},"children":[]}]}]}],"example":"CT"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code or ZIP Code of the address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For US addresses, use only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code."},"children":[]}]}]}],"example":"06484-4361"},"countryCode":{"type":"string","description":"Country code of the address.","example":"US"},"phone":{"type":"string","description":"Phone number associated with the address.","example":"203-555-1213"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the sender address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.","example":"06905"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value is 'true', else it is 'false'."}}},"toAddress":{"type":"object","properties":{"name":{"type":"string","description":"Name of the person or entity.","example":"test_user"},"addressLine1":{"type":"string","description":"First line of the address.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"City or town of the address.","example":"Shelton"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State or province of the address. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US address(es)."},"children":[]}]}]}],"example":"CT"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code or ZIP Code of the address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For US addresses, use only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code."},"children":[]}]}]}],"example":"06484-4361"},"countryCode":{"type":"string","description":"Country code of the address.","example":"US"},"phone":{"type":"string","description":"Phone number associated with the address.","example":"203-555-1213"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the receiver address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be recipient’s valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value is 'true', else it is 'false'."}}},"labelLayout":{"type":"array","items":{"type":"object","properties":{"fileFormat":{"type":"string","description":"The file format of the coversheet.","example":"PDF"},"size":{"type":"string","description":"The size of the coversheet.","example":"6X9.5"},"type":{"type":"string","description":"The type of the coversheet.","example":"COVERSHEET"},"contentType":{"type":"string","description":"Specifies how the label content is encoded.","example":"URL"},"contents":{"type":"string","description":"The content of the label is URL.","example":"https://225934331380-spa-bpod-files-dev.s3-fips.us-east-1.amazonaws.com/trk-barcode/898643/9414809898643517920904.pdf?..................................."}}},"example":[{"contentType":"URL","contents":"https://225934331380-spa-bpod-files-prd.s3.us-east-1.amazonaws.com/trk-barcode/898643/9414809898643519783477.pdf?..................","fileFormat":"PDF","size":"9.5X12","type":"COVERSHEET"},{"contentType":"URL","contents":"https://prv-labels-cls.gcs.pitneybowes.com/usps/456312111/outbound/stamp/2f221f00b108436586b9263c62edd9f7.gif","fileFormat":"GIF","type":"STAMP"},{"contentType":"BASE64","contents":"R0lGODlhIAOkAfAAAAAAAP///ywAAAAAIAOkAUAC/4yPqcvtD6OctNqLs968+w+G4kiW5omm6sq27gvH8kzX9o3n+s73/g8MCofEovGITCqXzKbzCY1Kp9Sq9YrNarfcrvcLDovH5LL5jE6r1+y2mwKIy+OIOWOOl7/3/L7/......................................../8hwIAADs=","fileFormat":"GIF","type":"BARCODE"}]},"parcel":{"type":"object","properties":{"weight":{"type":"number","description":"The weight of the parcel.","example":0.1},"weightUnit":{"type":"string","description":"The unit of the parcel weight.","example":"OZ"},"length":{"type":"number","description":"The length of the parcel.","example":1},"height":{"type":"number","description":"The height of the parcel.","example":1},"width":{"type":"number","description":"The width of the parcel.","example":0.1},"dimUnit":{"type":"string","description":"The dimensional unit of the parcel.","example":"IN"}}},"shipmentOptions":{"type":"object","properties":{"addToManifest":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The option asks if the shipment is to be added for Manifest, so that the shipment will reflect in the Manifest Form while compilation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The value can be 'true' or 'false'. Applicable for USPS and CPC carriers."},"children":[]}]}]}],"example":true},"printCustomMessage":{"type":"string","description":"A custom message printed on the coversheet.","example":"thankyou"}}},"shipmentId":{"type":"string","description":"A unique identifier for a Shipment.","example":"670d1820222f6a010ab3152c"},"parcelTrackingNumber":{"type":"string","description":"The tracking number associated with the parcel in a shipment.","example":"9414809898643517885166"},"rate":{"type":"object","properties":{"totalCarrierCharge":{"type":"number","description":"The total amount payable to the carrier.","example":8.97}}},"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"65cc49aa8aeb46c1a77b1fc82a5ecba4"}}}},"schema_345":{"kind":"json-schema","data":{"type":"string"},"id":"schema_345"},"schema_346":{"kind":"json-schema","data":{"type":"object","properties":{"X-PB-TransactionId":{"type":"string","description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system."}}},"id":"schema_346"},"schema_347":{"kind":"json-schema","data":{"type":"object","properties":{"X-PB-TransactionId":{"type":"string","example":"GmeMZJ9YDK5z87b","description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system."}}},"id":"schema_347"},"schema_348":{"kind":"json-schema","data":{"type":"object","properties":{"X-PB-TransactionId":{"type":"string","example":"XbxjOb5BR7lwMAe","description":"A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system."}}},"id":"schema_348"},"schema_349":{"kind":"json-schema","data":{"type":"object","properties":{"carrierAccounts":{"type":"array","items":{"type":"object","properties":{"carrierAccountId":{"type":"string","description":"A unique identifier assigned to the specific carrier account.","example":"abcd12"},"carrierName":{"type":"string","description":"Name of the carrier.","example":"FedEx"}}}}}},"id":"schema_349"},"schema_350":{"kind":"json-schema","data":{"type":"string","example":"2026-06-01"},"id":"schema_350"},"schema_351":{"kind":"json-schema","data":{"type":"string","example":"2026-06-10"},"id":"schema_351"},"schema_352":{"kind":"json-schema","data":{"type":"string","example":"UPS"},"id":"schema_352"},"schema_353":{"kind":"json-schema","data":{"type":"boolean","example":true},"id":"schema_353"},"schema_354":{"kind":"json-schema","data":{"type":"boolean","example":false},"id":"schema_354"},"schema_355":{"kind":"json-schema","data":{"type":"string","example":"apv"},"id":"schema_355"},"schema_356":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/GetAllShipments"},{"$ref":"#/components/schemas/GetAllShipmentsLTL"}]},"id":"schema_356"},"schema_357":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_357"},"schema_358":{"kind":"json-schema","data":{"type":"string","default":true},"id":"schema_358"},"schema_359":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ShipmentDomesticByCarrier"},{"$ref":"#/components/schemas/shipmentDomesticByRateGroup"},{"$ref":"#/components/schemas/shipmentDomesticByRuleset"},{"$ref":"#/components/schemas/shipmentDomesticByShipViaCode"},{"$ref":"#/components/schemas/shipmentDomesticByExternalSystemCode"},{"$ref":"#/components/schemas/shipmentInternationalByCarrier"},{"$ref":"#/components/schemas/MilitaryMailShipmentsRequestV2"}]},"id":"schema_359"},"schema_360":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/domesticShipmentResponseV2"},{"$ref":"#/components/schemas/internationalShipmentResponseV2"},{"$ref":"#/components/schemas/MilitaryMailShipmentResponseV2"}]},"id":"schema_360"},"schema_361":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/RateShopbyCarrier"},{"$ref":"#/components/schemas/RateShopbyRategroup"},{"$ref":"#/components/schemas/RateShopbyRuleset"},{"$ref":"#/components/schemas/RateShopbyShipViaCode"},{"$ref":"#/components/schemas/RateShopbyExternalSystemCode"}]},"id":"schema_361"},"schema_362":{"kind":"json-schema","data":{"type":"object","properties":{"parcel":{"type":"object","description":"Details of the parcel being rated.","properties":{"length":{"type":"number","example":2},"height":{"type":"number","example":1},"width":{"type":"number","example":1},"dimUnit":{"type":"string","example":"IN"},"weightUnit":{"type":"string","example":"OZ"},"weight":{"type":"number","example":2},"packageValue":{"type":"number","example":2}}},"rate":{"type":"array","items":{"type":"object","description":"Carrier-provided rate details for the shipment.","properties":{"baseCharge":{"type":"number","description":"The base service charge payable to the carrier, excluding special service charges.","example":8.55},"baseChargeTaxes":{"type":"array","description":"List of taxes applied to the base charge. Returned in case of Canada carriers, such as: purolator, Canpar and Fedex.","items":{"type":"object","properties":{"displayName":{"type":"string","description":"Name of the tax applied.","example":"Canada goods and services"},"name":{"type":"string","description":"Short code or identifier of the tax.","example":"GST"},"taxAmount":{"type":"number","format":"float","description":"Amount charged for this tax.","example":2.69}}}},"carrier":{"type":"string","description":"Carrier responsible for transporting the shipment.","example":"usps"},"parcelType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ParcelType have categories like Package, Envelopes, Paks, Boxes, Tube, etc."},"children":[]}]}]}],"example":"PKG"},"rateTypeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of rate associated with the quote, such as CONTRACT_RATES or RETAIL_RATES."},"children":[]}]}]}],"example":"CONTRACT_RATES"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"PM"},"surcharges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fees or surcharges applied to the shipment. Each object in the array represents a specific surcharge and its associated fee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be one of the supported surcharge types from the respective carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Surcharge Names by Carrier:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge Names"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FUEL, GO_GREEN_BASIC, OVERSIZE, PREMIUM, RURAL, TOLL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANCILLARY_FEE, CANADIAN_DESTINATION, DELIVERY_AREA, DELIVERY_CONFIRMATION, FUEL, NON_MACHINABLE, OTHER, OUT_OF_DELIVERY_AREA, OUT_OF_PICKUP_AREA, OVERSIZE, RESIDENTIAL_DELIVERY, RESIDENTIAL_PICKUP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERY_AREA, EXTENDED_AREA, FUEL, LARGE_PACKAGE, RESIDENTIAL, SHIPPER_PAYS_DUTY_TAX"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nonmachinable, oversize"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"fee":{"type":"number","description":"The amount of the surcharge.","example":5.85},"name":{"type":"string","description":"The type of surcharge.","example":"RESIDENTIAL"}}},"example":[{"fee":5.85,"name":"RESIDENTIAL"},{"fee":4.66,"name":"FUEL"}]},"totalCarrierCharge":{"type":"number","description":"Total amount payable to the carrier, including base and special service fees.","example":12.7},"deliveryCommitment":{"type":"object","description":"Estimated delivery details, including any guarantee or commitment.","properties":{"additionalDetails":{"type":"string","description":"Additional information about the delivery timing.","example":"Thu, Nov 14 by 6:00 PM"},"estimatedDeliveryDateTime":{"type":"string","description":"Date and time of the estimated delivery.","example":"2024-11-14 18:00:00.000"},"guarantee":{"type":"string","description":"Type of delivery guarantee provided by the carrier.","example":"FULL"},"maxEstimatedNumberOfDays":{"type":"string","description":"Maximum number of days estimated for delivery.","example":"2"},"minEstimatedNumberOfDays":{"type":"string","description":"Minimum number of days estimated for delivery.","example":"2"}}},"totalTaxAmount":{"type":"number","format":"float","description":"Total tax amount applied to the shipment. Returned in case of canada carriers.","example":2.69},"destinationZone":{"type":"string","description":"This is the postal or delivery zone assigned to the shipment's destination by the carrier. This field is returned for USPS as of now.","example":"8"},"publishedTotalCarrierCharge":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount based on the carrier's standard (published) rates, including base charges, surcharges, special services, discounts, and applicable taxes. This value reflects the amount the carrier would charge without any negotiated discounts or platform-specific rate adjustments."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only when supported by the carrier (e.g., FedEx, UPS, DHL, USPS).\""},"children":[]}]}]}]}],"example":73.12}}},"example":[{"baseCharge":41.65,"carrier":"usps","carrierAccount":"vpjoz235J1Wp","deliveryCommitment":{"additionalDetails":"Tue, Aug 19 by 6:00 PM","estimatedDeliveryDateTime":"2025-08-19 18:00:00.000","guarantee":"FULL","maxEstimatedNumberOfDays":"1","minEstimatedNumberOfDays":"1"},"parcelType":"PKG","rateTypeId":"CONTRACT_RATES","serviceId":"EM","totalCarrierCharge":41.65,"destinationZone":"8","isHazmat":true},{"baseCharge":47.8,"carrier":"usps","carrierAccount":"vpjoz235J1Wp","deliveryCommitment":{"additionalDetails":"Tue, Aug 19 by 6:00 PM","estimatedDeliveryDateTime":"2025-08-19 18:00:00.000","guarantee":"FULL","maxEstimatedNumberOfDays":"1","minEstimatedNumberOfDays":"1"},"parcelType":"PKG","rateTypeId":"RETAIL","serviceId":"EM","totalCarrierCharge":47.8,"destinationZone":"8","isHazmat":true}]},"fromAddress":{"$ref":"#/components/schemas/fromAddressV2Response"},"toAddress":{"$ref":"#/components/schemas/toAddressV2Response"},"shipmentOptions":{"type":"object","description":"Optional shipment preferences.","example":{}},"references":{"type":"object","description":"Any additional references related to the rate shop request.","example":{}}}},"id":"schema_362"},"schema_363":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/getSingleShipment"},{"$ref":"#/components/schemas/getSingleShipmentLTL"}]},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2026-03-12"},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"type":"object","required":["format","carrierAccountId","documentType","contentType","shipmentDocuments"],"properties":{"carrierAccountId":{"type":"string","description":"A unique identifier for the carrier account to which the document will be uploaded.\n","example":"vO396rorMdxZ8k1"},"shipmentDocuments":{"type":"array","description":"List of electronic trade documents to be uploaded for the shipment.\n","minItems":1,"items":{"type":"object","required":["format","fileName","contentType","documentType"],"properties":{"fileName":{"type":"string","description":"The name of the file to be uploaded."},"format":{"type":"string","enum":["PDF"],"description":"The format of the file to be uploaded."},"documentType":{"type":"string","enum":["INVOICE","COMMERCIAL_INVOICE","PROFORMA_INVOICE","CERTIFICATE_OF_ORIGIN","NAFTA_CERTIFICATE_OF_ORIGIN","CUSTOMS_DECLARATION_FORM","AIR_WAYBILL_AND_WAYBILL"],"description":"Type of the electronic trade document to be uploaded ."},"contentType":{"type":"string","description":"Content type of the file to be uploaded.\n","example":"DOCUMENT_REFERENCE"}}}}}},"id":"schema_365"},"schema_366":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"fileName":{"type":"string","description":"The original name of the electronic document to be uploaded.","example":"invoice.pdf"},"s3FileId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The internal relative file path in the S3 bucket. This ID is used when referencing the document in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customsDocuments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object during "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipping/shipment/createshipmentv2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shipment creation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"uploads/shipping/intl_docs/.../invoice.pdf"},"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A pre-signed Amazon S3 URL used to upload the actual binary file via an HTTP PUT request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This URL is securely generated by the server. It allows direct upload to the S3 bucket "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without requiring AWS credentials or additional authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To complete the document upload process:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copy the URL and create a new request to this URL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perform an HTTP PUT request to this URL."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the request body to the binary content and select the same file whose  metadata was previously submitted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once the upload is complete, the document is stored in the specified S3 location and can be referenced later using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"s3FileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"format":"url","example":"https://s3-url-with-signature"}}}},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/schedulePickupDHLEXPRequest"},{"$ref":"#/components/schemas/schedulePickupUSPSRequest"},{"$ref":"#/components/schemas/schedulePickupUPSRequest"},{"$ref":"#/components/schemas/schedulePickupFedexRequest"},{"$ref":"#/components/schemas/schedulePickupPurolatorRequest"},{"$ref":"#/components/schemas/schedulePickupCPCRequest"},{"$ref":"#/components/schemas/schedulePickupFreightCarriersRequest"}]},"id":"schema_367"},"schema_368":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/schedulePickupDHLEXPResponse"},{"$ref":"#/components/schemas/schedulePickupUSPSResponse"},{"$ref":"#/components/schemas/schedulePickupUPSResponse"},{"$ref":"#/components/schemas/schedulePickupPurolatorResponse"},{"$ref":"#/components/schemas/schedulePickupCPCResponse"},{"$ref":"#/components/schemas/schedulePickupFedexResponse"}]},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-z]{2}-[A-Z]{2}$","example":"en-US"},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/MultipieceShipmentRequest"},{"$ref":"#/components/schemas/MultipieceShipmentInternationalRequest"}]},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/MultipieceShipmentResponse"},{"$ref":"#/components/schemas/MultipieceShipmentInternationalResponse"},{"$ref":"#/components/schemas/MultipieceShipmentSplitParcelLabelResponse"}]},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/MultipieceRateShopRequest"},{"$ref":"#/components/schemas/MultipieceRatesRequest"}]},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/MultipieceRateShopResponse"},{"$ref":"#/components/schemas/MultipieceRatesResponse"}]},"id":"schema_374"}},"exampleStore":{"paths/~1api~1v1~1carrier-facility/post/responses/200/content/application~1json/example":{"value":{"address":{"addressLine1":"24182 Kathy Ave","cityTown":"Lake Forest","company":"Pitney Bowes Inc.","countryCode":"US","email":"Kathryn@email.com","phone":"6502530000","postalCode":"92630","residential":false,"stateProvince":"CA"},"carrier":"USPS","carrierFacilityOptions":[{"name":"FACILITY_TYPE","value":"POST_OFFICE"},{"name":"FACILITY_TYPE_SERVICE","value":"LABEL_BROKER_RETAIL"},{"name":"FACILITY_WITHIN_RADIUS","value":"10"},{"name":"NUMBER_OF_FACILITIES","value":"1"}],"carrierFacilitySuggestions":[{"address":{"addressLine1":"24552 RAYMOND WAY","cityTown":"LAKE FOREST","postalCode":"92630","residential":false,"stateProvince":"CA"},"facilityHours":[{"day":"MONDAY","facilityTimings":[{"opensAt":"08:30:00","closesAt":"17:00:00"}]},{"day":"TUESDAY","facilityTimings":[{"opensAt":"08:30:00","closesAt":"17:00:00"}]},{"day":"WEDNESDAY","facilityTimings":[{"opensAt":"08:30:00","closesAt":"17:00:00"}]},{"day":"THURSDAY","facilityTimings":[{"opensAt":"08:30:00","closesAt":"17:00:00"}]},{"day":"FRIDAY","facilityTimings":[{"opensAt":"08:30:00","closesAt":"17:00:00"}]},{"day":"SATURDAY","facilityTimings":[{"opensAt":"10:00:00","closesAt":"15:00:00"}]}],"facilityParking":"LOT"}]},"id":"paths/~1api~1v1~1carrier-facility/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1countries/get/responses/200/content/application~1json/example":{"value":{"countries":[{"countryCode":"CA","countryName":"Canada"}]},"id":"paths/~1api~1v1~1countries/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1services/get/responses/200/content/application~1json/example":{"value":{"services":[{"serviceId":"EM","brandedName":"Priority Mail Express™"}]},"id":"paths/~1api~1v1~1services/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1parcelTypes/get/responses/200/content/application~1json/example":{"value":{"parcels":[{"brandedName":"Box 1092","carrier":"USPS","groupName":"Specialty Boxes and Envelopes","brandedDimensions":{"girth":0,"length":12.25,"width":2.875,"height":13.6875,"unitOfMeasurement":"IN"},"parcelId":"B1092","isBranded":true,"parcelType":"LP","serviceId":"PM","weightRules":[{"maxWeight":1120,"minWeight":0.01,"required":true,"unitOfMeasurement":"OZ"}]},{"brandedName":"My Box","dimensionRules":[{"maxLengthPlusGirth":130,"maxParcelDimensions":{"length":120,"width":38,"height":41,"unitOfMeasurement":"IN"},"minParcelDimensions":{"length":0.001,"width":0.001,"height":0.001,"unitOfMeasurement":"IN"},"required":true,"unitOfMeasurement":"IN"}],"groupName":"My Packaging","parcelId":"PKG","isBranded":false,"parcelType":"PKG","suggestedTrackableSpecialserviceId":"Sig","weightRules":[{"maxWeight":1120,"minWeight":0.01,"required":true,"unitOfMeasurement":"OZ"}]}]},"id":"paths/~1api~1v1~1parcelTypes/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1carrierAccounts/get/responses/200/content/application~1json/example":{"value":{"carrierAccounts":[{"carrierAccountId":"abcd12","carrierName":"FedEx"},{"carrierAccountId":"xyz12","carrierName":"UPS"},{"carrierAccountId":"12prqs","carrierName":"USPS"}]},"id":"paths/~1api~1v1~1carrierAccounts/get/responses/200/content/application~1json/example"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic"},"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}]},"options":{"hideDownloadButtons":false,"hideInfoMetadata":true,"jsonSamplesExpandLevel":3,"layout":"three-panel","schemasExpansionLevel":2,"theme":{"colors":{"primary":{"main":"#2F6BFF"},"http":{"get":"#0F766E","post":"#1D4ED8","put":"#7C3AED","delete":"#B91C1C"}},"rightPanel":{"backgroundColor":"#111111","textColor":"#E2E8F0"},"typography":{"fontFamily":"\"Source Sans Pro\", sans-serif","code":{"fontFamily":"\"Source Code Pro\", monospace"}},"sidebar":{"backgroundColor":"#f31111"}},"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Go"},{"lang":"Java"},{"lang":"C#"}]},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/shipping.json?download"},{"url":"/_bundle/openapi/shipping.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Overview","description":"The Shipping APIs provide a unified, multi-carrier platform to rate shipments, generate labels, manage pickups, and track parcel movement from creation through delivery. These APIs support a wide range of carriers and services, enabling developers to integrate shipping functionalities into their applications with ease. The Shipping APIs are designed to handle single-parcel, multi-parcel, and high-volume workflows. They also include features for managing carrier accounts, configuring defaults, and handling post-shipment operations like reprints, cancellations, and tracking updates. With comprehensive documentation, sample code, and a sandbox environment for testing. \n\nIf you are integrating for the first time, follow this path:\n\n1. Authenticate before calling Shipping APIs\n  - Start with the [Auth API](/openapi/auth/other/getaccesstoken) to generate an OAuth access token.\n  - Send the token in the Authorization header for every request: `Authorization: Bearer <access_token>`.\n\n2. Start with account and carrier setup\n  - Use Get Carrier Accounts to identify available carrierAccountId values.\n  - Use Get Carriers, Get Services, Get Parcel Types, and Get Special Services to discover what is valid for your scenario.\n\n3. Validate shipment inputs before creating labels\n  - Confirm address quality with the Address APIs.\n  - For international shipments, prepare customs data and upload Electronic Trade Documents when required.\n\n4. Rate first, then ship\n  - Use Rate Shipment to compare options by carrier, rate group, rule set, Ship Via Code, or external system code.\n  - Use Create Shipment to generate the label once the preferred option is selected.\n\n5. Manage post-shipment operations\n  - Reprint or cancel labels when needed.\n  - Retrieve shipment details and tracking updates.\n  - Schedule pickups, check pickup availability, and generate pickup documents.\n\n6. Use Batch Shipments for high-volume processing\n  - Use Batch Shipment APIs when creating large shipment volumes.\n  - Choose synchronous bulk creation or asynchronous CSV import, then process and monitor using batchId.\n  - Use batch status, shipment-level details, and batch void operations to manage exceptions at scale.\n\n7. Optimize for production scale\n  - Use Defaults to reduce repeated request fields.\n  - Use Multipiece Shipment for multi-parcel workflows.\n  - Use metadata, references, manifests, and reports for operational control and reconciliation.\n"}},"baseSlug":"/openapi/shipping","routesMapping":{}}