For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update

This is the endpoint for updating orders. It can be used for single or multiple orders and it takes an array object.

Update Order

Endpoint => /order

PUT /order

Headers

Name
Type
Description

Authorization *

String

Your Bearer Token

secret-key*

String

Your Secret Key

Request Body

Name
Type
Description

recipientAddress

String

Recipient Address (Delivery destination)

recipientState

String

Must be any of the 36 states or FCT

recipientName

String

Recipient Name

recipientPhone

String

Recipient Phone or Mobile number

orderNo*

String

Order number

{
  "status": "Success",
  "description": "Update Batch Request Processed",
  "Response": {
    "37P727012321": "Order Successfully Updated",
    "JHAZ27012319": "Order Successfully Updated"
  }
}
{
    "status": "Error",
    "description": "Organization Secret Key is Required"
}

Good to know: Upon successfully creating the order, the API returns an array object that consist of the update feedback for each request.

Last updated