{"items":[{"type":"link","label":"ShipSaving Legacy API","link":"/v1/openapi","routeSlug":"/v1/openapi","content":{"contentType":"overview","meta":{"name":"ShipSaving Legacy API"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"ShipSaving Legacy API (v1)","showPageActions":true}],"sectionId":"/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.  Rate limit: 600 requests per minute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRateList","name":"Get Rate","isWebhook":false,"pointer":"/paths/~1api~1rates~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve shipping rates for a given package and address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 600 requests per minute."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentRequest"}},"schemaId":"components/schemas/ShipmentRequest","pointer":"/paths/~1api~1rates~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/rates/list","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShipmentRequest"}},"responseCodes":["200"],"pointer":"/api/rates/list","href":"label-management/getratelist","openApiOperationId":"getRateList","summary":"Get Rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"schemaId":"components/schemas/ShipmentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rate list retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RatingResponse"}},"schemaId":"components/schemas/RatingResponse"}],"pointer":"/paths/~1api~1rates~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RatingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RatingResponse"}}}],"examples":[]}]}]}]},"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.Rate limit: 600 requests per minute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"purchaseLabel","name":"Buy Label","isWebhook":false,"pointer":"/paths/~1api~1rates~1buy/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Buy Label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase a shipping label based on the provided rate ID."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 600 requests per minute."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rate_id","in":"query","schemaId":"schema_114","description":"Unique identifier of the shipping rate.","required":true}],"pointer":"/paths/~1api~1rates~1buy/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/rates/buy","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"rate_id","in":"query","required":true,"schemaId":"schema_114"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/rates/buy","href":"label-management/purchaselabel","openApiOperationId":"purchaseLabel","summary":"Buy Label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Label successfully purchased.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseLabelResponse"}},"schemaId":"components/schemas/PurchaseLabelResponse"}],"pointer":"/paths/~1api~1rates~1buy/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseLabelResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseLabelResponse"}}}],"examples":[]}]}]}]},"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.  Rate limit: 600 requests per minute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"directlyBuyLabel","name":"Directly Buy Label","isWebhook":false,"pointer":"/paths/~1api~1rates~1buy-label/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Directly Buy Label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 600 requests per minute."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentRequest"}},"schemaId":"components/schemas/ShipmentRequest","pointer":"/paths/~1api~1rates~1buy-label/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/rates/buy-label","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShipmentRequest"}},"responseCodes":["200"],"pointer":"/api/rates/buy-label","href":"label-management/directlybuylabel","openApiOperationId":"directlyBuyLabel","summary":"Directly Buy Label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"schemaId":"components/schemas/ShipmentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Label successfully purchased","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseLabelResponse"}},"schemaId":"components/schemas/PurchaseLabelResponse"}],"pointer":"/paths/~1api~1rates~1buy-label/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseLabelResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseLabelResponse"}}}],"examples":[]}]}]}]},"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.   Rate limit: 600 requests per minute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"voidLabel","name":"Void Label","isWebhook":false,"pointer":"/paths/~1api~1shipments~1void/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Void Label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voids a purchased shipping label using the shipment’s tracking number.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 600 requests per minute."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_115","exampleIds":["paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_115","exampleIds":["paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1shipments~1void/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipments/void","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_115","exampleIds":["paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/shipments/void","href":"label-management/voidlabel","openApiOperationId":"voidLabel","summary":"Void Label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"schemaId":"schema_115","exampleIds":["paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_115","exampleIds":["paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Label voided successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116","exampleIds":["paths/~1api~1shipments~1void/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_116","exampleIds":["paths/~1api~1shipments~1void/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1shipments~1void/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_116","exampleIds":["paths/~1api~1shipments~1void/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116","exampleIds":["paths/~1api~1shipments~1void/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/api/shipments/void"}],"content":{"contentType":"group","meta":{"name":"Label Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Label Management","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/rates/list","summary":"Get Rate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/label-management/getratelist","deprecated":false},{"title":"/api/rates/buy","summary":"Buy Label","prefix":{"name":"get","color":"get"},"badges":[],"link":"/label-management/purchaselabel","deprecated":false},{"title":"/api/rates/buy-label","summary":"Directly Buy Label","prefix":{"name":"post","color":"post"},"badges":[],"link":"/label-management/directlybuylabel","deprecated":false},{"title":"/api/shipments/void","summary":"Void Label","prefix":{"name":"post","color":"post"},"badges":[],"link":"/label-management/voidlabel","deprecated":false}]}]}]}]}},{"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.Rate limit: 300 requests per minute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrders","name":"Create Orders","isWebhook":false,"pointer":"/paths/~1api~1orders~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new order in the ShipSaving system. Typically used to pre-create orders before generating shipping labels."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 300 requests per minute."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrderRequest"}},"schemaId":"components/schemas/CreateOrderRequest","pointer":"/paths/~1api~1orders~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/create","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateOrderRequest"}},"responseCodes":["200"],"pointer":"/api/orders/create","href":"order-management/createorders","openApiOperationId":"createOrders","summary":"Create Orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"schemaId":"components/schemas/CreateOrderRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrderRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_117"}},"schemaId":"schema_117"}],"pointer":"/paths/~1api~1orders~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_117","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_117"}}}],"examples":[]}]}]}]},"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. Rate limit: 120 requests per minute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkOrderLabels","name":"Check Order Labels","isWebhook":false,"pointer":"/paths/~1api~1shipments~1get/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check Order Labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the shipment label details for a specified store and order number. Applicable only to orders with a purchased shipping label."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 120 requests per minute."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"store_name","in":"query","schemaId":"schema_114","description":"Store name in the ShipSaving system","required":true},{"name":"order_number","in":"query","schemaId":"schema_114","description":"Order number associated with the purchased label","required":true}],"pointer":"/paths/~1api~1shipments~1get/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipments/get","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"store_name","in":"query","required":true,"schemaId":"schema_114"},{"name":"order_number","in":"query","required":true,"schemaId":"schema_114"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipments/get","href":"order-management/checkorderlabels","openApiOperationId":"checkOrderLabels","summary":"Check Order Labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118"}},"schemaId":"schema_118"}],"pointer":"/paths/~1api~1shipments~1get/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_118","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118"}}}],"examples":[]}]}]}]},"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. Rate limit: 300 requests per minute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrder","name":"Delete an order","isWebhook":false,"pointer":"/paths/~1api~1orders~1delete/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 300 requests per minute."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_119"}},"schemaId":"schema_119","pointer":"/paths/~1api~1orders~1delete/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/orders/delete","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_119"}},"responseCodes":["200","400"],"pointer":"/api/orders/delete","href":"order-management/deleteorder","openApiOperationId":"deleteOrder","summary":"Delete an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"schemaId":"schema_119","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_119"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order deleted successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_120","exampleIds":["paths/~1api~1orders~1delete/delete/responses/200/content/application~1json/example"]}},"schemaId":"schema_120","exampleIds":["paths/~1api~1orders~1delete/delete/responses/200/content/application~1json/example"]},{"code":"400","description":"Error occurred while deleting order","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_121","exampleIds":["paths/~1api~1orders~1delete/delete/responses/400/content/application~1json/example"]}},"schemaId":"schema_121","exampleIds":["paths/~1api~1orders~1delete/delete/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1delete/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_120","exampleIds":["paths/~1api~1orders~1delete/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_120","exampleIds":["paths/~1api~1orders~1delete/delete/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_121","exampleIds":["paths/~1api~1orders~1delete/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_121","exampleIds":["paths/~1api~1orders~1delete/delete/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/api/orders/delete"}],"content":{"contentType":"group","meta":{"name":"Order Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Management","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/orders/create","summary":"Create Orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-management/createorders","deprecated":false},{"title":"/api/shipments/get","summary":"Check Order Labels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-management/checkorderlabels","deprecated":false},{"title":"/api/orders/delete","summary":"Delete an order","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-management/deleteorder","deprecated":false}]}]}]}]}},{"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. Rate limit: 600 requests per minute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyAddress","name":"Address Verification","isWebhook":false,"pointer":"/paths/~1api~1addresses~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Address Verification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies and standardizes an address based on the provided details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API checks for errors and returns suggestions or corrections. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 600 requests per minute."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_122"}},"schemaId":"schema_122","pointer":"/paths/~1api~1addresses~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/addresses/verify","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_122"}},"responseCodes":["200"],"pointer":"/api/addresses/verify","href":"address-verification/verifyaddress","openApiOperationId":"verifyAddress","summary":"Address Verification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"schemaId":"schema_122","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_122"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Address verification result","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123"}],"pointer":"/paths/~1api~1addresses~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}}}],"examples":[]}]}]}]},"httpPath":"/api/addresses/verify"}],"content":{"contentType":"group","meta":{"name":"Address Verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Address Verification","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/addresses/verify","summary":"Address Verification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/address-verification/verifyaddress","deprecated":false}]}]}]}]}},{"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. Rate limit: 60 requests per minute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createScanForms","name":"Create USPS SCAN Form","isWebhook":false,"pointer":"/paths/~1api~1shipments~1scan-forms~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create USPS SCAN Form","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a USPS SCAN Form for the provided list of shipment tracking codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable to shipments with valid USPS tracking numbers. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 60 requests per minute."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_124","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_124","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1shipments~1scan-forms~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipments/scan-forms/create","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_124","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/shipments/scan-forms/create","href":"scan-form/createscanforms","openApiOperationId":"createScanForms","summary":"Create USPS SCAN Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"schemaId":"schema_124","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_124","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved manifest PDF URL","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_125","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1shipments~1scan-forms~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_125","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]}]},"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.   Rate limit: 60 requests per minute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEcsScanForms","name":"Create DHL eCommerce SCAN Form","isWebhook":false,"pointer":"/paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create DHL eCommerce SCAN Form","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 60 requests per minute."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_124","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_124","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipments/scan-forms/dhl/ecommerce/create","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_124","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/shipments/scan-forms/dhl/ecommerce/create","href":"scan-form/createecsscanforms","openApiOperationId":"createEcsScanForms","summary":"Create DHL eCommerce SCAN Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"schemaId":"schema_124","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_124","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SCAN Form request accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses/200/content/application~1json/examples/success-response"]}},"schemaId":"schema_126","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses/200/content/application~1json/examples/success-response"]}],"pointer":"/paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_126","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses/200/content/application~1json/examples/success-response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses/200/content/application~1json/examples/success-response"]}}}],"examples":[]}]}]}]},"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.   Rate limit: 60 requests per minute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEcsScanForms","name":"Get DHL eCommerce SCAN Form","isWebhook":false,"pointer":"/paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get DHL eCommerce SCAN Form","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the DHL eCommerce SCAN Form PDF URL based on the request ID from the creation endpoint.  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 60 requests per minute."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"request_id","in":"query","schemaId":"schema_127","description":"Request ID returned from the Create SCAN Form API","required":true}],"pointer":"/paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipments/scan-forms/dhl/ecommerce/get","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"request_id","in":"query","required":true,"schemaId":"schema_127"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipments/scan-forms/dhl/ecommerce/get","href":"scan-form/getecsscanforms","openApiOperationId":"getEcsScanForms","summary":"Get DHL eCommerce SCAN Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved manifest PDF URL","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_125","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_125","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_125","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/api/shipments/scan-forms/dhl/ecommerce/get"}],"content":{"contentType":"group","meta":{"name":"SCAN Form"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SCAN Form","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/shipments/scan-forms/create","summary":"Create USPS SCAN Form","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scan-form/createscanforms","deprecated":false},{"title":"/api/shipments/scan-forms/dhl/ecommerce/create","summary":"Create DHL eCommerce SCAN Form","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scan-form/createecsscanforms","deprecated":false},{"title":"/api/shipments/scan-forms/dhl/ecommerce/get","summary":"Get DHL eCommerce SCAN Form","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scan-form/getecsscanforms","deprecated":false}]}]}]}]}},{"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.Rate limit: 60 requests per minute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCarrierAccountList","name":"Get Carrier Account List","isWebhook":false,"pointer":"/paths/~1api~1carrier-account~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Carrier Account List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the list of carrier accounts associated with the authenticated API token."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 60 requests per minute."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/carrier-account/list","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/carrier-account/list","href":"carrier-management/getcarrieraccountlist","openApiOperationId":"getCarrierAccountList","summary":"Get Carrier Account List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response with list of carrier accounts","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}},"schemaId":"schema_128"}],"pointer":"/paths/~1api~1carrier-account~1list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_128","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}}}],"examples":[]}]}]}]},"httpPath":"/api/carrier-account/list"}],"content":{"contentType":"group","meta":{"name":"Carrier Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Carrier Management","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/carrier-account/list","summary":"Get Carrier Account List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/carrier-management/getcarrieraccountlist","deprecated":false}]}]}]}]}},{"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.Rate limit: 60 requests per minute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryBalance","name":"Get Account Balance","isWebhook":false,"pointer":"/paths/~1api~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Account Balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves real-time account balance in USD."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 60 requests per minute."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/balance","servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/balance","href":"account-management/querybalance","openApiOperationId":"queryBalance","summary":"Get Account Balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129"}},"schemaId":"schema_129"}],"pointer":"/paths/~1api~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_129","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129"}}}],"examples":[]}]}]}]},"httpPath":"/api/balance"}],"content":{"contentType":"group","meta":{"name":"Account Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Management","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/balance","summary":"Get Account Balance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-management/querybalance","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/street":{"id":"components/schemas/street","kind":"json-schema","title":"street","data":{"type":"string","example":"xxx Grand Avenue"}},"components/schemas/street2":{"id":"components/schemas/street2","kind":"json-schema","title":"street2","data":{"type":"string","description":"Optional secondary address line (e.g., Apt, Suite, Unit, Floor).","example":"Apt 5B"}},"components/schemas/zipcode":{"id":"components/schemas/zipcode","kind":"json-schema","title":"zipcode","data":{"type":"string","example":"90006"}},"components/schemas/city":{"id":"components/schemas/city","kind":"json-schema","title":"city","data":{"type":"string","example":"Los Angeles"}},"components/schemas/state":{"id":"components/schemas/state","kind":"json-schema","title":"state","data":{"type":"string","example":"CA"}},"components/schemas/country":{"id":"components/schemas/country","kind":"json-schema","title":"country","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2-letter code for origin country. This field’s value will be an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 two-digit code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"US"}},"components/schemas/ShipmentRequest":{"id":"components/schemas/ShipmentRequest","kind":"json-schema","title":"ShipmentRequest","data":{"type":"object","required":["from","to","shipments"],"properties":{"request_id":{"type":"string","description":"Unique identifier for this API request. Used for tracking, debugging, and issue resolution. Must be a string up to 64 characters.","example":"req_20251024_abcd1234ef567890"},"carrier":{"type":"object","description":"Carrier information","properties":{"carrier_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to your ShipSaving account Carrier Accounts -> Token"},"children":[]}]}]}],"example":"ca_36f49ebbe91d4006a6583e17ceeec500"}}},"from":{"type":"object","description":"Shipper's address","required":["name","street","city","state","zip","country"],"properties":{"name":{"type":"string","example":"full name"},"company":{"type":"string","example":"company name"},"email":{"type":"string","example":"xxx@gmail.com"},"phone":{"type":"string","description":"Shipper's phone number. Required for international shipments.","example":1237771234},"street":{"type":"string","example":"xxx Grand Ave"},"street2":{"$ref":"#/components/schemas/street2"},"city":{"type":"string","example":"Los Angeles"},"state":{"type":"string","example":"CA"},"zip":{"type":"string","example":90018},"country":{"$ref":"#/components/schemas/country"}}},"to":{"type":"object","description":"Recipient's address","required":["name","street","city","state","zip","country"],"properties":{"name":{"type":"string","example":"full name"},"company":{"type":"string","example":"company name"},"email":{"type":"string","example":"xxx@gmail.com"},"phone":{"type":"string","description":"Recipient's phone number. Required for international shipments.","example":1237771234},"street":{"type":"string","example":"xxx Grand Ave"},"street2":{"$ref":"#/components/schemas/street2"},"city":{"type":"string","example":"Los Angeles"},"state":{"type":"string","example":"CA"},"zip":{"type":"string","example":90018},"country":{"$ref":"#/components/schemas/country"},"residential":{"type":"boolean","description":"Specifies if the address is residential, which can impact the quoted shipping rate.","example":true}}},"shipments":{"type":"array","description":"List of shipments","items":{"type":"object","required":["length","width","height","weight"],"properties":{"length":{"type":"number","description":"Package length (inch)","example":6},"width":{"type":"number","description":"Package width (inch)","example":6},"height":{"type":"number","description":"Package height (inch)","example":6},"weight":{"type":"number","description":"Package weight (pound)","example":1},"packages":{"type":"array","items":{"type":"string","example":"usps_small_flat_rate_box"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field accepts carrier predefined packages.  Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/v1/appendix"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined Carrier Packages Table"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for supported values."},"children":[]}]}]}]},"insurance_amount":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount for insured shipment. Must be used in conjunction with insurance_provider."},"children":[]}]}]}],"example":120},"custom_print1":{"type":"string","description":"Customized print on label.If the label itself supports custom printing content, this field will be printed onto the label.\n","example":"custom print1"},"custom_print2":{"type":"string","description":"Customized print on label.If the label itself supports custom printing content, this field will be printed onto the label.\n","example":"custom print2"},"contents":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of items filed for customs (*required for international)"},"children":[]}]}]}],"items":{"type":"object","required":["weight","description","quantity","value","origin_country"],"properties":{"weight":{"type":"number","description":"Weight of the item in lbs.","example":1},"description":{"type":"string","description":"Description of the item being shipped. Provide accurate and clear details for customs clearance.","example":"T-shirt"},"quantity":{"type":"integer","description":"Total number of identical items in this shipment entry.","example":2},"value":{"type":"number","description":"Declared value of the item in USD.","example":29.99},"hs_tariff_number":{"type":"string","description":"Harmonized System (HS) tariff code of the item.","example":"610910"},"origin_country":{"$ref":"#/components/schemas/country"}}}}}}},"order":{"type":"object","description":"Order information","required":["warehouse_name"],"properties":{"warehouse_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-existing warehouse name in ShipSaving system. (Please refer to your ShipSaving account Warehouses -> Name)"},"children":[]}]}]}],"example":"WH"},"store_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-existing store name in ShipSaving system. (Please refer to your ShipSaving account Stores -> Stores Nickname. If you use order_number, then the store_name of the order is required)"},"children":[]}]}]}]},"order_number":{"type":"string","description":"Pre-existing order number in ShipSaving system. If you need to check label price or buy a label for an order which already existed in our system, then this field is required.\n"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used with order_number; sets order status (awaiting, hold, or shipped) after label purchase. Defaults to awaiting if omitted."},"children":[]}]}]}],"enum":["awaiting","hold","shipped"]},"service_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/v1/appendix"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier Service Types Table"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for supported values."},"children":[]}]}]}],"example":"usps_ground_advantage"},"signature":{"type":"string","enum":["NO_SIGNATURE","SIGNATURE","ADULT_SIGNATURE"]},"insurance_provider":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used with the field insurance_amount."},"children":[]}]}]}],"enum":["SHIPSURANCE","CARRIER"]},"contents_type":{"type":"string","enum":["GIFT","MERCHANDISE","SAMPLE","RETURNED_GOODS","DOCUMENTS"]},"non_delivery_option":{"type":"string","description":"Defines the action to take for undeliverable shipments.","enum":["RETURN","ABANDON"]},"eel_pfc_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the Electronic Export Information (EEI) filing method for this shipment."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ITN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if an Internal Transaction Number was issued after AES filing."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXEMPTION_CODE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the shipment qualifies for an EEI filing exemption."},"children":[]}]}]}],"enum":["ITN","EXEMPTION_CODE"]},"eel_pfc_code":{"type":"string","description":"EEI filing identifier for this shipment.  \nProvide either the Internal Transaction Number (ITN) received from AES, or the exemption code if EEI filing is not required.\n","example":"X20250627012345"},"tax_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recipient‘s taxid"},"children":[]}]}]}],"items":{"type":"object","properties":{"tax_id_type":{"type":"string","enum":["TIN","EIN","SSN","VAT","EORI","IOSS","PAN","VOEC"]},"tax_id_number":{"type":"string","description":"The value corresponding to the tax ID type"},"tax_id_country":{"$ref":"#/components/schemas/country"}}}}}},"options":{"type":"object","description":"Additional shipping options","properties":{"ship_date":{"type":"string","description":"Timestamp in ISO 8601 format, including local time and time zone offset.\n","example":"2024-02-07T10:55:56-08:00"},"require_saturday_delivery":{"type":"boolean","description":"Whether this shipment requires Saturday delivery","example":false},"require_hazmat":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether this shipment contains dangerous goods or hazardous materials (USPS Ground Advantage service only). View "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.uspsdelivers.com/hazmat-shipping-safety/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tutorial"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" about how to package, label and ship HAZMAT for domestic shipments."},"children":[]}]}]}],"example":false},"hazmat_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of hazardous material. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usps_hazmat_820"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for USPS shipments (Class 9 lithium batteries, unmarked package) and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dhlecs_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values for DHL eCommerce shipments. Shipments to or from U.S. offshore destinations (such as Guam, Puerto Rico) generally require "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usps_hazmat_820"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to ship lithium batteries. This parameter must be used in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options.require_hazmat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to take effect."},"children":[]}]}]}],"enum":["usps_hazmat_820","dhlecs_lithium_metal_alloy_contained","dhlecs_lithium_metal_alloy_packed","dhlecs_lithium_metal_alloy_standalone","dhlecs_lithium_ion_contained","dhlecs_lithium_ion_packed","dhlecs_lithium_ion_standalone","dhlecs_limited_quantity","dhlecs_small_quantity_provision","dhlecs_limited_quantities_plt"]},"label_type":{"type":"string","description":"The possible values are \"pdf\" or \"png\". If this parameter is not provided, the default value is \"png\".\n","enum":["png","pdf"],"example":"png"},"require_qr_code":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the shipping label should be generated as a normal label, QR code or barcode.   Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to request a paperless label (e.g., QR code or barcode).   Note: Availability of paperless labels depends on the carrier's support."},"children":[]}]}]}],"example":false}}},"recipient_tax_ids":{"type":"array","description":"Recipient's tax information","items":{"type":"object","properties":{"tax_id_type":{"type":"string","enum":["TIN","EIN","SSN","VAT","EORI","IOSS","PAN","VOEC"]},"tax_id_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recipient_tax_ids parameter"},"children":[]}]}]}]}}}}}}},"components/schemas/RatingResponse":{"id":"components/schemas/RatingResponse","kind":"json-schema","title":"RatingResponse","data":{"type":"object","properties":{"rates":{"type":"array","description":"List of shipment rates","items":{"type":"object","properties":{"shipment_id":{"type":"string","example":"ship_bea6cc8c-27f8-4dcf-915e-f6aeed8c5600"},"rate_id":{"type":"string","example":"rate_e50d02e2-047a-402c-aa32-22ad0926db00"},"provider":{"type":"string","description":"Carrier account provider, ShipSaving or user's own account","example":"shipsaving"},"account_name":{"type":"string","example":"USPS"},"carrier":{"type":"string","description":"Carrier, USPS, UPS, FEDEX, or DHL","example":"USPS"},"service":{"type":"string","example":"USPS_GROUND_ADVANTAGE"},"service_type":{"type":"string","example":"usps_ground_advantage"},"package":{"type":"string","example":"PACKAGE"},"package_type":{"type":"string","example":"my_package"},"delivery_days":{"type":"string","description":"Course of traveling days to destination","example":5},"published_rate":{"type":"number","format":"float","description":"Standard shipping rate before discount","example":10.9},"rate":{"type":"number","format":"float","description":"Actual shipping rate after discount","example":8.99},"rebate":{"type":"number","format":"float","example":0.21}}}}}}},"components/schemas/CreateOrderRequest":{"id":"components/schemas/CreateOrderRequest","kind":"json-schema","title":"CreateOrderRequest","data":{"type":"object","required":["store_name","warehouse_name","verify_address","client_name","client_street","client_city","client_state","client_zip","client_country","shipments"],"properties":{"store_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Store nickname as registered in your ShipSaving account (Stores > Stores Nickname)."},"children":[]}]}]}],"example":"CS"},"order_number":{"type":"string","description":"Unique identifier for the order. If omitted, one will be generated automatically.","example":"202402071641"},"warehouse_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warehouse name as listed in your ShipSaving account (Warehouses > Warehouses name)."},"children":[]}]}]}],"example":"WH"},"verify_address":{"type":"boolean","description":"Indicates whether the recipient address should be verified.","example":true},"client_name":{"type":"string","description":"Full name of the recipient.","example":"full name"},"client_company":{"type":"string","description":"Company name of the recipient (if applicable).","example":"company name"},"client_email":{"type":"string","description":"Email address of the recipient.","example":""},"client_phone":{"type":"string","description":"Phone number of the recipient. Required for international shipments.","example":"1234567890"},"client_street":{"type":"string","description":"Primary street address of the recipient.","example":"123 street name"},"client_street2":{"type":"string","description":"Secondary address line, such as apartment or suite number.","example":"apt 123"},"client_city":{"type":"string","description":"City of the recipient's address.","example":"city"},"client_state":{"type":"string","description":"State or province of the recipient's address.","example":"state"},"client_zip":{"type":"string","description":"ZIP or postal code of the recipient's address.","example":"zipcode"},"client_country":{"$ref":"#/components/schemas/country","example":"US"},"shipments":{"type":"array","description":"List of shipment packages included in the order.","items":{"type":"object","properties":{"length":{"type":"number","description":"Length of the package in inches.","example":6},"width":{"type":"number","description":"Width of the package in inches.","example":6},"height":{"type":"number","description":"Height of the package in inches.","example":3},"weight":{"type":"number","description":"Weight of the package in pounds.","example":0.4},"signature":{"type":"string","description":"Signature requirement for delivery.","enum":["NO_SIGNATURE","SIGNATURE","ADULT_SIGNATURE"],"example":"NO_SIGNATURE"},"insurance_provider":{"type":"string","description":"Insurance provider for the shipment.","enum":["SHIPSURANCE","CARRIER."],"example":"SHIPSURANCE"},"insurance_amount":{"type":"number","description":"Value of insurance coverage in USD.","example":200},"custom_print1":{"type":"string","description":"Custom text to appear on the first line of the shipping label.","example":"this is a custom print 1 field"},"custom_print2":{"type":"string","description":"Custom text to appear on the second line of the shipping label.","example":"this is a custom print 2 field"},"items":{"type":"array","description":"List of individual items in the package.","items":{"type":"object","required":["sku","quantity","price"],"properties":{"sku":{"type":"string","description":"Stock Keeping Unit (SKU) of the item.","example":"2PCSFLCX-BLACK_PINK-S"},"title":{"type":"string","description":"Descriptive title of the item.","example":"2 t-shirts"},"quantity":{"type":"integer","description":"Number of units for this item.","example":1},"price":{"type":"number","description":"Unit price of the item.","example":20},"tax":{"type":"number","description":"Sales tax per unit.","example":1.2},"shipping_cost":{"type":"number","description":"Shipping cost allocated to the item.","example":10}}}},"notes":{"type":"array","description":"Optional notes or instructions related to the shipment.","items":{"type":"string"},"example":["note 1","note 2"]}}}}}}},"components/schemas/PurchaseLabelResponse":{"id":"components/schemas/PurchaseLabelResponse","kind":"json-schema","title":"PurchaseLabelResponse","data":{"type":"object","properties":{"packing_slip_number":{"type":"integer","example":109169},"master_tracking_code":{"type":"string","example":""},"prefix_tracking_code":{"type":"string","example":""},"tracking_code":{"type":"string","example":"1ZY50G652000880500"},"label_size":{"type":"string","example":"4x6"},"label_type":{"type":"string","example":"label"},"length":{"type":"number","example":12},"width":{"type":"number","example":12},"height":{"type":"number","example":7},"weight":{"type":"number","example":14.99},"insurance":{"type":"number","example":0},"insurance_fee":{"type":"number","example":0},"signature":{"type":"string","example":"NO_SIGNATURE"},"custom_print1":{"type":"string","example":""},"custom_print2":{"type":"string","example":""},"delivery_days":{"type":"string","example":"1"},"service_fee":{"type":"number","example":0.05},"rate":{"type":"number","example":10.87},"rebate":{"type":"number","example":0},"from_name":{"type":"string","description":"Sender's name","example":"sender name"},"from_company":{"type":"string","description":"Sender's company","example":"ShipSaving, LLC"},"from_phone":{"type":"string","description":"Sender's phone","example":""},"from_street":{"type":"string","description":"Sender's address line 1","example":"769 Broadview Avenue"},"from_street2":{"type":"string","description":"Sender's address line 2","example":""},"from_city":{"type":"string","description":"Sender's city","example":"Toronto"},"from_state":{"type":"string","description":"Sender's state or province","example":"ON"},"from_zip":{"type":"string","description":"Sender's postal code","example":"M4K 2P7"},"from_country":{"type":"string","description":"Sender's country code","example":"CA"},"to_name":{"type":"string","description":"Recipient's name","example":"ShipSaving"},"to_company":{"type":"string","description":"Recipient's company","example":"UPS Plus"},"to_phone":{"type":"string","description":"Recipient's phone","example":""},"to_street":{"type":"string","description":"Recipient's address line 1","example":"961 Broadview Avenue"},"to_street2":{"type":"string","description":"Recipient's address line 2","example":""},"to_city":{"type":"string","description":"Recipient's city","example":"Toronto"},"to_state":{"type":"string","description":"Recipient's state or province","example":"ON"},"to_zip":{"type":"string","description":"Recipient's postal code","example":"M4K 2P7"},"to_country":{"type":"string","description":"Recipient's country code","example":"CA"},"label_status":{"type":"string","example":"completed"},"shipment_id":{"type":"integer","example":1245627},"warehouse_name":{"type":"string","example":"WH"},"store_name":{"type":"string","example":""},"order_number":{"type":"string","example":""},"provider":{"type":"string","example":"shipsaving"},"carrier":{"type":"string","example":"UPS"},"service":{"type":"string","example":"UPS_GROUND"},"package":{"type":"string","example":"PACKAGE"},"published_rate":{"type":"number","example":34.53},"label_url":{"type":"array","items":{"type":"string"},"example":["https://...../labels/2025-06-30/0231b055b64044e6b7e027874e915361_0.pdf"]},"commercial_invoice_url":{"type":"string","nullable":true,"example":null}}}},"schema_114":{"kind":"json-schema","data":{"type":"string"},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"type":"object","required":["tracking_code"],"properties":{"tracking_code":{"type":"string","description":"Shipment tracking number"}}},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"type":"object","properties":{"tracking_code":{"type":"string","description":"The tracking number of the voided label"}}},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"type":"object","properties":{"order_number":{"type":"string","description":"Order number"}}},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"packing_slip_number":{"type":"integer","description":"Packing slip number","example":100108},"carrier":{"type":"string","description":"Carrier's name","example":"UPS"},"predefined_package":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier’s predefined packaging type"},"children":[]}]}]}],"example":""},"service_level":{"type":"string","description":"Carrier service type","example":"ups_ground"},"tracking_code":{"type":"string","description":"Tracking number","example":"1ZXXXXXXXXXXXXXXXX"},"length":{"type":"number","format":"float","description":"Package length (inch)","example":6},"width":{"type":"number","format":"float","description":"Package width (inch)","example":6},"height":{"type":"number","format":"float","description":"Package height (inch)","example":6},"weight":{"type":"number","format":"float","description":"Package weight (lb)","example":1},"rate":{"type":"number","format":"float","description":"Shipping rate","example":5.99},"service_fee":{"type":"number","format":"float","description":"System service fee","example":0.05},"label_width":{"type":"number","format":"float","description":"Label width (inch)","example":4},"label_height":{"type":"number","format":"float","description":"Label height (inch)","example":6},"label_urls":{"type":"array","items":{"type":"string","example":"https://…/labels/2024-10-23/9524d5ac21a744a1954e16ebda769772_0.png"},"description":"List of image URLs for shipping labels"},"commercial_invoice_urls":{"type":"array","items":{"type":"string"},"description":"List of image URLs for commercial invoices","example":null}}}},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"type":"object","required":["store_name","order_number"],"properties":{"store_name":{"type":"string","description":"The store name associated with the order.","example":"xxx 3C Store"},"order_number":{"type":"string","description":"Unique identifier of the order to be deleted.","example":"20240201125047532"}}},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"type":"array","items":{}},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}}},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"type":"object","required":["street","city","zip","country","state"],"properties":{"street":{"$ref":"#/components/schemas/street"},"street2":{"$ref":"#/components/schemas/street2"},"city":{"$ref":"#/components/schemas/city"},"state":{"$ref":"#/components/schemas/state"},"zip":{"$ref":"#/components/schemas/zipcode"},"country":{"$ref":"#/components/schemas/country"}}},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"type":"object","properties":{"street":{"$ref":"#/components/schemas/street"},"street2":{"$ref":"#/components/schemas/street2"},"city":{"$ref":"#/components/schemas/city"},"state":{"$ref":"#/components/schemas/state"},"zip":{"$ref":"#/components/schemas/zipcode"},"country":{"$ref":"#/components/schemas/country"},"residential":{"type":"boolean","example":true},"errored":{"type":"boolean","description":"Whether the address has an error"},"corrected":{"type":"boolean","description":"Whether the address was corrected"},"standardized":{"type":"boolean","description":"Whether the address was standardized"},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"ADDRESS.PRIMARY.INVALID"},"message":{"type":"string","example":"Primary number invalid."}}}},"corrections":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"ADDRESS.COMPONENT.CHANGED"},"message":{"type":"string","example":"An address component (i.e., directional or suffix only) was changed"}}}}}},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"object","properties":{"tracking_codes":{"type":"array","items":{"type":"string"},"description":"List of shipment tracking codes"}},"required":["tracking_codes"]},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Manifest URL to the SCAN Form document (PDF)"}}},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"type":"object","properties":{"request":{"type":"integer","description":"Request ID for fetching the manifest later"}}},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the carrier account","example":"USPS-B"},"token":{"type":"string","description":"The unique token of the carrier account","example":"ca_bc28f2e7_aaaa_4bbb_accc_bf7d9f2c27xx"},"carrier":{"type":"string","description":"The carrier type of the account (e.g., USPS, UPS, FedEx, DHL Express, etc.)","example":"USPS"}}}},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"object","properties":{"balance":{"type":"string","description":"Account balance","example":"173.13"},"currency":{"type":"string","description":"Currency. Only USD is supported.","example":"usd"}}},"id":"schema_129"}},"exampleStore":{"paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example":{"value":{"tracking_code":"9435811899562089111300"},"id":"paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example"},"paths/~1api~1shipments~1void/post/responses/200/content/application~1json/example":{"value":{"tracking_code":"9435811899562089111300"},"id":"paths/~1api~1shipments~1void/post/responses/200/content/application~1json/example"},"paths/~1api~1orders~1delete/delete/responses/200/content/application~1json/example":{"value":[],"id":"paths/~1api~1orders~1delete/delete/responses/200/content/application~1json/example"},"paths/~1api~1orders~1delete/delete/responses/400/content/application~1json/example":{"value":{"message":"Invalid order number or store name"},"id":"paths/~1api~1orders~1delete/delete/responses/400/content/application~1json/example"},"paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example":{"value":{"tracking_codes":["9434611899562089592093","9434611899562089592048"]},"id":"paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example"},"paths/~1api~1shipments~1scan-forms~1create/post/responses/200/content/application~1json/example":{"value":{"url":"https://...../forms/2024-11-01/12345667.pdf"},"id":"paths/~1api~1shipments~1scan-forms~1create/post/responses/200/content/application~1json/example"},"paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example":{"value":{"tracking_codes":["40EB09B82E1146DE9166C499A0B4EA","40EB09B82E1146DE9166C499A0B4DD"]},"id":"paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example"},"paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses/200/content/application~1json/examples/success-response":{"value":{"request":202},"key":"success-response","summary":"success-response","id":"paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses/200/content/application~1json/examples/success-response"},"paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses/200/content/application~1json/example":{"value":{"url":"https://...../forms/2024-11-01/12345667.pdf"},"id":"paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses/200/content/application~1json/example"}},"securitySchemeStore":{"ApiTokenAuth":{"id":"ApiTokenAuth","type":"apiKey","in":"query","paramName":"api_token"}},"servers":[{"url":"https://api.shipsaving.com","description":"Production server"}]},"options":{"hideDownloadButtons":true,"hideReplay":true,"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/v1/openapi.json?download"},{"url":"/_bundle/v1/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"ShipSaving Legacy API","description":""}},"baseSlug":"/v1/openapi","routesMapping":{}}