POST /void

Void an order ---- [auth scope: api-user]

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orderReferencestringRequired

Order Reference for order

Body

application/json

voidReferencestringRequired

The order voiding reference.

descriptionstringOptional

The description of the capture.

amountnumberRequired

The voided amount for the items shipped

Responses

200Success

application/json

400Error

application/json

401Error

application/json

404Error

application/json

post

/orders/{orderReference}/void

HTTPcURLJavaScriptPython

POST /orders/{orderReference}/void HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "voidReference": "text",
  "description": "text",
  "amount": 1
}

{
  "voidReference": "text",
  "voidedId": "text",
  "amount": 1
}

Sample Request/Response

Request

{
    "voidReference": "LatEHAuPtpN2HSrTMK-1",
    "description": "Please void this order",
    "amount": 100
}

Response

{
    "voidReference": "LatEHAuPtpN2HSrTMK-1",
    "amount": 100,
    "voidedId": "LatEHAuPtpN2HSrTMK-1"
}