The Price List object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

enabled boolean

Default: true

price_list_name string required
currency string required
buying boolean

Default: false

selling boolean

Default: false

price_not_uom_dependent boolean

Default: false

The Price List object 
{
  "id": "price-list_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "enabled": true,
  "price_list_name": "price_list_name_example",
  "currency": "USD",
  "buying": false,
  "selling": false,
  "price_not_uom_dependent": false
}
GET /api/stock/price-list/{id}

Retrieve a price list

Retrieves the details of an existing price list. Supply the unique price list ID that was returned from a previous request.

Path parameters

id string required

The identifier of the price list to retrieve.

Returns

Returns the price list object if a valid identifier was provided.

GET /api/stock/price-list/{id} 
curl https://api.overplane.dev/api/stock/price-list/price-list_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "price-list_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "enabled": true,
  "price_list_name": "price_list_name_example",
  "currency": "USD",
  "buying": false,
  "selling": false,
  "price_not_uom_dependent": false
}
GET /api/stock/price-list

List all price lists

Returns a list of price lists. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of price list objects.

GET /api/stock/price-list 
curl https://api.overplane.dev/api/stock/price-list \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "price-list_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "enabled": true,
      "price_list_name": "price_list_name_example",
      "currency": "USD",
      "buying": false,
      "selling": false,
      "price_not_uom_dependent": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/price-list

Create a price list

Creates a new price list object.

Body parameters

enabled boolean

Default: true

price_list_name string required
currency string required
buying boolean

Default: false

selling boolean

Default: false

price_not_uom_dependent boolean

Default: false

Returns

Returns the newly created price list object if the call succeeded.

POST /api/stock/price-list 
curl https://api.overplane.dev/api/stock/price-list \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"price_list_name":"price_list_name_example","currency":"USD"}'
Response 
{
  "id": "price-list_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "enabled": true,
  "price_list_name": "price_list_name_example",
  "currency": "USD",
  "buying": false,
  "selling": false,
  "price_not_uom_dependent": false
}
PATCH /api/stock/price-list/{id}

Update a price list

Updates the specified price list by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the price list to update.

Body parameters

enabled boolean

Default: true

price_list_name string
currency string
buying boolean

Default: false

selling boolean

Default: false

price_not_uom_dependent boolean

Default: false

Returns

Returns the updated price list object.

PATCH /api/stock/price-list/{id} 
curl https://api.overplane.dev/api/stock/price-list/price-list_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"price_list_name":"price_list_name_example"}'
Response 
{
  "id": "price-list_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "enabled": true,
  "price_list_name": "price_list_name_example",
  "currency": "USD",
  "buying": false,
  "selling": false,
  "price_not_uom_dependent": false
}
DELETE /api/stock/price-list/{id}

Delete a price list

Permanently deletes a price list. This cannot be undone.

Path parameters

id string required

The identifier of the price list to delete.

Returns

Returns a confirmation that the price list has been deleted.

DELETE /api/stock/price-list/{id} 
curl https://api.overplane.dev/api/stock/price-list/price-list_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "price-list_abc123",
  "deleted": true
}

Line items

Child objects that belong to this price list. These are accessed via the parent's ID.

Price List Country

Attributes

idx integer
price_list_id string required
country string required

Endpoints

GET /api/stock/price-list-country?parent_id={id}
POST /api/stock/price-list-country
PATCH /api/stock/price-list-country/{id}
DELETE /api/stock/price-list-country/{id}
POST /api/stock/price-list-country/reorder
Price List Country object 
{
  "id": "price-list-country_abc123",
  "idx": 1,
  "price_list_id": "price_list_id_example",
  "country": "country_example"
}