Orders

Get orders

get

Retrieves all orders for the specified customer token.

This endpoint is only available for stores that use Steam based authentication.

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

200

application/json

Data transfer object representing a store order.

idstring · flake-idRequiredExample: 411486491630370816

pretty_idstringRead-onlyRequired

Human-readable identifier for the order.

store_idstring · flake-idRequiredExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

statusstring · enumRequiredPossible values:

typestring · enumRequired

Defines the type of items contained in an order

Possible values:

checkout_idstring · flake-idOptionalExample: 411486491630370816

subscription_idstring · flake-idOptionalExample: 411486491630370816

is_subscriptionbooleanRequired

Indicates whether this order is a subscription order.

currencystringRequired

Currency code used for this order.

discount_amountinteger · int32Required

The total discount amount applied to this order in smallest currency unit

Example: 500

discount_amount_strstringRequired

The discount amount formatted as a string

Example: $5.00

subtotal_amountinteger · int32Required

The subtotal amount for this order in smallest currency unit

Example: 9995

subtotal_amount_strstringRequired

The subtotal amount formatted as a string

Example: $99.95

tax_amountinteger · int32Required

The tax amount for this order in smallest currency unit

Example: 999

tax_amount_strstringRequired

The tax amount formatted as a string

Example: $9.99

total_amountinteger · int32Required

The total amount for this order in smallest currency unit

Example: 10494

total_amount_strstringRequired

The total amount formatted as a string

Example: $104.94

giftcard_usage_amountinteger · int32Required

The amount of gift card value used for this order in smallest currency unit

Example: 0

giftcard_usage_amount_strstringRequired

The gift card usage amount formatted as a string

Example: $0.00

presentment_currencystringRequired

The presentment currency code used for this order (currency shown to customer)

Example: eur

presentment_subtotal_amountinteger · int32Required

The presentment subtotal amount in smallest currency unit

Example: 9995

presentment_subtotal_amount_strstringRead-onlyRequired

The presentment subtotal amount formatted as a string

Example: €99.95

presentment_discount_amountinteger · int32Required

The presentment discount amount in smallest currency unit

Example: 500

presentment_discount_amount_strstringRead-onlyRequired

The presentment discount amount formatted as a string

Example: €5.00

presentment_giftcard_usage_amountinteger · int32Required

The presentment gift card usage amount in the smallest currency unit

Example: 0

presentment_giftcard_usage_amount_strstringRead-onlyRequired

The presentment gift card usage amount formatted as a string

Example: €0.00

presentment_tax_amountinteger · int32Required

The presentment tax amount in smallest currency unit

Example: 999

presentment_tax_amount_strstringRead-onlyRequired

The presentment tax amount formatted as a string

Example: €9.99

presentment_total_amountinteger · int32Required

The presentment total amount in the smallest currency unit

Example: 10494

presentment_total_amount_strstringRead-onlyRequired

The presentment total amount formatted as a string

Example: €104.94

billing_cycle_sequenceinteger · nullableOptional

Sequence number of the billing cycle, if this order is associated with a subscription.

created_atstring · nullableOptional

Date and time when the order was created.

completed_atstring · nullableOptional

Date and time when the order was completed.

canceled_atstring · nullableOptional

Date and time when the order was canceled.

default

Error response

application/json

get/v1/store/customer/orders

