{"items":[{"type":"link","label":"Known Shipper APIs","link":"/openapi/knownshipper","routeSlug":"/openapi/knownshipper","content":{"contentType":"overview","meta":{"name":"Known Shipper APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"knownshipper.json","url":"/_bundle/openapi/knownshipper.json?download"},{"kind":"download","label":"knownshipper.yaml","url":"/_bundle/openapi/knownshipper.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"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Known Shipper APIs (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The Known Shipper Management APIs provide operations to register, retrieve, update, and delete known shipper records associated with a developer account. A known shipper represents a merchant that is authorized and configured for shipping operations within the platform.\n\nThese APIs enable management of known shipper data and status, ensuring that only valid and active shippers are used in shipment processing workflows."}],"sectionId":"/openapi/knownshipper"}],"sectionId":"/openapi/knownshipper"}]}]}},{"type":"group","label":"Known Shipper","link":"/openapi/knownshipper/known-shipper","routeSlug":"/openapi/knownshipper/known-shipper","items":[{"label":"Register Known Shipper","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/knownshipper/known-shipper/registerknownshipper","routeSlug":"/openapi/knownshipper/known-shipper/registerknownshipper","metadata":{"seo":{"title":"Register Known Shipper","description":"This operation registers a merchant as a known shipper."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"registerKnownShipper","name":"Register Known Shipper","isWebhook":false,"pointer":"/paths/~1api~1v1~1shippers~1registration/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register Known Shipper","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation registers a merchant as a known shipper."},{"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/KnownShipperRequest"}},"schemaId":"components/schemas/KnownShipperRequest","pointer":"/paths/~1api~1v1~1shippers~1registration/post/requestBody","description":"Request body to register a merchant as a known shipper."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/shippers/registration","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/KnownShipperRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/shippers/registration","href":"known-shipper/registerknownshipper","openApiOperationId":"registerKnownShipper","summary":"Register Known Shipper"},"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"}],"schemaId":"components/schemas/KnownShipperRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KnownShipperRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchant has been successfully registered.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KnownShipperResponse"}},"schemaId":"components/schemas/KnownShipperResponse"},{"code":"400","description":"Invalid or Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1api~1v1~1shippers~1registration/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KnownShipperResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KnownShipperResponse"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/known-shipper/registerknownshipper"}],"panels":[]}]},"httpPath":"/api/v1/shippers/registration"},{"label":"Update Known Shipper","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/knownshipper/known-shipper/updateknownshipper","routeSlug":"/openapi/knownshipper/known-shipper/updateknownshipper","metadata":{"seo":{"title":"Update Known Shipper","description":"This operation updates details of an existing known shipper. Body must not be empty."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateKnownShipper","name":"Update Known Shipper","isWebhook":false,"pointer":"/paths/~1api~1v1~1shippers~1registration~1{shipperID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Known Shipper","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 details of an existing known shipper."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Body must not be empty."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shipperID","in":"path","schemaId":"schema_267","description":"The unique ID of the known shipper.","required":true}],"pointer":"/paths/~1api~1v1~1shippers~1registration~1{shipperID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KnownShipperUpdateRequest"}},"schemaId":"components/schemas/KnownShipperUpdateRequest","pointer":"/paths/~1api~1v1~1shippers~1registration~1{shipperID}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/shippers/registration/{shipperID}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server"}],"parameters":{"path":[{"name":"shipperID","in":"path","required":true,"schemaId":"schema_267"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/KnownShipperUpdateRequest"}},"responseCodes":["200","400","401","404","500"],"pointer":"/api/v1/shippers/registration/{shipperID}","href":"known-shipper/updateknownshipper","openApiOperationId":"updateKnownShipper","summary":"Update Known Shipper"},"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"}],"schemaId":"components/schemas/KnownShipperUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KnownShipperUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Known shipper details successfully updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KnownShipperUpdateResponse"}},"schemaId":"components/schemas/KnownShipperUpdateResponse"},{"code":"400","description":"Invalid or Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Known Shipper not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1api~1v1~1shippers~1registration~1{shipperID}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KnownShipperUpdateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KnownShipperUpdateResponse"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/known-shipper/updateknownshipper"}],"panels":[]}]},"httpPath":"/api/v1/shippers/registration/{shipperID}"},{"label":"Get Known Shipper","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/knownshipper/known-shipper/getknownshipper","routeSlug":"/openapi/knownshipper/known-shipper/getknownshipper","metadata":{"seo":{"title":"Get Known Shipper","description":"This operation retrieves detailed information about a registered known shipper using their unique ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKnownShipper","name":"Get Known Shipper","isWebhook":false,"pointer":"/paths/~1api~1v1~1shippers~1{shipperID}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Known Shipper","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation retrieves detailed information about a registered known shipper using their unique ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shipperID","in":"path","schemaId":"schema_267","description":"The unique ID of the known shipper.","required":true}],"pointer":"/paths/~1api~1v1~1shippers~1{shipperID}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/shippers/{shipperID}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server"}],"parameters":{"path":[{"name":"shipperID","in":"path","required":true,"schemaId":"schema_267"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/api/v1/shippers/{shipperID}","href":"known-shipper/getknownshipper","openApiOperationId":"getKnownShipper","summary":"Get Known Shipper"},"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Known shipper details successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KnownShipperResponse"}},"schemaId":"components/schemas/KnownShipperResponse"},{"code":"400","description":"Invalid or Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Known Shipper not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1api~1v1~1shippers~1{shipperID}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KnownShipperResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KnownShipperResponse"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/known-shipper/getknownshipper"}],"panels":[]}]},"httpPath":"/api/v1/shippers/{shipperID}"},{"label":"Update Known Shipper State","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/knownshipper/known-shipper/updateknownshipperstate","routeSlug":"/openapi/knownshipper/known-shipper/updateknownshipperstate","metadata":{"seo":{"title":"Update Known Shipper State","description":"This operation change current status of the known shipper valid values are: Active or Inactive."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateKnownShipperState","name":"Update Known Shipper State","isWebhook":false,"pointer":"/paths/~1api~1v1~1shippers~1{shipperID}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Known Shipper State","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 change current status of the known shipper"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" valid values are: Active or Inactive."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shipperID","in":"path","schemaId":"schema_267","description":"The unique identifier of the Known Shipper.","required":true}],"pointer":"/paths/~1api~1v1~1shippers~1{shipperID}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_268","description":"Change the status of the known shipper. Valid values are: Active or Inactive.","required":true}],"pointer":"/paths/~1api~1v1~1shippers~1{shipperID}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/shippers/{shipperID}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server"}],"parameters":{"path":[{"name":"shipperID","in":"path","required":true,"schemaId":"schema_267"}],"query":[{"name":"status","in":"query","required":true,"schemaId":"schema_268"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/api/v1/shippers/{shipperID}","href":"known-shipper/updateknownshipperstate","openApiOperationId":"updateKnownShipperState","summary":"Update Known Shipper State"},"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The known shipper's status has been successfully updated."},{"code":"400","description":"Invalid or Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Known Shipper not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1api~1v1~1shippers~1{shipperID}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/known-shipper/updateknownshipperstate"}],"panels":[]}]},"httpPath":"/api/v1/shippers/{shipperID}"},{"label":"Delete Known Shipper","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/knownshipper/known-shipper/deleteknownshipper","routeSlug":"/openapi/knownshipper/known-shipper/deleteknownshipper","metadata":{"seo":{"title":"Delete Known Shipper","description":"This operation deletes a known shipper using their unique ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteKnownShipper","name":"Delete Known Shipper","isWebhook":false,"pointer":"/paths/~1api~1v1~1shippers~1{shipperID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Known Shipper","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation deletes a known shipper using their unique ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shipperID","in":"path","schemaId":"schema_267","description":"The ID of the known shipper to delete.","required":true}],"pointer":"/paths/~1api~1v1~1shippers~1{shipperID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/shippers/{shipperID}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server"}],"parameters":{"path":[{"name":"shipperID","in":"path","required":true,"schemaId":"schema_267"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/api/v1/shippers/{shipperID}","href":"known-shipper/deleteknownshipper","openApiOperationId":"deleteKnownShipper","summary":"Delete Known Shipper"},"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Known shipper successfully deleted."},{"code":"400","description":"Invalid or Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Known Shipper not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1api~1v1~1shippers~1{shipperID}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/known-shipper/deleteknownshipper"}],"panels":[]}]},"httpPath":"/api/v1/shippers/{shipperID}"}],"content":{"contentType":"group","meta":{"name":"Known Shipper"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Known Shipper","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing known shipper entities. These APIs support operations such as registering a merchant as a known shipper, retrieving shipper details, updating shipper information, modifying shipper status, and deleting shipper records. They enable control over which merchants are authorized and active for shipping operations within the platform."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/shippers/registration","summary":"Register Known Shipper","prefix":{"name":"post","color":"post"},"badges":[],"link":"/known-shipper/registerknownshipper","deprecated":false},{"title":"/api/v1/shippers/registration/{shipperID}","summary":"Update Known Shipper","prefix":{"name":"put","color":"put"},"badges":[],"link":"/known-shipper/updateknownshipper","deprecated":false},{"title":"/api/v1/shippers/{shipperID}","summary":"Get Known Shipper","prefix":{"name":"get","color":"get"},"badges":[],"link":"/known-shipper/getknownshipper","deprecated":false},{"title":"/api/v1/shippers/{shipperID}","summary":"Update Known Shipper State","prefix":{"name":"put","color":"put"},"badges":[],"link":"/known-shipper/updateknownshipperstate","deprecated":false},{"title":"/api/v1/shippers/{shipperID}","summary":"Delete Known Shipper","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/known-shipper/deleteknownshipper","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/KnownShipperRequest":{"id":"components/schemas/KnownShipperRequest","kind":"json-schema","title":"KnownShipperRequest","data":{"type":"object","required":["addressLine1","cityTown","stateProvince","postalCode","countryCode","phone","carrierAccountId","email","company"],"properties":{"addressLine1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 50"},"children":[]}]}]}],"example":"1234 Elm Street"},"addressLine2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine2 contains the Area or Street Name. This is an optional field. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 50"},"children":[]}]}]}],"example":"Suite 567"},"addressLine3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine3 contains other details for easy reach, e.g. Landmark. This is an optional field. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 50"},"children":[]}]}]}],"example":"Building A"},"cityTown":{"type":"string","description":"The name of the city or town the merchant's address belongs to.","example":"San Francisco"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the State or Province the merchant belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US address(es)."},"children":[]}]}]}],"example":"CA"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code or ZIP Code of the address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For US addresses, use only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code. If it is 5 digit code then pass four zeros (0000)"},"children":[]}]}]}],"example":"941056743"},"countryCode":{"type":"string","description":"The country in which the merchant's address is located.","example":"US"},"name":{"type":"string","description":"Name of the merchant you want to register as a known shipper.","example":"John Doe"},"company":{"type":"string","description":"The name of the company, in case if the merchant address is not residential.","example":"PB"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is merchant's phone number. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1234512343"},"carrierAccountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier assigned to the specific carrier account. Its value can be referred from the response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carrier Accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}],"example":"34jdsS81Kmp"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be merchant's valid email address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 50"},"children":[]}]}]}],"example":"johndoe@yopmail.com"}}}},"components/schemas/KnownShipperUpdateRequest":{"id":"components/schemas/KnownShipperUpdateRequest","kind":"json-schema","title":"KnownShipperUpdateRequest","data":{"type":"object","description":"This is the request body for updating known shipper details against the shipperID.","properties":{"addressLine1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 50"},"children":[]}]}]}],"example":"1236 Elm Street"},"addressLine2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine2 contains the Area or Street Name. This is an optional field. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 50"},"children":[]}]}]}],"example":"Suite 367"},"addressLine3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine3 contains other details for easy reach, e.g. Landmark. This is an optional field. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 50"},"children":[]}]}]}],"example":"Building B"},"cityTown":{"type":"string","description":"The name of the city or town the merchant's address belongs to.","example":"San Francisco"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the State or Province the merchant belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US address(es)."},"children":[]}]}]}],"example":"UT"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code or ZIP Code of the address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For US addresses, use only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code."},"children":[]}]}]}],"example":"941056743"},"countryCode":{"type":"string","description":"The country in which the merchant's address is located.","example":"US"},"name":{"type":"string","description":"Name of the merchant you want to register as a known shipper.","example":"John Doe"},"company":{"type":"string","description":"The name of the company, in case if the merchant address is not residential.","example":"PB"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is merchant's phone number. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1234512343"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be merchant's valid email address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 50"},"children":[]}]}]}],"example":"johndoe@yopmail.com"}}}},"components/schemas/KnownShipperResponse":{"id":"components/schemas/KnownShipperResponse","kind":"json-schema","title":"KnownShipperResponse","data":{"type":"object","properties":{"shipperID":{"type":"string","description":"A unique ID is generated for a merchant when they register as a known shipper. This ID is used for all future operations related to this known shipper","example":"2000083071"},"addressLine1":{"type":"string","description":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender.","example":"1234 Elm Street"},"addressLine2":{"type":"string","description":"The addressLine2 contains the Area or Street Name. This is an optional field.","example":"Suite 567"},"addressLine3":{"type":"string","description":"The addressLine3 contains other details for easy reach, e.g. Landmark.","example":"Building A"},"cityTown":{"type":"string","description":"The name of the city or town the merchant's address belongs to.","example":"San Francisco"},"stateProvince":{"type":"string","description":"The name of the State or Province the merchant belongs to.","example":"CA"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address.","example":"941056743"},"countryCode":{"type":"string","description":"The country in which the merchant's address is located.","example":"US"},"name":{"type":"string","description":"Name of the merchant registered as a known shipper.","example":"John Doe"},"company":{"type":"string","description":"The name of the company, in case if the merchant address is not residential.","example":"PB"},"phone":{"type":"string","description":"This is known shipper's phone number.","example":"1234512343"},"carrierAccountId":{"type":"string","description":"A unique identifier assigned to the specific carrier account.","example":"34jdsS81Kmp"},"email":{"type":"string","description":"This is known-shippers's valid email address."},"status":{"type":"string","enum":["new","updated","withdrawn"],"example":"new","description":"This indicates the status for the operation."}}}},"components/schemas/KnownShipperUpdateResponse":{"id":"components/schemas/KnownShipperUpdateResponse","kind":"json-schema","title":"KnownShipperUpdateResponse","data":{"type":"object","properties":{"shipperID":{"type":"string","description":"A unique ID is generated for a merchant when they register as a known shipper. This ID is used for all future operations related to this known shipper","example":"2000083071"},"addressLine1":{"type":"string","description":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender.","example":"1234 Elm Street"},"addressLine2":{"type":"string","description":"The addressLine2 contains the Area or Street Name. This is an optional field.","example":"Suite 567"},"addressLine3":{"type":"string","description":"The addressLine3 contains other details for easy reach, e.g. Landmark.","example":"Building A"},"cityTown":{"type":"string","description":"The name of the city or town the merchant's address belongs to.","example":"San Francisco"},"stateProvince":{"type":"string","description":"The name of the State or Province the merchant belongs to.","example":"CA"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address.","example":"941056743"},"countryCode":{"type":"string","description":"The country in which the merchant's address is located.","example":"US"},"name":{"type":"string","description":"Name of the merchant registered as a known shipper.","example":"John Doe"},"company":{"type":"string","description":"The name of the company, in case if the merchant address is not residential.","example":"PB"},"phone":{"type":"string","description":"This is known shipper's phone number.","example":"1234512343"},"email":{"type":"string","description":"This is known-shippers's valid email address."},"status":{"type":"string","enum":["new","updated","withdrawn"],"example":"updated","description":"This indicates the status for the operation."}}}},"components/schemas/KnownShipperDeleteResponse":{"id":"components/schemas/KnownShipperDeleteResponse","kind":"json-schema","title":"KnownShipperDeleteResponse","data":{"type":"object","properties":{"shipperID":{"type":"string","description":"A unique ID is generated for a merchant when they register as a known shipper. This ID is used for all future operations related to this known shipper","example":"2000083071"},"addressLine1":{"type":"string","description":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender.","example":"1234 Elm Street"},"addressLine2":{"type":"string","description":"The addressLine2 contains the Area or Street Name. This is an optional field.","example":"Suite 567"},"addressLine3":{"type":"string","description":"The addressLine3 contains other details for easy reach, e.g. Landmark.","example":"Building A"},"cityTown":{"type":"string","description":"The name of the city or town the merchant's address belongs to.","example":"San Francisco"},"stateProvince":{"type":"string","description":"The name of the State or Province the merchant belongs to.","example":"CA"},"postalCode":{"type":"string","description":"The Postal Code or ZIP Code of the address.","example":"941056743"},"countryCode":{"type":"string","description":"The country in which the merchant's address is located.","example":"US"},"name":{"type":"string","description":"Name of the merchant registered as a known shipper.","example":"John Doe"},"company":{"type":"string","description":"The name of the company, in case if the merchant address is not residential.","example":"PB"},"phone":{"type":"string","description":"This is known shipper's phone number.","example":"1234512343"},"email":{"type":"string","description":"This is known-shippers's valid email address."},"status":{"type":"string","enum":["new","updated","withdrawn"],"example":"withdrawn","description":"This indicates the status of the known shipper."}}}},"components/schemas/KnownShipperRegistrationResponse":{"id":"components/schemas/KnownShipperRegistrationResponse","kind":"json-schema","title":"KnownShipperRegistrationResponse","data":{"type":"object","properties":{"response":{"type":"object","properties":{"id":{"type":"string","description":"A unique ID generated for the merchant.","example":"2000083756"},"productType":{"type":"string","description":"Type of product associated with the merchant.","example":"XXXPro"},"created":{"type":"string","format":"date-time","description":"The date and time when the merchant was created.","example":"2024-09-30T06:24:44.97048"},"modified":{"type":"string","format":"date-time","description":"The date and time when the merchant was last modified.","example":"2024-09-30T06:24:44.97048"},"sentToFusion":{"type":"boolean","description":"Indicates whether the information was sent to Fusion.","example":false},"dateSentToFusion":{"type":"string","format":"date-time","description":"The date and time when the information was sent to Fusion.","example":"0001-01-01T00:00:00"},"recordStatus":{"type":"string","description":"The current status of the regustration record.","example":"New"},"statusUpdatedOn":{"type":"string","format":"date-time","description":"The date and time when the status was last updated.","example":"2019-03-11T18:29:54.246728"},"contactName":{"type":"string","description":"The name of the contact person for the merchant.","example":"Ambuj Singh"},"companyName":{"type":"string","description":"The name of the company associated with the merchant.","example":"Pitney Bowes"},"addressLine1":{"type":"string","description":"The first line of the address, which may include building number and street name.","example":"24182 Kathy Ave"},"addressLine2":{"type":"string","description":"The second line of the address, such as suite or apartment number.","example":"Abc"},"addressLine3":{"type":"string","description":"The third line of the address, such as additional details or landmarks.","example":"XYZ"},"city":{"type":"string","description":"The city of the merchant's address.","example":"Lake Forest"},"state":{"type":"string","description":"The state or province of the merchant's address.","example":"UP"},"zip":{"type":"string","description":"The postal code of the merchant's address.","example":"926301827"},"contactPhone":{"type":"string","description":"The contact phone number for the merchant.","example":"1234512343"},"contactEmail":{"type":"string","description":"The contact email address for the merchant.","example":"xxxx.singh@pb.com"},"shipToBpn":{"type":"string","description":".... Can be null if not assigned.","example":null}}},"errors":{"type":"array","description":"An array of error messages, if any.","items":{"type":"string","example":null}}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining the issue."}},"required":["message"]}},"schema_267":{"kind":"json-schema","data":{"type":"string"},"id":"schema_267"},"schema_268":{"kind":"json-schema","data":{"type":"string","enum":["active","inactive"]},"id":"schema_268"}},"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"}]},"options":{"hideDownloadButtons":false,"hideInfoMetadata":true,"jsonSamplesExpandLevel":3,"layout":"three-panel","schemasExpansionLevel":2,"expandResponses":"all","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/knownshipper.json?download"},{"url":"/_bundle/openapi/knownshipper.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Known Shipper APIs","description":"The Known Shipper Management APIs provide operations to register, retrieve, update, and delete known shipper records associated with a developer account. A known shipper represents a merchant that is authorized and configured for shipping operations within the platform.\n\nThese APIs enable management of known shipper data and status, ensuring that only valid and active shippers are used in shipment processing workflows.\n"}},"baseSlug":"/openapi/knownshipper","routesMapping":{}}