Skip to main content

Find cancel requests by IDs

GET 
/cancels

Find multiple cancel requests by their IDs

Request​

Query Parameters

    ids[] integer[]required

Responses​

Successful response

Schema

    data

    object[]

    Array of cancel requests

  • Array [

    • id int32
    status CancelStatus (string)

    Possible values: [Pending, Completed, Rejected]

    order

    object

    id int64

    Order ID

    service

    object

    id int32
    name string

    category

    object

    id int32
    name string

    Possible values: non-empty

    Category name

    services array

    List of services in this category

    description string
    rate float

    Amount in THB.

    currency Currency (string)

    Possible values: [THB]

    Default value: THB

    min int32

    Possible values: >= 1

    max int32

    Possible values: >= 1

    step int32

    Possible values: >= 1

    Quantity should be a multiple of this number

    dripfeed boolean

    Indicates if the service supports dripfeed delivery

    refill boolean

    Indicates if the service supports refill

    cancel boolean

    Indicates if the service supports order cancellation

    average_delivery string

    Average delivery time

    type ServiceType (enum)

    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]

    link url

    URL or username

    quantity int32

    Possible values: >= 1

    Quantity is always present for the order status object

    start_count int32

    Start count of the order

    remains int32

    Remaining quantity

    charge float

    Amount in THB.

    currency Currency (string)

    Possible values: [THB]

    Default value: THB

    is_refilling boolean

    Indicates if the order is refilling

    is_refillable boolean

    Indicates if the order is refillable

    is_cancellable boolean

    Indicates if the order is cancellable

    execute_at date-time

    Execution date (for scheduled orders)

    comments string
    • Returned for orders with service types:
    • Custom Comments, Custom Comments Package, Custom Replies
    username string
    • Returned for orders with service types:
    • Comment Likes, Comment Replies, Mentions User Followers
    usernames string
    • Returned for orders with service types:
    • Mentions, Mentions with Hashtags, Mentions Custom List
    • 1 username per line separated by \r\n or \n
    answer_number int32
    • Returned for orders with service types:
    • Poll
    keywords string
    • Returned for orders with service types:
    • SEO
    • 1 keyword per line separated by \r\n or \n
    hashtag string
    • Returned for orders with service types:
    • Mentions Hashtag
    hashtags string
    • Returned for orders with service types:
    • Mentions with Hashtags
    • 1 hashtag per line separated by \r\n or \n
    media url
    • Returned for orders with service types:
    • Mentions Media Likers
    status OrderStatus (string)

    Possible values: [Pending, Processing, In progress, Completed, Partial, Canceled, Processed, Failed]

    Order status

    refills

    object[]

  • Array [

    • id int32
    status RefillStatus (string)

    Possible values: [Processing, In progress, Completed, Rejected, Awaiting, Processed, Failed, Error]

    Refill status

    created_at date-time

  • ]

    • created_at date-time

    Order creation date

    completed_at date-time

    Present only for orders with status "Completed", "Partial", "Canceled"

    created_at date-time

  • ]

    • errors int32[]
    • Array of order IDs that were not found
    • Returned only if at least one order ID was not found
Loading...