Skip to main content
POST
/
inbounds
Create inbound shipment
curl --request POST \
  --url https://api.quivo.co/inbounds \
  --header 'Content-Type: application/json' \
  --data '
{
  "sellerId": 123,
  "warehouseId": 123,
  "shipFrom": {
    "name1": "<string>",
    "name2": "<string>",
    "company": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "address3": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "phone": "<string>",
    "email": "<string>"
  },
  "estimatedArrivalTime": "2023-11-07T05:31:56Z",
  "deliverySlipNumber": "<string>",
  "inboundPositions": [
    {
      "quantity": 2,
      "sku": "<string>",
      "lot": "<string>",
      "location": "<string>",
      "expirationDate": "2023-12-25",
      "serialNumbers": [
        "<string>"
      ],
      "positionNumber": "<string>",
      "customAttributes": "{\"attr1\":\"val1\"}"
    }
  ],
  "deliveryInfo": {
    "cargoType": "CARTON",
    "quantity": 2
  },
  "trackingNumber": "<string>",
  "customAttributes": "{\"attr1\":\"val1\"}",
  "movementReferenceNumber": "<string>",
  "carrier": "<string>",
  "comments": "<string>",
  "deliverySlipDate": "2023-11-07T05:31:56Z",
  "externalIdentifier": "<string>",
  "tags": [
    "<string>"
  ],
  "inboundReference": "<string>"
}
'
{
  "status": "<string>",
  "inboundId": 123,
  "field": "<string>",
  "message": "<string>"
}

Body

application/json

Data to create a new resource at /inbounds

Request payload for creating a new inbound shipment or inbound delivery. Contains inbound shipment details including expected items, quantities, warehouse destination, and delivery dates.

sellerId
integer<int64>
required

Seller ID.

warehouseId
integer<int64>
required

Warehouse ID.
A list of warehouse identifiers and names can be obtained by executing GET /warehouses

shipFrom
object
required

Detailed address information

estimatedArrivalTime
string<date-time>
required

Estimated date of arrival

deliverySlipNumber
string
required

Delivery slip number

inboundPositions
object[]
required

List of inbound positions

deliveryInfo
object
required

Detailed information for inbounddeliveryinfo

trackingNumber
string
required

Optional tracking number

customAttributes
object

Optional custom attributes of this inbound.

Example:

"{\"attr1\":\"val1\"}"

movementReferenceNumber
string

Optional movement reference number. Unique identifier assigned to customs declarations within the UK and EU

Maximum string length: 1024
carrier
string

Optional carrier

comments
string

Comments.

deliverySlipDate
string<date-time>

Optional date of the creation of the delivery slip

externalIdentifier
string

Optional identifier. Can be a freight number or container number

Maximum string length: 25
tags
string[]

Optional tags of this inbound

inboundReference
string

Optional additional reference of this Inbound.

Maximum string length: 40

Response

Returns the result of the inbound shipment creation, including assigned identifiers and validation status.

Result of creating an inbound shipment. Contains inbound shipment identifier and processing status.

status
string

The current status of the item

inboundId
integer<int64>

The unique identifier for the inbound

field
string

The field value

message
string

Message content