Price Tables

Explore the limitless potential of Price Tables, designed to bring unparalleled flexibility to your pricing strategies. Price Tables functionality adapts to your needs seamlessly, allowing you to craft tailored pricing structures effortlessly and swap prices on the fly.

Endpoints

The Price Table object

Attributes

_id

Required

string

The ID of the price table

sellerId

Required

string

The ID of the seller of the price table

name

Required

string

The name of the price table. Is used for identification

Optional Attributes

Collapse all

Optional Attributes

Collapse all

categories[]._id

Optional

string

The ID of the price category

types

Optional

array

An array of price types

types[].name

Required

string

The name of the price type. Is used for identification

types[].categoryId

Required

string

The ID of the price category

types[].price

Required

number float

The default price for the type, can be overridden per price tier

Optional Attributes

Collapse all

types[]._id

Optional

string

The ID of the price type

tiers

Optional

array

An array of price tiers

tiers[].name

Required

string

The name of the price tier. Is used for identification

Optional Attributes

Collapse all

tiers[]._id

Optional

string

tiers[].prices

Optional

array

tiers[].prices[].priceTypeId

Required

string

The ID of the price type

tiers[].prices[].price

Required

number float

The price for the associated price type

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "name": "string",
  "categories": [
    {
      "_id": "string",
      "name": "string"
    }
  ],
  "types": [
    {
      "_id": "string",
      "name": "string",
      "categoryId": "string",
      "price": 10.5
    }
  ],
  "tiers": [
    {
      "_id": "string",
      "name": "string",
      "prices": [
        {
          "priceTypeId": "string",
          "price": 10.5
        }
      ]
    }
  ]
}

Create a Price Table

Payload

name

Required

string

The name of the price table. Is used for identification

Optional Attributes

Collapse all

Optional Attributes

Collapse all

categories[]._id

Optional

string

The ID of the price category

types

Optional

array

An array of price types

types[].name

Required

string

The name of the price type. Is used for identification

types[].categoryId

Required

string

The ID of the price category

types[].price

Required

number float

The default price for the type, can be overridden per price tier

Optional Attributes

Collapse all

types[]._id

Optional

string

The ID of the price type

tiers

Optional

array

An array of price tiers

tiers[].name

Required

string

The name of the price tier. Is used for identification

Optional Attributes

Collapse all

tiers[]._id

Optional

string

tiers[].prices

Optional

array

tiers[].prices[].priceTypeId

Required

string

The ID of the price type

tiers[].prices[].price

Required

number float

The price for the associated price type

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "categories": [
    {
      "_id": "string",
      "name": "string"
    }
  ],
  "types": [
    {
      "_id": "string",
      "name": "string",
      "categoryId": "string",
      "price": 10.5
    }
  ],
  "tiers": [
    {
      "_id": "string",
      "name": "string",
      "prices": [
        {
          "priceTypeId": "string",
          "price": 10.5
        }
      ]
    }
  ]
}

{
  "_id": "string",
  "sellerId": "string",
  "name": "string",
  "categories": [
    {
      "_id": "string",
      "name": "string"
    }
  ],
  "types": [
    {
      "_id": "string",
      "name": "string",
      "categoryId": "string",
      "price": 10.5
    }
  ],
  "tiers": [
    {
      "_id": "string",
      "name": "string",
      "prices": [
        {
          "priceTypeId": "string",
          "price": 10.5
        }
      ]
    }
  ]
}

Get a Price Table

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "name": "string",
  "categories": [
    {
      "_id": "string",
      "name": "string"
    }
  ],
  "types": [
    {
      "_id": "string",
      "name": "string",
      "categoryId": "string",
      "price": 10.5
    }
  ],
  "tiers": [
    {
      "_id": "string",
      "name": "string",
      "prices": [
        {
          "priceTypeId": "string",
          "price": 10.5
        }
      ]
    }
  ]
}

Update a Price Table

Payload

Optional Attributes

Collapse all

name

Optional

string

The name of the price table. Is used for identification

Optional Attributes

Collapse all

categories[]._id

Optional

string

The ID of the price category

types

Optional

array

An array of price types

types[].name

Required

string

The name of the price type. Is used for identification

types[].categoryId

Required

string

The ID of the price category

types[].price

Required

number float

The default price for the type, can be overridden per price tier

Optional Attributes

Collapse all

types[]._id

Optional

string

The ID of the price type

tiers

Optional

array

An array of price tiers

tiers[].name

Required

string

The name of the price tier. Is used for identification

Optional Attributes

Collapse all

tiers[]._id

Optional

string

tiers[].prices

Optional

array

tiers[].prices[].priceTypeId

Required

string

The ID of the price type

tiers[].prices[].price

Required

number float

The price for the associated price type

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "categories": [
    {
      "_id": "string",
      "name": "string"
    }
  ],
  "types": [
    {
      "_id": "string",
      "name": "string",
      "categoryId": "string",
      "price": 10.5
    }
  ],
  "tiers": [
    {
      "_id": "string",
      "name": "string",
      "prices": [
        {
          "priceTypeId": "string",
          "price": 10.5
        }
      ]
    }
  ]
}

{
  "_id": "string",
  "sellerId": "string",
  "name": "string",
  "categories": [
    {
      "_id": "string",
      "name": "string"
    }
  ],
  "types": [
    {
      "_id": "string",
      "name": "string",
      "categoryId": "string",
      "price": 10.5
    }
  ],
  "tiers": [
    {
      "_id": "string",
      "name": "string",
      "prices": [
        {
          "priceTypeId": "string",
          "price": 10.5
        }
      ]
    }
  ]
}

Get all Price Tables

Query

name

Optional

string

The name of the price table to filter for

top

Optional

integer

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

integer

The number of objects to skip for the requested result

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "docs": [
    {
      "_id": "string",
      "sellerId": "string",
      "name": "string",
      "categories": [
        {
          "_id": "string",
          "name": "string"
        }
      ],
      "types": [
        {
          "_id": "string",
          "name": "string",
          "categoryId": "string",
          "price": 10.5
        }
      ],
      "tiers": [
        {
          "_id": "string",
          "name": "string",
          "prices": [
            {
              "priceTypeId": "string",
              "price": 10.5
            }
          ]
        }
      ]
    }
  ],
  "total": 1
}