Saltar al contenido

SCAN Form

Crear SCAN Form

Solicitud

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.

Seguridad
BearerAuth
Cuerpoapplication/jsonrequerido
address_dataobject(ScanFormAddress)requerido

Dirección de origen (remitente) impresa en el SCAN Form. Debe indicarse al menos uno de company_name o el par first_name + last_name.

tracking_nosArray of strings, non-emptyrequerido

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.

ship_datestring, (date)

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.

Ejemplo:"2026-07-21"
POST
/api/scan_form/create_scan_form
curl -i -X POST \
  https://x-api.shipsaving.com/api/scan_form/create_scan_form \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "address_data": {
      "company_name": "ShipSaving",
      "first_name": "Alice",
      "last_name": "Green",
      "phone": "1234567890",
      "email": "it@shipsaving.com",
      "street": "xxxx Olive Street",
      "street2": "STE XXX",
      "city": "Los Angeles",
      "state": "CA",
      "zip_code": "021XX",
      "country": "US"
    },
    "tracking_nos": [
      "9234690381085700XXXXX"
    ],
    "ship_date": "2026-07-21"
  }'

Respuestas

OK

Cuerpoapplication/json
codestring

Código de resultado. ok indica éxito; cualquier otro valor indica un error de negocio y data es null.

Ejemplo:"ok"
msgstring

Mensaje de resultado legible.

Ejemplo:"ok"
dataobject(ScanFormCreateResponse)

Carga útil de la respuesta; null cuando code no es ok.

Response
{ "code": "ok", "msg": "ok", "data": { "scan_form_image": "https://xxxxx/forms/2026-07-16/92XXXXXXXXX00000010794.pdf" } }