Orders

Get orders

get

Retrieves all orders for the specified store.

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 to retrieve orders for.

Example: 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.

order_idstring · flake-idOptional

Order ID

Example: 411486491630370816

customer_idstring · flake-idOptional

Customer ID

Example: 411486491630370816

billing_emailstringOptional

Billing Email

customer_ipstringOptional

Customer IP

subscription_idstring · flake-idOptional

Subscription ID

Example: 411486491630370816

checkout_idstring · flake-idOptional

Checkout ID

Example: 411486491630370816

is_subscriptionbooleanOptional

Flag indicating if the order is a subscription

affiliate_idstring · flake-idOptional

Affiliate ID

Example: 411486491630370816

coupon_idstring · flake-idOptional

Coupon ID

Example: 411486491630370816

giftcard_idstring · flake-idOptional

Gift card ID

Example: 411486491630370816

product_idstring · flake-idOptional

Product ID

Example: 411486491630370816

sale_idstring · flake-idOptional

Sale ID

Example: 411486491630370816

Responses

200

application/json

default

Error response

application/json

get

/v1/stores/{storeId}/orders

GET /v1/stores/{storeId}/orders HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "pretty_id": "pn-355eevennsow",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2025-12-12T13:27:22.946Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "type": "one_time",
    "status": "created",
    "checkout_id": "411486491630370816",
    "checkout_token": "c4qqilpphugeqf2gndnkk5ad8fdq",
    "subscription_id": "411486491630370816",
    "is_subscription": true,
    "coupon_id": "411486491630370816",
    "giftcard_id": "411486491630370816",
    "affiliate_id": "411486491630370816",
    "billing_name": "John Doe",
    "billing_email": "[email protected]",
    "billing_country": "US",
    "billing_cycle_sequence": 1,
    "customer_ip": "192.168.1.1",
    "currency": "usd",
    "discount_amount": 500,
    "discount_amount_str": "$5.00",
    "subtotal_amount": 9995,
    "subtotal_amount_str": "$99.95",
    "tax_amount": 999,
    "tax_amount_str": "$9.99",
    "total_amount": 10494,
    "total_amount_str": "$104.94",
    "giftcard_usage_amount": 0,
    "giftcard_usage_amount_str": "$0.00",
    "created_at": "2025-04-01T15:30:45Z",
    "completed_at": "2025-04-01T15:35:22Z",
    "lines": [
      {
        "id": "411486491630370816",
        "checkout_line_id": "411486491630370816",
        "product_id": "411486491630370816",
        "product_version_id": "411486491630370816",
        "product_name": "Premium Game Pass",
        "product_image_url": "https://cdn.example.com/images/premium-game-pass.jpg",
        "created_giftcard_id": null,
        "subscription_id": "411486491630370816",
        "trial_id": "411486491630370816",
        "subscription_interval_value": 1,
        "subscription_interval_scale": "invalid",
        "gift": false,
        "gift_to_customer_id": "411486491630370816",
        "gift_to_customer": {
          "id": "411486491630370816",
          "store_id": "411486491630370816",
          "profile": {
            "id": "text",
            "platform": "steam",
            "name": "text",
            "avatar_url": null
          },
          "steam_id": "76561197960287930",
          "steam": {
            "id": "76561197960287930",
            "name": "text",
            "avatar_url": "text"
          },
          "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
          "minecraft": {
            "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
            "name": "notch",
            "avatar_url": "text"
          },
          "xbox_xuid": null,
          "minecraft_platform": "unknown",
          "name": "m0uka",
          "created_at": "2025-12-12T13:27:22.946Z",
          "updated_at": null,
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "sale_id": "411486491630370816",
        "price": 1999,
        "price_str": "$19.99",
        "quantity": 1,
        "discount_amount": 0,
        "discount_amount_str": "$0.00",
        "giftcard_usage_amount": 0,
        "giftcard_usage_amount_str": "$0.00",
        "subtotal_amount": 1999,
        "subtotal_amount_str": "$19.99",
        "tax_amount": 200,
        "tax_amount_str": "$2.00",
        "total_amount": 2199,
        "total_amount_str": "$21.99",
        "selected_gameserver_id": "411486491630370816",
        "tax_inclusive": false,
        "payout_splits": [
          {
            "user_id": "411486491630370816",
            "percentage": null,
            "platform_fee": 1
          }
        ],
        "pricing_region_id": "eu",
        "custom_variables": null
      }
    ],
    "tax_jurisdictions": [
      {
        "name": "EU OSS",
        "taxes": [
          {
            "tax_name": "text",
            "taxable_amount": "text",
            "tax_amount": "text",
            "tax_rate": "text"
          }
        ],
        "not_taxed_reason": null
      }
    ],
    "last_payment_error": {
      "decline_code": "unknown",
      "message": "text"
    }
  }
]

Get order by ID

get

Retrieves an order by the ID for the specified store.

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 to retrieve the order for.

Example: 411486491630370816

orderIdstring · flake-idRequired

The ID of the order.

Example: 411486491630370816

Responses

200

application/json

default

Error response

application/json

get

/v1/stores/{storeId}/orders/{orderId}

