{"items":[{"type":"group","label":"Getting Started","items":[{"type":"link","fsPath":"docs/index.md","metadata":{"type":"markdown"},"label":"Quick Overview","link":"/docs","routeSlug":"/docs"},{"type":"group","label":"Authentication","items":[{"type":"link","label":"Auth APIs","link":"/openapi/auth","routeSlug":"/openapi/auth"},{"label":"Get Access Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/auth/other/getaccesstoken","routeSlug":"/openapi/auth/other/getaccesstoken","metadata":{"seo":{"title":"Get Access Token","description":"Each request to the Shipping 360 API requires authentication via an OAuth token. This API call generates the OAuth token based on the Base64-encoded value of the Client ID and Secret associated with your developer account. The token expires after 4 hours. Client ID is the The unique identifier assigned to the client application and Secret is a confidential string used to authenticate the client. These both are required to generate token. Use Client ID as User Name and Secret as Password for getting access token while trying out in security options."}},"httpPath":"/api/v1/token"}]}],"expanded":"true","separatorLine":true},{"type":"group","label":"Shipping APIs","items":[{"type":"link","label":"Overview","link":"/openapi/shipping","routeSlug":"/openapi/shipping"},{"type":"group","label":"Shipment","link":"/openapi/shipping/shipment","routeSlug":"/openapi/shipping/shipment","items":[{"label":"Get Carriers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getcarriers","routeSlug":"/openapi/shipping/shipment/getcarriers","metadata":{"seo":{"title":"Get Carriers","description":"The operation fetches all supported carriers. This service is used to get list of supported carriers and their properties."}},"httpPath":"/api/v1/carriers"},{"label":"Carrier facilities","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/carrierfacility","routeSlug":"/openapi/shipping/shipment/carrierfacility","metadata":{"seo":{"title":"Carrier facilities","description":"This operation locates Post Offices and other facilities for a given carrier. You can use this operation, for example, to locate all USPS Post Offices near a given postal code."}},"httpPath":"/api/v1/carrier-facility"},{"label":"Get Countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getcountries","routeSlug":"/openapi/shipping/shipment/getcountries","metadata":{"seo":{"title":"Get Countries","description":"The operation fetches list of supported destination countries for a provided carrier and origin country. If query parameters are not provided, it will default to USPS as carrier and US as origin country."}},"httpPath":"/api/v1/countries"},{"label":"Get Services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getservices","routeSlug":"/openapi/shipping/shipment/getservices","metadata":{"seo":{"title":"Get Services","description":"The operation fetches a list of supported services for a carrier with respect to specific origin and destination country. If query parameters are not provided, this will default to USPS as carrier, US as both origin and destination country code."}},"httpPath":"/api/v1/services"},{"label":"Get Parcel Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getparceltypes","routeSlug":"/openapi/shipping/shipment/getparceltypes","metadata":{"seo":{"title":"Get Parcel Types","description":"The operation fetches Parcel Types based on the provided carrier, origin county, and the destination country. If query parameters are not provided, this will default to USPS as carrier, US as both origin and destination country code."}},"httpPath":"/api/v1/parcelTypes"},{"label":"Get Special Services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getspecialservices","routeSlug":"/openapi/shipping/shipment/getspecialservices","metadata":{"seo":{"title":"Get Special Services","description":"The operation fetches Special Services for a given carrier, service, origin country, and the destination country. If query parameters are not provided, it will default to USPS as carrier, US as both origin, and destination country and will show for all service and parcel types"}},"httpPath":"/api/v1/specialServices"},{"label":"Get Carrier Accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getcarrieraccount","routeSlug":"/openapi/shipping/shipment/getcarrieraccount","metadata":{"seo":{"title":"Get Carrier Accounts","description":"The operation retrieves onboarded Carriers with their Carrier Account IDs which uniquely identify multiple accounts of same carrier."}},"httpPath":"/api/v1/carrierAccounts"},{"label":"Get All Shipments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getallshipments","routeSlug":"/openapi/shipping/shipment/getallshipments","metadata":{"seo":{"title":"Get All Shipments","description":"The operation fetches all created Shipments. If query parameters are not provided, it will default endDate as current date, page as 1 and size as 10."}},"httpPath":"/api/v1/shipments"},{"label":"Create Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/createshipmentv2","routeSlug":"/openapi/shipping/shipment/createshipmentv2","metadata":{"seo":{"title":"Create Shipment","description":"Note: This Request sample includes the full set of supported fields across all carriers. However, not all fields are applicable to every carrier. When making API calls from the doc portal, ensure you include only the parameters supported by the specific carrier you are integrating with. If unsupported fields are included, the request may fail. <br/>To simplify integration and avoid errors, refer to the Postman Collection. <br/>To explore which label types, label formats, label sizes, parcel types, services, and special services are supported by each carrier, see the Carrier Catalog. Detailed field descriptions are also provided below."}},"httpPath":"/api/v2/shipments"},{"label":"Rate Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/rateshipment","routeSlug":"/openapi/shipping/shipment/rateshipment","metadata":{"seo":{"title":"Rate Shipment","description":"This operation generates rate Shop for a specified shipment without generating the labels."}},"httpPath":"/api/v2/rates"},{"label":"Create ERR Single Coversheet","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/createerrcoversheet","routeSlug":"/openapi/shipping/shipment/createerrcoversheet","metadata":{"seo":{"title":"Create ERR Single Coversheet","description":"This API generates Electronic Return Receipt (ERR) artifacts for a parcel, including a coversheet, ERR barcode, and ERR stamp. The response output can be configured using the type parameter to return a coversheet, barcode and stamp images, or all outputs."}},"httpPath":"/api/v1/err/coverSheet"},{"label":"Get Shipment by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/shipmentbyid","routeSlug":"/openapi/shipping/shipment/shipmentbyid","metadata":{"seo":{"title":"Get Shipment by Id","description":"The operation retrieves shipment details using shipmentId."}},"httpPath":"/api/v1/shipments/{shipmentId}"},{"label":"Reprint Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/reprintshipmentbyidv2","routeSlug":"/openapi/shipping/shipment/reprintshipmentbyidv2","metadata":{"seo":{"title":"Reprint Shipment","description":"This operation retrieves an existing shipping label associated with a shipment. The API uses the shipmentId returned by the original Create Shipment request. Use this API only if the original shipping label has been lost or damaged. <br>"}},"httpPath":"/api/v2/shipments/reprint"},{"label":"Cancel Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/cancelshipmentbyidv2","routeSlug":"/openapi/shipping/shipment/cancelshipmentbyidv2","metadata":{"seo":{"title":"Cancel Shipment","description":"This operation cancels or voids a shipment label that has not been processed by the carrier. When you cancel an unused prepaid shipment label, the API initiates a request for an electronic refund.<br>"}},"httpPath":"/api/v2/shipments/cancel"},{"label":"Signature Image ERR","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/getsignatureimageerr","routeSlug":"/openapi/shipping/shipment/getsignatureimageerr","metadata":{"seo":{"title":"Signature Image ERR","description":"This API provides a downloadable link containing the signature image for a specific ERR (Electronic Return Receipt) shipment. This signature image serves as Proof of Delivery (POD). <br>What is Proof of Delivery (POD)?<br>Proof of Delivery is a document or file that acts as evidence of successful shipment delivery. This file contains a digital copy of the recipient's signature, provided as a downloadable link or URL."}},"httpPath":"/api/v1/err/shipments/{shipmentId}/signaturefile"},{"label":"Cancel Stamps ERR","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/cancelstampserr","routeSlug":"/openapi/shipping/shipment/cancelstampserr","metadata":{"seo":{"title":"Cancel Stamps ERR","description":"This operation cancels (voids) stamps generated for ERR (Electronic Return Receipt)."}},"httpPath":"/api/v1/err/stamps/void"},{"label":"Download BPOD Files","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/shipment/downloadbpodfiles","routeSlug":"/openapi/shipping/shipment/downloadbpodfiles","metadata":{"seo":{"title":"Download BPOD Files","description":"This API operation is used to download bulk of ERR (Electronic Return Receipt) - POD (Proof of Delivery) files, which are specific to USPS carrier. <br />User can download BPOD (Bulk Proof of Delivery) files either using Shipment IDs or Date Range. <br/>"}},"httpPath":"/api/v1/err/shipments/bpod"}]},{"type":"group","label":"Electronic Trade Document","link":"/openapi/shipping/electronic-trade-document","routeSlug":"/openapi/shipping/electronic-trade-document","items":[{"label":"Upload Electronic Trade Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/electronic-trade-document/uploadetd","routeSlug":"/openapi/shipping/electronic-trade-document/uploadetd","metadata":{"seo":{"title":"Upload Electronic Trade Document","description":"Electronic Trade Documents Upload API is an international shipping document upload solution that simplifies global shipping needs and allows you to electronically upload customs documentation required for international shipments.You can submit most of your trade documents electronically relieving yourself from printing or attaching trade documents with the shipment. <br/>This API simplifies and accelerates customs clearance by replacing physical paperwork with electronic documentation.<br/>The customs and other agencies receive electronically sent documents faster than paper copies attached with your shipment. The customs clearance process is also optimized as capturing and sharing of critical trade information is done at earlier stages of shipping."}},"httpPath":"/api/v1/importUrl"}]},{"type":"group","label":"Pickups","link":"/openapi/shipping/pickups","routeSlug":"/openapi/shipping/pickups","items":[{"label":"Schedule Pickup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/pickups/schedulepickup","routeSlug":"/openapi/shipping/pickups/schedulepickup","metadata":{"seo":{"title":"Schedule Pickup","description":"Pickups endpoint allows you to schedule pickups with USPS, DHL Express, UPS and FedEx carriers for eligible shipments.The pickup schedule scope is determined by what you provide in the request:"}},"httpPath":"/api/v1/pickups"},{"label":"Get Pickups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/pickups/getpickups","routeSlug":"/openapi/shipping/pickups/getpickups","metadata":{"seo":{"title":"Get Pickups","description":"Get Pickups"}},"httpPath":"/api/v1/pickups"},{"label":"Cancel Pickups","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/pickups/cancelpickups","routeSlug":"/openapi/shipping/pickups/cancelpickups","metadata":{"seo":{"title":"Cancel Pickups","description":"Cancel Pickups."}},"httpPath":"/api/v1/pickups/cancel"},{"label":"Get Pickup Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/pickups/getpickupdocument","routeSlug":"/openapi/shipping/pickups/getpickupdocument","metadata":{"seo":{"title":"Get Pickup Document","description":"The API retrieves the document for a scheduled pickup receipt using the pickupId, generated when the pickup is successfully scheduled."}},"httpPath":"/api/v1/pickups/{pickupId}/document"},{"label":"Cancelled Pickup Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/pickups/cancelledpickupdocument","routeSlug":"/openapi/shipping/pickups/cancelledpickupdocument","metadata":{"seo":{"title":"Cancelled Pickup Document","description":"This operation generates a PDF receipt for pickup cancellations. It supports creating receipts for multiple cancelled pickups."}},"httpPath":"/api/v1/pickups/document"},{"label":"Check Pickup Availability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/pickups/checkpickupavailability","routeSlug":"/openapi/shipping/pickups/checkpickupavailability","metadata":{"seo":{"title":"Check Pickup Availability","description":"Validates if the requested carrier can perform a pickup at the provided address, given the shipment details and requested pickup date/time."}},"httpPath":"/api/v1/pickups/availability"}]},{"type":"group","label":"Multipiece Shipment","link":"/openapi/shipping/multipiece-shipment","routeSlug":"/openapi/shipping/multipiece-shipment","items":[{"label":"Multipiece Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/multipiece-shipment/multipieceshipment","routeSlug":"/openapi/shipping/multipiece-shipment/multipieceshipment","metadata":{"seo":{"title":"Multipiece Shipment","description":"The operation creates Multipiece Shipments. Shipments with multiple parcels sent to the same destination can be grouped together in a multipiece shipment. - UPS, FedEx, DHL Express, Suprmsys, Purolator, Apple Express, Tforce Mile, Loomis and Canpar are supported for Multipiece Shipments. - Maximum Parcels Allowed per Carrier: - DHL: 75 - FedEx: 40 - UPS: 50 - Purolator: 100 - Apple Express: 75 - Tforce Mile: 75 - Loomis: 75 - Canpar: 25"}},"httpPath":"/api/v1/multipiece/shipments"},{"label":"Multipiece Rates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/multipiece-shipment/multipiecerates","routeSlug":"/openapi/shipping/multipiece-shipment/multipiecerates","metadata":{"seo":{"title":"Multipiece Rates","description":"The operation is used for rateshop and to get specific rate based on serviceId for Multipiece."}},"httpPath":"/api/v1/multipiece/rates"},{"label":"Reprint Multipiece Shipment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/multipiece-shipment/multipieceshipmentreprint","routeSlug":"/openapi/shipping/multipiece-shipment/multipieceshipmentreprint","metadata":{"seo":{"title":"Reprint Multipiece Shipment","description":"The operation is used to reprint the multipiece label. It takes the shipmentId of the multipiece shipment done. All supported carriers (UPS, FedEx, DHL Express, Suprmsys, Purolator, and Apple Express) allow up to 8 reprint."}},"httpPath":"/api/v1/multipiece/shipments/{shipmentId}/reprint"},{"label":"Cancel Multipiece Shipment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/multipiece-shipment/multipieceshipmentcancel","routeSlug":"/openapi/shipping/multipiece-shipment/multipieceshipmentcancel","metadata":{"seo":{"title":"Cancel Multipiece Shipment","description":"The operation is used to cancel the multipiece label. It takes the shipmentId of the multipiece shipment done."}},"httpPath":"/api/v1/multipiece/shipments/{shipmentId}/cancel"}]},{"type":"group","label":"Print","link":"/openapi/shipping/print","routeSlug":"/openapi/shipping/print","items":[{"label":"Print Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/print/printdocument","routeSlug":"/openapi/shipping/print/printdocument","metadata":{"seo":{"title":"Print Document","description":"It contains information about a label or a document, e.g., a shipping label, a customs form, manifest report etc., that pertains to a shipment or manifest."}},"httpPath":"/api/v1/document/print"},{"label":"Printer mapping","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/print/printermapping","routeSlug":"/openapi/shipping/print/printermapping","metadata":{"seo":{"title":"Printer mapping","description":"printer mapping document"}},"httpPath":"/api/v1/printer/mapping"},{"label":"Get Printer mapping","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/print/getprintermapping","routeSlug":"/openapi/shipping/print/getprintermapping","metadata":{"seo":{"title":"Get Printer mapping","description":"Get printer mapping document"}},"httpPath":"/api/v1/printer/mapping"},{"label":"Delete Printer mapping","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/print/deleteprintermapping","routeSlug":"/openapi/shipping/print/deleteprintermapping","metadata":{"seo":{"title":"Delete Printer mapping","description":"delete printer mapping document"}},"httpPath":"/api/v1/printer/mapping"},{"label":"Job status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/print/jobstatus","routeSlug":"/openapi/shipping/print/jobstatus","metadata":{"seo":{"title":"Job status","description":"job status"}},"httpPath":"/api/v1/jobs/{jobId}"}]},{"type":"group","label":"Defaults","link":"/openapi/shipping/defaults","routeSlug":"/openapi/shipping/defaults","items":[{"label":"Create Defaults","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/defaults/createdefaults","routeSlug":"/openapi/shipping/defaults/createdefaults","metadata":{"seo":{"title":"Create Defaults","description":"While creating shipment, a few columns/ fields information are used mandatorily, and if the value for those columns are used repetitively, then it is always better to save last used values. And hence, this API has been introduced. Using this API, default values can be set up for frequently used columns/fields information like carrier and linked services. Setting up the defaults will save both time and efforts."}},"httpPath":"/api/v1/defaults"},{"label":"Get All Defaults","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/defaults/getalldefaults","routeSlug":"/openapi/shipping/defaults/getalldefaults","metadata":{"seo":{"title":"Get All Defaults","description":"The operation fetches all created Defaults. If query parameters are not provided, it will consider default page as 1 and default size as 10."}},"httpPath":"/api/v1/defaults"},{"label":"Update Defaults","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/defaults/putdefaultsbyid","routeSlug":"/openapi/shipping/defaults/putdefaultsbyid","metadata":{"seo":{"title":"Update Defaults","description":"This operation updates the values set for Defaults."}},"httpPath":"/api/v1/defaults/{defaultID}"},{"label":"Get Defaults By ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/defaults/getdefaultsbyid","routeSlug":"/openapi/shipping/defaults/getdefaultsbyid","metadata":{"seo":{"title":"Get Defaults By ID","description":"This operation fetches the values set for the Defaults."}},"httpPath":"/api/v1/defaults/{defaultID}"},{"label":"Delete Defaults by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/shipping/defaults/deletedefaultsbyid","routeSlug":"/openapi/shipping/defaults/deletedefaultsbyid","metadata":{"seo":{"title":"Delete Defaults by ID","description":"This operation deletes the existing Defaults."}},"httpPath":"/api/v1/defaults/{defaultID}"}]},{"type":"group","label":"RateGroup APIs","items":[{"type":"link","label":"RateGroup APIs","link":"/openapi/rategroup","routeSlug":"/openapi/rategroup"},{"type":"group","label":"RateGroup","link":"/openapi/rategroup/rategroup","routeSlug":"/openapi/rategroup/rategroup","items":[{"label":"Create RateGroup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rategroup/rategroup/createrategroup","routeSlug":"/openapi/rategroup/rategroup/createrategroup","metadata":{"seo":{"title":"Create RateGroup","description":"Use this API to create a RateGroup that groups carriers and their services for automated rate shopping. A RateGroup allows the system to dynamically select the cheapest or fastest delivery option across the defined carriers and services—without manual comparison.Read How to Create RateGroup."}},"httpPath":"/api/v1/rategroups"},{"label":"Get All RateGroups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rategroup/rategroup/getallrategroups","routeSlug":"/openapi/rategroup/rategroup/getallrategroups","metadata":{"seo":{"title":"Get All RateGroups","description":"This operation retrieves a list of all RateGroups with metadata such as the RateGroup ID, display name, origin country, status (active/inactive), audience type, included carriers and services, archival status available in the system."}},"httpPath":"/api/v1/rategroups"},{"label":"Get RateGroup by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rategroup/rategroup/getrategroup","routeSlug":"/openapi/rategroup/rategroup/getrategroup","metadata":{"seo":{"title":"Get RateGroup by ID","description":"This operation retrieves a RateGroups using the provided RateGroup ID with metadata such as the RateGroup ID, display name, origin country, status (active/inactive), audience type, included carriers and services, archival status available in the system."}},"httpPath":"/api/v1/rategroups/{rateGroupId}"},{"label":"Update RateGroup","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rategroup/rategroup/updaterategroup","routeSlug":"/openapi/rategroup/rategroup/updaterategroup","metadata":{"seo":{"title":"Update RateGroup","description":"This operation updates the details of an existing RateGroup identified by its RateGroup ID. You can modify attributes such as the display name, status (active/inactive), audience type (Enterprise, Location, or Users and Roles), and the list of carriers and services associated with the RateGroup. Once updated, the revised RateGroup will be available for use in dynamic rate shopping through the Rate and Create Shipment APIs."}},"httpPath":"/api/v1/rategroups/{rateGroupId}"},{"label":"Delete RateGroup","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rategroup/rategroup/deleterategroup","routeSlug":"/openapi/rategroup/rategroup/deleterategroup","metadata":{"seo":{"title":"Delete RateGroup","description":"This operations deletes the specified RateGroup."}},"httpPath":"/api/v1/rategroups/{rateGroupId}"}]}],"separatorLine":true},{"type":"group","label":"Batch Shipment APIs","items":[{"type":"link","label":"Batch Shipment APIs","link":"/openapi/batchshipping","routeSlug":"/openapi/batchshipping"},{"type":"group","label":"Batch Shipment","link":"/openapi/batchshipping/batch-shipment","routeSlug":"/openapi/batchshipping/batch-shipment","items":[{"label":"Create Bulk Shipments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/batchshipping/batch-shipment/createbulkshipmentsapi","routeSlug":"/openapi/batchshipping/batch-shipment/createbulkshipmentsapi","metadata":{"seo":{"title":"Create Bulk Shipments","description":"This API \"Create Bulk Shipments\" operation requires the following information:"}},"httpPath":"/api/v1/bulkShipments"},{"label":"Create Bulk Shipments ERR","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/batchshipping/batch-shipment/createbulkshipmentsapierr","routeSlug":"/openapi/batchshipping/batch-shipment/createbulkshipmentsapierr","metadata":{"seo":{"title":"Create Bulk Shipments ERR","description":"ERR (Electronic Return Receipt) is an official United States Postal Service® (USPS) document designed to be equivalent to the hardcopy 'green card' Return Receipt. <br />It provides the following information:"}},"httpPath":"/api/v1/err/bulkShipments"},{"label":"Bulk Import Shipments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/batchshipping/batch-shipment/bulkimportapi","routeSlug":"/openapi/batchshipping/batch-shipment/bulkimportapi","metadata":{"seo":{"title":"Bulk Import Shipments","description":"\"This operation imports the .CSV file for Bulk Shipment, which includes fields essential to create Bulk Shipments. The payload contains the following essential fields in .CSV file, used for shipment transactions: - Carrier Account - Output format, which includes Shipping Label and Coversheet - Services, and - Special Services"}},"httpPath":"/api/v1/shipments/importUrl"},{"label":"Bulk Import Shipments ERR","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/batchshipping/batch-shipment/bulkimportapierr","routeSlug":"/openapi/batchshipping/batch-shipment/bulkimportapierr","metadata":{"seo":{"title":"Bulk Import Shipments ERR","description":"This operation imports the .CSV file which includes fields required for creating ERR (Electronic Return Receipt) Bulk Shipments. The payload, which is used for shipment transactions, contains the following essential information in .CSV file: - Carrier Account - Output format: Shipping Label and Coversheet - Services, and - Special Services"}},"httpPath":"/api/v1/err/shipments/importUrl"},{"label":"Process Batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/batchshipping/batch-shipment/processbatchapi","routeSlug":"/openapi/batchshipping/batch-shipment/processbatchapi","metadata":{"seo":{"title":"Process Batch","description":"This operation processes (executes) the existing Batch. The payload for this endpoint needs only an empty JSON object and no additional data is required in the request body. The BatchID parameter located in the endpoint specifies which batch of shipments to process."}},"httpPath":"/api/v1/shipments/batch/{batchId}/process"},{"label":"Void Batch Shipping Labels","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/batchshipping/batch-shipment/voidshippinglabel","routeSlug":"/openapi/batchshipping/batch-shipment/voidshippinglabel","metadata":{"seo":{"title":"Void Batch Shipping Labels","description":"This operation cancels (voids) shipments which are created using the Batch API operation createBulkShipments. <br />If user wants to cancel specific shipment(s) of the Batch, then s/he needs to pass the Shipment ID for the selected shipments in the shipmentIDs array.While if user wants to cancel all shipments of the Batch, then s/he does not need to provide any Shipment ID in the array under request body."}},"httpPath":"/api/v1/shipments/batch/{batchId}/void"},{"label":"Get Batch Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/batchshipping/batch-shipment/getbatchstatusapi","routeSlug":"/openapi/batchshipping/batch-shipment/getbatchstatusapi","metadata":{"seo":{"title":"Get Batch Status","description":"This operation retrieves the status of an existing Batch using Batch ID. Once the Job status is completed, the URL received from Response can be used to download the shipping label in PDF format."}},"httpPath":"/api/v1/shipments/batch/{batchId}/status"},{"label":"Get Batch Shipment Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/batchshipping/batch-shipment/getshipmentdetailsforbatchapi","routeSlug":"/openapi/batchshipping/batch-shipment/getshipmentdetailsforbatchapi","metadata":{"seo":{"title":"Get Batch Shipment Details","description":"\"This API operation provides the shipment details for those shipments which are SUCCESS or FAILED during batch processing at the following levels:"}},"httpPath":"/api/v1/shipments/batch/{batchId}/shipments"}]}],"separatorLine":true},{"type":"group","label":"Transaction Report APIs","items":[{"type":"link","label":"Transaction Report APIs","link":"/openapi/transactionreport","routeSlug":"/openapi/transactionreport"},{"type":"group","label":"Transaction Report","link":"/openapi/transactionreport/transaction-report","routeSlug":"/openapi/transactionreport/transaction-report","items":[{"label":"Get Funds Transaction Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/transactionreport/transaction-report/getfundstransactionreport","routeSlug":"/openapi/transactionreport/transaction-report/getfundstransactionreport","metadata":{"seo":{"title":"Get Funds Transaction Report","description":"This Operation returns the report of funds transactions within the specified date range."}},"httpPath":"/api/v1/funds"},{"label":"Get Shipment Transaction Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/transactionreport/transaction-report/getshipmenttransactionreport","routeSlug":"/openapi/transactionreport/transaction-report/getshipmenttransactionreport","metadata":{"seo":{"title":"Get Shipment Transaction Report","description":"This Operation returns the report of shipments transactions within the specified date range."}},"httpPath":"/api/v1/shipments"},{"label":"Get Stamps Transaction Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/transactionreport/transaction-report/getstamptransactionreport","routeSlug":"/openapi/transactionreport/transaction-report/getstamptransactionreport","metadata":{"seo":{"title":"Get Stamps Transaction Report","description":"This Operation returns the report of stamps transactions within the specified date range."}},"httpPath":"/api/v1/stamps"}]}],"separatorLine":true},{"type":"group","label":"Importer Of Record APIs","items":[{"type":"link","label":"Importer of Record API","link":"/openapi/importerofrecord","routeSlug":"/openapi/importerofrecord"},{"type":"group","label":"Importer of Record","link":"/openapi/importerofrecord/importer-of-record","routeSlug":"/openapi/importerofrecord/importer-of-record","items":[{"label":"Create Importer of Record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/importerofrecord/importer-of-record/createimporterofrecord","routeSlug":"/openapi/importerofrecord/importer-of-record/createimporterofrecord","metadata":{"seo":{"title":"Create Importer of Record","description":"Creates a new Importer of Record entry for a specific country.Each entry must have a unique iorCode and is tied to a countryCode."}},"httpPath":"/api/v1/importerofrecord"},{"label":"Get Importers of Record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/importerofrecord/importer-of-record/getimportersofrecord","routeSlug":"/openapi/importerofrecord/importer-of-record/getimportersofrecord","metadata":{"seo":{"title":"Get Importers of Record","description":"Returns a list of Importers of Record."}},"httpPath":"/api/v1/importerofrecord"},{"label":"Get Importer of Record by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/importerofrecord/importer-of-record/getimporterofrecordbyid","routeSlug":"/openapi/importerofrecord/importer-of-record/getimporterofrecordbyid","metadata":{"seo":{"title":"Get Importer of Record by ID","description":"Retrieves a specific Importer of Record entry by its unique id."}},"httpPath":"/api/v1/importerofrecord/{id}"},{"label":"Update Importer of Record","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/importerofrecord/importer-of-record/updateimporterofrecord","routeSlug":"/openapi/importerofrecord/importer-of-record/updateimporterofrecord","metadata":{"seo":{"title":"Update Importer of Record","description":"Update the Importer of Record entry with new values for iorCode,description, and countryCode."}},"httpPath":"/api/v1/importerofrecord/{id}"},{"label":"Detete Importer of Record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/importerofrecord/importer-of-record/deleteimporterofrecord","routeSlug":"/openapi/importerofrecord/importer-of-record/deleteimporterofrecord","metadata":{"seo":{"title":"Detete Importer of Record","description":"This operation deletes the Importer of Record entry identified by id."}},"httpPath":"/api/v1/importerofrecord/{id}"}]}],"separatorLine":true},{"type":"group","label":"Ship Via Code APIs","items":[{"type":"link","label":"Ship via Code APIs","link":"/openapi/shipviacode","routeSlug":"/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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/api/v1/shipviacode/{code}"}]}],"separatorLine":true},{"type":"group","label":"Customs Product APIs","items":[{"type":"link","label":"Customs Product API","link":"/openapi/customproduct","routeSlug":"/openapi/customproduct"},{"type":"group","label":"Customs Product","link":"/openapi/customproduct/customs-product","routeSlug":"/openapi/customproduct/customs-product","items":[{"label":"Add Customs Product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customproduct/customs-product/addcustomsproduct","routeSlug":"/openapi/customproduct/customs-product/addcustomsproduct","metadata":{"seo":{"title":"Add Customs Product","description":"This operation creates a customs product and returns its identifier. Use this identifier in shipment APIs to prefill customs item fields (HS tariff code, origin country, unit price, weight, quantity)."}},"httpPath":"/api/v1/customsproduct"},{"label":"Get all Customs Products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customproduct/customs-product/getcustomsproduct","routeSlug":"/openapi/customproduct/customs-product/getcustomsproduct","metadata":{"seo":{"title":"Get all Customs Products","description":"Returns a list of all Customs Products."}},"httpPath":"/api/v1/customsproduct"},{"label":"Get Customs Product by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customproduct/customs-product/getcustomsproductbyid","routeSlug":"/openapi/customproduct/customs-product/getcustomsproductbyid","metadata":{"seo":{"title":"Get Customs Product by Id","description":"This operation retrieves the details of a specific Customs Product mapping by its unique description.A customs product (description) represents a saved configuration of customs items defined for international shipment."}},"httpPath":"/api/v1/customsproduct/{customsProductId}"},{"label":"Update Customs Product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customproduct/customs-product/updatecustomsproduct","routeSlug":"/openapi/customproduct/customs-product/updatecustomsproduct","metadata":{"seo":{"title":"Update Customs Product","description":"This operation Updates the details for the specified Customs Product.The customs product (description)  itself cannot be changed."}},"httpPath":"/api/v1/customsproduct/{customsProductId}"},{"label":"Delete Customs Product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customproduct/customs-product/deletecustomsproduct","routeSlug":"/openapi/customproduct/customs-product/deletecustomsproduct","metadata":{"seo":{"title":"Delete Customs Product","description":"This operation deletes the Customs Product by its unique description."}},"httpPath":"/api/v1/customsproduct/{customsProductId}"}]}],"separatorLine":true},{"type":"group","label":"LTL Shipments APIs","items":[{"type":"link","label":"LTL Shipment APIs","link":"/openapi/freightshipment","routeSlug":"/openapi/freightshipment"},{"type":"group","label":"LTLShipment","link":"/openapi/freightshipment/ltlshipment","routeSlug":"/openapi/freightshipment/ltlshipment","items":[{"label":"LTL RateShop","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/freightshipment/ltlshipment/ltlrateshop","routeSlug":"/openapi/freightshipment/ltlshipment/ltlrateshop","metadata":{"seo":{"title":"LTL RateShop","description":"The LTL Rate Shop API is used to shop for rates for LTL shipments."}},"httpPath":"/api/v1/ltl/rates"},{"label":"LTL Create Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/freightshipment/ltlshipment/ltlcreateshipment","routeSlug":"/openapi/freightshipment/ltlshipment/ltlcreateshipment","metadata":{"seo":{"title":"LTL Create Shipment","description":"The LTL Create Shipment API is used to create shipments and generate shipment labels.Key Considerations"}},"httpPath":"/api/v1/ltl/shipments"},{"label":"LTL Reprint Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/freightshipment/ltlshipment/ltlreprintshipment","routeSlug":"/openapi/freightshipment/ltlshipment/ltlreprintshipment","metadata":{"seo":{"title":"LTL Reprint Shipment","description":"The LTL Reprint Shipment API is used to reprint shipments and generate shipment labels. <br/>"}},"httpPath":"/api/v1/ltl/shipments/reprint"}]}],"separatorLine":true},{"type":"group","label":"Carrier","items":[{"type":"link","fsPath":"docs/shipping/carriers/carrier-catalog.md","metadata":{"type":"markdown"},"label":"Carrier Catalog","link":"/docs/shipping/carriers/carrier-catalog","routeSlug":"/docs/shipping/carriers/carrier-catalog"},{"type":"link","fsPath":"docs/shipping/carriers/overview/usps.md","metadata":{"type":"markdown"},"label":"USPS","link":"/docs/shipping/carriers/overview/usps","routeSlug":"/docs/shipping/carriers/overview/usps"},{"type":"link","fsPath":"docs/shipping/carriers/overview/fedex.md","metadata":{"type":"markdown"},"label":"FedEx","link":"/docs/shipping/carriers/overview/fedex","routeSlug":"/docs/shipping/carriers/overview/fedex"},{"type":"link","fsPath":"docs/shipping/carriers/overview/ups.md","metadata":{"type":"markdown"},"label":"UPS","link":"/docs/shipping/carriers/overview/ups","routeSlug":"/docs/shipping/carriers/overview/ups"},{"type":"link","fsPath":"docs/shipping/carriers/overview/speedee.md","metadata":{"type":"markdown"},"label":"Spee-Dee","link":"/docs/shipping/carriers/overview/speedee","routeSlug":"/docs/shipping/carriers/overview/speedee"},{"type":"link","fsPath":"docs/shipping/carriers/overview/purolator.md","metadata":{"type":"markdown"},"label":"Purolator","link":"/docs/shipping/carriers/overview/purolator","routeSlug":"/docs/shipping/carriers/overview/purolator"},{"type":"link","fsPath":"docs/shipping/carriers/overview/canadapost.md","metadata":{"type":"markdown"},"label":"Canada Post","link":"/docs/shipping/carriers/overview/canadapost","routeSlug":"/docs/shipping/carriers/overview/canadapost"},{"type":"link","fsPath":"docs/shipping/carriers/overview/canpar.md","metadata":{"type":"markdown"},"label":"Canpar","link":"/docs/shipping/carriers/overview/canpar","routeSlug":"/docs/shipping/carriers/overview/canpar"},{"type":"link","fsPath":"docs/shipping/carriers/overview/dhlexpress.md","metadata":{"type":"markdown"},"label":"DHL Express","link":"/docs/shipping/carriers/overview/dhlexpress","routeSlug":"/docs/shipping/carriers/overview/dhlexpress"},{"type":"link","fsPath":"docs/shipping/carriers/overview/ics.md","metadata":{"type":"markdown"},"label":"ICS","link":"/docs/shipping/carriers/overview/ics","routeSlug":"/docs/shipping/carriers/overview/ics"},{"type":"link","fsPath":"docs/shipping/carriers/overview/loomis.md","metadata":{"type":"markdown"},"label":"Loomis","link":"/docs/shipping/carriers/overview/loomis","routeSlug":"/docs/shipping/carriers/overview/loomis"},{"type":"link","fsPath":"docs/shipping/carriers/overview/dicom.md","metadata":{"type":"markdown"},"label":"Dicom","link":"/docs/shipping/carriers/overview/dicom","routeSlug":"/docs/shipping/carriers/overview/dicom"},{"type":"link","fsPath":"docs/shipping/carriers/overview/norate.md","metadata":{"type":"markdown"},"label":"NORATE","link":"/docs/shipping/carriers/overview/norate","routeSlug":"/docs/shipping/carriers/overview/norate"},{"type":"link","fsPath":"docs/shipping/carriers/overview/goforcanada.md","metadata":{"type":"markdown"},"label":"GoFor","link":"/docs/shipping/carriers/overview/goforcanada","routeSlug":"/docs/shipping/carriers/overview/goforcanada"},{"type":"link","fsPath":"docs/shipping/carriers/overview/supreme.md","metadata":{"type":"markdown"},"label":"Supreme","link":"/docs/shipping/carriers/overview/supreme","routeSlug":"/docs/shipping/carriers/overview/supreme"},{"type":"link","fsPath":"docs/shipping/carriers/overview/dpd.md","metadata":{"type":"markdown"},"label":"DPD","link":"/docs/shipping/carriers/overview/dpd","routeSlug":"/docs/shipping/carriers/overview/dpd"},{"type":"link","fsPath":"docs/shipping/carriers/overview/royalmail.md","metadata":{"type":"markdown"},"label":"RoyalMail","link":"/docs/shipping/carriers/overview/royalmail","routeSlug":"/docs/shipping/carriers/overview/royalmail"},{"type":"link","fsPath":"docs/shipping/carriers/overview/appleexpress.md","metadata":{"type":"markdown"},"label":"AppleExpress","link":"/docs/shipping/carriers/overview/appleexpress","routeSlug":"/docs/shipping/carriers/overview/appleexpress"},{"type":"link","fsPath":"docs/shipping/carriers/overview/ontrac.md","metadata":{"type":"markdown"},"label":"OnTrac","link":"/docs/shipping/carriers/overview/ontrac","routeSlug":"/docs/shipping/carriers/overview/ontrac"},{"type":"link","fsPath":"docs/shipping/carriers/overview/lasership.md","metadata":{"type":"markdown"},"label":"Lasership","link":"/docs/shipping/carriers/overview/lasership","routeSlug":"/docs/shipping/carriers/overview/lasership"},{"type":"link","fsPath":"docs/shipping/carriers/overview/roadie.md","metadata":{"type":"markdown"},"label":"Roadie","link":"/docs/shipping/carriers/overview/roadie","routeSlug":"/docs/shipping/carriers/overview/roadie"},{"type":"link","fsPath":"docs/shipping/carriers/overview/addisonlee.md","metadata":{"type":"markdown"},"label":"AddisonLee","link":"/docs/shipping/carriers/overview/addisonlee","routeSlug":"/docs/shipping/carriers/overview/addisonlee"},{"type":"link","fsPath":"docs/shipping/carriers/overview/ontime.md","metadata":{"type":"markdown"},"label":"OnTime","link":"/docs/shipping/carriers/overview/ontime","routeSlug":"/docs/shipping/carriers/overview/ontime"},{"type":"link","fsPath":"docs/shipping/carriers/overview/gls.md","metadata":{"type":"markdown"},"label":"GLS","link":"/docs/shipping/carriers/overview/gls","routeSlug":"/docs/shipping/carriers/overview/gls"},{"type":"link","fsPath":"docs/shipping/carriers/overview/fedexfreight.md","metadata":{"type":"markdown"},"label":"FedEx Freight","link":"/docs/shipping/carriers/overview/fedexfreight","routeSlug":"/docs/shipping/carriers/overview/fedexfreight"},{"type":"link","fsPath":"docs/shipping/carriers/overview/purolatorfreight.md","metadata":{"type":"markdown"},"label":"Purolator Freight","link":"/docs/shipping/carriers/overview/purolatorfreight","routeSlug":"/docs/shipping/carriers/overview/purolatorfreight"},{"type":"link","fsPath":"docs/shipping/carriers/overview/tforce.md","metadata":{"type":"markdown"},"label":"Tforce Mile","link":"/docs/shipping/carriers/overview/tforce","routeSlug":"/docs/shipping/carriers/overview/tforce"},{"type":"link","fsPath":"docs/shipping/carriers/overview/intelcom.md","metadata":{"type":"markdown"},"label":"Intelcom","link":"/docs/shipping/carriers/overview/intelcom","routeSlug":"/docs/shipping/carriers/overview/intelcom"},{"type":"link","fsPath":"docs/shipping/carriers/overview/quickcontractors.md","metadata":{"type":"markdown"},"label":"Quick Contractors","link":"/docs/shipping/carriers/overview/quickcontractors","routeSlug":"/docs/shipping/carriers/overview/quickcontractors"},{"type":"link","fsPath":"docs/shipping/carriers/overview/armour.md","metadata":{"type":"markdown"},"label":"Armour","link":"/docs/shipping/carriers/overview/armour","routeSlug":"/docs/shipping/carriers/overview/armour"},{"type":"link","label":"Carrier Onbording APIs","link":"/openapi/carrieraccounts","routeSlug":"/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"}},"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."}},"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"}},"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"}},"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"}},"httpPath":"/api/v1/hubs"}]}],"separatorLine":true},{"type":"group","label":"Tracking APIs","items":[{"type":"link","label":"Tracking APIs","link":"/openapi/tracking","routeSlug":"/openapi/tracking"},{"type":"group","label":"Tracking","link":"/openapi/tracking/tracking","routeSlug":"/openapi/tracking/tracking","items":[{"label":"Get Shipment Tracking Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tracking/tracking/getshipmenttrackingdetails","routeSlug":"/openapi/tracking/tracking/getshipmenttrackingdetails","metadata":{"seo":{"title":"Get Shipment Tracking Details","description":"Get Shipment Tracking Details"}},"httpPath":"/api/v1/tracking/{trackingNumber}"},{"label":"Subscribe Tracking Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tracking/tracking/subscribeshipmenttrackingdetails","routeSlug":"/openapi/tracking/tracking/subscribeshipmenttrackingdetails","metadata":{"seo":{"title":"Subscribe Tracking Details","description":"Subscribe To Shipment Tracking Details"}},"httpPath":"/api/v1/track/{trackingNumber}/subscribe"}]}],"separatorLine":true},{"type":"group","label":"Webhook APIs","items":[{"type":"link","label":"Webhook APIs","link":"/openapi/webhook","routeSlug":"/openapi/webhook"},{"type":"group","label":"Webhook","link":"/openapi/webhook/webhook","routeSlug":"/openapi/webhook/webhook","items":[{"label":"Get Applicable Event list for Webhook configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhook/webhook/getevents","routeSlug":"/openapi/webhook/webhook/getevents","metadata":{"seo":{"title":"Get Applicable Event list for Webhook configuration","description":"This operation gets the events details"}},"httpPath":"/api/v1/events"},{"label":"Create Webhook configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhook/webhook/postwebhook","routeSlug":"/openapi/webhook/webhook/postwebhook","metadata":{"seo":{"title":"Create Webhook configuration","description":"Webhook provides the mechanism to push tracking events as they occur. With help of this user would be able to receive events as they are generated and is received to the end user. This operation creates a webhook configuration. It needs details of events for which webhook tracking is required also the URL with its authorization details to which the tracking events be pushed."}},"httpPath":"/api/v1/webhookConfig"},{"label":"Get All Webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhook/webhook/getallwebhook","routeSlug":"/openapi/webhook/webhook/getallwebhook","metadata":{"seo":{"title":"Get All Webhooks","description":"This operation gets all the configured webhook and its details."}},"httpPath":"/api/v1/webhookConfig"},{"label":"Update Webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhook/webhook/putwebhook","routeSlug":"/openapi/webhook/webhook/putwebhook","metadata":{"seo":{"title":"Update Webhook","description":"This operation updates the webhook details"}},"httpPath":"/api/v1/webhookConfig/{webHookConfigID}"},{"label":"Get Webhook details by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhook/webhook/getwebhook","routeSlug":"/openapi/webhook/webhook/getwebhook","metadata":{"seo":{"title":"Get Webhook details by Id","description":"This operation gets the webhook details"}},"httpPath":"/api/v1/webhookConfig/{webHookConfigID}"},{"label":"Delete Webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhook/webhook/deletewebhook","routeSlug":"/openapi/webhook/webhook/deletewebhook","metadata":{"seo":{"title":"Delete Webhook","description":"This operation delete the webhook"}},"httpPath":"/api/v1/webhookConfig/{webHookConfigID}"}]}],"separatorLine":true},{"type":"group","label":"Manifest APIs","items":[{"type":"link","label":"Manifest APIs","link":"/openapi/manifest","routeSlug":"/openapi/manifest"},{"type":"group","label":"Manifest","link":"/openapi/manifest/manifest","routeSlug":"/openapi/manifest/manifest","items":[{"label":"Create Manifest","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/manifest/manifest/createmanifest","routeSlug":"/openapi/manifest/manifest/createmanifest","metadata":{"seo":{"title":"Create Manifest","description":"This operation creates an end-of-day manifest (a compilation of information about all shipments) that combines all shipments of the day into a single form or electronic record, depending on the carrier. For USPS®, this manifest is called a SCAN form (Shipment Confirmation Acceptance Notice), which combines all trackable shipments into a single form with a single barcode. When the carrier scans the barcode, all shipments for that barcode receive an Acceptance event from USPS. If the SCAN form includes shipments from multiple different induction postal codes, this operation generates a multi-page form with one bar code per page.<br>Key Considerations: <br>"}},"httpPath":"/api/v1/manifests"},{"label":"Reprint manifest","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/manifest/manifest/reprintmanifest","routeSlug":"/openapi/manifest/manifest/reprintmanifest","metadata":{"seo":{"title":"Reprint manifest","description":"This operation reprints a manifest for which the initial created manifest request was successful. For USPS, up to 10 reprints of a manifest label are allowed."}},"httpPath":"/api/v1/manifests/reprint"},{"label":"Create Manifest Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/manifest/manifest/createusps3877document","routeSlug":"/openapi/manifest/manifest/createusps3877document","metadata":{"seo":{"title":"Create Manifest Document","description":"This operation creates a USPS 3877 manifest document for ERR shipments."}},"httpPath":"/api/v1/manifest/document"},{"label":"Get Manifest Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/manifest/manifest/get3877document","routeSlug":"/openapi/manifest/manifest/get3877document","metadata":{"seo":{"title":"Get Manifest Document","description":"This operation retrieves the USPS 3877 manifest document by manifest ID."}},"httpPath":"/api/v1/manifest/{manifestId}/document"}]}],"separatorLine":true},{"type":"group","label":"Payments APIs","items":[{"type":"link","label":"Payments APIs","link":"/openapi/payment","routeSlug":"/openapi/payment"},{"type":"group","label":"Payment","link":"/openapi/payment/payment","routeSlug":"/openapi/payment/payment","items":[{"label":"Get Payment Methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payment/payment/getpaymentmethods","routeSlug":"/openapi/payment/payment/getpaymentmethods","metadata":{"seo":{"title":"Get Payment Methods","description":"This operation returns all payment methods (Credit Card, Trust Account , Reserve and Purchase Power accounts) associated with the carrier account (USPS)"}},"httpPath":"/api/v1/payments/methods"},{"label":"Get Payment account balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payment/payment/getpaymentbalance","routeSlug":"/openapi/payment/payment/getpaymentbalance","metadata":{"seo":{"title":"Get Payment account balance","description":"This operation returns balance of Wallet or PB Bank (GFS payment method) accounts."}},"httpPath":"/api/v1/payments/accounts/balance"},{"label":"Set rank of payment method","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payment/payment/setpaymentmethodrank","routeSlug":"/openapi/payment/payment/setpaymentmethodrank","metadata":{"seo":{"title":"Set rank of payment method","description":"This operation sets rank (priority) of payment method for postage refill and subscription billing ."}},"httpPath":"/api/v1/payments/methods/rank"},{"label":"Set Payment Method Status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payment/payment/setpaymentmethodstatus","routeSlug":"/openapi/payment/payment/setpaymentmethodstatus","metadata":{"seo":{"title":"Set Payment Method Status","description":"This operation sets the Payment Method active or inactive."}},"httpPath":"/api/v1/payments/methods/status"},{"label":"Wallet Refill","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/payment/payment/walletrefill","routeSlug":"/openapi/payment/payment/walletrefill","metadata":{"seo":{"title":"Wallet Refill","description":"This operation is used to refill amount to the Wallet"}},"httpPath":"/api/v1/payments/wallet/refill"}]}],"separatorLine":true},{"type":"group","label":"Legacy Shipping APIs","items":[{"type":"link","label":"Legacy Shipping APIs","link":"/openapi/newshipping","routeSlug":"/openapi/newshipping"},{"type":"group","label":"Legacy Endpoints","link":"/openapi/newshipping/legacy-endpoints","routeSlug":"/openapi/newshipping/legacy-endpoints","items":[{"label":"Rate Shop and Get Single Rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/newshipping/legacy-endpoints/getrates","routeSlug":"/openapi/newshipping/legacy-endpoints/getrates","metadata":{"seo":{"title":"Rate Shop and Get Single Rate","description":"Note: This is a legacy API. Please use V2 Rate Shipment API. For migration assistance, contact our API Support team."}},"httpPath":"/api/v1/rates"},{"label":"Create Shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/newshipping/legacy-endpoints/createshipment","routeSlug":"/openapi/newshipping/legacy-endpoints/createshipment","metadata":{"seo":{"title":"Create Shipment","description":"Note: This is a legacy API. Please use V2 Create Shipment API. For migration assistance, contact our API Support team."}},"httpPath":"/api/v1/shipments"},{"label":"Reprint Shipment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/newshipping/legacy-endpoints/reprintshipmentbyid","routeSlug":"/openapi/newshipping/legacy-endpoints/reprintshipmentbyid","metadata":{"seo":{"title":"Reprint Shipment","description":"Note: This is a legacy API. Please use V2 Reprint Shipment API. For migration assistance, contact our API Support team."}},"httpPath":"/api/v1/shipments/{shipmentId}/reprint"},{"label":"Cancel Shipment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/newshipping/legacy-endpoints/cancelshipmentbyid","routeSlug":"/openapi/newshipping/legacy-endpoints/cancelshipmentbyid","metadata":{"seo":{"title":"Cancel Shipment","description":"Note: This is a legacy API. Please use V2 Cancel Shipment API. For migration assistance, contact our API Support team."}},"httpPath":"/api/v1/shipments/{shipmentId}/cancel"}]}],"separatorLine":true}],"separatorLine":true},{"type":"group","label":"OMS","items":[{"type":"link","label":"Order Management APIs","link":"/openapi/ordermanagement","routeSlug":"/openapi/ordermanagement"},{"type":"group","label":"Order","link":"/openapi/ordermanagement/order","routeSlug":"/openapi/ordermanagement/order","items":[{"label":"Create Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/createorder","routeSlug":"/openapi/ordermanagement/order/createorder","metadata":{"seo":{"title":"Create Order","description":"This operation creates a new order in the Order Management System. This API accepts customer details, item information, pricing, and shipping-related data and generates a unique order identifier. The created order is initialized in an unfulfilled state and can be updated or progressed through subsequent OMS operations."}},"httpPath":"/api/v1/orders"},{"label":"Get Order by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/getorderbyid","routeSlug":"/openapi/ordermanagement/order/getorderbyid","metadata":{"seo":{"title":"Get Order by ID","description":"This operation retrives the complete details of a specific order using its unique orderId. - Retrieve all order-related information for tracking or reporting. - Verify order contents and financials before fulfillment."}},"httpPath":"/api/v1/orders/{orderId}"},{"label":"Delete Order by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/deleteorderbyid","routeSlug":"/openapi/ordermanagement/order/deleteorderbyid","metadata":{"seo":{"title":"Delete Order by ID","description":"This operation performs a soft delete of an order identified by orderId. The order is marked as deleted and is no longer available for processing or fulfillment"}},"httpPath":"/api/v1/orders/{orderId}"},{"label":"Partial Order Update by OrderId","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/partialupdateorderbyid","routeSlug":"/openapi/ordermanagement/order/partialupdateorderbyid","metadata":{"seo":{"title":"Partial Order Update by OrderId","description":"This operation updates one or more fields of an existing order.This API is used to modify order data after creation, such as adding items or updating order-level information, without replacing the entire order record."}},"httpPath":"/api/v1/orders/{orderId}"},{"label":"Update Bulk Orders Status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/updateorderbyid","routeSlug":"/openapi/ordermanagement/order/updateorderbyid","metadata":{"seo":{"title":"Update Bulk Orders Status","description":"This API is used to Updates the status of multiple orders in a single request such as UNFULFILLED, ONHOLD, FULFILLED, or CANCELED, based on business or fulfillment actions. Use this API to apply the same status change to more than one order at once."}},"httpPath":"/api/v1/orders/bulk/status"},{"label":"Delete Order Item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/deleteorderitem","routeSlug":"/openapi/ordermanagement/order/deleteorderitem","metadata":{"seo":{"title":"Delete Order Item","description":"Deletes a specific item from an order using its SKU. This operation is used when an item is removed before fulfillment due to order changes or corrections."}},"httpPath":"/api/v1/orders/{orderId}/items"},{"label":"Search Orders by OrderID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/searchorders","routeSlug":"/openapi/ordermanagement/order/searchorders","metadata":{"seo":{"title":"Search Orders by OrderID","description":"This operation returns a list of orders that match the provided search criteria."}},"httpPath":"/api/v1/orders/search"}]},{"type":"group","label":"Tags","link":"/openapi/ordermanagement/tags","routeSlug":"/openapi/ordermanagement/tags","items":[{"label":"Update Tags for an Order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/tags/updatetags","routeSlug":"/openapi/ordermanagement/tags/updatetags","metadata":{"seo":{"title":"Update Tags for an Order","description":"This operation is used to create, update or remove tags associated with a specific order."}},"httpPath":"/api/v1/orders/{orderId}/tags"},{"label":"Update Tags for Bulk Orders","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/tags/bulkupdatetags","routeSlug":"/openapi/ordermanagement/tags/bulkupdatetags","metadata":{"seo":{"title":"Update Tags for Bulk Orders","description":"This operation creates, updates, or removes tags for multiple orders in a single request."}},"httpPath":"/api/v1/orders/bulkTags"}]}],"separatorLine":true},{"type":"group","label":"Analytics","items":[{"type":"link","label":"Pitney Analytics Reporting API","link":"/openapi/analytics","routeSlug":"/openapi/analytics"},{"type":"group","label":"Analytics Reports","link":"/openapi/analytics/analytics-reports","routeSlug":"/openapi/analytics/analytics-reports","items":[{"label":"Get Report Names","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/analytics/analytics-reports/getreportname","routeSlug":"/openapi/analytics/analytics-reports/getreportname","metadata":{"seo":{"title":"Get Report Names","description":"Retrieves the list of report names available to the authenticated user based on enabled features and access permissions."}},"httpPath":"/api/v1/reports/name"},{"label":"Get Report Metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/analytics/analytics-reports/getreportmetadata","routeSlug":"/openapi/analytics/analytics-reports/getreportmetadata","metadata":{"seo":{"title":"Get Report Metadata","description":"Retrieves metadata details for a specified report type, including supported spend type, measures, filters and grouping options."}},"httpPath":"/api/v1/reports/metadata"},{"label":"Retrieve Custom Report Data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/analytics/analytics-reports/getreportdata","routeSlug":"/openapi/analytics/analytics-reports/getreportdata","metadata":{"seo":{"title":"Retrieve Custom Report Data","description":"Retrieves report data based on user-defined filters, measures, and grouping criteria.This endpoint allows users to:"}},"httpPath":"/api/v1/reports"}]}],"separatorLine":true},{"type":"group","label":"Cross-Border APIs","items":[{"type":"link","label":"Overview","link":"/openapi/crossborderdeliveryservices","routeSlug":"/openapi/crossborderdeliveryservices"},{"type":"group","label":"HSClassification","link":"/openapi/crossborderdeliveryservices/hsclassification","routeSlug":"/openapi/crossborderdeliveryservices/hsclassification","items":[{"label":"Get HS Code for Single Country","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/hsclassification/retrievehscode","routeSlug":"/openapi/crossborderdeliveryservices/hsclassification/retrievehscode","metadata":{"seo":{"title":"Get HS Code for Single Country","description":"Returns the full-length HS/HTS tariff code for a single item to a given destination country.Pre-classify products or obtain tariff codes when needed for crossborder transactions from AI models, facilitating customs formalities and the accurate calculation of import charges."}},"httpPath":"/api/v1/crossborder-services/hsclassification"},{"label":"Get HS Codes Across Countries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/hsclassification/retrievehscodebulk","routeSlug":"/openapi/crossborderdeliveryservices/hsclassification/retrievehscodebulk","metadata":{"seo":{"title":"Get HS Codes Across Countries","description":"Returns full-length HS/HTS tariff codes for a single item across multiple destination countries in a single request. This bulk API is useful for global classification needs, allowing businesses to prepare items for international shipping and customs compliance across regions."}},"httpPath":"/api/v1/crossborder-services/hsclassification/bulk"}]},{"type":"group","label":"Restriction","link":"/openapi/crossborderdeliveryservices/restriction","routeSlug":"/openapi/crossborderdeliveryservices/restriction","items":[{"label":"Get Shipping Restrictions for Single Country","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/restriction/returnshipmentrestrictions","routeSlug":"/openapi/crossborderdeliveryservices/restriction/returnshipmentrestrictions","metadata":{"seo":{"title":"Get Shipping Restrictions for Single Country","description":"This API helps determine if the item has regulatory, legal, or carrier-based restrictions for a single destination country. <br/> Use this API to determine which countries are available for listing, and/or perform screenings to determine shipping compliance for crossborder transactions. Responses include restrictions and prohibitions for CITES, Health, Limited Quantity, Hazmat & Dangerous Goods, ITAR and Medical related regulations."}},"httpPath":"/api/v1/crossborder-services/restriction"},{"label":"Get Shipping Restrictions Across Countries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/restriction/returnshipmentbulkrestrictions","routeSlug":"/openapi/crossborderdeliveryservices/restriction/returnshipmentbulkrestrictions","metadata":{"seo":{"title":"Get Shipping Restrictions Across Countries","description":"This API helps determine if the item has regulatory, legal, or carrier-based restrictions for multiple destination countries. <br/> Use this API to determine which countries are available for listing, and/or perform screenings to determine shipping compliance for crossborder transactions. Responses include restrictions and prohibitions for CITES, Health, Limited Quantity, Hazmat & Dangerous Goods, ITAR and Medical related regulations."}},"httpPath":"/api/v1/crossborder-services/restriction/bulk"}]},{"type":"group","label":"Landed Cost Quote","link":"/openapi/crossborderdeliveryservices/landed-cost-quote","routeSlug":"/openapi/crossborderdeliveryservices/landed-cost-quote","items":[{"label":"Calculate Duties and Taxes for Single Country","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/landed-cost-quote/calculatedutiesandtaxes","routeSlug":"/openapi/crossborderdeliveryservices/landed-cost-quote/calculatedutiesandtaxes","metadata":{"seo":{"title":"Calculate Duties and Taxes for Single Country","description":"This API calculates estimated duties and taxes for a basket of items being shipped to a single country.A landed cost is the total of all charges involved in a crossborder transaction, including transportation, import duties and taxes, shipping insurance, and related fees. Use this API to power a superior “duty-paid” checkout experience with accurate D&T estimates, and/or to inform business planning around import costs."}},"httpPath":"/api/v1/crossborder-services/landedCostQuote"},{"label":"Calculate Duties and Taxes for Single Item Across Countries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/landed-cost-quote/calculatebulkdutiesandtaxes","routeSlug":"/openapi/crossborderdeliveryservices/landed-cost-quote/calculatebulkdutiesandtaxes","metadata":{"seo":{"title":"Calculate Duties and Taxes for Single Item Across Countries","description":"This API calculates estimated duties and taxes duties for a single item across multiple destination countries.A landed cost is the total of all charges involved in a crossborder transaction, including transportation, import duties and taxes, shipping insurance, and related fees. Use this API to power a superior \"duty-paid\" checkout experience with accurate D&T estimates, and/or to inform business planning around import costs."}},"httpPath":"/api/v1/crossborder-services/landedCostQuote/bulk"}]},{"type":"group","label":"Denied Party Screening","link":"/openapi/crossborderdeliveryservices/denied-party-screening","routeSlug":"/openapi/crossborderdeliveryservices/denied-party-screening","items":[{"label":"Denied Party Screening","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/crossborderdeliveryservices/denied-party-screening/deniedpartyscreening","routeSlug":"/openapi/crossborderdeliveryservices/denied-party-screening/deniedpartyscreening","metadata":{"seo":{"title":"Denied Party Screening","description":"This API operation is used to submit shipper and/or consignee address information for denied party screening and receive a compliance status indicating whether the address is approved, potentially matched, or matched to a restricted entity. The API does not approve or reject shipments; instead, it provides actionable compliance insights that clients can use to determine next steps."}},"httpPath":"/api/v1/denied-party-screening"}]},{"type":"group","label":"References","items":[{"type":"link","fsPath":"docs/cbds/error-handling.md","metadata":{"type":"markdown"},"label":"CBDS Error Handling","link":"/docs/cbds/error-handling","routeSlug":"/docs/cbds/error-handling"},{"type":"link","fsPath":"docs/cbds/predefined-attributes.md","metadata":{"type":"markdown"},"label":"Predefined Item attributes","link":"/docs/cbds/predefined-attributes","routeSlug":"/docs/cbds/predefined-attributes"},{"type":"link","fsPath":"docs/cbds/calculation-methods.md","metadata":{"type":"markdown"},"label":"Duty and Tax Calculation Methods","link":"/docs/cbds/calculation-methods","routeSlug":"/docs/cbds/calculation-methods"},{"type":"link","fsPath":"docs/cbds/shipping-destination-countries.md","metadata":{"type":"markdown"},"label":"Supported Shipping and Destination Countries","link":"/docs/cbds/shipping-destination-countries","routeSlug":"/docs/cbds/shipping-destination-countries"}]}],"separatorLine":true},{"type":"group","label":"Shared APIs","items":[{"type":"group","label":"Address APIs","items":[{"type":"link","label":"Address APIs","link":"/openapi/address","routeSlug":"/openapi/address"},{"type":"group","label":"Address","link":"/openapi/address/address","routeSlug":"/openapi/address/address","items":[{"label":"Address Validate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/address/address/addressvalidate","routeSlug":"/openapi/address/address/addressvalidate","metadata":{"seo":{"title":"Address Validate","description":"This operation validates addresses to improve postal accuracy within the country (e.g., United States). This ensure that parcels are rated correctly and shipments reach their final destination on time. The validate address operation sends an address for verification, and the response indicates whether the address is valid. <br>Key Considerations:"}},"httpPath":"/api/v1/address/verify"},{"label":"Address Suggest","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/address/address/addresssuggest","routeSlug":"/openapi/address/address/addresssuggest","metadata":{"seo":{"title":"Address Suggest","description":"The Address Suggest API returns address suggestions. Use this API only if the Address Validate API fails to validate an address and returns a 400 error. This API itself does not validate addresses; it returns suggestions based on the information submitted in the request."}},"httpPath":"/api/v1/address/suggest"},{"label":"Address Autocomplete","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/address/address/addressautocomplete","routeSlug":"/openapi/address/address/addressautocomplete","metadata":{"seo":{"title":"Address Autocomplete","description":"The Address Autocomplete API provides intelligent address suggestions for U.S. addresses based on partial input submitted in the searchText query parameter. It returns a structured list of up to 15 suggested addresses, including unit-level details (e.g., apartments or suites) and geographic coordinates when available.<br/>Use Address Validate API to validate the address."}},"httpPath":"/api/v2/address/suggest"},{"label":"International Address Validate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/address/address/addressvalidateintl","routeSlug":"/openapi/address/address/addressvalidateintl","metadata":{"seo":{"title":"International Address Validate","description":"This operation validates international addresses to improve postal accuracy within that country. This ensure that parcels are rated correctly and shipments reach their final destination on time. The International Address Validate operation sends an address for verification, and the response indicates whether the address is valid. <br>Key Considerations:"}},"httpPath":"/api/v1/address/verify/intl"}]}]},{"type":"group","label":"Address Book APIs","items":[{"type":"link","label":"Address Book APIs","link":"/openapi/addressbook","routeSlug":"/openapi/addressbook"},{"type":"group","label":"Contact","link":"/openapi/addressbook/contact","routeSlug":"/openapi/addressbook/contact","items":[{"label":"Create Contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/addressbook/contact/addcontact","routeSlug":"/openapi/addressbook/contact/addcontact","metadata":{"seo":{"title":"Create Contact","description":"This operaion add a new Contact in the Address book."}},"httpPath":"/api/v1/contact"},{"label":"Get Contact by contactID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/addressbook/contact/getcontact","routeSlug":"/openapi/addressbook/contact/getcontact","metadata":{"seo":{"title":"Get Contact by contactID","description":"This API retrieves the details of a contact using the unique contactId. The contactId is generated when the contact is created."}},"httpPath":"/api/v1/contact/{contactId}"},{"label":"Update Contact details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/addressbook/contact/updatecontact","routeSlug":"/openapi/addressbook/contact/updatecontact","metadata":{"seo":{"title":"Update Contact details","description":"This operation will update existing contact's details."}},"httpPath":"/api/v1/contact/{contactId}"},{"label":"Update specific fields of Contact","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/addressbook/contact/updatespecificcontactfield","routeSlug":"/openapi/addressbook/contact/updatespecificcontactfield","metadata":{"seo":{"title":"Update specific fields of Contact","description":"This operation updates specific fields of contact.Only the fields that need to be updated should be provided in the request. All other fields of the existing address will remain unchanged."}},"httpPath":"/api/v1/contact/{contactId}"},{"label":"Delete contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/addressbook/contact/deletecontact","routeSlug":"/openapi/addressbook/contact/deletecontact","metadata":{"seo":{"title":"Delete contact","description":"This operation deletes an existing Contact from the address book using its contactId."}},"httpPath":"/api/v1/contact/{contactId}"},{"label":"Get Contact list or Search Contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/addressbook/contact/searchcontact","routeSlug":"/openapi/addressbook/contact/searchcontact","metadata":{"seo":{"title":"Get Contact list or Search Contact","description":"This operation retrieves a list of contacts or searches for specific contacts based on the provided filters."}},"httpPath":"/api/v1/contact/search"}]},{"type":"group","label":"Department","link":"/openapi/addressbook/department","routeSlug":"/openapi/addressbook/department","items":[{"label":"Get Department list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/addressbook/department/getdepartments","routeSlug":"/openapi/addressbook/department/getdepartments","metadata":{"seo":{"title":"Get Department list","description":"This operation retrieves all the departments. (For now, departments can only be created from the UI.)"}},"httpPath":"/api/v1/departments"},{"label":"Get Contact list for a Department","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/addressbook/department/getdepartmentcontacts","routeSlug":"/openapi/addressbook/department/getdepartmentcontacts","metadata":{"seo":{"title":"Get Contact list for a Department","description":"This operation retrieves all the contacts of the specified department"}},"httpPath":"/api/v1/departments/{departmentId}/contacts"}]}]},{"type":"group","label":"Cost Account APIs","items":[{"type":"link","label":"Cost Account APIs","link":"/openapi/costaccount","routeSlug":"/openapi/costaccount"},{"type":"group","label":"Cost Account Management","link":"/openapi/costaccount/cost-account-management","routeSlug":"/openapi/costaccount/cost-account-management","items":[{"label":"Add Cost Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/addcostaccount","routeSlug":"/openapi/costaccount/cost-account-management/addcostaccount","metadata":{"seo":{"title":"Add Cost Account","description":"This operation creates cost account. <br>"}},"httpPath":"/api/v1/costAccounts"},{"label":"Get Cost Accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/getcostaccounts","routeSlug":"/openapi/costaccount/cost-account-management/getcostaccounts","metadata":{"seo":{"title":"Get Cost Accounts","description":"This operation gets cost account details"}},"httpPath":"/api/v1/costAccounts"},{"label":"Update Cost Account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/updatecostaccount","routeSlug":"/openapi/costaccount/cost-account-management/updatecostaccount","metadata":{"seo":{"title":"Update Cost Account","description":"Update Cost Account"}},"httpPath":"/api/v1/costAccounts/{costaccountId}"},{"label":"Get Cost Account Details by Cost Account ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/getcostaccount","routeSlug":"/openapi/costaccount/cost-account-management/getcostaccount","metadata":{"seo":{"title":"Get Cost Account Details by Cost Account ID","description":"This operation gets the Cost account by cost account ID"}},"httpPath":"/api/v1/costAccounts/{costaccountId}"},{"label":"Delete Cost Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/deletecostaccount","routeSlug":"/openapi/costaccount/cost-account-management/deletecostaccount","metadata":{"seo":{"title":"Delete Cost Account","description":"This operation archive the cost account"}},"httpPath":"/api/v1/costAccounts/{costaccountId}"},{"label":"Create Cost Account Import Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/importcostaccount","routeSlug":"/openapi/costaccount/cost-account-management/importcostaccount","metadata":{"seo":{"title":"Create Cost Account Import Job","description":"This operation is used for creating a job for Cost Accounts Import. The payload for this endpoint is an empty JSON object {} because it does not require any additional data to be sent in the request body. jobID and url is returned in the response where user can upload csv file containing cost accounts. Download the sample-cost-accounts-import file."}},"httpPath":"/api/v1/costAccounts/importUrl"},{"label":"Process Import Cost Account Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/processimportcostaccount","routeSlug":"/openapi/costaccount/cost-account-management/processimportcostaccount","metadata":{"seo":{"title":"Process Import Cost Account Job","description":"This operation processes (executes) the existing Batch job. The {jobID} path parameter is required to identify which batch job to process. The payload for this endpoint is an empty JSON object {} because it does not require any additional data to be sent in the request body. Once the job is processed, system will read the uploaded csv file, validate the data and create cost accounts based on that. In case of any error in the file, cost account will not be created and error csv file will be generated for details of error.The payload for this endpoint is an empty JSON object {} because it does not require any additional data to be sent in the request body. The jobId parameter in the endpoint URL specifies which batch of shipments to process."}},"httpPath":"/api/v1/costAccounts/batch/{jobID}/process"},{"label":"Get Import Cost Account Job Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/importcostaccountstatus","routeSlug":"/openapi/costaccount/cost-account-management/importcostaccountstatus","metadata":{"seo":{"title":"Get Import Cost Account Job Status","description":"This operation retrieves the status of an existing Batch identified by {jobID}. The response will provide information about its current status and whether the job has been completed. In case of error, an error CSV file will be generated with details of the error."}},"httpPath":"/api/v1/costAccounts/batch/{jobID}/status"}]}]},{"type":"group","label":"Billing Codes APIs","items":[{"type":"link","label":"Overview","link":"/openapi/billingcodes","routeSlug":"/openapi/billingcodes"},{"type":"group","label":"Account Code","link":"/openapi/billingcodes/account-code","routeSlug":"/openapi/billingcodes/account-code","items":[{"label":"Create Account Code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/account-code/createaccountcode","routeSlug":"/openapi/billingcodes/account-code/createaccountcode","metadata":{"seo":{"title":"Create Account Code","description":"Creates a new Account Code record. The code should be unique per tenant."}},"httpPath":"/api/v1/accountCodes"},{"label":"Get Account Codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/account-code/getaccountcodes","routeSlug":"/openapi/billingcodes/account-code/getaccountcodes","metadata":{"seo":{"title":"Get Account Codes","description":"Returns a list of Account Codes.Use sortBy to sort results by a supported field and direction."}},"httpPath":"/api/v1/accountCodes"},{"label":"Get Account Code by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/account-code/getaccountcodebyid","routeSlug":"/openapi/billingcodes/account-code/getaccountcodebyid","metadata":{"seo":{"title":"Get Account Code by ID","description":"Retrieves a single Account Code by its unique id."}},"httpPath":"/api/v1/accountCodes/{id}"},{"label":"Update Account Code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/account-code/updateaccountcode","routeSlug":"/openapi/billingcodes/account-code/updateaccountcode","metadata":{"seo":{"title":"Update Account Code","description":"Update the code and/or description for the specified id. Use this to revise an Account Code record."}},"httpPath":"/api/v1/accountCodes/{id}"},{"label":"Delete Account Code","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/account-code/deleteaccountcodebyid","routeSlug":"/openapi/billingcodes/account-code/deleteaccountcodebyid","metadata":{"seo":{"title":"Delete Account Code","description":"Deletes the Account Code identified by id."}},"httpPath":"/api/v1/accountCodes/{id}"}]},{"type":"group","label":"Company Code","link":"/openapi/billingcodes/company-code","routeSlug":"/openapi/billingcodes/company-code","items":[{"label":"Create Company Code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/company-code/createcompanycode","routeSlug":"/openapi/billingcodes/company-code/createcompanycode","metadata":{"seo":{"title":"Create Company Code","description":"Creates a new Company Code record. The code must be unique per tenant."}},"httpPath":"/api/v1/companyCodes"},{"label":"Get Company Codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/company-code/getcompanycodes","routeSlug":"/openapi/billingcodes/company-code/getcompanycodes","metadata":{"seo":{"title":"Get Company Codes","description":"Returns a list of Company Codes."}},"httpPath":"/api/v1/companyCodes"},{"label":"Get Company Code by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/company-code/getcompanycodebyid","routeSlug":"/openapi/billingcodes/company-code/getcompanycodebyid","metadata":{"seo":{"title":"Get Company Code by ID","description":"Retrieves a single Company Code by its unique id."}},"httpPath":"/api/v1/companyCodes/{id}"},{"label":"Update Company Code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/company-code/updatecompanycode","routeSlug":"/openapi/billingcodes/company-code/updatecompanycode","metadata":{"seo":{"title":"Update Company Code","description":"Update the code and/or description for the specified id."}},"httpPath":"/api/v1/companyCodes/{id}"},{"label":"Delete Company Code","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/company-code/deletecompanycodebyid","routeSlug":"/openapi/billingcodes/company-code/deletecompanycodebyid","metadata":{"seo":{"title":"Delete Company Code","description":"Deletes the Company Code identified by id."}},"httpPath":"/api/v1/companyCodes/{id}"}]}]},{"type":"group","label":"Location APIs","items":[{"type":"link","label":"Overview","link":"/openapi/location","routeSlug":"/openapi/location"},{"type":"group","label":"Location Management","link":"/openapi/location/location-management","routeSlug":"/openapi/location/location-management","items":[{"label":"Get Divisions Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/location/location-management/getdivisions","routeSlug":"/openapi/location/location-management/getdivisions","metadata":{"seo":{"title":"Get Divisions Details","description":"This operation provides the divisions details."}},"httpPath":"/api/v1/divisions"},{"label":"Get Locations Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/location/location-management/getlocations","routeSlug":"/openapi/location/location-management/getlocations","metadata":{"seo":{"title":"Get Locations Details","description":"This operation provides the location details with the subscription."}},"httpPath":"/api/v1/locations"}]}]},{"type":"group","label":"Custom Fields APIs","items":[{"type":"link","label":"Custom Fields APIs","link":"/openapi/customfields","routeSlug":"/openapi/customfields"},{"type":"group","label":"Custom Fields","link":"/openapi/customfields/custom-fields","routeSlug":"/openapi/customfields/custom-fields","items":[{"label":"Get Custom Fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfields/custom-fields/getcustomfield","routeSlug":"/openapi/customfields/custom-fields/getcustomfield","metadata":{"seo":{"title":"Get Custom Fields","description":"This operation retrieves the list of custom fields defined on the platform. <br/>Custom fields are additional package fields that can be displayed on PitneyTrack workflow pages.Custom fields can be created from My Settings > Custom Fields > Add Custom Field in the platform settings."}},"httpPath":"/api/v1/customfields"},{"label":"Get Custom Field By ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customfields/custom-fields/getcustomfieldbyid","routeSlug":"/openapi/customfields/custom-fields/getcustomfieldbyid","metadata":{"seo":{"title":"Get Custom Field By ID","description":"Retrieves the details of a custom field using its unique custom field ID.<br/>Custom fields can be created from My Settings > Custom Fields > Add Custom Field in the platform settings"}},"httpPath":"/api/v1/customfields/{customFieldId}"}]}]}],"separatorLine":true},{"type":"group","label":"Partner APIs","items":[{"type":"group","label":"Partners APIs","items":[{"type":"link","label":"Developer Partner APIs","link":"/openapi/partneraccount","routeSlug":"/openapi/partneraccount"},{"type":"group","label":"Invitation","link":"/openapi/partneraccount/invitation","routeSlug":"/openapi/partneraccount/invitation","items":[{"label":"Create Merchant onboarding Invitation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/partneraccount/invitation/createpartnerinvitation","routeSlug":"/openapi/partneraccount/invitation/createpartnerinvitation","metadata":{"seo":{"title":"Create Merchant onboarding Invitation","description":"\"This operation creates the partner onboarding email invitation. These are the requirements to create this request:"}},"httpPath":"/api/v1/invitation"}]}]},{"type":"group","label":"Merchants APIs","items":[{"type":"link","label":"Merchants APIs","link":"/openapi/merchants","routeSlug":"/openapi/merchants"},{"type":"group","label":"Partners","link":"/openapi/merchants/partners","routeSlug":"/openapi/merchants/partners","items":[{"label":"Get All Partners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/merchants/partners/getallpartners","routeSlug":"/openapi/merchants/partners/getallpartners","metadata":{"seo":{"title":"Get All Partners","description":"The operation fetches all partners (merchants and knownshippers) associated to a developer."}},"httpPath":"/api/v1/partners"},{"label":"Get Individual Merchant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/merchants/partners/getpartner","routeSlug":"/openapi/merchants/partners/getpartner","metadata":{"seo":{"title":"Get Individual Merchant","description":"The operation fetches individual merchants associated to a developer."}},"httpPath":"/api/v1/partners/individual"}]}]},{"type":"group","label":"Knownshippers APIs","items":[{"type":"link","label":"Known Shipper APIs","link":"/openapi/knownshipper","routeSlug":"/openapi/knownshipper"},{"type":"group","label":"Known Shipper","link":"/openapi/knownshipper/known-shipper","routeSlug":"/openapi/knownshipper/known-shipper","items":[{"label":"Register Known Shipper","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/knownshipper/known-shipper/registerknownshipper","routeSlug":"/openapi/knownshipper/known-shipper/registerknownshipper","metadata":{"seo":{"title":"Register Known Shipper","description":"This operation registers a merchant as a known shipper."}},"httpPath":"/api/v1/shippers/registration"},{"label":"Update Known Shipper","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/knownshipper/known-shipper/updateknownshipper","routeSlug":"/openapi/knownshipper/known-shipper/updateknownshipper","metadata":{"seo":{"title":"Update Known Shipper","description":"This operation updates details of an existing known shipper.<br/> Body must not be empty."}},"httpPath":"/api/v1/shippers/registration/{shipperID}"},{"label":"Get Known Shipper","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/knownshipper/known-shipper/getknownshipper","routeSlug":"/openapi/knownshipper/known-shipper/getknownshipper","metadata":{"seo":{"title":"Get Known Shipper","description":"This operation retrieves detailed information about a registered known shipper using their unique ID."}},"httpPath":"/api/v1/shippers/{shipperID}"},{"label":"Update Known Shipper State","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/knownshipper/known-shipper/updateknownshipperstate","routeSlug":"/openapi/knownshipper/known-shipper/updateknownshipperstate","metadata":{"seo":{"title":"Update Known Shipper State","description":"This operation change current status of the known shipper<br/> valid values are: Active or Inactive."}},"httpPath":"/api/v1/shippers/{shipperID}"},{"label":"Delete Known Shipper","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/knownshipper/known-shipper/deleteknownshipper","routeSlug":"/openapi/knownshipper/known-shipper/deleteknownshipper","metadata":{"seo":{"title":"Delete Known Shipper","description":"This operation deletes a known shipper using their unique ID."}},"httpPath":"/api/v1/shippers/{shipperID}"}]}]}],"separatorLine":true},{"type":"group","label":"Pitney Locker APIs","items":[{"type":"group","label":"Locker APIs","items":[{"type":"link","label":"Pitney Locker APIs","link":"/openapi/lockers","routeSlug":"/openapi/lockers"},{"type":"group","label":"Locker Bank","link":"/openapi/lockers/locker-bank","routeSlug":"/openapi/lockers/locker-bank","items":[{"label":"Get List of all Locker Banks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lockers/locker-bank/getlockerbanks","routeSlug":"/openapi/lockers/locker-bank/getlockerbanks","metadata":{"seo":{"title":"Get List of all Locker Banks","description":"This API operation returns a list of all available locker banks where packages can be deposited for recipient pickup."}},"httpPath":"/api/v1/lockerBanks"},{"label":"List of Locker Sizes in a Locker Bank","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lockers/locker-bank/lockersizes","routeSlug":"/openapi/lockers/locker-bank/lockersizes","metadata":{"seo":{"title":"List of Locker Sizes in a Locker Bank","description":"This API operation returns all available locker sizes in the specified locker bank to help select an appropriate size for reservations."}},"httpPath":"/api/v1/lockerBanks/{lockerBankId}/lockers/sizes"},{"label":"Get Locker Bank by Locker Bank ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lockers/locker-bank/getlockerbankdetails","routeSlug":"/openapi/lockers/locker-bank/getlockerbankdetails","metadata":{"seo":{"title":"Get Locker Bank by Locker Bank ID","description":"This API operation retrieves detailed information for the specified locker bank along with the list of locker units."}},"httpPath":"/api/v1/lockerBanks/{lockerBankId}"}]},{"type":"group","label":"Locker Unit","link":"/openapi/lockers/locker-unit","routeSlug":"/openapi/lockers/locker-unit","items":[{"label":"Creates a new Reservation for a Locker","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lockers/locker-unit/createreservation","routeSlug":"/openapi/lockers/locker-unit/createreservation","metadata":{"seo":{"title":"Creates a new Reservation for a Locker","description":"This API operation creates a reservation for a locker unit in the specified locker bank."}},"httpPath":"/api/v1/lockerBanks/{lockerBankId}/lockers/reserve"},{"label":"Create a return reservation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lockers/locker-unit/createreturnreservation","routeSlug":"/openapi/lockers/locker-unit/createreturnreservation","metadata":{"seo":{"title":"Create a return reservation","description":"Creates a locker reservation for a return or asset drop-off. Use this endpoint when the depositor needs to place a package or asset into a locker for pickup by a courier, or operations team. The reservation details include the intended receiving contact (e.g., store or department) and the depositor contact (e.g., customer or recipient) who will drop off the package or asset. Once the reservation is created, the depositor can use the provided locker unit information to complete the return drop-off, and the receiving contact can retrieve the item from the locker for processing."}},"httpPath":"/api/v1/lockerBanks/{lockerBankId}/lockers/asset/reserve"},{"label":"Open a locker unit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lockers/locker-unit/openlockerunit","routeSlug":"/openapi/lockers/locker-unit/openlockerunit","metadata":{"seo":{"title":"Open a locker unit","description":"Opens a specific locker unit remotely in the specified locker bank. Use this endpoint when an authorized user needs to unlock a locker unit for package deposit or return drop-off.Note: This API returns a success response only when the locker hardware is configured."}},"httpPath":"/api/v1/lockerBanks/{lockerBankId}/lockers/{lockerUnitId}/open"},{"label":"Free a Reserved Locker Unit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lockers/locker-unit/freereservation","routeSlug":"/openapi/lockers/locker-unit/freereservation","metadata":{"seo":{"title":"Free a Reserved Locker Unit","description":"This API operation release a previously reserved locker unit or remove the reserved package based on the tracking number in the specified locker bank when the reservation needs to be released. Once the locker unit freed, the unit becomes available for new reservations."}},"httpPath":"/api/v1/lockerBanks/{lockerBankId}/lockers/{lockerUnitId}/free"},{"label":"Get Reservation List by Contact ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lockers/locker-unit/getreservationlist","routeSlug":"/openapi/lockers/locker-unit/getreservationlist","metadata":{"seo":{"title":"Get Reservation List by Contact ID","description":"This API operation retrieves all active reservations for the specified contact within the given locker bank. Use this API to view all locker units currently reserved for a particular recipient or department."}},"httpPath":"/api/v1/lockerBanks/{lockerBankId}/lockers/reserved/contact/{contactId}"},{"label":"Get Reservation by Tracking Number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lockers/locker-unit/getreservation","routeSlug":"/openapi/lockers/locker-unit/getreservation","metadata":{"seo":{"title":"Get Reservation by Tracking Number","description":"This API operation retrieves the reservation details for a specific parcel using its tracking number within the specified locker bank."}},"httpPath":"/api/v1/lockerBanks/{lockerBankId}/lockers/reserved/{trackingNumber}"},{"label":"Deposit a package into a locker unit","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lockers/locker-unit/updatedeposit","routeSlug":"/openapi/lockers/locker-unit/updatedeposit","metadata":{"seo":{"title":"Deposit a package into a locker unit","description":"This API operation deposit a package into a locker unit in the specified locker bank"}},"httpPath":"/api/v1/lockerBanks/{lockerBankId}/lockers/{lockerUnitId}/deposit"},{"label":"Update Reservation","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lockers/locker-unit/updatereservation","routeSlug":"/openapi/lockers/locker-unit/updatereservation","metadata":{"seo":{"title":"Update Reservation","description":"This API operation updates the reservation information to add a package into an existing locker unit in the given locker bank."}},"httpPath":"/api/v1/lockerBanks/{lockerBankId}/lockers/{lockerUnitId}/reservation/update"},{"label":"Get locker unit status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lockers/locker-unit/getlockerunitstatus","routeSlug":"/openapi/lockers/locker-unit/getlockerunitstatus","metadata":{"seo":{"title":"Get locker unit status","description":"Retrieves the door status of a specific locker unit in the specified locker bank. Use this endpoint to check whether the locker unit door is open or closed after an open, deposit, pickup, return drop-off, or maintenance operation. <br/> Note: This API returns a success response only when the locker hardware is configured."}},"httpPath":"/api/v1/lockerBanks/{lockerBankId}/lockers/{lockerUnitId}/status"},{"label":"Pickup package from locker unit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lockers/locker-unit/pickuppackage","routeSlug":"/openapi/lockers/locker-unit/pickuppackage","metadata":{"seo":{"title":"Pickup package from locker unit","description":"This API operation is used to pick up deposited packages from locker units within the specified locker bank."}},"httpPath":"/api/v1/lockerBanks/{lockerBankId}/lockers/pickup"}]}]},{"type":"group","label":"Locker Webhook APIs","items":[{"type":"link","label":"Lockers Webhook APIs","link":"/openapi/webhooklocker","routeSlug":"/openapi/webhooklocker"},{"type":"group","label":"Webhook","link":"/openapi/webhooklocker/webhook","routeSlug":"/openapi/webhooklocker/webhook","items":[{"label":"Get Applicable Event list for Webhook configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooklocker/webhook/getevents","routeSlug":"/openapi/webhooklocker/webhook/getevents","metadata":{"seo":{"title":"Get Applicable Event list for Webhook configuration","description":"This operation gets the events details"}},"httpPath":"/api/v1/events"},{"label":"Create Webhook configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooklocker/webhook/postwebhook","routeSlug":"/openapi/webhooklocker/webhook/postwebhook","metadata":{"seo":{"title":"Create Webhook configuration","description":"Webhook provides the mechanism to push locker events as they occur. With help of this user would be able to receive events as they are generated and is received to the end user. This operation creates a webhook configuration. It needs details of events for which webhook tracking is required also the URL with its authorization details to which the locker events be pushed."}},"httpPath":"/api/v1/webhookConfig"},{"label":"Get All Webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooklocker/webhook/getallwebhook","routeSlug":"/openapi/webhooklocker/webhook/getallwebhook","metadata":{"seo":{"title":"Get All Webhooks","description":"This operation gets all the configured webhook and its details."}},"httpPath":"/api/v1/webhookConfig"},{"label":"Update Webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooklocker/webhook/putwebhook","routeSlug":"/openapi/webhooklocker/webhook/putwebhook","metadata":{"seo":{"title":"Update Webhook","description":"This operation updates the webhook details"}},"httpPath":"/api/v1/webhookConfig/{webHookConfigID}"},{"label":"Get Webhook details by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooklocker/webhook/getwebhook","routeSlug":"/openapi/webhooklocker/webhook/getwebhook","metadata":{"seo":{"title":"Get Webhook details by Id","description":"This operation gets the webhook details"}},"httpPath":"/api/v1/webhookConfig/{webHookConfigID}"},{"label":"Delete Webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooklocker/webhook/deletewebhook","routeSlug":"/openapi/webhooklocker/webhook/deletewebhook","metadata":{"seo":{"title":"Delete Webhook","description":"This operation delete the webhook"}},"httpPath":"/api/v1/webhookConfig/{webHookConfigID}"}]},{"type":"link","fsPath":"docs/webhook/lockerwebhookeventpayloads.md","metadata":{"type":"markdown"},"label":"Locker Webhook Events","link":"/docs/webhook/lockerwebhookeventpayloads","routeSlug":"/docs/webhook/lockerwebhookeventpayloads"}]}],"separatorLine":true},{"type":"group","label":"Receiving APIs","items":[{"type":"link","label":"Receiving APIs","link":"/openapi/receiving","routeSlug":"/openapi/receiving"},{"type":"group","label":"Decode","link":"/openapi/receiving/decode","routeSlug":"/openapi/receiving/decode","items":[{"label":"Decode Tracking Number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/decode/decodetrackingnumber","routeSlug":"/openapi/receiving/decode/decodetrackingnumber","metadata":{"seo":{"title":"Decode Tracking Number","description":"This operation decodes a tracking number from a barcode, extracting package details like carrier information, receiver Id, and package type. It supports 2D barcodes."}},"httpPath":"/api/v1/packages/tracking/decode"}]},{"type":"group","label":"Packages","link":"/openapi/receiving/packages","routeSlug":"/openapi/receiving/packages","items":[{"label":"Generate Tracking Number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/createtrackingnumber","routeSlug":"/openapi/receiving/packages/createtrackingnumber","metadata":{"seo":{"title":"Generate Tracking Number","description":"This API generates a unique tracking number required to add a package.These numbers serve as identifiers for packages throughout their lifecycle. <br> Use this API when a package does not already have a tracking number."}},"httpPath":"/api/v1/trackingNumbers"},{"label":"Create Image","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/createimage","routeSlug":"/openapi/receiving/packages/createimage","metadata":{"seo":{"title":"Create Image","description":"This operation creates an image and provides details about the created image. The image data must be provided in Base64 format in the request body."}},"httpPath":"/api/v1/packages/images"},{"label":"Search Package","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/searchpackage","routeSlug":"/openapi/receiving/packages/searchpackage","metadata":{"seo":{"title":"Search Package","description":"This operation retrieves a list of packages based on the specified search criteria, such as tracking numbers, status, or associated metadata."}},"httpPath":"/api/v1/packages"},{"label":"Add Package","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/createpackage","routeSlug":"/openapi/receiving/packages/createpackage","metadata":{"seo":{"title":"Add Package","description":"This API operation creates a new package in the system and records its associated activity.<br>Each package requires a unique tracking number to be added successfully. If an attempt is made to add multiple packages using the same tracking number, the API will return an error.<br>When to use Add Package API?"}},"httpPath":"/api/v1/packages"},{"label":"Search Packages with Custom Header Mapping","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/searchpackages","routeSlug":"/openapi/receiving/packages/searchpackages","metadata":{"seo":{"title":"Search Packages with Custom Header Mapping","description":"This operation returns package records based on the requested custom header mapping. The request body contains package field names as keys and custom header labels as values. These header labels can be used to display the returned package data with user-defined column names."}},"httpPath":"/api/v1/packages/search"},{"label":"Get Package","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/getpackagepackageid","routeSlug":"/openapi/receiving/packages/getpackagepackageid","metadata":{"seo":{"title":"Get Package","description":"This operation retrive detailed information or activities of a specific package using its unique packageId. <br> The packageId is generated when a package is added to the system"}},"httpPath":"/api/v1/packages/{packageId}"},{"label":"Update Package","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/updatepackage","routeSlug":"/openapi/receiving/packages/updatepackage","metadata":{"seo":{"title":"Update Package","description":"This operation updates the details of an existing package using its unique packageId. Updates include the latest activity performen on the package or current status of the package such as RECEIVED or DELIVERED as well as recording additional information like damage reports, location changes, or other relevant package events."}},"httpPath":"/api/v1/packages/{packageId}"},{"label":"Archive Package","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/archivepackage","routeSlug":"/openapi/receiving/packages/archivepackage","metadata":{"seo":{"title":"Archive Package","description":"This operation marks the specified package as archived by updating its archived status to true. Archiving a package indicates that its lifecycle is complete, and it is no longer actively tracked. While archived packages are removed from active workflows, their records remain accessible for future reference"}},"httpPath":"/api/v1/packages/{packageId}/archive"},{"label":"Get Package By Tracking","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/getpackagebytracking","routeSlug":"/openapi/receiving/packages/getpackagebytracking","metadata":{"seo":{"title":"Get Package By Tracking","description":"This operation retrives a package using its unique tracking number."}},"httpPath":"/api/v1/packages/tracking/{trackingNumber}"}]},{"type":"group","label":"Carrier","link":"/openapi/receiving/carrier","routeSlug":"/openapi/receiving/carrier","items":[{"label":"Retrive Carrier List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/carrier/getcarrierlist","routeSlug":"/openapi/receiving/carrier/getcarrierlist","metadata":{"seo":{"title":"Retrive Carrier List","description":"This operation retrieves a list of carriers associated with the specific location/s."}},"httpPath":"/api/v1/carriers"}]},{"type":"group","label":"Inbound sites","link":"/openapi/receiving/inbound-sites","routeSlug":"/openapi/receiving/inbound-sites","items":[{"label":"Add Inbound Site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/inbound-sites/addinboundsite","routeSlug":"/openapi/receiving/inbound-sites/addinboundsite","metadata":{"seo":{"title":"Add Inbound Site","description":"This operation used for generating Inbound Site Id."}},"httpPath":"/api/v1/inboundsites"},{"label":"Get Inbound Site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/inbound-sites/getinboundsite","routeSlug":"/openapi/receiving/inbound-sites/getinboundsite","metadata":{"seo":{"title":"Get Inbound Site","description":"This operation is used to retrived the Inbound Sites."}},"httpPath":"/api/v1/inboundsites"},{"label":"Update Inbound Site","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/inbound-sites/updateinboundsite","routeSlug":"/openapi/receiving/inbound-sites/updateinboundsite","metadata":{"seo":{"title":"Update Inbound Site","description":"This operation used to update Inbound Site."}},"httpPath":"/api/v1/inboundsites/{inboundSiteId}"},{"label":"Delete Inbound Site","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/inbound-sites/deleteinboundsite","routeSlug":"/openapi/receiving/inbound-sites/deleteinboundsite","metadata":{"seo":{"title":"Delete Inbound Site","description":"This operation is used to delete Inbound Site."}},"httpPath":"/api/v1/inboundsites/{inboundSiteId}"},{"label":"Get against locationId","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/inbound-sites/getlocationinboundsite","routeSlug":"/openapi/receiving/inbound-sites/getlocationinboundsite","metadata":{"seo":{"title":"Get against locationId","description":"This operation is used to retrived Inbound Site against the location."}},"httpPath":"/api/v1/location/inboundsites"}]}],"separatorLine":true},{"type":"group","label":"Reference Guides","items":[{"type":"group","label":"Shipments","items":[{"type":"link","fsPath":"docs/shipping/guides/hazmat-shipment.md","metadata":{"type":"markdown"},"label":"Hazmat Shipment","link":"/docs/shipping/guides/hazmat-shipment","routeSlug":"/docs/shipping/guides/hazmat-shipment"},{"type":"link","fsPath":"docs/shipping/batch/overview.md","metadata":{"type":"markdown"},"label":"Batch Shipment","link":"/docs/shipping/batch/overview","routeSlug":"/docs/shipping/batch/overview"},{"type":"link","fsPath":"docs/shipping/guides/multipiece-shipment.md","metadata":{"type":"markdown"},"label":"Multipiece Shipment","link":"/docs/shipping/guides/multipiece-shipment","routeSlug":"/docs/shipping/guides/multipiece-shipment"},{"type":"link","fsPath":"docs/shipping/shipment/multiparcel.md","metadata":{"type":"markdown"},"label":"Multiparcel Shipment","link":"/docs/shipping/shipment/multiparcel","routeSlug":"/docs/shipping/shipment/multiparcel"}]},{"type":"group","label":"Partner Accounts","items":[{"type":"link","fsPath":"docs/accounts/guides/partner-onboarding.md","metadata":{"type":"markdown"},"label":"Account Onboarding","link":"/docs/accounts/guides/partner-onboarding","routeSlug":"/docs/accounts/guides/partner-onboarding"}]},{"type":"group","label":"Auto Refill","items":[{"type":"link","fsPath":"docs/auto-refill/auto-refill.md","metadata":{"type":"markdown"},"label":"Postage Auto Refill","link":"/docs/auto-refill/auto-refill","routeSlug":"/docs/auto-refill/auto-refill"}]},{"type":"group","label":"Company Logo Signature","items":[{"type":"link","fsPath":"docs/signature-logo/company-signature-logo.md","metadata":{"type":"markdown"},"label":"Company Logo and Signature","link":"/docs/signature-logo/company-signature-logo","routeSlug":"/docs/signature-logo/company-signature-logo"}]},{"type":"group","label":"RateGroup","items":[{"type":"link","fsPath":"docs/rategroup-management/rategroup-guide.md","metadata":{"type":"markdown"},"label":"How To Create RateGroup","link":"/docs/rategroup-management/rategroup-guide","routeSlug":"/docs/rategroup-management/rategroup-guide"}]},{"type":"group","label":"Tracking","items":[{"type":"link","fsPath":"docs/tracking/overview.md","metadata":{"type":"markdown"},"label":"Supported Carriers","link":"/docs/tracking/overview","routeSlug":"/docs/tracking/overview"},{"type":"link","fsPath":"docs/tracking/trackingeventcodes.md","metadata":{"type":"markdown"},"label":"Tracking Event Codes","link":"/docs/tracking/trackingeventcodes","routeSlug":"/docs/tracking/trackingeventcodes"}]},{"type":"group","label":"Cost Accounts","items":[{"type":"link","fsPath":"docs/shared/cost-account-management/overview.md","metadata":{"type":"markdown"},"label":"Importing Cost Accounts","link":"/docs/shared/cost-account-management/overview","routeSlug":"/docs/shared/cost-account-management/overview"}]},{"type":"group","label":"Analytics","items":[{"type":"link","fsPath":"docs/analytics/analytics.md","metadata":{"type":"markdown"},"label":"Analytics","link":"/docs/analytics/analytics","routeSlug":"/docs/analytics/analytics"}]},{"type":"group","label":"WebHook Setup","items":[{"type":"link","fsPath":"docs/webhook/webhook-setup-guide.md","metadata":{"type":"markdown"},"label":"Webhook Services","link":"/docs/webhook/webhook-setup-guide","routeSlug":"/docs/webhook/webhook-setup-guide"},{"type":"link","fsPath":"docs/webhook/webhookeventpayloads.md","metadata":{"type":"markdown"},"label":"Webhook Event Payloads","link":"/docs/webhook/webhookeventpayloads","routeSlug":"/docs/webhook/webhookeventpayloads"}]}],"separatorLine":true},{"type":"group","label":"Resources","items":[{"type":"link","fsPath":"docs/resources/postman.md","metadata":{"type":"markdown"},"label":"Postman Collections","link":"/docs/resources/postman","routeSlug":"/docs/resources/postman"},{"type":"link","fsPath":"docs/overview/sdks.md","metadata":{"type":"markdown"},"label":"SDKs & Client Libraries","link":"/docs/overview/sdks","routeSlug":"/docs/overview/sdks"}],"separatorLine":true},{"type":"group","label":"Support","items":[{"type":"link","fsPath":"docs/support/error-codes.md","metadata":{"type":"markdown"},"label":"Errors","link":"/docs/support/error-codes","routeSlug":"/docs/support/error-codes"},{"type":"link","fsPath":"docs/support/troubleshooting.md","metadata":{"type":"markdown"},"label":"Troubleshooting","link":"/docs/support/troubleshooting","routeSlug":"/docs/support/troubleshooting"},{"type":"link","fsPath":"docs/support/traffic-shaping.md","metadata":{"type":"markdown"},"label":"Traffic Shaping","link":"/docs/support/traffic-shaping","routeSlug":"/docs/support/traffic-shaping"},{"type":"link","fsPath":"docs/support/glossary.md","metadata":{"type":"markdown"},"label":"Glossary","link":"/docs/support/glossary","routeSlug":"/docs/support/glossary"},{"type":"link","fsPath":"docs/support/contact-us.md","metadata":{"type":"markdown"},"label":"Contact Us","link":"/docs/support/contact-us","routeSlug":"/docs/support/contact-us"},{"type":"link","fsPath":"docs/faqs/usps-migration-faqs.md","metadata":{"type":"markdown"},"label":"FAQs","link":"/docs/faqs/usps-migration-faqs","routeSlug":"/docs/faqs/usps-migration-faqs"}],"separatorLine":true},{"type":"group","label":"Release","items":[{"type":"link","fsPath":"docs/releases/index.md","metadata":{"type":"markdown"},"label":"All Releases","link":"/docs/releases","routeSlug":"/docs/releases"},{"type":"link","fsPath":"docs/releases/upcoming.md","metadata":{"type":"markdown"},"label":"Upcoming Release","link":"/docs/releases/upcoming","routeSlug":"/docs/releases/upcoming"}]},{"type":"group","label":"Others","items":[{"type":"link","fsPath":"docs/others/usps-rate-change-2026.md","metadata":{"type":"markdown"},"label":"USPS Rate Change Updates 2026","link":"/docs/others/usps-rate-change-2026","routeSlug":"/docs/others/usps-rate-change-2026"},{"type":"link","fsPath":"docs/others/upload-document.md","metadata":{"type":"markdown"},"label":"Upload Shipment Documents","link":"/docs/others/upload-document","routeSlug":"/docs/others/upload-document"}]}]}