{"items":[{"type":"link","label":"Overview","link":"/openapi/crossborderdeliveryservices","routeSlug":"/openapi/crossborderdeliveryservices","content":{"contentType":"overview","meta":{"name":"Overview"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"crossborderdeliveryservices.json","url":"/_bundle/openapi/crossborderdeliveryservices.json?download"},{"kind":"download","label":"crossborderdeliveryservices.yaml","url":"/_bundle/openapi/crossborderdeliveryservices.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)"}],"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 Cross-Border Delivery Services (CBDS) APIs provide capabilities to support international shipping compliance and cost calculation. These APIs help determine product classification, identify country-specific shipping restrictions, calculate landed costs  (duties and taxes), and screen buyers or sellers against denied or sanctioned party lists."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The APIs are grouped into the following categories:"},"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":"HS Classification:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retrieve HS codes for items for a single country or across multiple countries."},"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":"Restrictions:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Identify import and export restrictions for items based on destination or origin countries."},"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":"Landed Cost Quote:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Calculate applicable duties and taxes for international 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":"Denied Party Screening:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Screen buyers or sellers against embargoed or sanctioned parties at the country level."},"children":[]}]}]}]}]}],"sectionId":"/openapi/crossborderdeliveryservices"}],"sectionId":"/openapi/crossborderdeliveryservices"}]}]}},{"type":"group","label":"HSClassification","link":"/openapi/crossborderdeliveryservices/hsclassification","routeSlug":"/openapi/crossborderdeliveryservices/hsclassification","items":[{"label":"Get HS Code for Single Country","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/hsclassification/retrievehscode","routeSlug":"/openapi/crossborderdeliveryservices/hsclassification/retrievehscode","metadata":{"seo":{"title":"Get HS Code for Single Country","description":"Returns the full-length HS/HTS tariff code for a single item to a given destination country.Pre-classify products or obtain tariff codes when needed for crossborder transactions from AI models, facilitating customs formalities and the accurate calculation of import charges."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveHSCode","name":"Get HS Code for Single Country","isWebhook":false,"pointer":"/paths/~1api~1v1~1crossborder-services~1hsclassification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get HS Code for Single Country","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the full-length HS/HTS tariff code for a single item to a given destination country.Pre-classify products or obtain tariff codes when needed for crossborder transactions from AI models, facilitating customs formalities and the accurate calculation of import charges."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-TransactionId","in":"header","schemaId":"schema_249","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.Allowed characters limit is 36."},{"name":"Content-Type","in":"header","schemaId":"schema_250","description":"The media type of the request body.\n","required":true}],"pointer":"/paths/~1api~1v1~1crossborder-services~1hsclassification/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HSCodesSingleCountryRequest"}},"schemaId":"components/schemas/HSCodesSingleCountryRequest","pointer":"/paths/~1api~1v1~1crossborder-services~1hsclassification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/crossborder-services/hsclassification","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)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_249"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_250"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/HSCodesSingleCountryRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/crossborder-services/hsclassification","href":"hsclassification/retrievehscode","openApiOperationId":"retrieveHSCode","summary":"Get HS Code for Single Country"},"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)"}],"schemaId":"components/schemas/HSCodesSingleCountryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HSCodesSingleCountryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The requested HS Code has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HSCodesSingleCountryResponse"}},"schemaId":"components/schemas/HSCodesSingleCountryResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"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~1crossborder-services~1hsclassification/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/HSCodesSingleCountryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HSCodesSingleCountryResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hsclassification/retrievehscode"}],"panels":[]}]},"httpPath":"/api/v1/crossborder-services/hsclassification"},{"label":"Get HS Codes Across Countries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/hsclassification/retrievehscodebulk","routeSlug":"/openapi/crossborderdeliveryservices/hsclassification/retrievehscodebulk","metadata":{"seo":{"title":"Get HS Codes Across Countries","description":"Returns full-length HS/HTS tariff codes for a single item across multiple destination countries in a single request. This bulk API is useful for global classification needs, allowing businesses to prepare items for international shipping and customs compliance across regions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveHSCodeBulk","name":"Get HS Codes Across Countries","isWebhook":false,"pointer":"/paths/~1api~1v1~1crossborder-services~1hsclassification~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get HS Codes Across Countries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns full-length HS/HTS tariff codes for a single item across multiple destination countries in a single request. This bulk API is useful for global classification needs, allowing businesses to prepare items for international shipping and customs compliance across regions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-TransactionId","in":"header","schemaId":"schema_249","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.\nAllowed characters limit is 36.\n"},{"name":"Content-Type","in":"header","schemaId":"schema_250","description":"The media type of the request body.\n","required":true}],"pointer":"/paths/~1api~1v1~1crossborder-services~1hsclassification~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HSCodesMultiCountryRequest"}},"schemaId":"components/schemas/HSCodesMultiCountryRequest","pointer":"/paths/~1api~1v1~1crossborder-services~1hsclassification~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/crossborder-services/hsclassification/bulk","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)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_249"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_250"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/HSCodesMultiCountryRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/crossborder-services/hsclassification/bulk","href":"hsclassification/retrievehscodebulk","openApiOperationId":"retrieveHSCodeBulk","summary":"Get HS Codes Across 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)"}],"schemaId":"components/schemas/HSCodesMultiCountryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HSCodesMultiCountryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The requested HS Code has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HSCodesMultiCountryResponse"}},"schemaId":"components/schemas/HSCodesMultiCountryResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"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~1crossborder-services~1hsclassification~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/HSCodesMultiCountryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HSCodesMultiCountryResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hsclassification/retrievehscodebulk"}],"panels":[]}]},"httpPath":"/api/v1/crossborder-services/hsclassification/bulk"}],"content":{"contentType":"group","meta":{"name":"HSClassification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"HSClassification","showPageActions":true},{"nodeType":"markdoc","content":"APIs provide HS/HTS tariff code for a single item (to be shipped) to a given destination country or across multiple destination countries."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/crossborder-services/hsclassification","summary":"Get HS Code for Single Country","prefix":{"name":"post","color":"post"},"badges":[],"link":"/hsclassification/retrievehscode","deprecated":false},{"title":"/api/v1/crossborder-services/hsclassification/bulk","summary":"Get HS Codes Across Countries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/hsclassification/retrievehscodebulk","deprecated":false}]}]}]}]}},{"type":"group","label":"Restriction","link":"/openapi/crossborderdeliveryservices/restriction","routeSlug":"/openapi/crossborderdeliveryservices/restriction","items":[{"label":"Get Shipping Restrictions for Single Country","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/restriction/returnshipmentrestrictions","routeSlug":"/openapi/crossborderdeliveryservices/restriction/returnshipmentrestrictions","metadata":{"seo":{"title":"Get Shipping Restrictions for Single Country","description":"This API helps determine if the item has regulatory, legal, or carrier-based restrictions for a single destination country.  Use this API to determine which countries are available for listing, and/or perform screenings to determine shipping compliance for crossborder transactions. Responses include restrictions and prohibitions for CITES, Health, Limited Quantity, Hazmat & Dangerous Goods, ITAR and Medical related regulations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"returnShipmentRestrictions","name":"Get Shipping Restrictions for Single Country","isWebhook":false,"pointer":"/paths/~1api~1v1~1crossborder-services~1restriction/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Shipping Restrictions for Single Country","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 helps determine if the item has regulatory, legal, or carrier-based restrictions for a single destination country. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use this API to determine which countries are available for listing, and/or perform screenings to determine shipping compliance for crossborder transactions. Responses include restrictions and prohibitions for CITES, Health, Limited Quantity, Hazmat & Dangerous Goods, ITAR and Medical related regulations."},"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-TransactionId","in":"header","schemaId":"schema_249","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.Allowed characters limit is 36."},{"name":"Content-Type","in":"header","schemaId":"schema_250","description":"The media type of the request body.\n","required":true}],"pointer":"/paths/~1api~1v1~1crossborder-services~1restriction/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SingleCountrySingleItemRestrictionsRequest"}},"schemaId":"components/schemas/SingleCountrySingleItemRestrictionsRequest","pointer":"/paths/~1api~1v1~1crossborder-services~1restriction/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/crossborder-services/restriction","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)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_249"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_250"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SingleCountrySingleItemRestrictionsRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/crossborder-services/restriction","href":"restriction/returnshipmentrestrictions","openApiOperationId":"returnShipmentRestrictions","summary":"Get Shipping Restrictions for Single Country"},"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)"}],"schemaId":"components/schemas/SingleCountrySingleItemRestrictionsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SingleCountrySingleItemRestrictionsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The requested restrictions has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingleCountrySingleItemRestrictionsResponse"}},"schemaId":"components/schemas/SingleCountrySingleItemRestrictionsResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"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~1crossborder-services~1restriction/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SingleCountrySingleItemRestrictionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SingleCountrySingleItemRestrictionsResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/restriction/returnshipmentrestrictions"}],"panels":[]}]},"httpPath":"/api/v1/crossborder-services/restriction"},{"label":"Get Shipping Restrictions Across Countries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/restriction/returnshipmentbulkrestrictions","routeSlug":"/openapi/crossborderdeliveryservices/restriction/returnshipmentbulkrestrictions","metadata":{"seo":{"title":"Get Shipping Restrictions Across Countries","description":"This API helps determine if the item has regulatory, legal, or carrier-based restrictions for multiple destination countries.  Use this API to determine which countries are available for listing, and/or perform screenings to determine shipping compliance for crossborder transactions. Responses include restrictions and prohibitions for CITES, Health, Limited Quantity, Hazmat & Dangerous Goods, ITAR and Medical related regulations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"returnShipmentBulkRestrictions","name":"Get Shipping Restrictions Across Countries","isWebhook":false,"pointer":"/paths/~1api~1v1~1crossborder-services~1restriction~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Shipping Restrictions Across 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":"This API helps determine if the item has regulatory, legal, or carrier-based restrictions for multiple destination countries. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use this API to determine which countries are available for listing, and/or perform screenings to determine shipping compliance for crossborder transactions. Responses include restrictions and prohibitions for CITES, Health, Limited Quantity, Hazmat & Dangerous Goods, ITAR and Medical related regulations."},"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-TransactionId","in":"header","schemaId":"schema_249","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.Allowed characters limit is 36."},{"name":"Content-Type","in":"header","schemaId":"schema_250","description":"The media type of the request body.\n","required":true}],"pointer":"/paths/~1api~1v1~1crossborder-services~1restriction~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MultipleCountriesSingleItemRestrictionsRequest"}},"schemaId":"components/schemas/MultipleCountriesSingleItemRestrictionsRequest","pointer":"/paths/~1api~1v1~1crossborder-services~1restriction~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/crossborder-services/restriction/bulk","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)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_249"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_250"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MultipleCountriesSingleItemRestrictionsRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/crossborder-services/restriction/bulk","href":"restriction/returnshipmentbulkrestrictions","openApiOperationId":"returnShipmentBulkRestrictions","summary":"Get Shipping Restrictions Across 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)"}],"schemaId":"components/schemas/MultipleCountriesSingleItemRestrictionsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MultipleCountriesSingleItemRestrictionsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The requested restriction has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MultipleCountriesSingleItemRestrictionsResponse"}},"schemaId":"components/schemas/MultipleCountriesSingleItemRestrictionsResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"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~1crossborder-services~1restriction~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MultipleCountriesSingleItemRestrictionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MultipleCountriesSingleItemRestrictionsResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/restriction/returnshipmentbulkrestrictions"}],"panels":[]}]},"httpPath":"/api/v1/crossborder-services/restriction/bulk"}],"content":{"contentType":"group","meta":{"name":"Restriction"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restriction","showPageActions":true},{"nodeType":"markdoc","content":"APIs determine if the item (to be shipped) has regulatory, legal, or carrier-based restrictions for a single destination country or across multiple destination countries."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/crossborder-services/restriction","summary":"Get Shipping Restrictions for Single Country","prefix":{"name":"post","color":"post"},"badges":[],"link":"/restriction/returnshipmentrestrictions","deprecated":false},{"title":"/api/v1/crossborder-services/restriction/bulk","summary":"Get Shipping Restrictions Across Countries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/restriction/returnshipmentbulkrestrictions","deprecated":false}]}]}]}]}},{"type":"group","label":"Landed Cost Quote","link":"/openapi/crossborderdeliveryservices/landed-cost-quote","routeSlug":"/openapi/crossborderdeliveryservices/landed-cost-quote","items":[{"label":"Calculate Duties and Taxes for Single Country","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/landed-cost-quote/calculatedutiesandtaxes","routeSlug":"/openapi/crossborderdeliveryservices/landed-cost-quote/calculatedutiesandtaxes","metadata":{"seo":{"title":"Calculate Duties and Taxes for Single Country","description":"This API calculates estimated duties and taxes for a basket of items being shipped to a single country.A landed cost is the total of all charges involved in a crossborder transaction, including transportation, import duties and taxes, shipping insurance, and related fees. Use this API to power a superior “duty-paid” checkout experience with accurate D&T estimates, and/or to inform business planning around import costs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"calculateDutiesAndTaxes","name":"Calculate Duties and Taxes for Single Country","isWebhook":false,"pointer":"/paths/~1api~1v1~1crossborder-services~1landedCostQuote/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Calculate Duties and Taxes for Single Country","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 calculates estimated duties and taxes for a basket of items being shipped to a single country."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A landed cost is the total of all charges involved in a crossborder transaction, including transportation, import duties and taxes, shipping insurance, and related fees. Use this API to power a superior “duty-paid” checkout experience with accurate D&T estimates, and/or to inform business planning around import costs."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"calculationType","in":"query","schemaId":"schema_251","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of calculation to be performed. Possible values are:"},"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":"duty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only the duty will be returned"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only the tax will be returned"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duty_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Both duty and tax will be returned (default if not provided)"},"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":"Note: Duty and/or tax may still be calculated internally if required as part of determining the other, but the results will not be included in the response based on the calculation type."},"children":[]}]}]}]}],"example":"duty_tax"}],"pointer":"/paths/~1api~1v1~1crossborder-services~1landedCostQuote/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-TransactionId","in":"header","schemaId":"schema_249","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.Allowed characters limit is 36."},{"name":"Content-Type","in":"header","schemaId":"schema_250","description":"The media type of the request body.\n","required":true}],"pointer":"/paths/~1api~1v1~1crossborder-services~1landedCostQuote/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MultipleItemsSingleCountryDnTRequest"}},"schemaId":"components/schemas/MultipleItemsSingleCountryDnTRequest","pointer":"/paths/~1api~1v1~1crossborder-services~1landedCostQuote/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/crossborder-services/landedCostQuote","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)"}],"parameters":{"path":[],"query":[{"name":"calculationType","in":"query","required":false,"example":"duty_tax","schemaId":"schema_251"}],"querystring":[],"header":[{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_249"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_250"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MultipleItemsSingleCountryDnTRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/crossborder-services/landedCostQuote","href":"landed-cost-quote/calculatedutiesandtaxes","openApiOperationId":"calculateDutiesAndTaxes","summary":"Calculate Duties and Taxes for Single Country"},"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)"}],"schemaId":"components/schemas/MultipleItemsSingleCountryDnTRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MultipleItemsSingleCountryDnTRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The requested Landed Cost Quote has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MultipleItemsSingleCountryDnTResponse"}},"schemaId":"components/schemas/MultipleItemsSingleCountryDnTResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"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~1crossborder-services~1landedCostQuote/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MultipleItemsSingleCountryDnTResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MultipleItemsSingleCountryDnTResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/landed-cost-quote/calculatedutiesandtaxes"}],"panels":[]}]},"httpPath":"/api/v1/crossborder-services/landedCostQuote"},{"label":"Calculate Duties and Taxes for Single Item Across Countries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/landed-cost-quote/calculatebulkdutiesandtaxes","routeSlug":"/openapi/crossborderdeliveryservices/landed-cost-quote/calculatebulkdutiesandtaxes","metadata":{"seo":{"title":"Calculate Duties and Taxes for Single Item Across Countries","description":"This API calculates estimated duties and taxes duties for a single item across multiple destination countries.A landed cost is the total of all charges involved in a crossborder transaction, including transportation, import duties and taxes, shipping insurance, and related fees. Use this API to power a superior \"duty-paid\" checkout experience with accurate D&T estimates, and/or to inform business planning around import costs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"calculateBulkDutiesAndTaxes","name":"Calculate Duties and Taxes for Single Item Across Countries","isWebhook":false,"pointer":"/paths/~1api~1v1~1crossborder-services~1landedCostQuote~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Calculate Duties and Taxes for Single Item Across 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":"This API calculates estimated duties and taxes duties for a single item across multiple destination countries."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A landed cost is the total of all charges involved in a crossborder transaction, including transportation, import duties and taxes, shipping insurance, and related fees. Use this API to power a superior \"duty-paid\" checkout experience with accurate D&T estimates, and/or to inform business planning around import costs."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"calculationType","in":"query","schemaId":"schema_251","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of calculation to be performed. Possible values are:"},"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":"duty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only the duty will be returned"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only the tax will be returned"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duty_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Both duty and tax will be returned (default if not provided)"},"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":"Note: Duty and/or tax may still be calculated internally if required as part of determining the other, but the results will not be included in the response based on the calculation type."},"children":[]}]}]}]}],"example":"duty_tax"}],"pointer":"/paths/~1api~1v1~1crossborder-services~1landedCostQuote~1bulk/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-TransactionId","in":"header","schemaId":"schema_249","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.Allowed characters limit is 36."},{"name":"Content-Type","in":"header","schemaId":"schema_250","description":"The media type of the request body.\n","required":true}],"pointer":"/paths/~1api~1v1~1crossborder-services~1landedCostQuote~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MultipleCountriesSingleItemDnTRequest"}},"schemaId":"components/schemas/MultipleCountriesSingleItemDnTRequest","pointer":"/paths/~1api~1v1~1crossborder-services~1landedCostQuote~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/crossborder-services/landedCostQuote/bulk","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)"}],"parameters":{"path":[],"query":[{"name":"calculationType","in":"query","required":false,"example":"duty_tax","schemaId":"schema_251"}],"querystring":[],"header":[{"name":"X-PB-TransactionId","in":"header","required":false,"schemaId":"schema_249"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_250"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MultipleCountriesSingleItemDnTRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/crossborder-services/landedCostQuote/bulk","href":"landed-cost-quote/calculatebulkdutiesandtaxes","openApiOperationId":"calculateBulkDutiesAndTaxes","summary":"Calculate Duties and Taxes for Single Item Across 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)"}],"schemaId":"components/schemas/MultipleCountriesSingleItemDnTRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MultipleCountriesSingleItemDnTRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The requested Landed Cost Quote has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MultipleCountriesSingleItemDnTResponse"}},"schemaId":"components/schemas/MultipleCountriesSingleItemDnTResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"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~1crossborder-services~1landedCostQuote~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MultipleCountriesSingleItemDnTResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MultipleCountriesSingleItemDnTResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/landed-cost-quote/calculatebulkdutiesandtaxes"}],"panels":[]}]},"httpPath":"/api/v1/crossborder-services/landedCostQuote/bulk"}],"content":{"contentType":"group","meta":{"name":"Landed Cost Quote"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Landed Cost Quote","showPageActions":true},{"nodeType":"markdoc","content":"APIs calculate estimated duties and taxes for a basket of items (to be shipped) being shipped to a single country or for a single item (to be shipped) across multiple destination countries."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/crossborder-services/landedCostQuote","summary":"Calculate Duties and Taxes for Single Country","prefix":{"name":"post","color":"post"},"badges":[],"link":"/landed-cost-quote/calculatedutiesandtaxes","deprecated":false},{"title":"/api/v1/crossborder-services/landedCostQuote/bulk","summary":"Calculate Duties and Taxes for Single Item Across Countries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/landed-cost-quote/calculatebulkdutiesandtaxes","deprecated":false}]}]}]}]}},{"type":"group","label":"Denied Party Screening","link":"/openapi/crossborderdeliveryservices/denied-party-screening","routeSlug":"/openapi/crossborderdeliveryservices/denied-party-screening","items":[{"label":"Denied Party Screening","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/denied-party-screening/deniedpartyscreening","routeSlug":"/openapi/crossborderdeliveryservices/denied-party-screening/deniedpartyscreening","metadata":{"seo":{"title":"Denied Party Screening","description":"This API operation is used to submit shipper and/or consignee address information for denied party screening and receive a compliance status indicating whether the address is approved, potentially matched, or matched to a restricted entity. The API does not approve or reject shipments; instead, it provides actionable compliance insights that clients can use to determine next steps."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deniedPartyScreening","name":"Denied Party Screening","isWebhook":false,"pointer":"/paths/~1api~1v1~1denied-party-screening/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Denied Party Screening","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API operation is used to submit shipper and/or consignee address information for denied party screening and receive a compliance status indicating whether the address is approved, potentially matched, or matched to a restricted entity.\nThe API does not approve or reject shipments; instead, it provides actionable compliance insights that clients can use to determine next steps.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeniedPartyScreeningRequest"}},"schemaId":"components/schemas/DeniedPartyScreeningRequest","pointer":"/paths/~1api~1v1~1denied-party-screening/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/denied-party-screening","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)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeniedPartyScreeningRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/denied-party-screening","href":"denied-party-screening/deniedpartyscreening","openApiOperationId":"deniedPartyScreening","summary":"Denied Party Screening"},"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)"}],"schemaId":"components/schemas/DeniedPartyScreeningRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeniedPartyScreeningRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The requested screening report has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeniedPartyScreeningResponse"}},"schemaId":"components/schemas/DeniedPartyScreeningResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"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~1denied-party-screening/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeniedPartyScreeningResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeniedPartyScreeningResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/denied-party-screening/deniedpartyscreening"}],"panels":[]}]},"httpPath":"/api/v1/denied-party-screening"}],"content":{"contentType":"group","meta":{"name":"Denied Party Screening"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Denied Party Screening","showPageActions":true},{"nodeType":"markdoc","content":"API check compliance of the shipper and/or consignee addresses against government-issued watch lists to avoid doing business with prohibited individuals, entities, or organizations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/denied-party-screening","summary":"Denied Party Screening","prefix":{"name":"post","color":"post"},"badges":[],"link":"/denied-party-screening/deniedpartyscreening","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/HSCodesSingleCountryRequest":{"id":"components/schemas/HSCodesSingleCountryRequest","kind":"json-schema","title":"HSCodesSingleCountryRequest","data":{"type":"object","required":["item"],"properties":{"destinationCountryCode":{"type":"string","minLength":2,"maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country to which the shipment is intended. This must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., US or USA)."},"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 field is required only if retrieving a country-specific HS code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, a non-country-specific HS6 (international) code will be returned."},"children":[]}]}]}]}],"example":"CA"},"pricingCurrencyCode":{"type":"string","minLength":3,"maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency used for the item price. It must be a valid ISO 4217 currency code (e.g., USD, EUR)."},"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 field is required only if the item price is provided."},"children":[]}]}]}]}],"example":"USD"},"item":{"type":"object","required":["itemId","description"],"description":"Details of the item to be classified.","properties":{"itemId":{"type":"string","maxLength":50,"description":"Unique identifier for the item, such as a merchant-assigned SKU or product code.\n","example":"ITEM123456"},"name":{"type":"string","maxLength":50,"description":"Name of the item.\n","example":"Classic Blazer"},"description":{"type":"string","maxLength":255,"description":"A brief description of the item.\n","example":"Classic blazer, designed for those who value timeless style and versatile elegance..."},"categoryPath":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchical path to the item's category. Each category level is represented by its name and concatenated by a pipe (|) delimiter."},"children":[]}]}]}],"example":"Clothing & Accessories|Suit Jackets & Blazers|Blazer"},"hsTariffCode":{"type":"string","minLength":2,"maxLength":14,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A full HS code or partial prefix (2-14 digits), to guide AI classification."},"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":"Valid input of any length will constrain the AI to return only full-length tariff codes that begin with your input — providing more digits (or the full code, if known) makes the result increasingly precise and helps to improve accuracy in classification and duty calculation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, providing an input of \"62\" will ensure that the classification for an item with a description of \"cotton blazer\" is constrained to tariff codes within woven apparel, rather than knitted."},"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":"62 → General HS code for \"Apparel, not knitted or crocheted\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6203 → More specific code for men's or boys' suits, ensembles, jackets, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"620332 → Even more detailed code indicating \"men's and boys' jackets and blazers of cotton"},"children":[]}]}]}]}],"example":"6104"},"hsTariffCountryCode":{"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 code associated with the HS code provided in the request. It must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., \"US\", \"USA\")."},"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 field is required if the hsCode passed in the request is greater than 6 digits."},"children":[]}]}]}]}],"example":"CA"},"imageURL":{"type":"string","format":"url","maxLength":1000,"description":"URL to the item's image on the merchant's website.\n","example":"https://www.client.com/ITEM123456.png"},"productURL":{"type":"string","format":"url","maxLength":1000,"description":"URL to the item's product page on the merchant's website.\n","example":"https://www.client.com/ITEM123456"},"attributes":{"type":"array","required":["name","value"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of item attributes that describe additional item characteristics. A set of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/cbds/predefined-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"predefined attribute names and values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is available, but custom attributes can also be included."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","maxLength":50,"description":"The name of the attribute (e.g., gender, material, size). Required.\n","example":"gender"},"value":{"type":"string","maxLength":50,"description":"The value of the attribute (e.g., women, wool,large). Required.\n","example":"women"},"unitOfMeasurement":{"type":"string","maxLength":5,"description":"The unit of measure associated with the value, if applicable.\n","example":"cm"},"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 attribute."},"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":"Accepted values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Material"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"Material","enum":["Material","Form","Application"]}}}},"unitPrice":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of a single unit of the item. If 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":"The value must be greater than 0."},"children":[]}]}]}]}],"example":100},"weight":{"type":"object","required":["value","unitOfMeasurement"],"description":"The weight of a single item, including its unit of measure. Note that Unit codes are case-insensitive.\n","properties":{"value":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric weight of the item."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":3.25},"unitOfMeasurement":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit of measure for the weight."},"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":"Accepted values are: Lb, Oz, G, Kg."},"children":[]}]}]}]}],"example":"LB","enum":["Lb (pounds)","Oz (ounces)","G (grams)","Kg (kilograms)"]}}}}}},"example":{"destinationCountryCode":"CA","pricingCurrencyCode":"USD","item":{"itemId":"itemid-11","name":"Fisher Price Tricycle","description":"The Fisher-Price Grow-With-Me Girls' Tricycle is the perfect first ride for little adventurers aged 2–5.","categoryPath":"Toys & Games/Other Toys & Games","imageURL":"www.client.com/ITEM11.png","productURL":"www.client.com/ITEM11","attributes":[{"name":"gender","value":"girls"},{"name":"material","value":"steel"},{"name":"brand","value":"Fisher-Price"}],"unitPrice":100,"weight":{"value":3,"unitOfMeasurement":"LB"}}}}},"components/schemas/HSCodesSingleCountryResponse":{"id":"components/schemas/HSCodesSingleCountryResponse","kind":"json-schema","title":"HSCodesSingleCountryResponse","data":{"type":"object","properties":{"item":{"type":"object","properties":{"itemId":{"type":"string","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":"Unique identifier for the item, such as a merchant-assigned SKU or product code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"children":[]}]}]}]}],"example":"ITEM123456"},"hsClassification":{"type":"object","description":"HS classification details for the item.\n","properties":{"destinationCountryCode":{"type":"string","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":"ISO 3166-1 alpha-2 or alpha-3 country code representing the destination country."},"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":"destinationCountryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not provided in the request, this field will not returned in the response and a non-country-specific international HS code will be returned in the response."},"children":[]}]}]}]}],"example":"CA"},"hsTariffCode":{"type":"string","minLength":2,"maxLength":14,"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":"The Harmonized Tariff Code for the item as classified for the destination country."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hsTariffCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will include the predicted HS6 or full HS code for this country."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a valid full HS code was provided in the request, the same will be returned."},"children":[]}]}]}]}],"example":"6104310000"},"tariffDescription":{"type":"string","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":"Description of the classified tariff code as returned by the HS classification service."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tariffDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"children":[]}]}]}]}],"example":"Articles of apparel and clothing accessories, knitted or crocheted Women's or girls' suits, ensembles, jackets and blazers, dresses, skirts, divided skirts, trousers, bib and brace overalls, breeches and shorts (other than swimwear), knitted or crocheted. Jackets and blazers: Of wool or fine animal hair"},"confidenceLevel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confidence level of the HS classification result. Possible values: HIGH, MEDIUM, LOW or N/A."},"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 confidence level represents how certain the system is about the accuracy of the returned HS code for a given item."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confidenceLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you provide a full valid HS code in the request, the system doesn't predict anything, it shows N/A."},"children":[]}]}]}]}],"enum":["HIGH","MEDIUM","LOW","N/A"],"example":"HIGH"}}}}}},"example":{"item":{"itemId":"itemid-11","hsClassification":{"destinationCountryCode":"CA","hsTariffCode":"9503009099","tariffDescription":"Toys, games and sports requisites; parts and accessories thereof Tricycles, scooters, pedal cars and similar wheeled toys; dolls' carriages; dolls; other toys; reduced-size ('scale') models and similar recreational models, working or not; puzzles of all kinds. Other Other: Other","confidenceLevel":"HIGH"}}}}},"components/schemas/HSCodesMultiCountryRequest":{"id":"components/schemas/HSCodesMultiCountryRequest","kind":"json-schema","title":"HSCodesMultiCountryRequest","data":{"type":"object","required":["destinationCountryCodes","item"],"properties":{"destinationCountryCodes":{"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 destination country codes to classify the item for. Each must be a valid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 or alpha-3 code (e.g., \"CA\", \"USA\")."},"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":"Maximum 250 coutries can be passed in the list."},"children":[]}]}]}]}],"items":{"type":"string","example":"CA"},"example":["CA","CL"]},"pricingCurrencyCode":{"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 used for the item price. It must be a valid ISO 4217 currency code"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g., USD, EUR)."},"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 field is required only if the item price is provided in the request."},"children":[]}]}]}]}],"example":"USD"},"item":{"type":"object","required":["itemId","description"],"description":"Details of the item to be classified.","properties":{"itemId":{"type":"string","maxLength":50,"description":"Unique identifier for the item, such as a merchant-assigned SKU or product code.\n","example":"ITEM123456"},"name":{"type":"string","maxLength":50,"description":"Name of the item.\n","example":"Classic Blazer"},"description":{"type":"string","maxLength":255,"description":"A brief description of the item.\n","example":"Classic blazer, designed for those who value timeless style and versatile elegance..."},"categoryPath":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchical path to the item's category. Each category level is represented by its name and concatenated by a pipe (|) delimiter."},"children":[]}]}]}],"example":"Clothing & Accessories|Suit Jackets & Blazers|Blazer"},"hsTariffCode":{"type":"string","minLength":2,"maxLength":14,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A full HS code or partial prefix (2-14 digits), to guide AI classification."},"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":"Valid input of any length will constrain the AI to return only full-length tariff codes that begin with your input — providing more digits (or the full code, if known) makes the result increasingly precise and helps to improve accuracy in classification and duty calculation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, providing an input of \"62\" will ensure that the classification for an item with a description of \"cotton blazer\" is constrained to tariff codes within woven apparel, rather than knitted."},"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":"62 → General HS code for \"Apparel, not knitted or crocheted\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6203 → More specific code for men's or boys' suits, ensembles, jackets, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"620332 → Even more detailed code indicating \"men's and boys' jackets and blazers of cotton"},"children":[]}]}]}]}],"example":"6104"},"hsTariffCountryCode":{"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 code associated with the HS code provided in the request. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., \"US\", \"USA\")."},"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":"hsTariffCountryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required only when the provided HS code is longer than 6 digits."},"children":[]}]}]}]}],"example":"CA"},"imageURL":{"type":"string","format":"url","maxLength":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to the item's image on the merchant's website."},"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":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCEEDS_MAX_LENGTH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the URL is invalid."},"children":[]}]}]}]}],"example":"https://www.client.com/ITEM123456.png"},"productURL":{"type":"string","format":"url","maxLength":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to the item's product page on the merchant's website."},"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":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCEEDS_MAX_LENGTH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the URL is invalid."},"children":[]}]}]}]}],"example":"https://www.client.com/ITEM123456"},"attributes":{"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 item attributes that describe additional item characteristics. A set of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/cbds/predefined-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"predefined"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attribute names and values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is available, but custom attributes can also be included."},"children":[]}]}]}],"items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","maxLength":50,"description":"The name of the attribute (e.g., gender, material, size).\n","example":"gender"},"value":{"type":"string","maxLength":50,"description":"The value of the attribute (e.g., women, wool, large).\n","example":"women"},"unitOfMeasurement":{"type":"string","maxLength":5,"description":"Unit of measure associated with the value, if applicable.\n","example":"cm"},"type":{"type":"string","enum":["Material","Form","Application"],"description":"Type of attribute. Accepted values: Material, Form, Application.\n","example":"Material"}}}},"unitPrice":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of a single unit of the item."},"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":"Must be greater than 0 if provided."},"children":[]}]}]}]}],"example":100},"weight":{"type":"object","required":["value","unitOfMeasurement"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The weight of a single item, including its unit of measure."},"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":"Note that Unit codes are case-insensitive."},"children":[]}]}]}]}],"properties":{"value":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric weight of the item. Must be a valid decimal number."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":3.25},"unitOfMeasurement":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit of measure for the weight."},"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":"Accepted values are: Lb, Oz, G, Kg."},"children":[]}]}]}]}],"example":"LB","enum":["Lb (pounds)","Oz (ounces)","G (grams)","Kg (kilograms)"]}}}}}},"example":{"destinationCountryCodes":["CA","CL"],"pricingCurrencyCode":"USD","item":{"itemId":"itemid-11","name":"Fisher Price Tricycle","description":"The Fisher-Price Grow-With-Me Girls' Tricycle is the perfect first ride for little adventurers aged 2–5.","categoryPath":"Toys & Games/Other Toys & Games","imageURL":"www.client.com/ITEM11.png","productURL":"www.client.com/ITEM11","attributes":[{"name":"gender","value":"girls"},{"name":"material","value":"steel"},{"name":"brand","value":"Fisher-Price"}],"unitPrice":100,"weight":{"value":3,"unitOfMeasurement":"LB"}}}}},"components/schemas/HSCodesMultiCountryResponse":{"id":"components/schemas/HSCodesMultiCountryResponse","kind":"json-schema","title":"HSCodesMultiCountryResponse","data":{"type":"object","properties":{"item":{"type":"object","properties":{"itemId":{"type":"string","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":"Unique identifier for the item, such as a merchant-assigned SKU or product code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"children":[]}]}]}]}],"example":"ITEM123456"},"hsClassifications":{"type":"array","description":"HS classification details for the item across multiple countries.\n","items":{"type":"object","properties":{"destinationCountryCode":{"type":"string","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":"ISO 3166-1 alpha-2 or alpha-3 country code representing the destination country."},"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":"destinationCountryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not provided in the request, this field will not returned in the response and a non-country-specific international HS code will be returned in the response."},"children":[]}]}]}]}],"example":"CA"},"hsTariffCode":{"type":"string","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":"The Harmonized Tariff Code for the item as classified for the destination country."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hsTariffCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will include the predicted HS6 or full HS code for this country."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a valid full HS code was provided in the request, the same will be returned."},"children":[]}]}]}]}],"example":"6104310000"},"tariffDescription":{"type":"string","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":"Description of the classified tariff code as returned by the HS classification service."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tariffDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"children":[]}]}]}]}],"example":"Articles of apparel and clothing accessories, knitted or crocheted Women's or girls' suits, ensembles, jackets and blazers, dresses, skirts, divided skirts, trousers, bib and brace overalls, breeches and shorts (other than swimwear), knitted or crocheted. Jackets and blazers: Of wool or fine animal hair"},"confidenceLevel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confidence level of the HS classification result. Possible values: HIGH, MEDIUM, LOW or N/A."},"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 confidence level represents how certain the system is about the accuracy of the returned HS code for a given item."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confidenceLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you provide a full valid HS code in the request, the system doesn't predict anything, it shows N/A."},"children":[]}]}]}]}],"enum":["HIGH","MEDIUM","LOW","N/A"],"example":"HIGH"}}}}}}},"example":{"item":{"itemId":"itemid-11","hsClassifications":[{"destinationCountryCode":"CA","hsTariffCode":"9503009099","tariffDescription":"Toys, games and sports requisites; parts and accessories thereof Tricycles, scooters, pedal cars and similar wheeled toys; dolls' carriages; dolls; other toys; reduced-size ('scale') models and similar recreational models, working or not; puzzles of all kinds. Other Other: Other","confidenceLevel":"HIGH"},{"destinationCountryCode":"CL","hsTariffCode":"95030099","tariffDescription":"Toys, games and sports requisites; parts and accessories thereof Tricycles, scooters, pedal cars and similar wheeled toys; dolls' carriages; dolls; other toys; reduced-size ('scale') models and similar recreational models, working or not; puzzles of all kinds. other other","confidenceLevel":"HIGH"}]}}}},"components/schemas/MultipleItemsSingleCountryDnTRequest":{"id":"components/schemas/MultipleItemsSingleCountryDnTRequest","kind":"json-schema","title":"MultipleItemsSingleCountryDnTRequest","data":{"type":"object","required":["exportCountryCode","destinationCountryCode","pricingCurrencyCode","items"],"properties":{"exportCountryCode":{"type":"string","maxLength":3,"minLength":2,"description":"The country from which the shipment is exported. This must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., US or USA).\n","example":"US"},"destinationCountryCode":{"type":"string","maxLength":3,"minLength":2,"description":"The country to which the shipment is intended. This must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., US or USA).\n","example":"CA"},"destinationStateProvince":{"type":"string","maxLength":2,"minLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Region code in the country of destination."},"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 countries that require a state or province (CA and BR), if not provided, the default will be:"},"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":"ON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Canada"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Brazil"},"children":[]}]}]}]}]}]}],"example":"ON"},"serviceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping service type used. Customs processing and related fees can vary between courier shipments and parcels shipped and cleared via the International Postal System. For the most accurate duty and tax estimation, specify the service type related to your 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":"Valid values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COURIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POSTAL"},"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 not provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COURIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used as the default serviceId."},"children":[]}]}]}]}],"example":"COURIER","enum":["COURIER","POSTAL"]},"responseCurrencyCode":{"type":"string","maxLength":3,"minLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency in which the quote should be returned. This must be a valid ISO 4217 currency code"},"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":"Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not provided."},"children":[]}]}]}]}],"example":"USD"},"pricingCurrencyCode":{"type":"string","maxLength":3,"minLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code associated with the amounts passed 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":"text","inline":true,"attributes":{"content":"Must be a valid ISO 4217 currency code."},"children":[]}]}]}]}],"example":"USD"},"items":{"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 item objects for the quote."},"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":"Maximum number of items is 200."},"children":[]}]}]}]}],"items":{"type":"object","required":["itemId","hsTariffCode","weight","unitPrice","quantity"],"properties":{"itemId":{"type":"string","maxLength":50,"description":"Unique identifier for the item, such as a merchant-assigned SKU or product code.\n","example":"ITEM123456"},"hsTariffCode":{"type":"string","maxLength":14,"minLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A full HS code or partial prefix (2-14 digits), to guide AI classification."},"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":"Valid input of any length will constrain the AI to return only full-length tariff codes that begin with your input — providing more digits (or the full code, if known) makes the result increasingly precise and helps to improve accuracy in classification and duty calculation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, providing an input of \"62\" will ensure that the classification for an item with a description of \"cotton blazer\" is constrained to tariff codes within woven apparel, rather than knitted."},"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":"62 → General HS code for \"Apparel, not knitted or crocheted\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6203 → More specific code for men's or boys' suits, ensembles, jackets, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"620332 → Even more detailed code indicating \"men's and boys' jackets and blazers of cotton"},"children":[]}]}]}]}],"example":"8471300000"},"weight":{"type":"object","required":["value","unitOfMeasurement"],"description":"The weight of a single item, including its unit of measure. Note that Unit codes are case-insensitive.\n","properties":{"value":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric weight of the item. Must be a valid decimal number."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":3.25},"unitOfMeasurement":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit of measure for the weight."},"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":"Accepted values are: Lb, Oz, G, Kg."},"children":[]}]}]}]}],"example":"LB","enum":["Lb (pounds)","Oz (ounces)","G (grams)","Kg (kilograms)"]}}},"dimension":{"type":"object","required":["length","height","width","unitOfMeasurement"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The item dimension or package dimension for a single unit."},"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":"Length is the longest dimension."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Height is the second longest dimension."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Width is the shortest dimension."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit codes are case-insensitive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid units: IN (inches), FT (feet), YD (yards), CM (centimeters), M (meters), MM (millimeters)."},"children":[]}]}]}]}],"properties":{"length":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the item. Length is considered the longest dimension."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":11},"height":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The height of the item. Height is the second longest dimension."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":12},"width":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The width of the item. Width is the shortest dimension."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":32},"unitOfMeasurement":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit of measure associated with the dimensions."},"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":"Must be a valid distance unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN:Inches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FT:Feet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YD:Yards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CM:Centimeters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M:Meters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM:Millimeter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(case-insensitive)."},"children":[]}]}]}]}],"example":"IN","enum":["IN","FT","YD","CM","M","MM"]}}},"volumes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The volumes and units of measure for a single item of this commodity type."},"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":"Accepted values (case-insensitive):"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABV: Alcohol by Volume"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GAL: Gallon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HLT: Hectolitre"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"L: Liter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LAL: Liter of Alcohol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PT: Pint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PF: Proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PFG: Proof Gallon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PGL: Proof Gallon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QT: Quart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WG: Wine Gallon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WL: Wine Liter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"items":{"type":"object","required":["value","unitOfMeasurement"],"properties":{"value":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The numeric volume value."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":4},"unitOfMeasurement":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit of measure associated with the volume value."},"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":"Must be a valid volume unit."},"children":[]}]}]}]}],"example":"L","enum":["ABV","GAL","HLT","L","LAL","PT","PF","PFG","PGL","QT","WG","WL"]}}}},"unitPrice":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of one unit of the item."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":100},"quantity":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity of items."},"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":"Must be a positive integer."},"children":[]}]}]}]}],"example":1},"originCountryCode":{"type":"string","maxLength":3,"minLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code of the item's origin (where the item was manufactured)."},"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":"Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USA"},"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 the country qualifies for reduced or Free Trade Agreement (FTA) rates, the Country of Origin (COO) must be provided to apply those reduced rates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional duty and taxes may apply based on the Country of Origin."},"children":[]}]}]}]}],"example":"US"}}}},"shippingAmount":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end-to-end shipping cost in the pricing currency."},"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":"Used in duty and tax calculations for countries that require shipping cost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, zero will be assumed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be 0 or greater."},"children":[]}]}]}]}],"example":10},"handlingAmount":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The handling cost in the pricing currency."},"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":"Used in duty and tax calculations for countries that require handling cost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, zero will be assumed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be 0 or greater."},"children":[]}]}]}]}],"example":6},"insuranceAmount":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The insurance cost in the pricing currency."},"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":"Used in duty and tax calculations for countries that require insurance cost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, zero will be assumed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be 0 or greater."},"children":[]}]}]}]}],"example":5}},"example":{"exportCountryCode":"US","destinationCountryCode":"CA","destinationStateProvince":"ON","serviceId":"COURIER","responseCurrencyCode":"USD","pricingCurrencyCode":"USD","items":[{"itemId":"ITEM-1234","hsTariffCode":"8471300000","weight":{"value":10,"unitOfMeasurement":"KG"},"dimension":{"length":11,"height":12,"width":32,"unitOfMeasurement":"IN"},"volumes":[{"value":4,"unitOfMeasurement":"L"}],"unitPrice":100,"quantity":1,"originCountryCode":"US"}],"shippingAmount":10,"handlingAmount":6,"insuranceAmount":5}}},"components/schemas/MultipleCountriesSingleItemDnTRequest":{"id":"components/schemas/MultipleCountriesSingleItemDnTRequest","kind":"json-schema","title":"MultipleCountriesSingleItemDnTRequest","data":{"type":"object","required":["exportCountryCode","pricingCurrencyCode","destinationCountries","item"],"properties":{"exportCountryCode":{"type":"string","maxLength":3,"minLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country from which the shipment is exported."},"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":"Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., US or USA)."},"children":[]}]}]}]}],"example":"US"},"serviceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping service type used. Customs processing and related fees can vary between courier shipments and parcels shipped and cleared via the International Postal System. For the most accurate duty and tax estimation, specify the service type related to your 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":"Valid values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COURIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POSTAL"},"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 not provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COURIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used as the default serviceId."},"children":[]}]}]}]}],"example":"Courier","enum":["COURIER","POSTAL"]},"responseCurrencyCode":{"type":"string","maxLength":3,"minLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency in which the quote should be returned."},"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":"Must be a valid 3-character ISO 4217 currency code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not provided."},"children":[]}]}]}]}],"example":"USD"},"pricingCurrencyCode":{"type":"string","maxLength":3,"minLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code associated with the amounts passed 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":"text","inline":true,"attributes":{"content":"Must be a valid ISO 4217 currency code."},"children":[]}]}]}]}],"example":"USD"},"destinationCountries":{"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":"The countries to which the shipment is intended. This must be a valid ISO 3166-1 alpha-2 or alpha-3 country codes (e.g., US or USA)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum number of countries can be pass in this array is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"250 "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"items":{"type":"object","required":["destinationCountryCode","hsTariffCode"],"properties":{"destinationCountryCode":{"type":"string","maxLength":3,"minLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination country code."},"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":"Must be a valid ISO 3166-1 alpha-2 or alpha-3 code."},"children":[]}]}]}]}],"example":"CA"},"destinationStateProvince":{"type":"string","maxLength":2,"minLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Region code in the country of destination."},"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 countries that require a state or province (CA and BR), if not provided, the default will be:"},"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":"ON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Canada"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Brazil"},"children":[]}]}]}]}]}]}],"example":"ON"},"shippingAmount":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end-to-end shipping cost in the pricing currency for the destination country."},"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":"Used in duty and tax calculations for countries that require shipping cost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, zero will be assumed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be 0 or greater"},"children":[]}]}]}]}],"example":10},"handlingAmount":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The handling cost in the pricing currency."},"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":"Used in duty and tax calculations for countries that require handling cost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, zero will be assumed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be 0 or greater"},"children":[]}]}]}]}],"example":6},"insuranceAmount":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The insurance cost in the pricing currency."},"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":"Used in duty and tax calculations for countries that require insurance cost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, zero will be assumed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be 0 or greater"},"children":[]}]}]}]}],"example":5},"hsTariffCode":{"type":"string","maxLength":14,"minLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A full HS code or partial prefix (2-14 digits), to guide AI classification."},"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":"Valid input of any length will constrain the AI to return only full-length tariff codes that begin with your input — providing more digits (or the full code, if known) makes the result increasingly precise and helps to improve accuracy in classification and duty calculation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, providing an input of \"62\" will ensure that the classification for an item with a description of \"cotton blazer\" is constrained to tariff codes within woven apparel, rather than knitted."},"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":"62 → General HS code for \"Apparel, not knitted or crocheted\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6203 → More specific code for men's or boys' suits, ensembles, jackets, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"620332 → Even more detailed code indicating \"men's and boys' jackets and blazers of cotton"},"children":[]}]}]}]}],"example":"8471300000"}}}},"item":{"type":"object","required":["itemId","weight","unitPrice","quantity"],"description":"Details of the item used for duty and tax estimation.\n","properties":{"itemId":{"type":"string","maxLength":50,"description":"Unique identifier for the item, such as a merchant-assigned SKU or product code.\n","example":"ITEM123456"},"weight":{"type":"object","required":["value","unitOfMeasurement"],"description":"The weight of a single item, including its unit of measure. Note that Unit codes are case-insensitive.\n","properties":{"value":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric weight of the item. Must be a valid decimal number."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":3.25},"unitOfMeasurement":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit of measure for the weight."},"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":"Accepted values are: Lb, Oz, G, Kg."},"children":[]}]}]}]}],"example":"LB","enum":["Lb (pounds)","Oz (ounces)","G (grams)","Kg (kilograms)"]}}},"dimension":{"type":"object","required":["length","height","width","unitOfMeasurement"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The item dimension or package dimension for a single unit."},"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":"Length is the longest dimension."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Height is the second longest dimension."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Width is the shortest dimension."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit codes are case-insensitive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid units: IN (inches), FT (feet), YD (yards), CM (centimeters), M (meters), MM (millimeters)."},"children":[]}]}]}]}],"properties":{"length":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The length of the item. Length is considered the longest dimension."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":11},"height":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The height of the item. Height is the second longest dimension."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":12},"width":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The width of the item. Width is the shortest dimension."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":32},"unitOfMeasurement":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit of measure associated with the dimensions."},"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":"Must be a valid distance unit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN:Inches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FT:Feet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YD:Yards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CM:Centimeters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M:Meters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM:Millimeter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(case-insensitive)."},"children":[]}]}]}]}],"example":"IN","enum":["IN","FT","YD","CM","M","MM"]}}},"volumes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The volumes and units of measure for a single item of this commodity type."},"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":"Accepted values (case-insensitive):"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABV: Alcohol by Volume"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GAL: Gallon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HLT: Hectolitre"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"L: Liter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LAL: Liter of Alcohol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PT: Pint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PF: Proof"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PFG: Proof Gallon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PGL: Proof Gallon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QT: Quart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WG: Wine Gallon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WL: Wine Liter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"items":{"type":"object","required":["value","unitOfMeasurement"],"properties":{"value":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The numeric volume value."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":4},"unitOfMeasurement":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit of measure associated with the volume value."},"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":"Must be a valid volume unit."},"children":[]}]}]}]}],"example":"L","enum":["ABV","GAL","HLT","L","LAL","PT","PF","PFG","PGL","QT","WG","WL"]}}}},"unitPrice":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of one unit of the item."},"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":"Must be greater than 0."},"children":[]}]}]}]}],"example":100},"quantity":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity of items."},"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":"Must be a positive integer."},"children":[]}]}]}]}],"example":1},"originCountryCode":{"type":"string","maxLength":3,"minLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code of the item's origin (where the item was manufactured)."},"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":"Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USA"},"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 the country qualifies for reduced or Free Trade Agreement (FTA) rates, the Country of Origin (COO) must be provided to apply those reduced rates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional duty and taxes may apply based on the Country of Origin."},"children":[]}]}]}]}],"example":"US"}}}},"example":{"exportCountryCode":"US","serviceId":"Courier","responseCurrencyCode":"USD","pricingCurrencyCode":"USD","destinationCountries":[{"destinationCountryCode":"CA","destinationStateProvince":"ON","shippingAmount":10,"handlingAmount":6,"insuranceAmount":5,"hsTariffCode":"8471300000"},{"destinationCountryCode":"CL","destinationStateProvince":"ML","shippingAmount":10,"handlingAmount":6,"insuranceAmount":5,"hsTariffCode":"8471300001"}],"item":{"itemId":"ITEM123456","weight":{"value":10,"unitOfMeasurement":"KG"},"dimension":{"length":11,"height":12,"width":32,"unitOfMeasurement":"IN"},"volumes":[{"value":4,"unitOfMeasurement":"L"}],"unitPrice":100,"quantity":1,"originCountryCode":"US"}}}},"components/schemas/MultipleItemsSingleCountryDnTResponse":{"id":"components/schemas/MultipleItemsSingleCountryDnTResponse","kind":"json-schema","title":"MultipleItemsSingleCountryDnTResponse","data":{"type":"object","properties":{"exportCountryCode":{"type":"string","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":"The country from which the shipment is exported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exportCountryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"US"},"destinationCountryCode":{"type":"string","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":"Country to which the shipment is being imported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationCountryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"CA"},"destinationStateProvince":{"type":"string","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":"Region or state within the destination country."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationStateProvince"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may or may not returned in the response depending on the  destination countries."},"children":[]}]}]}]}],"example":"ON"},"serviceId":{"type":"string","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":"Service used for the shipment.Valid values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COURIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POSTAL"},"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":"serviceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"Courier"},"responseCurrencyCode":{"type":"string","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":"The currency in which the quote is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"responseCurrencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"USD"},"items":{"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":"List of items with duty and tax breakdown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"itemId":{"type":"string","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":"Unique identifier for the item, such as a merchant-assigned SKU or product code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"ITEM123456"},"quantity":{"type":"integer","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":"Quantity of the item."},"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":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}]}]}],"example":1},"duties":{"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 duties applied to the item."},"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":"Duties are calculated based on destination country rules and thresholds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All value fields (except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryThreshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are expressed in the response currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duties"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in response only when query parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calculationType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes duty."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"type":{"type":"string","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":"The type of duty being applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"Duty"},"calculationMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to calculate duty. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/cbds/calculation-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculation Methods"},"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":"code","inline":true,"attributes":{"content":"calculationMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"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":"Formats may include:"},"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":"A. Rate% CostBase"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% FOB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% CIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% CFR"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B. Value per UNIT or UOM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".05 CAD/UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".05 CAD/LB"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C. Combination of A and B"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% FOB plus .05 CAD/UNIT"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D. Lesser of A or B"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Lesser of 5% FOB or .05 CAD/UNIT"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E. Greater of A or B"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Greater of 5% FOB or .05 CAD/UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}],"example":"5% FOB"},"threshold":{"type":"number","format":"float","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":"Duty threshold value for the destination country (in the response currency)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"threshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":150},"countryThreshold":{"type":"number","format":"float","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":"Duty threshold value  for the country of destination in the country's threshold currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryThreshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":215},"thresholdCostBaseValue":{"type":"number","format":"float","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":"How much of the items value will be used to compare against the threshold value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thresholdCostBaseValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":100},"thresholdCostBase":{"type":"string","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":"The cost components used to calculate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thesholdCostBaseValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., FOB, CIF)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thresholdCostBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"FOB"},"dutiableValue":{"type":"number","format":"float","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":"How much of the items value is subject to duty. Value is in the response currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dutiableValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":100},"amount":{"type":"number","format":"float","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":"Final calculated duty amount for the item. Amount is applicable for the unit item. Value is in the response currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":0}}}},"taxes":{"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 taxes applied to the item."},"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":"Taxes are calculated based on applicable rules, including thresholds and cost bases."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All value fields (except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryThreshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are expressed in the response currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calculationType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes tax."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"type":{"type":"string","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":"The type of tax being applied (e.g., GST, HST, VAT, PST)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"HST"},"calculationMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to calculate tax."},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/cbds/calculation-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculation Methods"},"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":"code","inline":true,"attributes":{"content":"calculationMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"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":"Formats may include:"},"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":"A. Rate% CostBase"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% FOB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% FOBD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% CIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":",5% CIFD , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% DUTY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% FREIGHT"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B. Value per UNIT or UOM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".05 CAD/UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".05 CAD/LB"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C. Combination of A and B"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% FOB  + .05 CAD/UNIT"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D. Lesser of A or B"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Lesser of 5% FOB or .05 CAD/UNIT"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E. Greater of A or B"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Greater of 5% FOB or .05 CAD/UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}],"example":"5% FOB"},"threshold":{"type":"number","format":"float","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":"Tax threshold value for the destination country in the response currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"threshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":150},"countryThreshold":{"type":"number","format":"float","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":"Tax threshold value for the destination country in the  country's threshold currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryThreshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":215},"thresholdCostBaseValue":{"type":"number","format":"float","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":"How much of the items value will be used to compare against the threshold value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thresholdCostBaseValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":100},"thresholdCostBase":{"type":"string","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":"The cost components used to calculate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thesholdCostBaseValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., FOB, CIFD)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thresholdCostBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"FOB"},"taxableValue":{"type":"number","format":"float","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":"How much of the items value is subject to tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxableValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":100},"amount":{"type":"number","format":"float","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":"Final calculated tax amount in the response currency. Amount is applicable for the unit item."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":0}}}}}}},"importationFees":{"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":"List of additional importation fees that may apply at the time of customs clearance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"importationFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may or may not returned in the response."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"type":{"type":"string","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":"The type of importation fee being applied (e.g., Merchandise Processing Fee, Handling Surcharge)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always return in response."},"children":[]}]}]}]}],"example":"Merchandise Processing Fee"},"calculationMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to calculate the fee. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/cbds/calculation-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculation Methods"},"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":"code","inline":true,"attributes":{"content":"calculationMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"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":"Formats include:"},"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":"A. Rate% CostBase"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"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":"5% FOB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Fee calculated as 5% of total sale price."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% CIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Fee based on total sale price + shipping + handling + insurance."},"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":"B. Flat Rate"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"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":"1.50 USD Flat Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Fixed fee applied."},"children":[]}]}]}]}]}]}],"example":"5% FOB"},"threshold":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional threshold value for the destination country. If the value of the item is below this threshold, the fee may not apply."},"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":"Expressed in the response currency."},"children":[]}]}]}]}],"example":150},"countryThreshold":{"type":"number","format":"float","description":"Optional threshold value for the destination country, expressed in the country's threshold currency.\n","example":215},"thresholdCostBaseValue":{"type":"number","format":"float","description":"How much of the items value will be used to compare against the threshold value.\n","example":100},"thresholdCostBase":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cost components used to calculate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thesholdCostBaseValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., FOB, CIF)."},"children":[]}]}]}],"example":"FOB"},"amount":{"type":"number","format":"float","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":"Final calculated importation fee amount in the response currency. Amount is applicable for the unit item."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":0}}}},"totalCharges":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Summary of all duty, tax, and importation fee totals."},"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":"Includes item value, shipping and handling charges, calculated duties, taxes, and total cost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalCharges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response in the response currency."},"children":[]}]}]}]}],"properties":{"totalValue":{"type":"number","format":"float","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":"Total item value across all items in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":100},"totalShippingAmount":{"type":"number","format":"float","description":"Total shipping cost provided by the client, if included in the request.\n","example":10},"totalHandlingAmount":{"type":"number","format":"float","description":"Total handling cost provided by the client, if included in the request.\n","example":6},"totalInsuranceAmount":{"type":"number","format":"float","description":"Total insurance cost provided by the client, if included in the request.\n","example":5},"totalDuty":{"type":"number","format":"float","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":"Total calculated duty across all items."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalDuty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":0},"totalTax":{"type":"number","format":"float","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":"Total calculated tax across all items."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalTax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":0},"totalImportationFees":{"type":"number","format":"float","description":"Total calculated importation fees, if applicable.\n","example":0},"sumTotal":{"type":"number","format":"float","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":"code","inline":true,"attributes":{"content":"sumTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response. "},"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":"Final total of all charges, including:"},"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":"totalValue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"totalShippingAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"totalHandlingAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"totalInsuranceAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"totalDuty"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"totalTax"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"totalImportationFees"},"children":[]}]}]}]}]}]}],"example":121},"exchangeRates":{"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 exchange rates applied during the duty and tax estimation."},"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":"These rates are used to convert values like thresholds and item costs from one currency to another."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"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 exchange rate applied."},"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":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returns in response. "},"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":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DutyThreshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Rate used for converting duty threshold currency to the response currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxThreshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Rate used for converting tax threshold currency to the response currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shipment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Rate used for converting shipment value."},"children":[]}]}]}]}],"example":"DutyThreshold"},"rate":{"type":"number","format":"float","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":"The exchange rate applied for the conversion."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returns in response."},"children":[]}]}]}]}],"example":1.3565},"fromCurrencyCode":{"type":"string","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":"Currency code from which the conversion was performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromCurrencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returns in response."},"children":[]}]}]}]}],"example":"CAD"},"toCurrencyCode":{"type":"string","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":"Currency code to which the conversion was performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toCurrencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returns in response."},"children":[]}]}]}]}],"example":"USD"}}}}}},"messages":{"type":"array","description":"Any additional information that may apply to the quote. This fiels may or may not returned in the response.","items":{"type":"string","example":"FTA rates applied."}}},"example":{"destinationCountryCode":"CA","destinationStateProvince":"ON","exportCountryCode":"US","importationFees":[{"amount":0,"calculationMethod":"5% FOB","countryThreshold":215,"threshold":150,"thresholdCostBase":"FOB","thresholdCostBaseValue":100,"type":"Merchandise Processing Fee"}],"items":[{"duties":[{"amount":0,"calculationMethod":"0% FOB","countryThreshold":20,"dutiableValue":100,"threshold":14.5833,"thresholdCostBase":"FOB","thresholdCostBaseValue":100,"type":"Duty"}],"itemId":"ITEM-1234","quantity":1,"taxes":[{"amount":5,"calculationMethod":"5.00% FOBD","countryThreshold":20,"taxableValue":100,"threshold":14.5833,"thresholdCostBase":"FOBD","thresholdCostBaseValue":100,"type":"HST - Federal"},{"amount":8,"calculationMethod":"8.00% FOBD","countryThreshold":20,"taxableValue":100,"threshold":14.5833,"thresholdCostBase":"FOBD","thresholdCostBaseValue":100,"type":"HST - Provincial (PST)"}]}],"messages":["FTA rates applied.","Duty DeMinimis rules not applied.","Tax DeMinimis rules not applied."],"responseCurrencyCode":"USD","serviceId":"COURIER","totalCharges":{"exchangeRates":[{"fromCurrencyCode":"USD","rate":1.3714304014,"toCurrencyCode":"CAD","type":"Shipment"},{"fromCurrencyCode":"CAD","rate":0.7291656937,"toCurrencyCode":"USD","type":"DutyThreshold"},{"fromCurrencyCode":"CAD","rate":0.7291656937,"toCurrencyCode":"USD","type":"TaxThreshold"}],"sumTotal":134,"totalDuty":0,"totalHandlingAmount":6,"totalImportationFees":0,"totalInsuranceAmount":5,"totalShippingAmount":10,"totalTax":13,"totalValue":100}}}},"components/schemas/MultipleCountriesSingleItemDnTResponse":{"id":"components/schemas/MultipleCountriesSingleItemDnTResponse","kind":"json-schema","title":"MultipleCountriesSingleItemDnTResponse","data":{"type":"object","description":"Response for multi-country, single-item duty and tax estimation.","properties":{"exportCountryCode":{"type":"string","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":"The country from which the shipment is exported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exportCountryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"US"},"serviceId":{"type":"string","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":"Service used for the shipment.Valid values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COURIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POSTAL"},"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":"serviceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"Courier"},"responseCurrencyCode":{"type":"string","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":"The currency in which the quote is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"responseCurrencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"USD"},"item":{"type":"object","properties":{"itemId":{"type":"string","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":"Unique identifier for the item, such as a merchant-assigned SKU or product code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"children":[]}]}]}]}],"example":"ITEM123456"},"quantity":{"type":"integer","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":"Quantity of the item being shipped."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":1},"countryQuotes":{"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":"List of destination countries with duty, tax, and fee calculations."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryQuotes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"destinationCountryCode":{"type":"string","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":"Country to which the shipment is being imported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationCountryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"CA"},"destinationStateProvince":{"type":"string","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":"Region or state within the destination country."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationStateProvince"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may or may not returned in the response depending on the  destination countries."},"children":[]}]}]}]}],"example":"ON"},"duties":{"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 duties applied to the item."},"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":"Duties are calculated based on destination country rules and thresholds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All value fields (except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryThreshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are expressed in the response currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duties"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in response only when query parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calculationType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes duty."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"type":{"type":"string","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":"The type of duty being applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"Duty"},"calculationMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to calculate duty. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/cbds/calculation-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculation Methods"},"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":"code","inline":true,"attributes":{"content":"calculationMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"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":"Formats may 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A. Rate% CostBase"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% FOB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% CIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% CFR"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B. Value per UNIT or UOM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".05 CAD/UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".05 CAD/LB"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C. Combination of A and B"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% FOB plus .05 CAD/UNIT"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D. Lesser of A or B"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Lesser of 5% FOB or .05 CAD/UNIT"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E. Greater of A or B"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Greater of 5% FOB or .05 CAD/UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}]}]}],"example":"5% FOB"},"threshold":{"type":"number","format":"float","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":"Duty threshold value for the destination country (in the response currency)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"threshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":150},"countryThreshold":{"type":"number","format":"float","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":"Duty threshold value  for the country of destination in the country's threshold currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryThreshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":215},"thresholdCostBaseValue":{"type":"number","format":"float","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":"How much of the items value will be used to compare against the threshold value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thresholdCostBaseValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":100},"thresholdCostBase":{"type":"string","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":"The cost components used to calculate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thesholdCostBaseValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., FOB, CIF)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thresholdCostBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"FOB"},"dutiableValue":{"type":"number","format":"float","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":"How much of the items value is subject to duty. Value is in the response currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dutiableValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":100},"amount":{"type":"number","format":"float","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":"Final calculated duty amount for the item. Amount is applicable for the unit item. Value is in the response currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":0}}}},"taxes":{"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 taxes applied to the item."},"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":"Taxes are calculated based on applicable rules, including thresholds and cost bases."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All value fields (except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryThreshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are expressed in the response currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"calculationType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes tax."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"type":{"type":"string","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":"The type of tax being applied (e.g., GST, HST, VAT, PST)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"HST"},"calculationMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to calculate tax."},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/cbds/calculation-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculation Methods"},"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":"code","inline":true,"attributes":{"content":"calculationMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"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":"Formats may include:"},"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":"A. Rate% CostBase"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% FOB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% FOBD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% CIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":",5% CIFD , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% DUTY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% FREIGHT"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B. Value per UNIT or UOM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".05 CAD/UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".05 CAD/LB"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C. Combination of A and B"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% FOB  + .05 CAD/UNIT"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D. Lesser of A or B"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Lesser of 5% FOB or .05 CAD/UNIT"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E. Greater of A or B"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Greater of 5% FOB or .05 CAD/UNIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}],"example":"5% FOB"},"threshold":{"type":"number","format":"float","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":"Tax threshold value for the destination country in the response currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"threshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":150},"countryThreshold":{"type":"number","format":"float","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":"Tax threshold value for the destination country in the  country's threshold currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryThreshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":215},"thresholdCostBaseValue":{"type":"number","format":"float","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":"How much of the items value will be used to compare against the threshold value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thresholdCostBaseValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":100},"thresholdCostBase":{"type":"string","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":"The cost components used to calculate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thesholdCostBaseValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., FOB, CIFD)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thresholdCostBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"FOB"},"taxableValue":{"type":"number","format":"float","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":"How much of the items value is subject to tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxableValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":100},"amount":{"type":"number","format":"float","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":"Final calculated tax amount in the response currency. Amount is applicable for the unit item."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":0}}}},"importationFees":{"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":"List of additional importation fees that may apply at the time of customs clearance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"importationFees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may or may not returned in the response."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"type":{"type":"string","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":"The type of importation fee being applied (e.g., Merchandise Processing Fee, Handling Surcharge)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always return in response."},"children":[]}]}]}]}],"example":"Merchandise Processing Fee"},"calculationMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to calculate the fee. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/cbds/calculation-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculation Methods"},"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":"code","inline":true,"attributes":{"content":"calculationMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"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":"Formats include:"},"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":"A. Rate% CostBase"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"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":"5% FOB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Fee calculated as 5% of total sale price."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5% CIF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Fee based on total sale price + shipping + handling + insurance."},"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":"B. Flat Rate"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"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":"1.50 USD Flat Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Fixed fee applied."},"children":[]}]}]}]}]}]}],"example":"5% FOB"},"threshold":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional threshold value for the destination country. If the value of the item is below this threshold, the fee may not apply."},"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":"Expressed in the response currency."},"children":[]}]}]}]}],"example":150},"countryThreshold":{"type":"number","format":"float","description":"Optional threshold value for the destination country, expressed in the country's threshold currency.\n","example":215},"thresholdCostBaseValue":{"type":"number","format":"float","description":"How much of the items value will be used to compare against the threshold value.\n","example":100},"thresholdCostBase":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cost components used to calculate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thesholdCostBaseValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., FOB, CIF)."},"children":[]}]}]}],"example":"FOB"},"amount":{"type":"number","format":"float","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":"Final calculated importation fee amount in the response currency. Amount is applicable for the unit item."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":0}}}},"exchangeRates":{"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 exchange rates applied during the duty and tax estimation."},"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":"These rates are used to convert values like thresholds and item costs from one currency to another."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"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 exchange rate applied."},"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":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returns in response. "},"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":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DutyThreshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Rate used for converting duty threshold currency to the response currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxThreshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Rate used for converting tax threshold currency to the response currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shipment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Rate used for converting shipment value."},"children":[]}]}]}]}],"example":"DutyThreshold"},"rate":{"type":"number","format":"float","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":"The exchange rate applied for the conversion."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returns in response."},"children":[]}]}]}]}],"example":1.3565},"fromCurrencyCode":{"type":"string","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":"Currency code from which the conversion was performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromCurrencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returns in response."},"children":[]}]}]}]}],"example":"CAD"},"toCurrencyCode":{"type":"string","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":"Currency code to which the conversion was performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toCurrencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returns in response."},"children":[]}]}]}]}],"example":"USD"}}}},"messages":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any additional information that may apply to the quote. This fiels may or may not returned in the response. "},"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 example -"},"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":"\"FTA rates applied.\","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Duty DeMinimis rules applied.\","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Tax DeMinimis rules applied.\""},"children":[]}]}]}]}],"items":{"type":"string","example":"FTA rates applied."}}}}}}}},"example":{"exportCountryCode":"US","serviceId":"Courier","responseCurrencyCode":"USD","item":{"itemId":"ITEM123456","quantity":1,"countryQuotes":[{"destinationCountryCode":"CA","destinationStateProvince":"ON","duties":[{"type":"Duty","calculationMethod":"0% FOB","threshold":14.5833,"countryThreshold":20,"thresholdCostBaseValue":100,"thresholdCostBase":"FOB","dutiableValue":100,"amount":0}],"taxes":[{"type":"HST - Federal","calculationMethod":"5.00% FOBD","threshold":14.5833,"countryThreshold":20,"thresholdCostBaseValue":100,"thresholdCostBase":"FOBD","taxableValue":100,"amount":5},{"type":"HST - Provincial (PST)","calculationMethod":"8.00% FOBD","threshold":14.5833,"countryThreshold":20,"thresholdCostBaseValue":100,"thresholdCostBase":"FOBD","taxableValue":100,"amount":8}],"exchangeRates":[{"type":"Shipment","rate":1.3714304014,"fromCurrencyCode":"USD","toCurrencyCode":"CAD"},{"type":"DutyThreshold","rate":0.7291656937,"fromCurrencyCode":"CAD","toCurrencyCode":"USD"},{"type":"TaxThreshold","rate":0.7291656937,"fromCurrencyCode":"CAD","toCurrencyCode":"USD"}],"messages":["FTA rates applied.","Duty DeMinimis rules not applied.","Tax DeMinimis rules not applied."]},{"destinationCountryCode":"CL","destinationStateProvince":"ML","duties":[{"type":"Duty","calculationMethod":"6.00% CIF","threshold":41,"countryThreshold":41,"thresholdCostBaseValue":100,"thresholdCostBase":"FOB","dutiableValue":121,"amount":7.26}],"taxes":[{"type":"VAT","calculationMethod":"19.00% CIFD","threshold":41,"countryThreshold":41,"thresholdCostBaseValue":107.26,"thresholdCostBase":"FOBD","taxableValue":128.26,"amount":24.3694}],"exchangeRates":[{"type":"Shipment","rate":940.3518815548,"fromCurrencyCode":"USD","toCurrencyCode":"CLP"},{"type":"DutyThreshold","rate":1,"fromCurrencyCode":"USD","toCurrencyCode":"USD"},{"type":"TaxThreshold","rate":1,"fromCurrencyCode":"USD","toCurrencyCode":"USD"}],"messages":["Standard rates applied.","Duty DeMinimis rules not applied.","Tax DeMinimis rules not applied."]}]}}}},"components/schemas/SingleCountrySingleItemRestrictionsRequest":{"id":"components/schemas/SingleCountrySingleItemRestrictionsRequest","kind":"json-schema","title":"SingleCountrySingleItemRestrictionsRequest","data":{"type":"object","required":["exportCountryCode","destinationCountryCode","item"],"properties":{"exportCountryCode":{"type":"string","maxLength":3,"minLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country from which the shipment is exported."},"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":"Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., US or USA)."},"children":[]}]}]}]}],"example":"US"},"destinationCountryCode":{"type":"string","maxLength":3,"minLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country to which the shipment is destined."},"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":"Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., CA or CAN)."},"children":[]}]}]}]}],"example":"CA"},"item":{"type":"object","description":"The item being evaluated for restriction.\n","required":["itemId","hsTariffCode"],"properties":{"itemId":{"type":"string","maxLength":50,"description":"Unique identifier for the item, such as a merchant-assigned SKU or product code.\n","example":"ITEM123456"},"hsTariffCode":{"type":"string","maxLength":14,"minLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A full HS code or partial prefix (2-14 digits), to guide AI classification."},"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":"Valid input of any length will constrain the AI to return only full-length tariff codes that begin with your input — providing more digits (or the full code, if known) makes the result increasingly precise and helps to improve accuracy in classification and duty calculation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, providing an input of \"62\" will ensure that the classification for an item with a description of \"cotton blazer\" is constrained to tariff codes within woven apparel, rather than knitted."},"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":"62 → General HS code for \"Apparel, not knitted or crocheted\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6203 → More specific code for men's or boys' suits, ensembles, jackets, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"620332 → Even more detailed code indicating \"men's and boys' jackets and blazers of cotton"},"children":[]}]}]}]}],"example":"2936210000"},"condition":{"type":"string","description":"The condition of the item.\n","example":"new","enum":["new","used","refurbished","damaged","unknown"]}}}}}},"components/schemas/SingleCountrySingleItemRestrictionsResponse":{"id":"components/schemas/SingleCountrySingleItemRestrictionsResponse","kind":"json-schema","title":"SingleCountrySingleItemRestrictionsResponse","data":{"type":"object","properties":{"exportCountryCode":{"type":"string","maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country from which the shipment is exported."},"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":"ISO 3166-1 alpha-2 or alpha-3 country code (e.g., US or USA)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exportCountryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"US"},"destinationCountryCode":{"type":"string","maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country to which the shipment is destined."},"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":"ISO 3166-1 alpha-2 or alpha-3 country code (e.g., CA or CAN)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationCountryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"CA"},"item":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The item being evaluated for restriction."},"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":"Contains item-specific shipping restriction information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always returned in response."},"children":[]}]}]}]}],"properties":{"itemId":{"type":"string","maxLength":50,"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":"Unique identifier for the item, such as a merchant-assigned SKU or product code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"ITEM123456"},"restrictions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrictions associated with the item."},"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":"May be empty if no restrictions exist."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"restrictionType":{"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 restriction applied to the item."},"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":"Can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DANGEROUS GOODS"},"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":"restrictionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"IMPORT"},"regulation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regulation that qualifies the restriction."},"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":"Prohibited"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the item cannot be shipped."},"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":"Restricted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the item can be shipped but requires additional documentation or permits."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regulation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned in the response only if there are applicable regulations for the item."},"children":[]}]}]}]}],"example":"RESTRICTED"},"category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The category under which the restriction falls."},"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":"Example values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hazmat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"health"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIMITED QUANTITY"},"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":"category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned in the response only if there are applicable restriction category for the item."},"children":[]}]}]}]}],"example":"LIMITED QUANTITY"},"requirement":{"type":"string","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":"Required documentation, permits, or licenses for the item to be shipped."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requirement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"children":[]}]}]}]}],"example":"IMPORT PERMIT"},"agencies":{"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":"Regulatory authority overseeing the restriction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in the response only if agencies are associated with the item's regulation."},"children":[]}]}]}]}],"items":{"type":"string"},"example":["CFIA"]},"complianceMessage":{"type":"string","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":"Additional message about compliance requirements or special handling instructions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complianceMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may or may not be returned in the response."},"children":[]}]}]}]}],"example":"Import Permit required"}}}}}}}}},"components/schemas/MultipleCountriesSingleItemRestrictionsRequest":{"id":"components/schemas/MultipleCountriesSingleItemRestrictionsRequest","kind":"json-schema","title":"MultipleCountriesSingleItemRestrictionsRequest","data":{"type":"object","required":["exportCountryCode","destinationCountries","item"],"properties":{"exportCountryCode":{"type":"string","maxLength":3,"minLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country from which the shipment is exported."},"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":"Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., US or USA)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum 250 coutries can be passed in the list."},"children":[]}]}]}]}],"example":"US"},"destinationCountries":{"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 destination country details."},"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 destination country code and its associated HS tariff code."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"destinationCountryCode":{"type":"string","maxLength":3,"minLength":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country to which the shipment is destined."},"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":"Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code (e.g., CA or CAN)."},"children":[]}]}]}]}],"example":"CA"},"hsTariffCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A full HS code or partial prefix (2-14 digits), to guide AI classification."},"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":"Valid input of any length will constrain the AI to return only full-length tariff codes that begin with your input — providing more digits (or the full code, if known) makes the result increasingly precise and helps to improve accuracy in classification and duty calculation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, providing an input of \"62\" will ensure that the classification for an item with a description of \"cotton blazer\" is constrained to tariff codes within woven apparel, rather than knitted."},"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":"62 → General HS code for \"Apparel, not knitted or crocheted\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6203 → More specific code for men's or boys' suits, ensembles, jackets, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"620332 → Even more detailed code indicating \"men's and boys' jackets and blazers of cotton"},"children":[]}]}]}]}],"example":"8471300000"}}}},"item":{"type":"object","required":["itemId"],"description":"The item being evaluated for shipping restrictions.\n","properties":{"itemId":{"type":"string","maxLength":50,"description":"Unique identifier for the item, such as a merchant-assigned SKU or product code.\n","example":"ITEM123456"},"condition":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The condition of the item."},"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":"Allowed values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFURBISHED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAMAGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"NEW"}}}},"example":{"exportCountryCode":"US","destinationCountries":[{"destinationCountryCode":"CL","hsTariffCode":"420211888"},{"destinationCountryCode":"CA","hsTariffCode":"010121"},{"destinationCountryCode":"MX","hsTariffCode":"10000000"}],"item":{"itemId":"ITEM-1234","condition":"NEW"}}}},"components/schemas/MultipleCountriesSingleItemRestrictionsResponse":{"id":"components/schemas/MultipleCountriesSingleItemRestrictionsResponse","kind":"json-schema","title":"MultipleCountriesSingleItemRestrictionsResponse","data":{"type":"object","properties":{"exportCountryCode":{"type":"string","maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country from which the shipment is exported."},"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":"ISO 3166-1 alpha-2 or alpha-3 country code (e.g., US or USA)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exportCountryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"US"},"item":{"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":"Item and its associated restrictions per destination country."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"item"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"properties":{"itemId":{"type":"string","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":"Unique identifier for the item, such as a merchant-assigned SKU or product code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"ITEM123456"},"countryRestrictions":{"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 restrictions applied to the item for each destination country."},"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":"May be empty for countries with no applicable restrictions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryRestrictions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"destinationCountryCode":{"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 associated with the shipping restriction."},"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":"Can be ALL if the restriction pertains to all countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationCountryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in response."},"children":[]}]}]}]}],"example":"CA"},"restrictions":{"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 restrictions applicable to the item for the specified destination country."},"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":"Can be empty if no restrictions apply."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field may or may not be returned in the response, depending on whether any country-specific restrictions exist."},"children":[]}]}]}]}],"items":{"type":"object","properties":{"restrictionType":{"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 restriction applied to the item."},"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":"Can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DANGEROUS GOODS"},"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":"restrictionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"children":[]}]}]}]}],"example":"EXPORT"},"regulation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regulation that qualifies the restriction."},"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":"Prohibited"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the item cannot be shipped."},"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":"Restricted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the item can be shipped but requires additional documentation or permits."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regulation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned in the response only if there are applicable regulations for the item."},"children":[]}]}]}]}],"example":"RESTRICTED"},"category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The category under which the restriction falls."},"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":"Example values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hazmat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"health"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIMITED QUANTITY"},"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":"category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned in the response only if there are applicable restriction category for the item."},"children":[]}]}]}]}],"example":"HEALTH"},"requirement":{"type":"string","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":"Required documentation, permits, or licenses for the item to be shipped."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requirement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the response."},"children":[]}]}]}]}],"example":"LICENSE"},"agencies":{"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":"List of authorities overseeing the restriction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in the response only if agencies are associated with the item's regulation."},"children":[]}]}]}]}],"items":{"type":"string"},"example":["Canadian Food Inspection Agency"]},"complianceMessage":{"type":"string","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":"Additional details or advisory messages related to the restriction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complianceMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may or may not be returned in the response."},"children":[]}]}]}]}],"example":"Import restricted (Veterinary Health Certificate)"}}}}}}}}}},"example":{"exportCountryCode":"US","item":{"itemId":"ITEM-1234","countryRestrictions":[{"destinationCountryCode":"ALL","restrictions":[{"restrictionType":"EXPORT","regulation":"RESTRICTED","category":"CITES","requirement":"EXPORT PERMIT; FW1","complianceMessage":"CITES"}]},{"destinationCountryCode":"CL","restrictions":[{"restrictionType":"IMPORT","regulation":"RESTRICTED","category":"CITES","requirement":"IMPORT PERMIT; FW1","agencies":["Chilean Ministry of Health and the Chilean Agricultural and Livestock Service."],"complianceMessage":"CITES: Health and veterinary permits are issued by the Chilean Ministry of Health and the Chilean Agricultural and Livestock Service. - Chilean Ministry of Health and the Chilean Agricultural and Livestock Service: https://www.gob.cl/en/ministries/ministry-of-health/ or http://www.minsal.cl and http://www.sag.gob.cl"}]},{"destinationCountryCode":"ALL","restrictions":[{"restrictionType":"EXPORT","regulation":"RESTRICTED","category":"HEALTH","requirement":"LICENSE; FD3; AP2","complianceMessage":"Export license (Veterinary Health Certificate)"}]},{"destinationCountryCode":"CA","restrictions":[{"restrictionType":"IMPORT","regulation":"RESTRICTED","category":"HEALTH","requirement":"FORMAL ENTRY; FD3; AP2","agencies":["Canadian Food Inspection Agency."],"complianceMessage":"Import restricted (Veterinary Health Certificate): Import restrictions requiring health certificates are overseen by the Canadian Food Inspection Agency. - Canadian Food Inspection Agency: https://inspection.canada.ca/en"}]},{"destinationCountryCode":"MX","restrictions":[]}]}}}},"components/schemas/DeniedPartyScreeningRequest":{"id":"components/schemas/DeniedPartyScreeningRequest","kind":"json-schema","title":"DeniedPartyScreeningRequest","data":{"type":"object","required":["addresses"],"properties":{"addresses":{"type":"array","description":"List of addresses to be screened. It includes a consignee and/or shipper.\n","items":{"$ref":"#/components/schemas/ScreeningAddress"}}},"example":{"addresses":[{"addressType":"CONSIGNEE","address":{"addressLine1":"27 Waterview Dr","cityTown":"Shelton","company":"Pitney Bowes","countryCode":"US","email":"john.doe@example.com","name":"pablo Escobar","phone":"123-456-7890","postalCode":"06484-4675","residential":false,"stateProvince":"CT"}},{"addressType":"SHIPPER","address":{"name":"Jason Henley","addressLine1":"74 Thame rd","addressLine2":"Warborough","addressLine3":"Wallingford","cityTown":"Oxfordshire","stateProvince":"TX","postalCode":"OX10 7DG","countryCode":"UA","email":"ovidiu131183@yahoo.com","phone":"123-456-7891"}}]}}},"components/schemas/ScreeningAddress":{"id":"components/schemas/ScreeningAddress","kind":"json-schema","title":"ScreeningAddress","data":{"type":"object","required":["addressType","address"],"properties":{"addressType":{"type":"string","description":"Identifies whether the address belongs to the shipper or consignee.","enum":["SHIPPER","CONSIGNEE"],"example":"CONSIGNEE"},"address":{"$ref":"#/components/schemas/Address"}},"description":"A single address entry submitted for screening."}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","required":["name","addressLine1","cityTown","countryCode"],"properties":{"name":{"type":"string","description":"Full name of the person associated with the address.","example":"Pablo Escobar"},"company":{"type":"string","description":"Company name associated with the address, if applicable.","example":"Pitney Bowes"},"addressLine1":{"type":"string","description":"Primary street address line.","example":"27 Waterview Dr"},"addressLine2":{"type":"string","description":"Additional street address information (line 2).","example":"Warborough"},"addressLine3":{"type":"string","description":"Additional street address information (line 3).","example":"Wallingford"},"cityTown":{"type":"string","description":"City or town for the address.","example":"Shelton"},"stateProvince":{"type":"string","description":"State or province.","example":"CT"},"postalCode":{"type":"string","description":"Postal code / ZIP code.","example":"06484-4675"},"countryCode":{"type":"string","description":"Two- or three-character country code (ISO 3166-1 alpha-2 or alpha-3).\n","minLength":2,"maxLength":3,"example":"US"},"email":{"type":"string","description":"Email address associated with the party.","format":"email","example":"john.doe@example.com"},"phone":{"type":"string","description":"Phone number associated with the party.","example":"123-456-7890"},"residential":{"type":"boolean","description":"Indicates whether the address is residential. If omitted, defaults to false.\n","example":false}}}},"components/schemas/DeniedPartyScreeningResponse":{"id":"components/schemas/DeniedPartyScreeningResponse","kind":"json-schema","title":"DeniedPartyScreeningResponse","data":{"type":"object","required":["addresses"],"properties":{"addresses":{"type":"array","description":"List of addresses that were screened for denied party restrictions. Each address is evaluated independently and includes the screening outcome.\n","items":{"$ref":"#/components/schemas/AdditionalAddressResponse"}}}}},"components/schemas/AdditionalAddressResponse":{"id":"components/schemas/AdditionalAddressResponse","kind":"json-schema","title":"AdditionalAddressResponse","data":{"type":"object","required":["addressType","address","screeningResult"],"properties":{"addressType":{"type":"string","description":"Indicates the role of the address being screened.","enum":["SHIPPER","CONSIGNEE"],"example":"CONSIGNEE"},"address":{"$ref":"#/components/schemas/Address"},"screeningResult":{"$ref":"#/components/schemas/ScreeningResult"}}}},"components/schemas/ScreeningResult":{"id":"components/schemas/ScreeningResult","kind":"json-schema","title":"ScreeningResult","data":{"type":"object","required":["status","message"],"properties":{"status":{"type":"string","description":"Result of the denied party screening performed on the address.\n","enum":["APPROVED","POTENTIAL MATCHED","MATCHED"],"example":"APPROVED"},"message":{"type":"string","description":"Additional information describing the screening outcome.","example":"Consignee details are completely verified."},"restrictionPartyList":{"type":"array","description":"List of governmental regulatory denied party lists on which the\nshipper or consignee may exist. Returned only when a match or\npotential match is identified.\n","items":{"$ref":"#/components/schemas/Restriction"}}}}},"components/schemas/Restriction":{"id":"components/schemas/Restriction","kind":"json-schema","title":"Restriction","data":{"type":"object","required":["restrictionParty","country"],"properties":{"restrictionParty":{"type":"string","description":"Name of the governmental regulatory denied party list.","example":"EMBARGOED-COUNTRY"},"country":{"type":"string","description":"Country associated with the denied party restriction.","example":"UA"},"matchScore":{"type":"number","format":"float","description":"Confidence score indicating how closely the screened data matched\na restricted party record.\n","example":1},"matchType":{"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 or category of data that was matched during the screening process. It identifies what kind of information triggered the match—for example, whether it was a person's name or address"},"children":[]}]}]}],"enum":["name and/or company","address"],"example":"name and/or company"},"matchValue":{"type":"string","description":"The specific name string that matched a record on a restricted list. This will only be returned when the match type is name or company.\n","example":"Pablo Escobar"}}}},"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"type":"object","properties":{"message":{"type":"string","description":"This is HTTP 401 Unauthorized response status code, that indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.","example":"Unauthorized"}},"required":["message"]}},"components/schemas/Errors":{"id":"components/schemas/Errors","kind":"json-schema","title":"Errors","data":{"type":"object","properties":{"errors":{"type":"array","description":"List of errors.","items":{"type":"object","properties":{"errorCode":{"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 the code of the error. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/cbds/error-handling"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]}]}]}],"example":"PB-XECOM-ERR-XXXX"},"errorDescription":{"type":"string","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":"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)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returned in the error response."},"children":[]}]}]}]}],"example":"Invalid Value."},"additionalInfo":{"type":"string","description":" additional information of the error. This field may or may not returned in the response.","example":"additional information"},"additionalParameters":{"type":"array","items":{"type":"string"},"example":["item.hsTariffCode"],"description":"Additional context or parameters related to the error."}}}}}}},"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.","example":"Server error"}},"required":["message"]}},"schema_249":{"kind":"json-schema","data":{"type":"string"},"id":"schema_249"},"schema_250":{"kind":"json-schema","data":{"type":"string","enum":["application/json"]},"id":"schema_250"},"schema_251":{"kind":"json-schema","data":{"type":"string","enum":["duty","tax","duty_tax"]},"id":"schema_251"}},"exampleStore":{},"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)"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/crossborderdeliveryservices.json?download"},{"url":"/_bundle/openapi/crossborderdeliveryservices.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Overview","description":"The Cross-Border Delivery Services (CBDS) APIs provide capabilities to support international shipping compliance and cost calculation. These APIs help determine product classification, identify country-specific shipping restrictions, calculate landed costs  (duties and taxes), and screen buyers or sellers against denied or sanctioned party lists.\n\nThe APIs are grouped into the following categories:\n\n- **HS Classification:** Retrieve HS codes for items for a single country or across multiple countries.  \n- **Restrictions:** Identify import and export restrictions for items based on destination or origin countries.  \n- **Landed Cost Quote:** Calculate applicable duties and taxes for international shipments.  \n- **Denied Party Screening:** Screen buyers or sellers against embargoed or sanctioned parties at the country level.\n"}},"baseSlug":"/openapi/crossborderdeliveryservices","routesMapping":{}}