Skip to main content
This tutorial guides you step by step through creating an “Inbound” record to notify the Quivo warehouse team that you are sending products. To fulfill orders, you need inventory available in a Quivo warehouse. This API flow creates an inbound record so the warehouse can plan for the arrival and process the inventory.

​
Prerequisites

Before you start, make sure you have:
All API examples in this guide use ${BASE_URL} as a placeholder. Replace it with the correct base URL configured for the correct environment. For more information see Environments page.

​
Create the inbound request

Create an inbound record when you are preparing to send products to a Quivo warehouse. You must tell the warehouse exactly what’s coming so they can plan for its arrival using the POST /inbounds endpoint. The following example shows a complete inbound payload with all required fields and some common optional fields.
Use this request to create a new inbound record and notify the warehouse about incoming stock.
curl -X POST "${BASE_URL}/inbounds" \
  -H "X-Api-Key: <YOUR_STATIC_API_KEY>" \
  -H "Authorization: <YOUR_SESSION_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "sellerId": <YOUR_SELLER_ID>,
    "warehouseId": <YOUR_WAREHOUSE_ID>,
    "deliverySlipNumber": "<YOUR_DELIVERY_SLIP_NUMBER>",
    "estimatedArrivalTime": "<YYYY-MM-DDTHH:mm:ssZ>",
    "trackingNumber": "<YOUR_TRACKING_NUMBER>",
    "carrier": "<YOUR_CARRIER>",
    "deliveryInfo": {
      "cargoType": "CARTON",
      "quantity": <NUMBER_OF_CARTONS>
    },
    "inboundPositions": [
      {
        "sku": "<YOUR_SKU>",
        "quantity": <QUANTITY>
      },
      {
        "sku": "<YOUR_SKU>",
        "quantity": <QUANTITY>
      }
    ],
    "shipFrom": {
      "company": "<YOUR_COMPANY_NAME>",
      "address1": "<YOUR_STREET_ADDRESS>",
      "city": "<YOUR_CITY>",
      "country": "<YOUR_COUNTRY_CODE>",
      "zip": "<YOUR_ZIP_CODE>"
    }
  }'
For the complete inbound request schema—including all required and optional fields—see the Inbounds section in the API Reference.

​
Track inbound status

After creating an inbound record, use this endpoint to monitor the processing status. Once your shipment arrives, the warehouse team starts scanning the items. Check the status of this process via the API using the GET /inbounds/{inboundId} endpoint.
Use this request to retrieve the current status of an existing inbound by its ID.
curl -X GET "${BASE_URL}/inbounds/<YOUR_INBOUND_ID>" \
  -H "X-Api-Key: <YOUR_STATIC_API_KEY>" \
  -H "Authorization: <YOUR_SESSION_TOKEN>"

​
Where to go next

Now that you have sent inventory to the warehouse, continue with these guides:

Create a Fulfillment Order

Once Quivo processes your inventory, create fulfillment orders to start shipping products to customers.

Track an Order

Monitor order status and retrieve tracking information for shipments.