Sales

Get sales associated with a store.

get

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

Represents a detailed view of a Sale, including configuration and audit information.

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

enabledbooleanRequired

Indicates whether the sale is enabled.

namestringRequired

The name of the sale.

discount_typestring · enumRequiredPossible values:

discount_amountinteger · int32Required

The discount value. For percent discounts, this represents the percentage multiplied by 10 (e.g., 250 = 25%). For amount discounts, this represents the value in the smallest currency unit (e.g., cents).

apply_to_product_idsstring · flake-id[]Required

A list of product IDs the sale applies to.

Example: 411486491630370816

apply_to_tag_idsstring · flake-id[]Required

A list of tag IDs the sale applies to.

Example: 411486491630370816

minimum_order_valueinteger · int32Required

The minimum order value required to apply the sale, in the smallest currency unit (e.g., cents).

begins_atstring · date-timeRequired

The date and time when the sale begins.

ends_atstring · nullableOptional

The date and time when the sale ends.

created_atstring · date-timeRequired

The date and time when the sale was created.

updated_atstring · nullableOptional

The date and time when the sale was last updated.

default

Error response

application/json

get

/v1/stores/{storeId}/sales

HTTPcURLJavaScriptPython

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

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "enabled": true,
    "name": "text",
    "discount_type": "percent",
    "discount_amount": 1,
    "apply_to_product_ids": [
      "411486491630370816"
    ],
    "apply_to_tag_ids": [
      "411486491630370816"
    ],
    "minimum_order_value": 1,
    "begins_at": "2026-02-19T00:03:13.090Z",
    "ends_at": null,
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "created_at": "2026-02-19T00:03:13.090Z",
    "updated_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "updated_at": null
  }
]

Create a sale by ID for a store

post

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

enabledbooleanRequired

namestringRequired

discount_typestring · enumRequiredPossible values:

discount_amountinteger · int32Required

apply_to_product_idsstring · flake-id[]RequiredExample: 411486491630370816

apply_to_tag_idsstring · flake-id[]RequiredExample: 411486491630370816

minimum_order_valueinteger · int32Required

begins_atstring · date-timeRequired

ends_atstring · nullableOptional

Responses

200

OK

application/json

Represents a detailed view of a Sale, including configuration and audit information.

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

enabledbooleanRequired

Indicates whether the sale is enabled.

namestringRequired

The name of the sale.

discount_typestring · enumRequiredPossible values:

discount_amountinteger · int32Required

The discount value. For percent discounts, this represents the percentage multiplied by 10 (e.g., 250 = 25%). For amount discounts, this represents the value in the smallest currency unit (e.g., cents).

apply_to_product_idsstring · flake-id[]Required

A list of product IDs the sale applies to.

Example: 411486491630370816

apply_to_tag_idsstring · flake-id[]Required

A list of tag IDs the sale applies to.

Example: 411486491630370816

minimum_order_valueinteger · int32Required

The minimum order value required to apply the sale, in the smallest currency unit (e.g., cents).

begins_atstring · date-timeRequired

The date and time when the sale begins.

ends_atstring · nullableOptional

The date and time when the sale ends.

created_atstring · date-timeRequired

The date and time when the sale was created.

updated_atstring · nullableOptional

The date and time when the sale was last updated.

default

Error response

application/json

post

/v1/stores/{storeId}/sales

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/sales HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "enabled": true,
  "name": "text",
  "discount_type": "percent",
  "discount_amount": 1,
  "apply_to_product_ids": [
    "411486491630370816"
  ],
  "apply_to_tag_ids": [
    "411486491630370816"
  ],
  "minimum_order_value": 1,
  "begins_at": "2026-02-19T00:03:13.090Z",
  "ends_at": null
}

