Create a Shipment

POST

/shipments

Request Body

object

shipment

string

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

notify_customer

required

Whether to notify the buyer via email from Veeqo

boolean

update_remote_order

required

Whether to update the remote store (if using an integrated solution such as Amazon)

boolean

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,
    "notify_customer": false,
    "update_remote_order": false
  },
  "allocation_id": 1,
  "order_id": 1
}

Responses

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

boolean

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
  }
}