Create a consignment

post https://domain_prefix.vendhq.com/api/2.0/consignments

Creates a new consignment.

The consignment type can be SUPPLIER, OUTLET, STOCKTAKE or RETURN. The workflows for these are:

  • SUPPLIER workflow: OPEN -> SENT -> DISPATCHED -> RECEIVED (can be CANCELLED at any time after OPEN)
  • OUTLET workflow: OPEN -> SENT -> RECEIVED (can be CANCELLED at any time after OPEN)
  • RETURN workflow: OPEN -> SENT or CANCELLED
  • STOCKTAKE workflow: STOCKTAKE or STOCKTAKE_SCHEDULED -> STOCKTAKE_IN_PROGRESS -> STOCKTAKE_IN_PROGRESS_PROCESSED -> STOCKTAKE_COMPLETE (can be CANCELLED or CLOSED at any time)
Language
Authorization
Bearer
JWT
Click Try It! to start a request and see the response here!