Obtener registros de recolección

Referencia de la API

Obtener registros de recolección

Solicitud

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.

Seguridad

BearerAuth

Consulta

confirmation_numberstring(PickUpConfirmationNo)

Número de confirmación de la recolección asignado por USPS.

Ejemplo:confirmation_number=WTC65384000

statusstring

Filtro por estado de la recolección.

Enum:"CONFIRMED""CANCELED"

carrier_codestring(PickUpCarrierCodeEnum)

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:carrier_code=USPS

pageinteger, (int32)

Número de página para los resultados paginados (comenzando desde 1).

Predeterminado:1

page_sizeinteger, (int32)

Número de resultados a devolver por página.

Predeterminado:50

order_bybooleanrequerido

Indicador de orden que controla la ordenación temporal:

true: orden cronológico (más antiguo → más reciente)
false: orden cronológico inverso (más reciente → más antiguo)

GET

/api/shipment/pickup/list

curl -i -X GET \
  'https://x-api.shipsaving.com/api/shipment/pickup/list?confirmation_number=WTC65384000&status=CONFIRMED&carrier_code=USPS&page=1&page_size=50&order_by=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

Cuerpoapplication/json

codestring

Ejemplo:"ok"

msgstring

Ejemplo:"ok"

dataobject

Response

{
  "code": "ok",
  "msg": "ok",
  "data": {
    "pickup_data_list": [ … ],
    "total_count": 0
  }
}