Inbound Shipments

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

GET/api/v1/inbound

List all inbound shipments

This endpoint allows you to retrieve a paginated list of all your inbound 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/inbound

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

Response

{
  "status": "success",
  "data": {
    "inbound": [
        {
            "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
        }
    ]
  }
}

POST/api/v1/inbound

Create a shipment

This endpoint allows you to create a new inbound shipment.

Required attributes

Name
sold_as
Type
individual | multi-pack | bundle
Description
The sold as type for the shipment.
Name
units_per_pack
Type
integer
Description
Only required if sold_as is multi-pack or bundle.
Name
date
Type
string
Description
The date for the shipment
Name
retailer
Type
string
Description
The supplier for the shipment.
Name
itemName
Type
string
Description
The item name for the shipment.
Name
quantity
Type
integer
Description
The quantity of units in the shipment.
Name
size
Type
string
Description
The size of units in the shipment.
Name
color
Type
string
Description
The color of units in the shipment.
Name
cogs
Type
string
Description
The unit cost in the shipment.

Optional attributes

Name
orderNumber
Type
string
Description
The order number for the shipment.
Name
brandSKU
Type
string
Description
The brand sku for the shipment.
Name
listPrice
Type
string
Description
The list price for the shipment.
Name
asin
Type
string
Description
The asin for the shipment.
Name
amazonSKU
Type
string
Description
The amazon sku for the shipment.
Name
tracking_numbers
Type
string[]
Description
A list of the tracking numbers for the shipment.

Request

POST

/api/v1/inbound

curl https://api.urvafreight.com/api/v1/inbound \
  -H "Authorization: Bearer {token}" \

Response

{
  "status": "success",
  "message": "Created a shipment",
  "errors": []
}