{"items":[{"type":"link","label":"Customs Product API","link":"/openapi/customproduct","routeSlug":"/openapi/customproduct","content":{"contentType":"overview","meta":{"name":"Customs Product API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"customproduct.json","url":"/_bundle/openapi/customproduct.json?download"},{"kind":"download","label":"customproduct.yaml","url":"/_bundle/openapi/customproduct.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"PB Software License Agreement","url":"https://www.pitneybowes.com/us/support/account/pitney-bowes-terms-and-conditions.html"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Customs Product API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Customs Product APIs let you create and manage saved customs product records for international shipments. These records can be reused in shipment requests to prefill customs item details such as product description, origin country, HS tariff code, quantity, unit price, and product dimensions.\nUsing these APIs helps reduce repeated data entry and improves consistency when the same product details are used across multiple domestic/international shipments.\nSaved customs product identifiers can be passed in shipment/OMS workflows where customs item details are required."}],"sectionId":"/openapi/customproduct"}],"sectionId":"/openapi/customproduct"}]}]}},{"type":"group","label":"Customs Product","link":"/openapi/customproduct/customs-product","routeSlug":"/openapi/customproduct/customs-product","items":[{"label":"Add Customs Product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customproduct/customs-product/addcustomsproduct","routeSlug":"/openapi/customproduct/customs-product/addcustomsproduct","metadata":{"seo":{"title":"Add Customs Product","description":"This operation creates a customs product and returns its identifier. Use this identifier in shipment APIs to prefill customs item fields (HS tariff code, origin country, unit price, weight, quantity)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addCustomsProduct","name":"Add Customs Product","isWebhook":false,"pointer":"/paths/~1api~1v1~1customsproduct/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Customs Product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation creates a customs product and returns its identifier. Use this identifier in shipment APIs to prefill customs item fields (HS tariff code, origin country, unit price, weight, quantity)."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Support for this capability in the Rate Shipment and Create Shipment APIs is under active development. It is targeted for upcoming release."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddCustomsProduct"}},"schemaId":"components/schemas/AddCustomsProduct","pointer":"/paths/~1api~1v1~1customsproduct/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/customsproduct","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddCustomsProduct"}},"responseCodes":["201","400","401","500"],"pointer":"/api/v1/customsproduct","href":"customs-product/addcustomsproduct","openApiOperationId":"addCustomsProduct","summary":"Add Customs Product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/AddCustomsProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddCustomsProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Customs Product identifier successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255"}},"schemaId":"schema_255"},{"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."}],"pointer":"/paths/~1api~1v1~1customsproduct/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_255","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255"}}},{"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customs-product/addcustomsproduct"}],"panels":[]}]},"httpPath":"/api/v1/customsproduct"},{"label":"Get all Customs Products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customproduct/customs-product/getcustomsproduct","routeSlug":"/openapi/customproduct/customs-product/getcustomsproduct","metadata":{"seo":{"title":"Get all Customs Products","description":"Returns a list of all Customs Products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomsProduct","name":"Get all Customs Products","isWebhook":false,"pointer":"/paths/~1api~1v1~1customsproduct/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Customs Products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all Customs Products.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_256"},{"name":"page","in":"query","schemaId":"schema_257"},{"name":"size","in":"query","schemaId":"schema_257"}],"pointer":"/paths/~1api~1v1~1customsproduct/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customsproduct","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","example":"productName,ASC","schemaId":"schema_256"},{"name":"page","in":"query","schemaId":"schema_257"},{"name":"size","in":"query","schemaId":"schema_257"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/customsproduct","href":"customs-product/getcustomsproduct","openApiOperationId":"getCustomsProduct","summary":"Get all Customs Products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of customs productss has beed retreived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258"}},"schemaId":"schema_258"},{"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."}],"pointer":"/paths/~1api~1v1~1customsproduct/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_258","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258"}}},{"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customs-product/getcustomsproduct"}],"panels":[]}]},"httpPath":"/api/v1/customsproduct"},{"label":"Get Customs Product by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customproduct/customs-product/getcustomsproductbyid","routeSlug":"/openapi/customproduct/customs-product/getcustomsproductbyid","metadata":{"seo":{"title":"Get Customs Product by Id","description":"This operation retrieves the details of a specific Customs Product mapping by its unique description.A customs product (description) represents a saved configuration of customs items defined for international shipment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomsProductbyId","name":"Get Customs Product by Id","isWebhook":false,"pointer":"/paths/~1api~1v1~1customsproduct~1{customsProductId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Customs Product by Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation retrieves the details of a specific Customs Product mapping by its unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A customs product (description) represents a saved configuration of customs items defined for international shipment."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customsProductId","in":"path","schemaId":"schema_259","required":true}],"pointer":"/paths/~1api~1v1~1customsproduct~1{customsProductId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customsproduct/{customsProductId}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"customsProductId","in":"path","required":true,"schemaId":"schema_259"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/customsproduct/{customsProductId}","href":"customs-product/getcustomsproductbyid","openApiOperationId":"getCustomsProductbyId","summary":"Get Customs Product by Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Specified customs product has beed retreived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCustomsProductResponse"}},"schemaId":"components/schemas/GetCustomsProductResponse"},{"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."}],"pointer":"/paths/~1api~1v1~1customsproduct~1{customsProductId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCustomsProductResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCustomsProductResponse"}}},{"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customs-product/getcustomsproductbyid"}],"panels":[]}]},"httpPath":"/api/v1/customsproduct/{customsProductId}"},{"label":"Update Customs Product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customproduct/customs-product/updatecustomsproduct","routeSlug":"/openapi/customproduct/customs-product/updatecustomsproduct","metadata":{"seo":{"title":"Update Customs Product","description":"This operation Updates the details for the specified Customs Product.The customs product (description)  itself cannot be changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomsProduct","name":"Update Customs Product","isWebhook":false,"pointer":"/paths/~1api~1v1~1customsproduct~1{customsProductId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Customs Product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation Updates the details for the specified Customs Product."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customs product (description)  itself "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be changed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customsProductId","in":"path","schemaId":"schema_260","required":true}],"pointer":"/paths/~1api~1v1~1customsproduct~1{customsProductId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddCustomsProduct"}},"schemaId":"components/schemas/AddCustomsProduct","pointer":"/paths/~1api~1v1~1customsproduct~1{customsProductId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/customsproduct/{customsProductId}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"customsProductId","in":"path","required":true,"schemaId":"schema_260"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddCustomsProduct"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/customsproduct/{customsProductId}","href":"customs-product/updatecustomsproduct","openApiOperationId":"updateCustomsProduct","summary":"Update Customs Product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/AddCustomsProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddCustomsProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customs Product description successfully updated."},{"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."}],"pointer":"/paths/~1api~1v1~1customsproduct~1{customsProductId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customs-product/updatecustomsproduct"}],"panels":[]}]},"httpPath":"/api/v1/customsproduct/{customsProductId}"},{"label":"Delete Customs Product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customproduct/customs-product/deletecustomsproduct","routeSlug":"/openapi/customproduct/customs-product/deletecustomsproduct","metadata":{"seo":{"title":"Delete Customs Product","description":"This operation deletes the Customs Product by its unique description."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomsProduct","name":"Delete Customs Product","isWebhook":false,"pointer":"/paths/~1api~1v1~1customsproduct~1{customsProductId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Customs Product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation deletes the Customs Product by its unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customsProductId","in":"path","schemaId":"schema_261","description":"Unique customs product identifier. This value is defined when the customs product is created and cannot be changed.","required":true}],"pointer":"/paths/~1api~1v1~1customsproduct~1{customsProductId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/customsproduct/{customsProductId}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"customsProductId","in":"path","required":true,"schemaId":"schema_261"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/customsproduct/{customsProductId}","href":"customs-product/deletecustomsproduct","openApiOperationId":"deleteCustomsProduct","summary":"Delete Customs Product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The specified customs product has been deleted successfully."},{"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."}],"pointer":"/paths/~1api~1v1~1customsproduct~1{customsProductId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customs-product/deletecustomsproduct"}],"panels":[]}]},"httpPath":"/api/v1/customsproduct/{customsProductId}"}],"content":{"contentType":"group","meta":{"name":"Customs Product"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customs Product","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing saved customs product records used to prefill customs item details for domestic/international shipments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customsproduct","summary":"Add Customs Product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customs-product/addcustomsproduct","deprecated":false},{"title":"/api/v1/customsproduct","summary":"Get all Customs Products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customs-product/getcustomsproduct","deprecated":false},{"title":"/api/v1/customsproduct/{customsProductId}","summary":"Get Customs Product by Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customs-product/getcustomsproductbyid","deprecated":false},{"title":"/api/v1/customsproduct/{customsProductId}","summary":"Update Customs Product","prefix":{"name":"put","color":"put"},"badges":[],"link":"/customs-product/updatecustomsproduct","deprecated":false},{"title":"/api/v1/customsproduct/{customsProductId}","summary":"Delete Customs Product","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customs-product/deletecustomsproduct","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"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."}},"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 error can be validation_error or internal_error or not_found or already_exists"},"children":[]}]}]}],"example":"validation_error"},"errorDescription":{"type":"string","description":"The HTTP 400 Bad Request response status code indicates that the server cannot process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","example":"Customs Product not found"}}}}}}},"components/schemas/AddCustomsProduct":{"id":"components/schemas/AddCustomsProduct","kind":"json-schema","title":"AddCustomsProduct","data":{"type":"object","required":["description","originCountryCode","quantity","unitPrice","productDimensions"],"properties":{"description":{"type":"string","description":"Description of the product.","example":"This is description of the product"},"originCountryCode":{"type":"string","description":"ISO country code of the product origin.","example":"US"},"hsTariffCode":{"type":"string","description":"Harmonized System (HS) tariff code.","example":"hsc01"},"quantity":{"type":"integer","description":"Quantity of the product.","example":1},"unitPrice":{"type":"number","format":"float","description":"Unit price of this item.","example":10},"itemId":{"type":"string","description":"Unique identifier for the commodity.","example":"item1"},"url":{"type":"string","description":"Product page URL for this item.","example":"abc"},"productDimensions":{"type":"object","description":"Physical details of the product (Item).","required":["weight","weightUnit"],"properties":{"length":{"type":"number","format":"float","description":"Length of the product.","example":10},"height":{"type":"number","format":"float","description":"Height of the product.","example":10},"width":{"type":"number","format":"float","description":"Width of the product.","example":10},"dimUnit":{"type":"string","description":"Unit of measurement for dimensions.","enum":["IN","CM"],"example":"IN"}}},"weightUnit":{"type":"string","description":"Unit of weight.","enum":["OZ","GM"],"example":"OZ"},"weight":{"type":"number","format":"float","description":"Weight of the product(Item).","example":10}}}},"components/schemas/GetCustomsProductResponse":{"id":"components/schemas/GetCustomsProductResponse","kind":"json-schema","title":"GetCustomsProductResponse","data":{"type":"object","properties":{"customsProductId":{"type":"string","description":"Customs product identifier.","example":"MGW40jeQAZ3m"},"description":{"type":"string","description":"Description of the product.","example":"towel"},"originCountryCode":{"type":"string","description":"ISO country code of the product origin.","example":"US"},"hsTariffCode":{"type":"string","description":"Harmonized System (HS) tariff code.","example":"hsc01"},"quantity":{"type":"integer","description":"Quantity of the product.","example":1},"unitPrice":{"type":"number","format":"float","description":"Unit price of the product.","example":10},"itemId":{"type":"string","description":"Unique identifier for the commodity.","example":"item1"},"url":{"type":"string","description":"Product page URL.","example":"abc"},"productDimensions":{"type":"object","description":"Physical details of the product (Item).","required":["weight","weightUnit"],"properties":{"length":{"type":"number","format":"float","description":"Length of the product.","example":10},"height":{"type":"number","format":"float","description":"Height of the product.","example":10},"width":{"type":"number","format":"float","description":"Width of the product.","example":10},"dimUnit":{"type":"string","description":"Unit of measurement for dimensions.","enum":["IN","CM"],"example":"IN"}}},"weightUnit":{"type":"string","description":"Unit of weight.","enum":["OZ","GM"],"example":"OZ"},"weight":{"type":"number","format":"float","description":"Weight of the product(Item).","example":10}}}},"components/schemas/UpdateCustomsProductRequest":{"id":"components/schemas/UpdateCustomsProductRequest","kind":"json-schema","title":"UpdateCustomsProductRequest","data":{"type":"object","required":["weight","weightUnit"],"properties":{"description":{"type":"string","description":"Description of the product/Item needs to be updated.","example":"This is description of the product"},"originCountryCode":{"type":"string","description":"ISO country code of the product origin.","example":"US"},"hsTariffCode":{"type":"string","description":"Harmonized System (HS) tariff code.","example":"hsc01"},"quantity":{"type":"integer","description":"Quantity of the product.","example":1},"unitPrice":{"type":"number","format":"float","description":"Unit price of this item.","example":10},"itemId":{"type":"string","description":"Unique identifier for the commodity.","example":"item1"},"url":{"type":"string","description":"Product page URL for this item.","example":"abc"},"productDimensions":{"type":"object","description":"Physical details of the product (Item).","required":["weight","weightUnit"],"properties":{"length":{"type":"number","format":"float","description":"Length of the product.","example":10},"height":{"type":"number","format":"float","description":"Height of the product.","example":10},"width":{"type":"number","format":"float","description":"Width of the product.","example":10},"dimUnit":{"type":"string","description":"Unit of measurement for dimensions.","enum":["IN","CM"],"example":"IN"}}},"weightUnit":{"type":"string","description":"Unit of weight.","enum":["OZ","GM"],"example":"OZ"},"weight":{"type":"number","format":"float","description":"Weight of the product(Item).","example":10}}}},"schema_255":{"kind":"json-schema","data":{"type":"object","properties":{"customsProductId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The generated customs product identifier that can be used as customs items for international shipments. The items/properties defined here can only be used in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.sendpro360.pitneycloud.com/openapi/shipping/shipment/createshipmentv2#shipment/createshipmentv2/t=request&path=&oneof=0/customs/customsitems"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customsItems"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}],"example":"cp00000922010"}}},"id":"schema_255"},"schema_256":{"kind":"json-schema","data":{"type":"string","description":"","example":"productName,ASC","default":null,"enum":["productName,ASC"]},"id":"schema_256"},"schema_257":{"kind":"json-schema","data":{"type":"number","description":"","default":1},"id":"schema_257"},"schema_258":{"kind":"json-schema","data":{"type":"object","properties":{"pageInfo":{"type":"object","description":"Pagination details for the response.","properties":{"total":{"type":"integer","description":"Total number of records available.","example":10},"pages":{"type":"integer","description":"Total number of pages available.","example":1},"page":{"type":"integer","description":"","example":1},"pageSize":{"type":"integer","description":"","example":20}}},"data":{"type":"array","description":"List of customs products.","items":{"$ref":"#/components/schemas/GetCustomsProductResponse"}}}},"id":"schema_258"},"schema_259":{"kind":"json-schema","data":{"type":"string","description":"Unique customs product identifier. This value is defined when the customs product is created and cannot be changed later."},"id":"schema_259"},"schema_260":{"kind":"json-schema","data":{"type":"string","description":"Unique customs product identifier. This value is defined when the customs product is created and cannot be changed."},"id":"schema_260"},"schema_261":{"kind":"json-schema","data":{"type":"string"},"id":"schema_261"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}]},"options":{"hideDownloadButtons":false,"hideInfoMetadata":true,"jsonSamplesExpandLevel":3,"layout":"three-panel","schemasExpansionLevel":2,"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Go"},{"lang":"Java"},{"lang":"C#"}]},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/customproduct.json?download"},{"url":"/_bundle/openapi/customproduct.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Customs Product API","description":"Customs Product APIs let you create and manage saved customs product records for international shipments. These records can be reused in shipment requests to prefill customs item details such as product description, origin country, HS tariff code, quantity, unit price, and product dimensions.\nUsing these APIs helps reduce repeated data entry and improves consistency when the same product details are used across multiple domestic/international shipments.\nSaved customs product identifiers can be passed in shipment/OMS workflows where customs item details are required."}},"baseSlug":"/openapi/customproduct","routesMapping":{}}