iotoms Docs

Cancel a sales order

POST
/api/v1/sales/orders/{id}/cancel

Cancels an order with a mandatory reason. Refused once an invoice has been issued for the order, or if it is already cancelled.

How to use it

  1. Take the order id from List sales orders; orders with an issued invoice cannot be cancelled.
  2. Send a non-blank reason.
  3. The order becomes CANCELLED with the reason and time recorded, and can no longer be edited or invoiced.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Request Body

application/json
  1. body
reason*string

Why the order is being cancelled. Required and must not be blank; stored on the order.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was handled, ERROR otherwise.

message*string

Short human-readable message describing the outcome, e.g. which record was fetched or saved.

data?

The sales order.

Example Request
curl -X POST 'https://beta.iotoms.com/api/v1/sales/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel' \  -H 'X-TenantID: your-tenant-code' \  -H 'Content-Type: application/json' \  -d '{  "reason": "string"}'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "orderNumber": "string",    "customerStoreId": 0,    "customerStoreName": "string",    "customerNumber": "string",    "customerNameSnapshot": "string",    "storeId": 0,    "status": "DRAFT",    "effectiveStatus": "DRAFT",    "orderDate": "2019-08-24",    "requestedDeliveryDate": "2019-08-24",    "bookedBy": "string",    "orderSource": "FIELD_APP",    "currency": "string",    "routeId": 0,    "subtotal": 0,    "discountTotal": 0,    "taxTotal": 0,    "grandTotal": 0,    "notes": "string",    "cancelReason": "string",    "overridePending": true,    "overrideApprovedBy": "string",    "overrideApprovedAt": "2019-08-24T14:15:22Z",    "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",    "invoiceNumber": "string",    "invoiceBlockedReason": "string",    "submittedAt": "2019-08-24T14:15:22Z",    "confirmedAt": "2019-08-24T14:15:22Z",    "cancelledAt": "2019-08-24T14:15:22Z",    "createdBy": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "lines": [      {        "id": 0,        "itemId": "string",        "description": "string",        "uomCode": "string",        "uomFactor": 0,        "quantity": 0,        "baseQuantity": 0,        "unitPrice": 0,        "discountAmount": 0,        "taxRate1": 0,        "taxRate2": 0,        "taxAmount": 0,        "lineTotal": 0,        "lineNumber": 0      }    ],    "revisions": [      {        "revisionNo": 0,        "changedBy": "string",        "changedAt": "2019-08-24T14:15:22Z",        "reason": "string",        "changes": "string"      }    ]  }}