Orders
Orders are replicas of the orders generated by external software (e.g. web shops, ordering apps, POS systems, kiosks et cetera), to be used by Leat as the driving force behind our Loyalty, Marketing, Data and Automation tools. In the Leat dashboard, clients can setup Actions to be triggered after the successful creation of an Order in the Leat system. This can result in Leat objects such as a Points Transaction or a Prepaid Transaction.
Using Orders for Loyalty purposes requires two steps:
- Creating the Order: Replicates the Order in the Leat system.
- Processing the Order: Clients will set up their so-called Order Action in their dashboard to decide how to process the Order within the Leat system. This will usually entail converting the Order into a Points Transaction (currently the only option, to be extended in the near future).
For some integrations, it makes sense to split the two steps, and only perform the second step under certain circumstances. For most integrations, however, both steps are required. To make it easier for those, a combined Create and Process Order endpoint has been added.
New conventions
Please note: this API call uses conventions that will be used in the V4 version of our API and from this points onwards. If you're already familiar with our API, take note of the following:
- 'business_profile' instead of 'shop': This entity has already been renamed in the Leat dashboard for some time now and will be named as such in API calls.
- Refactor of Credit Receptions: As part of a larger refactor of the core of our Loyalty engine, some new entities have been introduced, whilst others have been renamed. For this particular API, this means a
points_transactionwill be returned as a result instead ofcredit_reception. - Input parameters: For previous API endpoints, input parameters like a Contact's UUID were given as
contact_uuid. In this newest endpoint, an object is expected instead.
Create And Process Order
RECOMMENDED
Creates a new Order in the Leat system and directly processes it. Returns both the Order entity itself and a result object containing the result of the Order Action as configured by the Client. Currently, the only type of Order Action supported is the creation of a Points Transaction. However, please take into account that more result types will be added in the future (e.g. Prepaid Transaction).
Note that all monetary amounts – like total_order_amount – are to be given in the currency's lowest denomination (e.g. €34,50 -> 3450).
POST
https://api.piggy.eu/api/v3/oauth/clients/orders/create-and-processHeaders
Authorization
Accept
Bearer {{ personal_access_token }}application/jsonInput parameters
external_identifierstringrequiredA unique identifier from your system
referencestringoptionalA human readable identifier from your system, for reference purposes only
statusstringrequiredStatus of the order
Possible values:
CREATEDOrder has just been created, not yet completedPENDINGPending fulfilment and/or paymentCOMPLETEDOrder has been completedCANCELLEDOrder was cancelled before completionpayment_statusstringrequiredStatus of the payment of the order
Possible values:
UNPAIDPayment process has not been startedPENDINGPayment process started, pending confirmationPAIDPayment successfultotal_order_amountnumberrequiredTotal order amount, after discounts and other charges, in the currency's lowest denomination.
order_amountnumberoptionalTotal order amount, before discounts and other charges, in the currency's lowest denomination
total_discount_amountnumberoptionalTotal discount amount, in the currency's lowest denomination
currencystringoptionalOrder currency in ISO 4217 format; defaults to Account's default currency
paid_atstringoptionalThe date and time this Order was paid, in ISO 8601 format
completed_atstringoptionalThe date and time this Order was completed, in ISO 8601 format
contactobjectrequiredContact who made the Order
uuidstringrequiredUUID of the Contact
business_profileobjectrequiredLocation where the Order took place
uuidstringrequiredUUID of the Business Profile
line_itemsarray of objectsrequiredList of Products in this Order
external_identifierstringrequiredA unique identifier for this Line Item
namestringrequiredName of the Line Item
quantitynumberrequiredQuantity of the Line Item
pricenumberrequiredPrice per unit of this Line Item
total_amountnumberrequiredTotal amount of this Line Item, in the currency's lowest denomination, after discounts
discount_amountnumberoptionalDiscount amount of this Line Item, in the currency's lowest denomination
productobjectoptionalAssociated Product, which enables the Product filtering feature. If specified, either uuid or external_identifier is required.
uuidstringrequired if external_identifier is missingUUID used to identify the Product, which takes precedence above external_identifier if both given
external_identifierstringrequired if uuid is missingUnique identifier to identify the Product
resultobjectoptionalResulting Leat object, if applicable. Possible options: Giftcard Transaction, Prepaid Transaction and Voucher.
uuidstringrequiredUUID used to identify the resulting Leat object
typestringrequiredType of the resulting Leat object
Possible values:
GIFTCARD_TRANSACTIONGiftcard TransactionPREPAID_TRANSACTIONPrepaid TransactionVOUCHERVouchersub_line_itemsarray of objectsoptionalList of Sub Line Items of this Line Item
external_identifierstringrequiredA unique identifier for this Sub Line Item
namestringrequiredName of the Sub Line Item
quantitynumberrequiredQuantity of the Sub Line Item
pricenumberrequiredPrice per unit of this Sub Line Item
total_amountnumberrequiredTotal amount of this Sub Line Item, in the currency's lowest denomination, after discounts
discount_amountnumberoptionalDiscount amount of this Sub Line Item, in the currency's lowest denomination
productobjectoptionalAssociated Product, which enables the Product filtering feature. If specified, either uuid or external_identifier is required.
uuidstringrequired if undefinedUUID to identify the Product
external_identifierstringrequired if undefinedUnique identifier to identify the Product
applied_discountsarray of objectsoptionalList of Discounts applied to this Order
external_identifierstringrequiredUnique identifier to the Discount
namestringrequiredName of the Discount
amountnumberrequiredResulting monetary discount amount in the currency's lowest denomination
typestringoptionalType of the Discount
Possible values:
PERCENTAGEFor percentage based discountsABSOLUTEFor absolute discountsvaluenumberoptionalThe value of either the percentage or absolute discount
applied_tostringrequiredIndicates if Discount is applied to Order or to one or more (Sub) Line Items
Possible values:
ORDERIndicates Discount is applied on an Order levelORDER_LINESIndicates Discount is applied to individual Line Items, Sub Line Items, and/or Chargesline_itemsarray of objectsoptionalList of Line Items to which this Discount was applied
external_identifierstringrequiredUnique identifier to the Line Item with which it's identified under line_items
sub_line_itemsarray of objectsoptionalList of Sub Line Items to which this Discount was applied
external_identifierstringrequiredUnique identifier to the Sub Line Item with which it's identified under sub_line_items
chargesarray of objectsoptionalList of Charges to which this Discount was applied
external_identifierstringrequiredUnique identifier to the Charge with which it's identified under charges
offerobjectoptionalCorresponding Leat Offer if applicable. Possible options: Reward Redemption, Collectable Reward Redemption and Voucher Redemption.
uuidstringrequiredUUID used to identify the Leat offer redemption
typestringrequiredType of the Leat Offer
Possible values:
REWARD_REDEMPTIONReward RedemptionCOLLECTABLE_REWARD_REDEMPTIONCollectable Reward RedemptionVOUCHER_REDEMPTIONVoucher Redemptionchargesarray of objectsoptionalAny charges not included as line items. E.g. gratuity, service charges or shipping
external_identifierstringrequiredUnique identifier to the Charge
typestringoptionaldeprecatedDeprecated: Please use charge_definition instead.
namestringrequiredA human readable reference to the charge
amountnumberoptionalThe cost of the charge, before discounts, in the currency's lowest denomination
discount_amountnumberoptionalThe discount amount, in the currency's lowest denomination
total_amountnumberrequiredThe total cost of the charge, after discounts, in the currency's lowest denomination
charge_definitionobjectoptionalThe charge definition, for use in rules and exclusions. Every account has a few definitions by default, with external identifiers: SERVICE_CHARGE.
Default definitions:
SERVICE_CHARGEA service charge applied to the orderGRATUITYGratuity or tipSHIPPINGShipping costsWRAPPINGWrapping costsTAXSeparate tax charges. Do not add if taxes are already included in line item total amounts.uuidstringrequired if undefinedUUID to identify the Charge Definition
external_identifierstringrequired if undefinedUnique identifier to identify the Charge Definition (use for default Charge Definitions)
paymentsarray of objectsoptionalAny payments made for this Order using Leat objects. Note: currently accepts Giftcard Transactions and Prepaid Transactions only.
uuidstringrequiredUUID used to identify the Leat Payment
typestringrequiredType of Leat Payment
Possible values:
GIFTCARD_TRANSACTIONGiftcard TransactionPREPAID_TRANSACTIONPrepaid TransactionResponse Example
Show more
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
94
95
96
97
98
99
100
101
102
103
104
105
{
"data": {
"order": {
"uuid": "bfada889-6a69-4fcf-aed6-42933ae9084d",
"contact": {
"uuid": "12345-abcdefg-6789-yuiop",
"email": "spongebob@bikinibottom.sea"
},
"business_profile": {
"uuid": "12345-abcdefg-6789-yuiop",
"name": "HeadQuarters"
},
"external_identifier": "EXT-0012",
"reference": "Order B-2110",
"status": "COMPLETED",
"payment_status": "PAID",
"currency": "EUR",
"formatted_total_order_amount": "€ 33.31",
"order_amount": 3175,
"total_charges_amount": 381,
"total_discount_amount": 225,
"total_order_amount": 3331,
"paid_at": "2025-05-01T20:10:44+00:00",
"completed_at": "2025-05-01T20:11:03+00:00",
"line_items": [
{
"uuid": "021as-8892k-ljkafds-98as",
"external_identifier": "LI_IT_11090_lkajsf",
"name": "Double Krabby Patty",
"quantity": 2,
"price": 1250,
"total_amount": 2500,
"discount_amount": 0,
"product": {
"external_identifier": "PR-12-401",
"name": "Double Krabby Patty",
},
"sub_line_items": [
{
"uuid": "87a4be97-73dd-40a4",
"external_identifier": "SU_LI_IT_11090_lkajsf",
"name": "Extra Secret Sauce",
"quantity": 1,
"price": 500,
"total_amount": 500,
"discount_amount": 0,
"product": {
"external_identifier": "PR-15-454",
"name": "Extra Secret Sauce",
}
}
]
},
{
"uuid": "187-8Dfadf3-lsdf234ds-99ass",
"external_identifier": "LI_IT_991_Ac990s",
"name": "Kelp Soda",
"quantity": 2,
"price": 450,
"total_amount": 675,
"discount_amount": 225,
"product": {
"external_identifier": "PR-12-401",
"name": "Double Krabby Patty",
},
},
],
"applied_discounts": [
{
"uuid": "021as-8892k-ljkafds-98as",
"external_identifier": "DISC_25_OFF_DRINKS",
"name": "25% off Drinks",
"amount": 225,
"type": "PERCENTAGE",
"value": 25,
"applied_to": "LINE_ITEM",
"line_items": [
{
"external_identifier": "LI_IT_991_Ac990s",
},
],
},
"charges": [
{
"external_identifier": "SRV_CH-12",
"type": "SERVICE_CHARGE",
"name": "Service charge: 12%",
"amount": 381,
"discount_amount": 0,
"total_amount": 0
},
],
"created_at": "2025-05-01T20:11:58+00:00",
"updated_at": "2025-05-01T20:11:58+00:00"
},
"result": {
"type": "POINTS_TRANSACTION",
"data": {
"points": 35,
"new_balance": 2267,
}
}
},
"meta": []
}Create Order
Creates a new Order in the Leat system. It does not yet process the Order, so no Points Transaction will be created just yet. Call the Process Order endpoint to convert the Order into a Points Transaction. Alternatively, use the Create and Process Order endpoint instead.
Note that all monetary amounts – like total_order_amount – are to be given in the currency's lowest denomination (e.g. €34,50 -> 3450).
POST
https://api.piggy.eu/api/v3/oauth/clients/ordersHeaders
Authorization
Accept
Bearer {{ personal_access_token }}application/jsonInput parameters
external_identifierstringrequiredA unique identifier from your system
referencestringoptionalA human readable identifier from your system, for reference purposes only
statusstringrequiredStatus of the order
Possible values:
CREATEDOrder has just been created, not yet completedPENDINGPending fulfilment and/or paymentCOMPLETEDOrder has been completedCANCELLEDOrder was cancelled before completionpayment_statusstringrequiredStatus of the payment of the order
Possible values:
UNPAIDPayment process has not been startedPENDINGPayment process started, pending confirmationPAIDPayment successfultotal_order_amountnumberrequiredTotal order amount, after discounts and other charges, in the currency's lowest denomination.
order_amountnumberoptionalTotal order amount, before discounts and other charges, in the currency's lowest denomination
total_discount_amountnumberoptionalTotal discount amount, in the currency's lowest denomination
currencystringoptionalOrder currency in ISO 4217 format; defaults to Account's default currency
paid_atstringoptionalThe date and time this Order was paid, in ISO 8601 format
completed_atstringoptionalThe date and time this Order was completed, in ISO 8601 format
contactobjectrequiredContact who made the Order
uuidstringrequiredUUID of the Contact
business_profileobjectrequiredLocation where the Order took place
uuidstringrequiredUUID of the Business Profile
line_itemsarray of objectsrequiredList of Products in this Order
external_identifierstringrequiredA unique identifier for this Line Item
namestringrequiredName of the Line Item
quantitynumberrequiredQuantity of the Line Item
pricenumberrequiredPrice per unit of this Line Item
total_amountnumberrequiredTotal amount of this Line Item, in the currency's lowest denomination, after discounts
discount_amountnumberoptionalDiscount amount of this Line Item, in the currency's lowest denomination
productobjectoptionalAssociated Product, which enables the Product filtering feature. If specified, either uuid or external_identifier is required.
uuidstringrequired if external_identifier is missingUUID used to identify the Product, which takes precedence above external_identifier if both given
external_identifierstringrequired if uuid is missingUnique identifier to identify the Product
resultobjectoptionalResulting Leat object, if applicable. Possible options: Giftcard Transaction, Prepaid Transaction and Voucher.
uuidstringrequiredUUID used to identify the resulting Leat object
typestringrequiredType of the resulting Leat object
Possible values:
GIFTCARD_TRANSACTIONGiftcard TransactionPREPAID_TRANSACTIONPrepaid TransactionVOUCHERVouchersub_line_itemsarray of objectsoptionalList of Sub Line Items of this Line Item
external_identifierstringrequiredA unique identifier for this Sub Line Item
namestringrequiredName of the Sub Line Item
quantitynumberrequiredQuantity of the Sub Line Item
pricenumberrequiredPrice per unit of this Sub Line Item
total_amountnumberrequiredTotal amount of this Sub Line Item, in the currency's lowest denomination, after discounts
discount_amountnumberoptionalDiscount amount of this Sub Line Item, in the currency's lowest denomination
productobjectoptionalAssociated Product, which enables the Product filtering feature. If specified, either uuid or external_identifier is required.
uuidstringrequired if undefinedUUID to identify the Product
external_identifierstringrequired if undefinedUnique identifier to identify the Product
applied_discountsarray of objectsoptionalList of Discounts applied to this Order
external_identifierstringrequiredUnique identifier to the Discount
namestringrequiredName of the Discount
amountnumberrequiredResulting monetary discount amount in the currency's lowest denomination
typestringoptionalType of the Discount
Possible values:
PERCENTAGEFor percentage based discountsABSOLUTEFor absolute discountsvaluenumberoptionalThe value of either the percentage or absolute discount
applied_tostringrequiredIndicates if Discount is applied to Order or to one or more (Sub) Line Items
Possible values:
ORDERIndicates Discount is applied on an Order levelORDER_LINESIndicates Discount is applied to individual Line Items, Sub Line Items, and/or Chargesline_itemsarray of objectsoptionalList of Line Items to which this Discount was applied
external_identifierstringrequiredUnique identifier to the Line Item with which it's identified under line_items
sub_line_itemsarray of objectsoptionalList of Sub Line Items to which this Discount was applied
external_identifierstringrequiredUnique identifier to the Sub Line Item with which it's identified under sub_line_items
chargesarray of objectsoptionalList of Charges to which this Discount was applied
external_identifierstringrequiredUnique identifier to the Charge with which it's identified under charges
offerobjectoptionalCorresponding Leat Offer if applicable. Possible options: Reward Redemption, Collectable Reward Redemption and Voucher Redemption.
uuidstringrequiredUUID used to identify the Leat offer redemption
typestringrequiredType of the Leat Offer
Possible values:
REWARD_REDEMPTIONReward RedemptionCOLLECTABLE_REWARD_REDEMPTIONCollectable Reward RedemptionVOUCHER_REDEMPTIONVoucher Redemptionchargesarray of objectsoptionalAny charges not included as line items. E.g. gratuity, service charges or shipping
external_identifierstringrequiredUnique identifier to the Charge
typestringoptionaldeprecatedDeprecated: Please use charge_definition instead.
namestringrequiredA human readable reference to the charge
amountnumberoptionalThe cost of the charge, before discounts, in the currency's lowest denomination
discount_amountnumberoptionalThe discount amount, in the currency's lowest denomination
total_amountnumberrequiredThe total cost of the charge, after discounts, in the currency's lowest denomination
charge_definitionobjectoptionalThe charge definition, for use in rules and exclusions. Every account has a few definitions by default, with external identifiers: SERVICE_CHARGE.
Default definitions:
SERVICE_CHARGEA service charge applied to the orderGRATUITYGratuity or tipSHIPPINGShipping costsWRAPPINGWrapping costsTAXSeparate tax charges. Do not add if taxes are already included in line item total amounts.uuidstringrequired if undefinedUUID to identify the Charge Definition
external_identifierstringrequired if undefinedUnique identifier to identify the Charge Definition (use for default Charge Definitions)
paymentsarray of objectsoptionalAny payments made for this Order using Leat objects. Note: currently accepts Giftcard Transactions and Prepaid Transactions only.
uuidstringrequiredUUID used to identify the Leat Payment
typestringrequiredType of Leat Payment
Possible values:
GIFTCARD_TRANSACTIONGiftcard TransactionPREPAID_TRANSACTIONPrepaid TransactionResponse Example
Show more
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
94
95
96
{
"data": {
"uuid": "bfada889-6a69-4fcf-aed6-42933ae9084d",
"contact": {
"uuid": "12345-abcdefg-6789-yuiop",
"email": "spongebob@bikinibottom.sea"
},
"business_profile": {
"uuid": "12345-abcdefg-6789-yuiop",
"name": "HeadQuarters"
},
"external_identifier": "EXT-0012",
"reference": "Order B-2110",
"status": "COMPLETED",
"payment_status": "PAID",
"currency": "EUR",
"formatted_total_order_amount": "€ 33.31",
"order_amount": 3175,
"total_charges_amount": 381,
"total_discount_amount": 225,
"total_order_amount": 3331,
"paid_at": "2025-05-01T20:10:44+00:00",
"completed_at": "2025-05-01T20:11:03+00:00",
"line_items": [
{
"uuid": "021as-8892k-ljkafds-98as",
"external_identifier": "LI_IT_11090_lkajsf",
"name": "Double Krabby Patty",
"quantity": 2,
"price": 1250,
"total_amount": 2500,
"discount_amount": 0,
"product": {
"external_identifier": "PR-12-401",
"name": "Double Krabby Patty",
},
"sub_line_items": [
{
"uuid": "87a4be97-73dd-40a4",
"external_identifier": "SU_LI_IT_11090_lkajsf",
"name": "Extra Secret Sauce",
"quantity": 1,
"price": 500,
"total_amount": 500,
"discount_amount": 0,
"product": {
"external_identifier": "PR-15-454",
"name": "Extra Secret Sauce",
}
}
]
},
{
"uuid": "187-8Dfadf3-lsdf234ds-99ass",
"external_identifier": "LI_IT_991_Ac990s",
"name": "Kelp Soda",
"quantity": 2,
"price": 450,
"total_amount": 675,
"discount_amount": 225,
"product": {
"external_identifier": "PR-12-401",
"name": "Double Krabby Patty",
},
},
],
"applied_discounts": [
{
"uuid": "021as-8892k-ljkafds-98as",
"external_identifier": "DISC_25_OFF_DRINKS",
"name": "25% off Drinks",
"amount": 225,
"type": "PERCENTAGE",
"value": 25,
"applied_to": "LINE_ITEM",
"line_items": [
{
"external_identifier": "LI_IT_991_Ac990s",
},
],
},
"charges": [
{
"external_identifier": "SRV_CH-12",
"type": "SERVICE_CHARGE",
"name": "Service charge: 12%",
"amount": 381,
"discount_amount": 0,
"total_amount": 0
},
],
"created_at": "2025-05-01T20:11:58+00:00",
"updated_at": "2025-05-01T20:11:58+00:00"
},
"meta": []
}Process Order
Processes an existing Order in the Leat system and returns a result object. If an Order Action was configured for the Account, then this is executed in sync and will fill the result object. An example of such a result would be a transaction containing loyalty points.
POST
https://api.piggy.eu/api/v3/oauth/clients/orders/{uuid}/processHeaders
Authorization
Accept
Bearer {{ personal_access_token }}application/jsonInput parameters
uuidstringrequiredThe uuid of the order in your Leat system
Response Example
Show more
1
2
3
4
5
6
7
8
9
10
{
"data": {
"type": "POINTS_TRANSACTION",
"data": {
"points": 35,
"new_balance": 2267,
}
},
"meta": []
}Find Order
Use the external_identifier to find an Order.
GET
https://api.piggy.eu/api/v3/oauth/clients/orders/findHeaders
Authorization
Accept
Bearer {{ personal_access_token }}application/jsonInput parameters
external_identifierstringrequiredA unique identifier from your system
Response Example
Show more
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
94
95
96
{
"data": {
"uuid": "bfada889-6a69-4fcf-aed6-42933ae9084d",
"contact": {
"uuid": "12345-abcdefg-6789-yuiop",
"email": "spongebob@bikinibottom.sea"
},
"business_profile": {
"uuid": "12345-abcdefg-6789-yuiop",
"name": "HeadQuarters"
},
"external_identifier": "EXT-0012",
"reference": "Order B-2110",
"status": "COMPLETED",
"payment_status": "PAID",
"currency": "EUR",
"formatted_total_order_amount": "€ 33.31",
"order_amount": 3175,
"total_charges_amount": 381,
"total_discount_amount": 225,
"total_order_amount": 3331,
"paid_at": "2025-05-01T20:10:44+00:00",
"completed_at": "2025-05-01T20:11:03+00:00",
"line_items": [
{
"uuid": "021as-8892k-ljkafds-98as",
"external_identifier": "LI_IT_11090_lkajsf",
"name": "Double Krabby Patty",
"quantity": 2,
"price": 1250,
"total_amount": 2500,
"discount_amount": 0,
"product": {
"external_identifier": "PR-12-401",
"name": "Double Krabby Patty",
},
"sub_line_items": [
{
"uuid": "87a4be97-73dd-40a4",
"external_identifier": "SU_LI_IT_11090_lkajsf",
"name": "Extra Secret Sauce",
"quantity": 1,
"price": 500,
"total_amount": 500,
"discount_amount": 0,
"product": {
"external_identifier": "PR-15-454",
"name": "Extra Secret Sauce",
}
}
]
},
{
"uuid": "187-8Dfadf3-lsdf234ds-99ass",
"external_identifier": "LI_IT_991_Ac990s",
"name": "Kelp Soda",
"quantity": 2,
"price": 450,
"total_amount": 675,
"discount_amount": 225,
"product": {
"external_identifier": "PR-12-401",
"name": "Double Krabby Patty",
},
},
],
"applied_discounts": [
{
"uuid": "021as-8892k-ljkafds-98as",
"external_identifier": "DISC_25_OFF_DRINKS",
"name": "25% off Drinks",
"amount": 225,
"type": "PERCENTAGE",
"value": 25,
"applied_to": "LINE_ITEM",
"line_items": [
{
"external_identifier": "LI_IT_991_Ac990s",
},
],
},
"charges": [
{
"external_identifier": "SRV_CH-12",
"type": "SERVICE_CHARGE",
"name": "Service charge: 12%",
"amount": 381,
"discount_amount": 0,
"total_amount": 0
},
],
"created_at": "2025-05-01T20:11:58+00:00",
"updated_at": "2025-05-01T20:11:58+00:00"
},
"meta": []
}Update Order
Use the uuid to update an existing Order.
PUT
https://api.piggy.eu/api/v3/oauth/clients/orders/{uuid}Headers
Authorization
Accept
Bearer {{ personal_access_token }}application/jsonInput parameters
statusstringoptionalStatus of the order
Possible values:
CREATEDOrder has just been created, not yet completedPENDINGPending fulfilment and/or paymentCOMPLETEDOrder has been completedCANCELLEDOrder was cancelled before completionpayment_statusstringoptionalStatus of the payment of the order
Possible values:
UNPAIDPayment process has not been startedPENDINGPayment process started, pending confirmationPAIDPayment successfulResponse Example
Show more
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
94
95
96
{
"data": {
"uuid": "bfada889-6a69-4fcf-aed6-42933ae9084d",
"contact": {
"uuid": "12345-abcdefg-6789-yuiop",
"email": "spongebob@bikinibottom.sea"
},
"business_profile": {
"uuid": "12345-abcdefg-6789-yuiop",
"name": "HeadQuarters"
},
"external_identifier": "EXT-0012",
"reference": "Order B-2110",
"status": "COMPLETED",
"payment_status": "PAID",
"currency": "EUR",
"formatted_total_order_amount": "€ 33.31",
"order_amount": 3175,
"total_charges_amount": 381,
"total_discount_amount": 225,
"total_order_amount": 3331,
"paid_at": "2025-05-01T20:10:44+00:00",
"completed_at": "2025-05-01T20:11:03+00:00",
"line_items": [
{
"uuid": "021as-8892k-ljkafds-98as",
"external_identifier": "LI_IT_11090_lkajsf",
"name": "Double Krabby Patty",
"quantity": 2,
"price": 1250,
"total_amount": 2500,
"discount_amount": 0,
"product": {
"external_identifier": "PR-12-401",
"name": "Double Krabby Patty",
},
"sub_line_items": [
{
"uuid": "87a4be97-73dd-40a4",
"external_identifier": "SU_LI_IT_11090_lkajsf",
"name": "Extra Secret Sauce",
"quantity": 1,
"price": 500,
"total_amount": 500,
"discount_amount": 0,
"product": {
"external_identifier": "PR-15-454",
"name": "Extra Secret Sauce",
}
}
]
},
{
"uuid": "187-8Dfadf3-lsdf234ds-99ass",
"external_identifier": "LI_IT_991_Ac990s",
"name": "Kelp Soda",
"quantity": 2,
"price": 450,
"total_amount": 675,
"discount_amount": 225,
"product": {
"external_identifier": "PR-12-401",
"name": "Double Krabby Patty",
},
},
],
"applied_discounts": [
{
"uuid": "021as-8892k-ljkafds-98as",
"external_identifier": "DISC_25_OFF_DRINKS",
"name": "25% off Drinks",
"amount": 225,
"type": "PERCENTAGE",
"value": 25,
"applied_to": "LINE_ITEM",
"line_items": [
{
"external_identifier": "LI_IT_991_Ac990s",
},
],
},
"charges": [
{
"external_identifier": "SRV_CH-12",
"type": "SERVICE_CHARGE",
"name": "Service charge: 12%",
"amount": 381,
"discount_amount": 0,
"total_amount": 0
},
],
"created_at": "2025-05-01T20:11:58+00:00",
"updated_at": "2025-05-01T20:11:58+00:00"
},
"meta": []
}Simulate Order Result
Simulates the result of a new Order in the Leat system. Please note that the actual result may differ, as some time-based rules may be in place. Also, some rules may not be applied if the required information is missing from the payload (e.g. contact).
POST
https://api.piggy.eu/api/v3/oauth/clients/orders/simulateHeaders
Authorization
Accept
Bearer {{ personal_access_token }}application/jsonInput parameters
statusstringoptionalStatus of the order
Possible values:
CREATEDOrder has just been created, not yet completedPENDINGPending fulfilmentCOMPLETEDWhen createdpayment_statusstringoptionalStatus of the payment of the order
Possible values:
UNPAIDPayment process has not been startedPENDINGPayment process started, pending confirmationPAIDPayment successfultotal_order_amountnumberrequiredTotal order amount, after discounts and other charges, in the currency's lowest denomination
order_amountnumberoptionalTotal order amount, before discounts and other charges, in the currency's lowest denomination
total_discount_amountnumberoptionalTotal discount amount, in the currency's lowest denomination
currencystringoptionalOrder currency in ISO 4217 format; defaults to Account's default currency
contactobjectoptionalThe Contact for this Order. If not given, Contact-based rules cannot be applied
uuidstringrequiredUUID of the Contact
business_profileobjectrequiredLocation where the Order takes place
uuidstringrequiredUUID of the Business Profile
line_itemsarray of objectsrequiredList of Products in this Order
namestringrequiredName of the Line Item
quantitynumberrequiredQuantity of the Line Item
pricenumberrequiredPrice per unit of this Line Item
total_amountnumberrequiredTotal amount of this Line Item, in the currency's lowest denomination
discount_amountnumberoptionalDiscount amount of this Line Item, in the currency's lowest denomination
productobjectoptionalAssociated Product
uuidstringoptionalUUID to the Product
external_identifierstringoptionalUnique identifier to the Product with which it's registered in Leat
sub_line_itemsarray of objectsoptionalList of Sub Line Items of this Line Item
namestringrequiredName of the Sub Line Item
quantitynumberrequiredQuantity of the Sub Line Item
pricenumberrequiredPrice per unit of this Sub Line Item
total_amountnumberrequiredTotal amount of this Sub Line Item, in the currency's lowest denomination
discount_amountnumberoptionalDiscount amount of this Sub Line Item, in the currency's lowest denomination
productobjectoptionalAssociated Product
uuidstringoptionalUUID to the Product
external_identifierstringoptionalUnique identifier to the Product with which it's registered in Leat
applied_discountsarray of objectsoptionalList of Discounts applied to this Order
namestringrequiredName of the Discount
amountnumberrequiredResulting monetary discount amount in the currency's lowest denomination
typestringoptionalType of the Discount
Possible values:
PERCENTAGEFor percentage based discountsABSOLUTEFor absolute discountsvaluenumberoptionalThe value of either the percentage or absolute discount
applied_tostringrequiredIndicates if Discount is applied to Order or to one or more (Sub) Line Items. Discounts applied on (Sub) Line Items can be excluded for the Order Simulation.
Possible values:
ORDERFor Order level discountsLINE_ITEMSFor Line Item level discountsSUB_LINE_ITEMSFor Sub Line Item level discountschargesarray of objectsoptionalAny charges not included as line items. E.g. gratuity, service charges or shipping
namestringrequiredA human readable reference to the charge
amountnumberoptionalThe cost of the charge, before discounts, in the currency's lowest denomination
discount_amountnumberoptionalThe discount amount, in the currency's lowest denomination
total_amountnumberrequiredThe total cost of the charge, after discounts, in the currency's lowest denomination
charge_definitionobjectoptionalThe charge definition, for use in rules and exclusions. Every account has a few definitions by default, with external identifiers: SERVICE_CHARGE.
Default definitions:
SERVICE_CHARGEA service charge applied to the orderGRATUITYGratuity or tipSHIPPINGShipping costsWRAPPINGWrapping costsTAXSeparate tax charges. Do not add if taxes are already included in line item total amounts.uuidstringrequired if undefinedUUID to identify the Charge Definition
external_identifierstringrequired if undefinedUnique identifier to identify the Charge Definition (use for default Charge Definitions)
Response Example
Show more
1
2
3
4
5
6
7
8
9
{
"data": {
"type": "points_transaction",
"data" : {
"points": 35
},
},
"meta": []
}