{"items":[{"type":"link","label":"ShipSaving Legacy API","link":"/zh-hans/v1/openapi","routeSlug":"/zh-hans/v1/openapi","content":{"contentType":"overview","meta":{"name":"ShipSaving Legacy API"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.shipsaving.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"ShipSaving Legacy API (v1)","showPageActions":true}],"sectionId":"/zh-hans/v1/openapi"}]}]}},{"type":"group","label":"运单管理","link":"/zh-hans/v1/openapi/运单管理","routeSlug":"/zh-hans/v1/openapi/运单管理","items":[{"label":"查询包裹价格列表","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zh-hans/v1/openapi/运单管理/getratelist","routeSlug":"/zh-hans/v1/openapi/运单管理/getratelist","metadata":{"seo":{"title":"查询包裹价格列表","description":"根据指定的包裹信息和地址获取运费报价。    限流说明： 每分钟最多600次请求。"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRateList","name":"查询包裹价格列表","isWebhook":false,"pointer":"/paths/~1api~1rates~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"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":"根据指定的包裹信息和地址获取运费报价。   "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"限流说明："},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 每分钟最多600次请求。"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentRequest"}},"schemaId":"components/schemas/ShipmentRequest","pointer":"/paths/~1api~1rates~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/rates/list","servers":[{"url":"https://api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShipmentRequest"}},"responseCodes":["200"],"pointer":"/api/rates/list","href":"运单管理/getratelist","openApiOperationId":"getRateList","summary":"查询包裹价格列表"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com"}],"schemaId":"components/schemas/ShipmentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运费列表获取成功"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RatingResponse"}},"schemaId":"components/schemas/RatingResponse"}],"pointer":"/paths/~1api~1rates~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RatingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RatingResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/rates/list"},{"label":"购买包裹","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zh-hans/v1/openapi/运单管理/purchaselabel","routeSlug":"/zh-hans/v1/openapi/运单管理/purchaselabel","metadata":{"seo":{"title":"购买包裹","description":"根据提供的运费报价ID购买运单面单。限流说明： 每分钟最多600次请求。"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"purchaseLabel","name":"购买包裹","isWebhook":false,"pointer":"/paths/~1api~1rates~1buy/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"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":"根据提供的运费报价ID购买运单面单。"},"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":"限流说明："},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 每分钟最多600次请求。"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rate_id","in":"query","schemaId":"schema_168","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运费报价的唯一标识。"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1rates~1buy/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/rates/buy","servers":[{"url":"https://api.shipsaving.com"}],"parameters":{"path":[],"query":[{"name":"rate_id","in":"query","required":true,"schemaId":"schema_168"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/rates/buy","href":"运单管理/purchaselabel","openApiOperationId":"purchaseLabel","summary":"购买包裹"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"面单购买成功。"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseLabelResponse"}},"schemaId":"components/schemas/PurchaseLabelResponse"}],"pointer":"/paths/~1api~1rates~1buy/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseLabelResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseLabelResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/rates/buy"},{"label":"直接下单","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zh-hans/v1/openapi/运单管理/directlybuylabel","routeSlug":"/zh-hans/v1/openapi/运单管理/directlybuylabel","metadata":{"seo":{"title":"直接下单","description":"在无需比较多个承运商选项的情况下直接购买运单面单。   仅当用户账户中针对每种承运商类型只配置了一个承运商时，才适用该接口。   若同一类型下存在多个承运商，请先使用查询包裹价格列表接口获取可选方案，再调用购买包裹接口完成购买。              限流说明： 每分钟最多600次请求。"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"directlyBuyLabel","name":"直接下单","isWebhook":false,"pointer":"/paths/~1api~1rates~1buy-label/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"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":"在无需比较多个承运商选项的情况下直接购买运单面单。   仅当用户账户中针对每种承运商类型只配置了一个承运商时，才适用该接口。   若同一类型下存在多个承运商，请先使用查询包裹价格列表接口获取可选方案，再调用购买包裹接口完成购买。    "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"          "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"限流说明："},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 每分钟最多600次请求。"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentRequest"}},"schemaId":"components/schemas/ShipmentRequest","pointer":"/paths/~1api~1rates~1buy-label/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/rates/buy-label","servers":[{"url":"https://api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShipmentRequest"}},"responseCodes":["200"],"pointer":"/api/rates/buy-label","href":"运单管理/directlybuylabel","openApiOperationId":"directlyBuyLabel","summary":"直接下单"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com"}],"schemaId":"components/schemas/ShipmentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"购买面单成功"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseLabelResponse"}},"schemaId":"components/schemas/PurchaseLabelResponse"}],"pointer":"/paths/~1api~1rates~1buy-label/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PurchaseLabelResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PurchaseLabelResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/rates/buy-label"},{"label":"取消面单","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zh-hans/v1/openapi/运单管理/voidlabel","routeSlug":"/zh-hans/v1/openapi/运单管理/voidlabel","metadata":{"seo":{"title":"取消面单","description":"通过运单的追踪号码作废已购买的运单面单。   限流说明： 每分钟最多600次请求。"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"voidLabel","name":"取消面单","isWebhook":false,"pointer":"/paths/~1api~1shipments~1void/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"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":"通过运单的追踪号码作废已购买的运单面单。 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"限流说明："},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 每分钟最多600次请求。"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_169","exampleIds":["paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_169","exampleIds":["paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1shipments~1void/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipments/void","servers":[{"url":"https://api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_169","exampleIds":["paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/shipments/void","href":"运单管理/voidlabel","openApiOperationId":"voidLabel","summary":"取消面单"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com"}],"schemaId":"schema_169","exampleIds":["paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_169","exampleIds":["paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"取消面单成功"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_170","exampleIds":["paths/~1api~1shipments~1void/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_170","exampleIds":["paths/~1api~1shipments~1void/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1shipments~1void/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_170","exampleIds":["paths/~1api~1shipments~1void/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_170","exampleIds":["paths/~1api~1shipments~1void/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/api/shipments/void"}],"content":{"contentType":"group","meta":{"name":"运单管理"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"运单管理","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/rates/list","summary":"查询包裹价格列表","prefix":{"name":"post","color":"post"},"badges":[],"link":"/运单管理/getratelist","deprecated":false},{"title":"/api/rates/buy","summary":"购买包裹","prefix":{"name":"get","color":"get"},"badges":[],"link":"/运单管理/purchaselabel","deprecated":false},{"title":"/api/rates/buy-label","summary":"直接下单","prefix":{"name":"post","color":"post"},"badges":[],"link":"/运单管理/directlybuylabel","deprecated":false},{"title":"/api/shipments/void","summary":"取消面单","prefix":{"name":"post","color":"post"},"badges":[],"link":"/运单管理/voidlabel","deprecated":false}]}]}]}]}},{"type":"group","label":"订单管理","link":"/zh-hans/v1/openapi/订单管理","routeSlug":"/zh-hans/v1/openapi/订单管理","items":[{"label":"创建订单","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zh-hans/v1/openapi/订单管理/createorders","routeSlug":"/zh-hans/v1/openapi/订单管理/createorders","metadata":{"seo":{"title":"创建订单","description":"在 ShipSaving 系统中创建一个新订单。通常用于在生成运单面单之前预先创建订单。速率限制： 每分钟最多 300 次请求。"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrders","name":"创建订单","isWebhook":false,"pointer":"/paths/~1api~1orders~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"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":"在 ShipSaving 系统中创建一个新订单。通常用于在生成运单面单之前预先创建订单。"},"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":"速率限制："},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 每分钟最多 300 次请求。"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrderRequest"}},"schemaId":"components/schemas/CreateOrderRequest","pointer":"/paths/~1api~1orders~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/create","servers":[{"url":"https://api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateOrderRequest"}},"responseCodes":["200"],"pointer":"/api/orders/create","href":"订单管理/createorders","openApiOperationId":"createOrders","summary":"创建订单"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com"}],"schemaId":"components/schemas/CreateOrderRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateOrderRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"订单创建成功"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171"}},"schemaId":"schema_171"}],"pointer":"/paths/~1api~1orders~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_171","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171"}}}],"examples":[]}]}]}]},"httpPath":"/api/orders/create"},{"label":"查询订单面单","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zh-hans/v1/openapi/订单管理/checkorderlabels","routeSlug":"/zh-hans/v1/openapi/订单管理/checkorderlabels","metadata":{"seo":{"title":"查询订单面单","description":"获取指定店铺及订单号对应的运单面单信息。仅适用于已成功购买运单面单的订单。   速率限制： 每分钟最多 120 次请求。"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkOrderLabels","name":"查询订单面单","isWebhook":false,"pointer":"/paths/~1api~1shipments~1get/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"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":"获取指定店铺及订单号对应的运单面单信息。仅适用于已成功购买运单面单的订单。 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"速率限制："},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 每分钟最多 120 次请求。"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"store_name","in":"query","schemaId":"schema_168","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ShipSaving 系统中的店铺名称"},"children":[]}]}]}],"required":true},{"name":"order_number","in":"query","schemaId":"schema_168","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"与已购买运单面单关联的订单号"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1shipments~1get/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipments/get","servers":[{"url":"https://api.shipsaving.com"}],"parameters":{"path":[],"query":[{"name":"store_name","in":"query","required":true,"schemaId":"schema_168"},{"name":"order_number","in":"query","required":true,"schemaId":"schema_168"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipments/get","href":"订单管理/checkorderlabels","openApiOperationId":"checkOrderLabels","summary":"查询订单面单"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"请求成功"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_172"}},"schemaId":"schema_172"}],"pointer":"/paths/~1api~1shipments~1get/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_172","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_172"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipments/get"},{"label":"删除订单","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zh-hans/v1/openapi/订单管理/deleteorder","routeSlug":"/zh-hans/v1/openapi/订单管理/deleteorder","metadata":{"seo":{"title":"删除订单","description":"通过指定店铺名称和订单号，从 ShipSaving 系统中删除一个已有订单。该操作不可逆，将永久删除订单及其关联数据。   速率限制： 每分钟最多 300 次请求。"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrder","name":"删除订单","isWebhook":false,"pointer":"/paths/~1api~1orders~1delete/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"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":"通过指定店铺名称和订单号，从 ShipSaving 系统中删除一个已有订单。该操作不可逆，将永久删除订单及其关联数据。 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"速率限制："},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 每分钟最多 300 次请求。"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_173"}},"schemaId":"schema_173","pointer":"/paths/~1api~1orders~1delete/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/orders/delete","servers":[{"url":"https://api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_173"}},"responseCodes":["200","400"],"pointer":"/api/orders/delete","href":"订单管理/deleteorder","openApiOperationId":"deleteOrder","summary":"删除订单"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com"}],"schemaId":"schema_173","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_173"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"订单删除成功"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_174","exampleIds":["paths/~1api~1orders~1delete/delete/responses/200/content/application~1json/example"]}},"schemaId":"schema_174","exampleIds":["paths/~1api~1orders~1delete/delete/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"删除订单时发生错误"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_175","exampleIds":["paths/~1api~1orders~1delete/delete/responses/400/content/application~1json/example"]}},"schemaId":"schema_175","exampleIds":["paths/~1api~1orders~1delete/delete/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1delete/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_174","exampleIds":["paths/~1api~1orders~1delete/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_174","exampleIds":["paths/~1api~1orders~1delete/delete/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_175","exampleIds":["paths/~1api~1orders~1delete/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_175","exampleIds":["paths/~1api~1orders~1delete/delete/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/api/orders/delete"}],"content":{"contentType":"group","meta":{"name":"订单管理"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"订单管理","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/orders/create","summary":"创建订单","prefix":{"name":"post","color":"post"},"badges":[],"link":"/订单管理/createorders","deprecated":false},{"title":"/api/shipments/get","summary":"查询订单面单","prefix":{"name":"get","color":"get"},"badges":[],"link":"/订单管理/checkorderlabels","deprecated":false},{"title":"/api/orders/delete","summary":"删除订单","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/订单管理/deleteorder","deprecated":false}]}]}]}]}},{"type":"group","label":"地址校验","link":"/zh-hans/v1/openapi/地址校验","routeSlug":"/zh-hans/v1/openapi/地址校验","items":[{"label":"地址校验","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zh-hans/v1/openapi/地址校验/verifyaddress","routeSlug":"/zh-hans/v1/openapi/地址校验/verifyaddress","metadata":{"seo":{"title":"地址校验","description":"根据提供的地址信息进行校验与标准化处理。该接口会检测地址错误，并返回可能的修正或建议。速率限制： 每分钟最多 600 次请求。"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyAddress","name":"地址校验","isWebhook":false,"pointer":"/paths/~1api~1addresses~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"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":"根据提供的地址信息进行校验与标准化处理。"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":"速率限制："},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 每分钟最多 600 次请求。"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_176"}},"schemaId":"schema_176","pointer":"/paths/~1api~1addresses~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/addresses/verify","servers":[{"url":"https://api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_176"}},"responseCodes":["200"],"pointer":"/api/addresses/verify","href":"地址校验/verifyaddress","openApiOperationId":"verifyAddress","summary":"地址校验"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com"}],"schemaId":"schema_176","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_176"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"地址校验结果"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_177"}},"schemaId":"schema_177"}],"pointer":"/paths/~1api~1addresses~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_177","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_177"}}}],"examples":[]}]}]}]},"httpPath":"/api/addresses/verify"}],"content":{"contentType":"group","meta":{"name":"地址校验"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"地址校验","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/addresses/verify","summary":"地址校验","prefix":{"name":"post","color":"post"},"badges":[],"link":"/地址校验/verifyaddress","deprecated":false}]}]}]}]}},{"type":"group","label":"SCAN Form","link":"/zh-hans/v1/openapi/scan-form","routeSlug":"/zh-hans/v1/openapi/scan-form","items":[{"label":"创建 USPS SCAN Form","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zh-hans/v1/openapi/scan-form/createscanforms","routeSlug":"/zh-hans/v1/openapi/scan-form/createscanforms","metadata":{"seo":{"title":"创建 USPS SCAN Form","description":"根据提供的运单追踪号列表创建 USPS SCAN Form。速率限制： 每分钟最多 60 次请求。"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createScanForms","name":"创建 USPS SCAN Form","isWebhook":false,"pointer":"/paths/~1api~1shipments~1scan-forms~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"创建 USPS SCAN Form","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"根据提供的运单追踪号列表创建 USPS SCAN Form。"},"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":"速率限制："},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 每分钟最多 60 次请求。"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_178","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_178","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1shipments~1scan-forms~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipments/scan-forms/create","servers":[{"url":"https://api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_178","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/shipments/scan-forms/create","href":"scan-form/createscanforms","openApiOperationId":"createScanForms","summary":"创建 USPS SCAN Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com"}],"schemaId":"schema_178","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_178","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"成功获取 SCAN Form 的下载地址"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_179","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_179","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1shipments~1scan-forms~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_179","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_179","exampleIds":["paths/~1api~1shipments~1scan-forms~1create/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/api/shipments/scan-forms/create"},{"label":"创建 DHL eCommerce SCAN Form","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zh-hans/v1/openapi/scan-form/createecsscanforms","routeSlug":"/zh-hans/v1/openapi/scan-form/createecsscanforms","metadata":{"seo":{"title":"创建 DHL eCommerce SCAN Form","description":"发起 DHL eCommerce SCAN Form的异步创建流程。 接口将返回一个请求 ID，可用于通过“获取 DHL eCommerce SCAN Form”接口获取最终的PDF文件。   速率限制： 每分钟最多 60 次请求。"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEcsScanForms","name":"创建 DHL eCommerce SCAN Form","isWebhook":false,"pointer":"/paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"创建 DHL eCommerce SCAN Form","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发起 DHL eCommerce SCAN Form的异步创建流程。 接口将返回一个请求 ID，可用于通过“获取 DHL eCommerce SCAN Form”接口获取最终的PDF文件。 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"速率限制："},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 每分钟最多 60 次请求。"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_178","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_178","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipments/scan-forms/dhl/ecommerce/create","servers":[{"url":"https://api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_178","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/shipments/scan-forms/dhl/ecommerce/create","href":"scan-form/createecsscanforms","openApiOperationId":"createEcsScanForms","summary":"创建 DHL eCommerce SCAN Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com"}],"schemaId":"schema_178","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_178","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCAN Form请求已受理"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_180","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses/200/content/application~1json/examples/success-response"]}},"schemaId":"schema_180","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses/200/content/application~1json/examples/success-response"]}],"pointer":"/paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_180","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses/200/content/application~1json/examples/success-response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_180","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses/200/content/application~1json/examples/success-response"]}}}],"examples":[]}]}]}]},"httpPath":"/api/shipments/scan-forms/dhl/ecommerce/create"},{"label":"获取 DHL eCommerce SCAN Form","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zh-hans/v1/openapi/scan-form/getecsscanforms","routeSlug":"/zh-hans/v1/openapi/scan-form/getecsscanforms","metadata":{"seo":{"title":"获取 DHL eCommerce SCAN Form","description":"根据创建接口返回的请求 ID，获取 DHL eCommerce SCAN Form PDF 下载地址。  速率限制： 每分钟最多 60 次请求。"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEcsScanForms","name":"获取 DHL eCommerce SCAN Form","isWebhook":false,"pointer":"/paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"获取 DHL eCommerce SCAN Form","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"根据创建接口返回的请求 ID，获取 DHL eCommerce SCAN Form PDF 下载地址。 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"速率限制："},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 每分钟最多 60 次请求。"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"request_id","in":"query","schemaId":"schema_181","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"创建SCAN Form的请求ID"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipments/scan-forms/dhl/ecommerce/get","servers":[{"url":"https://api.shipsaving.com"}],"parameters":{"path":[],"query":[{"name":"request_id","in":"query","required":true,"schemaId":"schema_181"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipments/scan-forms/dhl/ecommerce/get","href":"scan-form/getecsscanforms","openApiOperationId":"getEcsScanForms","summary":"获取 DHL eCommerce SCAN Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"成功获取 SCAN Form 的下载地址"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_179","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_179","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_179","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_179","exampleIds":["paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/api/shipments/scan-forms/dhl/ecommerce/get"}],"content":{"contentType":"group","meta":{"name":"SCAN Form"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SCAN Form","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/shipments/scan-forms/create","summary":"创建 USPS SCAN Form","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scan-form/createscanforms","deprecated":false},{"title":"/api/shipments/scan-forms/dhl/ecommerce/create","summary":"创建 DHL eCommerce SCAN Form","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scan-form/createecsscanforms","deprecated":false},{"title":"/api/shipments/scan-forms/dhl/ecommerce/get","summary":"获取 DHL eCommerce SCAN Form","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scan-form/getecsscanforms","deprecated":false}]}]}]}]}},{"type":"group","label":"承运商管理","link":"/zh-hans/v1/openapi/承运商管理","routeSlug":"/zh-hans/v1/openapi/承运商管理","items":[{"label":"获取承运商账户列表","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zh-hans/v1/openapi/承运商管理/getcarrieraccountlist","routeSlug":"/zh-hans/v1/openapi/承运商管理/getcarrieraccountlist","metadata":{"seo":{"title":"获取承运商账户列表","description":"获取与当前 API Token 关联的承运商账户列表。速率限制： 每分钟最多 60 次请求。"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCarrierAccountList","name":"获取承运商账户列表","isWebhook":false,"pointer":"/paths/~1api~1carrier-account~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"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":"获取与当前 API Token 关联的承运商账户列表。"},"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":"速率限制："},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 每分钟最多 60 次请求。"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/carrier-account/list","servers":[{"url":"https://api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/carrier-account/list","href":"承运商管理/getcarrieraccountlist","openApiOperationId":"getCarrierAccountList","summary":"获取承运商账户列表"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"返回承运商账户列表"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_182"}},"schemaId":"schema_182"}],"pointer":"/paths/~1api~1carrier-account~1list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_182","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_182"}}}],"examples":[]}]}]}]},"httpPath":"/api/carrier-account/list"}],"content":{"contentType":"group","meta":{"name":"承运商管理"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"承运商管理","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/carrier-account/list","summary":"获取承运商账户列表","prefix":{"name":"get","color":"get"},"badges":[],"link":"/承运商管理/getcarrieraccountlist","deprecated":false}]}]}]}]}},{"type":"group","label":"账户管理","link":"/zh-hans/v1/openapi/账户管理","routeSlug":"/zh-hans/v1/openapi/账户管理","items":[{"label":"查询账户余额","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/zh-hans/v1/openapi/账户管理/querybalance","routeSlug":"/zh-hans/v1/openapi/账户管理/querybalance","metadata":{"seo":{"title":"查询账户余额","description":"获取账户的实时余额（美元）。速率限制： 每分钟最多 60 次请求。"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryBalance","name":"查询账户余额","isWebhook":false,"pointer":"/paths/~1api~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"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":"获取账户的实时余额（美元）。"},"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":"速率限制："},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 每分钟最多 60 次请求。"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiTokenAuth","scopes":[],"type":"apiKey","in":"query","paramName":"api_token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/balance","servers":[{"url":"https://api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiTokenAuth","type":"apiKey","name":"api_token","in":"query"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/balance","href":"账户管理/querybalance","openApiOperationId":"queryBalance","summary":"查询账户余额"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.shipsaving.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"请求成功"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_183"}},"schemaId":"schema_183"}],"pointer":"/paths/~1api~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_183","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_183"}}}],"examples":[]}]}]}]},"httpPath":"/api/balance"}],"content":{"contentType":"group","meta":{"name":"账户管理"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"账户管理","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/balance","summary":"查询账户余额","prefix":{"name":"get","color":"get"},"badges":[],"link":"/账户管理/querybalance","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/street":{"id":"components/schemas/street","kind":"json-schema","title":"street","data":{"type":"string","example":"xxx Grand Avenue"}},"components/schemas/street2":{"id":"components/schemas/street2","kind":"json-schema","title":"street2","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"地址街道2应包含次要地址单位指示符，如公寓、套房、房间或楼层号。地址街道2用于需要精确客户信息的额外信息，以确保邮件或包裹被送达到正确的地址。在许多情况下，如果没有街道2，则街道2可以留空。"},"children":[]}]}]}],"example":"Apt 5B"}},"components/schemas/zipcode":{"id":"components/schemas/zipcode","kind":"json-schema","title":"zipcode","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"邮政编码"},"children":[]}]}]}],"example":"90006"}},"components/schemas/city":{"id":"components/schemas/city","kind":"json-schema","title":"city","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"城市名称"},"children":[]}]}]}],"example":"Los Angeles"}},"components/schemas/state":{"id":"components/schemas/state","kind":"json-schema","title":"state","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"州或省代码"},"children":[]}]}]}],"example":"CA"}},"components/schemas/country":{"id":"components/schemas/country","kind":"json-schema","title":"country","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"国家的两位字母代码。此字段的值将是"},"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的两位代码"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"。"},"children":[]}]}]}],"example":"US"}},"components/schemas/ShipmentRequest":{"id":"components/schemas/ShipmentRequest","kind":"json-schema","title":"ShipmentRequest","data":{"type":"object","required":["from","to","shipments"],"properties":{"request_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"本次 API 请求的唯一标识。 用于请求追踪、问题排查与故障定位。 最大长度为 64 个字符。"},"children":[]}]}]}],"example":"req_20251024_abcd1234ef567890"},"carrier":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"承运商账户信息"},"children":[]}]}]}],"properties":{"carrier_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"承运商账户 Token。 请参考 ShipSaving 系统：Carrier Accounts → Token。"},"children":[]}]}]}],"example":"ca_36f49ebbe91d4006a6583e17ceeec500"}}},"from":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发件人地址"},"children":[]}]}]}],"required":["name","street","city","state","zip","country"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发件人姓名"},"children":[]}]}]}],"example":"full name"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发件人公司名称"},"children":[]}]}]}],"example":"company name"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发件人电子邮箱"},"children":[]}]}]}],"example":"xxx@gmail.com"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发件人联系电话。 国际运单为必填项。"},"children":[]}]}]}],"example":1237771234},"street":{"type":"string","example":"xxx Grand Ave"},"street2":{"$ref":"#/components/schemas/street2"},"city":{"type":"string","example":"Los Angeles"},"state":{"type":"string","example":"CA"},"zip":{"type":"string","example":90018},"country":{"$ref":"#/components/schemas/country"}}},"to":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人地址"},"children":[]}]}]}],"required":["name","street","city","state","zip","country"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人姓名"},"children":[]}]}]}],"example":"full name"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人公司名称"},"children":[]}]}]}],"example":"company name"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人电子邮箱"},"children":[]}]}]}],"example":"xxx@gmail.com"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人联系电话。 国际运单为必填项。"},"children":[]}]}]}],"example":1237771234},"street":{"type":"string","example":"xxx Grand Ave"},"street2":{"$ref":"#/components/schemas/street2"},"city":{"type":"string","example":"Los Angeles"},"state":{"type":"string","example":"CA"},"zip":{"type":"string","example":90018},"country":{"$ref":"#/components/schemas/country"},"residential":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"是否为住宅地址。 该字段可能会影响运费报价。"},"children":[]}]}]}],"example":true}}},"shipments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运单包裹列表"},"children":[]}]}]}],"items":{"type":"object","required":["length","width","height","weight"],"properties":{"length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"包裹长度（英寸）"},"children":[]}]}]}],"example":6},"width":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"包裹宽度（英寸）"},"children":[]}]}]}],"example":6},"height":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"包裹高度（英寸）"},"children":[]}]}]}],"example":6},"weight":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"包裹重量（磅）"},"children":[]}]}]}],"example":1},"packages":{"type":"array","items":{"type":"string","example":"usps_small_flat_rate_box"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"使用承运商预定义的包装类型。 支持的取值请参考 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/zh-hans/v1/appendix"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"预定义承运商包裹表格"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"。"},"children":[]}]}]}]},"insurance_amount":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运单的保险申报金额。 需与 insurance_provider 字段配合使用。"},"children":[]}]}]}],"example":120},"custom_print1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运单面单上的第一行自定义打印内容。 若承运商支持自定义打印，该内容将显示在面单上。"},"children":[]}]}]}],"example":"custom print1"},"custom_print2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运单面单上的第二行自定义打印内容。 若承运商支持自定义打印，该内容将显示在面单上。"},"children":[]}]}]}],"example":"custom print2"},"contents":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"用于海关申报的商品明细列表（国际运单必填）。"},"children":[]}]}]}],"items":{"type":"object","required":["weight","description","quantity","value","origin_country"],"properties":{"weight":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"商品重量（磅）"},"children":[]}]}]}],"example":1},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"商品描述。 请提供准确、清晰的信息以便海关清关。"},"children":[]}]}]}],"example":"T-shirt"},"quantity":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"该商品的数量"},"children":[]}]}]}],"example":2},"value":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"商品申报价值（美元）"},"children":[]}]}]}],"example":29.99},"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":"商品的 HS 关税编码"},"children":[]}]}]}],"example":"610910"},"origin_country":{"$ref":"#/components/schemas/country"}}}}}}},"order":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"订单信息"},"children":[]}]}]}],"required":["warehouse_name"],"properties":{"warehouse_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order参数，Warehouse名称，必须为系统Warehouses里面已经存在的一个Warehouse名称。（请参考您的ShipSaving账户里仓库 -> 我的仓库里名称一栏）"},"children":[]}]}]}],"example":"WH"},"store_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order参数，Store名称，必须为系统Stores里面已经存在的一个Store名称。（请登录您ShipSaving账户，在店铺 -> 我的店铺 里查看名称一栏。如果您使用订单号，则该订单的店铺名称是必需的）"},"children":[]}]}]}]},"order_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order参数，订单号码，不提供时由系统自动分配订单号，必须预先存在于ShipSaving系统中。如果您需要为已经存在于我们系统中的订单查询包裹价格或购买面单，则需要此字段。"},"children":[]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"与 order_number 配合使用，用于在购买面单后更新订单状态。 若未指定，默认值为 awaiting。"},"children":[]}]}]}],"enum":["awaiting","hold","shipped"]},"service_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"支持的取值请参考 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/zh-hans/v1/appendix"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"承运商服务类型表格"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"。"},"children":[]}]}]}],"example":"usps_ground_advantage"},"signature":{"type":"string","enum":["NO_SIGNATURE","SIGNATURE","ADULT_SIGNATURE"]},"insurance_provider":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"与 insurance_amount 字段配合使用，用于指定保险服务提供方。"},"children":[]}]}]}],"enum":["SHIPSURANCE","CARRIER"]},"contents_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"申报的包裹内容类型。"},"children":[]}]}]}],"enum":["GIFT","MERCHANDISE","SAMPLE","RETURNED_GOODS","DOCUMENTS"]},"non_delivery_option":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"定义包裹无法投递时的处理方式。"},"children":[]}]}]}],"enum":["RETURN","ABANDON"]},"eel_pfc_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"指定该运单的电子出口信息（EEI）申报方式。"},"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":"若在 AES 申报后获得了内部交易编号，请使用 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ITN"},"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":"若该运单符合 EEI 申报豁免条件，请使用 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXEMPTION_CODE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"。"},"children":[]}]}]}]}],"enum":["ITN","EXEMPTION_CODE"]},"eel_pfc_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"该运单的 EEI 申报标识。"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"可填写从 AES 获取的内部交易编号（ITN），"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"或在无需进行 EEI 申报时填写对应的豁免代码。"},"children":[]}]}]}],"example":"X20250627012345"},"tax_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人的税务识别信息。"},"children":[]}]}]}],"items":{"type":"object","properties":{"tax_id_type":{"type":"string","enum":["TIN","EIN","SSN","VAT","EORI","IOSS","PAN","VOEC"]},"tax_id_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"与税号类型对应的税号值"},"children":[]}]}]}]},"tax_id_country":{"$ref":"#/components/schemas/country"}}}}}},"options":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"额外的运送选项"},"children":[]}]}]}],"properties":{"ship_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 格式的时间戳，包含本地时间及对应的时区偏移。"},"children":[]}]}]}],"example":"2024-02-07T10:55:56-08:00"},"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":"是否需要周六派送"},"children":[]}]}]}],"example":false},"require_hazmat":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"是否包含危险品或受限物品 （仅适用于 USPS Ground Advantage 服务）。 有关危险品的包装、标签及寄送规范， 请参考 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.uspsdelivers.com/hazmat-shipping-safety/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"官方教程"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"。"},"children":[]}]}]}],"example":false},"hazmat_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"指定危险品类型。 USPS 运单使用 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usps_hazmat_820"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"（Class 9 未标记包装的锂电池），DHL eCommerce 运单使用 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dhlecs_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 系列值。 寄往或寄自美国外岛地区（如关岛、波多黎各）的运单，通常需要使用 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usps_hazmat_820"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"，才能寄递锂电池。 该参数需与 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"options.require_hazmat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 一同使用方可生效。"},"children":[]}]}]}],"enum":["usps_hazmat_820","dhlecs_lithium_metal_alloy_contained","dhlecs_lithium_metal_alloy_packed","dhlecs_lithium_metal_alloy_standalone","dhlecs_lithium_ion_contained","dhlecs_lithium_ion_packed","dhlecs_lithium_ion_standalone","dhlecs_limited_quantity","dhlecs_small_quantity_provision","dhlecs_limited_quantities_plt"]},"label_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"面单文件格式，若未指定，默认使用 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"。"},"children":[]}]}]}],"enum":["png","pdf"],"example":"png"},"require_qr_code":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"指示是否生成无纸化运单（如二维码或条形码）。   设置为 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 时，将请求生成无纸化面单。目前仅支持 USPS (QR code)、UPS (barcode) 及 FedEx (QR code)。   风险提示： 若承运商服务不支持此功能，会导致下单失败。"},"children":[]}]}]}],"example":false}}},"recipient_tax_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人的税务信息"},"children":[]}]}]}],"items":{"type":"object","properties":{"tax_id_type":{"type":"string","enum":["TIN","EIN","SSN","VAT","EORI","IOSS","PAN","VOEC"]},"tax_id_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人的税号值"},"children":[]}]}]}]}}}}}}},"components/schemas/RatingResponse":{"id":"components/schemas/RatingResponse","kind":"json-schema","title":"RatingResponse","data":{"type":"object","properties":{"rates":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运费报价列表"},"children":[]}]}]}],"items":{"type":"object","properties":{"shipment_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运单编号"},"children":[]}]}]}],"type":"string","example":"ship_bea6cc8c-27f8-4dcf-915e-f6aeed8c5600"},"rate_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"报价编号"},"children":[]}]}]}],"type":"string","example":"rate_e50d02e2-047a-402c-aa32-22ad0926db00"},"provider":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier账号类型，shipsaving or user"},"children":[]}]}]}],"example":"shipsaving"},"account_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"承运商账户名称"},"children":[]}]}]}],"example":"USPS"},"carrier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"承运商名称（USPS、UPS、FEDEX 或 DHL）"},"children":[]}]}]}],"example":"USPS"},"service":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"承运商服务名称"},"children":[]}]}]}],"example":"USPS_GROUND_ADVANTAGE"},"service_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"承运商服务类型标识"},"children":[]}]}]}],"example":"usps_ground_advantage"},"package":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"包裹类型"},"children":[]}]}]}],"example":"PACKAGE"},"package_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"自定义包裹类型"},"children":[]}]}]}],"example":"my_package"},"delivery_days":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"预计送达所需天数"},"children":[]}]}]}],"example":5},"published_rate":{"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":"折扣前的官方公布运费"},"children":[]}]}]}],"example":10.9},"rate":{"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":"折扣后的实际运费"},"children":[]}]}]}],"example":8.99},"rebate":{"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":"运费返利金额"},"children":[]}]}]}],"example":0.21}}}}}}},"components/schemas/CreateOrderRequest":{"id":"components/schemas/CreateOrderRequest","kind":"json-schema","title":"CreateOrderRequest","data":{"type":"object","required":["store_name","warehouse_name","verify_address","client_name","client_street","client_city","client_state","client_zip","client_country","shipments"],"properties":{"store_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order参数，Store名称，必须为系统Stores里面已经存在的一个Store名称。（请登录您ShipSaving账户，在店铺 -> 我的店铺 里查看名称一栏。如果您使用订单号，则该订单的店铺名称是必需的）"},"children":[]}]}]}],"example":"CS"},"order_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"订单编号，如未提供，将由系统自动生成。"},"children":[]}]}]}],"example":"202402071641"},"warehouse_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order参数，Warehouse名称，必须为系统Warehouses里面已经存在的一个Warehouse名称。（请参考您的ShipSaving账户里仓库 -> 我的仓库里名称一栏）"},"children":[]}]}]}],"example":"WH"},"verify_address":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"客户地址是否需要通过ShipSaving进行验证。地址验证结果将在创建订单后3至5分钟内显示在订单旁边。"},"children":[]}]}]}],"example":true},"client_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人姓名（全名）。"},"children":[]}]}]}],"example":"full name"},"client_company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人公司名称（如适用）。"},"children":[]}]}]}],"example":"company name"},"client_email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人电子邮箱地址。"},"children":[]}]}]}],"example":""},"client_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人联系电话。国际运单为必填项。"},"children":[]}]}]}],"example":"1234567890"},"client_street":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人地址（第一行）。"},"children":[]}]}]}],"example":"123 street name"},"client_street2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"地址街道2应包含次要地址单位指示符，如公寓、套房、房间或楼层号。地址街道2用于需要精确客户信息的额外信息，以确保邮件或包裹被送达到正确的地址。在许多情况下，如果没有街道2，则街道2可以留空。"},"children":[]}]}]}],"example":"apt 123"},"client_city":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人所在城市。"},"children":[]}]}]}],"example":"city"},"client_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人所在州或省。"},"children":[]}]}]}],"example":"state"},"client_zip":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人邮政编码。"},"children":[]}]}]}],"example":"zipcode"},"client_country":{"$ref":"#/components/schemas/country","example":"US"},"shipments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"订单中包含的包裹列表。"},"children":[]}]}]}],"items":{"type":"object","properties":{"length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"包裹长度（英寸）。"},"children":[]}]}]}],"example":6},"width":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"包裹宽度（英寸）。"},"children":[]}]}]}],"example":6},"height":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"包裹高度（英寸）。"},"children":[]}]}]}],"example":3},"weight":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"包裹重量（磅）。"},"children":[]}]}]}],"example":0.4},"signature":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"派送签收要求。"},"children":[]}]}]}],"enum":["NO_SIGNATURE","SIGNATURE","ADULT_SIGNATURE"],"example":"NO_SIGNATURE"},"insurance_provider":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运单使用的保险服务提供方。"},"children":[]}]}]}],"enum":["SHIPSURANCE","CARRIER"],"example":"SHIPSURANCE"},"insurance_amount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"保险申报金额（美元）。"},"children":[]}]}]}],"example":200},"custom_print1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运单面单上的第一行自定义打印内容。 若承运商支持自定义打印，该内容将显示在面单上。"},"children":[]}]}]}],"example":"custom print1"},"custom_print2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运单面单上的第一行自定义打印内容。 若承运商支持自定义打印，该内容将显示在面单上。"},"children":[]}]}]}],"example":"custom print2"},"items":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"包裹内包含的商品明细列表。"},"children":[]}]}]}],"items":{"type":"object","required":["sku","quantity","price"],"properties":{"sku":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"商品库存单位（SKU）。"},"children":[]}]}]}],"example":"2PCSFLCX-BLACK_PINK-S"},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"商品描述标题。"},"children":[]}]}]}],"example":"2 t-shirts"},"quantity":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"商品数量。"},"children":[]}]}]}],"example":1},"price":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"商品单价。"},"children":[]}]}]}],"example":20},"tax":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"单件商品的销售税金额。"},"children":[]}]}]}],"example":1.2},"shipping_cost":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"单件商品运费"},"children":[]}]}]}],"example":10}}}},"notes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"与该包裹相关的可选备注或说明。"},"children":[]}]}]}],"items":{"type":"string"},"example":["note 1","note 2"]}}}}}}},"components/schemas/PurchaseLabelResponse":{"id":"components/schemas/PurchaseLabelResponse","kind":"json-schema","title":"PurchaseLabelResponse","data":{"type":"object","properties":{"packing_slip_number":{"type":"integer","example":109169},"master_tracking_code":{"type":"string","example":""},"prefix_tracking_code":{"type":"string","example":""},"tracking_code":{"type":"string","example":"1ZY50G652000880500"},"label_size":{"type":"string","example":"4x6"},"label_type":{"type":"string","example":"label"},"length":{"type":"number","example":12},"width":{"type":"number","example":12},"height":{"type":"number","example":7},"weight":{"type":"number","example":14.99},"insurance":{"type":"number","example":0},"insurance_fee":{"type":"number","example":0},"signature":{"type":"string","example":"NO_SIGNATURE"},"custom_print1":{"type":"string","example":""},"custom_print2":{"type":"string","example":""},"delivery_days":{"type":"string","example":"1"},"service_fee":{"type":"number","example":0.05},"rate":{"type":"number","example":10.87},"rebate":{"type":"number","example":0},"from_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发件人姓名"},"children":[]}]}]}],"example":"sender name"},"from_company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发件人公司名称"},"children":[]}]}]}],"example":"ShipSaving, LLC"},"from_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发件人联系电话"},"children":[]}]}]}],"example":""},"from_street":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发件人地址（第一行）"},"children":[]}]}]}],"example":"769 Broadview Avenue"},"from_street2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"地址街道2应包含次要地址单位指示符，如公寓、套房、房间或楼层号。地址街道2用于需要精确客户信息的额外信息，以确保邮件或包裹被送达到正确的地址。在许多情况下，如果没有街道2，则街道2可以留空。"},"children":[]}]}]}],"example":""},"from_city":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发件人城市"},"children":[]}]}]}],"example":"Toronto"},"from_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发件人州 / 省"},"children":[]}]}]}],"example":"ON"},"from_zip":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发件人邮政编码"},"children":[]}]}]}],"example":"M4K 2P7"},"from_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"发件人国家代码"},"children":[]}]}]}],"example":"CA"},"to_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人姓名"},"children":[]}]}]}],"example":"ShipSaving"},"to_company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人公司名称"},"children":[]}]}]}],"example":"UPS Plus"},"to_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人联系电话"},"children":[]}]}]}],"example":""},"to_street":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人地址（第一行）"},"children":[]}]}]}],"example":"961 Broadview Avenue"},"to_street2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"地址街道2应包含次要地址单位指示符，如公寓、套房、房间或楼层号。地址街道2用于需要精确客户信息的额外信息，以确保邮件或包裹被送达到正确的地址。在许多情况下，如果没有街道2，则街道2可以留空。"},"children":[]}]}]}],"example":""},"to_city":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人城市"},"children":[]}]}]}],"example":"Toronto"},"to_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人州 / 省"},"children":[]}]}]}],"example":"ON"},"to_zip":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人邮政编码"},"children":[]}]}]}],"example":"M4K 2P7"},"to_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"收件人国家代码"},"children":[]}]}]}],"example":"CA"},"label_status":{"type":"string","example":"completed"},"shipment_id":{"type":"integer","example":1245627},"warehouse_name":{"type":"string","example":"WH"},"store_name":{"type":"string","example":""},"order_number":{"type":"string","example":""},"provider":{"type":"string","example":"shipsaving"},"carrier":{"type":"string","example":"UPS"},"service":{"type":"string","example":"UPS_GROUND"},"package":{"type":"string","example":"PACKAGE"},"published_rate":{"type":"number","example":34.53},"label_url":{"type":"array","items":{"type":"string"},"example":["https://...../labels/2025-06-30/0231b055b64044e6b7e027874e915361_0.pdf"]},"commercial_invoice_url":{"type":"string","nullable":true,"example":null}}}},"schema_168":{"kind":"json-schema","data":{"type":"string"},"id":"schema_168"},"schema_169":{"kind":"json-schema","data":{"type":"object","required":["tracking_code"],"properties":{"tracking_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"物流单号"},"children":[]}]}]}]}}},"id":"schema_169"},"schema_170":{"kind":"json-schema","data":{"type":"object","properties":{"tracking_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"所取消的物流单号"},"children":[]}]}]}]}}},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"type":"object","properties":{"order_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"订单号"},"children":[]}]}]}]}}},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"packing_slip_number":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"装箱单号"},"children":[]}]}]}],"example":100108},"carrier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"承运商名称"},"children":[]}]}]}],"example":"UPS"},"predefined_package":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"承运商预定义包装类型"},"children":[]}]}]}],"example":""},"service_level":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"承运商服务类型"},"children":[]}]}]}],"example":"ups_ground"},"tracking_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运单追踪号"},"children":[]}]}]}],"example":"1ZXXXXXXXXXXXXXXXX"},"length":{"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":"包裹长度（英寸）"},"children":[]}]}]}],"example":6},"width":{"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":"包裹宽度（英寸）"},"children":[]}]}]}],"example":6},"height":{"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":"包裹高度（英寸）"},"children":[]}]}]}],"example":6},"weight":{"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":"包裹重量（磅）"},"children":[]}]}]}],"example":1},"rate":{"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":"运费金额"},"children":[]}]}]}],"example":5.99},"service_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":"系统服务费"},"children":[]}]}]}],"example":0.05},"label_width":{"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":"面单宽度（英寸）"},"children":[]}]}]}],"example":4},"label_height":{"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":"面单高度（英寸）"},"children":[]}]}]}],"example":6},"label_urls":{"type":"array","items":{"type":"string","example":"https://…/labels/2024-10-23/9524d5ac21a744a1954e16ebda769772_0.png"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运单面单图片 URL 列表"},"children":[]}]}]}]},"commercial_invoice_urls":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"报关单图片URL地址列表，报关单尺寸为美国Letter"},"children":[]}]}]}],"example":null}}}},"id":"schema_172"},"schema_173":{"kind":"json-schema","data":{"type":"object","required":["store_name","order_number"],"properties":{"store_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"订单所属的店铺名称"},"children":[]}]}]}],"example":"xxx 3C Store"},"order_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"订单编号"},"children":[]}]}]}],"example":"20240201125047532"}}},"id":"schema_173"},"schema_174":{"kind":"json-schema","data":{"type":"array","items":{}},"id":"schema_174"},"schema_175":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"错误信息"},"children":[]}]}]}]}}},"id":"schema_175"},"schema_176":{"kind":"json-schema","data":{"type":"object","required":["street","city","zip","country","state"],"properties":{"street":{"$ref":"#/components/schemas/street"},"street2":{"$ref":"#/components/schemas/street2"},"city":{"$ref":"#/components/schemas/city"},"state":{"$ref":"#/components/schemas/state"},"zip":{"$ref":"#/components/schemas/zipcode"},"country":{"$ref":"#/components/schemas/country"}}},"id":"schema_176"},"schema_177":{"kind":"json-schema","data":{"type":"object","properties":{"street":{"$ref":"#/components/schemas/street"},"street2":{"$ref":"#/components/schemas/street2"},"city":{"$ref":"#/components/schemas/city"},"state":{"$ref":"#/components/schemas/state"},"zip":{"$ref":"#/components/schemas/zipcode"},"country":{"$ref":"#/components/schemas/country"},"residential":{"type":"boolean","example":true},"errored":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"是否存在地址错误"},"children":[]}]}]}]},"corrected":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"地址是否被修正"},"children":[]}]}]}]},"standardized":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"地址是否已标准化"},"children":[]}]}]}]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"ADDRESS.PRIMARY.INVALID"},"message":{"type":"string","example":"主门牌号无效。"}}}},"corrections":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"ADDRESS.COMPONENT.CHANGED"},"message":{"type":"string","example":"地址组件（如方向或后缀）已被更改"}}}}}},"id":"schema_177"},"schema_178":{"kind":"json-schema","data":{"type":"object","properties":{"tracking_codes":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"运单追踪号列表"},"children":[]}]}]}]}},"required":["tracking_codes"]},"id":"schema_178"},"schema_179":{"kind":"json-schema","data":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scan Form文件路径（PDF）"},"children":[]}]}]}]}}},"id":"schema_179"},"schema_180":{"kind":"json-schema","data":{"type":"object","properties":{"request":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"创建SCAN Form的请求ID"},"children":[]}]}]}]}}},"id":"schema_180"},"schema_181":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_181"},"schema_182":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"承运商账户名称"},"children":[]}]}]}],"example":"USPS-B"},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"承运商账户的唯一标识 Token"},"children":[]}]}]}],"example":"ca_bc28f2e7_aaaa_4bbb_accc_bf7d9f2c27xx"},"carrier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"承运商类型（如 USPS、UPS、FedEx、DHL Express 等）"},"children":[]}]}]}],"example":"USPS"}}}},"id":"schema_182"},"schema_183":{"kind":"json-schema","data":{"type":"object","properties":{"balance":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"账户余额"},"children":[]}]}]}],"example":"173.13"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"货币类型，仅支持 USD"},"children":[]}]}]}],"example":"usd"}}},"id":"schema_183"}},"exampleStore":{"paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example":{"value":{"tracking_code":"9435811899562089111300"},"id":"paths/~1api~1shipments~1void/post/requestBody/content/application~1json/example"},"paths/~1api~1shipments~1void/post/responses/200/content/application~1json/example":{"value":{"tracking_code":"9435811899562089111300"},"id":"paths/~1api~1shipments~1void/post/responses/200/content/application~1json/example"},"paths/~1api~1orders~1delete/delete/responses/200/content/application~1json/example":{"value":[],"id":"paths/~1api~1orders~1delete/delete/responses/200/content/application~1json/example"},"paths/~1api~1orders~1delete/delete/responses/400/content/application~1json/example":{"value":{"message":"订单号或店铺名称无效"},"id":"paths/~1api~1orders~1delete/delete/responses/400/content/application~1json/example"},"paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example":{"value":{"tracking_codes":["9434611899562089592093","9434611899562089592048"]},"id":"paths/~1api~1shipments~1scan-forms~1create/post/requestBody/content/application~1json/example"},"paths/~1api~1shipments~1scan-forms~1create/post/responses/200/content/application~1json/example":{"value":{"url":"https://...../forms/2024-11-01/12345667.pdf"},"id":"paths/~1api~1shipments~1scan-forms~1create/post/responses/200/content/application~1json/example"},"paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example":{"value":{"tracking_codes":["40EB09B82E1146DE9166C499A0B4EA","40EB09B82E1146DE9166C499A0B4DD"]},"id":"paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/requestBody/content/application~1json/example"},"paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses/200/content/application~1json/examples/success-response":{"value":{"request":202},"key":"success-response","summary":"success-response","id":"paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1create/post/responses/200/content/application~1json/examples/success-response"},"paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses/200/content/application~1json/example":{"value":{"url":"https://...../forms/2024-11-01/12345667.pdf"},"id":"paths/~1api~1shipments~1scan-forms~1dhl~1ecommerce~1get/get/responses/200/content/application~1json/example"}},"securitySchemeStore":{"ApiTokenAuth":{"id":"ApiTokenAuth","type":"apiKey","in":"query","paramName":"api_token"}},"servers":[{"url":"https://api.shipsaving.com"}]},"options":{"hideDownloadButtons":true,"hideReplay":true,"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/@l10n/zh-Hans/v1/openapi.json?download"},{"url":"/_bundle/@l10n/zh-Hans/v1/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"ShipSaving Legacy API","description":""}},"baseSlug":"/zh-hans/v1/openapi","routesMapping":{}}