Create an order
POST/orders
Create an order for a service
Request
- application/json
Body
- Execution date (for scheduled orders)
- Format: YYYY-MM-DD HH:MM
- Required for services with types:
Default
,Poll
,SEO
,Comment Likes
,Mentions
,Mentions Hashtag
,Mentions with Hashtags
,Mentions User Followers
,Mentions Media Likers
- Required for services with types:
Custom Comments
,Custom Comments Package
,Custom Replies
- Required for services with types:
Comment Likes
,Comment Replies
,Mentions User Followers
- Required for services with types:
Mentions
,Mentions with Hashtags
,Mentions Custom List
- 1 username per line separated by \r\n or \n
- Required for services with types:
Poll
- Required for services with types:
SEO
- 1 keyword per line separated by \r\n or \n
- Required for services with types:
Mentions Hashtag
- Required for services with types:
Mentions with Hashtags
- 1 hashtag per line separated by \r\n or \n
- Required for services with types:
Mentions Media Likers
Service ID
URL or username
Possible values: >= 1
Responses
- 200
- 422
- application/json
- Schema
- Example (from schema)
Schema
- Returned for orders with service types:
Custom Comments
,Custom Comments Package
,Custom Replies
- Returned for orders with service types:
Comment Likes
,Comment Replies
,Mentions User Followers
- Returned for orders with service types:
Mentions
,Mentions with Hashtags
,Mentions Custom List
- 1 username per line separated by \r\n or \n
- Returned for orders with service types:
Poll
- Returned for orders with service types:
SEO
- 1 keyword per line separated by \r\n or \n
- Returned for orders with service types:
Mentions Hashtag
- Returned for orders with service types:
Mentions with Hashtags
- 1 hashtag per line separated by \r\n or \n
- Returned for orders with service types:
Mentions Media Likers
Array [
]
service
object
category
object
Possible values: non-empty
Category name
List of services in this category
Amount in THB.
Possible values: [THB
]
Default value: THB
Possible values: >= 1
Possible values: >= 1
Possible values: >= 1
Quantity should be a multiple of this number
Indicates if the service supports dripfeed delivery
Indicates if the service supports refill
Indicates if the service supports order cancellation
Average delivery time
Possible values: [Default
, Poll
, SEO
, Comment Likes
, Mentions
, Mentions Hashtag
, Mentions with Hashtags
, Mentions User Followers
, Mentions Media Likers
, Custom Comments
, Custom Comments Package
, Custom Replies
, Mentions Custom List
]
URL or username
Possible values: >= 1
Quantity is always present for the order status object
Start count of the order
Remaining quantity
Amount in THB.
Possible values: [THB
]
Default value: THB
Indicates if the order is refilling
Indicates if the order is refillable
Indicates if the order is cancellable
Execution date (for scheduled orders)
Possible values: [Pending
, Processing
, In progress
, Completed
, Partial
, Canceled
, Processed
, Failed
]
Order status
refills
object[]
Possible values: [Processing
, In progress
, Completed
, Rejected
, Awaiting
, Processed
, Failed
, Error
]
Refill status
Order creation date
Present only for orders with status "Completed", "Partial", "Canceled"
{
"id": 0,
"service": {
"id": 0,
"name": "string",
"category": {
"id": 0,
"name": "string",
"services": [
null
]
},
"description": "string",
"currency": "THB",
"min": 0,
"max": 0,
"step": 0,
"dripfeed": true,
"refill": true,
"cancel": true,
"average_delivery": "string",
"type": "Default"
},
"link": "string",
"quantity": 0,
"start_count": 0,
"remains": 0,
"currency": "THB",
"is_refilling": true,
"is_refillable": true,
"is_cancellable": true,
"execute_at": "2024-07-29T15:51:28.071Z",
"comments": "string",
"username": "string",
"usernames": "string",
"answer_number": 0,
"keywords": "string",
"hashtag": "string",
"hashtags": "string",
"media": "string",
"status": "Pending",
"refills": [
{
"id": 0,
"status": "Processing",
"created_at": "2024-07-29T15:51:28.071Z"
}
],
"created_at": "2024-07-29T15:51:28.071Z",
"completed_at": "2024-07-29T15:51:28.071Z"
}
Validation error