Getting Customer Order List
Method Description
Invoked with a POST request. Operation name is set up via Maestra framework.
POST https://api.maestra.io/v3/operations/sync?endpointId={API endpoint ID}&operation=OperationSystemName
Content-Type: application/json; charset=utf-8
Accept: application/json
Authorization: SecretKey {Secret Key}
Sample Operation
{
"page": {
"pageNumber": "<Page number, starting from 1 (no greater than 21474831)>",
"itemsPerPage": "<Number of items per page (max. 1000)>",
"sinceDateTimeUtc": "<The left border of the Customer Change time (inclusive)>",
"tillDateTimeUtc": "<The right border of the Customer change time (not inclusive). The right border must be at least five minutes less than the current time.>"
}
}
Response
{
"status": "<Request execution response: Success on successful execution, ValidationError on user error, ProtocolError on integration error, InternalServerError on server unavailability.>",
"orders": [
{
"firstPointOfContact": {
"ids": {
"pointOfContactId": "<Maestra id>",
"externalId": "<Touchpoint external ID>"
},
"name": "<Touchpoint name>"
},
"ids": {
"retailOrderId": "<Maestra id>"
},
"totalPrice": "<Order price including discounts>",
"lines": [
{
"product": {
"ids": {
"mindboxId": "<Maestra id>",
"website": "<SKU ID in website>"
}
},
"quantity": "<Number of units of product>",
"quantityType": "<Quantity type (int or double)>",
"basePricePerItem": "<Product base price per unit>",
"priceOfLine": "<line final price>",
"status": {
"ids": {
"externalId": "<Line status ID>"
},
"category": "<Line status ID>"
},
"appliedPromotions": [
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"balanceType": {
"ids": {
"systemName": "<Points balance system name>"
},
"name": "<Points account name>"
},
"amount": "<Value of the applied promotion>",
"expirationDateTimeUtc": "<Points expiry date>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"balanceType": {
"ids": {
"systemName": "<Points balance system name>"
},
"name": "<Points account name>"
},
"spentBonusPointsAmount": "<Used bonus points the applied promotion>",
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"issuedCoupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
}
},
{
"type": "<Applied promotion type>",
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"amount": "<Value of the applied promotion>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
}
},
{
"type": "<Applied promotion type>",
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"amount": "<Value of the applied promotion>"
}
],
"giftCard": {
"amount": "<Value>",
"ids": {
"number": "<Gift card number>"
},
"status": {
"ids": {
"systemName": "<Card status system name>"
}
},
"product": {
"ids": {
"mindboxId": "<Maestra id>",
"website": "<product ID in website>"
},
"sku": {
"ids": {
"mindboxId": "<Maestra id>",
"website": "<SKU ID in website>"
}
}
},
"basePricePerItem": "<Card price>"
},
"lineNumber": "<Order item number>",
"lineId": "<Order item ID>",
"minPricePerItem": "<Minimum price per unit of product>"
},
{
"product": {
"ids": {
"mindboxId": "<Maestra id>",
"website": "<SKU ID in website>"
}
},
"quantity": "<Number of units of product>",
"quantityType": "<Quantity type (int or double)>",
"basePricePerItem": "<Product base price per unit>",
"priceOfLine": "<line final price>",
"status": {
"ids": {
"externalId": "<Line status ID>"
},
"category": "<Line status ID>"
},
"appliedPromotions": [
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"balanceType": {
"ids": {
"systemName": "<Points balance system name>"
},
"name": "<Points account name>"
},
"amount": "<Value of the applied promotion>",
"expirationDateTimeUtc": "<Points expiry date>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"balanceType": {
"ids": {
"systemName": "<Points balance system name>"
},
"name": "<Points account name>"
},
"spentBonusPointsAmount": "<Used bonus points the applied promotion>",
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"issuedCoupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
}
},
{
"type": "<Applied promotion type>",
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"amount": "<Value of the applied promotion>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
}
},
{
"type": "<Applied promotion type>",
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"amount": "<Value of the applied promotion>"
}
],
"giftCard": {
"amount": "<Value>",
"ids": {
"number": "<Gift card number>"
},
"status": {
"ids": {
"systemName": "<Card status system name>"
}
},
"product": {
"ids": {
"mindboxId": "<Maestra id>",
"website": "<product ID in website>"
},
"sku": {
"ids": {
"mindboxId": "<Maestra id>",
"website": "<SKU ID in website>"
}
}
},
"basePricePerItem": "<Card price>"
},
"lineNumber": "<Order item number>",
"lineId": "<Order item ID>",
"minPricePerItem": "<Minimum price per unit of product>"
}
],
"appliedPromotions": [
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"balanceType": {
"ids": {
"systemName": "<Points balance system name>"
},
"name": "<Points account name>"
},
"amount": "<Value of the applied promotion>",
"expirationDateTimeUtc": "<Points expiry date>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"balanceType": {
"ids": {
"systemName": "<Points balance system name>"
},
"name": "<Points account name>"
},
"spentBonusPointsAmount": "<Used bonus points the applied promotion>",
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"limits": [
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
},
{
"type": "<Entity the limit will apply to (customer or promotion)>",
"amount": {
"type": "<Limit type (number of uses, discount amount)>",
"value": "<Value of limit>"
},
"used": {
"usageServiceStatus": "<Limit usage>",
"amount": "<Limit usage>"
},
"untilDateTimeUtc": "<Limit expires on:>"
}
],
"groupingKey": "<Applied promotions grouping key>",
"issuedCoupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
}
},
{
"type": "<Applied promotion type>",
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"amount": "<Value of the applied promotion>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
}
},
{
"type": "<Applied promotion type>",
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"promotion": {
"ids": {
"externalId": "<Promotion external ID>"
},
"name": "<Promotion name>",
"type": "<Promotion type>"
},
"amount": "<Value of the applied promotion>"
},
{
"type": "<Applied promotion type>",
"coupon": {
"ids": {
"code": "<Promo code>"
},
"pool": {
"ids": {
"promoCodePoolId": "<Maestra id>",
"externalId": "<Promo code pool external ID>"
},
"name": "<Promo code pool name>",
"description": "<Promo code pool description>"
}
},
"amount": "<Value of the applied promotion>"
}
],
"area": {
"ids": {
"externalId": "<Customer geographical area ID>"
}
},
"deliveryCost": "<Delivery cost>",
"payments": [
{
"type": "<Payment type>",
"id": "<Payment ID>",
"amount": "<Payment amount applied to order>",
"promoActionId": "<Promotion ID>",
"creditCard": {
"hash": "<Credit card hash>"
},
"balanceType": {
"ids": {
"systemName": "<Points balance system name>"
},
"name": "<Points account name>"
}
},
{
"type": "<Payment type>",
"id": "<Payment ID>",
"amount": "<Payment amount applied to order>",
"promoActionId": "<Promotion ID>",
"creditCard": {
"hash": "<Credit card hash>"
},
"balanceType": {
"ids": {
"systemName": "<Points balance system name>"
},
"name": "<Points account name>"
}
}
],
"bonusPointsInfoPerBalanceTypes": [
{
"balanceType": {
"ids": {
"systemName": "<Points balance system name>"
},
"name": "<Points account name>"
},
"earnedAmount": "<Earned bonus points within the order>",
"spentAmount": "<Spent bonus points within the order>"
},
{
"balanceType": {
"ids": {
"systemName": "<Points balance system name>"
},
"name": "<Points account name>"
},
"earnedAmount": "<Earned bonus points within the order>",
"spentAmount": "<Spent bonus points within the order>"
}
],
"createDateTimeUtc": "<Order start date in UTC>"
}
]
}
Updated 16 days ago