Inventory Shipments

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


GET/api/v1/inventory

List all inventory shipments

This endpoint allows you to retrieve a paginated list of all your inventory 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/inventory
curl -G https://api.urvafreight.com/api/v1/inventory \
  -H "Authorization: Bearer {token}" \
  -d limit=200 \
  -d offset=0

Response

{
  "status": "success",
  "data": {
    "inventory": [
        {
            "admin_notes": null,
            "amazon_sku": null,
            "asin": null,
            "brand_sku": null,
            "check_ins": [],
            "color": "asd",
            "created_at": "Tue, 25 Mar 2025 21:05:40 GMT",
            "date": "Tue, 25 Mar 2025 00:00:00 GMT",
            "fulfilled_by": "parcel-forwarding",
            "id": 20386,
            "image_urls": [],
            "item_name": "asd",
            "list_price": null,
            "order_id": "64c65048-b335-4921-b09d-68d4142d5655",
            "order_number": "asd",
            "quantity": 2,
            "quantity_received": 0,
            "quantity_remaining": null,
            "quantity_removed": 0,
            "retailer": "as",
            "shipment_id": null,
            "shipment_value": 400,
            "shipping_labels": [],
            "size": "asd",
            "sold_as": "individual",
            "status": "inbound",
            "trackings": [
                {
                    "tracking": "234235232"
                }
            ],
            "unit_cost": 200,
            "unit_status": "pending",
            "units_per_pack": null,
            "upc": null,
            "updated_at": "Tue, 25 Mar 2025 21:05:40 GMT",
            "user_id": "cus_TwrZZI2vchdd",
            "user_notes": null
        }
    ]
  }
}

Was this page helpful?