Delivery

Get delivery items associated with an order

get

Retrieves all delivery items associated with a specific order.

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequired

The ID of the store.

Example: 411486491630370816
orderIdstring · flake-idRequired

The ID of the order to retrieve delivery items from.

Example: 411486491630370816
Responses
200

OK

application/json
get
/v1/stores/{storeId}/orders/{orderId}/delivery/items

Assign delivery items in bulk

post

Allows you to assign multiple delivery items for multiple customers in bulk

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
Bodyobject[]
customer_idstring · flake-idRequiredExample: 411486491630370816
product_version_idstring · flake-idOptionalExample: 411486491630370816
execute_on_gameserver_idstring · flake-idOptionalExample: 411486491630370816
quantitynull | integerOptional

Quantity of products to assign.

override_expires_atnull | stringOptional

Override expiry date for the delivery item.

skip_commandsnull | booleanOptional

Skip command execution when assigning the item.

custom_variablesnull | objectOptional

Custom variables for the assignment.

Responses
200

OK

application/json
post
/v1/stores/{storeId}/delivery/items

Unqueue commands by Attempt IDs

post
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
Body
attempt_idsstring · flake-id[]RequiredExample: 411486491630370816
Responses
200

OK

application/json
post
/v1/stores/{storeId}/delivery/commands/unqueue

Update product version id for delivery items of given product id

post
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
Body
product_version_idstring · flake-idRequiredExample: 411486491630370816
product_idstring · flake-idRequiredExample: 411486491630370816
Responses
200

OK

application/json
post
/v1/stores/{storeId}/delivery/items/update-product-versions

Get delivery items associated with a customer

get

Retrieves delivery items associated with a customer

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
customerIdstring · flake-idRequiredExample: 411486491630370816
Query parameters
limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816
beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816
ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses
200

OK

application/json
get
/v1/stores/{storeId}/customers/{customerId}/delivery/items

Assign a delivery item to a customer

post

Allows you to assign a delivery item to a customer

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
customerIdstring · flake-idRequiredExample: 411486491630370816
Body
product_idstring · flake-idOptionalExample: 411486491630370816
product_version_idstring · flake-idOptionalExample: 411486491630370816
execute_on_gameserver_idstring · flake-idOptionalExample: 411486491630370816
quantitynull | integerOptional

Quantity of products to assign.

override_expires_atnull | stringOptional

Override expiry date for the delivery item.

skip_commandsnull | booleanOptional

Skip command execution when assigning the item.

custom_variablesnull | objectOptional

Custom variables for the assignment.

Responses
200

OK

application/json
post
/v1/stores/{storeId}/customers/{customerId}/delivery/items

Revoke a delivery item from a customer

delete

Allows you to revoke a delivery item associated with a customer

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
customerIdstring · flake-idRequiredExample: 411486491630370816
deliveryItemIdstring · flake-idRequiredExample: 411486491630370816
Responses
delete
/v1/stores/{storeId}/customers/{customerId}/delivery/items/{deliveryItemId}

No content

Get command attempts associated with a customer

get

Retrieves command attempts associated with a customer

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
customerIdstring · flake-idRequiredExample: 411486491630370816
Query parameters
limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816
beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816
ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses
200

OK

application/json
get
/v1/stores/{storeId}/customers/{customerId}/delivery/commands

Resend commands for a given Gameserver

post
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
gameServerIdstring · flake-idRequiredExample: 411486491630370816
Body
starts_atnull | stringOptional
ends_atnull | stringOptional
inventory_item_idstring · flake-idOptionalExample: 411486491630370816
customer_idstring · flake-idOptionalExample: 411486491630370816
order_idstring · flake-idOptionalExample: 411486491630370816
product_idstring · flake-idOptionalExample: 411486491630370816
subscription_idstring · flake-idOptionalExample: 411486491630370816
Responses
200

OK

application/json
post
/v1/stores/{storeId}/gameservers/{gameServerId}/delivery/commands/resend

Last updated

Was this helpful?