Delivery

Get the customers delivery items

get

Retrieves the current customers delivery items.

Authorizations
AuthorizationstringRequired

A Customer token generated using an API Key in the format 'Customer TOKEN_HERE'.

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
chevron-right
200

OK

application/json

Represents a delivery item assigned to a customer

idstring · flake-idRequiredExample: 411486491630370816
store_idstring · flake-idRequiredExample: 411486491630370816
customer_idstring · flake-idRequiredExample: 411486491630370816
order_idstring · flake-idOptionalExample: 411486491630370816
order_line_idstring · flake-idOptionalExample: 411486491630370816
subscription_idstring · flake-idOptionalExample: 411486491630370816
execute_on_gameserver_idstring · flake-idOptionalExample: 411486491630370816
quantity_indexinteger · nullableOptional

The index of the item when multiple quantities were assigned

statestring · enumRequiredPossible values:
expirablebooleanRequired

Indicates whether the delivery item can expire

giftbooleanRequired

Indicates whether the item was given as a gift

added_atstring · date-timeRequired

The date and time when the item was added

active_atstring · nullableOptional

The date and time when the item became active

expires_atstring · nullableOptional

The date and time when the item expires naturally

override_expires_atstring · nullableOptional

The override expiry date for the delivery item

removed_atstring · nullableOptional

The date and time when the item was removed

revoked_atstring · nullableOptional

The date and time when the item was revoked

revoke_reasonstring · nullableOptional

The reason for revoking the delivery item

get
/v1/store/customer/delivery/items

Last updated

Was this helpful?