Add a parcel to a pending order

Request

Adds one parcel to a pending order and returns the new parcel on its own, not the whole order. A label is generated per parcel. Once the order has left pending the call is rejected with 422.

Security

bearerToken or oauthToken

Path

client_order_idintegerrequired

The order id, order.id in the create response.

Example:10000001

Bodyapplication/json

The parcel to add.

namestring, [ 1 .. 255 ] charactersrequired

Item's name

Example:"item1"

curl -i -X POST \
  https://api-ae.quiqup.com/orders/10000001/parcels \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "item1"
  }'

Responses

The parcel that was added.

Bodyapplication/json

allowed_eansArray of strings

Always empty

checkedboolean

Always false

checked_atstring or null

Always null

eanstring or null

Always null

gidstring

Global ID of the order the parcel belongs to

idinteger

Parcel ID

metadataobject

Always empty

namestring

Parcel name, as sent

notesstring or null

Always null

parcel_barcodestring

Barcode printed on the label

parcel_barcode_generated_bystring

Who generated the barcode

pricestring

Always "0.0"

quantityinteger

Always 1

statestring or null

Always null

total_coststring

Always "0.0"

Response

{
  "allowed_eans": [
    "string"
  ],
  "checked": true,
  "checked_at": "string",
  "ean": "string",
  "gid": "string",
  "id": 0,
  "metadata": {},
  "name": "string",
  "notes": "string",
  "parcel_barcode": "string",
  "parcel_barcode_generated_by": "string",
  "price": "string",
  "quantity": 0,
  "state": "string",
  "total_cost": "string"
}