GET /v1/store/customer/orders HTTP/1.1
Authorization: Customer TOKEN_HERE
Accept: */*

[
  {
    "id": "411486491630370816",
    "pretty_id": "text",
    "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"
      },
      "minecraft_platform": "unknown",
      "xbox_xuid": null,
      "name": "m0uka"
    },
    "status": "created",
    "type": "one_time",
    "checkout_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "is_subscription": true,
    "currency": "text",
    "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",
    "presentment_currency": "eur",
    "presentment_subtotal_amount": 9995,
    "presentment_subtotal_amount_str": "€99.95",
    "presentment_discount_amount": 500,
    "presentment_discount_amount_str": "€5.00",
    "presentment_giftcard_usage_amount": 0,
    "presentment_giftcard_usage_amount_str": "€0.00",
    "presentment_tax_amount": 999,
    "presentment_tax_amount_str": "€9.99",
    "presentment_total_amount": 10494,
    "presentment_total_amount_str": "€104.94",
    "billing_cycle_sequence": null,
    "lines": [
      {
        "id": "411486491630370816",
        "checkout_line_id": "411486491630370816",
        "subscription_line_id": "411486491630370816",
        "trial_id": "411486491630370816",
        "product_id": "411486491630370816",
        "product_version_id": "411486491630370816",
        "product_name": "text",
        "product_image_url": "text",
        "subscription_interval_value": null,
        "subscription_interval_scale": null,
        "gift": true,
        "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"
          },
          "minecraft_platform": "unknown",
          "xbox_xuid": null,
          "name": "m0uka"
        },
        "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",
        "presentment_subtotal_amount": 1999,
        "presentment_subtotal_amount_str": "€19.99",
        "presentment_discount_amount": 0,
        "presentment_discount_amount_str": "€0.00",
        "presentment_tax_amount": 200,
        "presentment_tax_amount_str": "€2.00",
        "presentment_giftcard_usage_amount": 0,
        "presentment_giftcard_usage_amount_str": "€0.00",
        "presentment_total_amount": 2199,
        "presentment_total_amount_str": "€21.99",
        "selected_gameserver_id": "411486491630370816",
        "tax_inclusive": false,
        "pricing_region_id": "eu",
        "custom_variables": null
      }
    ],
    "created_at": null,
    "completed_at": null,
    "canceled_at": null
  }
]

Get order by ID

get

Retrieves an order by its ID for the specified customer token.

This endpoint is only available for stores that use Steam based authentication.

Authorizations

AuthorizationstringRequired

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

Path parameters

orderIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

application/json

Data transfer object representing a store order.

idstring · flake-idRequiredExample: 411486491630370816

pretty_idstringRead-onlyRequired

Human-readable identifier for the order.

store_idstring · flake-idRequiredExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

statusstring · enumRequiredPossible values:

typestring · enumRequired

Defines the type of items contained in an order

Possible values:

checkout_idstring · flake-idOptionalExample: 411486491630370816

subscription_idstring · flake-idOptionalExample: 411486491630370816

is_subscriptionbooleanRequired

Indicates whether this order is a subscription order.

currencystringRequired

Currency code used for this order.

discount_amountinteger · int32Required

The total discount amount applied to this order in smallest currency unit

Example: 500

discount_amount_strstringRequired

The discount amount formatted as a string

Example: $5.00

subtotal_amountinteger · int32Required

The subtotal amount for this order in smallest currency unit

Example: 9995

subtotal_amount_strstringRequired

The subtotal amount formatted as a string

Example: $99.95

tax_amountinteger · int32Required

The tax amount for this order in smallest currency unit

Example: 999

tax_amount_strstringRequired

The tax amount formatted as a string

Example: $9.99

total_amountinteger · int32Required

The total amount for this order in smallest currency unit

Example: 10494

total_amount_strstringRequired

The total amount formatted as a string

Example: $104.94

giftcard_usage_amountinteger · int32Required

The amount of gift card value used for this order in smallest currency unit

Example: 0

giftcard_usage_amount_strstringRequired

The gift card usage amount formatted as a string

Example: $0.00

presentment_currencystringRequired

The presentment currency code used for this order (currency shown to customer)

Example: eur

presentment_subtotal_amountinteger · int32Required

The presentment subtotal amount in smallest currency unit

Example: 9995

presentment_subtotal_amount_strstringRead-onlyRequired

The presentment subtotal amount formatted as a string

Example: €99.95

presentment_discount_amountinteger · int32Required

The presentment discount amount in smallest currency unit

Example: 500

presentment_discount_amount_strstringRead-onlyRequired

The presentment discount amount formatted as a string

Example: €5.00

presentment_giftcard_usage_amountinteger · int32Required

The presentment gift card usage amount in the smallest currency unit

Example: 0

presentment_giftcard_usage_amount_strstringRead-onlyRequired

The presentment gift card usage amount formatted as a string

Example: €0.00

presentment_tax_amountinteger · int32Required

The presentment tax amount in smallest currency unit

Example: 999

presentment_tax_amount_strstringRead-onlyRequired

The presentment tax amount formatted as a string

Example: €9.99

presentment_total_amountinteger · int32Required

The presentment total amount in the smallest currency unit

Example: 10494

presentment_total_amount_strstringRead-onlyRequired

The presentment total amount formatted as a string

Example: €104.94

billing_cycle_sequenceinteger · nullableOptional

Sequence number of the billing cycle, if this order is associated with a subscription.

created_atstring · nullableOptional

Date and time when the order was created.

completed_atstring · nullableOptional

Date and time when the order was completed.

canceled_atstring · nullableOptional

Date and time when the order was canceled.

default

Error response

application/json

get/v1/store/customer/orders/{orderId}

GET /v1/store/customer/orders/{orderId} HTTP/1.1
Authorization: Customer TOKEN_HERE
Accept: */*

{
  "id": "411486491630370816",
  "pretty_id": "text",
  "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"
    },
    "minecraft_platform": "unknown",
    "xbox_xuid": null,
    "name": "m0uka"
  },
  "status": "created",
  "type": "one_time",
  "checkout_id": "411486491630370816",
  "subscription_id": "411486491630370816",
  "is_subscription": true,
  "currency": "text",
  "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",
  "presentment_currency": "eur",
  "presentment_subtotal_amount": 9995,
  "presentment_subtotal_amount_str": "€99.95",
  "presentment_discount_amount": 500,
  "presentment_discount_amount_str": "€5.00",
  "presentment_giftcard_usage_amount": 0,
  "presentment_giftcard_usage_amount_str": "€0.00",
  "presentment_tax_amount": 999,
  "presentment_tax_amount_str": "€9.99",
  "presentment_total_amount": 10494,
  "presentment_total_amount_str": "€104.94",
  "billing_cycle_sequence": null,
  "lines": [
    {
      "id": "411486491630370816",
      "checkout_line_id": "411486491630370816",
      "subscription_line_id": "411486491630370816",
      "trial_id": "411486491630370816",
      "product_id": "411486491630370816",
      "product_version_id": "411486491630370816",
      "product_name": "text",
      "product_image_url": "text",
      "subscription_interval_value": null,
      "subscription_interval_scale": null,
      "gift": true,
      "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"
        },
        "minecraft_platform": "unknown",
        "xbox_xuid": null,
        "name": "m0uka"
      },
      "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",
      "presentment_subtotal_amount": 1999,
      "presentment_subtotal_amount_str": "€19.99",
      "presentment_discount_amount": 0,
      "presentment_discount_amount_str": "€0.00",
      "presentment_tax_amount": 200,
      "presentment_tax_amount_str": "€2.00",
      "presentment_giftcard_usage_amount": 0,
      "presentment_giftcard_usage_amount_str": "€0.00",
      "presentment_total_amount": 2199,
      "presentment_total_amount_str": "€21.99",
      "selected_gameserver_id": "411486491630370816",
      "tax_inclusive": false,
      "pricing_region_id": "eu",
      "custom_variables": null
    }
  ],
  "created_at": null,
  "completed_at": null,
  "canceled_at": null
}

PreviousNavlinks NextProducts

Last updated 15 days ago

Was this helpful?