Received Shipments

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

GET/api/v1/received

List all received shipments

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

Required attributes

Name
status
Type
received | checked-in
Description
The status for the received shipments.

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/received

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

Response

{
  "status": "success",
  "data": {
    "received_orders": [
      {
        "brand_sku": null,
        "carrier": "Unknown",
        "check_in_notes": null,
        "client_notes": null,
        "client_notes_at": null,
        "color": "ads",
        "created_at": "Thu, 27 Mar 2025 14:22:08 GMT",
        "date": "Thu, 27 Mar 2025 00:00:00 GMT",
        "do_check": true,
        "id": 14018,
        "item_name": "asd",
        "location": "asd",
        "order_name": null,
        "quantity": 2,
        "received_order_id": "6cfbc6a6-694d-4a8d-b68d-e88b77c6744a",
        "related_orders": [],
        "retailer": null,
        "size": "asd",
        "status": "received",
        "team_member_notes": null,
        "team_member_notes_at": null,
        "tracking_number": "123",
        "tracking_status": null,
        "trackings": [],
        "upc": "asd",
        "updated_at": null,
        "user_id": "cus_TwrZZI2vchR6"
      }
    ],
  }
}