Order API - Update check first

Update Check First

POST *base*/check-first Authentication : API Key

This will update the status of a check-first warehouse on an order.

Updating a check first for an order is irreversible. Once an order has been accepted or rejected, it can no longer be changed.

Parameters

orderNumber
int
required

Order ID to update the Check first.

warehouseId
int
required

Warehouse ID associated with the Check first order.

accepted
bool
required

Whether to accept or reject the Check First warehouse. true to accept, false to reject.

Request example

POST <base>/check-first HTTP/1.1
Content-type: application/json

{
   "orderNumber": 123,
   "warehouseId": 321,
   "accepted": true
}

Response

200 Content-type: application/json

status
string
required

ok if success, else no.

msg
string|object
optional

If status returns no, this value should send back a message why it failed.

orderNumber
string
optional

Error message describing an issue with the provided order number.

warehouseId
string
optional

Error message describing an issue with the provided warehouse id.

accepted
string
optional

Error message describing an issue with the provided accepted value.

Response example

HTTP/1.1 200 OK
Content-type: application/json

{
   "status": "ok"
}

Error examples

{
   "status": "no",
   "msg": {
      "orderNumber": "invalid value",
      "warehouseId": "required",
      "accepted": "invalid value"
   }
}
{
   "msg": "order does not exist",
   "status": "no"
}
{
   "msg": "failed to allocate stock",
   "status": "no"
}

Previous article: Order API - Update stock
Next article: Integration API (SOAP)