Skip to content
Veeqo, An Amazon company Developers
Login Signup

Create a Shipment

POST
/shipments

Creates a shipment against an order’s allocation, marking the order as shipped. Use this to record a fulfilment in Veeqo — including orders shipped outside of Veeqo — without purchasing a label.

A carrier_id is required. For orders fulfilled externally, or with a carrier not integrated with Veeqo, use the built-in “Other” carrier (carrier_id: 3). The full list of built-in carrier IDs is in the Shipments overview. With the “Other” carrier, send the name of the carrier that delivers the parcel in shipment_extra_attributes.external_carrier_name: Veeqo then sends that name, not “Other”, as the carrier with the tracking number to Amazon, eBay and Shopify.

Each call ships one allocation, so an order with several allocations takes one call for each. Veeqo refuses an allocation that is already shipped, a cancelled order and an allocation that Amazon FBA fulfils, with a 400 and the reason in error_messages. An order awaiting payment keeps that status once its shipment is created.

Request Body

Section titled “Request Body ”
object
shipment
required
object
tracking_number_attributes

Only required if you have a value for tracking_number

object
tracking_number
required

Tracking number for the shipment (if applicable)

string
12345679ABC
carrier_id
required

Veeqo ID of the carrier for the shipment

number
3
shipment_extra_attributes
object
external_carrier_name

The name of the carrier that delivers the parcel, for a shipment with the “Other” carrier. Veeqo sends it as the carrier, with the tracking number, to Amazon, eBay and Shopify.

string
Royal Mail
notify_customer
required

Whether to notify the buyer via email from Veeqo

boolean
update_remote_order

Overrides the channel’s tracking sync for the order while this is its newest shipment. true forces the push on, false forces it off, and omitting it (or sending null) defers to the channel’s own update_remote_order. This is an override, not the primary control which exists on the channel setting.

boolean
nullable
allocation_id
required

ID of the allocation

number
1
order_id
required

ID of the order

number
1
Example
{
  "shipment": {
    "tracking_number_attributes": {
      "tracking_number": "12345679ABC"
    },
    "carrier_id": 3,
    "shipment_extra_attributes": {
      "external_carrier_name": "Royal Mail"
    },
    "notify_customer": false,
    "update_remote_order": false
  },
  "allocation_id": 1,
  "order_id": 1
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

object
id
number
created_at
string
allocation_id
number
carrier_id
number
shipped_by_id
number
weight
number
notify_customer
boolean
update_remote_order

The override as stored on this shipment. null means no override was set, so the channel’s own update_remote_order decides.

boolean
nullable
tracking_number
object
id
number
tracking_number
string
order_id
number
carrier
object
id
number
name
string
outbound_label_charges
object
unit
string
value
number
Example
{
  "id": 3,
  "created_at": "2016-11-14T15:05:35.709Z",
  "allocation_id": 1,
  "carrier_id": 3,
  "shipped_by_id": 1402,
  "weight": 20,
  "notify_customer": false,
  "update_remote_order": false,
  "tracking_number": {
    "id": 12618396,
    "tracking_number": " 12345679ABC"
  },
  "order_id": 5753042,
  "carrier": {
    "id": 3,
    "name": "Other"
  },
  "outbound_label_charges": {
    "unit": "USD",
    "value": 5.52
  }
}