GET /lists/price-lists/\{id\}

GET 
/lists/price-lists/:id

GET /lists/price-lists/{id}

Request

Path Parameters

id int64required

Query Parameters

include string[]

Responses

200

OK

text/plain

Schema

Schema

id int32
code stringrequired

Possible values: non-empty

name stringnullable
name_loc stringnullable
type stringnullable
tax_nexus stringnullable
currency stringrequired

Possible values: non-empty

country stringnullable
rate_format stringrequired

Possible values: non-empty

contact

object

id int64nullable

uid uuid

created_at date-timenullable

type stringrequired

Possible values: non-empty

Default value: COM

display_name stringrequired

Possible values: non-empty

business_name stringrequired

Possible values: non-empty

reg_no stringnullable

tax_no stringnullable

social_security_no stringnullable

currency stringnullable

payment_term int32nullable

email stringnullable

preferred_locale stringnullable

shopify_customer_id int64nullable

stripe_customer_id stringnullable

woocommerce_customer_id int64nullable

eshop_customer_id int64nullable

billing_address

object

id int64nullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

country stringnullable

region stringnullable

subregion stringnullable

shipping_address

object

id int64nullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

country stringnullable

region stringnullable

subregion stringnullable

taxes

object[]

nullable

Array [

country stringnullable

vat_no stringnullable

]

items

object[]

nullable

Array [

id int64

item

object

id int64

uid uuid

sku stringnullable

name stringnullable

barcode stringnullable

country_of_origin stringnullable

harmonized_system_code stringnullable

weight_grams doublenullable

rate doublenullable

has_batches boolean

has_serial_no boolean

requires_shipping boolean

shopify_product_id int64nullable

woocommerce_product_id int64nullable

eshop_product_id int64nullable

stock_unit

object

id int32nullable

symbol stringnullable

unece_code stringnullable

iso_code stringnullable

name stringnullable

l10n

object[]

nullable

Array [

id int64

culture stringnullable

name stringnullable

description stringnullable

]

variants

object[]

nullable

Array [

id int64

order int32nullable

sku stringnullable

barcode stringnullable

country_of_origin stringnullable

harmonized_system_code stringnullable

weight_grams doublenullable

dimension1 stringnullable

dimension2 stringnullable

dimension3 stringnullable

dimension4 stringnullable

dimension5 stringnullable

shopify_variant_id int64nullable

woocommerce_variant_id int64nullable

eshop_variant_id int64nullable

]

dimensions

object[]

nullable

Array [

order int32

name stringnullable

values string[]nullable

]

taxes

object[]

nullable

Array [

tax_index int32nullable

tax_rate doublenullable

]

unit

object

unece_code stringnullable

id int32nullable

symbol stringnullable

name stringnullable

iso_code stringnullable

rate double

qty_from doublenullable

qty_to doublenullable

stock_unit_rate doublenullable

order int32nullable

]

l10n

object[]

nullable

Array [

id int64

culture stringnullable

name stringnullable

description stringnullable

]

Example (from schema)

