Price Lists

Retrieve a price list

get

Retrieve the details of a specific price list by ID.

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Price list retrieved successfully.

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/price_list/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "name": "Standard Price List",
  "code": "shop_price_list",
  "currency": "try",
  "is_auto_sync": true,
  "created_date": "2025-05-22T10:23:17.888Z",
  "modified_date": "2025-05-22T10:23:17.888Z"
}

Update a price list

put

Update the details of a specific price list by ID.

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

pkinteger · int64Optional

Price List ID

namestring · max: 64Optional

Name of the price list.

Example: Standard Price List

codestring | nullableOptional

Unique code for the price list. Can be null or blank.

Example: shop_price_list

currencystring · enumOptional

Currency type for the price list.

Example: tryPossible values:

is_auto_syncbooleanOptional

Indicates whether the price list is auto-synchronized with an external integration.

Default: falseExample: true

created_datestring · date-timeOptional

Creation Date of the Price List

modified_datestring · date-timeOptional

Last Modification Date of the Price List

Responses

200

Price list updated successfully.

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/price_list/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "pk": 1,
  "name": "Standard Price List",
  "code": "shop_price_list",
  "currency": "try",
  "is_auto_sync": true,
  "created_date": "2025-05-22T10:23:17.888Z",
  "modified_date": "2025-05-22T10:23:17.888Z"
}

{
  "pk": 1,
  "name": "Standard Price List",
  "code": "shop_price_list",
  "currency": "try",
  "is_auto_sync": true,
  "created_date": "2025-05-22T10:23:17.888Z",
  "modified_date": "2025-05-22T10:23:17.888Z"
}

Delete a price list

delete

Delete a specific price list by ID.

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

No content

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/price_list/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

List price lists

get

Retrieve a list of price lists with optional filtering.

Authorizations

Query parameters

namestringOptional

Filters by name

codestringOptional

Filter by code.

code__exactstringOptional

Filters by exact code

is_auto_syncbooleanOptional

Filter by auto-sync status.

Example: true

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

Responses

200

A list of price lists.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/price_list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

A list of price lists.

[
  {
    "pk": 1,
    "name": "Standard Price List",
    "code": "shop_price_list",
    "currency": "try",
    "is_auto_sync": true,
    "created_date": "2025-05-22T10:23:17.888Z",
    "modified_date": "2025-05-22T10:23:17.888Z"
  }
]

Create a price list

post

Create a new price list with the specified data.

Authorizations

Body

pkinteger · int64Optional

Price List ID

namestring · max: 64Optional

Name of the price list.

Example: Standard Price List

codestring | nullableOptional

Unique code for the price list. Can be null or blank.

Example: shop_price_list

currencystring · enumOptional

Currency type for the price list.

Example: tryPossible values:

is_auto_syncbooleanOptional

Indicates whether the price list is auto-synchronized with an external integration.

Default: falseExample: true

created_datestring · date-timeOptional

Creation Date of the Price List

modified_datestring · date-timeOptional

Last Modification Date of the Price List

Responses

201

Price list created successfully.

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

post

HTTPcURLJavaScriptPython

POST /api/v1/price_list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "pk": 1,
  "name": "Standard Price List",
  "code": "shop_price_list",
  "currency": "try",
  "is_auto_sync": true,
  "created_date": "2025-05-22T10:23:17.888Z",
  "modified_date": "2025-05-22T10:23:17.888Z"
}

{
  "pk": 1,
  "name": "Standard Price List",
  "code": "shop_price_list",
  "currency": "try",
  "is_auto_sync": true,
  "created_date": "2025-05-22T10:23:17.888Z",
  "modified_date": "2025-05-22T10:23:17.888Z"
}