PayNow

Delivery Command Queue

The Delivery Command Queue is responsible for managing the commands that need to be executed in order to deliver products to customers. It is accessed through an API endpoint.

Endpoints

GET
/delivery/command-queue
POST
/delivery/command-queue
DELETE
/delivery/command-queue
DELETE
/delivery/command-queue/{attemptID}

Get Queued Commands

This endpoint fetches the list of commands that are queued for execution.

Response

Returns a JSON array of queued commands.

QueuedCommand object structure

  • Fields

  • Name
    attempt_id
    Type
    integer
    Tags
    Description

    id of the command attempt

  • Name
    command
    Type
    string
    Tags
    Description

    command to be executed to assign products for customers

  • Name
    online_only
    Type
    boolean
    Tags
    Description

    indicates whether the command should be only executed if the customer is online

  • Name
    queued_at
    Type
    time
    Tags
    Description

    time when the command was queued

  • Name
    steam_id
    Type
    string
    Tags
    Description

    steam id 64 of the customer

Endpoints

GET
/delivery/command-queue

Get Queued Commands Response

[
    {
        "attempt_id": "124249183568797696",
        "command": "add 76561198085278322 hero",
        "queued_at": "2023-10-23T14:12:00Z",
        "online_only": false,
        "steam_id": "76561198085278322"
    }
]

Get Queued Commands with Online Players

This endpoint fetches the list of commands that are queued for execution while prioritizing commands for the online players passed in the request body

  • Fields

  • Name
    steam_ids
    Type
    []string
    Tags
    Description

    an array of currently online players steam ids

Response

Returns a JSON array of queued commands.

QueuedCommand object structure

  • Fields

  • Name
    attempt_id
    Type
    integer
    Tags
    Description

    id of the command attempt

  • Name
    command
    Type
    string
    Tags
    Description

    command to be executed to assign products for customers

  • Name
    online_only
    Type
    boolean
    Tags
    Description

    indicates whether the command should be only executed if the customer is online

  • Name
    queued_at
    Type
    time
    Tags
    Description

    time when the command was queued

  • Name
    steam_id
    Type
    string
    Tags
    Description

    steam id 64 of the customer

Endpoints

POST
/delivery/command-queue

Get Queued Commands Request

{
    "steam_ids": [
        "76561198085278322",
        "76561198085278323"
    ]
}

Get Queued Commands Response

[
    {
        "attempt_id": "124249183568797696",
        "command": "add 76561198085278322 hero",
        "queued_at": "2023-10-23T14:12:00Z",
        "online_only": false,
        "steam_id": "76561198085278322"
    }
]

Bulk Mark Commands Executed

This endpoint allows for marking multiple commands as executed in a bulk operation.

BulkCommandMarkExecutedEntry object structure

  • Fields

  • Name
    attempt_id
    Type
    integer
    Tags
    Description

    id of the command attempt

Endpoints

DELETE
/delivery/command-queue

Bulk Mark Commands Executed Request

[
    {
        "attempt_id": "124249183568797696"
    }
]

Mark Command Executed

This endpoint marks a single command as executed based on the provided attemptID.

  • Query Parameters

  • Name
    attemptID
    Type
    integer
    Tags
    Description

    id of the command attempt to mark as executed

Returns

Does not return a response object.

Endpoints

DELETE
/delivery/command-queue/{attemptID}

URL Example

/delivery/command-queue/124249183568797696