This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

List Price Lists

Production Env

http://127.0.0.1:3658/m1/543334-505232-default

GET

/admin/price-lists

Retrieve a list of price lists. The price lists can be filtered by fields such as q or status. The price lists can also be sorted or paginated.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://127.0.0.1:3658/m1/543334-505232-default/admin/price-lists'

Response Example

200 - Example 1

{
    "count": 0,
    "offset": 0,
    "limit": 0,
    "price_lists": [
        {
            "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"
                    }
                }
            ]
        }
    ]
}

Request

Query Params

Responses

🟢200OK

application/json

Body

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2024-05-20 07:45:58

Create a Price List

Create a Product Category