Programar recolección

Referencia de la API

Solicitud

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.

Seguridad

BearerAuth

Cuerpoapplication/jsonrequerido

pickup_datestring

Fecha de recolección programada en formato YYYY-MM-DD. 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.

pickup_locationobject(PickupAddress)

Any of:

package_locationstring(PackageLocationEnum)requerido

Esta es la ubicación de los paquetes listos para la recolección en la dirección de recolección.

Enum:"front_door""back_door""side_door""knock_on_door_ring_bell""mail_room""office""reception""in_at_mail_box""other"

package_location_extstring, <= 255 characters

Información adicional sobre dónde pueden recolectarse los paquetes. Es obligatorio cuando package_location es other. No se admiten caracteres chinos.

carrier_codestring(PickUpCarrierCodeEnum)requerido

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).

Value:"USPS"

Ejemplo:"USPS"

tracking_nosArray of stringsrequerido

Lista de números de rastreo de envíos asociados a los paquetes que se incluirán en la solicitud de recolección.

POST

/api/shipment/pickup/add

curl -i -X POST \
  https://x-api.shipsaving.com/api/shipment/pickup/add \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pickup_date": "string",
    "pickup_location": {
      "first_name": "Alice",
      "last_name": "Green",
      "company_name": "ShipSaving",
      "phone": "1234567890",
      "email": "it@shipsaving.com",
      "street": "xxxx Olive Street",
      "street2": "STE XXX",
      "city": "San Francisco",
      "state": "CA",
      "zip_code": "941XX",
      "country": "US",
      "address_type": "residential"
    },
    "package_location": "front_door",
    "package_location_ext": "string",
    "carrier_code": "USPS",
    "tracking_nos": [
      "9234690381085700XXXXX"
    ]
  }'

Respuestas

Cuerpoapplication/json

codestring

Ejemplo:"ok"

msgstring

Ejemplo:"ok"

dataobject(AddPickupResult)

Response

{
  "code": "ok",
  "msg": "ok",
  "data": {
    "pickup_no": "10000000000",
    "pickup_date": "2025-11-21",
    "package_total_num": 1,
    "package_total_weight": 0.1,
    "carrier_code": "USPS",
    "carrier_name": "USPS",
    "confirmation_number": "WTC65384000"
  }
}