{"items":[{"type":"link","label":"Ship via Code APIs","link":"/openapi/shipviacode","routeSlug":"/openapi/shipviacode","content":{"contentType":"overview","meta":{"name":"Ship via Code APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"shipviacode.json","url":"/_bundle/openapi/shipviacode.json?download"},{"kind":"download","label":"shipviacode.yaml","url":"/_bundle/openapi/shipviacode.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"PB Software License Agreement","url":"https://www.pitneybowes.com/us/support/account/pitney-bowes-terms-and-conditions.html"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Ship via Code APIs (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ship Via Code APIs provide capabilities to create and manage reusable shipping configurations that combine carrier, carrier account, parcel type, service, and special services into a single identifier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These APIs help simplify shipment creation by allowing you to reference a predefined ship via code instead of repeatedly providing the same carrier configuration details in each request. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The APIs support the following services:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a ship via code with predefined carrier configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all ship via codes or a specific code by identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an existing ship via code configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a ship via code"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these APIs to standardize shipping configurations, reduce repetitive input, and streamline shipment workflows when using the Create Shipment API."},"children":[]}]}]}]}]}],"sectionId":"/openapi/shipviacode"}],"sectionId":"/openapi/shipviacode"}]}]}},{"type":"group","label":"Ship Via Code","link":"/openapi/shipviacode/ship-via-code","routeSlug":"/openapi/shipviacode/ship-via-code","items":[{"label":"Create Ship Via Code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipviacode/ship-via-code/createshipviacode","routeSlug":"/openapi/shipviacode/ship-via-code/createshipviacode","metadata":{"seo":{"title":"Create Ship Via Code","description":"Create a ship via code that represents a specific combination of carrier, carrier account,parcel type, service, and special services.This ship via code can then be used in the Create Shipment API, so users don't need to manuallyre-enter these parameters each time.Once generated, the code can be reused across multiple shipments to reduce effort in shipping requests."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createShipViaCode","name":"Create Ship Via Code","isWebhook":false,"pointer":"/paths/~1api~1v1~1shipviacode/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Ship Via Code","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":"Create a ship via code that represents a specific combination of carrier, carrier account,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parcel type, service, and special services."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This ship via code can then be used in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Shipment API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so users don't need to manually"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"re-enter these parameters each time."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once generated, the code can be reused across multiple shipments to reduce effort in shipping requests."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCarrierCustomCodeRequest"}},"schemaId":"components/schemas/CreateCarrierCustomCodeRequest","pointer":"/paths/~1api~1v1~1shipviacode/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/shipviacode","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCarrierCustomCodeRequest"}},"responseCodes":["201","400","401","500"],"pointer":"/api/v1/shipviacode","href":"ship-via-code/createshipviacode","openApiOperationId":"createShipViaCode","summary":"Create Ship Via Code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/CreateCarrierCustomCodeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCarrierCustomCodeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Ship Via Code successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_411"}},"schemaId":"schema_411"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1shipviacode/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_411","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_411"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ship-via-code/createshipviacode"}],"panels":[]}]},"httpPath":"/api/v1/shipviacode"},{"label":"Get all Ship Via Codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipviacode/ship-via-code/getshipviacodes","routeSlug":"/openapi/shipviacode/ship-via-code/getshipviacodes","metadata":{"seo":{"title":"Get all Ship Via Codes","description":"Returns a list of ship via codes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShipViaCodes","name":"Get all Ship Via Codes","isWebhook":false,"pointer":"/paths/~1api~1v1~1shipviacode/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Ship Via Codes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of ship via codes.\n"},{"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/shipviacode","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/shipviacode","href":"ship-via-code/getshipviacodes","openApiOperationId":"getShipViaCodes","summary":"Get all Ship Via Codes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of ship via codes has beed retreived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1shipviacode/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ship-via-code/getshipviacodes"}],"panels":[]}]},"httpPath":"/api/v1/shipviacode"},{"label":"Get Ship via Code by Code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipviacode/ship-via-code/getshipviacodebycode","routeSlug":"/openapi/shipviacode/ship-via-code/getshipviacodebycode","metadata":{"seo":{"title":"Get Ship via Code by Code","description":"This operation retrieves the details of a specific ship via code mapping by its unique code.A ship via code represents a saved configuration of carrier, carrier account, parcel, service, and special services."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShipViaCodeByCode","name":"Get Ship via Code by Code","isWebhook":false,"pointer":"/paths/~1api~1v1~1shipviacode~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Ship via Code by Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation retrieves the details of a specific ship via code mapping by its unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ship via code represents a saved configuration of carrier, carrier account, parcel, service, and special services."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_413","description":"Unique ship via code identifier. This value is defined when the ship via code is created and cannot be changed.","required":true}],"pointer":"/paths/~1api~1v1~1shipviacode~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/shipviacode/{code}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"schemaId":"schema_413"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/shipviacode/{code}","href":"ship-via-code/getshipviacodebycode","openApiOperationId":"getShipViaCodeByCode","summary":"Get Ship via Code by Code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Specified ship via codes has beed retreived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCustomCarrierCodeResponse"}},"schemaId":"components/schemas/GetCustomCarrierCodeResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1shipviacode~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCustomCarrierCodeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCustomCarrierCodeResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ship-via-code/getshipviacodebycode"}],"panels":[]}]},"httpPath":"/api/v1/shipviacode/{code}"},{"label":"Update Ship Via Code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipviacode/ship-via-code/updateshipviacode","routeSlug":"/openapi/shipviacode/ship-via-code/updateshipviacode","metadata":{"seo":{"title":"Update Ship Via Code","description":"This operation Updates the configuration for the specified ship via code.The ship via code  itself cannot be changed. If provided in the body, it will be ignored."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateShipViaCode","name":"Update Ship Via Code","isWebhook":false,"pointer":"/paths/~1api~1v1~1shipviacode~1{code}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Ship Via Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation Updates the configuration for the specified ship via code."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ship via code  itself "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be changed. If provided in the body, it will be ignored."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_413","description":"Unique ship via code identifier. This value is defined when the ship via code is created and cannot be changed.","required":true}],"pointer":"/paths/~1api~1v1~1shipviacode~1{code}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCarrierCustomCodeRequest"}},"schemaId":"components/schemas/UpdateCarrierCustomCodeRequest","pointer":"/paths/~1api~1v1~1shipviacode~1{code}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/shipviacode/{code}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"schemaId":"schema_413"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCarrierCustomCodeRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/shipviacode/{code}","href":"ship-via-code/updateshipviacode","openApiOperationId":"updateShipViaCode","summary":"Update Ship Via Code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/UpdateCarrierCustomCodeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCarrierCustomCodeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ship via code successfully updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_414"}},"schemaId":"schema_414"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1shipviacode~1{code}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_414","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_414"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ship-via-code/updateshipviacode"}],"panels":[]}]},"httpPath":"/api/v1/shipviacode/{code}"},{"label":"Delete Ship Via Code","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipviacode/ship-via-code/deleteshipviacode","routeSlug":"/openapi/shipviacode/ship-via-code/deleteshipviacode","metadata":{"seo":{"title":"Delete Ship Via Code","description":"This operation deletes the ship via code mapping by its unique code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteShipViaCode","name":"Delete Ship Via Code","isWebhook":false,"pointer":"/paths/~1api~1v1~1shipviacode~1{code}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Ship Via Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation deletes the ship via code mapping by its unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_413","description":"Unique ship via code identifier. This value is defined when the ship via code is created and cannot be changed.","required":true}],"pointer":"/paths/~1api~1v1~1shipviacode~1{code}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/shipviacode/{code}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"schemaId":"schema_413"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/shipviacode/{code}","href":"ship-via-code/deleteshipviacode","openApiOperationId":"deleteShipViaCode","summary":"Delete Ship Via Code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The specified ship via code has been deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1shipviacode~1{code}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ship-via-code/deleteshipviacode"}],"panels":[]}]},"httpPath":"/api/v1/shipviacode/{code}"}],"content":{"contentType":"group","meta":{"name":"Ship Via Code"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ship Via Code","showPageActions":true},{"nodeType":"markdoc","content":"APIs Provide services to manage reusable ship via codes that simplify shipment creation by encapsulating carrier, service, and parcel configuration."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/shipviacode","summary":"Create Ship Via Code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ship-via-code/createshipviacode","deprecated":false},{"title":"/api/v1/shipviacode","summary":"Get all Ship Via Codes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ship-via-code/getshipviacodes","deprecated":false},{"title":"/api/v1/shipviacode/{code}","summary":"Get Ship via Code by Code","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ship-via-code/getshipviacodebycode","deprecated":false},{"title":"/api/v1/shipviacode/{code}","summary":"Update Ship Via Code","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ship-via-code/updateshipviacode","deprecated":false},{"title":"/api/v1/shipviacode/{code}","summary":"Delete Ship Via Code","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ship-via-code/deleteshipviacode","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"type":"object","properties":{"message":{"type":"string","description":"This is HTTP 401 Unauthorized response status code, that indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource."}},"required":["message"]}},"components/schemas/Errors":{"id":"components/schemas/Errors","kind":"json-schema","title":"Errors","data":{"type":"object","properties":{"errors":{"type":"array","description":"List of errors.","items":{"type":"object","properties":{"errorCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This error can be validation_error or internal_error or not_found or already_exists"},"children":[]}]}]}],"example":"validation_error"},"errorDescription":{"type":"string","description":"The HTTP 400 Bad Request response status code indicates that the server cannot process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","example":"Custom Fields not found"}}}}}}},"components/schemas/CreateCarrierCustomCodeRequest":{"id":"components/schemas/CreateCarrierCustomCodeRequest","kind":"json-schema","title":"CreateCarrierCustomCodeRequest","data":{"type":"object","required":["code","carrier","carrierAccountId"],"properties":{"code":{"type":"string","description":"Unique ship via code value defined by the client.","example":"FEDEX-custom-code1"},"carrier":{"type":"string","description":"Carrier name associated with the custom configuration.","example":"FEDEX"},"carrierAccountId":{"type":"string","description":"Unique identifier of the carrier account under which shipments will be processed.","example":"xxxxxxxxxxx"},"parcelType":{"type":"string","description":"Parcel type (e.g., PKG for package, LTR for letter).","example":"PKG"},"parcelName":{"type":"string","description":"Human-readable name for the parcel type (optional).","example":"Package"},"serviceId":{"type":"string","description":"Identifier of the shipping service to be used.","example":"GRD"},"serviceName":{"type":"string","description":"Human-readable name of the shipping service (optional).","example":"Ground"},"specialServices":{"type":"array","description":"List of special services applied to the ship via code.","items":{"type":"object","properties":{"specialServiceId":{"type":"string","description":"Identifier of the special service.","example":"INS"},"inputParameters":{"type":"array","description":"Input parameters for the special service.","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name.","example":"INPUT_VALUE"},"value":{"type":"string","description":"Parameter value.","example":"101"}}}},"fee":{"type":"number","description":"Monetary fee associated with the service (if any).","example":0}}}}}}},"components/schemas/customCarrierCodesResponse":{"id":"components/schemas/customCarrierCodesResponse","kind":"json-schema","title":"customCarrierCodesResponse","data":{"type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier to represent the custom carrier configuration. This code will be used later in Create Shipment API."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed: letters, digits, dot, underscore, hyphen (need to confirm with team)"},"children":[]}]}]}]}],"example":"FEDEX-custom-code1"}}}},"components/schemas/GetCustomCarrierCodeResponse":{"id":"components/schemas/GetCustomCarrierCodeResponse","kind":"json-schema","title":"GetCustomCarrierCodeResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier generated by the system for the ship via code.","example":"68b6bf44e10c804a9c1441df"},"code":{"type":"string","description":"Ship via code value.","example":"FEDEX-custom-code"},"subID":{"type":"string","description":"Subscription ID associated with this ship via code.","example":"sac4c3a"},"carrier":{"type":"string","description":"Carrier name.","example":"FEDEX"},"carrierAccountId":{"type":"string","description":"Unique identifier of the carrier account.","example":"B9PZAR2QZzn01Xo"},"parcelType":{"type":"string","description":"Parcel type (e.g., PKG, LTR).","example":"PKG"},"serviceId":{"type":"string","description":"Identifier of the service selected for the shipment.","example":"NDA"},"specialServices":{"type":"array","description":"List of special services applied to the ship via code.","items":{"type":"object","properties":{"specialServiceId":{"type":"string","description":"Identifier of the special service.","example":"INS"},"inputParameters":{"type":"array","description":"Input parameters for the special service.","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name.","example":"INPUT_VALUE"},"value":{"type":"string","description":"Parameter value.","example":"101"}}}},"fee":{"type":"number","description":"Monetary fee associated with the service (if any).","example":0}}}},"residential":{"type":"boolean","example":false},"insertTimestamp":{"type":"string","format":"date-time","description":"Timestamp when the entry was created.","example":"2025-09-02T09:56:20.851Z"},"updateTimestamp":{"type":"string","format":"date-time","description":"Timestamp when the entry was last updated.","example":"0001-01-01T00:00:00Z"},"createdBy":{"type":"string","description":"User ID of the creator.","example":"0oa2fok3669kX7can0h8"},"archived":{"type":"boolean","description":"Indicates whether the record is archived.","example":false}}}},"components/schemas/UpdateCarrierCustomCodeRequest":{"id":"components/schemas/UpdateCarrierCustomCodeRequest","kind":"json-schema","title":"UpdateCarrierCustomCodeRequest","data":{"type":"object","required":["carrier","carrierAccountId"],"properties":{"carrier":{"type":"string","description":"Carrier name associated with the custom configuration.","example":"FEDEX"},"carrierAccountId":{"type":"string","description":"Unique identifier of the carrier account under which shipments will be processed.","example":"xxxxxxxxxxx"},"parcelType":{"type":"string","description":"Parcel type (e.g., PKG for package, LTR for letter).","example":"PKG"},"parcelName":{"type":"string","description":"Human-readable name for the parcel type (optional).","example":"Package"},"serviceId":{"type":"string","description":"Identifier of the shipping service to be used.","example":"GRD"},"serviceName":{"type":"string","description":"Human-readable name of the shipping service (optional).","example":"Ground"},"specialServices":{"type":"array","description":"List of special services applied to the ship via code.","items":{"type":"object","properties":{"specialServiceId":{"type":"string","description":"Identifier of the special service.","example":"INS"},"inputParameters":{"type":"array","description":"Input parameters for the special service.","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name.","example":"INPUT_VALUE"},"value":{"type":"string","description":"Parameter value.","example":"101"}}}},"fee":{"type":"number","description":"Monetary fee associated with the service (if any).","example":0}}}}}}},"schema_411":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"string","description":"The generated ship via code that can be reused in Create Shipment API.","example":"FEDEX-custom-code1"}}},"id":"schema_411"},"schema_412":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/GetCustomCarrierCodeResponse"}},"id":"schema_412"},"schema_413":{"kind":"json-schema","data":{"type":"string"},"id":"schema_413"},"schema_414":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"string","description":"The updated ship via code that can be used in Create Shipment API.","example":"myups-test2"}}},"id":"schema_414"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}]},"options":{"hideDownloadButtons":false,"hideInfoMetadata":true,"jsonSamplesExpandLevel":3,"layout":"three-panel","schemasExpansionLevel":2,"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Go"},{"lang":"Java"},{"lang":"C#"}]},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/shipviacode.json?download"},{"url":"/_bundle/openapi/shipviacode.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Ship via Code APIs","description":"Ship Via Code APIs provide capabilities to create and manage reusable shipping configurations that combine carrier, carrier account, parcel type, service, and special services into a single identifier. <br/>These APIs help simplify shipment creation by allowing you to reference a predefined ship via code instead of repeatedly providing the same carrier configuration details in each request. <br/>The APIs support the following services:\n- Create a ship via code with predefined carrier configuration\n- Retrieve all ship via codes or a specific code by identifier\n- Update an existing ship via code configuration\n- Delete a ship via code\n<br/>Use these APIs to standardize shipping configurations, reduce repetitive input, and streamline shipment workflows when using the Create Shipment API.\n"}},"baseSlug":"/openapi/shipviacode","routesMapping":{}}