Outbound Shipments

This page will dive into the different endpoints for outbound shipments.


GET/api/v1/outbound

List all outbound shipments

This endpoint allows you to retrieve a paginated list of all your outbound shipments. By default, a maximum of 200 shipments are shown per page.

Optional attributes

  • Name
    limit
    Type
    integer
    Description

    Limit the number of shipments returned.

  • Name
    offset
    Type
    integer
    Description

    Select the page of shipments returned.

Request

GET
/api/v1/outbound
curl -G https://api.urvafreight.com/api/v1/outbound \
  -H "Authorization: Bearer {token}" \
  -d limit=200 \
  -d offset=0

Response

{
  "status": "success",
  "data": {
    "shipments": [
      {
        "admin_status": null,
        "boxes": [],
        "created_at": "Tue, 04 Mar 2025 22:11:19 GMT",
        "date": "Tue, 04 Mar 2025 00:00:00 GMT",
        "date_requested": null,
        "date_shipped": "Tue, 04 Mar 2025 22:11:19 GMT",
        "name": "awdawd",
        "notes": "",
        "services": [],
        "shipment_id": "ec37a9b2-e42e-49d7-a32b-5190756345c7",
        "shipment_value": 200,
        "status": "shipped",
        "total_quantity_shipped": 1,
        "user_id": "cus_TwrZZI2vchR6"
      }
    ],
  }
}

Was this page helpful?