Introduction
When an event from order changes, e.g. order state changes to PREPARE_TO_SHIPPING, the system will sends a HTTP POST request to your webhook URL
Currently the URL is configured internally by admin from Deeple system. Please contact sales@deeple.ai for further information.
Request headers
| Description | |
|---|---|
| PID | Your project id |
| TIMESTAMP | timestamp on request |
| SIGNATURE | Your hash signature |
You can use provided PID and SECRET for signature validation
Request body
The request body contains a JSON object of order information
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| receiverName | string(50) | R | Receiver name for order |
| firstName | string(30) | R | First name for order |
| lastName | string(30) | R | Last name for order |
| streetAddress | string(50) | R | Street address for order |
| streetAddress2 | string(50) | O | Street address2 for order |
| district | string(50) | R | District for order |
| subDistrict | string(50) | R | Sub-district for order |
| province | string(50) | R | Province for order |
| postalCode | string(10) | R | Postal code for order |
| phoneNumber | string(10) | R | Phone number for order |
| string(50) | R | Email for order | |
| orderNumber | string(12) | R | Order's number |
| state | string(30) | R | Order's state |
| platform | string(15) | R | Order's platform |
| note | string(50) | O | Order's note from customer |
| grandTotal | number(10) | R | Order’s grand total |
| totalPrice | number(10) | R | Order’s total price |
| vatPrice | number(10) | R | Order's vat price |
| vatValue | number(1) | R | Order's vat value |
| vatOptions | string(10) | R | Order's vat option |
| discountTotalPrice | number(10) | R | Order's total discount price |
| platform | string(10) | R | Order's platform |
| items | list of item | R | Selected Items’ in order |
| createdAt | string(20) | R | Order's created date |
| updatedAt | string(20) | R | Order's updated date |
Responses
The server must return status code 200 after it receives the POST request sent from Deeple system.
Remarks
- POST requests sent from Deeple system will sent for 5 times if the request fails