{
  "id": 0,
  "code": "string",
  "name": "string",
  "name_loc": "string",
  "type": "string",
  "tax_nexus": "string",
  "currency": "string",
  "country": "string",
  "rate_format": "string",
  "contact": {
    "id": 0,
    "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2024-07-29T15:51:28.071Z",
    "type": "COM",
    "display_name": "string",
    "business_name": "string",
    "reg_no": "string",
    "tax_no": "string",
    "social_security_no": "string",
    "currency": "string",
    "payment_term": 0,
    "email": "string",
    "preferred_locale": "string",
    "shopify_customer_id": 0,
    "stripe_customer_id": "string",
    "woocommerce_customer_id": 0,
    "eshop_customer_id": 0,
    "billing_address": {
      "id": 0,
      "address1": "string",
      "address2": "string",
      "postal_code": "string",
      "city": "string",
      "country": "string",
      "region": "string",
      "subregion": "string"
    },
    "shipping_address": {
      "id": 0,
      "address1": "string",
      "address2": "string",
      "postal_code": "string",
      "city": "string",
      "country": "string",
      "region": "string",
      "subregion": "string"
    },
    "taxes": [
      {
        "country": "string",
        "vat_no": "string"
      }
    ]
  },
  "items": [
    {
      "id": 0,
      "item": {
        "id": 0,
        "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "sku": "string",
        "name": "string",
        "barcode": "string",
        "country_of_origin": "string",
        "harmonized_system_code": "string",
        "weight_grams": 0,
        "rate": 0,
        "has_batches": true,
        "has_serial_no": true,
        "requires_shipping": true,
        "shopify_product_id": 0,
        "woocommerce_product_id": 0,
        "eshop_product_id": 0,
        "stock_unit": {
          "id": 0,
          "symbol": "string",
          "unece_code": "string",
          "iso_code": "string",
          "name": "string"
        },
        "l10n": [
          {
            "id": 0,
            "culture": "string",
            "name": "string",
            "description": "string"
          }
        ],
        "variants": [
          {
            "id": 0,
            "order": 0,
            "sku": "string",
            "barcode": "string",
            "country_of_origin": "string",
            "harmonized_system_code": "string",
            "weight_grams": 0,
            "dimension1": "string",
            "dimension2": "string",
            "dimension3": "string",
            "dimension4": "string",
            "dimension5": "string",
            "shopify_variant_id": 0,
            "woocommerce_variant_id": 0,
            "eshop_variant_id": 0
          }
        ],
        "dimensions": [
          {
            "order": 0,
            "name": "string",
            "values": [
              "string"
            ]
          }
        ],
        "taxes": [
          {
            "tax_index": 0,
            "tax_rate": 0
          }
        ]
      },
      "unit": {
        "unece_code": "string",
        "id": 0,
        "symbol": "string",
        "name": "string",
        "iso_code": "string"
      },
      "rate": 0,
      "qty_from": 0,
      "qty_to": 0,
      "stock_unit_rate": 0,
      "order": 0
    }
  ],
  "l10n": [
    {
      "id": 0,
      "culture": "string",
      "name": "string",
      "description": "string"
    }
  ]
}

application/json

Schema

Schema

id int32
code stringrequired

Possible values: non-empty

name stringnullable
name_loc stringnullable
type stringnullable
tax_nexus stringnullable
currency stringrequired

Possible values: non-empty

country stringnullable
rate_format stringrequired

Possible values: non-empty

contact

object

id int64nullable

uid uuid

created_at date-timenullable

type stringrequired

Possible values: non-empty

Default value: COM

display_name stringrequired

Possible values: non-empty

business_name stringrequired

Possible values: non-empty

reg_no stringnullable

tax_no stringnullable

social_security_no stringnullable

currency stringnullable

payment_term int32nullable

email stringnullable

preferred_locale stringnullable

shopify_customer_id int64nullable

stripe_customer_id stringnullable

woocommerce_customer_id int64nullable

eshop_customer_id int64nullable

billing_address

object

id int64nullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

country stringnullable

region stringnullable

subregion stringnullable

shipping_address

object

id int64nullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

country stringnullable

region stringnullable

subregion stringnullable

taxes

object[]

nullable

Array [

country stringnullable

vat_no stringnullable

]

items

object[]

nullable

Array [

id int64

item

object

id int64

uid uuid

sku stringnullable

name stringnullable

barcode stringnullable

country_of_origin stringnullable

harmonized_system_code stringnullable

weight_grams doublenullable

rate doublenullable

has_batches boolean

has_serial_no boolean

requires_shipping boolean

shopify_product_id int64nullable

woocommerce_product_id int64nullable

eshop_product_id int64nullable

stock_unit

object

id int32nullable

symbol stringnullable

unece_code stringnullable

iso_code stringnullable

name stringnullable

l10n

object[]

nullable

Array [

id int64

culture stringnullable

name stringnullable

description stringnullable

]

variants

object[]

nullable

Array [

id int64

order int32nullable

sku stringnullable

barcode stringnullable

country_of_origin stringnullable

harmonized_system_code stringnullable

weight_grams doublenullable

dimension1 stringnullable

dimension2 stringnullable

dimension3 stringnullable

dimension4 stringnullable

dimension5 stringnullable

shopify_variant_id int64nullable

woocommerce_variant_id int64nullable

eshop_variant_id int64nullable

]

dimensions

object[]

nullable

Array [

order int32

name stringnullable

values string[]nullable

]

taxes

object[]

nullable

Array [

tax_index int32nullable

tax_rate doublenullable

]

unit

object

unece_code stringnullable

id int32nullable

symbol stringnullable

name stringnullable

iso_code stringnullable

rate double

qty_from doublenullable

qty_to doublenullable

stock_unit_rate doublenullable

order int32nullable

]

l10n

object[]

nullable

Array [

id int64

culture stringnullable

name stringnullable

description stringnullable

]

Example (from schema)

