This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26

GET /prices/{scope}

Get list of Prices

Description

Returns list of Prices

Parameters (path)

Name Required Description Values
scope optional Price scope. sales, purchase

Parameters (query)

Name Required Description Values
sortBy optional Field to sort by. Without sort specified it will sort first by ref and then name. sku.sku_code, sku.global_name, price_list.ref, price_list.name, price
sortDirection optional Direction of sort. asc, desc
price_list[eq] optional Search for prices by price list. Allowed expression(s): eq, in  
sku[eq] optional Search for prices by SKU. Allowed expression(s): eq, in  
include optional The resources that can be included in this request, delimited by a comma: sku  

Responses

200

successful operation

406

not acceptable

500

internal server error

PUT /prices/{scope}

Upserta price. Will check if an existing price with the same criterias already exists, otherwise it will create a new price

Description

Upsert a price with the given criterias.

Parameters (path)

Name Required Description Values
scope optional Price scope. sales, purchase

Request body

Description

Target PriceListPrice.

Required

This parameter is required.

Request body JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

{
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "composite_id": {
      "description": "Unique id created as a compund key from the criterias",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "correction_percentage": {
      "description": "Correction percentage for price lists setup to correct a fallback price list",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "delivered_from": {
      "description": "Delivered from date",
      "type": "string",
      "format": "date",
      "example": "2019-01-01"
    },
    "delivered_to": {
      "description": "Delivered to date",
      "type": "string",
      "format": "date",
      "example": "2019-01-01"
    },
    "price": {
      "description": "The unit price",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "price_list_id": {
      "description": "Id of the price list this price belongs to",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "quantity_from": {
      "description": "Lower quantity limit for this price",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "quantity_to": {
      "description": "Upper quantity limit for this price",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "sku_id": {
      "description": "Id of the SKU",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "weight": {
      "description": "The order-weight of this price",
      "type": "integer",
      "format": "int2",
      "default": 0,
      "example": 0
    },
    "active": {
      "description": "Boolean indicating if the record is active and could be referenced from other entities",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "updated_at": {
      "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2020-01-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

200

successful operation

Response content JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

{
  "properties": {
    "properties": {
      "id": {
        "description": "Id of the record",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "composite_id": {
        "description": "Unique id created as a compund key from the criterias",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "correction_percentage": {
        "description": "Correction percentage for price lists setup to correct a fallback price list",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "delivered_from": {
        "description": "Delivered from date",
        "type": "string",
        "format": "date",
        "example": "2019-01-01"
      },
      "delivered_to": {
        "description": "Delivered to date",
        "type": "string",
        "format": "date",
        "example": "2019-01-01"
      },
      "price": {
        "description": "The unit price",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "price_list_id": {
        "description": "Id of the price list this price belongs to",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "quantity_from": {
        "description": "Lower quantity limit for this price",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "quantity_to": {
        "description": "Upper quantity limit for this price",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "sku_id": {
        "description": "Id of the SKU",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "weight": {
        "description": "The order-weight of this price",
        "type": "integer",
        "format": "int2",
        "default": 0,
        "example": 0
      },
      "active": {
        "description": "Boolean indicating if the record is active and could be referenced from other entities",
        "type": "boolean",
        "format": "boolean",
        "example": true
      },
      "created_at": {
        "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "updated_at": {
        "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2020-01-01T13:25:32.312Z"
      }
    },
    "type": "object"
  },
  "type": "object"
}

403

Unauthorized request

406

not acceptable

500

Internal server error

POST /prices/{scope}

Create new Price

Description

Create a new Price

Parameters (path)

Name Required Description Values
scope optional Price scope. sales, purchase

Request body

Description

Target Price.

Required

This parameter is required.

Request body JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

{
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "composite_id": {
      "description": "Unique id created as a compund key from the criterias",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "correction_percentage": {
      "description": "Correction percentage for price lists setup to correct a fallback price list",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "delivered_from": {
      "description": "Delivered from date",
      "type": "string",
      "format": "date",
      "example": "2019-01-01"
    },
    "delivered_to": {
      "description": "Delivered to date",
      "type": "string",
      "format": "date",
      "example": "2019-01-01"
    },
    "price": {
      "description": "The unit price",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "price_list_id": {
      "description": "Id of the price list this price belongs to",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "quantity_from": {
      "description": "Lower quantity limit for this price",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "quantity_to": {
      "description": "Upper quantity limit for this price",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "sku_id": {
      "description": "Id of the SKU",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "weight": {
      "description": "The order-weight of this price",
      "type": "integer",
      "format": "int2",
      "default": 0,
      "example": 0
    },
    "active": {
      "description": "Boolean indicating if the record is active and could be referenced from other entities",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "updated_at": {
      "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2020-01-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

200

successful operation

Response content JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

{
  "properties": {
    "properties": {
      "id": {
        "description": "Id of the record",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "composite_id": {
        "description": "Unique id created as a compund key from the criterias",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "correction_percentage": {
        "description": "Correction percentage for price lists setup to correct a fallback price list",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "delivered_from": {
        "description": "Delivered from date",
        "type": "string",
        "format": "date",
        "example": "2019-01-01"
      },
      "delivered_to": {
        "description": "Delivered to date",
        "type": "string",
        "format": "date",
        "example": "2019-01-01"
      },
      "price": {
        "description": "The unit price",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "price_list_id": {
        "description": "Id of the price list this price belongs to",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "quantity_from": {
        "description": "Lower quantity limit for this price",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "quantity_to": {
        "description": "Upper quantity limit for this price",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "sku_id": {
        "description": "Id of the SKU",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "weight": {
        "description": "The order-weight of this price",
        "type": "integer",
        "format": "int2",
        "default": 0,
        "example": 0
      },
      "active": {
        "description": "Boolean indicating if the record is active and could be referenced from other entities",
        "type": "boolean",
        "format": "boolean",
        "example": true
      },
      "created_at": {
        "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "updated_at": {
        "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2020-01-01T13:25:32.312Z"
      }
    },
    "type": "object"
  },
  "type": "object"
}

406

not acceptable

500

internal server error