GET /v1/stores/{storeId}/orders/{orderId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "411486491630370816",
  "pretty_id": "pn-355eevennsow",
  "store_id": "411486491630370816",
  "customer_id": "411486491630370816",
  "customer": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "profile": {
      "id": "text",
      "platform": "steam",
      "name": "text",
      "avatar_url": null
    },
    "steam_id": "76561197960287930",
    "steam": {
      "id": "76561197960287930",
      "name": "text",
      "avatar_url": "text"
    },
    "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
    "minecraft": {
      "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "name": "notch",
      "avatar_url": "text"
    },
    "xbox_xuid": null,
    "minecraft_platform": "unknown",
    "name": "m0uka",
    "created_at": "2025-12-12T13:27:22.946Z",
    "updated_at": null,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "type": "one_time",
  "status": "created",
  "checkout_id": "411486491630370816",
  "checkout_token": "c4qqilpphugeqf2gndnkk5ad8fdq",
  "subscription_id": "411486491630370816",
  "is_subscription": true,
  "coupon_id": "411486491630370816",
  "giftcard_id": "411486491630370816",
  "affiliate_id": "411486491630370816",
  "billing_name": "John Doe",
  "billing_email": "[email protected]",
  "billing_country": "US",
  "billing_cycle_sequence": 1,
  "customer_ip": "192.168.1.1",
  "currency": "usd",
  "discount_amount": 500,
  "discount_amount_str": "$5.00",
  "subtotal_amount": 9995,
  "subtotal_amount_str": "$99.95",
  "tax_amount": 999,
  "tax_amount_str": "$9.99",
  "total_amount": 10494,
  "total_amount_str": "$104.94",
  "giftcard_usage_amount": 0,
  "giftcard_usage_amount_str": "$0.00",
  "created_at": "2025-04-01T15:30:45Z",
  "completed_at": "2025-04-01T15:35:22Z",
  "lines": [
    {
      "id": "411486491630370816",
      "checkout_line_id": "411486491630370816",
      "product_id": "411486491630370816",
      "product_version_id": "411486491630370816",
      "product_name": "Premium Game Pass",
      "product_image_url": "https://cdn.example.com/images/premium-game-pass.jpg",
      "created_giftcard_id": null,
      "subscription_id": "411486491630370816",
      "trial_id": "411486491630370816",
      "subscription_interval_value": 1,
      "subscription_interval_scale": "invalid",
      "gift": false,
      "gift_to_customer_id": "411486491630370816",
      "gift_to_customer": {
        "id": "411486491630370816",
        "store_id": "411486491630370816",
        "profile": {
          "id": "text",
          "platform": "steam",
          "name": "text",
          "avatar_url": null
        },
        "steam_id": "76561197960287930",
        "steam": {
          "id": "76561197960287930",
          "name": "text",
          "avatar_url": "text"
        },
        "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "minecraft": {
          "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
          "name": "notch",
          "avatar_url": "text"
        },
        "xbox_xuid": null,
        "minecraft_platform": "unknown",
        "name": "m0uka",
        "created_at": "2025-12-12T13:27:22.946Z",
        "updated_at": null,
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "sale_id": "411486491630370816",
      "price": 1999,
      "price_str": "$19.99",
      "quantity": 1,
      "discount_amount": 0,
      "discount_amount_str": "$0.00",
      "giftcard_usage_amount": 0,
      "giftcard_usage_amount_str": "$0.00",
      "subtotal_amount": 1999,
      "subtotal_amount_str": "$19.99",
      "tax_amount": 200,
      "tax_amount_str": "$2.00",
      "total_amount": 2199,
      "total_amount_str": "$21.99",
      "selected_gameserver_id": "411486491630370816",
      "tax_inclusive": false,
      "payout_splits": [
        {
          "user_id": "411486491630370816",
          "percentage": null,
          "platform_fee": 1
        }
      ],
      "pricing_region_id": "eu",
      "custom_variables": null
    }
  ],
  "tax_jurisdictions": [
    {
      "name": "EU OSS",
      "taxes": [
        {
          "tax_name": "text",
          "taxable_amount": "text",
          "tax_amount": "text",
          "tax_rate": "text"
        }
      ],
      "not_taxed_reason": null
    }
  ],
  "last_payment_error": {
    "decline_code": "unknown",
    "message": "text"
  }
}

Refund order by ID

post

Creates a refund for an order by the ID for the specified store.

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 to refund the order for.

Example: 411486491630370816

orderIdstring · flake-idRequired

The ID of the order.

Example: 411486491630370816

Body

order_line_idstring · flake-idOptionalExample: 411486491630370816

refund_from_connected_user_balancenull | booleanOptional

Determines if the refund should be taken from the connected user's balance. Only relevant for connected platforms.

Responses

200

application/json

default

Error response

application/json

post

/v1/stores/{storeId}/orders/{orderId}/refund

POST /v1/stores/{storeId}/orders/{orderId}/refund HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "order_line_id": "411486491630370816",
  "refund_from_connected_user_balance": null
}

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "payment_id": "411486491630370816",
  "customer_id": "411486491630370816",
  "order_line_id": "411486491630370816",
  "status": "created",
  "failure_reason": null,
  "currency": "text",
  "amount": 1,
  "amount_str": "text",
  "gateway_fee_amount": 1,
  "gateway_fee_amount_str": "text",
  "tax_amount": 1,
  "tax_amount_str": "text",
  "platform_fee_amount": 1,
  "platform_fee_amount_str": "text",
  "store_net_amount": 1,
  "store_net_amount_str": "text",
  "store_refund_amount": 1,
  "store_refund_amount_str": "text",
  "presentment_currency": null,
  "presentment_amount": null,
  "fx_rate": null,
  "refund_from_connected_user_balance": true,
  "created_at": "2025-12-12T13:27:22.946Z",
  "approved_at": null,
  "pending_at": null,
  "completed_at": null,
  "canceled_at": null,
  "failed_at": null
}

PreviousNavlinks NextPayments

Last updated 1 day ago

Was this helpful?