{"items":[{"type":"link","label":"ShipSaving New API","link":"/es/v2/openapi","routeSlug":"/es/v2/openapi","content":{"contentType":"overview","meta":{"name":"ShipSaving New API"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://x-api.shipsaving.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"ShipSaving New API (v2)","showPageActions":true}],"sectionId":"/es/v2/openapi"}]}]}},{"type":"group","label":"Authentication","link":"/es/v2/openapi/authentication","routeSlug":"/es/v2/openapi/authentication","items":[{"label":"Obtener token de acceso","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/authentication/getaccesstoken","routeSlug":"/es/v2/openapi/authentication/getaccesstoken","metadata":{"seo":{"title":"Obtener token de acceso","description":"Emite un token de acceso de corta duración mediante el flujo OAuth 2.1 Client Credentials."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccessToken","name":"Obtener token de acceso","isWebhook":false,"pointer":"/paths/~1oauth2~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Obtener token de acceso","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":"Emite un token de acceso de corta duración mediante el flujo OAuth 2.1 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client Credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proporciona:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Basic base64(AppKey:AppSecret)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type: application/x-www-form-urlencoded"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación básica usando AppKey/AppSecret."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_156","exampleIds":["paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample"]}},"schemaId":"schema_156","exampleIds":["paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample"],"pointer":"/paths/~1oauth2~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/oauth2/token","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_156","exampleIds":["paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample"]}},"responseCodes":["200","400","401"],"pointer":"/oauth2/token","href":"authentication/getaccesstoken","openApiOperationId":"getAccessToken","summary":"Obtener token de acceso"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com"}],"schemaId":"schema_156","exampleIds":["paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample"],"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_156","exampleIds":["paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Token de acceso emitido","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenResponse","exampleIds":["paths/~1oauth2~1token/post/responses/200/content/application~1json/examples/success"]}},"schemaId":"components/schemas/TokenResponse","exampleIds":["paths/~1oauth2~1token/post/responses/200/content/application~1json/examples/success"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solicitud inválida"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthError","exampleIds":["paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badContentType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badGrantType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/invalidScope"]}},"schemaId":"components/schemas/OAuthError","exampleIds":["paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badContentType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badGrantType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/invalidScope"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credenciales de cliente inválidas o uso de un token expirado/inválido"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthError"}},"schemaId":"components/schemas/OAuthError"}],"pointer":"/paths/~1oauth2~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TokenResponse","exampleIds":["paths/~1oauth2~1token/post/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenResponse","exampleIds":["paths/~1oauth2~1token/post/responses/200/content/application~1json/examples/success"]}}},{"code":"400","schemaId":"components/schemas/OAuthError","exampleIds":["paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badContentType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badGrantType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/invalidScope"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthError","exampleIds":["paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badContentType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badGrantType","paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/invalidScope"]}}},{"code":"401","schemaId":"components/schemas/OAuthError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OAuthError"}}}],"examples":[]}]}]}]},"httpPath":"/oauth2/token"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/oauth2/token","summary":"Obtener token de acceso","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/getaccesstoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Shipment","link":"/es/v2/openapi/shipment","routeSlug":"/es/v2/openapi/shipment","items":[{"label":"Tarifa rápida por lotes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/shipment/batchquickrate","routeSlug":"/es/v2/openapi/shipment/batchquickrate","metadata":{"seo":{"title":"Tarifa rápida por lotes","description":"Este endpoint te permite obtener rápidamente cotizaciones de tarifas de envío proporcionando from_address_data, to_address_data, package_data y la ship_date.Cada llamada a la API puede incluir hasta 10 solicitudes de tarifa individuales."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchQuickRate","name":"Tarifa rápida por lotes","isWebhook":false,"pointer":"/paths/~1api~1shipment~1batch~1quick_rate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tarifa rápida por lotes","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":"Este endpoint te permite obtener rápidamente cotizaciones de tarifas de envío proporcionando "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from_address_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to_address_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"package_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" y la "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ship_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cada llamada a la API puede incluir hasta 10 solicitudes de tarifa individuales."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Anteriormente, este endpoint solo devolvía tarifas para USPS Ground Advantage."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Con la nueva actualización, puedes especificar opcionalmente transportistas y niveles de servicio adicionales mediante el campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipment_rate_carrier_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". En el esquema de la solicitud encontrarás una explicación detallada sobre cómo utilizar este parámetro."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Si se omite "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipment_rate_carrier_data"},"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":"El sistema devolverá tarifas solo para USPS Ground Advantage (comportamiento predeterminado)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Si se proporciona "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipment_rate_carrier_data"},"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":"El sistema devolverá tarifas únicamente para los proveedores y niveles de servicio especificados."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pueden enviarse varias combinaciones en una sola solicitud."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchQuickRateRequest"}},"schemaId":"components/schemas/BatchQuickRateRequest","pointer":"/paths/~1api~1shipment~1batch~1quick_rate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/batch/quick_rate","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchQuickRateRequest"}},"responseCodes":["200"],"pointer":"/api/shipment/batch/quick_rate","href":"shipment/batchquickrate","openApiOperationId":"batchQuickRate","summary":"Tarifa rápida por lotes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com"}],"schemaId":"components/schemas/BatchQuickRateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchQuickRateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchQuickRateResponse"}},"schemaId":"components/schemas/BatchQuickRateResponse"}],"pointer":"/paths/~1api~1shipment~1batch~1quick_rate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchQuickRateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchQuickRateResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/batch/quick_rate"},{"label":"Obtener tarifas","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/shipment/getrates","routeSlug":"/es/v2/openapi/shipment/getrates","metadata":{"seo":{"title":"Obtener tarifas","description":"Recupera las tarifas de envío de todos los transportistas y niveles de servicio activos en tu cuenta, opcionalmente filtradas por transportistas y niveles de servicio específicos, y devuelve los resultados ordenados por el más rápido, el más económico y otros criterios, junto con la información de errores aplicable."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRates","name":"Obtener tarifas","isWebhook":false,"pointer":"/paths/~1api~1shipment~1get_rates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Obtener tarifas","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":"Recupera las tarifas de envío de todos los transportistas y niveles de servicio activos en tu cuenta, opcionalmente filtradas por transportistas y niveles de servicio específicos, y devuelve los resultados ordenados por el más rápido, el más económico y otros criterios, junto con la información de errores aplicable."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentRateRequest"}},"schemaId":"components/schemas/ShipmentRateRequest","pointer":"/paths/~1api~1shipment~1get_rates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/get_rates","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShipmentRateRequest"}},"responseCodes":["200"],"pointer":"/api/shipment/get_rates","href":"shipment/getrates","openApiOperationId":"getRates","summary":"Obtener tarifas"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com"}],"schemaId":"components/schemas/ShipmentRateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentRateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRatesResponse"}},"schemaId":"components/schemas/GetRatesResponse"}],"pointer":"/paths/~1api~1shipment~1get_rates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetRatesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRatesResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/get_rates"},{"label":"Comprar etiqueta","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/shipment/createandpay","routeSlug":"/es/v2/openapi/shipment/createandpay","metadata":{"seo":{"title":"Comprar etiqueta","description":"Crea y paga una etiqueta de envío utilizando el rate_id obtenido en una llamada previa a get_rates.Este endpoint también permite contratar un seguro de envío en la misma solicitud (el seguro no puede comprarse por separado). "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAndPay","name":"Comprar etiqueta","isWebhook":false,"pointer":"/paths/~1api~1shipment~1create_and_pay/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Comprar etiqueta","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":"Crea y paga una etiqueta de envío utilizando el "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" obtenido en una llamada previa a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"get_rates"},"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":"Este endpoint también permite contratar un seguro de envío en la misma solicitud (el seguro no puede comprarse por separado). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para evitar compras duplicadas causadas por fluctuaciones de red o reintentos, la API verifica si ya existe un envío bajo el "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform_uk_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" especificado."},"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":"Si se encuentra un envío relacionado, se devolverá la información del envío existente y el campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duplicate_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" en la respuesta se establecerá en "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Si no existe ningún envío, se creará un nuevo envío de forma normal y el campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duplicate_label"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"será "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BuyLabelRequest"}},"schemaId":"components/schemas/BuyLabelRequest","pointer":"/paths/~1api~1shipment~1create_and_pay/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/create_and_pay","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BuyLabelRequest"}},"responseCodes":["200"],"pointer":"/api/shipment/create_and_pay","href":"shipment/createandpay","openApiOperationId":"createAndPay","summary":"Comprar etiqueta"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com"}],"schemaId":"components/schemas/BuyLabelRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BuyLabelRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentPurchaseResponse"}},"schemaId":"components/schemas/ShipmentPurchaseResponse"}],"pointer":"/paths/~1api~1shipment~1create_and_pay/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShipmentPurchaseResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentPurchaseResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/create_and_pay"},{"label":"Compra directa de etiqueta","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/shipment/directbuy","routeSlug":"/es/v2/openapi/shipment/directbuy","metadata":{"seo":{"title":"Compra directa de etiqueta","description":"Crea y compra una etiqueta de envío en un solo paso sin necesidad de llamar a get_rates por separado. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"directBuy","name":"Compra directa de etiqueta","isWebhook":false,"pointer":"/paths/~1api~1shipment~1direct_buy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Compra directa de etiqueta","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":"Crea y compra una etiqueta de envío en un solo paso sin necesidad de llamar a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"get_rates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" por separado. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actualmente, este endpoint admite los niveles de servicio de USPS Returns. Consulta el Apéndice para ver la lista completa de valores soportados."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para evitar compras duplicadas causadas por fluctuaciones de red o reintentos, la API verifica si ya existe un envío bajo el "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform_uk_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" especificado."},"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":"Si se encuentra un envío relacionado, se devolverá la información del envío existente y el campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duplicate_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" en la respuesta se establecerá en "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Si no existe ningún envío, se creará un nuevo envío de forma normal y el campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duplicate_label"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"será "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectBuyShipmentRequest"}},"schemaId":"components/schemas/DirectBuyShipmentRequest","pointer":"/paths/~1api~1shipment~1direct_buy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/direct_buy","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DirectBuyShipmentRequest"}},"responseCodes":["200"],"pointer":"/api/shipment/direct_buy","href":"shipment/directbuy","openApiOperationId":"directBuy","summary":"Compra directa de etiqueta"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com"}],"schemaId":"components/schemas/DirectBuyShipmentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectBuyShipmentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentPurchaseResponse"}},"schemaId":"components/schemas/ShipmentPurchaseResponse"}],"pointer":"/paths/~1api~1shipment~1direct_buy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShipmentPurchaseResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentPurchaseResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/direct_buy"},{"label":"Anular etiqueta","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/shipment/voidlabel","routeSlug":"/es/v2/openapi/shipment/voidlabel","metadata":{"seo":{"title":"Anular etiqueta","description":"Este endpoint permite anular una etiqueta proporcionando ya seashipment_no o platform_uk_id. Solo se requiere uno de los parámetros para identificarde forma única un envío."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"voidLabel","name":"Anular etiqueta","isWebhook":false,"pointer":"/paths/~1api~1shipment~1void_label/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Anular etiqueta","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":"Este endpoint permite anular una etiqueta proporcionando "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ya sea"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipment_no"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" o "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform_uk_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Solo se requiere uno de los parámetros para identificar"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de forma única un envío."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentVoidRequest"}},"schemaId":"components/schemas/ShipmentVoidRequest","pointer":"/paths/~1api~1shipment~1void_label/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/void_label","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShipmentVoidRequest"}},"responseCodes":["200"],"pointer":"/api/shipment/void_label","href":"shipment/voidlabel","openApiOperationId":"voidLabel","summary":"Anular etiqueta"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com"}],"schemaId":"components/schemas/ShipmentVoidRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShipmentVoidRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonServiceResponse"}},"schemaId":"components/schemas/CommonServiceResponse"}],"pointer":"/paths/~1api~1shipment~1void_label/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonServiceResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonServiceResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/void_label"},{"label":"Consultar tarifa de seguro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/shipment/paths/~1api~1shipment~1insurance~1rate/get","routeSlug":"/es/v2/openapi/shipment/paths/~1api~1shipment~1insurance~1rate/get","metadata":{"seo":{"title":"Consultar tarifa de seguro","description":"Consultar tarifa de seguro"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Consultar tarifa de seguro","isWebhook":false,"pointer":"/paths/~1api~1shipment~1insurance~1rate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consultar tarifa de seguro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"declared_value","in":"query","schemaId":"schema_157","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor declarado para el seguro de envío, que representa el monto asegurado en USD."},"children":[]}]}]}],"required":true,"example":200},{"name":"service_level","in":"query","schemaId":"schema_158","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"La solicitud de cotización de seguro debe especificar un service_level. El precio varía según el nivel de servicio seleccionado."},"children":[]}]}]}],"required":true,"example":"USPS_GROUND_ADVANTAGE"}],"pointer":"/paths/~1api~1shipment~1insurance~1rate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipment/insurance/rate","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[{"name":"declared_value","in":"query","required":true,"example":200,"schemaId":"schema_157"},{"name":"service_level","in":"query","required":true,"example":"USPS_GROUND_ADVANTAGE","schemaId":"schema_158"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipment/insurance/rate","href":"shipment/paths/~1api~1shipment~1insurance~1rate/get","summary":"Consultar tarifa de seguro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InsuranceRateResponse"}},"schemaId":"components/schemas/InsuranceRateResponse"}],"pointer":"/paths/~1api~1shipment~1insurance~1rate/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InsuranceRateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InsuranceRateResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/insurance/rate"}],"content":{"contentType":"group","meta":{"name":"Shipment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipment","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/shipment/batch/quick_rate","summary":"Tarifa rápida por lotes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/batchquickrate","deprecated":false},{"title":"/api/shipment/get_rates","summary":"Obtener tarifas","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/getrates","deprecated":false},{"title":"/api/shipment/create_and_pay","summary":"Comprar etiqueta","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/createandpay","deprecated":false},{"title":"/api/shipment/direct_buy","summary":"Compra directa de etiqueta","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/directbuy","deprecated":false},{"title":"/api/shipment/void_label","summary":"Anular etiqueta","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipment/voidlabel","deprecated":false},{"title":"/api/shipment/insurance/rate","summary":"Consultar tarifa de seguro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipment/paths/~1api~1shipment~1insurance~1rate/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Tracking","link":"/es/v2/openapi/tracking","routeSlug":"/es/v2/openapi/tracking","items":[{"label":"Consultar estado de rastreo por número de rastreo (con offset UTC)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/tracking/getshipmenttrackingwithutcoffset","routeSlug":"/es/v2/openapi/tracking/getshipmenttrackingwithutcoffset","metadata":{"seo":{"title":"Consultar estado de rastreo por número de rastreo (con offset UTC)","description":"Recupera el evento de rastreo actual del envío, el primer evento de rastreo registrado yel historial completo de eventos de rastreo según lo reportado por el transportista."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShipmentTrackingWithUtcOffset","name":"Consultar estado de rastreo por número de rastreo (con offset UTC)","isWebhook":false,"pointer":"/paths/~1api~1shipment~1direct~1tracking_by_tracking_no/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consultar estado de rastreo por número de rastreo (con offset UTC)","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":"Recupera el evento de rastreo actual del envío, el primer evento de rastreo registrado y"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"el historial completo de eventos de rastreo según lo reportado por el transportista."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Este endpoint devuelve todas las marcas de tiempo de los eventos de rastreo en formato"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 incluyendo el offset UTC, lo que permite a los clientes interpretar con"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"precisión las horas locales de los eventos en distintas zonas horarias."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tracking_no","in":"query","schemaId":"schema_158","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"número de rastreo"},"children":[]}]}]}],"required":true,"example":"940013620842281000000"},{"name":"carrier_code","in":"query","schemaId":"schema_159","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"código del transportista"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1shipment~1direct~1tracking_by_tracking_no/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipment/direct/tracking_by_tracking_no","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[{"name":"tracking_no","in":"query","required":true,"example":"940013620842281000000","schemaId":"schema_158"},{"name":"carrier_code","in":"query","required":true,"example":"USPS","schemaId":"schema_159"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipment/direct/tracking_by_tracking_no","href":"tracking/getshipmenttrackingwithutcoffset","openApiOperationId":"getShipmentTrackingWithUtcOffset","summary":"Consultar estado de rastreo por número de rastreo (con offset UTC)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrackingStatusWithUtcOffsetResponse"}},"schemaId":"components/schemas/TrackingStatusWithUtcOffsetResponse"}],"pointer":"/paths/~1api~1shipment~1direct~1tracking_by_tracking_no/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrackingStatusWithUtcOffsetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrackingStatusWithUtcOffsetResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/direct/tracking_by_tracking_no"},{"label":"Enviar Prueba de Entrega (POD)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/tracking/submitpod","routeSlug":"/es/v2/openapi/tracking/submitpod","metadata":{"seo":{"title":"Enviar Prueba de Entrega (POD)","description":"Envía una solicitud de Prueba de Entrega para un envío ya entregado. Actualmente solo se admite USPS (carrier_code = USPS); otros transportistas se rechazan con un error de negocio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submitPod","name":"Enviar Prueba de Entrega (POD)","isWebhook":false,"pointer":"/paths/~1api~1shipment~1submit_pod/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enviar Prueba de Entrega (POD)","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":"Envía una solicitud de Prueba de Entrega para un envío ya entregado. Actualmente solo se admite USPS ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier_code = USPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); otros transportistas se rechazan con un error de negocio."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PodSubmitRequest"}},"schemaId":"components/schemas/PodSubmitRequest","pointer":"/paths/~1api~1shipment~1submit_pod/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/submit_pod","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PodSubmitRequest"}},"responseCodes":["200"],"pointer":"/api/shipment/submit_pod","href":"tracking/submitpod","openApiOperationId":"submitPod","summary":"Enviar Prueba de Entrega (POD)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com"}],"schemaId":"components/schemas/PodSubmitRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PodSubmitRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PodSubmitResponseEnvelope"}},"schemaId":"components/schemas/PodSubmitResponseEnvelope"}],"pointer":"/paths/~1api~1shipment~1submit_pod/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PodSubmitResponseEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PodSubmitResponseEnvelope"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/submit_pod"}],"content":{"contentType":"group","meta":{"name":"Tracking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tracking","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/shipment/direct/tracking_by_tracking_no","summary":"Consultar estado de rastreo por número de rastreo (con offset UTC)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tracking/getshipmenttrackingwithutcoffset","deprecated":false},{"title":"/api/shipment/submit_pod","summary":"Enviar Prueba de Entrega (POD)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tracking/submitpod","deprecated":false}]}]}]}]}},{"type":"group","label":"Pickup","link":"/es/v2/openapi/pickup","routeSlug":"/es/v2/openapi/pickup","items":[{"label":"Programar recolección","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/pickup/addpickupbyshipment","routeSlug":"/es/v2/openapi/pickup/addpickupbyshipment","metadata":{"seo":{"title":"Programar recolección","description":"Crea una solicitud de recolección de USPS (Carrier Pickup) utilizando la información de un envío existente. Este endpoint programa al cartero de USPS para recoger paquetes elegibles en el siguiente día hábil de USPS.Para conocer todos los posibles códigos de error que devuelve este endpoint, consulta Apéndice – Códigos de error de recolección."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addPickupByShipment","name":"Programar recolección","isWebhook":false,"pointer":"/paths/~1api~1shipment~1pickup~1add/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Programar recolección","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":"Crea una solicitud de recolección de USPS (Carrier Pickup) utilizando la información de un envío existente. Este endpoint programa al cartero de USPS para recoger paquetes elegibles en el siguiente día hábil de USPS."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para conocer todos los posibles códigos de error que devuelve este endpoint, consulta "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.shipsaving.com/v2/appendix#post-apishipmentpickupadd"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apéndice – Códigos de error de recolección"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddPickUpByShipmentRequest"}},"schemaId":"components/schemas/AddPickUpByShipmentRequest","pointer":"/paths/~1api~1shipment~1pickup~1add/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/pickup/add","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddPickUpByShipmentRequest"}},"responseCodes":["200","400"],"pointer":"/api/shipment/pickup/add","href":"pickup/addpickupbyshipment","openApiOperationId":"addPickupByShipment","summary":"Programar recolección"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com"}],"schemaId":"components/schemas/AddPickUpByShipmentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddPickUpByShipmentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}},"schemaId":"schema_160"},{"code":"400","description":"Solicitud incorrecta","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161","exampleIds":["paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentAlreadyInPickup","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentNotExist","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/missingAddressFields","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/invalidAddress"]}},"schemaId":"schema_161","exampleIds":["paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentAlreadyInPickup","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentNotExist","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/missingAddressFields","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/invalidAddress"]}],"pointer":"/paths/~1api~1shipment~1pickup~1add/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_160","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}}},{"code":"400","schemaId":"schema_161","exampleIds":["paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentAlreadyInPickup","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentNotExist","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/missingAddressFields","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/invalidAddress"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161","exampleIds":["paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentAlreadyInPickup","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentNotExist","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/missingAddressFields","paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/invalidAddress"]}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/pickup/add"},{"label":"Cancelar recolección","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/pickup/cancelpickup","routeSlug":"/es/v2/openapi/pickup/cancelpickup","metadata":{"seo":{"title":"Cancelar recolección","description":"Cancela una recolección previamente programada con el transportista. Una vez cancelada, la recolección no puede actualizarse ni cancelarse de nuevo. No requiere parámetros adicionales más allá de pickup_no. Si la operación es exitosa, el estado cambiará a CANCELED.Para conocer todos los posibles códigos de error que devuelve este endpoint, consulta Apéndice – Códigos de error de recolección."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelPickup","name":"Cancelar recolección","isWebhook":false,"pointer":"/paths/~1api~1shipment~1pickup~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancelar recolección","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":"Cancela una recolección previamente programada con el transportista. Una vez cancelada, la recolección no puede actualizarse ni cancelarse de nuevo. No requiere parámetros adicionales más allá de "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pickup_no"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Si la operación es exitosa, el estado cambiará a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELED"},"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":"Para conocer todos los posibles códigos de error que devuelve este endpoint, consulta "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.shipsaving.com/v2/appendix#post-apishipmentpickupcancel"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apéndice – Códigos de error de recolección"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelPickupRequest"}},"schemaId":"components/schemas/CancelPickupRequest","pointer":"/paths/~1api~1shipment~1pickup~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipment/pickup/cancel","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CancelPickupRequest"}},"responseCodes":["200","400"],"pointer":"/api/shipment/pickup/cancel","href":"pickup/cancelpickup","openApiOperationId":"cancelPickup","summary":"Cancelar recolección"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com"}],"schemaId":"components/schemas/CancelPickupRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelPickupRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonServiceResponse"}},"schemaId":"components/schemas/CommonServiceResponse"},{"code":"400","description":"Solicitud incorrecta","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161","exampleIds":["paths/~1api~1shipment~1pickup~1cancel/post/responses/400/content/application~1json/examples/pickupAlreadyCanceled"]}},"schemaId":"schema_161","exampleIds":["paths/~1api~1shipment~1pickup~1cancel/post/responses/400/content/application~1json/examples/pickupAlreadyCanceled"]}],"pointer":"/paths/~1api~1shipment~1pickup~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonServiceResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonServiceResponse"}}},{"code":"400","schemaId":"schema_161","exampleIds":["paths/~1api~1shipment~1pickup~1cancel/post/responses/400/content/application~1json/examples/pickupAlreadyCanceled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161","exampleIds":["paths/~1api~1shipment~1pickup~1cancel/post/responses/400/content/application~1json/examples/pickupAlreadyCanceled"]}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/pickup/cancel"},{"label":"Obtener registros de recolección","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/pickup/getpickuplist","routeSlug":"/es/v2/openapi/pickup/getpickuplist","metadata":{"seo":{"title":"Obtener registros de recolección","description":"Recupera una lista paginada de los registros de recolección creados en el sistema.Este endpoint admite filtros opcionales como el número de confirmación de USPS,el estado de la recolección y el código del transportista. Los parámetros de paginación(page y page_size) permiten controlar el tamaño del conjunto de resultados devueltos,y el indicador order_by determina el orden de los resultados."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPickupList","name":"Obtener registros de recolección","isWebhook":false,"pointer":"/paths/~1api~1shipment~1pickup~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Obtener registros de recolección","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":"Recupera una lista paginada de los registros de recolección creados en el sistema."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Este endpoint admite filtros opcionales como el número de confirmación de USPS,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"el estado de la recolección y el código del transportista. Los parámetros de paginación"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" y "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page_size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") permiten controlar el tamaño del conjunto de resultados devueltos,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"y el indicador "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" determina el orden de los resultados."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"confirmation_number","in":"query","schemaId":"schema_162"},{"name":"status","in":"query","schemaId":"schema_163","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtro por estado de la recolección."},"children":[]}]}]}]},{"name":"carrier_code","in":"query","schemaId":"schema_164"},{"name":"page","in":"query","schemaId":"schema_165","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de página para los resultados paginados (comenzando desde 1)."},"children":[]}]}]}]},{"name":"page_size","in":"query","schemaId":"schema_166","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de resultados a devolver por página."},"children":[]}]}]}]},{"name":"order_by","in":"query","schemaId":"schema_167","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicador de orden que controla la ordenación temporal:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": orden cronológico (más antiguo → más reciente)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": orden cronológico inverso (más reciente → más antiguo)"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1api~1shipment~1pickup~1list/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipment/pickup/list","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[{"name":"confirmation_number","in":"query","required":false,"example":"WTC65384000","schemaId":"components/schemas/PickUpConfirmationNo"},{"name":"status","in":"query","required":false,"schemaId":"schema_163"},{"name":"carrier_code","in":"query","required":false,"example":"USPS","schemaId":"components/schemas/PickUpCarrierCodeEnum"},{"name":"page","in":"query","required":false,"schemaId":"schema_165"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_166"},{"name":"order_by","in":"query","required":true,"schemaId":"schema_167"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipment/pickup/list","href":"pickup/getpickuplist","openApiOperationId":"getPickupList","summary":"Obtener registros de recolección"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryPickupResponse"}},"schemaId":"components/schemas/QueryPickupResponse"}],"pointer":"/paths/~1api~1shipment~1pickup~1list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueryPickupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryPickupResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/pickup/list"},{"label":"Obtener ubicación del paquete","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/pickup/getpackagelocation","routeSlug":"/es/v2/openapi/pickup/getpackagelocation","metadata":{"seo":{"title":"Obtener ubicación del paquete","description":"Devuelve la lista de valores enum válidos para la ubicación del paquete. Estos valores indican dónde se colocarán los paquetes en la dirección de recolección para que el transportista de USPS los recoja durante la recolección programada."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPackageLocation","name":"Obtener ubicación del paquete","isWebhook":false,"pointer":"/paths/~1api~1shipment~1pickup~1package~1location~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Obtener ubicación del paquete","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":"Devuelve la lista de valores enum válidos para la ubicación del paquete. Estos valores indican dónde se colocarán los paquetes en la dirección de recolección para que el transportista de USPS los recoja durante la recolección programada."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipment/pickup/package/location/list","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipment/pickup/package/location/list","href":"pickup/getpackagelocation","openApiOperationId":"getPackageLocation","summary":"Obtener ubicación del paquete"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryPackageLocationResponse"}},"schemaId":"components/schemas/QueryPackageLocationResponse"}],"pointer":"/paths/~1api~1shipment~1pickup~1package~1location~1list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueryPackageLocationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryPackageLocationResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/shipment/pickup/package/location/list"}],"content":{"contentType":"group","meta":{"name":"Pickup"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pickup","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/shipment/pickup/add","summary":"Programar recolección","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pickup/addpickupbyshipment","deprecated":false},{"title":"/api/shipment/pickup/cancel","summary":"Cancelar recolección","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pickup/cancelpickup","deprecated":false},{"title":"/api/shipment/pickup/list","summary":"Obtener registros de recolección","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pickup/getpickuplist","deprecated":false},{"title":"/api/shipment/pickup/package/location/list","summary":"Obtener ubicación del paquete","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pickup/getpackagelocation","deprecated":false}]}]}]}]}},{"type":"group","label":"Address Validation","link":"/es/v2/openapi/address-validation","routeSlug":"/es/v2/openapi/address-validation","items":[{"label":"Validación de direcciones","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/address-validation/validateaddress","routeSlug":"/es/v2/openapi/address-validation/validateaddress","metadata":{"seo":{"title":"Validación de direcciones","description":"La API de Validación de Direcciones verifica la validez de las direcciones nacionalesde EE. UU. y devuelve los componentes de la dirección estandarizados de acuerdo conlos estándares de direcciones de USPS®.Esto ayuda a mejorar la precisión de entrega, reducir el correo no entregable yfavorecer una tarificación consistente para envíos y logística."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateAddress","name":"Validación de direcciones","isWebhook":false,"pointer":"/paths/~1api~1address~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validación de direcciones","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":"La API de Validación de Direcciones verifica la validez de las direcciones nacionales"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"de EE. UU. y devuelve los componentes de la dirección estandarizados de acuerdo con"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"los estándares de direcciones de USPS®."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Esto ayuda a mejorar la precisión de entrega, reducir el correo no entregable y"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"favorecer una tarificación consistente para envíos y logística."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BasicAddress"}},"schemaId":"components/schemas/BasicAddress","pointer":"/paths/~1api~1address~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/address/validate","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BasicAddress"}},"responseCodes":["200"],"pointer":"/api/address/validate","href":"address-validation/validateaddress","openApiOperationId":"validateAddress","summary":"Validación de direcciones"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com"}],"schemaId":"components/schemas/BasicAddress","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BasicAddress"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressValidateResponse"}},"schemaId":"components/schemas/AddressValidateResponse"}],"pointer":"/paths/~1api~1address~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddressValidateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressValidateResponse"}}}],"examples":[]}]}]}]},"httpPath":"/api/address/validate"}],"content":{"contentType":"group","meta":{"name":"Address Validation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Address Validation","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/address/validate","summary":"Validación de direcciones","prefix":{"name":"post","color":"post"},"badges":[],"link":"/address-validation/validateaddress","deprecated":false}]}]}]}]}},{"type":"group","label":"SCAN Form","link":"/es/v2/openapi/scan-form","routeSlug":"/es/v2/openapi/scan-form","items":[{"label":"Crear SCAN Form","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/es/v2/openapi/scan-form/createscanform","routeSlug":"/es/v2/openapi/scan-form/createscanform","metadata":{"seo":{"title":"Crear SCAN Form","description":"Crea un SCAN Form de USPS (PS Form 5630) para un conjunto de envíos ya comprados y devuelve la URL del PDF de manifiesto generado. Un SCAN Form es un único código de barras de manifiesto que consolida varios envíos, de modo que el transportista puede aceptar todo el lote con un solo escaneo en el momento de la entrega."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createScanForm","name":"Crear SCAN Form","isWebhook":false,"pointer":"/paths/~1api~1scan_form~1create_scan_form/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Crear 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":"Crea un SCAN Form de USPS (PS Form 5630) para un conjunto de envíos ya comprados y devuelve la URL del PDF de manifiesto generado. Un SCAN Form es un único código de barras de manifiesto que consolida varios envíos, de modo que el transportista puede aceptar todo el lote con un solo escaneo en el momento de la entrega."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ScanFormCreateRequest"}},"schemaId":"components/schemas/ScanFormCreateRequest","pointer":"/paths/~1api~1scan_form~1create_scan_form/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/scan_form/create_scan_form","servers":[{"url":"https://x-api.shipsaving.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ScanFormCreateRequest"}},"responseCodes":["200"],"pointer":"/api/scan_form/create_scan_form","href":"scan-form/createscanform","openApiOperationId":"createScanForm","summary":"Crear SCAN Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://x-api.shipsaving.com"}],"schemaId":"components/schemas/ScanFormCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ScanFormCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScanFormCreateResponseEnvelope"}},"schemaId":"components/schemas/ScanFormCreateResponseEnvelope"}],"pointer":"/paths/~1api~1scan_form~1create_scan_form/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ScanFormCreateResponseEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScanFormCreateResponseEnvelope"}}}],"examples":[]}]}]}]},"httpPath":"/api/scan_form/create_scan_form"}],"content":{"contentType":"group","meta":{"name":"SCAN Form"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SCAN Form","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/scan_form/create_scan_form","summary":"Crear SCAN Form","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scan-form/createscanform","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/TokenResponse":{"id":"components/schemas/TokenResponse","kind":"json-schema","title":"TokenResponse","data":{"type":"object","properties":{"access_token":{"type":"string","description":"Token de acceso JWT."},"token_type":{"type":"string","example":"Bearer"},"expires_in":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tiempo de expiración en segundos (1800 por defecto)."},"children":[]}]}]}]},"scope":{"type":"string","description":"Scopes otorgados (si se devuelven)."}}}},"components/schemas/OAuthError":{"id":"components/schemas/OAuthError","kind":"json-schema","title":"OAuthError","data":{"type":"object","properties":{"error":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de error de OAuth 2.0."},"children":[]}]}]}],"example":"invalid_request"},"error_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explicación legible por humanos."},"children":[]}]}]}]},"error_uri":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enlace a la sección correspondiente del RFC."},"children":[]}]}]}]}}}},"components/schemas/RequestUniqueId":{"id":"components/schemas/RequestUniqueId","kind":"json-schema","title":"RequestUniqueId","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único generado por el cliente que realiza la solicitud para marcar una solicitud de tarifa individual dentro de un lote. Este valor se devolverá en la respuesta correspondiente, garantizando una correspondencia uno a uno entre solicitudes y respuestas."},"children":[]}]}]}],"example":"unique_uuid_001"}},"components/schemas/BasicAddress":{"id":"components/schemas/BasicAddress","kind":"json-schema","title":"BasicAddress","data":{"required":["street","city","state","country","zip_code"],"type":"object","properties":{"street":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"El número del edificio junto con el nombre de la vía o calle en la que se encuentra."},"children":[]}]}]}],"example":"xxxx Olive Street"},"street2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"El identificador de unidad secundaria, como el número de apartamento (APT) o suite (STE), que define la ubicación exacta de la dirección dentro de un edificio."},"children":[]}]}]}],"example":"STE XXX"},"city":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nombre de la ciudad de la dirección."},"children":[]}]}]}],"example":"Los Angeles"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para direcciones de EE. UU., este campo debe ser un código de estado válido de dos letras (por ejemplo, \"CA\" para California, \"NY\" para Nueva York)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Para direcciones fuera de EE. UU., no existe restricción sobre el valor."},"children":[]}]}]}]}],"example":"CA"},"zip_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código postal de la dirección."},"children":[]}]}]}],"example":"021XX"},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de país de 2 letras. El valor de este campo será un "},"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":"código de dos dígitos ISO 3166-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"US"}}}},"components/schemas/AddressFrom":{"id":"components/schemas/AddressFrom","kind":"json-schema","title":"AddressFrom","data":{"allOf":[{"type":"object","required":["first_name","last_name","zip_code"],"properties":{"first_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nombre correspondiente a la dirección. Para la API de Batch Quick Rate, este parámetro es opcional."},"children":[]}]}]}],"example":"Alice"},"last_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apellido correspondiente a la dirección. Para la API de Batch Quick Rate, este parámetro es opcional."},"children":[]}]}]}],"example":"Green"},"company_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nombre de la empresa o comercio correspondiente a la dirección."},"children":[]}]}]}],"example":"ShipSaving"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de teléfono del remitente/destinatario. Es obligatorio para envíos internacionales. Se recomienda proporcionar un número de teléfono en todos los envíos para garantizar una entrega precisa y facilitar el contacto del transportista en caso de ser necesario."},"children":[]}]}]}],"example":"1234567890"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dirección de correo electrónico del remitente/destinatario. El transportista puede utilizarla para notificaciones de entrega o para resolver incidencias."},"children":[]}]}]}],"example":"it@shipsaving.com"}}},{"$ref":"#/components/schemas/BasicAddress"}]}},"components/schemas/AddressTo":{"id":"components/schemas/AddressTo","kind":"json-schema","title":"AddressTo","data":{"allOf":[{"$ref":"#/components/schemas/AddressFrom"},{"type":"object","required":["address_type"],"properties":{"address_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica si la dirección de destino es residencial o comercial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Este indicador se utiliza para determinar los recargos específicos del transportista (por ejemplo, recargos de UPS por entrega residencial)."},"children":[]}]}]}],"example":"residential","enum":["residential","commercial"]}}}]}},"components/schemas/CarrierPackageCodeEnum":{"id":"components/schemas/CarrierPackageCodeEnum","kind":"json-schema","title":"CarrierPackageCodeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador del código de paquete del transportista. Consulta Apéndice - Códigos de paquete por transportista para ver los valores admitidos en la nueva API de ShipSaving (v2)."},"children":[]}]}]}],"example":"USPS_SMALL_FLAT_RATE_BOX","enum":["USPS_LETTER","USPS_LARGE_ENVELOPE_OR_FLAT","USPS_THICK_ENVELOPE","USPS_SMALL_FLAT_RATE_BOX","USPS_MEDIUM_FLAT_RATE_BOX","USPS_LARGE_FLAT_RATE_BOX","USPS_FLAT_RATE_ENVELOPE","USPS_PADDED_FLAT_RATE_ENVELOPE","USPS_LEGAL_FLAT_RATE_ENVELOPE","UPS_LETTER","UPS_25KG_BOX","UPS_10KG_BOX","UPS_TUBE","UPS_PAK","UPS_EXPRESS_BOX_SMALL","UPS_EXPRESS_BOX_MEDIUM","UPS_EXPRESS_BOX_LARGE","FEDEX_ENVELOPE","FEDEX_PAK","FEDEX_TUBE","FEDEX_EXTRA_SMALL_BOX","FEDEX_SMALL_BOX","FEDEX_MEDIUM_BOX","FEDEX_LARGE_BOX","FEDEX_EXTRA_LARGE_BOX","FEDEX_BOX","FEDEX_10KG_BOX","FEDEX_25KG_BOX","UPS_CANADA_LETTER","UPS_CANADA_25KG_BOX","UPS_CANADA_10KG_BOX","UPS_CANADA_TUBE","UPS_CANADA_PAK","UPS_CANADA_EXPRESS_BOX_SMALL","UPS_CANADA_EXPRESS_BOX_MEDIUM","UPS_CANADA_EXPRESS_BOX_LARGE","UPS_CANADA_EXPRESS_BOX"]}},"components/schemas/DimensionUnitEnum":{"id":"components/schemas/DimensionUnitEnum","kind":"json-schema","title":"DimensionUnitEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unidad de dimensión seleccionada."},"children":[]}]}]}],"example":"in","enum":["in","cm"]}},"components/schemas/WeightUnitEnum":{"id":"components/schemas/WeightUnitEnum","kind":"json-schema","title":"WeightUnitEnum","data":{"type":"string","description":"Unidad de peso seleccionada.","example":"lb","enum":["lb","oz","kg","g"]}},"components/schemas/ShipmentPackageData":{"id":"components/schemas/ShipmentPackageData","kind":"json-schema","title":"ShipmentPackageData","data":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define el tipo de paquete que se envía."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"my_package"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Úsalo cuando especifiques dimensiones personalizadas del paquete. Requiere "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"width"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"length"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"height"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dimension_unit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" y "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight_unit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"predefined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Úsalo cuando selecciones un tipo de paquete predefinido del transportista. Solo requiere "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier_package_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" y los campos de peso; los campos de dimensiones se ignoran."},"children":[]}]}]}]}],"example":"my_package","enum":["my_package","predefined"]},"length":{"type":"number","description":"Largo del paquete en la unidad seleccionada.","example":10},"width":{"type":"number","description":"Ancho del paquete en la unidad seleccionada.","example":10},"height":{"type":"number","description":"Alto del paquete en la unidad seleccionada.","example":10},"weight":{"type":"number","description":"Peso del paquete en la unidad seleccionada.","example":10},"carrier_package_code":{"$ref":"#/components/schemas/CarrierPackageCodeEnum"},"dimension_unit":{"$ref":"#/components/schemas/DimensionUnitEnum"},"weight_unit":{"$ref":"#/components/schemas/WeightUnitEnum"}}}},"components/schemas/SignatureTypeEnum":{"id":"components/schemas/SignatureTypeEnum","kind":"json-schema","title":"SignatureTypeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solicita confirmación de firma en la entrega. Valores:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Confirmación de firma de;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adult_signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Firma de adulto requerida (21+);"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usps_signature_restricted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Confirmación de firma con entrega restringida"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(se entrega únicamente al destinatario indicado o a su agente autorizado);"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"usps_adult_signature_restricted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Firma de adulto con entrega restringida (21+)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(el destinatario debe tener 21 años o más y ser la persona indicada)."},"children":[]}]}]}]}],"enum":["signature","adult_signature","usps_signature_restricted","usps_adult_signature_restricted"]}},"components/schemas/CustomPrint":{"id":"components/schemas/CustomPrint","kind":"json-schema","title":"CustomPrint","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Texto personalizado para imprimir en la etiqueta. Si la etiqueta admite contenido de impresión personalizado, este campo se imprimirá en la etiqueta."},"children":[]}]}]}],"example":"Por favor, deja el paquete en el casillero."}},"components/schemas/ShipmentOptionData":{"id":"components/schemas/ShipmentOptionData","kind":"json-schema","title":"ShipmentOptionData","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opciones de envío adicionales"},"children":[]}]}]}],"properties":{"signature":{"$ref":"#/components/schemas/SignatureTypeEnum"},"custom_text_on_label_1":{"$ref":"#/components/schemas/CustomPrint"},"custom_text_on_label_2":{"$ref":"#/components/schemas/CustomPrint"},"hazardous_materials":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica si este envío contiene mercancías peligrosas o materiales peligrosos (solo para el servicio USPS Ground Advantage). Consulta el tutorial sobre cómo embalar, etiquetar y enviar HAZMAT para envíos nacionales."},"children":[]}]}]}],"example":true},"is_lithium_battery":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica si el paquete contiene baterías de litio."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nota"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cuando este campo es "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hazardous_materials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" se sobrescribe a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Los envíos con destino u origen en territorios insulares de EE. UU. (como Guam, Puerto Rico) normalmente requieren que este campo sea "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" para poder enviar baterías de litio."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consulta las pautas de USPS sobre baterías de litio antes de realizar el envío."},"children":[]}]}]}]}],"example":false},"additional_handling":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica si el paquete requiere manejo adicional debido a su tamaño, peso o embalaje que no cumple con las pautas estándar de envío. Los transportistas pueden aplicar cargos adicionales cuando este campo se establece en "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":false},"require_saturday_delivery":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cuando es "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", solo se devuelven las cotizaciones de tarifas que admiten entrega en sábado. Si es "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" o se omite, se devuelven todas las cotizaciones de tarifa disponibles independientemente del soporte de entrega en sábado."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nota"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"La disponibilidad real de entrega en sábado depende del transportista y del nivel de servicio; algunos transportistas o servicios pueden no admitirla."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activar esta preferencia puede dar lugar a recargos adicionales del transportista o a costos de envío más altos si el nivel de servicio seleccionado aplica cargos extra por entrega en sábado."},"children":[]}]}]}]}],"example":false}}}},"components/schemas/ShipDate":{"id":"components/schemas/ShipDate","kind":"json-schema","title":"ShipDate","data":{"type":"string","description":"Marca de tiempo en formato ISO 8601, incluyendo la hora local y el desplazamiento de zona horaria.","example":"2025-07-31T00:00:00+08:00"}},"components/schemas/BasicRateRequest":{"id":"components/schemas/BasicRateRequest","kind":"json-schema","title":"BasicRateRequest","data":{"required":["from_address_data","to_address_data","package_data","ship_date"],"type":"object","properties":{"from_address_data":{"$ref":"#/components/schemas/AddressFrom"},"to_address_data":{"$ref":"#/components/schemas/AddressTo"},"package_data":{"$ref":"#/components/schemas/ShipmentPackageData"},"option_data":{"$ref":"#/components/schemas/ShipmentOptionData"},"ship_date":{"$ref":"#/components/schemas/ShipDate"}}}},"components/schemas/IsReturnLabel":{"id":"components/schemas/IsReturnLabel","kind":"json-schema","title":"IsReturnLabel","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica si la etiqueta corresponde a un envío de devolución."},"children":[]}]}]}],"default":false,"example":false}},"components/schemas/ProviderIdEnum":{"id":"components/schemas/ProviderIdEnum","kind":"json-schema","title":"ProviderIdEnum","data":{"type":"string","description":"id del proveedor del transportista","example":"USPS_X","enum":["UPS_SS_DNI","USPS_X","FEDEX_X","DHL_A","GOFO_EXPRESS_A","SWIFTX","UPS_CANADA"]}},"components/schemas/ServiceLevelEnum":{"id":"components/schemas/ServiceLevelEnum","kind":"json-schema","title":"ServiceLevelEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nivel de servicio del transportista. Consulta Apéndice - Tipos de servicio por transportista para ver las relaciones válidas entre carrier_code, provider_id y service_level."},"children":[]}]}]}],"example":"USPS_GROUND_ADVANTAGE","enum":["USPS_FIRST_CLASS_MAIL","USPS_GROUND_ADVANTAGE","USPS_PRIORITY_MAIL","USPS_PRIORITY_MAIL_EXPRESS","USPS_MEDIA_MAIL","USPS_LIBRARY_MAIL","USPS_FIRST_CLASS_MAIL_INTERNATIONAL","USPS_PRIORITY_MAIL_INTERNATIONAL","USPS_PRIORITY_MAIL_EXPRESS_INTERNATIONAL","UPS_GROUND","UPS_GROUND_SAVER","UPS_NEXT_DAY_AIR","UPS_NEXT_DAY_AIR_SAVER","UPS_NEXT_DAY_AIR_EARLY","UPS_2ND_DAY_AIR","UPS_2ND_DAY_AIR_AM","UPS_3_DAY_SELECT","UPS_STANDARD","UPS_WORLDWIDE_SAVER","UPS_WORLDWIDE_EXPRESS","UPS_WORLDWIDE_EXPRESS_PLUS","UPS_WORLDWIDE_EXPEDITED","UPS_SUREPOST_LESS_THAN_1_LB","UPS_SUREPOST_1_LB_OR_GREATER","FEDEX_GROUND","FEDEX_2_DAY","FEDEX_2_DAY_AM","FEDEX_EXPRESS_SAVER","FEDEX_STANDARD_OVERNIGHT","FEDEX_FIRST_OVERNIGHT","FEDEX_PRIORITY_OVERNIGHT","FEDEX_INTERNATIONAL_ECONOMY","FEDEX_INTERNATIONAL_FIRST","FEDEX_INTERNATIONAL_PRIORITY","FEDEX_HOME_DELIVERY","FEDEX_SMARTPOST","FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS","FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS","FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS","FEDEX_INTERNATIONAL_PRIORITY_EXPRESS","FEDEX_INTERNATIONAL_CONNECT_PLUS","FEDEX_DATE_CERTAIN_HOME_DELIVERY","FEDEX_EVENING_HOME_DELIVERY","FEDEX_APPOINTMENT_HOME_DELIVERY","FEDEX_INTERNATIONAL_PRIORITY_PR","DHL_EXPRESS_WORLDWIDE_B2C","DHL_EXPRESS_WORLDWIDE_B2C_NONDOC","DHL_EXPRESS_JET_LINE_NONDOC","DHL_EXPRESS_SPRINT_LINE","DHL_EXPRESS_EURO_PACK_DOC","DHL_EXPRESS_BREAK_BULK_EXPRESS","DHL_EXPRESS_MEDICAL_EXPRESS","DHL_EXPRESS_WORLDWIDE_DOC","DHL_EXPRESS_0900_NONDOC","DHL_EXPRESS_FREIGHT_WORLDWIDE_NONDOC","DHL_EXPRESS_DOMESTIC_ECONOMY_SELECT","DHL_EXPRESS_ECONOMY_SELECT_NONDOC","DHL_EXPRESS_DOMESTIC_EXPRESS_0900","DHL_EXPRESS_JUMBO_BOX_NONDOC","DHL_EXPRESS_0900","DHL_EXPRESS_1030","DHL_EXPRESS_1030_NONDOC","DHL_EXPRESS_DOMESTIC_EXPRESS","DHL_EXPRESS_DOMESTIC_EXPRESS_1030","DHL_EXPRESS_WORLDWIDE_NONDOC","DHL_EXPRESS_MEDICAL_EXPRESS_NODOC","DHL_EXPRESS_GLOBAL_MAIL_BUSINESS","DHL_EXPRESS_SAME_DAY","DHL_EXPRESS_1200_DOC","DHL_EXPRESS_WORLDWIDE_ECX","DHL_EXPRESS_EURO_PACK_NONDOC","DHL_EXPRESS_ECONOMY_SELECT","DHL_EXPRESS_ENVELOPE","DHL_EXPRESS_1200_NONDOC","DHL_EXPRESS_DOMESTIC_EXPRESS_1200","GOFO_EXPRESS_ECO","SWIFTX_EXP","UPS_CANADA_EXPEDITED","UPS_CANADA_EXPRESS_EARLY","UPS_CANADA_EXPRESS_SAVER","UPS_CANADA_EXPRESS","UPS_CANADA_STANDARD","UPS_CANADA_3_DAY_SELECT","UPS_CANADA_EXPRESS_EARLY_SM","UPS_CANADA_WORLDWIDE_EXPEDITED_SM","UPS_CANADA_WORLDWIDE_EXPRESS_PLUS_SM","UPS_CANADA_WORLDWIDE_EXPRESS_SM","UPS_CANADA_EXPRESS_SAVER_SM"]}},"components/schemas/ShipmentRateCarrierData":{"id":"components/schemas/ShipmentRateCarrierData","kind":"json-schema","title":"ShipmentRateCarrierData","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Al especificar este parámetro, puedes filtrar las tarifas por transportista y nivel de servicio, lo que permite consultas más rápidas."},"children":[]}]}]}],"items":{"type":"object","properties":{"provider_id":{"$ref":"#/components/schemas/ProviderIdEnum"},"service_levels":{"type":"array","description":"Niveles de servicio del transportista.","items":{"$ref":"#/components/schemas/ServiceLevelEnum"}}}}}},"components/schemas/BatchQuickRateRequestItem":{"id":"components/schemas/BatchQuickRateRequestItem","kind":"json-schema","title":"BatchQuickRateRequestItem","data":{"allOf":[{"type":"object","required":["request_unique_id"],"properties":{"request_unique_id":{"$ref":"#/components/schemas/RequestUniqueId"}}},{"$ref":"#/components/schemas/BasicRateRequest"},{"type":"object","properties":{"is_return_label":{"$ref":"#/components/schemas/IsReturnLabel"},"shipment_rate_carrier_data":{"$ref":"#/components/schemas/ShipmentRateCarrierData"}}}]}},"components/schemas/BatchQuickRateRequest":{"id":"components/schemas/BatchQuickRateRequest","kind":"json-schema","title":"BatchQuickRateRequest","data":{"type":"object","required":["rate_requests"],"properties":{"rate_requests":{"type":"array","description":"Lista de solicitudes de tarifa individuales. Cada llamada puede incluir hasta 10 elementos.","maxItems":10,"items":{"$ref":"#/components/schemas/BatchQuickRateRequestItem"}}}}},"components/schemas/ShipmentRateId":{"id":"components/schemas/ShipmentRateId","kind":"json-schema","title":"ShipmentRateId","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único de una tarifa de envío devuelta por el endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"get_rates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Usa este valor para referenciar una tarifa específica al comprar una etiqueta."},"children":[]}]}]}],"example":"dc288147-f7dd-494d-9353-5ce00020c7aa"}},"components/schemas/CarrierCodeEnum":{"id":"components/schemas/CarrierCodeEnum","kind":"json-schema","title":"CarrierCodeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador del código de transportista."},"children":[]}]}]}],"example":"USPS","enum":["USPS","UPS","FEDEX","DHL_EXPRESS","SWIFTX","GOFO_EXPRESS","UPS_CANADA"]}},"components/schemas/BaseRateItem":{"id":"components/schemas/BaseRateItem","kind":"json-schema","title":"BaseRateItem","data":{"type":"object","description":"Representa la tarifa base cobrada por un transportista para un nivel de servicio determinado.","properties":{"amount":{"type":"number","format":"float","example":33.21},"currency":{"type":"string","example":"USD"},"list_amount":{"type":"number","format":"float","example":33.21},"retail_amount":{"type":"number","format":"float","example":59.55}}}},"components/schemas/SurchargeItem":{"id":"components/schemas/SurchargeItem","kind":"json-schema","title":"SurchargeItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Representa un único recargo aplicado a un envío o tarifa."},"children":[]}]}]}],"nullable":true,"properties":{"object":{"type":"string","description":"El tipo de objeto, que indica que este elemento representa un recargo.\n"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Un código que identifica el tipo específico de recargo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Por ejemplo, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonstandard_22"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" puede indicar un cargo por manejo de paquete no estándar."},"children":[]}]}]}],"example":"nonstandard_22"},"category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"La categoría del recargo, que agrupa tipos de cargos similares."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ejemplos comunes incluyen "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HANDLING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FUEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc."},"children":[]}]}]}],"example":"HANDLING"},"amount":{"type":"number","format":"float","description":"El monto total del recargo cobrado por este elemento.\n","example":4},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"El código de moneda de tres letras (ISO 4217) del recargo."},"children":[]}]}]}],"example":"USD"},"list_amount":{"type":"number","format":"float","example":4},"retail_amount":{"type":"number","format":"float","example":4}}}},"components/schemas/PriceDetailItem":{"id":"components/schemas/PriceDetailItem","kind":"json-schema","title":"PriceDetailItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Representa una única línea de desglose de precio de una tarifa. Específico de FedEx."},"children":[]}]}]}],"properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Un código que identifica el componente del cargo."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ejemplos comunes incluyen "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASE_CHARGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FUEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESIDENTIAL_DELIVERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEMAND_OVERSIZE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEMAND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OVERSIZE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" y "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERY_AREA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"BASE_CHARGE"},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Una descripción legible del componente del cargo."},"children":[]}]}]}],"example":"Shipping Label Charge"},"price":{"type":"number","format":"float","description":"El monto cobrado por este componente.","example":99.31}}}},"components/schemas/RateItem":{"id":"components/schemas/RateItem","kind":"json-schema","title":"RateItem","data":{"type":"object","properties":{"zone":{"type":"string","nullable":true,"example":"8Rural"},"currency":{"type":"string","example":"USD"},"cubic":{"type":"boolean","example":false},"rate_id":{"$ref":"#/components/schemas/ShipmentRateId"},"carrier_code":{"$ref":"#/components/schemas/CarrierCodeEnum"},"provider_id":{"$ref":"#/components/schemas/ProviderIdEnum"},"service_name":{"type":"string","example":"USPS Media Mail"},"service_level":{"type":"string","example":"USPS_MEDIA_MAIL"},"service_level_desc":{"type":"string","example":"Una forma rentable de enviar libros, contenido multimedia y materiales educativos elegibles."},"returned_package_code":{"type":"string","nullable":true,"example":"my_package"},"delivery_days":{"type":"string","nullable":true,"example":"2"},"delivery_date":{"type":"string","nullable":true,"example":"2025-08-08T00:00:00+08:00"},"delivery_weekday":{"type":"string","nullable":true,"example":"MONDAY"},"service_detail":{"type":"string","nullable":true,"example":"Tarifas bajas para paquetes con entrega prevista en 2-5 días hábiles."},"price":{"type":"number","format":"float","example":5.91},"origin_price":{"type":"number","format":"float","nullable":true,"example":null},"retail_price":{"type":"number","format":"float","nullable":true,"example":8.7},"discount_text":{"type":"string","nullable":true},"insurance_info":{"type":"string","nullable":true},"ship_date":{"$ref":"#/components/schemas/ShipDate"},"saturday_delivery":{"type":"boolean","example":false},"one_rate":{"type":"boolean","example":false},"base_rate":{"$ref":"#/components/schemas/BaseRateItem"},"surcharges":{"$ref":"#/components/schemas/SurchargeItem"},"usps_dim_rate_type":{"type":"string","example":"dim-weight"},"price_details":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Un desglose por componente de la tarifa. Específico de FedEx."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PriceDetailItem"}}}}},"components/schemas/RateErrorInfo":{"id":"components/schemas/RateErrorInfo","kind":"json-schema","title":"RateErrorInfo","data":{"type":"object"}},"components/schemas/BatchQuickRateItem":{"id":"components/schemas/BatchQuickRateItem","kind":"json-schema","title":"BatchQuickRateItem","data":{"type":"object","properties":{"request_unique_id":{"$ref":"#/components/schemas/RequestUniqueId"},"shipment_rate_data":{"type":"array","items":{"$ref":"#/components/schemas/RateItem"}},"error_info":{"$ref":"#/components/schemas/RateErrorInfo"}}}},"components/schemas/BatchQuickRateResponse":{"id":"components/schemas/BatchQuickRateResponse","kind":"json-schema","title":"BatchQuickRateResponse","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BatchQuickRateItem"}}}}},"components/schemas/AddressReturn":{"id":"components/schemas/AddressReturn","kind":"json-schema","title":"AddressReturn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dirección a la que se debe devolver el paquete si no se puede entregar o si se devuelve al remitente."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nota: Solo USPS admite la impresión de una dirección de devolución específica en la etiqueta."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/AddressFrom"}]}},"components/schemas/BasicRateReqWithReturnAddress":{"id":"components/schemas/BasicRateReqWithReturnAddress","kind":"json-schema","title":"BasicRateReqWithReturnAddress","data":{"allOf":[{"type":"object","properties":{"return_address_data":{"$ref":"#/components/schemas/AddressReturn"}}},{"$ref":"#/components/schemas/BasicRateRequest"}]}},"components/schemas/ContentTypeEnum":{"id":"components/schemas/ContentTypeEnum","kind":"json-schema","title":"ContentTypeEnum","data":{"type":"string","example":"merchandise","enum":["merchandise","documents","return_merchandise","sample","gift"]}},"components/schemas/TaxIdTypeEnum":{"id":"components/schemas/TaxIdTypeEnum","kind":"json-schema","title":"TaxIdTypeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tipo de identificación fiscal"},"children":[]}]}]}],"example":"TIN","enum":["TIN","EIN","SSN","VAT","EORI","IOSS","PAN"]}},"components/schemas/ShipmentCustomTaxData":{"id":"components/schemas/ShipmentCustomTaxData","kind":"json-schema","title":"ShipmentCustomTaxData","data":{"type":"object","properties":{"tax_id_type":{"$ref":"#/components/schemas/TaxIdTypeEnum"},"tax_id_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de identificación fiscal"},"children":[]}]}]}],"example":"tin2888"},"country_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de 2 letras del país. El valor de este campo será un "},"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":"código de dos dígitos ISO 3166-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"US"}}}},"components/schemas/EelPfcTypeEnum":{"id":"components/schemas/EelPfcTypeEnum","kind":"json-schema","title":"EelPfcTypeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica el método de declaración de la Información Electrónica de Exportación (EEI) para este envío."},"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":"Usa "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ITN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" si se emitió un Internal Transaction Number tras la declaración AES."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usa "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXEMPTION_CODE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" si el envío califica para una exención de la declaración EEI."},"children":[]}]}]}]}],"enum":["ITN","EXEMPTION_CODE"],"example":"ITN"}},"components/schemas/UndeliveryOptionEnum":{"id":"components/schemas/UndeliveryOptionEnum","kind":"json-schema","title":"UndeliveryOptionEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define la acción a tomar para los envíos no entregables."},"children":[]}]}]}],"example":"return_to_sender","enum":["return_to_sender","abandon"]}},"components/schemas/ShipmentCustomItemData":{"id":"components/schemas/ShipmentCustomItemData","kind":"json-schema","title":"ShipmentCustomItemData","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de artículos declarados ante aduanas (*obligatorio para envíos internacionales)"},"children":[]}]}]}],"properties":{"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descripción del artículo enviado. Proporciona datos precisos y claros para el despacho aduanero."},"children":[]}]}]}],"example":"ropa"},"quantity":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cantidad total de artículos idénticos en esta entrada de envío."},"children":[]}]}]}],"format":"int32","example":10},"origin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de 2 letras del país de origen. El valor de este campo será un "},"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":"código de dos dígitos ISO 3166-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"US"},"weight":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peso del artículo en la unidad seleccionada."},"children":[]}]}]}],"example":10},"unit_cost":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor declarado del artículo en USD. Se refiere al precio unitario del artículo."},"children":[]}]}]}],"example":19.99},"weight_unit":{"$ref":"#/components/schemas/WeightUnitEnum"},"hs_tariff_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código arancelario del Sistema Armonizado (HS) del artículo. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://uscensus.prod.3ceonline.com/ui/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encuentra mi número de armonización."},"children":[]}]}]}]}],"example":"xx"}}}},"components/schemas/ShipmentCustomData":{"id":"components/schemas/ShipmentCustomData","kind":"json-schema","title":"ShipmentCustomData","data":{"type":"object","description":"Datos aduaneros","properties":{"signing_person":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nombre de la persona que firma el formulario aduanero, normalmente el remitente o un agente autorizado, que confirma que toda la información declarada es exacta y cumple con la normativa aduanera aplicable."},"children":[]}]}]}],"example":"Ray"},"content_type":{"$ref":"#/components/schemas/ContentTypeEnum"},"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":"Información fiscal del remitente"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ShipmentCustomTaxData"}},"eel_pfc_type":{"$ref":"#/components/schemas/EelPfcTypeEnum"},"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":"Identificador de declaración EEI para este envío. Proporciona el Internal Transaction Number (ITN) obtenido de AES, o el código de exención si no se requiere la declaración EEI. Consulta el "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/appendix"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apéndice – Tabla de nombres de códigos de exención"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"X20250719123456"},"undeliverable_option":{"$ref":"#/components/schemas/UndeliveryOptionEnum"},"item_data_list":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentCustomItemData"}}}}},"components/schemas/ShipmentRateRequest":{"id":"components/schemas/ShipmentRateRequest","kind":"json-schema","title":"ShipmentRateRequest","data":{"allOf":[{"$ref":"#/components/schemas/BasicRateReqWithReturnAddress"},{"type":"object","properties":{"shipment_rate_carrier_data":{"$ref":"#/components/schemas/ShipmentRateCarrierData"},"custom_data":{"$ref":"#/components/schemas/ShipmentCustomData"}}}]}},"components/schemas/GetRatesResponse":{"id":"components/schemas/GetRatesResponse","kind":"json-schema","title":"GetRatesResponse","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"type":"object","properties":{"fastest":{"nullable":true,"$ref":"#/components/schemas/RateItem"},"cheapest":{"nullable":true,"$ref":"#/components/schemas/RateItem"},"shipment_rate_data":{"type":"array","items":{"$ref":"#/components/schemas/RateItem"}},"fastest_and_cheapest":{"type":"object","nullable":true,"$ref":"#/components/schemas/RateItem"},"error_info":{"$ref":"#/components/schemas/RateErrorInfo"}}}}}},"components/schemas/PlatformUkId":{"id":"components/schemas/PlatformUkId","kind":"json-schema","title":"PlatformUkId","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único proporcionado por quien realiza la llamada (por ejemplo, el número de pedido del cliente). Cada "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform_uk_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" debe corresponder exactamente a un envío y no puede reutilizarse en varios envíos."},"children":[]}]}]}],"example":"platformUkId175377917713"}},"components/schemas/InsuranceRateId":{"id":"components/schemas/InsuranceRateId","kind":"json-schema","title":"InsuranceRateId","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único de una tarifa de seguro devuelta por el endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/shipment/insurance/rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Usa este valor para contratar el seguro de un envío."},"children":[]}]}]}],"example":"dc288147-f7dd-494d-9353-5ce00020c7aa"}},"components/schemas/InsuranceData":{"id":"components/schemas/InsuranceData","kind":"json-schema","title":"InsuranceData","data":{"type":"object","properties":{"rate_id":{"$ref":"#/components/schemas/InsuranceRateId"}}}},"components/schemas/LabelPrintTypeEnum":{"id":"components/schemas/LabelPrintTypeEnum","kind":"json-schema","title":"LabelPrintTypeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define el formato de impresión de la etiqueta. Los tipos admitidos varían según el transportista y también pueden depender del nivel de servicio seleccionado."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Por ejemplo, USPS y FedEx pueden admitir "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"qrcode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", mientras que UPS puede admitir "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"barcode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"common","enum":["common","qrcode","barcode"]}},"components/schemas/IsExchangeLabel":{"id":"components/schemas/IsExchangeLabel","kind":"json-schema","title":"IsExchangeLabel","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica si la etiqueta de envío pertenece a un flujo de cambio/devolución específico de una plataforma. Este campo se utiliza para ciertas integraciones de marketplaces y se almacenará internamente en el campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":false,"default":false}},"components/schemas/BuyLabelRequest":{"id":"components/schemas/BuyLabelRequest","kind":"json-schema","title":"BuyLabelRequest","data":{"type":"object","required":["rate_id","platform_uk_id","label_print_type"],"properties":{"rate_id":{"$ref":"#/components/schemas/ShipmentRateId"},"platform_uk_id":{"$ref":"#/components/schemas/PlatformUkId"},"insurance_data":{"$ref":"#/components/schemas/InsuranceData"},"label_print_type":{"$ref":"#/components/schemas/LabelPrintTypeEnum"},"is_return_label":{"$ref":"#/components/schemas/IsReturnLabel"},"is_exchange_label":{"$ref":"#/components/schemas/IsExchangeLabel"}}}},"components/schemas/ShipmentNo":{"id":"components/schemas/ShipmentNo","kind":"json-schema","title":"ShipmentNo","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único del envío creado."},"children":[]}]}]}],"example":"1222243159"}},"components/schemas/TrackingNo":{"id":"components/schemas/TrackingNo","kind":"json-schema","title":"TrackingNo","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"El número de rastreo específico del transportista que puede utilizarse para rastrear el envío. Solo se devolverá un valor si la tarifa corresponde a un envío rastreable y si las transacciones se han procesado correctamente."},"children":[]}]}]}],"example":"9234690381085700XXXXX"}},"components/schemas/ShipmentItem":{"id":"components/schemas/ShipmentItem","kind":"json-schema","title":"ShipmentItem","data":{"type":"object","properties":{"zone":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"shipment_no":{"$ref":"#/components/schemas/ShipmentNo"},"tracking_no":{"$ref":"#/components/schemas/TrackingNo"},"total_fee":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monto total cobrado (etiqueta + seguro, si aplica). No incluye "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label_processing_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":39.39},"label_fee":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monto cobrado por la etiqueta de envío."},"children":[]}]}]}],"example":39.39},"insurance_fee":{"type":"number","format":"float","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monto cobrado por el seguro; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" si no se contrató."},"children":[]}]}]}],"example":null},"label_processing_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":"Tarifa fija de procesamiento cobrada por la creación de la etiqueta."},"children":[]}]}]}],"example":0.05},"label_urls":{"type":"array","description":"Lista de URLs de archivos de etiqueta (PNG) para descargar/imprimir.","items":{"type":"string","format":"uri"},"example":["https://xxxxxx.amazonaws.com/labels/2025-08-11/b0dd99909e2e7b03_0.png"]},"qrcode_urls":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de URLs PNG para descargar o imprimir la etiqueta con código QR. Campo opcional, utilizado únicamente para etiquetas con código QR de USPS."},"children":[]}]}]}],"items":{"type":"string","format":"uri"},"example":["https://xxxxxx.amazonaws.com/labels/2025-08-11/b0dd99909e2e7b03_0.png"]},"commercial_urls":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de URLs de facturas comerciales; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" si no aplica."},"children":[]}]}]}],"items":{"type":"string","format":"uri"},"example":null},"duplicate_label":{"type":"boolean","nullable":true,"example":true},"label_print_type":{"$ref":"#/components/schemas/LabelPrintTypeEnum"}}}},"components/schemas/ShipmentPurchaseResponse":{"id":"components/schemas/ShipmentPurchaseResponse","kind":"json-schema","title":"ShipmentPurchaseResponse","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"$ref":"#/components/schemas/ShipmentItem"}}}},"components/schemas/DirectBuyShipmentRequest":{"id":"components/schemas/DirectBuyShipmentRequest","kind":"json-schema","title":"DirectBuyShipmentRequest","data":{"allOf":[{"type":"object","required":["platform_uk_id","carrier_code","service_level"],"properties":{"platform_uk_id":{"$ref":"#/components/schemas/PlatformUkId"},"carrier_code":{"$ref":"#/components/schemas/CarrierCodeEnum"},"service_level":{"$ref":"#/components/schemas/ServiceLevelEnum"}}},{"$ref":"#/components/schemas/BasicRateReqWithReturnAddress"},{"type":"object","required":["label_print_type"],"properties":{"custom_data":{"$ref":"#/components/schemas/ShipmentCustomData"},"insurance_data":{"$ref":"#/components/schemas/InsuranceData"},"label_print_type":{"$ref":"#/components/schemas/LabelPrintTypeEnum"},"is_return_label":{"$ref":"#/components/schemas/IsReturnLabel"},"is_exchange_label":{"$ref":"#/components/schemas/IsExchangeLabel"}}}]}},"components/schemas/ShipmentVoidRequest":{"id":"components/schemas/ShipmentVoidRequest","kind":"json-schema","title":"ShipmentVoidRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Al llamar a la API solo necesitas proporcionar shipment_no o platform_uk_id, y el sistema podrá ubicar y procesar de forma única el envío correspondiente."},"children":[]}]}]}],"properties":{"shipment_no":{"$ref":"#/components/schemas/ShipmentNo"},"platform_uk_id":{"$ref":"#/components/schemas/PlatformUkId"}}}},"components/schemas/CommonServiceResponse":{"id":"components/schemas/CommonServiceResponse","kind":"json-schema","title":"CommonServiceResponse","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"type":"object","example":{}}}}},"components/schemas/InsuranceRateItem":{"id":"components/schemas/InsuranceRateItem","kind":"json-schema","title":"InsuranceRateItem","data":{"type":"object","properties":{"carrier":{"$ref":"#/components/schemas/CarrierCodeEnum"},"rate_id":{"$ref":"#/components/schemas/InsuranceRateId"},"service_level":{"$ref":"#/components/schemas/ServiceLevelEnum"},"rate":{"type":"number","format":"float","description":"Costo del seguro para el nivel de servicio y el valor declarado especificados.","example":1.98},"declared_value":{"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":"Valor declarado del envío para el cálculo de la cobertura del seguro."},"children":[]}]}]}],"example":200}}}},"components/schemas/InsuranceRateResponse":{"id":"components/schemas/InsuranceRateResponse","kind":"json-schema","title":"InsuranceRateResponse","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"$ref":"#/components/schemas/InsuranceRateItem"}}}},"components/schemas/TrackingStatusEnum":{"id":"components/schemas/TrackingStatusEnum","kind":"json-schema","title":"TrackingStatusEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estado actual del envío. Los valores posibles incluyen:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": La etiqueta de envío ha sido generada pero aún no ha sido escaneada por el transportista."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica que el proceso de envío aún no ha comenzado."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available_for_pickup"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": El paquete ha llegado a una ubicación designada y está esperando a que el destinatario lo recoja."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica que se requiere acción del cliente para retirar el envío."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in_transit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": El paquete se encuentra en tránsito, pasando por diferentes instalaciones o puntos de control."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica que el envío está en camino pero aún no ha llegado al destino."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"out_for_delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": El paquete ha sido entregado al mensajero y se encuentra en su ruta final de entrega."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica que el envío está en la etapa de entrega de última milla."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivered"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": El paquete ha sido entregado con éxito y firmado por el destinatario."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica que el proceso de envío se ha completado."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return_to_sender"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": El paquete está siendo devuelto al remitente debido a una entrega fallida u otros motivos."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica un proceso de logística inversa."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"voided"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": La etiqueta de envío ha sido anulada y el paquete no será procesado."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica que el envío ha sido cancelado o invalidado."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Se produjo un error durante el procesamiento del envío."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica incidencias del lado del transportista que pueden requerir intervención manual."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"seized_by_law_enforcement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": El paquete fue incautado por las autoridades policiales."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica problemas de cumplimiento o legales que afectan al envío."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unknown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Se desconoce el estado del envío o el transportista no proporciona una actualización válida."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica que no hay información de rastreo disponible en este momento."},"children":[]}]}]}]}]}],"enum":["created","available_for_pickup","in_transit","out_for_delivery","delivered","return_to_sender","voided","error","seized_by_law_enforcement","unknown"],"example":"in_transit"}},"components/schemas/TrackingLocation":{"id":"components/schemas/TrackingLocation","kind":"json-schema","title":"TrackingLocation","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Información de ubicación reportada por el transportista. Los campos como city, state, zipcode y country pueden devolverse según la disponibilidad de los datos del transportista."},"children":[]}]}]}],"properties":{"city":{"type":"string","example":"BROOKLYN"},"state":{"type":"string","example":"NY"},"zipcode":{"type":"string","example":"91777"},"country":{"type":"string"}}}},"components/schemas/ReturnToSenderFlag":{"id":"components/schemas/ReturnToSenderFlag","kind":"json-schema","title":"ReturnToSenderFlag","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica si el envío ha sido devuelto al remitente."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Este campo siempre está presente en la respuesta cuando el código de estado es 200, independientemente del estado de rastreo actual."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false: El envío no ha sido devuelto al remitente."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true: El envío ha sido devuelto al remitente."},"children":[]}]}]}]}],"example":true,"default":false}},"components/schemas/TrackingEventWUtcOffset":{"id":"components/schemas/TrackingEventWUtcOffset","kind":"json-schema","title":"TrackingEventWUtcOffset","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Un único evento de rastreo."},"children":[]}]}]}],"properties":{"status":{"type":"string","example":"in_transit"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descripción legible por humanos."},"children":[]}]}]}],"example":"Arrived at USPS Facility"},"event_time":{"type":"string","format":"date-time","description":"Marca de tiempo del evento devuelta en formato ISO 8601 con el desfase UTC incluido\npara indicar la zona horaria local del evento.\n","example":"2025-09-15T09:22:36-05:00"},"location":{"$ref":"#/components/schemas/TrackingLocation"}}}},"components/schemas/TrackingDataWUtcOffset":{"id":"components/schemas/TrackingDataWUtcOffset","kind":"json-schema","title":"TrackingDataWUtcOffset","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Este es el registro de rastreo más reciente."},"children":[]}]}]}],"properties":{"status":{"$ref":"#/components/schemas/TrackingStatusEnum"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descripción legible por humanos del estado."},"children":[]}]}]}],"example":"USPS in possession of item"},"status_summary":{"type":"string","description":"El resumen del estado.","example":"Your item has been delivered and is available at xxx at 9:00 am on xxx in xxxx, xx 20000."},"recipient_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"El nombre de la persona que firma la entrega (si está disponible)."},"children":[]}]}]}],"example":"Alice"},"scanned_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marca de tiempo en la que se escaneó el paquete, devuelta en formato ISO 8601 con el desfase UTC incluido para indicar la zona horaria local."},"children":[]}]}]}],"example":"2025-12-16T10:48:28-05:00"},"location":{"$ref":"#/components/schemas/TrackingLocation"},"return_to_sender":{"$ref":"#/components/schemas/ReturnToSenderFlag"},"first_scan_date":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marca de tiempo del primer escaneo del transportista para el envío, que indica cuándo"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"el paquete fue procesado o recibido inicialmente por el transportista. Se devuelve en"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"formato ISO 8601 con el desfase UTC incluido para representar la hora local del evento."},"children":[]}]}]}],"example":"2025-11-14T14:07:33-05:00"},"first_scan_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descripción del primer evento de escaneo del transportista. Indica el estado inicial o el mensaje de procesamiento registrado cuando el envío fue escaneado por primera vez."},"children":[]}]}]}],"example":"Package is in transit to a UPS facility"},"first_scan_location":{"$ref":"#/components/schemas/TrackingLocation"},"tracking_events":{"type":"array","items":{"$ref":"#/components/schemas/TrackingEventWUtcOffset"}}}}},"components/schemas/TrackingStatusWithUtcOffsetResponse":{"id":"components/schemas/TrackingStatusWithUtcOffsetResponse","kind":"json-schema","title":"TrackingStatusWithUtcOffsetResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Envoltorio estándar para respuestas del estado de rastreo."},"children":[]}]}]}],"properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de respuesta de la API; \"ok\" indica éxito."},"children":[]}]}]}],"example":"ok"},"msg":{"type":"string","description":"Mensaje de respuesta legible por humanos.","example":"ok"},"data":{"$ref":"#/components/schemas/TrackingDataWUtcOffset"}}}},"components/schemas/PodRecipient":{"id":"components/schemas/PodRecipient","kind":"json-schema","title":"PodRecipient","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Un único destinatario de correo del POD."},"children":[]}]}]}],"required":["email","first_name","last_name"],"properties":{"email":{"type":"string","format":"email","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dirección de correo del destinatario que recibirá la carta POD."},"children":[]}]}]}],"example":"xxxxxxx@gmail.com"},"first_name":{"type":"string","description":"Nombre del destinatario.","example":"Lisa"},"last_name":{"type":"string","description":"Apellido del destinatario.","example":"Green"}}}},"components/schemas/PodSubmitRequest":{"id":"components/schemas/PodSubmitRequest","kind":"json-schema","title":"PodSubmitRequest","data":{"type":"object","required":["tracking_number","carrier_code","recipients"],"properties":{"tracking_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de seguimiento del transportista del envío para el que se solicita el POD."},"children":[]}]}]}],"example":"940XXXXXXXXXXXXXXXXX"},"carrier_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código del transportista. Actualmente solo se admite "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; cualquier otro valor se rechaza con "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipment.carrier_code_illegal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["USPS"],"example":"USPS"},"recipients":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destinatarios que recibirán la carta POD por correo. Debe contener de 1 a 3 destinatarios."},"children":[]}]}]}],"minItems":1,"maxItems":3,"items":{"$ref":"#/components/schemas/PodRecipient"}},"letter_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tipo de carta POD que se generará. Se transfiere al transportista. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROOF_OF_DELIVERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" es el valor utilizado actualmente."},"children":[]}]}]}],"example":"PROOF_OF_DELIVERY"}}}},"components/schemas/PodSubmitResponse":{"id":"components/schemas/PodSubmitResponse","kind":"json-schema","title":"PodSubmitResponse","data":{"type":"object","properties":{"transaction_message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirmación legible de que la solicitud de POD fue aceptada para su procesamiento."},"children":[]}]}]}],"example":"Your Proof of Delivery record is complete and will be processed shortly."}}}},"components/schemas/PodSubmitResponseEnvelope":{"id":"components/schemas/PodSubmitResponseEnvelope","kind":"json-schema","title":"PodSubmitResponseEnvelope","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Envoltorio de respuesta estándar de la API para el endpoint submit POD."},"children":[]}]}]}],"properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de resultado. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indica éxito; cualquier otro valor indica un error de negocio y "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" es "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ok"},"msg":{"type":"string","description":"Mensaje de resultado legible.","example":"ok"},"data":{"allOf":[{"$ref":"#/components/schemas/PodSubmitResponse"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carga útil de la respuesta; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cuando "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" no es "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/PickupAddress":{"id":"components/schemas/PickupAddress","kind":"json-schema","title":"PickupAddress","data":{"required":["phone","street","city","state","country","zip_code","address_type"],"type":"object","properties":{"first_name":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nombre correspondiente a la dirección. Obligatorio si no se proporciona "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Alice"},"last_name":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apellido correspondiente a la dirección. Obligatorio si no se proporciona "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Green"},"company_name":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nombre de la empresa o comercio correspondiente a la dirección. Obligatorio si no se proporcionan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" y "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ShipSaving"},"phone":{"type":"string","pattern":"^\\d{10}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de teléfono del contacto en el lugar de recolección. Debe tener exactamente 10 dígitos."},"children":[]}]}]}],"example":"1234567890"},"email":{"type":"string","format":"email","maxLength":50,"pattern":"^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dirección de correo electrónico del contacto en el lugar de recolección. Debe tener un formato de correo válido (por ejemplo, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name@example.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"it@shipsaving.com"},"street":{"type":"string","minLength":1,"maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"El número del edificio junto con el nombre de la vía o calle en la que se encuentra."},"children":[]}]}]}],"example":"xxxx Olive Street"},"street2":{"type":"string","maxLength":50,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"El identificador de unidad secundaria, como el número de apartamento (APT) o suite (STE), que define la ubicación exacta de la dirección dentro de un edificio."},"children":[]}]}]}],"example":"STE XXX"},"city":{"type":"string","minLength":1,"maxLength":28,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nombre de la ciudad de la dirección."},"children":[]}]}]}],"example":"San Francisco"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nombre del estado o código de estado de dos caracteres correspondiente a la dirección. La solicitud admite tanto el nombre completo del estado como el código de estado de dos caracteres."},"children":[]}]}]}],"example":"CA"},"zip_code":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código postal de la dirección. Debe ser un código ZIP de 5 dígitos (por ejemplo, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"900XX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") o estar en formato ZIP+4 (por ejemplo, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"900XX-XXXX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"941XX"},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de país de 2 letras. El valor de este campo será un "},"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":"código de dos dígitos ISO 3166-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"US"},"address_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica si la dirección de recolección es residencial o comercial."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Este indicador se utiliza para determinar los recargos específicos del transportista (por ejemplo, recargos de UPS por entrega residencial)."},"children":[]}]}]}],"example":"residential","enum":["residential","commercial"]}},"anyOf":[{"required":["first_name","last_name"]},{"required":["company_name"]}]}},"components/schemas/PackageLocationEnum":{"id":"components/schemas/PackageLocationEnum","kind":"json-schema","title":"PackageLocationEnum","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Esta es la ubicación de los paquetes listos para la recolección en la dirección de recolección."},"children":[]}]}]}],"type":"string","enum":["front_door","back_door","side_door","knock_on_door_ring_bell","mail_room","office","reception","in_at_mail_box","other"]}},"components/schemas/PickUpCarrierCodeEnum":{"id":"components/schemas/PickUpCarrierCodeEnum","kind":"json-schema","title":"PickUpCarrierCodeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código que identifica al transportista/proveedor de envío para la recolección. Este valor determina qué proveedor logístico debe gestionar la solicitud de recolección o de envío. Actualmente solo se admite USPS. En el futuro podrían incluirse códigos para otros transportistas (por ejemplo, UPS, FedEx)."},"children":[]}]}]}],"enum":["USPS"],"example":"USPS"}},"components/schemas/AddPickUpByShipmentRequest":{"id":"components/schemas/AddPickUpByShipmentRequest","kind":"json-schema","title":"AddPickUpByShipmentRequest","data":{"required":["package_location","carrier_code","tracking_nos"],"type":"object","properties":{"pickup_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fecha de recolección programada en formato "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Si se omite, el valor se establece automáticamente al siguiente día calendario según la zona horaria America/Los_Angeles, independientemente del momento en que se envíe la solicitud."},"children":[]}]}]}]},"pickup_location":{"$ref":"#/components/schemas/PickupAddress"},"package_location":{"$ref":"#/components/schemas/PackageLocationEnum"},"package_location_ext":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Información adicional sobre dónde pueden recolectarse los paquetes. Es obligatorio cuando "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"package_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" es "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". No se admiten caracteres chinos."},"children":[]}]}]}]},"carrier_code":{"$ref":"#/components/schemas/PickUpCarrierCodeEnum"},"tracking_nos":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de números de rastreo de envíos asociados a los paquetes que se incluirán en la solicitud de recolección."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TrackingNo"}}}}},"components/schemas/PickUpNo":{"id":"components/schemas/PickUpNo","kind":"json-schema","title":"PickUpNo","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número interno del registro de recolección utilizado para identificar una solicitud de recolección de USPS previamente programada. Este valor se devuelve durante el proceso de creación de la recolección y debe proporcionarse para cancelar la orden de recolección correspondiente."},"children":[]}]}]}],"example":"10000000000"}},"components/schemas/PickUpConfirmationNo":{"id":"components/schemas/PickUpConfirmationNo","kind":"json-schema","title":"PickUpConfirmationNo","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número de confirmación de la recolección asignado por USPS."},"children":[]}]}]}],"example":"WTC65384000"}},"components/schemas/AddPickupResult":{"id":"components/schemas/AddPickupResult","kind":"json-schema","title":"AddPickupResult","data":{"type":"object","properties":{"pickup_no":{"$ref":"#/components/schemas/PickUpNo"},"pickup_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fecha de recolección programada (YYYY-MM-DD)."},"children":[]}]}]}],"example":"2025-11-21"},"package_total_num":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número total de paquetes incluidos en la solicitud de recolección."},"children":[]}]}]}],"example":1},"package_total_weight":{"type":"number","description":"Peso total de todos los paquetes en libras (lb).","example":0.1},"carrier_code":{"$ref":"#/components/schemas/PickUpCarrierCodeEnum"},"carrier_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nombre del transportista que realiza la recolección."},"children":[]}]}]}],"example":"USPS"},"confirmation_number":{"$ref":"#/components/schemas/PickUpConfirmationNo"}}}},"components/schemas/CancelPickupRequest":{"id":"components/schemas/CancelPickupRequest","kind":"json-schema","title":"CancelPickupRequest","data":{"type":"object","required":["pickup_no"],"properties":{"pickup_no":{"$ref":"#/components/schemas/PickUpNo"}}}},"components/schemas/PickUpStatusEnum":{"id":"components/schemas/PickUpStatusEnum","kind":"json-schema","title":"PickUpStatusEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"El estado actual de la solicitud de recolección de USPS."},"children":[]}]}]}],"enum":["CONFIRMED","CANCELED"],"example":"CONFIRMED"}},"components/schemas/PickupVO":{"id":"components/schemas/PickupVO","kind":"json-schema","title":"PickupVO","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Información de la orden de recolección."},"children":[]}]}]}],"properties":{"status":{"$ref":"#/components/schemas/PickUpStatusEnum"},"pickup_no":{"$ref":"#/components/schemas/PickUpNo"},"pickup_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fecha de recolección programada en formato YYYY-MM-DD."},"children":[]}]}]}],"example":"2025-11-21"},"package_total_num":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número total de paquetes incluidos en la solicitud de recolección."},"children":[]}]}]}],"example":1},"package_total_weight":{"type":"number","description":"Peso total de todos los paquetes en libras (lb).","example":0.1},"carrier_code":{"$ref":"#/components/schemas/PickUpCarrierCodeEnum"},"carrier_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nombre del transportista que realiza la recolección."},"children":[]}]}]}],"example":"USPS"},"confirmation_number":{"$ref":"#/components/schemas/PickUpConfirmationNo"},"pickup_location_ext":{"$ref":"#/components/schemas/AddressTo"},"package_location":{"$ref":"#/components/schemas/PackageLocationEnum"},"package_location_ext":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Información adicional que describe la ubicación del paquete."},"children":[]}]}]}],"example":"Dejado detrás de la planta"},"tracking_nos":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de números de rastreo de envíos asociados a la recolección."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TrackingNo"},"example":["94055XXXXXXXXX123","92055XXXXXXXXX456"]}}}},"components/schemas/QueryPickupResponse":{"id":"components/schemas/QueryPickupResponse","kind":"json-schema","title":"QueryPickupResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Objeto de respuesta para la consulta paginada de registros de recolección."},"children":[]}]}]}],"properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"type":"object","properties":{"pickup_data_list":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de registros de órdenes de recolección."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PickupVO"}},"total_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número total de registros de recolección que coinciden con la consulta."},"children":[]}]}]}],"format":"int32"}}}}}},"components/schemas/QueryPackageLocationResponse":{"id":"components/schemas/QueryPackageLocationResponse","kind":"json-schema","title":"QueryPackageLocationResponse","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PackageLocationEnum"}}}}},"components/schemas/AddressIssue":{"id":"components/schemas/AddressIssue","kind":"json-schema","title":"AddressIssue","data":{"type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de incidencia legible por máquina."},"children":[]}]}]}],"example":"ADDRESS.SECONDARY.MISSING"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descripción legible por humanos de la incidencia."},"children":[]}]}]}],"example":"Falta el número de unidad secundaria en una dirección de edificio de varios pisos."}}}},"components/schemas/AddressCorrection":{"id":"components/schemas/AddressCorrection","kind":"json-schema","title":"AddressCorrection","data":{"type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código legible por máquina."},"children":[]}]}]}],"example":"ADDRESS.COMPONENT.CHANGED"},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descripción legible por humanos."},"children":[]}]}]}],"example":"Se modificó un componente de la dirección (por ejemplo, solo la dirección cardinal o el sufijo)."}}}},"components/schemas/ValidatedAddress":{"id":"components/schemas/ValidatedAddress","kind":"json-schema","title":"ValidatedAddress","data":{"allOf":[{"type":"object","properties":{"street":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Línea principal de la calle estandarizada."},"children":[]}]}]}],"example":"17XXX Tremont ST"},"street2":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Línea secundaria estandarizada, si está disponible."},"children":[]}]}]}],"example":null},"city":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ciudad/localidad estandarizada (en mayúsculas)."},"children":[]}]}]}],"example":"Los Angeles"},"state":{"type":"string","example":"CA"},"zip":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP o ZIP+4 estandarizado."},"children":[]}]}]}],"example":"02111-XXXX"},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de país ISO 3166-1 alpha-2."},"children":[]}]}]}],"example":"US"},"residential":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica si la dirección se clasifica como residencial."},"children":[]}]}]}],"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":"Indica si la validación detectó uno o más errores."},"children":[]}]}]}],"example":true},"corrected":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica si el validador corrigió alguno de los componentes."},"children":[]}]}]}],"example":true},"standardized":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica si la dirección está totalmente estandarizada."},"children":[]}]}]}],"example":false},"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errores de validación detectados durante el procesamiento."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/AddressIssue"}},"corrections":{"type":"array","description":"Correcciones aplicadas o sugerencias.","items":{"$ref":"#/components/schemas/AddressCorrection"}}}}]}},"components/schemas/AddressValidateResponse":{"id":"components/schemas/AddressValidateResponse","kind":"json-schema","title":"AddressValidateResponse","data":{"type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de resultado."},"children":[]}]}]}],"example":"ok"},"msg":{"type":"string","description":"Mensaje legible por humanos.","example":"ok"},"data":{"$ref":"#/components/schemas/ValidatedAddress"}}}},"components/schemas/ScanFormAddress":{"id":"components/schemas/ScanFormAddress","kind":"json-schema","title":"ScanFormAddress","data":{"allOf":[{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dirección de origen (remitente) impresa en el SCAN Form. Debe indicarse al menos uno de "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" o el par "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"company_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nombre de la empresa/negocio. Obligatorio si no se proporcionan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ShipSaving"},"first_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nombre del contacto. Obligatorio (junto con "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") si no se proporciona "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Alice"},"last_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apellido del contacto. Obligatorio (junto con "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") si no se proporciona "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Green"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Teléfono de contacto. Opcional, pero recomendado para que el transportista pueda comunicarse si es necesario."},"children":[]}]}]}],"example":"1234567890"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correo electrónico de contacto. Opcional."},"children":[]}]}]}],"example":"it@shipsaving.com"}}},{"$ref":"#/components/schemas/BasicAddress"}]}},"components/schemas/ScanFormCreateRequest":{"id":"components/schemas/ScanFormCreateRequest","kind":"json-schema","title":"ScanFormCreateRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Solicitud para crear un SCAN Form de USPS (PS Form 5630) para un conjunto de envíos ya comprados."},"children":[]}]}]}],"required":["address_data","tracking_nos"],"properties":{"address_data":{"$ref":"#/components/schemas/ScanFormAddress"},"tracking_nos":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Números de seguimiento de los envíos comprados que se incluirán en el SCAN Form. Cada envío debe pertenecer a USPS y estar en estado comprado y aún no enviado; un envío solo puede aparecer en un SCAN Form."},"children":[]}]}]}],"minItems":1,"items":{"$ref":"#/components/schemas/TrackingNo"}},"ship_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"La fecha de envío postal: la fecha en que los artículos del SCAN Form asociado se depositarán en la oficina de admisión (entry facility). Una fecha de calendario en formato full-date de ISO 8601 (YYYY-MM-DD), sin hora ni zona horaria. Opcional; si se omite, se usa la fecha actual por defecto."},"children":[]}]}]}],"example":"2026-07-21"}}}},"components/schemas/ScanFormCreateResponse":{"id":"components/schemas/ScanFormCreateResponse","kind":"json-schema","title":"ScanFormCreateResponse","data":{"type":"object","properties":{"scan_form_image":{"type":"string","description":"URL del PDF del SCAN Form generado.","example":"https://xxxxx/forms/2026-07-16/92XXXXXXXXX00000010794.pdf"}}}},"components/schemas/ScanFormCreateResponseEnvelope":{"id":"components/schemas/ScanFormCreateResponseEnvelope","kind":"json-schema","title":"ScanFormCreateResponseEnvelope","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Envoltorio de respuesta estándar de la API para el endpoint de creación de SCAN Form."},"children":[]}]}]}],"properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de resultado. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indica éxito; cualquier otro valor indica un error de negocio y "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" es "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ok"},"msg":{"type":"string","description":"Mensaje de resultado legible.","example":"ok"},"data":{"allOf":[{"$ref":"#/components/schemas/ScanFormCreateResponse"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carga útil de la respuesta; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cuando "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" no es "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ok"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"schema_156":{"kind":"json-schema","data":{"type":"object","properties":{"grant_type":{"type":"string","enum":["client_credentials"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debe ser "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"scope":{"type":"string","description":"Scopes opcionales separados por espacios.","example":"API"}},"required":["grant_type"]},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"number"},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"string"},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"string","example":"USPS"},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"string","example":"ok"},"msg":{"type":"string","example":"ok"},"data":{"$ref":"#/components/schemas/AddPickupResult"}}},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de error en formato separado por puntos."},"children":[]}]}]}]},"msg":{"type":"string","description":"Mensaje de error legible para humanos."},"data":{"example":null}}},"id":"schema_161"},"schema_162":{"kind":"json-schema","data":{"$ref":"#/components/schemas/PickUpConfirmationNo"},"id":"schema_162"},"schema_163":{"kind":"json-schema","data":{"type":"string","enum":["CONFIRMED","CANCELED"]},"id":"schema_163"},"schema_164":{"kind":"json-schema","data":{"$ref":"#/components/schemas/PickUpCarrierCodeEnum"},"id":"schema_164"},"schema_165":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":1},"id":"schema_165"},"schema_166":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":50},"id":"schema_166"},"schema_167":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_167"}},"exampleStore":{"paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample":{"value":{"grant_type":"client_credentials","scope":"API"},"key":"curlExample","summary":"Solicitud Client Credentials","id":"paths/~1oauth2~1token/post/requestBody/content/application~1x-www-form-urlencoded/examples/curlExample"},"paths/~1oauth2~1token/post/responses/200/content/application~1json/examples/success":{"value":{"access_token":"eyJraWQiOiIxIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJTU19MSVZFX3RoNXE5S0pUZTBrdllsM3pRSFFmU0Q3NW5ETGlZQ2s4dlowSSIsImF1ZCI6IlNTX0xJVkVfdGg1cTlLSlRlMGt2WWwzelFIUWZTRDc1bkRMaVlDazh2WjBJIiwibmJmIjoxNzU0MzU1MzM0LCJjb21wYW55X2lkIjoiMTgyMyIsInVzZXJfaWQiOiIyNDA3Iiwic2NvcGUiOlsiQVBJIl0sImlzX3ZhbGlkIjp0cnVlLCJpc3MiOiJodHRwczovL3gtYXBpLnNoaXBzYXZpbmcudXMiLCJleHAiOjE3NTQzNTcxMzQsImlhdCI6MTc1NDM1NTMzNCwidGVzdF9tb2RlbCI6ZmFsc2V9.CsOfJozZUmd5cFrSodxGuDH0xxRQjau_qKwyOuJBPWigJeZXeoB_FgOl7r2kDfVndrru7IkXw5XCEmePkTJ25nyTD7RiysInBOuU0a89mfj4czedC8qHIHU-EI1CfRopHan2dCHfSog5skNT6edAmQfSNndj6mV18Pr0AclnhEgIG-CsfYkxZXRITXeqFKqiLfbUt8A4YsqT9zhXHqqttk42rBNzSddgBcBkHNGdys-qltEPc7xB_NpV02tZbsfl-hcHbHZYt_ufT4u4BLy5g7p6bd4Tt2vgUbRrVx-umCWuT3dad5di2Loj9vs2boywSCQshM1Aj4Fxzg8Sk-GsBw","scope":"API","token_type":"Bearer","expires_in":1799},"key":"success","summary":"Respuesta exitosa","id":"paths/~1oauth2~1token/post/responses/200/content/application~1json/examples/success"},"paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badContentType":{"value":{"error_description":"OAuth 2.0 Parameter: grant_type","error":"invalid_request","error_uri":"https://datatracker.ietf.org/doc/html/rfc6749#section-5.2"},"key":"badContentType","summary":"Content-Type no es form-encoded","id":"paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badContentType"},"paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badGrantType":{"value":{"error_description":"OAuth 2.0 Parameter: grant_type","error":"unsupported_grant_type","error_uri":"https://datatracker.ietf.org/doc/html/rfc6749#section-5.2"},"key":"badGrantType","summary":"grant_type no soportado","id":"paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/badGrantType"},"paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/invalidScope":{"value":{"error":"invalid_scope"},"key":"invalidScope","summary":"Valor de scope inválido","id":"paths/~1oauth2~1token/post/responses/400/content/application~1json/examples/invalidScope"},"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentAlreadyInPickup":{"value":{"code":"pickup.shipment_already_in_pickup","msg":"Shipment is already in pickup (tracking no: {tracking_no}).","data":null},"key":"shipmentAlreadyInPickup","summary":"El envío ya tiene una recolección programada","id":"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentAlreadyInPickup"},"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentNotExist":{"value":{"code":"pickup.shipment_not_exist","msg":"Shipment does not exist.","data":null},"key":"shipmentNotExist","summary":"El número de rastreo no existe","id":"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/shipmentNotExist"},"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/missingAddressFields":{"value":{"code":"invalid_request_params","msg":"Missing or invalid request parameters\nInvalid request, 'address' requires a valid 'street1', 'city', 'state', 'zip', 'phone', and 'name' or 'company'.","data":null},"key":"missingAddressFields","summary":"Faltan campos obligatorios de la dirección (p. ej., phone)","id":"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/missingAddressFields"},"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/invalidAddress":{"value":{"code":"invalid_request_params","msg":"Missing or invalid request parameters\nAPI Version: /pickup/v3/, Error Code: 400, An invalid address was entered. Please verify address, including apartment, suite, etc.: An invalid address was entered. Please verify address, including apartment, suite, etc., Source Parameter: No parameter provided., USPS Error Code: 1007","data":null},"key":"invalidAddress","summary":"Dirección rechazada por la validación del transportista","id":"paths/~1api~1shipment~1pickup~1add/post/responses/400/content/application~1json/examples/invalidAddress"},"paths/~1api~1shipment~1pickup~1cancel/post/responses/400/content/application~1json/examples/pickupAlreadyCanceled":{"value":{"code":"pickup.pickup_is_canceled","msg":"Pickup is already canceled.","data":null},"key":"pickupAlreadyCanceled","summary":"La recolección ya fue cancelada","id":"paths/~1api~1shipment~1pickup~1cancel/post/responses/400/content/application~1json/examples/pickupAlreadyCanceled"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación mediante Bearer token (JWT)."},"children":[]}]}]}]},"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autenticación básica usando AppKey/AppSecret."},"children":[]}]}]}]}},"servers":[{"url":"https://x-api.shipsaving.com"}]},"options":{"hideDownloadButtons":true,"hideReplay":true,"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/@l10n/es/v2/openapi.json?download"},{"url":"/_bundle/@l10n/es/v2/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"ShipSaving New API"}},"baseSlug":"/es/v2/openapi","routesMapping":{}}