{
  "id": 0,
  "code": "string",
  "name": "string",
  "name_loc": "string",
  "type": "string",
  "tax_nexus": "string",
  "currency": "string",
  "country": "string",
  "rate_format": "string",
  "contact": {
    "id": 0,
    "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2024-07-29T15:51:28.071Z",
    "type": "COM",
    "display_name": "string",
    "business_name": "string",
    "reg_no": "string",
    "tax_no": "string",
    "social_security_no": "string",
    "currency": "string",
    "payment_term": 0,
    "email": "string",
    "preferred_locale": "string",
    "shopify_customer_id": 0,
    "stripe_customer_id": "string",
    "woocommerce_customer_id": 0,
    "eshop_customer_id": 0,
    "billing_address": {
      "id": 0,
      "address1": "string",
      "address2": "string",
      "postal_code": "string",
      "city": "string",
      "country": "string",
      "region": "string",
      "subregion": "string"
    },
    "shipping_address": {
      "id": 0,
      "address1": "string",
      "address2": "string",
      "postal_code": "string",
      "city": "string",
      "country": "string",
      "region": "string",
      "subregion": "string"
    },
    "taxes": [
      {
        "country": "string",
        "vat_no": "string"
      }
    ]
  },
  "items": [
    {
      "id": 0,
      "item": {
        "id": 0,
        "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "sku": "string",
        "name": "string",
        "barcode": "string",
        "country_of_origin": "string",
        "harmonized_system_code": "string",
        "weight_grams": 0,
        "rate": 0,
        "has_batches": true,
        "has_serial_no": true,
        "requires_shipping": true,
        "shopify_product_id": 0,
        "woocommerce_product_id": 0,
        "eshop_product_id": 0,
        "stock_unit": {
          "id": 0,
          "symbol": "string",
          "unece_code": "string",
          "iso_code": "string",
          "name": "string"
        },
        "l10n": [
          {
            "id": 0,
            "culture": "string",
            "name": "string",
            "description": "string"
          }
        ],
        "variants": [
          {
            "id": 0,
            "order": 0,
            "sku": "string",
            "barcode": "string",
            "country_of_origin": "string",
            "harmonized_system_code": "string",
            "weight_grams": 0,
            "dimension1": "string",
            "dimension2": "string",
            "dimension3": "string",
            "dimension4": "string",
            "dimension5": "string",
            "shopify_variant_id": 0,
            "woocommerce_variant_id": 0,
            "eshop_variant_id": 0
          }
        ],
        "dimensions": [
          {
            "order": 0,
            "name": "string",
            "values": [
              "string"
            ]
          }
        ],
        "taxes": [
          {
            "tax_index": 0,
            "tax_rate": 0
          }
        ]
      },
      "unit": {
        "unece_code": "string",
        "id": 0,
        "symbol": "string",
        "name": "string",
        "iso_code": "string"
      },
      "rate": 0,
      "qty_from": 0,
      "qty_to": 0,
      "stock_unit_rate": 0,
      "order": 0
    }
  ],
  "l10n": [
    {
      "id": 0,
      "culture": "string",
      "name": "string",
      "description": "string"
    }
  ]
}

text/json

Schema

Schema

id int32
code stringrequired

Possible values: non-empty

name stringnullable
name_loc stringnullable
type stringnullable
tax_nexus stringnullable
currency stringrequired

Possible values: non-empty

country stringnullable
rate_format stringrequired

Possible values: non-empty

contact

object

id int64nullable

uid uuid

created_at date-timenullable

type stringrequired

Possible values: non-empty

Default value: COM

display_name stringrequired

Possible values: non-empty

business_name stringrequired

Possible values: non-empty

reg_no stringnullable

tax_no stringnullable

social_security_no stringnullable

currency stringnullable

payment_term int32nullable

email stringnullable

preferred_locale stringnullable

shopify_customer_id int64nullable

stripe_customer_id stringnullable

woocommerce_customer_id int64nullable

eshop_customer_id int64nullable

billing_address

object

id int64nullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

country stringnullable

region stringnullable

subregion stringnullable

shipping_address

object

id int64nullable

address1 stringnullable

address2 stringnullable

postal_code stringnullable

city stringnullable

country stringnullable

region stringnullable

subregion stringnullable

taxes

object[]

nullable

Array [

country stringnullable

vat_no stringnullable

]

items

object[]

nullable

