Delivery

Get the customers delivery items

GEThttps://api.paynow.gg/v1/store/customer/delivery/items

Retrieves the current customers delivery items.

Headers

AuthorizationCustomer tokenRequired

Authentication token for this request, sent as Authorization: Customer TOKEN.

Query parameters

limitintegerOptional

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

afterFlakeIdOptional

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

beforeFlakeIdOptional

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

ascbooleanOptional

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

Response

200OKStorefrontDeliveryItemDto[]

Represents a delivery item assigned to a customer

Show fields

added_atstringRequired

The date and time when the item was added

customer_idFlakeIdRequired

expirablebooleanRequired

Indicates whether the delivery item can expire

giftbooleanRequired

Indicates whether the item was given as a gift

idFlakeIdRequired

productDeliveryItemProductDtoRequired

Represents the product information for a delivery item

idFlakeIdRequired

namestringRequired

The name of the product

slugstringRequired

The URL-friendly slug of the product

version_idstringRequired

The version identifier of the product

stateenumRequired

Possible enum values

usable
active
used
revoked
renewed

store_idFlakeIdRequired

active_atstringOptional

The date and time when the item became active

execute_on_gameserver_idFlakeIdOptional

expires_atstringOptional

The date and time when the item expires naturally

order_idFlakeIdOptional

order_line_idFlakeIdOptional

override_expires_atstringOptional

The override expiry date for the delivery item

quantity_indexintegerOptional

The index of the item when multiple quantities were assigned

removed_atstringOptional

The date and time when the item was removed

revoke_reasonstringOptional

The reason for revoking the delivery item

revoked_atstringOptional

The date and time when the item was revoked

subscription_idFlakeIdOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/store/customer/delivery/items" \
  -H "Authorization: Customer TOKEN"

import { createStorefrontClient } from "@paynow-gg/typescript-sdk";

const paynow = createStorefrontClient({
  storeId: "STORE_ID",
  customerToken: "CUSTOMER_TOKEN",
});

const result = await paynow.delivery.getStorefrontCustomerDeliveryItems();

import requests

headers = {"Authorization": "Customer TOKEN"}
response = requests.get("https://api.paynow.gg/v1/store/customer/delivery/items", headers=headers)

Response200

[
  {
    "added_at": "2024-01-01T00:00:00Z",
    "customer_id": "411486491630370816",
    "expirable": true,
    "gift": true,
    "id": "411486491630370816",
    "product": {
      "id": "411486491630370816",
      "name": "Premium Membership",
      "slug": "premium-membership",
      "version_id": "v2.1.0"
    },
    "state": "usable",
    "store_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "quantity_index": 0,
    "active_at": "2024-01-01T00:00:00Z",
    "expires_at": "2024-01-01T00:00:00Z",
    "override_expires_at": "2024-01-01T00:00:00Z",
    "removed_at": "2024-01-01T00:00:00Z",
    "revoked_at": "2024-01-01T00:00:00Z",
    "revoke_reason": "string"
  }
]