Hold order

POST /v1/hold_order

Puts an existing order on hold. Orders that are already in processing can't be held.

Request

Send username, password and secretkey along with a data object. See Making requests.

Request bodycURL

{
  "username": "YOUR_USERNAME",
  "password": "YOUR_PASSWORD",
  "secretkey": "YOUR_SECRET_KEY",
  "data": {
    "xid": "23542123",
    "order_id": "1001",
    "msg": "due to technical issue holding my order"
  }
}

curl -X POST https://gatewaybeta.marcofinearts.com/v1/hold_order \
  -H "Content-Type: application/json" \
  -d '{
    "username": "YOUR_USERNAME",
    "password": "YOUR_PASSWORD",
    "secretkey": "YOUR_SECRET_KEY",
    "data": {
      "xid": "23542123",
      "order_id": "1001",
      "msg": "due to technical issue holding my order"
    }
  }'

data fields

Field	Required	Validation	Notes
xid	Conditional		Your order number. Required if order_id is not passed.
order_id	Conditional		Marco Fine Arts order ID. Required if xid is not passed.
msg	Yes		Reason for the request.

Response

SuccessError

{
  "res": "success"
}

{
  "res": "error",
  "code": "000",
  "message": "Error message."
}

Error codes

Code	Error	Description
301	Authentication failed	Your account is invalid or does not have API access. Check username, password and secretkey.
302	Missing field	One or more required fields are missing.
314	Missing field	order_id or xid is required.
315	Invalid data	Invalid order_id or xid.
316	Missing field	msg is required.
318	Error	Order is already in processing and can't be put on hold.