Add or Update Prices

Add or update a list of prices in a Price List

Request

Path Params

string

required

The ID of the Price List.

Body Params application/json

override

boolean

optional

If set to true, the prices will replace all existing prices associated with the Price List.

prices

array [object {7}]

optional

The prices to update or add.

string

optional

The ID of the price.

region_id

string

optional

The ID of the Region for which the price is used. This is only required if currecny_code is not provided.

variant_id

string

required

The ID of the Variant for which the price is used.

amount

integer

required

The amount to charge for the Product Variant.

min_quantity

integer

optional

The minimum quantity for which the price will be used.

max_quantity

integer

optional

The maximum quantity for which the price will be used.

currency_code

string

optional

The 3 character ISO currency code for which the price will be used. This is only required if region_id is not provided.

Example

{
    "override": true,
    "prices": [
        {
            "id": "string",
            "region_id": "string",
            "variant_id": "string",
            "amount": 0,
            "min_quantity": 0,
            "max_quantity": 0,
            "currency_code": "string"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

price_list

object (Price List)

required

A Price List represents a set of prices that override the default price for one or more product variants.

string

required

The price list's ID

Example:

pl_01G8X3CKJXCG5VXVZ87H9KC09W

name

string

required

The price list's name

Example:

VIP Prices

description

string

required

The price list's description

Example:

Prices for VIP customers

starts_at

string <date-time> | null

required

The date with timezone that the Price List starts being valid.

ends_at

string <date-time> | null

required

The date with timezone that the Price List stops being valid.

includes_tax

boolean

optional

Whether the price list prices include tax

Default:

false

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

type

enum<string>

required

The type of Price List. This can be one of either sale or override.

Allowed values:

saleoverride

Default:

sale

status

enum<string>

required

The status of the Price List

Allowed values:

activedraft

Default:

draft

customer_groups

array[object (Customer Group) {8}]

optional

The details of the customer groups that the Price List can apply to.

prices

array[object (Money Amount) {15}]

optional

The prices that belong to the price list, represented as a Money Amount.

Example

{
    "price_list": {
        "id": "pl_01G8X3CKJXCG5VXVZ87H9KC09W",
        "name": "VIP Prices",
        "description": "Prices for VIP customers",
        "starts_at": "2019-08-24T14:15:22Z",
        "ends_at": "2019-08-24T14:15:22Z",
        "includes_tax": false,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "type": "sale",
        "status": "draft",
        "customer_groups": [
            {
                "id": "cgrp_01G8ZH853Y6TFXWPG5EYE81X63",
                "name": "VIP",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "customers": [
                    {}
                ],
                "price_lists": [
                    {}
                ],
                "metadata": {
                    "car": "white"
                }
            }
        ],
        "prices": [
            {
                "id": "ma_01F0YESHRFQNH5S8Q0PK84YYZN",
                "amount": 100,
                "min_quantity": 1,
                "max_quantity": 1,
                "price_list_id": "pl_01G8X3CKJXCG5VXVZ87H9KC09W",
                "price_list": {},
                "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                "variant": {},
                "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                "region": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "currency_code": "usd",
                "currency": {
                    "symbol": "$",
                    "symbol_native": "$",
                    "name": "US Dollar",
                    "includes_tax": false,
                    "code": "usd"
                }
            }
        ]
    }
}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error