{"items":[{"type":"link","label":"Carrier Onbording APIs","link":"/openapi/carrieraccounts","routeSlug":"/openapi/carrieraccounts","content":{"contentType":"overview","meta":{"name":"Carrier Onbording APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"carrieraccounts.json","url":"/_bundle/openapi/carrieraccounts.json?download"},{"kind":"download","label":"carrieraccounts.yaml","url":"/_bundle/openapi/carrieraccounts.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/carrieraccountmgmt"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Sandbox Server for Carrier Account"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/metadata","description":"Sandbox Server for Hub API"},{"url":"https://api.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Production Server for Carrier Account (uses live data)"},{"url":"https://api.sendpro360.pitneybowes.com/metadata","description":"Production Server for Hub API (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":"Carrier Onbording APIs (0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Carrier Accounts APIs provide capabilities to onboard and manage carrier accounts used for shipment processing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" These services include creating and maintaining carrier accounts, configuring carrier-specific details and capabilities, and retrieving supporting hub information for applicable carriers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Carrier accounts enable authentication with carriers and are required for rating, shipment creation, and label generation."},"children":[]}]}]}]}],"sectionId":"/openapi/carrieraccounts"}],"sectionId":"/openapi/carrieraccounts"}]}]}},{"type":"group","label":"Carrier Accounts","link":"/openapi/carrieraccounts/carrier-accounts","routeSlug":"/openapi/carrieraccounts/carrier-accounts","items":[{"label":"Add Carrier","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/carrieraccounts/carrier-accounts/addcarrieraccount","routeSlug":"/openapi/carrieraccounts/carrier-accounts/addcarrieraccount","metadata":{"seo":{"title":"Add Carrier","description":"Add Carrier Account API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addCarrierAccount","name":"Add Carrier","isWebhook":false,"pointer":"/paths/~1api~1v1~1carrierAccounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Carrier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add Carrier Account API"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_246","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_246","description":"This header is required when onboarding a carrier belongs to a locarion other than the developer's default location.\n"}],"pointer":"/paths/~1api~1v1~1carrierAccounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCarrierAccountRequest"}},"schemaId":"components/schemas/CreateCarrierAccountRequest","pointer":"/paths/~1api~1v1~1carrierAccounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/carrierAccounts","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Sandbox Server for Carrier Account"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/metadata","description":"Sandbox Server for Hub API"},{"url":"https://api.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Production Server for Carrier Account (uses live data)"},{"url":"https://api.sendpro360.pitneybowes.com/metadata","description":"Production Server for Hub API (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_246"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_246"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCarrierAccountRequest"}},"responseCodes":["200","400","401"],"pointer":"/api/v1/carrierAccounts","href":"carrier-accounts/addcarrieraccount","openApiOperationId":"addCarrierAccount","summary":"Add Carrier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Sandbox Server for Carrier Account"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/metadata","description":"Sandbox Server for Hub API"},{"url":"https://api.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Production Server for Carrier Account (uses live data)"},{"url":"https://api.sendpro360.pitneybowes.com/metadata","description":"Production Server for Hub API (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/CreateCarrierAccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCarrierAccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Carrier Added Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateCarrierAccountResponse"}},"schemaId":"components/schemas/CreateCarrierAccountResponse"},{"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"}],"pointer":"/paths/~1api~1v1~1carrierAccounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateCarrierAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateCarrierAccountResponse"}}},{"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"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/carrier-accounts/addcarrieraccount"}],"panels":[]}]},"httpPath":"/api/v1/carrierAccounts"},{"label":"Update Carrier","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/carrieraccounts/carrier-accounts/updatecarrieraccount","routeSlug":"/openapi/carrieraccounts/carrier-accounts/updatecarrieraccount","metadata":{"seo":{"title":"Update Carrier","description":"The Update Carrier operation enables you to update a carrier account and specifies its usable capabilities. By default, all available services, parcel types, and special services provided by the carrier are accessible. With this API, you can specify only the capabilities (services, parcel types, special services) that should be available for Rate Shop and Create Shipment operations. If a shipment request attempts to use a capability not enabled through this API, an error will be returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCarrierAccount","name":"Update Carrier","isWebhook":false,"pointer":"/paths/~1api~1v1~1carrierAccounts~1{carrierAccountID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Carrier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Update Carrier operation enables you to update a carrier account and specifies its usable capabilities. By default, all available services, parcel types, and special services provided by the carrier are accessible. With this API, you can specify only the capabilities (services, parcel types, special services) that should be available for Rate Shop and Create Shipment operations. If a shipment request attempts to use a capability not enabled through this API, an error will be returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"carrierAccountID","in":"path","schemaId":"schema_246","description":"Unique identifier of carrier account created","required":true}],"pointer":"/paths/~1api~1v1~1carrierAccounts~1{carrierAccountID}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_246"}],"pointer":"/paths/~1api~1v1~1carrierAccounts~1{carrierAccountID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCarrierAccountRequest"}},"schemaId":"components/schemas/UpdateCarrierAccountRequest","pointer":"/paths/~1api~1v1~1carrierAccounts~1{carrierAccountID}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/carrierAccounts/{carrierAccountID}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Sandbox Server for Carrier Account"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/metadata","description":"Sandbox Server for Hub API"},{"url":"https://api.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Production Server for Carrier Account (uses live data)"},{"url":"https://api.sendpro360.pitneybowes.com/metadata","description":"Production Server for Hub API (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":"carrierAccountID","in":"path","required":true,"schemaId":"schema_246"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_246"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCarrierAccountRequest"}},"responseCodes":["200","400","401"],"pointer":"/api/v1/carrierAccounts/{carrierAccountID}","href":"carrier-accounts/updatecarrieraccount","openApiOperationId":"updateCarrierAccount","summary":"Update Carrier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Sandbox Server for Carrier Account"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/metadata","description":"Sandbox Server for Hub API"},{"url":"https://api.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Production Server for Carrier Account (uses live data)"},{"url":"https://api.sendpro360.pitneybowes.com/metadata","description":"Production Server for Hub API (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/UpdateCarrierAccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCarrierAccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Carrier Added Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateCarrierAccountResponse"}},"schemaId":"components/schemas/UpdateCarrierAccountResponse"},{"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"}],"pointer":"/paths/~1api~1v1~1carrierAccounts~1{carrierAccountID}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateCarrierAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateCarrierAccountResponse"}}},{"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"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/carrier-accounts/updatecarrieraccount"}],"panels":[]}]},"httpPath":"/api/v1/carrierAccounts/{carrierAccountID}"},{"label":"Get Carrier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/carrieraccounts/carrier-accounts/getcarrieraccount","routeSlug":"/openapi/carrieraccounts/carrier-accounts/getcarrieraccount","metadata":{"seo":{"title":"Get Carrier","description":"Get Carrier Account details API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCarrierAccount","name":"Get Carrier","isWebhook":false,"pointer":"/paths/~1api~1v1~1carrierAccounts~1{carrierAccountID}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Carrier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Carrier Account details API"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"carrierAccountID","in":"path","schemaId":"schema_246","description":"Unique identifier of carrier account created","required":true}],"pointer":"/paths/~1api~1v1~1carrierAccounts~1{carrierAccountID}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_246"}],"pointer":"/paths/~1api~1v1~1carrierAccounts~1{carrierAccountID}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/carrierAccounts/{carrierAccountID}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Sandbox Server for Carrier Account"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/metadata","description":"Sandbox Server for Hub API"},{"url":"https://api.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Production Server for Carrier Account (uses live data)"},{"url":"https://api.sendpro360.pitneybowes.com/metadata","description":"Production Server for Hub API (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":"carrierAccountID","in":"path","required":true,"schemaId":"schema_246"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_246"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/api/v1/carrierAccounts/{carrierAccountID}","href":"carrier-accounts/getcarrieraccount","openApiOperationId":"getCarrierAccount","summary":"Get Carrier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Sandbox Server for Carrier Account"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/metadata","description":"Sandbox Server for Hub API"},{"url":"https://api.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Production Server for Carrier Account (uses live data)"},{"url":"https://api.sendpro360.pitneybowes.com/metadata","description":"Production Server for Hub API (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":"Carrier Added Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateCarrierAccountResponse"}},"schemaId":"components/schemas/CreateCarrierAccountResponse"},{"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"}],"pointer":"/paths/~1api~1v1~1carrierAccounts~1{carrierAccountID}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateCarrierAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateCarrierAccountResponse"}}},{"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"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/carrier-accounts/getcarrieraccount"}],"panels":[]}]},"httpPath":"/api/v1/carrierAccounts/{carrierAccountID}"},{"label":"Delete Carrier","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/carrieraccounts/carrier-accounts/deletecarrieraccount","routeSlug":"/openapi/carrieraccounts/carrier-accounts/deletecarrieraccount","metadata":{"seo":{"title":"Delete Carrier","description":"Delete Carrier Account API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCarrierAccount","name":"Delete Carrier","isWebhook":false,"pointer":"/paths/~1api~1v1~1carrierAccounts~1{carrierAccountID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Carrier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete Carrier Account API"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"carrierAccountID","in":"path","schemaId":"schema_246","description":"Unique identifier of carrier account created","required":true}],"pointer":"/paths/~1api~1v1~1carrierAccounts~1{carrierAccountID}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_246"}],"pointer":"/paths/~1api~1v1~1carrierAccounts~1{carrierAccountID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/carrierAccounts/{carrierAccountID}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Sandbox Server for Carrier Account"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/metadata","description":"Sandbox Server for Hub API"},{"url":"https://api.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Production Server for Carrier Account (uses live data)"},{"url":"https://api.sendpro360.pitneybowes.com/metadata","description":"Production Server for Hub API (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":"carrierAccountID","in":"path","required":true,"schemaId":"schema_246"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_246"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/api/v1/carrierAccounts/{carrierAccountID}","href":"carrier-accounts/deletecarrieraccount","openApiOperationId":"deleteCarrierAccount","summary":"Delete Carrier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Sandbox Server for Carrier Account"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/metadata","description":"Sandbox Server for Hub API"},{"url":"https://api.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Production Server for Carrier Account (uses live data)"},{"url":"https://api.sendpro360.pitneybowes.com/metadata","description":"Production Server for Hub API (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":"Carrier Updated 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"}],"pointer":"/paths/~1api~1v1~1carrierAccounts~1{carrierAccountID}/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"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/carrier-accounts/deletecarrieraccount"}],"panels":[]}]},"httpPath":"/api/v1/carrierAccounts/{carrierAccountID}"},{"label":"Get FedEx Smartpost hub details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/carrieraccounts/carrier-accounts/getfedexsmartposthubdetails","routeSlug":"/openapi/carrieraccounts/carrier-accounts/getfedexsmartposthubdetails","metadata":{"seo":{"title":"Get FedEx Smartpost hub details","description":"Get FedEx Smartpost hub details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFedexSmartpostHubDetails","name":"Get FedEx Smartpost hub details","isWebhook":false,"pointer":"/paths/~1api~1v1~1hubs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get FedEx Smartpost hub details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get FedEx Smartpost hub details"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/hubs","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Sandbox Server for Carrier Account"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/metadata","description":"Sandbox Server for Hub API"},{"url":"https://api.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Production Server for Carrier Account (uses live data)"},{"url":"https://api.sendpro360.pitneybowes.com/metadata","description":"Production Server for Hub API (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":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/hubs","href":"carrier-accounts/getfedexsmartposthubdetails","openApiOperationId":"getFedexSmartpostHubDetails","summary":"Get FedEx Smartpost hub details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Sandbox Server for Carrier Account"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/metadata","description":"Sandbox Server for Hub API"},{"url":"https://api.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Production Server for Carrier Account (uses live data)"},{"url":"https://api.sendpro360.pitneybowes.com/metadata","description":"Production Server for Hub API (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":"Get FedEx SmartPost hub details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_247"}},"schemaId":"schema_247"},{"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"}],"pointer":"/paths/~1api~1v1~1hubs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_247","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_247"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/carrier-accounts/getfedexsmartposthubdetails"}],"panels":[]}]},"httpPath":"/api/v1/hubs"}],"content":{"contentType":"group","meta":{"name":"Carrier Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Carrier Accounts","showPageActions":true},{"nodeType":"markdoc","content":"APIs to create, retrieve, update, and delete carrier accounts, and to retrieve supporting hub details required for specific carriers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/carrierAccounts","summary":"Add Carrier","prefix":{"name":"post","color":"post"},"badges":[],"link":"/carrier-accounts/addcarrieraccount","deprecated":false},{"title":"/api/v1/carrierAccounts/{carrierAccountID}","summary":"Update Carrier","prefix":{"name":"put","color":"put"},"badges":[],"link":"/carrier-accounts/updatecarrieraccount","deprecated":false},{"title":"/api/v1/carrierAccounts/{carrierAccountID}","summary":"Get Carrier","prefix":{"name":"get","color":"get"},"badges":[],"link":"/carrier-accounts/getcarrieraccount","deprecated":false},{"title":"/api/v1/carrierAccounts/{carrierAccountID}","summary":"Delete Carrier","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/carrier-accounts/deletecarrieraccount","deprecated":false},{"title":"/api/v1/hubs","summary":"Get FedEx Smartpost hub details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/carrier-accounts/getfedexsmartposthubdetails","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CreateCarrierAccountRequest":{"id":"components/schemas/CreateCarrierAccountRequest","kind":"json-schema","title":"CreateCarrierAccountRequest","data":{"type":"object","properties":{"accountNumber":{"type":"string","description":"Unique identifier of the account","example":"123338"},"carrierID":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It defines the carrier ID, can be get from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carriers API"},"children":[]}]}]}],"example":"FEDEX","enum":["FEDEX","UPS","DHLEXP","SPEEDEE","NORATE"]},"description":{"type":"string","description":"It defines the carrier account name","example":"FedEx Account"},"parameters":{"type":"object","description":"It lists the additional details required adding carrier account","properties":{"username":{"type":"string","description":"Username for the account, required for DHL Express","example":"abcjsk"},"password":{"type":"string","description":"Password for the account, required for DHL Express","example":"*******"},"accountAddress":{"type":"object","description":"It includes the account address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Watervw Dr"},"city":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"shelton"},"state":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"postalCode":{"type":"string","description":"The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484"},"countryCode":{"type":"string","description":"This indicates the two-character ISO code of the source country from the ISO country list.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":""},"company":{"type":"string","description":"This indicates the name of the company, in case if  address is not residential.","example":""},"name":{"type":"string","description":"Name of the sender to which this address points.","example":""},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum characters for Phone number is 10 digits. ","example":""}}},"contactAddress":{"type":"object","description":"It includes the contact address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Watervw Dr"},"city":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"shelton"},"state":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"postalCode":{"type":"string","description":"The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484"},"countryCode":{"type":"string","description":"This indicates the two-character ISO code of the source country from the ISO country list.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":""},"company":{"type":"string","description":"This indicates the name of the company, in case if  address is not residential.","example":""},"name":{"type":"string","description":"Name of the sender to which this address points.","example":""},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum characters for Phone number is 10 digits. ","example":""}}},"hubID":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It defines FedEx Smartpost hub ID, required only for FedEx Smartpost account, it can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get FedEx Smartpost hub details"},"children":[]}]}]}],"example":"1544"},"invoiceAmount":{"type":"string","description":"It defines the invoice amount ,Only for UPS acccount","example":"2121"},"invoiceControlID":{"type":"string","description":"It defines the invoice controlID ,Only for UPS acccount","example":"123D"},"invoiceDate":{"type":"string","description":"It defines the date of the invoice in the format YYYYMMDD., Only for UPS account","example":"20201203"},"invoiceNumber":{"type":"string","description":"It defines the invoice number ,Only for UPS acccount","example":"saas212121"},"hostName":{"type":"string","description":"It is required for SpeeDee. Manifest Details are provided by the carrier and these are required for end-of-day manifesting. Please contact your carrier relationship person for more details","example":"gppprt2ftp-ext.test.com"},"manifestUserId":{"type":"string","description":"It is required for SpeeDee. Manifest Details are provided by the carrier and these are required for end-of-day manifesting. Please contact your carrier relationship person for more details","example":"testuser"},"manifestPassword":{"type":"string","description":"It is required for SpeeDee. Manifest Details are provided by the carrier and these are required for end-of-day manifesting. Please contact your carrier relationship person for more details","example":"testpassword"},"manifestPath":{"type":"string","description":"It is required for SpeeDee. Manifest Details are provided by the carrier and these are required for end-of-day manifesting. Please contact your carrier relationship person for more details","example":"/in"}}}}}},"components/schemas/UpdateCarrierAccountRequest":{"id":"components/schemas/UpdateCarrierAccountRequest","kind":"json-schema","title":"UpdateCarrierAccountRequest","data":{"type":"object","properties":{"accountNumber":{"type":"string","description":"Unique identifier of the account","example":"123338"},"carrierID":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It defines the carrier ID, can be get from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carriers API"},"children":[]}]}]}],"example":"FEDEX","enum":["FEDEX","UPS","DHLEXP","SPEEDEE","NORATE"]},"description":{"type":"string","description":"It defines the carrier account name","example":"FedEx Account"},"parameters":{"type":"object","description":"It lists the additional details required adding carrier account","properties":{"username":{"type":"string","description":"Username for the account, required for DHL Express","example":"abcjsk"},"password":{"type":"string","description":"Password for the account, required for DHL Express","example":"*******"},"accountAddress":{"type":"object","description":"It includes the account address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Watervw Dr"},"city":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"shelton"},"state":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"postalCode":{"type":"string","description":"The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484"},"countryCode":{"type":"string","description":"This indicates the two-character ISO code of the source country from the ISO country list.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":""},"company":{"type":"string","description":"This indicates the name of the company, in case if  address is not residential.","example":""},"name":{"type":"string","description":"Name of the sender to which this address points.","example":""},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum characters for Phone number is 10 digits. ","example":""}}},"contactAddress":{"type":"object","description":"It includes the contact address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Watervw Dr"},"city":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"shelton"},"state":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"postalCode":{"type":"string","description":"The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484"},"countryCode":{"type":"string","description":"This indicates the two-character ISO code of the source country from the ISO country list.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":""},"company":{"type":"string","description":"This indicates the name of the company, in case if  address is not residential.","example":""},"name":{"type":"string","description":"Name of the sender to which this address points.","example":""},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum characters for Phone number is 10 digits. ","example":""}}},"hubID":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It defines FedEx Smartpost hub ID, required only for FedEx Smartpost account, it can be referred from response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get FedEx Smartpost hub details"},"children":[]}]}]}],"example":"1544"},"invoiceAmount":{"type":"string","description":"It defines the invoice amount ,Only for UPS acccount","example":"2121"},"invoiceControlID":{"type":"string","description":"It defines the invoice controlID ,Only for UPS acccount","example":"123D"},"invoiceDate":{"type":"string","description":"It defines the date of the invoice in the format YYYYMMDD., Only for UPS account","example":"20201203"},"invoiceNumber":{"type":"string","description":"It defines the invoice number ,Only for UPS acccount","example":"saas212121"},"hostName":{"type":"string","description":"It is required for SpeeDee. Manifest Details are provided by the carrier and these are required for end-of-day manifesting. Please contact your carrier relationship person for more details","example":"gppprt2ftp-ext.test.com"},"manifestUserId":{"type":"string","description":"It is required for SpeeDee. Manifest Details are provided by the carrier and these are required for end-of-day manifesting. Please contact your carrier relationship person for more details","example":"testuser"},"manifestPassword":{"type":"string","description":"It is required for SpeeDee. Manifest Details are provided by the carrier and these are required for end-of-day manifesting. Please contact your carrier relationship person for more details","example":"testpassword"},"manifestPath":{"type":"string","description":"It is required for SpeeDee. Manifest Details are provided by the carrier and these are required for end-of-day manifesting. Please contact your carrier relationship person for more details","example":"/in"},"capabilities":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the allowed capabilities for this carrier account. By default, all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available services, parcel types, and special services of the carrier are accessible."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify capabilities here, only the selected ones can be used in Rate Shop"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and Create Shipment APIs. Any attempt to use capabilities not listed will result in an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Support for this capability in the Create Shipment API is under active development. It is targeted for this release, but availability and behavior may change before general availability."},"children":[]}]}]}]}],"properties":{"services":{"type":"array","description":"List of enabled services for this carrier account.","items":{"type":"string"},"example":["NDA"]},"parcelTypes":{"type":"array","description":"List of enabled parcel types for this carrier account.","items":{"type":"string"},"example":["LTR"]},"specialServices":{"type":"array","description":"List of enabled special services for this carrier account.","items":{"type":"string"},"example":["INS"]}}}}}}}},"components/schemas/UpdateCarrierAccountResponse":{"id":"components/schemas/UpdateCarrierAccountResponse","kind":"json-schema","title":"UpdateCarrierAccountResponse","data":{"type":"object","properties":{"carrierAccountID":{"type":"string","description":"Unique identifier of carrier account created","example":"abc3849"},"accountNumber":{"type":"string","description":"Unique identifier of the account","example":"123338"},"carrierID":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It defines the carrier ID, can be get from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carriers API"},"children":[]}]}]}],"example":"FEDEX","enum":["FEDEX","UPS","DHLEXP"]},"description":{"type":"string","description":"It defines the carrier account name","example":"FedEx Account"},"carrierAccountType":{"type":"string","description":"This defines carrier account type","example":"Shipping"},"provisioningType":{"type":"string","description":"It defines the provisioning method","example":"API"},"parameters":{"type":"object","description":"It lists the additional details required adding carrier account","properties":{"username":{"type":"string","description":"Username for the account, required for DHL Express","example":"abcjsk"},"accountAddress":{"type":"object","description":"It includes the account address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Watervw Dr"},"city":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"shelton"},"state":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"postalCode":{"type":"string","description":"The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484"},"countryCode":{"type":"string","description":"This indicates the two-character ISO code of the source country from the ISO country list.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":""},"company":{"type":"string","description":"This indicates the name of the company, in case if  address is not residential.","example":""},"name":{"type":"string","description":"Name of the sender to which this address points.","example":""},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum characters for Phone number is 10 digits. ","example":""}}},"contactAddress":{"type":"object","description":"It includes the contact address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Watervw Dr"},"city":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"shelton"},"state":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"postalCode":{"type":"string","description":"The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484"},"countryCode":{"type":"string","description":"This indicates the two-character ISO code of the source country from the ISO country list.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":""},"company":{"type":"string","description":"This indicates the name of the company, in case if  address is not residential.","example":""},"name":{"type":"string","description":"Name of the sender to which this address points.","example":""},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum characters for Phone number is 10 digits. ","example":""}}},"hubID":{"type":"string","description":"It defines FedEx Smartpost hub ID, required only for FedEx Smartpost account","example":"1544"},"invoiceAmount":{"type":"string","description":"It defines the invoice amount ,Only for UPS acccount","example":"2121"},"invoiceControlID":{"type":"string","description":"It defines the invoice controlID ,Only for UPS acccount","example":"123D"},"invoiceDate":{"type":"string","description":"It defines the date of the invoice in the format YYYYMMDD., Only for UPS account","example":"20201203"},"invoiceNumber":{"type":"string","description":"It defines the invoice number ,Only for UPS acccount","example":"saas212121"},"capabilities":{"type":"object","description":"The allowed capabilities added for this carrier account.\n","properties":{"services":{"type":"array","description":"List of enabled services added to this carrier account.","items":{"type":"string"},"example":["NDA"]},"parcelTypes":{"type":"array","description":"List of enabled parcel types added to this carrier account.","items":{"type":"string"},"example":["LTR"]},"specialServices":{"type":"array","description":"List of enabled special services added to this carrier account.","items":{"type":"string"},"example":["INS"]}}}}},"permission":{"type":"object","description":"Permission details that define access control for this carrier account.\n","properties":{"permissionByEntity":{"type":"string","nullable":true,"description":"Entity or scope for which the permission applies.","example":"ORG"},"permissionByValue":{"type":"string","nullable":true,"description":"Specific value tied to the entity that determines permission. Can be null if not applicable.\n","example":"12345"}}}}}},"components/schemas/CreateCarrierAccountResponse":{"id":"components/schemas/CreateCarrierAccountResponse","kind":"json-schema","title":"CreateCarrierAccountResponse","data":{"type":"object","properties":{"carrierAccountID":{"type":"string","description":"Unique identifier of carrier account created","example":"abc3849"},"accountNumber":{"type":"string","description":"Unique identifier of the account","example":"123338"},"carrierID":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It defines the carrier ID, can be get from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carriers API"},"children":[]}]}]}],"example":"FEDEX","enum":["FEDEX","UPS","DHLEXP"]},"description":{"type":"string","description":"It defines the carrier account name","example":"FedEx Account"},"carrierAccountType":{"type":"string","description":"This defines carrier account type","example":"Shipping"},"provisioningType":{"type":"string","description":"It defines the provisioning method","example":"API"},"parameters":{"type":"object","description":"It lists the additional details required adding carrier account","properties":{"username":{"type":"string","description":"Username for the account, required for DHL Express","example":"abcjsk"},"accountAddress":{"type":"object","description":"It includes the account address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Watervw Dr"},"city":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"shelton"},"state":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"postalCode":{"type":"string","description":"The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484"},"countryCode":{"type":"string","description":"This indicates the two-character ISO code of the source country from the ISO country list.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":""},"company":{"type":"string","description":"This indicates the name of the company, in case if  address is not residential.","example":""},"name":{"type":"string","description":"Name of the sender to which this address points.","example":""},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum characters for Phone number is 10 digits. ","example":""}}},"contactAddress":{"type":"object","description":"It includes the contact address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Watervw Dr"},"city":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"shelton"},"state":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"postalCode":{"type":"string","description":"The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484"},"countryCode":{"type":"string","description":"This indicates the two-character ISO code of the source country from the ISO country list.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":""},"company":{"type":"string","description":"This indicates the name of the company, in case if  address is not residential.","example":""},"name":{"type":"string","description":"Name of the sender to which this address points.","example":""},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum characters for Phone number is 10 digits. ","example":""}}},"hubID":{"type":"string","description":"It defines FedEx Smartpost hub ID, required only for FedEx Smartpost account","example":"1544"},"invoiceAmount":{"type":"string","description":"It defines the invoice amount ,Only for UPS acccount","example":"2121"},"invoiceControlID":{"type":"string","description":"It defines the invoice controlID ,Only for UPS acccount","example":"123D"},"invoiceDate":{"type":"string","description":"It defines the date of the invoice in the format YYYYMMDD., Only for UPS account","example":"20201203"},"invoiceNumber":{"type":"string","description":"It defines the invoice number ,Only for UPS acccount","example":"saas212121"}}}}}},"components/schemas/GetCarrierAccountResponse":{"id":"components/schemas/GetCarrierAccountResponse","kind":"json-schema","title":"GetCarrierAccountResponse","data":{"type":"object","properties":{"carrierAccountID":{"type":"string","description":"Unique identifier of carrier account created","example":"abc3849"},"accountNumber":{"type":"string","description":"Unique identifier of the account","example":"123338"},"carrierID":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It defines the carrier ID, can be get from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get Carriers API"},"children":[]}]}]}],"example":"FEDEX","enum":["FEDEX","UPS","DHLEXP"]},"description":{"type":"string","description":"It defines the carrier account name","example":"FedEx Account"},"carrierAccountType":{"type":"string","description":"This defines carrier account type","example":"Shipping"},"provisioningType":{"type":"string","description":"It defines the provisioning method","example":"API"},"parameters":{"type":"object","description":"It lists the additional details required adding carrier account","properties":{"username":{"type":"string","description":"Username for the account, required for DHL Express","example":"abcjsk"},"accountAddress":{"type":"object","description":"It includes the account address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Watervw Dr"},"city":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"shelton"},"state":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"postalCode":{"type":"string","description":"The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484"},"countryCode":{"type":"string","description":"This indicates the two-character ISO code of the source country from the ISO country list.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":""},"company":{"type":"string","description":"This indicates the name of the company, in case if  address is not residential.","example":""},"name":{"type":"string","description":"Name of the sender to which this address points.","example":""},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum characters for Phone number is 10 digits. ","example":""}}},"contactAddress":{"type":"object","description":"It includes the contact address details","properties":{"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Watervw Dr"},"city":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"shelton"},"state":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"},"postalCode":{"type":"string","description":"The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":"06484"},"countryCode":{"type":"string","description":"This indicates the two-character ISO code of the source country from the ISO country list.","example":"US"},"email":{"type":"string","description":"The email address of the sender. It can be person's email address or company email address (for non-residential).","example":""},"company":{"type":"string","description":"This indicates the name of the company, in case if  address is not residential.","example":""},"name":{"type":"string","description":"Name of the sender to which this address points.","example":""},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum characters for Phone number is 10 digits. ","example":""}}},"hubID":{"type":"string","description":"It defines FedEx Smartpost hub ID, required only for FedEx Smartpost account","example":"1544"},"invoiceAmount":{"type":"string","description":"It defines the invoice amount ,Only for UPS acccount","example":"2121"},"invoiceControlID":{"type":"string","description":"It defines the invoice controlID ,Only for UPS acccount","example":"123D"},"invoiceDate":{"type":"string","description":"It defines the date of the invoice in the format YYYYMMDD., Only for UPS account","example":"20201203"},"invoiceNumber":{"type":"string","description":"It defines the invoice number ,Only for UPS acccount","example":"saas212121"}}}}}},"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"type":"object","properties":{"message":{"type":"string","example":"Unauthorized","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","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code(s) that appear due to HTTP  400- Invalid or Bad Request, e.g. validation-error.","example":"validation_error"},"errorDescription":{"type":"string","description":"The HTTP 400 Bad Request response status code indicates that the server cannot process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","example":"Error while getting rates for carrier with carrierAccount eRMnRx4mzPP."},"additionalCode":{"type":"string","description":"A unique identifier for the error, for example 1101055, 0100008, or 1021126."},"additionalInfo":{"type":"string","description":"This is an additional information about the error. This error 'Invalid Request' might appear due to invalid dimension, weight, or serviceid, or if the information is missing."},"additionalParameters":{"type":"array","items":{"type":"string","description":"The field(s) that might be incorrect in the request."}}}}}}}},"components/schemas/NotFoundErrors":{"id":"components/schemas/NotFoundErrors","kind":"json-schema","title":"NotFoundErrors","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code(s) that appear due to HTTP 404 Page or File not found","example":"not_found"},"errorDescription":{"type":"string","description":"The HTTP 404 Not Found response status code indicates that the server cannot find the requested resource.","example":"resource not found."},"additionalCode":{"type":"string","description":"A unique identifier for the error, for example 1101055, 0100008, or 1021126."},"additionalInfo":{"type":"string","description":"This is an additional information about the error. This error 'Invalid Request' might appear due to invalid dimension, weight, or serviceid, or if the information is missing."},"additionalParameters":{"type":"array","items":{"type":"string","description":"The field(s) that might be incorrect in the request."}}}}}}}},"schema_246":{"kind":"json-schema","data":{"type":"string"},"id":"schema_246"},"schema_247":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"carrierID":{"type":"string","description":"it displays the carrier Id","example":"FEDEX"},"countryCode":{"type":"string","description":"it displays country code","example":"US"},"hubID":{"type":"string","description":"it displays hubID of SmartPost","example":"5185"},"name":{"type":"string","description":"it displays hub name","example":"5185 ALPA Allentown"}}},"example":[{"carrierID":"FEDEX","countryCode":"US","hubID":"5185","name":"5185 ALPA Allentown"},{"carrierID":"FEDEX","countryCode":"US","hubID":"5303","name":"5303 ATGA Atlanta"}]},"id":"schema_247"}},"exampleStore":{},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic"},"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Sandbox Server for Carrier Account"},{"url":"https://api-sandbox.sendpro360.pitneybowes.com/metadata","description":"Sandbox Server for Hub API"},{"url":"https://api.sendpro360.pitneybowes.com/carrieraccountmgmt","description":"Production Server for Carrier Account (uses live data)"},{"url":"https://api.sendpro360.pitneybowes.com/metadata","description":"Production Server for Hub API (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/carrieraccounts.json?download"},{"url":"/_bundle/openapi/carrieraccounts.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Carrier Onbording APIs","description":"The Carrier Accounts APIs provide capabilities to onboard and manage carrier accounts used for shipment processing.<br/> These services include creating and maintaining carrier accounts, configuring carrier-specific details and capabilities, and retrieving supporting hub information for applicable carriers.<br/> Carrier accounts enable authentication with carriers and are required for rating, shipment creation, and label generation.\n"}},"baseSlug":"/openapi/carrieraccounts","routesMapping":{}}