Merchant Customer Pricing Service ((dev))

Download OpenAPI specification:Download

API for managing merchant customer price lists and pricing rules.

List Customer Price Lists

Returns all customer price lists belonging to the merchant.

Authorizations:

idp

header Parameters

x-logitrail-merchant-id

required

string non-empty

Logitrail's Merchant ID.

Responses

Response samples

200
400

Content type

application/json

{"price_lists": [{"id": "string",
"key": "string",
"comment": "string",
"valid_from": null,
"pricing_rules": [{"criteria": {"operator": "and",
"criteria": [{"parameter": "order.shipping_type",
"operator": "=",
"string_value": "string"
}
]
},
"comment": "string",
"price_type": "gross_price",
"price_value": 0
}
],
"price_modification_rules": [{"criteria": {"operator": "and",
"criteria": [{"parameter": "order.shipping_type",
"operator": "=",
"string_value": "string"
}
]
},
"comment": "string",
"price_type": "gross_price",
"price_value": 0
}
],
"currency": "string",
"vat_percentage": 0,
"vat_handling": "including_vat",
"default_price": 0,
"status": "active"
}
]
}

Create Customer Price List

Creates a new customer price list.

Authorizations:

idp

header Parameters

x-logitrail-merchant-id

required

string non-empty

Logitrail's Merchant ID.

Request Body schema: application/json

required

object

key required	string non-empty
comment	string
valid_from required	string
	Array of objects
	Array of objects
currency	string
vat_percentage	number
vat_handling required	string Enum: "including_vat" "excluding_vat"
default_price	number

Responses

Request samples

Payload

Content type

application/json

{"price_list": {"key": "string",
"comment": "string",
"valid_from": "string",
"pricing_rules": [{"criteria": {"operator": "and",
"criteria": [{"parameter": "order.shipping_type",
"operator": "=",
"string_value": "string"
}
]
},
"comment": "string",
"price_type": "gross_price",
"price_value": 0
}
],
"price_modification_rules": [{"criteria": {"operator": "and",
"criteria": [{"parameter": "order.shipping_type",
"operator": "=",
"string_value": "string"
}
]
},
"comment": "string",
"price_type": "gross_price",
"price_value": 0
}
],
"currency": "string",
"vat_percentage": 0,
"vat_handling": "including_vat",
"default_price": 0
}
}

Response samples

201
400

Content type

application/json

{"price_list": {"id": "string",
"key": "string",
"comment": "string",
"valid_from": null,
"pricing_rules": [{"criteria": {"operator": "and",
"criteria": [{"parameter": "order.shipping_type",
"operator": "=",
"string_value": "string"
}
]
},
"comment": "string",
"price_type": "gross_price",
"price_value": 0
}
],
"price_modification_rules": [{"criteria": {"operator": "and",
"criteria": [{"parameter": "order.shipping_type",
"operator": "=",
"string_value": "string"
}
]
},
"comment": "string",
"price_type": "gross_price",
"price_value": 0
}
],
"currency": "string",
"vat_percentage": 0,
"vat_handling": "including_vat",
"default_price": 0,
"status": "active"
}
}

Get Customer Price List

Returns a single customer price list by ID.

Authorizations:

idp

path Parameters

priceListId

required

string^[a-f0-9]{24}$

Internal technical ID of the price list.

header Parameters

x-logitrail-merchant-id

required

string non-empty

Logitrail's Merchant ID.

Responses

Response samples

200
400
404

Content type

application/json

{"price_list": {"id": "string",
"key": "string",
"comment": "string",
"valid_from": null,
"pricing_rules": [{"criteria": {"operator": "and",
"criteria": [{"parameter": "order.shipping_type",
"operator": "=",
"string_value": "string"
}
]
},
"comment": "string",
"price_type": "gross_price",
"price_value": 0
}
],
"price_modification_rules": [{"criteria": {"operator": "and",
"criteria": [{"parameter": "order.shipping_type",
"operator": "=",
"string_value": "string"
}
]
},
"comment": "string",
"price_type": "gross_price",
"price_value": 0
}
],
"currency": "string",
"vat_percentage": 0,
"vat_handling": "including_vat",
"default_price": 0,
"status": "active"
}
}

Update Customer Price List

Updates an existing customer price list, including its pricing rules.

Authorizations:

idp

path Parameters

priceListId

required

string^[a-f0-9]{24}$

Internal technical ID of the price list.

header Parameters

x-logitrail-merchant-id

required

string non-empty

Logitrail's Merchant ID.

Request Body schema: application/json

required

object

key	string
	string or null
valid_from	string
	Array of objects
	Array of objects
	string or null
	number or null
vat_handling	string Enum: "including_vat" "excluding_vat"
	number or null

Responses

Request samples

Payload

Content type

application/json

{"price_list": {"key": "string",
"comment": "string",
"valid_from": "string",
"pricing_rules": [{"criteria": {"operator": "and",
"criteria": [{"parameter": "order.shipping_type",
"operator": "=",
"string_value": "string"
}
]
},
"comment": "string",
"price_type": "gross_price",
"price_value": 0
}
],
"price_modification_rules": [{"criteria": {"operator": "and",
"criteria": [{"parameter": "order.shipping_type",
"operator": "=",
"string_value": "string"
}
]
},
"comment": "string",
"price_type": "gross_price",
"price_value": 0
}
],
"currency": "string",
"vat_percentage": 0,
"vat_handling": "including_vat",
"default_price": 0
}
}

Response samples

200
400
404

Content type

application/json

{"price_list": {"id": "string",
"key": "string",
"comment": "string",
"valid_from": null,
"pricing_rules": [{"criteria": {"operator": "and",
"criteria": [{"parameter": "order.shipping_type",
"operator": "=",
"string_value": "string"
}
]
},
"comment": "string",
"price_type": "gross_price",
"price_value": 0
}
],
"price_modification_rules": [{"criteria": {"operator": "and",
"criteria": [{"parameter": "order.shipping_type",
"operator": "=",
"string_value": "string"
}
]
},
"comment": "string",
"price_type": "gross_price",
"price_value": 0
}
],
"currency": "string",
"vat_percentage": 0,
"vat_handling": "including_vat",
"default_price": 0,
"status": "active"
}
}

Delete Customer Price List (Not implemented)

Not implemented. Will soft-delete (disable) a customer price list once the legacy pricing engine supports skipping disabled lists.

Authorizations:

idp

path Parameters

priceListId

required

string^[a-f0-9]{24}$

Internal technical ID of the price list.

header Parameters

x-logitrail-merchant-id

required

string non-empty

Logitrail's Merchant ID.

Responses

Response samples

200
400
404

Content type

application/json

{"message": "string"
}