Array [

id int64

item

object

id int64

uid uuid

sku stringnullable

name stringnullable

barcode stringnullable

country_of_origin stringnullable

harmonized_system_code stringnullable

weight_grams doublenullable

rate doublenullable

has_batches boolean

has_serial_no boolean

requires_shipping boolean

shopify_product_id int64nullable

woocommerce_product_id int64nullable

eshop_product_id int64nullable

stock_unit

object

id int32nullable

symbol stringnullable

unece_code stringnullable

iso_code stringnullable

name stringnullable

l10n

object[]

nullable

Array [

id int64

culture stringnullable

name stringnullable

description stringnullable

]

variants

object[]

nullable

Array [

id int64

order int32nullable

sku stringnullable

barcode stringnullable

country_of_origin stringnullable

harmonized_system_code stringnullable

weight_grams doublenullable

dimension1 stringnullable

dimension2 stringnullable

dimension3 stringnullable

dimension4 stringnullable

dimension5 stringnullable

shopify_variant_id int64nullable

woocommerce_variant_id int64nullable

eshop_variant_id int64nullable

]

dimensions

object[]

nullable

Array [

order int32

name stringnullable

values string[]nullable

]

taxes

object[]

nullable

Array [

tax_index int32nullable

tax_rate doublenullable

]

unit

object

unece_code stringnullable

id int32nullable

symbol stringnullable

name stringnullable

iso_code stringnullable

rate double

qty_from doublenullable

qty_to doublenullable

stock_unit_rate doublenullable

order int32nullable

]

l10n

object[]

nullable

Array [

id int64

culture stringnullable

name stringnullable

description stringnullable

]

Example (from schema)

{
  "id": 0,
  "code": "string",
  "name": "string",
  "name_loc": "string",
  "type": "string",
  "tax_nexus": "string",
  "currency": "string",
  "country": "string",
  "rate_format": "string",
  "contact": {
    "id": 0,
    "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2024-07-29T15:51:28.071Z",
    "type": "COM",
    "display_name": "string",
    "business_name": "string",
    "reg_no": "string",
    "tax_no": "string",
    "social_security_no": "string",
    "currency": "string",
    "payment_term": 0,
    "email": "string",
    "preferred_locale": "string",
    "shopify_customer_id": 0,
    "stripe_customer_id": "string",
    "woocommerce_customer_id": 0,
    "eshop_customer_id": 0,
    "billing_address": {
      "id": 0,
      "address1": "string",
      "address2": "string",
      "postal_code": "string",
      "city": "string",
      "country": "string",
      "region": "string",
      "subregion": "string"
    },
    "shipping_address": {
      "id": 0,
      "address1": "string",
      "address2": "string",
      "postal_code": "string",
      "city": "string",
      "country": "string",
      "region": "string",
      "subregion": "string"
    },
    "taxes": [
      {
        "country": "string",
        "vat_no": "string"
      }
    ]
  },
  "items": [
    {
      "id": 0,
      "item": {
        "id": 0,
        "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "sku": "string",
        "name": "string",
        "barcode": "string",
        "country_of_origin": "string",
        "harmonized_system_code": "string",
        "weight_grams": 0,
        "rate": 0,
        "has_batches": true,
        "has_serial_no": true,
        "requires_shipping": true,
        "shopify_product_id": 0,
        "woocommerce_product_id": 0,
        "eshop_product_id": 0,
        "stock_unit": {
          "id": 0,
          "symbol": "string",
          "unece_code": "string",
          "iso_code": "string",
          "name": "string"
        },
        "l10n": [
          {
            "id": 0,
            "culture": "string",
            "name": "string",
            "description": "string"
          }
        ],
        "variants": [
          {
            "id": 0,
            "order": 0,
            "sku": "string",
            "barcode": "string",
            "country_of_origin": "string",
            "harmonized_system_code": "string",
            "weight_grams": 0,
            "dimension1": "string",
            "dimension2": "string",
            "dimension3": "string",
            "dimension4": "string",
            "dimension5": "string",
            "shopify_variant_id": 0,
            "woocommerce_variant_id": 0,
            "eshop_variant_id": 0
          }
        ],
        "dimensions": [
          {
            "order": 0,
            "name": "string",
            "values": [
              "string"
            ]
          }
        ],
        "taxes": [
          {
            "tax_index": 0,
            "tax_rate": 0
          }
        ]
      },
      "unit": {
        "unece_code": "string",
        "id": 0,
        "symbol": "string",
        "name": "string",
        "iso_code": "string"
      },
      "rate": 0,
      "qty_from": 0,
      "qty_to": 0,
      "stock_unit_rate": 0,
      "order": 0
    }
  ],
  "l10n": [
    {
      "id": 0,
      "culture": "string",
      "name": "string",
      "description": "string"
    }
  ]
}

Loading...