{"items":[{"type":"link","label":"ShipSaving New API","link":"/v2/openapi","routeSlug":"/v2/openapi","content":{"contentType":"overview","meta":{"name":"ShipSaving New 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://x-api.shipsaving.com","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"ShipSaving New API (v2)","showPageActions":true}],"sectionId":"/v2/openapi"}]}]}},{"type":"group","label":"Authentication","link":"/v2/openapi/authentication","routeSlug":"/v2/openapi/authentication","items":[{"label":"Get Access Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/authentication/getaccesstoken","routeSlug":"/v2/openapi/authentication/getaccesstoken","metadata":{"seo":{"title":"Get Access Token","description":"Issue a short-lived access token using the OAuth 2.1 Client Credentials grant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccessToken","name":"Get Access Token","isWebhook":false,"pointer":"/paths/~1oauth2~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Access Token","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":"Issue a short-lived access token using the OAuth 2.1 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client Credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic base64(AppKey:AppSecret)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type: application/x-www-form-urlencoded"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"Basic auth using AppKey/AppSecret."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_128","exampleIds":["paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample"]}},"schemaId":"schema_128","exampleIds":["paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample"],"pointer":"/paths/~1oauth2~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/oauth2/token","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_128","exampleIds":["paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample"]}},"responseCodes":["200","400","401"],"pointer":"/oauth2/token","href":"authentication/getaccesstoken","openApiOperationId":"getAccessToken","summary":"Get Access Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"schemaId":"schema_128","exampleIds":["paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_128","exampleIds":["paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Access token issued","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenResponse","exampleIds":["paths/~1oauth2~1token/post/responses/200/content/application~1json/examples/success"]}},"schemaId":"components/schemas/TokenResponse","exampleIds":["paths/~1oauth2~1token/post/responses/200/content/application~1json/examples/success"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthError","exampleIds":["paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badContentType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badGrantType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/invalidScope"]}},"schemaId":"components/schemas/OAuthError","exampleIds":["paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badContentType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badGrantType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/invalidScope"]},{"code":"401","description":"Invalid client credentials or expired/invalid token use","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthError"}},"schemaId":"components/schemas/OAuthError"}],"pointer":"/paths/~1oauth2~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TokenResponse","exampleIds":["paths/~1oauth2~1token/post/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenResponse","exampleIds":["paths/~1oauth2~1token/post/responses/200/content/application~1json/examples/success"]}}},{"code":"400","schemaId":"components/schemas/OAuthError","exampleIds":["paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badContentType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badGrantType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/invalidScope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthError","exampleIds":["paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badContentType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badGrantType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/invalidScope"]}}},{"code":"401","schemaId":"components/schemas/OAuthError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthError"}}}],"examples":[]}]}]}]},"httpPath":"/oauth2/token"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/oauth2/token","summary":"Get Access Token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/getaccesstoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Shipment","link":"/v2/openapi/shipment","routeSlug":"/v2/openapi/shipment","items":[{"label":"Batch Quick Rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/shipment/batchquickrate","routeSlug":"/v2/openapi/shipment/batchquickrate","metadata":{"seo":{"title":"Batch Quick Rate","description":"This endpoint allows you to quickly retrieve shipment rate quotes by providing the from_address_data, to_address_data, package_data and the ship_date.Each API call can include up to 10 individual rate requests."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchQuickRate","name":"Batch Quick Rate","isWebhook":false,"pointer":"/paths/~1api~1shipment~1batch~1quick_rate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch Quick 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":"This endpoint allows you to quickly retrieve shipment rate quotes by providing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from_address_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to_address_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"package_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ship_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each API call can include up to 10 individual rate requests."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previously, this endpoint only returned rates for USPS Ground Advantage."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With the new update, you may optionally specify additional carriers and service levels using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipment_rate_carrier_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. A detailed explanation of how to use this parameter can be found in the request schema."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipment_rate_carrier_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will return rates only for USPS Ground Advantage (default behavior)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipment_rate_carrier_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system will return rates only for the specified provider(s) and service level(s)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple combinations may be sent in a single request."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchQuickRateRequest"}},"schemaId":"components/schemas/BatchQuickRateRequest","pointer":"/paths/~1api~1shipment~1batch~1quick_rate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/batch/quick_rate","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchQuickRateRequest"}},"responseCodes":["200"],"pointer":"/api/shipment/batch/quick_rate","href":"shipment/batchquickrate","openApiOperationId":"batchQuickRate","summary":"Batch Quick Rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"schemaId":"components/schemas/BatchQuickRateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchQuickRateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchQuickRateResponse"}},"schemaId":"components/schemas/BatchQuickRateResponse"}],"pointer":"/paths/~1api~1shipment~1batch~1quick_rate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchQuickRateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchQuickRateResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/batch/quick_rate"},{"label":"Get Rates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/shipment/getrates","routeSlug":"/v2/openapi/shipment/getrates","metadata":{"seo":{"title":"Get Rates","description":"Retrieves shipping rates from all active carriers and service levels under your account, optionally filtered by specified carriers and service levels, and returns results sorted by fastest, cheapest, and other criteria along with any applicable error information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRates","name":"Get Rates","isWebhook":false,"pointer":"/paths/~1api~1shipment~1get_rates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves shipping rates from all active carriers and service levels under your account, optionally filtered by specified carriers and service levels, and returns results sorted by fastest, cheapest, and other criteria along with any applicable error information.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentRateRequest"}},"schemaId":"components/schemas/ShipmentRateRequest","pointer":"/paths/~1api~1shipment~1get_rates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/get_rates","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShipmentRateRequest"}},"responseCodes":["200"],"pointer":"/api/shipment/get_rates","href":"shipment/getrates","openApiOperationId":"getRates","summary":"Get Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"schemaId":"components/schemas/ShipmentRateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentRateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRatesResponse"}},"schemaId":"components/schemas/GetRatesResponse"}],"pointer":"/paths/~1api~1shipment~1get_rates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetRatesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRatesResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/get_rates"},{"label":"Buy Label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/shipment/createandpay","routeSlug":"/v2/openapi/shipment/createandpay","metadata":{"seo":{"title":"Buy Label","description":"Creates and pays for a shipment label using the rate_id obtained from a prior get_rates call.This endpoint also allows purchasing shipment insurance in the same request (insurance cannot be purchased separately). "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAndPay","name":"Buy Label","isWebhook":false,"pointer":"/paths/~1api~1shipment~1create_and_pay/post","hasSamples":true},"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":"Creates and pays for a shipment label using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" obtained from a prior "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"get_rates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint also allows purchasing shipment insurance in the same request (insurance cannot be purchased separately). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To prevent duplicate purchases caused by network fluctuations or retries, the API checks ether a shipment already exists under the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform_uk_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a related shipment is found, the existing shipment information will be returned, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duplicate_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the response will be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no shipment exists, a new shipment will be created as normal, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duplicate_label"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BuyLabelRequest"}},"schemaId":"components/schemas/BuyLabelRequest","pointer":"/paths/~1api~1shipment~1create_and_pay/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/create_and_pay","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BuyLabelRequest"}},"responseCodes":["200"],"pointer":"/api/shipment/create_and_pay","href":"shipment/createandpay","openApiOperationId":"createAndPay","summary":"Buy Label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"schemaId":"components/schemas/BuyLabelRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BuyLabelRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentPurchaseResponse"}},"schemaId":"components/schemas/ShipmentPurchaseResponse"}],"pointer":"/paths/~1api~1shipment~1create_and_pay/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShipmentPurchaseResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentPurchaseResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/create_and_pay"},{"label":"Directly Buy Label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/shipment/directbuy","routeSlug":"/v2/openapi/shipment/directbuy","metadata":{"seo":{"title":"Directly Buy Label","description":"Creates and purchases a shipment label in a single step without calling get_rates separately. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"directBuy","name":"Directly Buy Label","isWebhook":false,"pointer":"/paths/~1api~1shipment~1direct_buy/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":"Creates and purchases a shipment label in a single step without calling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"get_rates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separately. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint currently supports USPS Returns service levels. See the Appendix for the full list of supported values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To prevent duplicate purchases caused by network fluctuations or retries, the API checks ether a shipment already exists under the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform_uk_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a related shipment is found, the existing shipment information will be returned, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duplicate_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the response will be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no shipment exists, a new shipment will be created as normal, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duplicate_label"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectBuyShipmentRequest"}},"schemaId":"components/schemas/DirectBuyShipmentRequest","pointer":"/paths/~1api~1shipment~1direct_buy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/direct_buy","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DirectBuyShipmentRequest"}},"responseCodes":["200"],"pointer":"/api/shipment/direct_buy","href":"shipment/directbuy","openApiOperationId":"directBuy","summary":"Directly Buy Label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"schemaId":"components/schemas/DirectBuyShipmentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectBuyShipmentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentPurchaseResponse"}},"schemaId":"components/schemas/ShipmentPurchaseResponse"}],"pointer":"/paths/~1api~1shipment~1direct_buy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShipmentPurchaseResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentPurchaseResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/direct_buy"},{"label":"Void Label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/shipment/voidlabel","routeSlug":"/v2/openapi/shipment/voidlabel","metadata":{"seo":{"title":"Void Label","description":"This endpoint allows voiding label by providing eithershipment_no or platform_uk_id. Only one parameter is required to uniquelyidentify a shipment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"voidLabel","name":"Void Label","isWebhook":false,"pointer":"/paths/~1api~1shipment~1void_label/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":"This endpoint allows voiding label by providing "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"either"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipment_no"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform_uk_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only one parameter is required to uniquely"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identify a shipment."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentVoidRequest"}},"schemaId":"components/schemas/ShipmentVoidRequest","pointer":"/paths/~1api~1shipment~1void_label/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/void_label","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShipmentVoidRequest"}},"responseCodes":["200"],"pointer":"/api/shipment/void_label","href":"shipment/voidlabel","openApiOperationId":"voidLabel","summary":"Void Label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"schemaId":"components/schemas/ShipmentVoidRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentVoidRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonServiceResponse"}},"schemaId":"components/schemas/CommonServiceResponse"}],"pointer":"/paths/~1api~1shipment~1void_label/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonServiceResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonServiceResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/void_label"},{"label":"Query Insurance Rate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/shipment/paths/~1api~1shipment~1insurance~1rate/get","routeSlug":"/v2/openapi/shipment/paths/~1api~1shipment~1insurance~1rate/get","metadata":{"seo":{"title":"Query Insurance Rate","description":"Query Insurance Rate"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Query Insurance Rate","isWebhook":false,"pointer":"/paths/~1api~1shipment~1insurance~1rate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Insurance Rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"declared_value","in":"query","schemaId":"schema_129","description":"Declared value for shipment insurance, representing the insured amount in USD.","required":true,"example":200},{"name":"service_level","in":"query","schemaId":"schema_130","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The insurance quote request must specify a service_level. Pricing varies depending on the selected service level."},"children":[]}]}]}],"required":true,"example":"USPS_GROUND_ADVANTAGE"}],"pointer":"/paths/~1api~1shipment~1insurance~1rate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipment/insurance/rate","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"declared_value","in":"query","required":true,"example":200,"schemaId":"schema_129"},{"name":"service_level","in":"query","required":true,"example":"USPS_GROUND_ADVANTAGE","schemaId":"schema_130"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipment/insurance/rate","href":"shipment/paths/~1api~1shipment~1insurance~1rate/get","summary":"Query Insurance Rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InsuranceRateResponse"}},"schemaId":"components/schemas/InsuranceRateResponse"}],"pointer":"/paths/~1api~1shipment~1insurance~1rate/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InsuranceRateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InsuranceRateResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/insurance/rate"}],"content":{"contentType":"group","meta":{"name":"Shipment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipment","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/shipment/batch/quick_rate","summary":"Batch Quick Rate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/batchquickrate","deprecated":false},{"title":"/api/shipment/get_rates","summary":"Get Rates","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/getrates","deprecated":false},{"title":"/api/shipment/create_and_pay","summary":"Buy Label","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/createandpay","deprecated":false},{"title":"/api/shipment/direct_buy","summary":"Directly Buy Label","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/directbuy","deprecated":false},{"title":"/api/shipment/void_label","summary":"Void Label","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/voidlabel","deprecated":false},{"title":"/api/shipment/insurance/rate","summary":"Query Insurance Rate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/paths/~1api~1shipment~1insurance~1rate/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Tracking","link":"/v2/openapi/tracking","routeSlug":"/v2/openapi/tracking","items":[{"label":"Query tracking status by tracking no (with UTC offset)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/tracking/getshipmenttrackingwithutcoffset","routeSlug":"/v2/openapi/tracking/getshipmenttrackingwithutcoffset","metadata":{"seo":{"title":"Query tracking status by tracking no (with UTC offset)","description":"Retrieves the current shipment tracking event, first scan tracking event, and the complete tracking event history as reported by the carrier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShipmentTrackingWithUtcOffset","name":"Query tracking status by tracking no (with UTC offset)","isWebhook":false,"pointer":"/paths/~1api~1shipment~1direct~1tracking_by_tracking_no/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query tracking status by tracking no (with UTC offset)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the current shipment tracking event, first scan tracking event, and the\ncomplete tracking event history as reported by the carrier.\n\n\nThis endpoint returns all tracking event timestamps in ISO 8601 format with the\nUTC offset included, allowing clients to accurately interpret local event times\nacross different time zones.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tracking_no","in":"query","schemaId":"schema_130","description":"tracking number","required":true,"example":"940013620842281000000"},{"name":"carrier_code","in":"query","schemaId":"schema_131","description":"carrier code","required":true}],"pointer":"/paths/~1api~1shipment~1direct~1tracking_by_tracking_no/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipment/direct/tracking_by_tracking_no","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"tracking_no","in":"query","required":true,"example":"940013620842281000000","schemaId":"schema_130"},{"name":"carrier_code","in":"query","required":true,"example":"USPS","schemaId":"schema_131"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipment/direct/tracking_by_tracking_no","href":"tracking/getshipmenttrackingwithutcoffset","openApiOperationId":"getShipmentTrackingWithUtcOffset","summary":"Query tracking status by tracking no (with UTC offset)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrackingStatusWithUtcOffsetResponse"}},"schemaId":"components/schemas/TrackingStatusWithUtcOffsetResponse"}],"pointer":"/paths/~1api~1shipment~1direct~1tracking_by_tracking_no/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrackingStatusWithUtcOffsetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrackingStatusWithUtcOffsetResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/direct/tracking_by_tracking_no"},{"label":"Submit Proof of Delivery","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/tracking/submitpod","routeSlug":"/v2/openapi/tracking/submitpod","metadata":{"seo":{"title":"Submit Proof of Delivery","description":"Submits a Proof of Delivery request for a delivered shipment. Only USPS (carrier_code = USPS) is supported today; other carriers are rejected with a business error."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submitPod","name":"Submit Proof of Delivery","isWebhook":false,"pointer":"/paths/~1api~1shipment~1submit_pod/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit Proof of Delivery","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":"Submits a Proof of Delivery request for a delivered shipment. Only USPS ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier_code = USPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported today; other carriers are rejected with a business error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PodSubmitRequest"}},"schemaId":"components/schemas/PodSubmitRequest","pointer":"/paths/~1api~1shipment~1submit_pod/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/submit_pod","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PodSubmitRequest"}},"responseCodes":["200"],"pointer":"/api/shipment/submit_pod","href":"tracking/submitpod","openApiOperationId":"submitPod","summary":"Submit Proof of Delivery"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"schemaId":"components/schemas/PodSubmitRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PodSubmitRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PodSubmitResponseEnvelope"}},"schemaId":"components/schemas/PodSubmitResponseEnvelope"}],"pointer":"/paths/~1api~1shipment~1submit_pod/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PodSubmitResponseEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PodSubmitResponseEnvelope"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/submit_pod"}],"content":{"contentType":"group","meta":{"name":"Tracking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tracking","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/shipment/direct/tracking_by_tracking_no","summary":"Query tracking status by tracking no (with UTC offset)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tracking/getshipmenttrackingwithutcoffset","deprecated":false},{"title":"/api/shipment/submit_pod","summary":"Submit Proof of Delivery","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tracking/submitpod","deprecated":false}]}]}]}]}},{"type":"group","label":"Pickup","link":"/v2/openapi/pickup","routeSlug":"/v2/openapi/pickup","items":[{"label":"Schedule pickup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/pickup/addpickupbyshipment","routeSlug":"/v2/openapi/pickup/addpickupbyshipment","metadata":{"seo":{"title":"Schedule pickup","description":"Create a USPS Carrier Pickup request using existing shipment information. This endpoint schedules a postal carrier to pick up eligible packages on the next USPS delivery day.For all possible error codes returned by this endpoint, see Appendix – Pickup Error Codes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addPickupByShipment","name":"Schedule pickup","isWebhook":false,"pointer":"/paths/~1api~1shipment~1pickup~1add/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schedule pickup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a USPS Carrier Pickup request using existing shipment information. This endpoint schedules a postal carrier to pick up eligible packages on the next USPS delivery day."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all possible error codes returned by this endpoint, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.shipsaving.com/v2/appendix#post-apishipmentpickupadd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appendix – Pickup Error Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddPickUpByShipmentRequest"}},"schemaId":"components/schemas/AddPickUpByShipmentRequest","pointer":"/paths/~1api~1shipment~1pickup~1add/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/pickup/add","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddPickUpByShipmentRequest"}},"responseCodes":["200","400"],"pointer":"/api/shipment/pickup/add","href":"pickup/addpickupbyshipment","openApiOperationId":"addPickupByShipment","summary":"Schedule pickup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"schemaId":"components/schemas/AddPickUpByShipmentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddPickUpByShipmentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}},"schemaId":"schema_132"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133","exampleIds":["paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentAlreadyInPickup","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentNotExist","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/missingAddressFields","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/invalidAddress"]}},"schemaId":"schema_133","exampleIds":["paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentAlreadyInPickup","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentNotExist","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/missingAddressFields","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/invalidAddress"]}],"pointer":"/paths/~1api~1shipment~1pickup~1add/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_132","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}}},{"code":"400","schemaId":"schema_133","exampleIds":["paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentAlreadyInPickup","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentNotExist","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/missingAddressFields","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/invalidAddress"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133","exampleIds":["paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentAlreadyInPickup","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentNotExist","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/missingAddressFields","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/invalidAddress"]}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/pickup/add"},{"label":"Cancel pickup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/pickup/cancelpickup","routeSlug":"/v2/openapi/pickup/cancelpickup","metadata":{"seo":{"title":"Cancel pickup","description":"Cancel a previously scheduled carrier pick up. A carrier pickup can no longer be updated or cancelled once cancelled. It requires no additional parameters other than the pickup_no. The status will change to CANCELED on success.For all possible error codes returned by this endpoint, see Appendix – Pickup Error Codes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelPickup","name":"Cancel pickup","isWebhook":false,"pointer":"/paths/~1api~1shipment~1pickup~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel pickup","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":"Cancel a previously scheduled carrier pick up. A carrier pickup can no longer be updated or cancelled once cancelled. It requires no additional parameters other than the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pickup_no"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The status will change to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on success."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all possible error codes returned by this endpoint, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.shipsaving.com/v2/appendix#post-apishipmentpickupcancel"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appendix – Pickup Error Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelPickupRequest"}},"schemaId":"components/schemas/CancelPickupRequest","pointer":"/paths/~1api~1shipment~1pickup~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/pickup/cancel","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CancelPickupRequest"}},"responseCodes":["200","400"],"pointer":"/api/shipment/pickup/cancel","href":"pickup/cancelpickup","openApiOperationId":"cancelPickup","summary":"Cancel pickup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"schemaId":"components/schemas/CancelPickupRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelPickupRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonServiceResponse"}},"schemaId":"components/schemas/CommonServiceResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133","exampleIds":["paths/~1api~1shipment~1pickup~1cancel/post/responses/400/content/application~1json/examples/pickupAlreadyCanceled"]}},"schemaId":"schema_133","exampleIds":["paths/~1api~1shipment~1pickup~1cancel/post/responses/400/content/application~1json/examples/pickupAlreadyCanceled"]}],"pointer":"/paths/~1api~1shipment~1pickup~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonServiceResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonServiceResponse"}}},{"code":"400","schemaId":"schema_133","exampleIds":["paths/~1api~1shipment~1pickup~1cancel/post/responses/400/content/application~1json/examples/pickupAlreadyCanceled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133","exampleIds":["paths/~1api~1shipment~1pickup~1cancel/post/responses/400/content/application~1json/examples/pickupAlreadyCanceled"]}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/pickup/cancel"},{"label":"Retrieve pickup records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/pickup/getpickuplist","routeSlug":"/v2/openapi/pickup/getpickuplist","metadata":{"seo":{"title":"Retrieve pickup records","description":"Fetches a paginated list of pickup records created in the system.This endpoint supports optional filters such as USPS confirmation number,pickup status, and carrier code. Pagination parameters (page and page_size)allow controlling the size of the returned dataset, and the order_by flagdetermines the sorting order of the results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPickupList","name":"Retrieve pickup records","isWebhook":false,"pointer":"/paths/~1api~1shipment~1pickup~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve pickup records","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":"Fetches a paginated list of pickup records created in the system."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports optional filters such as USPS confirmation number,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pickup status, and carrier code. Pagination parameters ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page_size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allow controlling the size of the returned dataset, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"determines the sorting order of the results."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"confirmation_number","in":"query","schemaId":"schema_134"},{"name":"status","in":"query","schemaId":"schema_135","description":"Pickup status filter."},{"name":"carrier_code","in":"query","schemaId":"schema_136"},{"name":"page","in":"query","schemaId":"schema_137","description":"Page number for paginated results (starting from 1)."},{"name":"page_size","in":"query","schemaId":"schema_138","description":"Number of results to return per page."},{"name":"order_by","in":"query","schemaId":"schema_139","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorting flag that controls the time order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": chronological order (oldest → newest)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": reverse chronological order (newest → oldest)"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1api~1shipment~1pickup~1list/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipment/pickup/list","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"confirmation_number","in":"query","required":false,"example":"WTC65384000","schemaId":"components/schemas/PickUpConfirmationNo"},{"name":"status","in":"query","required":false,"schemaId":"schema_135"},{"name":"carrier_code","in":"query","required":false,"example":"USPS","schemaId":"components/schemas/PickUpCarrierCodeEnum"},{"name":"page","in":"query","required":false,"schemaId":"schema_137"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_138"},{"name":"order_by","in":"query","required":true,"schemaId":"schema_139"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipment/pickup/list","href":"pickup/getpickuplist","openApiOperationId":"getPickupList","summary":"Retrieve pickup records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryPickupResponse"}},"schemaId":"components/schemas/QueryPickupResponse"}],"pointer":"/paths/~1api~1shipment~1pickup~1list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueryPickupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryPickupResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/pickup/list"},{"label":"Get package location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/pickup/getpackagelocation","routeSlug":"/v2/openapi/pickup/getpackagelocation","metadata":{"seo":{"title":"Get package location","description":"Returns the list of valid package location enum values. These values indicate where the packages will be placed at the pickup address for the USPS carrier to retrieve during the scheduled pickup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPackageLocation","name":"Get package location","isWebhook":false,"pointer":"/paths/~1api~1shipment~1pickup~1package~1location~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get package location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of valid package location enum values. These values indicate where the packages will be placed at the pickup address for the USPS carrier to retrieve during the scheduled pickup.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipment/pickup/package/location/list","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipment/pickup/package/location/list","href":"pickup/getpackagelocation","openApiOperationId":"getPackageLocation","summary":"Get package location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryPackageLocationResponse"}},"schemaId":"components/schemas/QueryPackageLocationResponse"}],"pointer":"/paths/~1api~1shipment~1pickup~1package~1location~1list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueryPackageLocationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryPackageLocationResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/pickup/package/location/list"}],"content":{"contentType":"group","meta":{"name":"Pickup"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pickup","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/shipment/pickup/add","summary":"Schedule pickup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pickup/addpickupbyshipment","deprecated":false},{"title":"/api/shipment/pickup/cancel","summary":"Cancel pickup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pickup/cancelpickup","deprecated":false},{"title":"/api/shipment/pickup/list","summary":"Retrieve pickup records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pickup/getpickuplist","deprecated":false},{"title":"/api/shipment/pickup/package/location/list","summary":"Get package location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pickup/getpackagelocation","deprecated":false}]}]}]}]}},{"type":"group","label":"Address Validation","link":"/v2/openapi/address-validation","routeSlug":"/v2/openapi/address-validation","items":[{"label":"Address Validation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/address-validation/validateaddress","routeSlug":"/v2/openapi/address-validation/validateaddress","metadata":{"seo":{"title":"Address Validation","description":"The Address Validation API checks the validity of U.S. domestic addressesand returns standardized address components in accordance with USPS®addressing standards.This helps improve delivery accuracy, reduce undeliverable mail, andsupport consistent pricing for shipping and logistics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateAddress","name":"Address Validation","isWebhook":false,"pointer":"/paths/~1api~1address~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Address Validation","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":"The Address Validation API checks the validity of U.S. domestic addresses"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and returns standardized address components in accordance with USPS®"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"addressing standards."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This helps improve delivery accuracy, reduce undeliverable mail, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"support consistent pricing for shipping and logistics."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BasicAddress"}},"schemaId":"components/schemas/BasicAddress","pointer":"/paths/~1api~1address~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/address/validate","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BasicAddress"}},"responseCodes":["200"],"pointer":"/api/address/validate","href":"address-validation/validateaddress","openApiOperationId":"validateAddress","summary":"Address Validation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"schemaId":"components/schemas/BasicAddress","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BasicAddress"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressValidateResponse"}},"schemaId":"components/schemas/AddressValidateResponse"}],"pointer":"/paths/~1api~1address~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddressValidateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressValidateResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/address/validate"}],"content":{"contentType":"group","meta":{"name":"Address Validation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Address Validation","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/address/validate","summary":"Address Validation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/address-validation/validateaddress","deprecated":false}]}]}]}]}},{"type":"group","label":"SCAN Form","link":"/v2/openapi/scan-form","routeSlug":"/v2/openapi/scan-form","items":[{"label":"Create USPS SCAN Form","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/scan-form/createscanform","routeSlug":"/v2/openapi/scan-form/createscanform","metadata":{"seo":{"title":"Create USPS SCAN Form","description":"Creates a USPS SCAN Form (PS Form 5630) for a set of already-purchased shipments and returns the URL of the generated manifest PDF. A SCAN Form is a single manifest barcode that consolidates multiple shipments so the carrier can accept the whole batch with one scan at drop-off."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createScanForm","name":"Create USPS SCAN Form","isWebhook":false,"pointer":"/paths/~1api~1scan_form~1create_scan_form/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":"Creates a USPS SCAN Form (PS Form 5630) for a set of already-purchased shipments and returns the URL of the generated manifest PDF. A SCAN Form is a single manifest barcode that consolidates multiple shipments so the carrier can accept the whole batch with one scan at drop-off.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ScanFormCreateRequest"}},"schemaId":"components/schemas/ScanFormCreateRequest","pointer":"/paths/~1api~1scan_form~1create_scan_form/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/scan_form/create_scan_form","servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ScanFormCreateRequest"}},"responseCodes":["200"],"pointer":"/api/scan_form/create_scan_form","href":"scan-form/createscanform","openApiOperationId":"createScanForm","summary":"Create USPS SCAN Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com","description":"Production server"}],"schemaId":"components/schemas/ScanFormCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ScanFormCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScanFormCreateResponseEnvelope"}},"schemaId":"components/schemas/ScanFormCreateResponseEnvelope"}],"pointer":"/paths/~1api~1scan_form~1create_scan_form/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ScanFormCreateResponseEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScanFormCreateResponseEnvelope"}}}],"examples":[]}]}]}]},"httpPath":"/api/scan_form/create_scan_form"}],"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/scan_form/create_scan_form","summary":"Create USPS SCAN Form","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scan-form/createscanform","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/TokenResponse":{"id":"components/schemas/TokenResponse","kind":"json-schema","title":"TokenResponse","data":{"type":"object","properties":{"access_token":{"type":"string","description":"JWT access token."},"token_type":{"type":"string","example":"Bearer"},"expires_in":{"type":"integer","format":"int32","description":"Expiration time in seconds (default 1800)."},"scope":{"type":"string","description":"Granted scopes (if returned)."}}}},"components/schemas/OAuthError":{"id":"components/schemas/OAuthError","kind":"json-schema","title":"OAuthError","data":{"type":"object","properties":{"error":{"type":"string","description":"OAuth 2.0 error code.","example":"invalid_request"},"error_description":{"type":"string","description":"Human-readable explanation."},"error_uri":{"type":"string","description":"Link to the relevant RFC section."}}}},"components/schemas/RequestUniqueId":{"id":"components/schemas/RequestUniqueId","kind":"json-schema","title":"RequestUniqueId","data":{"type":"string","description":"A unique identifier generated by the requesting client to mark a single rate request within a batch. This value will be echoed back in the corresponding response, ensuring one-to-one mapping between requests.","example":"unique_uuid_001"}},"components/schemas/BasicAddress":{"id":"components/schemas/BasicAddress","kind":"json-schema","title":"BasicAddress","data":{"required":["street","city","state","country","zip_code"],"type":"object","properties":{"street":{"type":"string","description":"The number of a building along with the name of the road or street on which it is located.","example":"xxxx Olive Street"},"street2":{"type":"string","description":"The secondary unit designator, such as apartment(APT) or suite(STE) number, defining the exact location of the address within a building.","example":"STE XXX"},"city":{"type":"string","description":"This is the city name of the address.","example":"Los Angeles"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For U.S. addresses, this field must be a valid two-letter state code (e.g., \"CA\" for California, \"NY\" for New York)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-U.S. addresses, there is no restriction on the value."},"children":[]}]}]}]}],"example":"CA"},"zip_code":{"type":"string","description":"Postal code of an Address.","example":"021XX"},"country":{"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 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/AddressFrom":{"id":"components/schemas/AddressFrom","kind":"json-schema","title":"AddressFrom","data":{"allOf":[{"type":"object","required":["first_name","last_name","zip_code"],"properties":{"first_name":{"type":"string","description":"First Name corresponding to the address. For the Batch Quick Rate API, this parameter is optional.","example":"Alice"},"last_name":{"type":"string","description":"Last Name corresponding to the address. For the Batch Quick Rate API, this parameter is optional.","example":"Green"},"company_name":{"type":"string","description":"Firm/business name corresponding to the address.","example":"ShipSaving"},"phone":{"type":"string","description":"Phone number of the sender/recipient. Required for international shipments. Providing a phone number is highly recommended for all shipments to ensure accurate delivery and facilitate carrier contact if needed.","example":"1234567890"},"email":{"type":"string","description":"Email address of the sender/recipient. May be used by the carrier for delivery notifications or issue resolution.","example":"it@shipsaving.com"}}},{"$ref":"#/components/schemas/BasicAddress"}]}},"components/schemas/AddressTo":{"id":"components/schemas/AddressTo","kind":"json-schema","title":"AddressTo","data":{"allOf":[{"$ref":"#/components/schemas/AddressFrom"},{"type":"object","required":["address_type"],"properties":{"address_type":{"type":"string","description":"Indicates whether the destination address is residential or commercial.\nThis flag is used to determine carrier-specific surcharges (e.g., UPS residential delivery fees).\n","example":"residential","enum":["residential","commercial"]}}}]}},"components/schemas/CarrierPackageCodeEnum":{"id":"components/schemas/CarrierPackageCodeEnum","kind":"json-schema","title":"CarrierPackageCodeEnum","data":{"type":"string","description":"Carrier package code identifier. See Appendix - Carrier Package Codes for supported values in the ShipSaving New API (v2).","example":"USPS_SMALL_FLAT_RATE_BOX","enum":["USPS_LETTER","USPS_LARGE_ENVELOPE_OR_FLAT","USPS_THICK_ENVELOPE","USPS_SMALL_FLAT_RATE_BOX","USPS_MEDIUM_FLAT_RATE_BOX","USPS_LARGE_FLAT_RATE_BOX","USPS_FLAT_RATE_ENVELOPE","USPS_PADDED_FLAT_RATE_ENVELOPE","USPS_LEGAL_FLAT_RATE_ENVELOPE","UPS_LETTER","UPS_25KG_BOX","UPS_10KG_BOX","UPS_TUBE","UPS_PAK","UPS_EXPRESS_BOX_SMALL","UPS_EXPRESS_BOX_MEDIUM","UPS_EXPRESS_BOX_LARGE","FEDEX_ENVELOPE","FEDEX_PAK","FEDEX_TUBE","FEDEX_EXTRA_SMALL_BOX","FEDEX_SMALL_BOX","FEDEX_MEDIUM_BOX","FEDEX_LARGE_BOX","FEDEX_EXTRA_LARGE_BOX","FEDEX_BOX","FEDEX_10KG_BOX","FEDEX_25KG_BOX","UPS_CANADA_LETTER","UPS_CANADA_25KG_BOX","UPS_CANADA_10KG_BOX","UPS_CANADA_TUBE","UPS_CANADA_PAK","UPS_CANADA_EXPRESS_BOX_SMALL","UPS_CANADA_EXPRESS_BOX_MEDIUM","UPS_CANADA_EXPRESS_BOX_LARGE","UPS_CANADA_EXPRESS_BOX"]}},"components/schemas/DimensionUnitEnum":{"id":"components/schemas/DimensionUnitEnum","kind":"json-schema","title":"DimensionUnitEnum","data":{"type":"string","description":"Selected dimension unit.","example":"in","enum":["in","cm"]}},"components/schemas/WeightUnitEnum":{"id":"components/schemas/WeightUnitEnum","kind":"json-schema","title":"WeightUnitEnum","data":{"type":"string","description":"Selected weight unit.","example":"lb","enum":["lb","oz","kg","g"]}},"components/schemas/ShipmentPackageData":{"id":"components/schemas/ShipmentPackageData","kind":"json-schema","title":"ShipmentPackageData","data":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of package being shipped."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"my_package"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use when specifying custom package dimensions. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"width"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"length"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"height"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dimension_unit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight_unit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"predefined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use when selecting a carrier’s predefined package type. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier_package_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and weight fields only; dimension fields are ignored."},"children":[]}]}]}]}],"example":"my_package","enum":["my_package","predefined"]},"length":{"type":"number","description":"Length of the package in the selected unit.","example":10},"width":{"type":"number","description":"Width of the package in the selected unit.","example":10},"height":{"type":"number","description":"Height of the package in the selected unit.","example":10},"weight":{"type":"number","description":"Weight of the package in the selected unit.","example":10},"carrier_package_code":{"$ref":"#/components/schemas/CarrierPackageCodeEnum"},"dimension_unit":{"$ref":"#/components/schemas/DimensionUnitEnum"},"weight_unit":{"$ref":"#/components/schemas/WeightUnitEnum"}}}},"components/schemas/SignatureTypeEnum":{"id":"components/schemas/SignatureTypeEnum","kind":"json-schema","title":"SignatureTypeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request signature confirmation on delivery. Values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Signature Confirmation;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adult_signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Adult Signature Required;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usps_signature_restricted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Signature Confirmation Restricted Delivery"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(delivered only to the specified addressee or their authorized agent);"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usps_adult_signature_restricted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Adult Signature Restricted Delivery (21+)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(recipient must be 21+ and the named addressee)."},"children":[]}]}]}]}],"enum":["signature","adult_signature","usps_signature_restricted","usps_adult_signature_restricted"]}},"components/schemas/CustomPrint":{"id":"components/schemas/CustomPrint","kind":"json-schema","title":"CustomPrint","data":{"type":"string","description":"Customized print on label.If the label itself supports custom printing content, this field will be printed onto the label.","example":"Please put the package in the locker."}},"components/schemas/ShipmentOptionData":{"id":"components/schemas/ShipmentOptionData","kind":"json-schema","title":"ShipmentOptionData","data":{"type":"object","description":"Additional shipping options","properties":{"signature":{"$ref":"#/components/schemas/SignatureTypeEnum"},"custom_text_on_label_1":{"$ref":"#/components/schemas/CustomPrint"},"custom_text_on_label_2":{"$ref":"#/components/schemas/CustomPrint"},"hazardous_materials":{"type":"boolean","description":"Whether this shipment contains dangerous goods or hazardous materials (USPS Ground Advantage service only).","example":true},"is_lithium_battery":{"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 package contains lithium batteries."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hazardous_materials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is overridden to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipments to or from U.S. offshore destinations (such as Guam, Puerto Rico) generally require this field to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order to ship lithium batteries."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review the USPS lithium battery guidelines before shipping."},"children":[]}]}]}]}],"example":false},"additional_handling":{"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 package requires additional handling due to size, weight, or packaging that falls outside standard shipping guidelines. Carriers may apply extra fees when this is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":false},"require_saturday_delivery":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only returns rate quotes that support Saturday delivery. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omitted, all available rate quotes are returned regardless of Saturday delivery support."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual Saturday delivery availability depends on the carrier and service level — some carriers or services may not support it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enabling this preference may result in additional carrier surcharges or higher shipping costs if the selected service level applies extra fees for Saturday delivery."},"children":[]}]}]}]}],"example":false}}}},"components/schemas/ShipDate":{"id":"components/schemas/ShipDate","kind":"json-schema","title":"ShipDate","data":{"type":"string","description":"Timestamp in ISO 8601 format, including local time and time zone offset.","example":"2025-07-31T00:00:00+08:00"}},"components/schemas/BasicRateRequest":{"id":"components/schemas/BasicRateRequest","kind":"json-schema","title":"BasicRateRequest","data":{"required":["from_address_data","to_address_data","package_data","ship_date"],"type":"object","properties":{"from_address_data":{"$ref":"#/components/schemas/AddressFrom"},"to_address_data":{"$ref":"#/components/schemas/AddressTo"},"package_data":{"$ref":"#/components/schemas/ShipmentPackageData"},"option_data":{"$ref":"#/components/schemas/ShipmentOptionData"},"ship_date":{"$ref":"#/components/schemas/ShipDate"}}}},"components/schemas/IsReturnLabel":{"id":"components/schemas/IsReturnLabel","kind":"json-schema","title":"IsReturnLabel","data":{"type":"boolean","description":"Indicates whether the label is for a return shipment.","default":false,"example":false}},"components/schemas/ProviderIdEnum":{"id":"components/schemas/ProviderIdEnum","kind":"json-schema","title":"ProviderIdEnum","data":{"type":"string","description":"carrier provider id","example":"USPS_X","enum":["UPS_SS_DNI","USPS_X","FEDEX_X","DHL_A","GOFO_EXPRESS_A","SWIFTX","UPS_CANADA"]}},"components/schemas/ServiceLevelEnum":{"id":"components/schemas/ServiceLevelEnum","kind":"json-schema","title":"ServiceLevelEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier service level. See Appendix - Carrier Service Types for the valid relationships between carrier_code, provider_id, and service_level."},"children":[]}]}]}],"example":"USPS_GROUND_ADVANTAGE","enum":["USPS_FIRST_CLASS_MAIL","USPS_GROUND_ADVANTAGE","USPS_PRIORITY_MAIL","USPS_PRIORITY_MAIL_EXPRESS","USPS_MEDIA_MAIL","USPS_LIBRARY_MAIL","USPS_FIRST_CLASS_MAIL_INTERNATIONAL","USPS_PRIORITY_MAIL_INTERNATIONAL","USPS_PRIORITY_MAIL_EXPRESS_INTERNATIONAL","UPS_GROUND","UPS_GROUND_SAVER","UPS_NEXT_DAY_AIR","UPS_NEXT_DAY_AIR_SAVER","UPS_NEXT_DAY_AIR_EARLY","UPS_2ND_DAY_AIR","UPS_2ND_DAY_AIR_AM","UPS_3_DAY_SELECT","UPS_STANDARD","UPS_WORLDWIDE_SAVER","UPS_WORLDWIDE_EXPRESS","UPS_WORLDWIDE_EXPRESS_PLUS","UPS_WORLDWIDE_EXPEDITED","UPS_SUREPOST_LESS_THAN_1_LB","UPS_SUREPOST_1_LB_OR_GREATER","FEDEX_GROUND","FEDEX_2_DAY","FEDEX_2_DAY_AM","FEDEX_EXPRESS_SAVER","FEDEX_STANDARD_OVERNIGHT","FEDEX_FIRST_OVERNIGHT","FEDEX_PRIORITY_OVERNIGHT","FEDEX_INTERNATIONAL_ECONOMY","FEDEX_INTERNATIONAL_FIRST","FEDEX_INTERNATIONAL_PRIORITY","FEDEX_HOME_DELIVERY","FEDEX_SMARTPOST","FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS","FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS","FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS","FEDEX_INTERNATIONAL_PRIORITY_EXPRESS","FEDEX_INTERNATIONAL_CONNECT_PLUS","FEDEX_DATE_CERTAIN_HOME_DELIVERY","FEDEX_EVENING_HOME_DELIVERY","FEDEX_APPOINTMENT_HOME_DELIVERY","FEDEX_INTERNATIONAL_PRIORITY_PR","DHL_EXPRESS_WORLDWIDE_B2C","DHL_EXPRESS_WORLDWIDE_B2C_NONDOC","DHL_EXPRESS_JET_LINE_NONDOC","DHL_EXPRESS_SPRINT_LINE","DHL_EXPRESS_EURO_PACK_DOC","DHL_EXPRESS_BREAK_BULK_EXPRESS","DHL_EXPRESS_MEDICAL_EXPRESS","DHL_EXPRESS_WORLDWIDE_DOC","DHL_EXPRESS_0900_NONDOC","DHL_EXPRESS_FREIGHT_WORLDWIDE_NONDOC","DHL_EXPRESS_DOMESTIC_ECONOMY_SELECT","DHL_EXPRESS_ECONOMY_SELECT_NONDOC","DHL_EXPRESS_DOMESTIC_EXPRESS_0900","DHL_EXPRESS_JUMBO_BOX_NONDOC","DHL_EXPRESS_0900","DHL_EXPRESS_1030","DHL_EXPRESS_1030_NONDOC","DHL_EXPRESS_DOMESTIC_EXPRESS","DHL_EXPRESS_DOMESTIC_EXPRESS_1030","DHL_EXPRESS_WORLDWIDE_NONDOC","DHL_EXPRESS_MEDICAL_EXPRESS_NODOC","DHL_EXPRESS_GLOBAL_MAIL_BUSINESS","DHL_EXPRESS_SAME_DAY","DHL_EXPRESS_1200_DOC","DHL_EXPRESS_WORLDWIDE_ECX","DHL_EXPRESS_EURO_PACK_NONDOC","DHL_EXPRESS_ECONOMY_SELECT","DHL_EXPRESS_ENVELOPE","DHL_EXPRESS_1200_NONDOC","DHL_EXPRESS_DOMESTIC_EXPRESS_1200","GOFO_EXPRESS_ECO","SWIFTX_EXP","UPS_CANADA_EXPEDITED","UPS_CANADA_EXPRESS_EARLY","UPS_CANADA_EXPRESS_SAVER","UPS_CANADA_EXPRESS","UPS_CANADA_STANDARD","UPS_CANADA_3_DAY_SELECT","UPS_CANADA_EXPRESS_EARLY_SM","UPS_CANADA_WORLDWIDE_EXPEDITED_SM","UPS_CANADA_WORLDWIDE_EXPRESS_PLUS_SM","UPS_CANADA_WORLDWIDE_EXPRESS_SM","UPS_CANADA_EXPRESS_SAVER_SM"]}},"components/schemas/ShipmentRateCarrierData":{"id":"components/schemas/ShipmentRateCarrierData","kind":"json-schema","title":"ShipmentRateCarrierData","data":{"type":"array","description":"Specifying this parameter allows you to filter rates by carrier and service level, enabling faster queries.","items":{"type":"object","properties":{"provider_id":{"$ref":"#/components/schemas/ProviderIdEnum"},"service_levels":{"type":"array","description":"Carrier service levels.","items":{"$ref":"#/components/schemas/ServiceLevelEnum"}}}}}},"components/schemas/BatchQuickRateRequestItem":{"id":"components/schemas/BatchQuickRateRequestItem","kind":"json-schema","title":"BatchQuickRateRequestItem","data":{"allOf":[{"type":"object","required":["request_unique_id"],"properties":{"request_unique_id":{"$ref":"#/components/schemas/RequestUniqueId"}}},{"$ref":"#/components/schemas/BasicRateRequest"},{"type":"object","properties":{"is_return_label":{"$ref":"#/components/schemas/IsReturnLabel"},"shipment_rate_carrier_data":{"$ref":"#/components/schemas/ShipmentRateCarrierData"}}}]}},"components/schemas/BatchQuickRateRequest":{"id":"components/schemas/BatchQuickRateRequest","kind":"json-schema","title":"BatchQuickRateRequest","data":{"type":"object","required":["rate_requests"],"properties":{"rate_requests":{"type":"array","description":"List of individual rate requests. Each API call can include up to 10 items.","maxItems":10,"items":{"$ref":"#/components/schemas/BatchQuickRateRequestItem"}}}}},"components/schemas/ShipmentRateId":{"id":"components/schemas/ShipmentRateId","kind":"json-schema","title":"ShipmentRateId","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of a shipping rate returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"get_rates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. Use this value to reference a specific rate when purchasing a label."},"children":[]}]}]}],"example":"dc288147-f7dd-494d-9353-5ce00020c7aa"}},"components/schemas/CarrierCodeEnum":{"id":"components/schemas/CarrierCodeEnum","kind":"json-schema","title":"CarrierCodeEnum","data":{"type":"string","description":"Carrier code identifier.","example":"USPS","enum":["USPS","UPS","FEDEX","DHL_EXPRESS","SWIFTX","GOFO_EXPRESS","UPS_CANADA"]}},"components/schemas/BaseRateItem":{"id":"components/schemas/BaseRateItem","kind":"json-schema","title":"BaseRateItem","data":{"type":"object","description":"Represents the base rate charged by a carrier for a given service level.","properties":{"amount":{"type":"number","format":"float","example":33.21},"currency":{"type":"string","example":"USD"},"list_amount":{"type":"number","format":"float","example":33.21},"retail_amount":{"type":"number","format":"float","example":59.55}}}},"components/schemas/SurchargeItem":{"id":"components/schemas/SurchargeItem","kind":"json-schema","title":"SurchargeItem","data":{"type":"object","description":"Represents a single surcharge item applied to a shipment or rate.","nullable":true,"properties":{"object":{"type":"string","description":"The object type, indicating this represents a surcharge item.\n"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code identifying the specific surcharge type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonstandard_22"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may indicate a non-standard package handling fee."},"children":[]}]}]}],"example":"nonstandard_22"},"category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The category of the surcharge, grouping similar charge types together."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common examples include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HANDLING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FUEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc."},"children":[]}]}]}],"example":"HANDLING"},"amount":{"type":"number","format":"float","description":"The total surcharge amount charged for this item.\n","example":4},"currency":{"type":"string","description":"The three-letter currency code (ISO 4217) for the surcharge.","example":"USD"},"list_amount":{"type":"number","format":"float","example":4},"retail_amount":{"type":"number","format":"float","example":4}}}},"components/schemas/PriceDetailItem":{"id":"components/schemas/PriceDetailItem","kind":"json-schema","title":"PriceDetailItem","data":{"type":"object","description":"Represents a single price breakdown line for a rate. FedEx specific.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code identifying the charge component."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common examples include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASE_CHARGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FUEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESIDENTIAL_DELIVERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEMAND_OVERSIZE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEMAND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OVERSIZE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY_AREA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"BASE_CHARGE"},"description":{"type":"string","description":"A human-readable description of the charge component.","example":"Shipping Label Charge"},"price":{"type":"number","format":"float","description":"The amount charged for this component.","example":99.31}}}},"components/schemas/RateItem":{"id":"components/schemas/RateItem","kind":"json-schema","title":"RateItem","data":{"type":"object","properties":{"zone":{"type":"string","nullable":true,"example":"8Rural"},"currency":{"type":"string","example":"USD"},"cubic":{"type":"boolean","example":false},"rate_id":{"$ref":"#/components/schemas/ShipmentRateId"},"carrier_code":{"$ref":"#/components/schemas/CarrierCodeEnum"},"provider_id":{"$ref":"#/components/schemas/ProviderIdEnum"},"service_name":{"type":"string","example":"USPS Media Mail"},"service_level":{"type":"string","example":"USPS_MEDIA_MAIL"},"service_level_desc":{"type":"string","example":"A cost-effective way to send eligible books, media, and educational materials."},"returned_package_code":{"type":"string","nullable":true,"example":"my_package"},"delivery_days":{"type":"string","nullable":true,"example":"2"},"delivery_date":{"type":"string","nullable":true,"example":"2025-08-08T00:00:00+08:00"},"delivery_weekday":{"type":"string","nullable":true,"example":"MONDAY"},"service_detail":{"type":"string","nullable":true,"example":"Low rates for packages with expected delivery in 2-5 business days."},"price":{"type":"number","format":"float","example":5.91},"origin_price":{"type":"number","format":"float","nullable":true,"example":null},"retail_price":{"type":"number","format":"float","nullable":true,"example":8.7},"discount_text":{"type":"string","nullable":true},"insurance_info":{"type":"string","nullable":true},"ship_date":{"$ref":"#/components/schemas/ShipDate"},"saturday_delivery":{"type":"boolean","example":false},"one_rate":{"type":"boolean","example":false},"base_rate":{"$ref":"#/components/schemas/BaseRateItem"},"surcharges":{"$ref":"#/components/schemas/SurchargeItem"},"usps_dim_rate_type":{"type":"string","example":"dim-weight"},"price_details":{"type":"array","nullable":true,"description":"A per-component breakdown of the rate. FedEx specific.","items":{"$ref":"#/components/schemas/PriceDetailItem"}}}}},"components/schemas/RateErrorInfo":{"id":"components/schemas/RateErrorInfo","kind":"json-schema","title":"RateErrorInfo","data":{"type":"object"}},"components/schemas/BatchQuickRateItem":{"id":"components/schemas/BatchQuickRateItem","kind":"json-schema","title":"BatchQuickRateItem","data":{"type":"object","properties":{"request_unique_id":{"$ref":"#/components/schemas/RequestUniqueId"},"shipment_rate_data":{"type":"array","items":{"$ref":"#/components/schemas/RateItem"}},"error_info":{"$ref":"#/components/schemas/RateErrorInfo"}}}},"components/schemas/BatchQuickRateResponse":{"id":"components/schemas/BatchQuickRateResponse","kind":"json-schema","title":"BatchQuickRateResponse","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BatchQuickRateItem"}}}}},"components/schemas/AddressReturn":{"id":"components/schemas/AddressReturn","kind":"json-schema","title":"AddressReturn","data":{"description":"Address where the package should be returned if undeliverable or returned to sender.\nNote: Only USPS supports printing a dedicated return address on the label.\n","allOf":[{"$ref":"#/components/schemas/AddressFrom"}]}},"components/schemas/BasicRateReqWithReturnAddress":{"id":"components/schemas/BasicRateReqWithReturnAddress","kind":"json-schema","title":"BasicRateReqWithReturnAddress","data":{"allOf":[{"type":"object","properties":{"return_address_data":{"$ref":"#/components/schemas/AddressReturn"}}},{"$ref":"#/components/schemas/BasicRateRequest"}]}},"components/schemas/ContentTypeEnum":{"id":"components/schemas/ContentTypeEnum","kind":"json-schema","title":"ContentTypeEnum","data":{"type":"string","example":"merchandise","enum":["merchandise","documents","return_merchandise","sample","gift"]}},"components/schemas/TaxIdTypeEnum":{"id":"components/schemas/TaxIdTypeEnum","kind":"json-schema","title":"TaxIdTypeEnum","data":{"type":"string","description":"tax id type","example":"TIN","enum":["TIN","EIN","SSN","VAT","EORI","IOSS","PAN"]}},"components/schemas/ShipmentCustomTaxData":{"id":"components/schemas/ShipmentCustomTaxData","kind":"json-schema","title":"ShipmentCustomTaxData","data":{"type":"object","properties":{"tax_id_type":{"$ref":"#/components/schemas/TaxIdTypeEnum"},"tax_id_number":{"type":"string","description":"tax id number","example":"tin2888"},"country_code":{"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 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/EelPfcTypeEnum":{"id":"components/schemas/EelPfcTypeEnum","kind":"json-schema","title":"EelPfcTypeEnum","data":{"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":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","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"],"example":"ITN"}},"components/schemas/UndeliveryOptionEnum":{"id":"components/schemas/UndeliveryOptionEnum","kind":"json-schema","title":"UndeliveryOptionEnum","data":{"type":"string","description":"Defines the action to take for undeliverable shipments.","example":"return_to_sender","enum":["return_to_sender","abandon"]}},"components/schemas/ShipmentCustomItemData":{"id":"components/schemas/ShipmentCustomItemData","kind":"json-schema","title":"ShipmentCustomItemData","data":{"type":"object","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":[]}]}]}],"properties":{"description":{"type":"string","description":"Description of the item being shipped. Provide accurate and clear details for customs clearance.","example":"cloth"},"quantity":{"type":"integer","description":"Total number of identical items in this shipment entry.","format":"int32","example":10},"origin":{"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"},"weight":{"type":"number","description":"Weight of the item in the selected unit.","example":10},"unit_cost":{"type":"number","description":"Declared value of the item in USD. Refers to the unit price of the item.","example":19.99},"weight_unit":{"$ref":"#/components/schemas/WeightUnitEnum"},"hs_tariff_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Harmonized System (HS) tariff code of the item. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://uscensus.prod.3ceonline.com/ui/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find My Harmonization Number."},"children":[]}]}]}]}],"example":"xx"}}}},"components/schemas/ShipmentCustomData":{"id":"components/schemas/ShipmentCustomData","kind":"json-schema","title":"ShipmentCustomData","data":{"type":"object","description":"custom data","properties":{"signing_person":{"type":"string","description":"Name of the individual signing the customs form, typically the sender or an authorized agent, confirming that all declared information is accurate and compliant with applicable customs regulations.","example":"Ray"},"content_type":{"$ref":"#/components/schemas/ContentTypeEnum"},"tax_ids":{"type":"array","description":"Sender's tax information","items":{"$ref":"#/components/schemas/ShipmentCustomTaxData"}},"eel_pfc_type":{"$ref":"#/components/schemas/EelPfcTypeEnum"},"eel_pfc_code":{"type":"string","description":"EEI filing identifier for this shipment. Provide either the Internal Transaction Number (ITN) received from AES, or the exemption code if EEI filing is not required.","example":"X20250719123456"},"undeliverable_option":{"$ref":"#/components/schemas/UndeliveryOptionEnum"},"item_data_list":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentCustomItemData"}}}}},"components/schemas/ShipmentRateRequest":{"id":"components/schemas/ShipmentRateRequest","kind":"json-schema","title":"ShipmentRateRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasicRateReqWithReturnAddress"},{"type":"object","properties":{"shipment_rate_carrier_data":{"$ref":"#/components/schemas/ShipmentRateCarrierData"},"custom_data":{"$ref":"#/components/schemas/ShipmentCustomData"}}}]}},"components/schemas/GetRatesResponse":{"id":"components/schemas/GetRatesResponse","kind":"json-schema","title":"GetRatesResponse","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"type":"object","properties":{"fastest":{"nullable":true,"$ref":"#/components/schemas/RateItem"},"cheapest":{"nullable":true,"$ref":"#/components/schemas/RateItem"},"shipment_rate_data":{"type":"array","items":{"$ref":"#/components/schemas/RateItem"}},"fastest_and_cheapest":{"type":"object","nullable":true,"$ref":"#/components/schemas/RateItem"},"error_info":{"$ref":"#/components/schemas/RateErrorInfo"}}}}}},"components/schemas/PlatformUkId":{"id":"components/schemas/PlatformUkId","kind":"json-schema","title":"PlatformUkId","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier provided by the calling party (e.g., the caller’s order number). Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform_uk_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must correspond to exactly one shipment and cannot be reused across multiple shipments."},"children":[]}]}]}],"example":"platformUkId175377917713"}},"components/schemas/InsuranceRateId":{"id":"components/schemas/InsuranceRateId","kind":"json-schema","title":"InsuranceRateId","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of an insurance rate returned by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/shipment/insurance/rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. Use this value to purchase insurance for a shipment."},"children":[]}]}]}],"example":"dc288147-f7dd-494d-9353-5ce00020c7aa"}},"components/schemas/InsuranceData":{"id":"components/schemas/InsuranceData","kind":"json-schema","title":"InsuranceData","data":{"type":"object","properties":{"rate_id":{"$ref":"#/components/schemas/InsuranceRateId"}}}},"components/schemas/LabelPrintTypeEnum":{"id":"components/schemas/LabelPrintTypeEnum","kind":"json-schema","title":"LabelPrintTypeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the label print format. Supported types vary by carrier and may also depend on the selected service level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, USPS and FedEx may support "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"qrcode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", while UPS may support "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"barcode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"common","enum":["common","qrcode","barcode"]}},"components/schemas/IsExchangeLabel":{"id":"components/schemas/IsExchangeLabel","kind":"json-schema","title":"IsExchangeLabel","data":{"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 shipment label belongs to a platform-specific exchange/return workflow. This field is used for certain marketplace integrations and will be stored internally in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":false,"default":false}},"components/schemas/BuyLabelRequest":{"id":"components/schemas/BuyLabelRequest","kind":"json-schema","title":"BuyLabelRequest","data":{"type":"object","required":["rate_id","platform_uk_id","label_print_type"],"properties":{"rate_id":{"$ref":"#/components/schemas/ShipmentRateId"},"platform_uk_id":{"$ref":"#/components/schemas/PlatformUkId"},"insurance_data":{"$ref":"#/components/schemas/InsuranceData"},"label_print_type":{"$ref":"#/components/schemas/LabelPrintTypeEnum"},"is_return_label":{"$ref":"#/components/schemas/IsReturnLabel"},"is_exchange_label":{"$ref":"#/components/schemas/IsExchangeLabel"}}}},"components/schemas/ShipmentNo":{"id":"components/schemas/ShipmentNo","kind":"json-schema","title":"ShipmentNo","data":{"type":"string","description":"Unique identifier of the created shipment.","example":"1222243159"}},"components/schemas/TrackingNo":{"id":"components/schemas/TrackingNo","kind":"json-schema","title":"TrackingNo","data":{"type":"string","description":"The carrier-specific tracking number that can be used to track the Shipment. A value will only be returned if the Rate is for a trackable Shipment and if the Transactions has been processed successfully.","example":"9234690381085700XXXXX"}},"components/schemas/ShipmentItem":{"id":"components/schemas/ShipmentItem","kind":"json-schema","title":"ShipmentItem","data":{"type":"object","properties":{"zone":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"shipment_no":{"$ref":"#/components/schemas/ShipmentNo"},"tracking_no":{"$ref":"#/components/schemas/TrackingNo"},"total_fee":{"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":"Total amount charged (label + insurance, if applicable). Does not include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label_processing_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":39.39},"label_fee":{"type":"number","format":"float","description":"Amount charged for the shipping label.","example":39.39},"insurance_fee":{"type":"number","format":"float","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount charged for insurance; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not purchased."},"children":[]}]}]}],"example":null},"label_processing_fee":{"type":"number","format":"float","description":"Fixed processing fee charged for creating the label.","example":0.05},"label_urls":{"type":"array","description":"List of label file URLs (PNG) for download/printing.","items":{"type":"string","format":"uri"},"example":["https://xxxxxx.amazonaws.com/labels/2025-08-11/b0dd99909e2e7b03_0.png"]},"qrcode_urls":{"type":"array","description":"List of PNG URLs for downloading or printing the QR-code label. Optional field, only used for USPS QR-code labels.","items":{"type":"string","format":"uri"},"example":["https://xxxxxx.amazonaws.com/labels/2025-08-11/b0dd99909e2e7b03_0.png"]},"commercial_urls":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of commercial invoice URLs; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not applicable."},"children":[]}]}]}],"items":{"type":"string","format":"uri"},"example":null},"duplicate_label":{"type":"boolean","nullable":true,"example":true},"label_print_type":{"$ref":"#/components/schemas/LabelPrintTypeEnum"}}}},"components/schemas/ShipmentPurchaseResponse":{"id":"components/schemas/ShipmentPurchaseResponse","kind":"json-schema","title":"ShipmentPurchaseResponse","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"$ref":"#/components/schemas/ShipmentItem"}}}},"components/schemas/DirectBuyShipmentRequest":{"id":"components/schemas/DirectBuyShipmentRequest","kind":"json-schema","title":"DirectBuyShipmentRequest","data":{"allOf":[{"type":"object","required":["platform_uk_id","carrier_code","service_level"],"properties":{"platform_uk_id":{"$ref":"#/components/schemas/PlatformUkId"},"carrier_code":{"$ref":"#/components/schemas/CarrierCodeEnum"},"service_level":{"$ref":"#/components/schemas/ServiceLevelEnum"}}},{"$ref":"#/components/schemas/BasicRateReqWithReturnAddress"},{"type":"object","required":["label_print_type"],"properties":{"custom_data":{"$ref":"#/components/schemas/ShipmentCustomData"},"insurance_data":{"$ref":"#/components/schemas/InsuranceData"},"label_print_type":{"$ref":"#/components/schemas/LabelPrintTypeEnum"},"is_return_label":{"$ref":"#/components/schemas/IsReturnLabel"},"is_exchange_label":{"$ref":"#/components/schemas/IsExchangeLabel"}}}]}},"components/schemas/ShipmentVoidRequest":{"id":"components/schemas/ShipmentVoidRequest","kind":"json-schema","title":"ShipmentVoidRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You only need to provide either shipment_no or platform_uk_id when calling the API, and the system will be able to uniquely locate and process the corresponding shipment."},"children":[]}]}]}],"properties":{"shipment_no":{"$ref":"#/components/schemas/ShipmentNo"},"platform_uk_id":{"$ref":"#/components/schemas/PlatformUkId"}}}},"components/schemas/CommonServiceResponse":{"id":"components/schemas/CommonServiceResponse","kind":"json-schema","title":"CommonServiceResponse","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"type":"object","example":{}}}}},"components/schemas/InsuranceRateItem":{"id":"components/schemas/InsuranceRateItem","kind":"json-schema","title":"InsuranceRateItem","data":{"type":"object","properties":{"carrier":{"$ref":"#/components/schemas/CarrierCodeEnum"},"rate_id":{"$ref":"#/components/schemas/InsuranceRateId"},"service_level":{"$ref":"#/components/schemas/ServiceLevelEnum"},"rate":{"type":"number","format":"float","description":"Insurance cost for the specified service level and declared value.","example":1.98},"declared_value":{"type":"number","format":"float","description":"Declared shipment value for insurance coverage calculation.","example":200}}}},"components/schemas/InsuranceRateResponse":{"id":"components/schemas/InsuranceRateResponse","kind":"json-schema","title":"InsuranceRateResponse","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"$ref":"#/components/schemas/InsuranceRateItem"}}}},"components/schemas/TrackingStatusEnum":{"id":"components/schemas/TrackingStatusEnum","kind":"json-schema","title":"TrackingStatusEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current shipment status. Possible values include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The shipment label has been generated but not yet scanned by the carrier."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the shipping process has not started."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available_for_pickup"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The package has arrived at a designated location and is waiting for the recipient to collect it."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates customer action is required to retrieve the shipment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in_transit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The package is in transit, moving through different facilities or checkpoints."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the shipment is on its way but has not yet reached the destination."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"out_for_delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The package has been handed over to the courier and is on its final delivery route."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the shipment is in the last-mile delivery stage."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivered"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The package has been successfully delivered and signed for by the recipient."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the shipping process is complete."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return_to_sender"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The package is being returned to the sender due to failed delivery or other issues."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates a reverse logistics process."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"voided"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The shipping label has been voided and the package will not be processed."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the shipment has been canceled or invalidated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An error occurred during shipment handling."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates carrier-side issues that may require manual intervention."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"seized_by_law_enforcement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The package was seized by law enforcement authorities."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates compliance or legal issues affecting the shipment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unknown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The shipment status is unknown or no valid update is available from the carrier."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates no current tracking information."},"children":[]}]}]}]}]}],"enum":["created","available_for_pickup","in_transit","out_for_delivery","delivered","return_to_sender","voided","error","seized_by_law_enforcement","unknown"],"example":"in_transit"}},"components/schemas/TrackingLocation":{"id":"components/schemas/TrackingLocation","kind":"json-schema","title":"TrackingLocation","data":{"type":"object","description":"Location information reported by the carrier. Fields such as city, state, zipcode, and country may be returned depending on carrier data availability.","properties":{"city":{"type":"string","example":"BROOKLYN"},"state":{"type":"string","example":"NY"},"zipcode":{"type":"string","example":"91777"},"country":{"type":"string"}}}},"components/schemas/ReturnToSenderFlag":{"id":"components/schemas/ReturnToSenderFlag","kind":"json-schema","title":"ReturnToSenderFlag","data":{"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 shipment has been returned to the sender."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is always present in the response when the status code is 200, regardless of the current tracking status."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false: The shipment has not been returned to the sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true: The shipment has been returned to the sender."},"children":[]}]}]}]}],"example":true,"default":false}},"components/schemas/TrackingEventWUtcOffset":{"id":"components/schemas/TrackingEventWUtcOffset","kind":"json-schema","title":"TrackingEventWUtcOffset","data":{"type":"object","description":"A single tracking event.","properties":{"status":{"type":"string","example":"in_transit"},"message":{"type":"string","description":"Human-readable description.","example":"Arrived at USPS Facility"},"event_time":{"type":"string","format":"date-time","description":"Event timestamp returned in ISO 8601 format with the UTC offset included\nto indicate the local time zone of the event.\n","example":"2025-09-15T09:22:36-05:00"},"location":{"$ref":"#/components/schemas/TrackingLocation"}}}},"components/schemas/TrackingDataWUtcOffset":{"id":"components/schemas/TrackingDataWUtcOffset","kind":"json-schema","title":"TrackingDataWUtcOffset","data":{"type":"object","description":"This is the latest tracking record.","properties":{"status":{"$ref":"#/components/schemas/TrackingStatusEnum"},"message":{"type":"string","description":"Human-readable description of the status.","example":"USPS in possession of item"},"status_summary":{"type":"string","description":"The status summary.","example":"Your item has been delivered and is available at xxx at 9:00 am on xxx in xxxx, xx 20000."},"recipient_name":{"type":"string","description":"The name of the person signing for delivery (if available).","example":"Alice"},"scanned_time":{"type":"string","format":"date-time","description":"The timestamp when the package was scanned, returned in ISO 8601 format with the UTC offset included to indicate the local time zone.\n","example":"2025-12-16T10:48:28-05:00"},"location":{"$ref":"#/components/schemas/TrackingLocation"},"return_to_sender":{"$ref":"#/components/schemas/ReturnToSenderFlag"},"first_scan_date":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of the first carrier scan for the shipment, indicating when the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package was initially processed or received by the carrier. Returned in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 format with the UTC offset included to represent the event’s local time."},"children":[]}]}]}],"example":"2025-11-14T14:07:33-05:00"},"first_scan_description":{"type":"string","description":"Description of the first carrier scan event. Indicates the initial status or processing message recorded when the shipment was first scanned.\n","example":"Package is in transit to a UPS facility"},"first_scan_location":{"$ref":"#/components/schemas/TrackingLocation"},"tracking_events":{"type":"array","items":{"$ref":"#/components/schemas/TrackingEventWUtcOffset"}}}}},"components/schemas/TrackingStatusWithUtcOffsetResponse":{"id":"components/schemas/TrackingStatusWithUtcOffsetResponse","kind":"json-schema","title":"TrackingStatusWithUtcOffsetResponse","data":{"type":"object","description":"Standard wrapper for tracking status responses.","properties":{"code":{"type":"string","description":"API response code; \"ok\" indicates success.","example":"ok"},"msg":{"type":"string","description":"Human-readable response message.","example":"ok"},"data":{"$ref":"#/components/schemas/TrackingDataWUtcOffset"}}}},"components/schemas/PodRecipient":{"id":"components/schemas/PodRecipient","kind":"json-schema","title":"PodRecipient","data":{"type":"object","description":"A single POD email recipient.","required":["email","first_name","last_name"],"properties":{"email":{"type":"string","format":"email","description":"Recipient email address that will receive the POD letter.","example":"xxxxxxx@gmail.com"},"first_name":{"type":"string","description":"Recipient first name.","example":"Lisa"},"last_name":{"type":"string","description":"Recipient last name.","example":"Green"}}}},"components/schemas/PodSubmitRequest":{"id":"components/schemas/PodSubmitRequest","kind":"json-schema","title":"PodSubmitRequest","data":{"type":"object","required":["tracking_number","carrier_code","recipients"],"properties":{"tracking_number":{"type":"string","description":"Carrier tracking number of the shipment the POD is requested for.","example":"940XXXXXXXXXXXXXXXXX"},"carrier_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier code. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is currently supported; any other value is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipment.carrier_code_illegal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["USPS"],"example":"USPS"},"recipients":{"type":"array","description":"Recipients who will receive the POD letter by email. Must contain 1 to 3 recipients.","minItems":1,"maxItems":3,"items":{"$ref":"#/components/schemas/PodRecipient"}},"letter_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of POD letter to generate. Passed through to the carrier. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROOF_OF_DELIVERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the currently used value."},"children":[]}]}]}],"example":"PROOF_OF_DELIVERY"}}}},"components/schemas/PodSubmitResponse":{"id":"components/schemas/PodSubmitResponse","kind":"json-schema","title":"PodSubmitResponse","data":{"type":"object","properties":{"transaction_message":{"type":"string","description":"Human-readable confirmation that the POD request was accepted for processing.","example":"Your Proof of Delivery record is complete and will be processed shortly."}}}},"components/schemas/PodSubmitResponseEnvelope":{"id":"components/schemas/PodSubmitResponseEnvelope","kind":"json-schema","title":"PodSubmitResponseEnvelope","data":{"type":"object","description":"Standard API response envelope for the submit POD endpoint.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result code. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates success; any other value indicates a business error and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ok"},"msg":{"type":"string","description":"Human-readable result message.","example":"ok"},"data":{"allOf":[{"$ref":"#/components/schemas/PodSubmitResponse"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response payload; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/PickupAddress":{"id":"components/schemas/PickupAddress","kind":"json-schema","title":"PickupAddress","data":{"required":["phone","street","city","state","country","zip_code","address_type"],"type":"object","properties":{"first_name":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First Name corresponding to the address. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided."},"children":[]}]}]}],"example":"Alice"},"last_name":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last Name corresponding to the address. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided."},"children":[]}]}]}],"example":"Green"},"company_name":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Firm/business name corresponding to the address. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not provided."},"children":[]}]}]}],"example":"ShipSaving"},"phone":{"type":"string","pattern":"^\\d{10}$","description":"Phone number of the contact at the pickup location. Must be exactly 10 digits.","example":"1234567890"},"email":{"type":"string","format":"email","maxLength":50,"pattern":"^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address of the contact at the pickup location. Must be a valid email format (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name@example.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"it@shipsaving.com"},"street":{"type":"string","minLength":1,"maxLength":50,"description":"The number of a building along with the name of the road or street on which it is located.","example":"xxxx Olive Street"},"street2":{"type":"string","maxLength":50,"description":"The secondary unit designator, such as apartment(APT) or suite(STE) number, defining the exact location of the address within a building.","example":"STE XXX"},"city":{"type":"string","minLength":1,"maxLength":28,"description":"This is the city name of the address.","example":"San Francisco"},"state":{"type":"string","description":"This is the state name or two-character state code of the address. The request accepts either the full state name or a two-character state code.","example":"CA"},"zip_code":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal code of the address. Must be either a 5-digit ZIP code (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"900XX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or ZIP+4 format (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"900XX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"941XX"},"country":{"type":"string","pattern":"^[A-Z]{2}$","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 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"},"address_type":{"type":"string","description":"Indicates whether the pickup address is residential or commercial.\nThis flag is used to determine carrier-specific surcharges (e.g., UPS residential delivery fees).\n","example":"residential","enum":["residential","commercial"]}},"anyOf":[{"required":["first_name","last_name"]},{"required":["company_name"]}]}},"components/schemas/PackageLocationEnum":{"id":"components/schemas/PackageLocationEnum","kind":"json-schema","title":"PackageLocationEnum","data":{"description":"This is the location of the packages ready for pick-up at the pickup address.","type":"string","enum":["front_door","back_door","side_door","knock_on_door_ring_bell","mail_room","office","reception","in_at_mail_box","other"]}},"components/schemas/PickUpCarrierCodeEnum":{"id":"components/schemas/PickUpCarrierCodeEnum","kind":"json-schema","title":"PickUpCarrierCodeEnum","data":{"type":"string","description":"A code identifying the shipping carrier/provider for the pickup. This value determines which logistics provider should handle the pickup or shipment request. Currently only USPS is supported. Future values may include codes for other carriers (e.g., UPS, FedEx).\n","enum":["USPS"],"example":"USPS"}},"components/schemas/AddPickUpByShipmentRequest":{"id":"components/schemas/AddPickUpByShipmentRequest","kind":"json-schema","title":"AddPickUpByShipmentRequest","data":{"required":["package_location","carrier_code","tracking_nos"],"type":"object","properties":{"pickup_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled pickup date in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. If omitted, the value is automatically set to the next calendar day based on the America/Los_Angeles time zone, regardless of the request submission time."},"children":[]}]}]}]},"pickup_location":{"$ref":"#/components/schemas/PickupAddress"},"package_location":{"$ref":"#/components/schemas/PackageLocationEnum"},"package_location_ext":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional details on where the packages can be picked-up. This is required when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"package_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Chinese characters are not supported."},"children":[]}]}]}]},"carrier_code":{"$ref":"#/components/schemas/PickUpCarrierCodeEnum"},"tracking_nos":{"type":"array","description":"A list of shipment tracking numbers associated with the packages to be included in the pickup request.","items":{"$ref":"#/components/schemas/TrackingNo"}}}}},"components/schemas/PickUpNo":{"id":"components/schemas/PickUpNo","kind":"json-schema","title":"PickUpNo","data":{"type":"string","description":"The internal pickup record number used to identify a previously scheduled USPS pickup request. This value is returned during the pickup creation process and must be provided to cancel the corresponding pickup order.\n","example":"10000000000"}},"components/schemas/PickUpConfirmationNo":{"id":"components/schemas/PickUpConfirmationNo","kind":"json-schema","title":"PickUpConfirmationNo","data":{"type":"string","description":"This is the USPS assigned confirmation number of the pick-up.","example":"WTC65384000"}},"components/schemas/AddPickupResult":{"id":"components/schemas/AddPickupResult","kind":"json-schema","title":"AddPickupResult","data":{"type":"object","properties":{"pickup_no":{"$ref":"#/components/schemas/PickUpNo"},"pickup_date":{"type":"string","description":"Scheduled pickup date (YYYY-MM-DD).","example":"2025-11-21"},"package_total_num":{"type":"integer","format":"int32","description":"Total number of packages included in the pickup request.","example":1},"package_total_weight":{"type":"number","description":"Total weight of all packages in pounds (lb).","example":0.1},"carrier_code":{"$ref":"#/components/schemas/PickUpCarrierCodeEnum"},"carrier_name":{"type":"string","description":"Name of the carrier handling the pickup.","example":"USPS"},"confirmation_number":{"$ref":"#/components/schemas/PickUpConfirmationNo"}}}},"components/schemas/CancelPickupRequest":{"id":"components/schemas/CancelPickupRequest","kind":"json-schema","title":"CancelPickupRequest","data":{"type":"object","required":["pickup_no"],"properties":{"pickup_no":{"$ref":"#/components/schemas/PickUpNo"}}}},"components/schemas/PickUpStatusEnum":{"id":"components/schemas/PickUpStatusEnum","kind":"json-schema","title":"PickUpStatusEnum","data":{"type":"string","description":"The current status of the USPS pickup request.","enum":["CONFIRMED","CANCELED"],"example":"CONFIRMED"}},"components/schemas/PickupVO":{"id":"components/schemas/PickupVO","kind":"json-schema","title":"PickupVO","data":{"type":"object","description":"Pickup order information.","properties":{"status":{"$ref":"#/components/schemas/PickUpStatusEnum"},"pickup_no":{"$ref":"#/components/schemas/PickUpNo"},"pickup_date":{"type":"string","description":"Scheduled pickup date in YYYY-MM-DD format.","example":"2025-11-21"},"package_total_num":{"type":"integer","format":"int32","description":"Total number of packages included in the pickup request.","example":1},"package_total_weight":{"type":"number","description":"Total weight of all packages in pounds (lb).","example":0.1},"carrier_code":{"$ref":"#/components/schemas/PickUpCarrierCodeEnum"},"carrier_name":{"type":"string","description":"Name of the carrier handling the pickup.","example":"USPS"},"confirmation_number":{"$ref":"#/components/schemas/PickUpConfirmationNo"},"pickup_location_ext":{"$ref":"#/components/schemas/AddressTo"},"package_location":{"$ref":"#/components/schemas/PackageLocationEnum"},"package_location_ext":{"type":"string","description":"Additional information describing the package location.","example":"Left behind the plant"},"tracking_nos":{"type":"array","description":"List of shipment tracking numbers associated with the pickup.","items":{"$ref":"#/components/schemas/TrackingNo"},"example":["94055XXXXXXXXX123","92055XXXXXXXXX456"]}}}},"components/schemas/QueryPickupResponse":{"id":"components/schemas/QueryPickupResponse","kind":"json-schema","title":"QueryPickupResponse","data":{"type":"object","description":"Response object for querying paginated pickup records.","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"type":"object","properties":{"pickup_data_list":{"type":"array","description":"List of pickup order records.","items":{"$ref":"#/components/schemas/PickupVO"}},"total_count":{"type":"integer","description":"Total number of pickup records matching the query.","format":"int32"}}}}}},"components/schemas/QueryPackageLocationResponse":{"id":"components/schemas/QueryPackageLocationResponse","kind":"json-schema","title":"QueryPackageLocationResponse","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PackageLocationEnum"}}}}},"components/schemas/AddressIssue":{"id":"components/schemas/AddressIssue","kind":"json-schema","title":"AddressIssue","data":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable issue code.","example":"ADDRESS.SECONDARY.MISSING"},"message":{"type":"string","description":"Human-readable description of the issue.","example":"High-rise address missing secondary number."}}}},"components/schemas/AddressCorrection":{"id":"components/schemas/AddressCorrection","kind":"json-schema","title":"AddressCorrection","data":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable code.","example":"ADDRESS.COMPONENT.CHANGED"},"message":{"type":"string","description":"Human-readable description.","example":"An address component (i.e., directional or suffix only) was changed"}}}},"components/schemas/ValidatedAddress":{"id":"components/schemas/ValidatedAddress","kind":"json-schema","title":"ValidatedAddress","data":{"allOf":[{"type":"object","properties":{"street":{"type":"string","description":"Standardized primary street line.","example":"17XXX Tremont ST"},"street2":{"type":"string","nullable":true,"description":"Standardized secondary line, if available.","example":null},"city":{"type":"string","description":"Standardized city/locality (uppercase).","example":"Los Angeles"},"state":{"type":"string","example":"CA"},"zip":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standardized ZIP or ZIP+4."},"children":[]}]}]}],"example":"02111-XXXX"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","example":"US"},"residential":{"type":"boolean","description":"Whether the address is classified as residential.","example":true},"errored":{"type":"boolean","description":"Whether validation encountered one or more errors.","example":true},"corrected":{"type":"boolean","description":"Whether any components were corrected by the validator.","example":true},"standardized":{"type":"boolean","description":"Whether the address is fully standardized.","example":false},"errors":{"type":"array","description":"Validation errors discovered during processing.","items":{"$ref":"#/components/schemas/AddressIssue"}},"corrections":{"type":"array","description":"Applied corrections or suggestions.","items":{"$ref":"#/components/schemas/AddressCorrection"}}}}]}},"components/schemas/AddressValidateResponse":{"id":"components/schemas/AddressValidateResponse","kind":"json-schema","title":"AddressValidateResponse","data":{"type":"object","properties":{"code":{"type":"string","description":"Result code.","example":"ok"},"msg":{"type":"string","description":"Human-readable message.","example":"ok"},"data":{"$ref":"#/components/schemas/ValidatedAddress"}}}},"components/schemas/ScanFormAddress":{"id":"components/schemas/ScanFormAddress","kind":"json-schema","title":"ScanFormAddress","data":{"allOf":[{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipped from address printed on the SCAN Form. At least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pair must be provided."},"children":[]}]}]}],"properties":{"company_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Firm/business name. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not provided."},"children":[]}]}]}],"example":"ShipSaving"},"first_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact first name. Required (together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided."},"children":[]}]}]}],"example":"Alice"},"last_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact last name. Required (together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided."},"children":[]}]}]}],"example":"Green"},"phone":{"type":"string","description":"Contact phone number. Optional, but recommended so the carrier can make contact if needed.","example":"1234567890"},"email":{"type":"string","description":"Contact email address. Optional.","example":"it@shipsaving.com"}}},{"$ref":"#/components/schemas/BasicAddress"}]}},"components/schemas/ScanFormCreateRequest":{"id":"components/schemas/ScanFormCreateRequest","kind":"json-schema","title":"ScanFormCreateRequest","data":{"type":"object","description":"Request to create a USPS SCAN Form (PS Form 5630) for a set of already-purchasedshipments.\n","required":["address_data","tracking_nos"],"properties":{"address_data":{"$ref":"#/components/schemas/ScanFormAddress"},"tracking_nos":{"type":"array","description":"Tracking numbers of the purchased shipments to include in the SCAN Form. Every shipment must belong to USPS and be in a purchased, not-yet-shipped state; a shipment may appear on only one SCAN Form.\n","minItems":1,"items":{"$ref":"#/components/schemas/TrackingNo"}},"ship_date":{"type":"string","format":"date","description":"A calendar date in ISO 8601 full-date format (YYYY-MM-DD), without time or time zone. Optional; defaults to the current date if omitted.\n","example":"2026-07-21"}}}},"components/schemas/ScanFormCreateResponse":{"id":"components/schemas/ScanFormCreateResponse","kind":"json-schema","title":"ScanFormCreateResponse","data":{"type":"object","properties":{"scan_form_image":{"type":"string","description":"URL of the generated SCAN Form PDF.","example":"https://xxxxx/forms/2026-07-16/92XXXXXXXXX00000010794.pdf"}}}},"components/schemas/ScanFormCreateResponseEnvelope":{"id":"components/schemas/ScanFormCreateResponseEnvelope","kind":"json-schema","title":"ScanFormCreateResponseEnvelope","data":{"type":"object","description":"Standard API response envelope for the create SCAN Form endpoint.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result code. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates success; any other value indicates a business error and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ok"},"msg":{"type":"string","description":"Human-readable result message.","example":"ok"},"data":{"allOf":[{"$ref":"#/components/schemas/ScanFormCreateResponse"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response payload; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"schema_128":{"kind":"json-schema","data":{"type":"object","properties":{"grant_type":{"type":"string","enum":["client_credentials"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"scope":{"type":"string","description":"Optional space-delimited scopes.","example":"API"}},"required":["grant_type"]},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"number"},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"string"},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"string","example":"USPS"},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"$ref":"#/components/schemas/AddPickupResult"}}},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"string","description":"Error code in dot-separated format."},"msg":{"type":"string","description":"Human-readable error message."},"data":{"example":null}}},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"$ref":"#/components/schemas/PickUpConfirmationNo"},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"type":"string","enum":["CONFIRMED","CANCELED"]},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"$ref":"#/components/schemas/PickUpCarrierCodeEnum"},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":1},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":50},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_139"}},"exampleStore":{"paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample":{"value":{"grant_type":"client_credentials","scope":"API"},"key":"curlExample","summary":"Client Credentials request","id":"paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample"},"paths/~1oauth2~1token/post/responses/200/content/application~1json/examples/success":{"value":{"access_token":"eyJraWQiOiIxIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJTU19MSVZFX3RoNXE5S0pUZTBrdllsM3pRSFFmU0Q3NW5ETGlZQ2s4dlowSSIsImF1ZCI6IlNTX0xJVkVfdGg1cTlLSlRlMGt2WWwzelFIUWZTRDc1bkRMaVlDazh2WjBJIiwibmJmIjoxNzU0MzU1MzM0LCJjb21wYW55X2lkIjoiMTgyMyIsInVzZXJfaWQiOiIyNDA3Iiwic2NvcGUiOlsiQVBJIl0sImlzX3ZhbGlkIjp0cnVlLCJpc3MiOiJodHRwczovL3gtYXBpLnNoaXBzYXZpbmcudXMiLCJleHAiOjE3NTQzNTcxMzQsImlhdCI6MTc1NDM1NTMzNCwidGVzdF9tb2RlbCI6ZmFsc2V9.CsOfJozZUmd5cFrSodxGuDH0xxRQjau_qKwyOuJBPWigJeZXeoB_FgOl7r2kDfVndrru7IkXw5XCEmePkTJ25nyTD7RiysInBOuU0a89mfj4czedC8qHIHU-EI1CfRopHan2dCHfSog5skNT6edAmQfSNndj6mV18Pr0AclnhEgIG-CsfYkxZXRITXeqFKqiLfbUt8A4YsqT9zhXHqqttk42rBNzSddgBcBkHNGdys-qltEPc7xB_NpV02tZbsfl-hcHbHZYt_ufT4u4BLy5g7p6bd4Tt2vgUbRrVx-umCWuT3dad5di2Loj9vs2boywSCQshM1Aj4Fxzg8Sk-GsBw","scope":"API","token_type":"Bearer","expires_in":1799},"key":"success","summary":"Successful response","id":"paths/~1oauth2~1token/post/responses/200/content/application~1json/examples/success"},"paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badContentType":{"value":{"error_description":"OAuth 2.0 Parameter: grant_type","error":"invalid_request","error_uri":"https://datatracker.ietf.org/doc/html/rfc6749#section-5.2"},"key":"badContentType","summary":"Content-Type not form-encoded","id":"paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badContentType"},"paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badGrantType":{"value":{"error_description":"OAuth 2.0 Parameter: grant_type","error":"unsupported_grant_type","error_uri":"https://datatracker.ietf.org/doc/html/rfc6749#section-5.2"},"key":"badGrantType","summary":"Unsupported grant_type","id":"paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badGrantType"},"paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/invalidScope":{"value":{"error":"invalid_scope"},"key":"invalidScope","summary":"Invalid scope value","id":"paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/invalidScope"},"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentAlreadyInPickup":{"value":{"code":"pickup.shipment_already_in_pickup","msg":"Shipment is already in pickup (tracking no: {tracking_no}).","data":null},"key":"shipmentAlreadyInPickup","summary":"Shipment already has a pickup scheduled","id":"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentAlreadyInPickup"},"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentNotExist":{"value":{"code":"pickup.shipment_not_exist","msg":"Shipment does not exist.","data":null},"key":"shipmentNotExist","summary":"Tracking number does not exist","id":"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentNotExist"},"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/missingAddressFields":{"value":{"code":"invalid_request_params","msg":"Missing or invalid request parameters\nInvalid request, 'address' requires a valid 'street1', 'city', 'state', 'zip', 'phone', and 'name' or 'company'.","data":null},"key":"missingAddressFields","summary":"Required address fields missing (e.g., phone)","id":"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/missingAddressFields"},"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/invalidAddress":{"value":{"code":"invalid_request_params","msg":"Missing or invalid request parameters\nAPI Version: /pickup/v3/, Error Code: 400, An invalid address was entered. Please verify address, including apartment, suite, etc.: An invalid address was entered. Please verify address, including apartment, suite, etc., Source Parameter: No parameter provided., USPS Error Code: 1007","data":null},"key":"invalidAddress","summary":"Address rejected by carrier validation","id":"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/invalidAddress"},"paths/~1api~1shipment~1pickup~1cancel/post/responses/400/content/application~1json/examples/pickupAlreadyCanceled":{"value":{"code":"pickup.pickup_is_canceled","msg":"Pickup is already canceled.","data":null},"key":"pickupAlreadyCanceled","summary":"Pickup has already been canceled","id":"paths/~1api~1shipment~1pickup~1cancel/post/responses/400/content/application~1json/examples/pickupAlreadyCanceled"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication (JWT)."},"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic","description":"Basic auth using AppKey/AppSecret."}},"servers":[{"url":"https://x-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/v2/openapi.json?download"},{"url":"/_bundle/v2/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"ShipSaving New API"}},"baseSlug":"/v2/openapi","routesMapping":{}}