application/jsontext/jsonapplication/*+json

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "enabled": true,
  "name": "text",
  "discount_type": "percent",
  "discount_amount": 1,
  "apply_to_product_ids": [
    "411486491630370816"
  ],
  "apply_to_tag_ids": [
    "411486491630370816"
  ],
  "minimum_order_value": 1,
  "begins_at": "2026-02-19T00:03:13.090Z",
  "ends_at": null,
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "created_at": "2026-02-19T00:03:13.090Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": null
}

Get a sale by ID for a store

get

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

saleIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

Represents a detailed view of a Sale, including configuration and audit information.

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

enabledbooleanRequired

Indicates whether the sale is enabled.

namestringRequired

The name of the sale.

discount_typestring · enumRequiredPossible values:

discount_amountinteger · int32Required

The discount value. For percent discounts, this represents the percentage multiplied by 10 (e.g., 250 = 25%). For amount discounts, this represents the value in the smallest currency unit (e.g., cents).

apply_to_product_idsstring · flake-id[]Required

A list of product IDs the sale applies to.

Example: 411486491630370816

apply_to_tag_idsstring · flake-id[]Required

A list of tag IDs the sale applies to.

Example: 411486491630370816

minimum_order_valueinteger · int32Required

The minimum order value required to apply the sale, in the smallest currency unit (e.g., cents).

begins_atstring · date-timeRequired

The date and time when the sale begins.

ends_atstring · nullableOptional

The date and time when the sale ends.

created_atstring · date-timeRequired

The date and time when the sale was created.

updated_atstring · nullableOptional

The date and time when the sale was last updated.

default

Error response

application/json

get

/v1/stores/{storeId}/sales/{saleId}

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/sales/{saleId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "enabled": true,
  "name": "text",
  "discount_type": "percent",
  "discount_amount": 1,
  "apply_to_product_ids": [
    "411486491630370816"
  ],
  "apply_to_tag_ids": [
    "411486491630370816"
  ],
  "minimum_order_value": 1,
  "begins_at": "2026-02-19T00:03:13.090Z",
  "ends_at": null,
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "created_at": "2026-02-19T00:03:13.090Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": null
}

Delete a sale by ID for a store

delete

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

saleIdstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

default

Error response

application/json

delete

/v1/stores/{storeId}/sales/{saleId}

HTTPcURLJavaScriptPython

DELETE /v1/stores/{storeId}/sales/{saleId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Update a sale by ID for a store

patch

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

saleIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

enabledbooleanOptional

namestringOptional

discount_typestring · enumOptionalPossible values:

discount_amountinteger · int32Optional

apply_to_product_idsstring · flake-id[]OptionalExample: 411486491630370816

apply_to_tag_idsstring · flake-id[]OptionalExample: 411486491630370816

minimum_order_valueinteger · int32Optional

begins_atstring · date-timeOptional

ends_atstring · nullableOptional

Responses

200

OK

application/json

Represents a detailed view of a Sale, including configuration and audit information.

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

enabledbooleanRequired

Indicates whether the sale is enabled.

namestringRequired

The name of the sale.

discount_typestring · enumRequiredPossible values:

discount_amountinteger · int32Required

The discount value. For percent discounts, this represents the percentage multiplied by 10 (e.g., 250 = 25%). For amount discounts, this represents the value in the smallest currency unit (e.g., cents).

apply_to_product_idsstring · flake-id[]Required

A list of product IDs the sale applies to.

Example: 411486491630370816

apply_to_tag_idsstring · flake-id[]Required

A list of tag IDs the sale applies to.

Example: 411486491630370816

minimum_order_valueinteger · int32Required

The minimum order value required to apply the sale, in the smallest currency unit (e.g., cents).

begins_atstring · date-timeRequired

The date and time when the sale begins.

ends_atstring · nullableOptional

The date and time when the sale ends.

created_atstring · date-timeRequired

The date and time when the sale was created.

updated_atstring · nullableOptional

The date and time when the sale was last updated.

default

Error response

application/json

patch

/v1/stores/{storeId}/sales/{saleId}

HTTPcURLJavaScriptPython

PATCH /v1/stores/{storeId}/sales/{saleId} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "enabled": true,
  "name": "text",
  "discount_type": "percent",
  "discount_amount": 1,
  "apply_to_product_ids": [
    "411486491630370816"
  ],
  "apply_to_tag_ids": [
    "411486491630370816"
  ],
  "minimum_order_value": 1,
  "begins_at": "2026-02-19T00:03:13.090Z",
  "ends_at": null
}

application/jsontext/jsonapplication/*+json

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "enabled": true,
  "name": "text",
  "discount_type": "percent",
  "discount_amount": 1,
  "apply_to_product_ids": [
    "411486491630370816"
  ],
  "apply_to_tag_ids": [
    "411486491630370816"
  ],
  "minimum_order_value": 1,
  "begins_at": "2026-02-19T00:03:13.090Z",
  "ends_at": null,
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "created_at": "2026-02-19T00:03:13.090Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": null
}