{"items":[{"type":"link","fsPath":"v1/index.md","metadata":{"type":"markdown"},"label":"Getting Started","link":"/v1","routeSlug":"/v1"},{"type":"separator","separatorLine":true},{"type":"link","label":"ShipSaving Legacy API","link":"/v1/openapi","routeSlug":"/v1/openapi"},{"type":"group","label":"Label Management","link":"/v1/openapi/label-management","routeSlug":"/v1/openapi/label-management","items":[{"label":"Get Rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/label-management/getratelist","routeSlug":"/v1/openapi/label-management/getratelist","metadata":{"seo":{"title":"Get Rate","description":"Retrieve shipping rates for a given package and address. </br> Rate limit: 600 requests per minute."}},"httpPath":"/api/rates/list"},{"label":"Buy Label","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/label-management/purchaselabel","routeSlug":"/v1/openapi/label-management/purchaselabel","metadata":{"seo":{"title":"Buy Label","description":"Purchase a shipping label based on the provided rate ID.</br>Rate limit: 600 requests per minute."}},"httpPath":"/api/rates/buy"},{"label":"Directly Buy Label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/label-management/directlybuylabel","routeSlug":"/v1/openapi/label-management/directlybuylabel","metadata":{"seo":{"title":"Directly Buy Label","description":"Purchases a shipping label directly without comparing multiple carrier options. This endpoint is applicable only when there is a single carrier configured for each carrier type in the user's account. If multiple carriers of the same type exist, use the Get Rate API to retrieve options, then call the Buy Label API to complete the purchase. </br> Rate limit: 600 requests per minute."}},"httpPath":"/api/rates/buy-label"},{"label":"Void Label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/label-management/voidlabel","routeSlug":"/v1/openapi/label-management/voidlabel","metadata":{"seo":{"title":"Void Label","description":"Voids a purchased shipping label using the shipment’s tracking number.  </br> Rate limit: 600 requests per minute."}},"httpPath":"/api/shipments/void"}]},{"type":"group","label":"Order Management","link":"/v1/openapi/order-management","routeSlug":"/v1/openapi/order-management","items":[{"label":"Create Orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/order-management/createorders","routeSlug":"/v1/openapi/order-management/createorders","metadata":{"seo":{"title":"Create Orders","description":"Creates a new order in the ShipSaving system. Typically used to pre-create orders before generating shipping labels.</br>Rate limit: 300 requests per minute."}},"httpPath":"/api/orders/create"},{"label":"Check Order Labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/order-management/checkorderlabels","routeSlug":"/v1/openapi/order-management/checkorderlabels","metadata":{"seo":{"title":"Check Order Labels","description":"Retrieves the shipment label details for a specified store and order number. Applicable only to orders with a purchased shipping label.</br> Rate limit: 120 requests per minute."}},"httpPath":"/api/shipments/get"},{"label":"Delete an order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/order-management/deleteorder","routeSlug":"/v1/openapi/order-management/deleteorder","metadata":{"seo":{"title":"Delete an order","description":"Deletes an existing order from the ShipSaving system by specifying both the store name and order number. This action is irreversible and will permanently remove the order and its associated data.</br> Rate limit: 300 requests per minute."}},"httpPath":"/api/orders/delete"}]},{"type":"group","label":"Address Verification","link":"/v1/openapi/address-verification","routeSlug":"/v1/openapi/address-verification","items":[{"label":"Address Verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/address-verification/verifyaddress","routeSlug":"/v1/openapi/address-verification/verifyaddress","metadata":{"seo":{"title":"Address Verification","description":"Verifies and standardizes an address based on the provided details.This API checks for errors and returns suggestions or corrections. </br>Rate limit: 600 requests per minute."}},"httpPath":"/api/addresses/verify"}]},{"type":"group","label":"SCAN Form","link":"/v1/openapi/scan-form","routeSlug":"/v1/openapi/scan-form","items":[{"label":"Create USPS SCAN Form","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/scan-form/createscanforms","routeSlug":"/v1/openapi/scan-form/createscanforms","metadata":{"seo":{"title":"Create USPS SCAN Form","description":"Creates a USPS SCAN Form for the provided list of shipment tracking codes.Only applicable to shipments with valid USPS tracking numbers. </br>Rate limit: 60 requests per minute."}},"httpPath":"/api/shipments/scan-forms/create"},{"label":"Create DHL eCommerce SCAN Form","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/scan-form/createecsscanforms","routeSlug":"/v1/openapi/scan-form/createecsscanforms","metadata":{"seo":{"title":"Create DHL eCommerce SCAN Form","description":"Initiates the asynchronous creation of a DHL eCommerce SCAN Form. Returns a request ID that can be used with the Get DHL eCommerce SCAN Form endpoint to retrieve the final manifest PDF.  </br> Rate limit: 60 requests per minute."}},"httpPath":"/api/shipments/scan-forms/dhl/ecommerce/create"},{"label":"Get DHL eCommerce SCAN Form","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/scan-form/getecsscanforms","routeSlug":"/v1/openapi/scan-form/getecsscanforms","metadata":{"seo":{"title":"Get DHL eCommerce SCAN Form","description":"Returns the DHL eCommerce SCAN Form PDF URL based on the request ID from the creation endpoint.  </br> Rate limit: 60 requests per minute."}},"httpPath":"/api/shipments/scan-forms/dhl/ecommerce/get"}]},{"type":"group","label":"Carrier Management","link":"/v1/openapi/carrier-management","routeSlug":"/v1/openapi/carrier-management","items":[{"label":"Get Carrier Account List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/carrier-management/getcarrieraccountlist","routeSlug":"/v1/openapi/carrier-management/getcarrieraccountlist","metadata":{"seo":{"title":"Get Carrier Account List","description":"Retrieves the list of carrier accounts associated with the authenticated API token.</br>Rate limit: 60 requests per minute."}},"httpPath":"/api/carrier-account/list"}]},{"type":"group","label":"Account Management","link":"/v1/openapi/account-management","routeSlug":"/v1/openapi/account-management","items":[{"label":"Get Account Balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/openapi/account-management/querybalance","routeSlug":"/v1/openapi/account-management/querybalance","metadata":{"seo":{"title":"Get Account Balance","description":"Retrieves real-time account balance in USD.</br>Rate limit: 60 requests per minute."}},"httpPath":"/api/balance"}]},{"type":"separator","separatorLine":true},{"type":"link","label":"UPS 4th Party API Integration","link":"/v1/ps_openapi","routeSlug":"/v1/ps_openapi"},{"type":"group","label":"Label Management","link":"/v1/ps_openapi/label-management","routeSlug":"/v1/ps_openapi/label-management","items":[{"label":"Get Rates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/ps_openapi/label-management/getratelist","routeSlug":"/v1/ps_openapi/label-management/getratelist","metadata":{"seo":{"title":"Get Rates","description":"Retrieve available shipping rates for the given package dimensions, weight, and origin/destination addresses. Returns rates across all active carrier accounts, sorted by price."}},"httpPath":"/api/rates/list"},{"label":"Buy Label","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/ps_openapi/label-management/buylabel","routeSlug":"/v1/ps_openapi/label-management/buylabel","metadata":{"seo":{"title":"Buy Label","description":"Purchase a shipping label using the rate_id returned by Get Rates."}},"httpPath":"/api/rates/buy"},{"label":"Void Label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/ps_openapi/label-management/voidlabel","routeSlug":"/v1/ps_openapi/label-management/voidlabel","metadata":{"seo":{"title":"Void Label","description":"Void a previously purchased shipping label by tracking number."}},"httpPath":"/api/shipments/void"},{"label":"Get Billing & Void Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/ps_openapi/label-management/getshipmentstatus","routeSlug":"/v1/ps_openapi/label-management/getshipmentstatus","metadata":{"seo":{"title":"Get Billing & Void Status","description":"Retrieve the carrier billing state and void state of a previously purchased label, looked up by tracking number."}},"httpPath":"/api/shipments/status"}]},{"type":"group","label":"Address Validation","link":"/v1/ps_openapi/address-validation","routeSlug":"/v1/ps_openapi/address-validation","items":[{"label":"Verify Address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/ps_openapi/address-validation/verifyaddress","routeSlug":"/v1/ps_openapi/address-validation/verifyaddress","metadata":{"seo":{"title":"Verify Address","description":"Validate and standardize a US shipping address against the address-service registry.Only the United States and its territories (PR, GU, VI, MP, MH, AS) are accepted —all other countries are rejected with HTTP 400."}},"httpPath":"/api/addresses/verify"}]},{"type":"group","label":"Carrier Management","link":"/v1/ps_openapi/carrier-management","routeSlug":"/v1/ps_openapi/carrier-management","items":[{"label":"Create UPS Ghost Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/ps_openapi/carrier-management/createupsghostaccount","routeSlug":"/v1/ps_openapi/carrier-management/createupsghostaccount","metadata":{"seo":{"title":"Create UPS Ghost Account","description":"Create a UPS shipper account on behalf of a merchant through ShipSaving,without requiring manual registration on the UPS website.The account is automatically linked to the merchant's ShipSaving companyand ready for shipping label purchases."}},"httpPath":"/api/carrier/create_ups_ghost_account"}]},{"type":"group","label":"Account Management","link":"/v1/ps_openapi/account-management","routeSlug":"/v1/ps_openapi/account-management","items":[{"label":"Get Account Balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/ps_openapi/account-management/querybalance","routeSlug":"/v1/ps_openapi/account-management/querybalance","metadata":{"seo":{"title":"Get Account Balance","description":"Retrieves real-time account balance in USD."}},"httpPath":"/api/balance"}]},{"type":"separator","separatorLine":true},{"type":"link","fsPath":"v1/changelog.md","metadata":{"type":"markdown"},"label":"Changelog","link":"/v1/changelog","routeSlug":"/v1/changelog"},{"type":"link","fsPath":"v1/appendix.md","metadata":{"type":"markdown"},"label":"Appendix","link":"/v1/appendix","routeSlug":"/v1/appendix"}]}