Create Shipment

POST 
/orders/:lookupKey/:lookupValue/shipments

Create a shipment which marks orderItems as delivered and adds track and trace information to the order.

Fields

Name	Required
deliveryId	yes
deliveryDate	no
supplier	yes
colli	no
notes	no
shipDate	no
items	yes
items.sku	yes
items.name	yes
items.supplierCode	no
items.quantity	yes
items.cancelled	no Default is 0
items.notes	no
items.externalLineId	no
tracktrace	no
tracktrace.carrierName	yes
carrierName.code	yes

Request

Path Parameters

lookupKey stringrequired

Use id or externalId

lookupValue stringrequired

The id or externalId of the order

application/json

Body

colli number
deliveryDate string
deliveryId string

items

object[]

Array [

externalLineId string

name string

notes string

quantity number

sku string

supplierCode string

]

notes string
supplier string

tracktrace

object[]

Array [

carrierName string

code string

]

Responses

200

Create Shipment - 200

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

data

object

object
messages string[]
total number

Example (from schema)

{
  "data": {},
  "messages": [
    "Shipment created"
  ],
  "total": 1
}

Create Shipment - 200

{
  "data": {},
  "messages": [
    "Shipment created"
  ],
  "total": 1
}

400

Create Shipment - 400 (invalid schema)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#/items/0: required key [sku] not found",
      "#/items/0: extraneous key [code] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Create Shipment - 400 (invalid schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#/items/0: required key [sku] not found",
      "#/items/0: extraneous key [code] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

404

Create Shipment - 404 (order not found)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 15001,
    "messages": [
      "Order with id [300] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/15001",
    "status": 404,
    "type": "OrderNotFound"
  }
}

Create Shipment - 404 (order not found)

{
  "error": {
    "code": 15001,
    "messages": [
      "Order with id [300] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/15001",
    "status": 404,
    "type": "OrderNotFound"
  }
}

Loading...