🧾 Checkout (2022-03-07)
Download OpenAPI specification:Download
This API is indented to transmit metadata about purchases from Point of Sale (PoS) or E-Commerce systems. We then generate a webview and a matching PDF from this data.
Sale created Webhook
This event is emitted whenever a new sale is created. The body contains the entire Sale. Our webhooks adhere to the CloudEvents Specification and uses the HTTP Bindings for the content.
Authorizations:
header Parameters
WebHook-Request-Origin | string <hostname> Examples: webhooks.eu-1.prod.warrify.cloud |
ce-dataref | string <uri> Examples: https://checkout.eu-1.prod.warrify.cloud/v1/tenants/bcf138b4-a1d9-412e-88e3-14ec9cd0d708/sales/arGq0vntos |
ce-id required | string non-empty Examples: 01GPG7G7S8AKPA2Q83AMQ33Z9D |
ce-source required | string <uri-reference> Examples: https://checkout.eu-1.prod.warrify.cloud/v1/tenants/bcf138b4-a1d9-412e-88e3-14ec9cd0d708/sales/arGq0vntos |
ce-specversion required | string Value: "1.0" |
ce-subject required | string <uri> (urn) >= 17 characters ^urn:(warrify-com):([0-9a-f]{8}-[0-9a-f]{4}-[... Examples: urn:warrify-com:bcf138b4-a1d9-412e-88e3-14ec9cd0d708:eu-1:checkout:sales:arGq0vntos A Uniform Resource Name (URN) is how every resource is identified at warrify. It consists of the |
ce-time required | string <date-time> |
ce-type required | string Value: "com.warrify.checkout.sale-created.v1" |
Request Body schema: application/json
The entire Sale object
id required | string (properties-id) [ 10 .. 500 ] characters ^[a-zA-Z0-9\-_]+$ The unique ID of this sale, either generated by the API or supplied in the Security Warning Since Sales can be retrieved by end customers the IDs used for Sales MUST be cryptographically secure and have enough entropy to make exhaustive enumeration infeasible. Something like |
type required | string (type) Value: "sales" |
version required | string^[0-9A-Z]{26}$ |
urn required | string <uri> (URN) >= 17 characters ^urn:(warrify-com):([0-9a-f]{8}-[0-9a-f]{4}-[... A Uniform Resource Name (URN) is how every resource is identified at warrify. It consists of the |
country required | string^[a-z]{2}$ The ISO 3166-1 alpha-2 country code of the sale. This affects in which language the sale is displayed and how numbers and dates are formatted. |
locale required | string (locale) [ 2 .. 5 ] characters ^[a-z]{2}(-[A-Z]{2})?$ The IETF BCP 47 language tag representing the locale. MUST start with the lowercase language code (e.g. |
createdAt required | string <date-time> (Timestamp) [ 20 .. 29 ] characters ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})... The ISO 8601 timestamp of the time the sale was created. |
updatedAt required | string <date-time> (Timestamp) [ 20 .. 29 ] characters ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})... The ISO 8601 timestamp when the sale was updated the last time. |
deletedAt | string <date-time> (Timestamp) [ 20 .. 29 ] characters ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})... The ISO 8601 timestamp when the sale was deleted. |
timestamp required | string <date-time> (Timestamp) [ 20 .. 29 ] characters ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})... The ISO 8601 timestamp when the transaction was completed. MUST contain the timezone offset or be in UTC time. |
object (cash-register) The cash register used to issue the receipt | |
object (cashier) Describes the personnel that operated the cash register that issued the receipt | |
object (order) Describes the order associated with a sale | |
object (receipt) Describes the receipt associated with a sale | |
object (retailer) The seller | |
object (customer) Describes the customer who receives the receipt. Use it in cases such as the static QR Code case or loyalty programs. Do not add any personal or sensitive data! | |
Array of objects (LineItem) | |
Array of objects (Tax) | |
Array of objects (Discount) | |
object (totals) The totals of the sale | |
Array of CashPayment (object) or CardPayment (object) or GiftCardPayment (object) or VoucherPayment (object) or OnlinePayment (object) or OtherPayment (object) (Payment) | |
Array of Order Fulfillment (object) or Return Code (object) or warrify Card (object) or [AT] BAO (object) or [AT] RKSV (object) or [DE] KassenSichV (object) or [DE] DSFinVK (object) or [EU] Directive 2019/771 (object) (Extension) unique | |
Array of TextSection (object) or BarcodeSection (object) (CustomSection) unique | |
externalId | string [ 1 .. 500 ] characters ^[a-zA-Z0-9\-_]+$ An id provided by the caller that can be used to later efficiently retrieve a given sale. This id is NOT required to be unique (unlike the top level |
testing | boolean Default: false Marks a resource for testing. If omitted it defaults to |
Array of objects (Media) <= 5 items unique |
Responses
Request samples
- Payload
{- "id": "stringstri",
- "type": "sales",
- "version": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:sales:NrcJUTXnPi",
- "country": "string",
- "locale": "en",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "updatedAt": "2020-02-08T09:30:26.123Z",
- "deletedAt": "2020-02-08T09:30:26.123Z",
- "timestamp": "2020-02-08T09:30:26.123Z",
- "cashRegister": {
- "cashRegisterId": "string",
- "cashDrawerId": "string",
- "meta": { }
}, - "cashier": {
- "cashierId": "string",
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "meta": { }
}, - "order": {
- "orderId": "162",
- "meta": { }
}, - "receipt": {
- "receiptId": "162",
- "original": false,
- "document": {
- "contentType": "application/pdf",
- "location": {
}, - "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}, - "meta": { }
}, - "retailer": {
- "name": "A1 Telekom Austria",
- "branch": {
- "name": "A1 Shop Graz Zentrum"
}, - "companyName": "A1 Telekom Austria AG"
}, - "customer": {
- "customerId": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "loyaltyCardNumber": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "employeeId": "34875392",
- "warrifyUserId": "d02c1cb5-840d-5d56-91f2-5423d113a0ce",
- "taxId": "123456",
- "address": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "contact": {
- "email": "user@example.com",
- "phone": "+436601234567"
}, - "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "locale": "en",
- "meta": { }
}, - "lineItems": [
- {
- "lineItemId": "LZM0OxDfLI",
- "name": "Bio Vollmilch - Ja! Natürlich",
- "sku": "08732",
- "articleId": "115432",
- "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "10",
- "taxAmount": {
- "amount": "1.15",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "11.55",
- "currency": "EUR"
}
}
], - "gtin": {
- "format": "GTIN-13",
- "content": "9005182001747"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "grossUnitPrice": {
- "currency": "EUR",
- "amount": "1.27"
}, - "baseGrossUnitPrice": {
- "currency": "EUR",
- "amount": "1.69"
}, - "totalTax": {
- "currency": "EUR",
- "amount": "1.15"
}, - "grossTotal": {
- "currency": "EUR",
- "amount": "12.70"
}, - "netTotal": {
- "currency": "EUR",
- "amount": "11.55"
}, - "baseGrossTotal": {
- "currency": "EUR",
- "amount": "16.90"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "20",
- "taxAmount": {
- "amount": "12.73",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "63.65",
- "currency": "EUR"
}
}
], - "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "totals": {
- "grossAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "netAmount": {
- "currency": "EUR",
- "amount": "44.00"
}, - "taxAmount": {
- "currency": "EUR",
- "amount": "12.00"
}
}, - "payments": [
- {
- "totalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "amount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "tip": {
- "currency": "EUR",
- "amount": "56.00"
}, - "paymentMethod": "CASH",
- "handed": {
- "currency": "EUR",
- "amount": "56.00"
}, - "returned": {
- "currency": "EUR",
- "amount": "56.00"
}, - "foreignTotalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}
}
], - "extensions": [
- {
- "extensionId": "com.warrify.order-fulfillment",
- "version": "2022-03-07",
- "attributes": {
- "shippingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "billingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}
}
}
], - "sections": [
- {
- "sectionType": "text",
- "content": {
- "contentType": "text/html",
- "content": "<p><strong>Bold Text</string></p>"
}, - "position": {
- "relativeTo": "head",
- "placement": "before"
}
}
], - "externalId": "string",
- "testing": false,
- "attachments": [
- {
- "contentType": "application/pdf",
- "location": {
}, - "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}
]
}
List sales
The endpoint returns a list of sales.
It will always return at most page[size]
sales.
If there are more, the response will contain $.links.next
which can be used to get the next page.
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
query Parameters
page[size] | number The size limit of the returned page. The brackets MUST be URL encoded. |
page[after] | string The cursor to use as an |
filter[query] | string non-empty Examples:
This filter is only applied after reading the a page from the sales list. This means:
A RSQL query to filter sales. We support the following operations:
as well as composite operations via |
sort | string Enum: "timestamp" "-timestamp" Examples:
Which field to sort by.
The field name can be prefixed with
|
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
Responses
Response samples
- 200
- 400
- 401
- 403
- 406
- 429
- 500
{- "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}, - "data": [
- {
- "id": "stringstri",
- "type": "sales",
- "attributes": {
- "version": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:sales:NrcJUTXnPi",
- "country": "string",
- "locale": "en",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "updatedAt": "2020-02-08T09:30:26.123Z",
- "deletedAt": "2020-02-08T09:30:26.123Z",
- "timestamp": "2020-02-08T09:30:26.123Z",
- "cashRegister": {
- "cashRegisterId": "string",
- "cashDrawerId": "string",
- "meta": { }
}, - "cashier": {
- "cashierId": "string",
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "meta": { }
}, - "order": {
- "orderId": "162",
- "meta": { }
}, - "receipt": {
- "receiptId": "162",
- "original": false,
- "document": {
- "contentType": "application/pdf",
- "location": {
}, - "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}, - "meta": { }
}, - "retailer": {
- "name": "A1 Telekom Austria",
- "branch": {
- "name": "A1 Shop Graz Zentrum"
}, - "companyName": "A1 Telekom Austria AG"
}, - "customer": {
- "customerId": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "loyaltyCardNumber": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "employeeId": "34875392",
- "warrifyUserId": "d02c1cb5-840d-5d56-91f2-5423d113a0ce",
- "taxId": "123456",
- "address": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "contact": {
- "email": "user@example.com",
- "phone": "+436601234567"
}, - "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "locale": "en",
- "meta": { }
}, - "lineItems": [
- {
- "lineItemId": "LZM0OxDfLI",
- "name": "Bio Vollmilch - Ja! Natürlich",
- "sku": "08732",
- "articleId": "115432",
- "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "10",
- "taxAmount": {
- "amount": "1.15",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "11.55",
- "currency": "EUR"
}
}
], - "gtin": {
- "format": "GTIN-13",
- "content": "9005182001747"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "grossUnitPrice": {
- "currency": "EUR",
- "amount": "1.27"
}, - "baseGrossUnitPrice": {
- "currency": "EUR",
- "amount": "1.69"
}, - "totalTax": {
- "currency": "EUR",
- "amount": "1.15"
}, - "grossTotal": {
- "currency": "EUR",
- "amount": "12.70"
}, - "netTotal": {
- "currency": "EUR",
- "amount": "11.55"
}, - "baseGrossTotal": {
- "currency": "EUR",
- "amount": "16.90"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "20",
- "taxAmount": {
- "amount": "12.73",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "63.65",
- "currency": "EUR"
}
}
], - "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "totals": {
- "grossAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "netAmount": {
- "currency": "EUR",
- "amount": "44.00"
}, - "taxAmount": {
- "currency": "EUR",
- "amount": "12.00"
}
}, - "payments": [
- {
- "totalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "amount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "tip": {
- "currency": "EUR",
- "amount": "56.00"
}, - "paymentMethod": "CASH",
- "handed": {
- "currency": "EUR",
- "amount": "56.00"
}, - "returned": {
- "currency": "EUR",
- "amount": "56.00"
}, - "foreignTotalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}
}
], - "extensions": [
- {
- "extensionId": "com.warrify.order-fulfillment",
- "version": "2022-03-07",
- "attributes": {
- "shippingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "billingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}
}
}
], - "sections": [
- {
- "sectionType": "text",
- "content": {
- "contentType": "text/html",
- "content": "<p><strong>Bold Text</string></p>"
}, - "position": {
- "relativeTo": "head",
- "placement": "before"
}
}
], - "externalId": "string",
- "testing": false,
- "attachments": [
- {
- "contentType": "application/pdf",
- "location": {
}, - "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}
]
}, - "links": {
- "self": "../dictionary",
- "original": "../dictionary",
- "copy": "../dictionary",
- "permalink": "../dictionary"
}
}
]
}
Create a new sale
The response contains the original payload including any data added/generated from our side. It is basically identical to the data you would get from sending a GET request to the endpoint of the generated resource. For ease of use this is not necessary as the data is in the response body.
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
Warrify-Idempotency-Token | string [ 10 .. 256 ] characters ^[a-zA-Z0-9_-]{10,256}$ A client generated id used to identify retried requests to ensure idempotency. |
Request Body schema: application/vnd.api+jsonrequired
The information about the sale to create
required | object (create-sale) | ||||||
|
Responses
Request samples
- Payload
{- "data": {
- "id": "stringstri",
- "type": "sales",
- "attributes": {
- "country": "string",
- "locale": "en",
- "timestamp": "2020-02-08T09:30:26.123Z",
- "cashRegister": {
- "cashRegisterId": "string",
- "cashDrawerId": "string",
- "meta": { }
}, - "cashier": {
- "cashierId": "string",
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "meta": { }
}, - "receipt": {
- "receiptId": "162",
- "original": false,
- "document": {
- "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}, - "meta": { }
}, - "order": {
- "orderId": "162",
- "meta": { }
}, - "retailer": {
- "name": "A1 Telekom Austria",
- "branch": {
- "name": "A1 Shop Graz Zentrum"
}, - "companyName": "A1 Telekom Austria AG"
}, - "customer": {
- "customerId": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "loyaltyCardNumber": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "employeeId": "34875392",
- "warrifyUserId": "d02c1cb5-840d-5d56-91f2-5423d113a0ce",
- "taxId": "123456",
- "address": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "contact": {
- "email": "user@example.com",
- "phone": "+436601234567"
}, - "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "locale": "en",
- "meta": { }
}, - "lineItems": [
- {
- "lineItemId": "LZM0OxDfLI",
- "name": "Bio Vollmilch - Ja! Natürlich",
- "sku": "08732",
- "articleId": "115432",
- "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "10",
- "taxAmount": {
- "amount": "1.15",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "11.55",
- "currency": "EUR"
}
}
], - "gtin": {
- "format": "GTIN-13",
- "content": "9005182001747"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "grossUnitPrice": {
- "currency": "EUR",
- "amount": "1.27"
}, - "baseGrossUnitPrice": {
- "currency": "EUR",
- "amount": "1.69"
}, - "totalTax": {
- "currency": "EUR",
- "amount": "1.15"
}, - "grossTotal": {
- "currency": "EUR",
- "amount": "12.70"
}, - "netTotal": {
- "currency": "EUR",
- "amount": "11.55"
}, - "baseGrossTotal": {
- "currency": "EUR",
- "amount": "16.90"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "20",
- "taxAmount": {
- "amount": "12.73",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "63.65",
- "currency": "EUR"
}
}
], - "totals": {
- "grossAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "netAmount": {
- "currency": "EUR",
- "amount": "44.00"
}, - "taxAmount": {
- "currency": "EUR",
- "amount": "12.00"
}
}, - "payments": [
- {
- "totalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "amount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "tip": {
- "currency": "EUR",
- "amount": "56.00"
}, - "paymentMethod": "CASH",
- "handed": {
- "currency": "EUR",
- "amount": "56.00"
}, - "returned": {
- "currency": "EUR",
- "amount": "56.00"
}, - "foreignTotalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}
}
], - "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "extensions": [
- {
- "extensionId": "com.warrify.order-fulfillment",
- "version": "2022-03-07",
- "attributes": {
- "shippingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "billingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}
}
}
], - "sections": [
- {
- "sectionType": "text",
- "content": {
- "contentType": "text/html",
- "content": "<p><strong>Bold Text</string></p>"
}, - "position": {
- "relativeTo": "head",
- "placement": "before"
}
}
], - "externalId": "string",
- "testing": false,
- "attachments": [
- {
- "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}
]
}
}
}
Response samples
- 201
- 400
- 401
- 403
- 406
- 409
- 415
- 429
- 500
{- "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}, - "data": {
- "id": "stringstri",
- "type": "sales",
- "attributes": {
- "version": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:sales:NrcJUTXnPi",
- "country": "string",
- "locale": "en",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "updatedAt": "2020-02-08T09:30:26.123Z",
- "deletedAt": "2020-02-08T09:30:26.123Z",
- "timestamp": "2020-02-08T09:30:26.123Z",
- "cashRegister": {
- "cashRegisterId": "string",
- "cashDrawerId": "string",
- "meta": { }
}, - "cashier": {
- "cashierId": "string",
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "meta": { }
}, - "order": {
- "orderId": "162",
- "meta": { }
}, - "receipt": {
- "receiptId": "162",
- "original": false,
- "document": {
- "contentType": "application/pdf",
- "location": {
}, - "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}, - "meta": { }
}, - "retailer": {
- "name": "A1 Telekom Austria",
- "branch": {
- "name": "A1 Shop Graz Zentrum"
}, - "companyName": "A1 Telekom Austria AG"
}, - "customer": {
- "customerId": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "loyaltyCardNumber": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "employeeId": "34875392",
- "warrifyUserId": "d02c1cb5-840d-5d56-91f2-5423d113a0ce",
- "taxId": "123456",
- "address": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "contact": {
- "email": "user@example.com",
- "phone": "+436601234567"
}, - "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "locale": "en",
- "meta": { }
}, - "lineItems": [
- {
- "lineItemId": "LZM0OxDfLI",
- "name": "Bio Vollmilch - Ja! Natürlich",
- "sku": "08732",
- "articleId": "115432",
- "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "10",
- "taxAmount": {
- "amount": "1.15",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "11.55",
- "currency": "EUR"
}
}
], - "gtin": {
- "format": "GTIN-13",
- "content": "9005182001747"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "grossUnitPrice": {
- "currency": "EUR",
- "amount": "1.27"
}, - "baseGrossUnitPrice": {
- "currency": "EUR",
- "amount": "1.69"
}, - "totalTax": {
- "currency": "EUR",
- "amount": "1.15"
}, - "grossTotal": {
- "currency": "EUR",
- "amount": "12.70"
}, - "netTotal": {
- "currency": "EUR",
- "amount": "11.55"
}, - "baseGrossTotal": {
- "currency": "EUR",
- "amount": "16.90"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "20",
- "taxAmount": {
- "amount": "12.73",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "63.65",
- "currency": "EUR"
}
}
], - "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "totals": {
- "grossAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "netAmount": {
- "currency": "EUR",
- "amount": "44.00"
}, - "taxAmount": {
- "currency": "EUR",
- "amount": "12.00"
}
}, - "payments": [
- {
- "totalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "amount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "tip": {
- "currency": "EUR",
- "amount": "56.00"
}, - "paymentMethod": "CASH",
- "handed": {
- "currency": "EUR",
- "amount": "56.00"
}, - "returned": {
- "currency": "EUR",
- "amount": "56.00"
}, - "foreignTotalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}
}
], - "extensions": [
- {
- "extensionId": "com.warrify.order-fulfillment",
- "version": "2022-03-07",
- "attributes": {
- "shippingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "billingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}
}
}
], - "sections": [
- {
- "sectionType": "text",
- "content": {
- "contentType": "text/html",
- "content": "<p><strong>Bold Text</string></p>"
}, - "position": {
- "relativeTo": "head",
- "placement": "before"
}
}
], - "externalId": "string",
- "testing": false,
- "attachments": [
- {
- "contentType": "application/pdf",
- "location": {
}, - "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}
]
}, - "links": {
- "self": "../dictionary",
- "original": "../dictionary",
- "copy": "../dictionary",
- "permalink": "../dictionary"
}
}
}
Get a sale
Get a sale by id
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
sale_id required | string^[a-zA-Z0-9]+$ Id of the sale |
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 406
- 429
- 500
{- "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}, - "data": {
- "id": "stringstri",
- "type": "sales",
- "attributes": {
- "version": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:sales:NrcJUTXnPi",
- "country": "string",
- "locale": "en",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "updatedAt": "2020-02-08T09:30:26.123Z",
- "deletedAt": "2020-02-08T09:30:26.123Z",
- "timestamp": "2020-02-08T09:30:26.123Z",
- "cashRegister": {
- "cashRegisterId": "string",
- "cashDrawerId": "string",
- "meta": { }
}, - "cashier": {
- "cashierId": "string",
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "meta": { }
}, - "order": {
- "orderId": "162",
- "meta": { }
}, - "receipt": {
- "receiptId": "162",
- "original": false,
- "document": {
- "contentType": "application/pdf",
- "location": {
}, - "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}, - "meta": { }
}, - "retailer": {
- "name": "A1 Telekom Austria",
- "branch": {
- "name": "A1 Shop Graz Zentrum"
}, - "companyName": "A1 Telekom Austria AG"
}, - "customer": {
- "customerId": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "loyaltyCardNumber": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "employeeId": "34875392",
- "warrifyUserId": "d02c1cb5-840d-5d56-91f2-5423d113a0ce",
- "taxId": "123456",
- "address": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "contact": {
- "email": "user@example.com",
- "phone": "+436601234567"
}, - "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "locale": "en",
- "meta": { }
}, - "lineItems": [
- {
- "lineItemId": "LZM0OxDfLI",
- "name": "Bio Vollmilch - Ja! Natürlich",
- "sku": "08732",
- "articleId": "115432",
- "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "10",
- "taxAmount": {
- "amount": "1.15",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "11.55",
- "currency": "EUR"
}
}
], - "gtin": {
- "format": "GTIN-13",
- "content": "9005182001747"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "grossUnitPrice": {
- "currency": "EUR",
- "amount": "1.27"
}, - "baseGrossUnitPrice": {
- "currency": "EUR",
- "amount": "1.69"
}, - "totalTax": {
- "currency": "EUR",
- "amount": "1.15"
}, - "grossTotal": {
- "currency": "EUR",
- "amount": "12.70"
}, - "netTotal": {
- "currency": "EUR",
- "amount": "11.55"
}, - "baseGrossTotal": {
- "currency": "EUR",
- "amount": "16.90"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "20",
- "taxAmount": {
- "amount": "12.73",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "63.65",
- "currency": "EUR"
}
}
], - "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "totals": {
- "grossAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "netAmount": {
- "currency": "EUR",
- "amount": "44.00"
}, - "taxAmount": {
- "currency": "EUR",
- "amount": "12.00"
}
}, - "payments": [
- {
- "totalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "amount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "tip": {
- "currency": "EUR",
- "amount": "56.00"
}, - "paymentMethod": "CASH",
- "handed": {
- "currency": "EUR",
- "amount": "56.00"
}, - "returned": {
- "currency": "EUR",
- "amount": "56.00"
}, - "foreignTotalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}
}
], - "extensions": [
- {
- "extensionId": "com.warrify.order-fulfillment",
- "version": "2022-03-07",
- "attributes": {
- "shippingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "billingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}
}
}
], - "sections": [
- {
- "sectionType": "text",
- "content": {
- "contentType": "text/html",
- "content": "<p><strong>Bold Text</string></p>"
}, - "position": {
- "relativeTo": "head",
- "placement": "before"
}
}
], - "externalId": "string",
- "testing": false,
- "attachments": [
- {
- "contentType": "application/pdf",
- "location": {
}, - "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}
]
}, - "links": {
- "self": "../dictionary",
- "original": "../dictionary",
- "copy": "../dictionary",
- "permalink": "../dictionary"
}
}
}
Update an existing sale
The response contains the updated sale (including any data added/generated from our side including any unchanged attributes).
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
sale_id required | string^[a-zA-Z0-9]+$ Id of the sale |
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
If-Match required | string [ 1 .. 256 ] characters ^[a-zA-Z0-9_-]{1,256}$ If the request header includes an |
Request Body schema: application/vnd.api+jsonrequired
The information about the sale to update
required | object (update-sale) | ||||||
|
Responses
Request samples
- Payload
{- "data": {
- "id": "stringstri",
- "type": "sales",
- "attributes": {
- "country": "string",
- "locale": "en",
- "timestamp": "2020-02-08T09:30:26.123Z",
- "cashRegister": { },
- "cashier": { },
- "receipt": { },
- "order": { },
- "retailer": { },
- "customer": { },
- "lineItems": { },
- "taxes": { },
- "totals": { },
- "payments": { },
- "discounts": { },
- "extensions": { },
- "sections": { },
- "externalId": { },
- "testing": true,
- "attachments": { }
}
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 406
- 412
- 429
- 500
{- "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}, - "data": {
- "id": "stringstri",
- "type": "sales",
- "attributes": {
- "version": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:sales:NrcJUTXnPi",
- "country": "string",
- "locale": "en",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "updatedAt": "2020-02-08T09:30:26.123Z",
- "deletedAt": "2020-02-08T09:30:26.123Z",
- "timestamp": "2020-02-08T09:30:26.123Z",
- "cashRegister": {
- "cashRegisterId": "string",
- "cashDrawerId": "string",
- "meta": { }
}, - "cashier": {
- "cashierId": "string",
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "meta": { }
}, - "order": {
- "orderId": "162",
- "meta": { }
}, - "receipt": {
- "receiptId": "162",
- "original": false,
- "document": {
- "contentType": "application/pdf",
- "location": {
}, - "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}, - "meta": { }
}, - "retailer": {
- "name": "A1 Telekom Austria",
- "branch": {
- "name": "A1 Shop Graz Zentrum"
}, - "companyName": "A1 Telekom Austria AG"
}, - "customer": {
- "customerId": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "loyaltyCardNumber": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "employeeId": "34875392",
- "warrifyUserId": "d02c1cb5-840d-5d56-91f2-5423d113a0ce",
- "taxId": "123456",
- "address": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "contact": {
- "email": "user@example.com",
- "phone": "+436601234567"
}, - "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "locale": "en",
- "meta": { }
}, - "lineItems": [
- {
- "lineItemId": "LZM0OxDfLI",
- "name": "Bio Vollmilch - Ja! Natürlich",
- "sku": "08732",
- "articleId": "115432",
- "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "10",
- "taxAmount": {
- "amount": "1.15",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "11.55",
- "currency": "EUR"
}
}
], - "gtin": {
- "format": "GTIN-13",
- "content": "9005182001747"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "grossUnitPrice": {
- "currency": "EUR",
- "amount": "1.27"
}, - "baseGrossUnitPrice": {
- "currency": "EUR",
- "amount": "1.69"
}, - "totalTax": {
- "currency": "EUR",
- "amount": "1.15"
}, - "grossTotal": {
- "currency": "EUR",
- "amount": "12.70"
}, - "netTotal": {
- "currency": "EUR",
- "amount": "11.55"
}, - "baseGrossTotal": {
- "currency": "EUR",
- "amount": "16.90"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "20",
- "taxAmount": {
- "amount": "12.73",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "63.65",
- "currency": "EUR"
}
}
], - "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "totals": {
- "grossAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "netAmount": {
- "currency": "EUR",
- "amount": "44.00"
}, - "taxAmount": {
- "currency": "EUR",
- "amount": "12.00"
}
}, - "payments": [
- {
- "totalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "amount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "tip": {
- "currency": "EUR",
- "amount": "56.00"
}, - "paymentMethod": "CASH",
- "handed": {
- "currency": "EUR",
- "amount": "56.00"
}, - "returned": {
- "currency": "EUR",
- "amount": "56.00"
}, - "foreignTotalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}
}
], - "extensions": [
- {
- "extensionId": "com.warrify.order-fulfillment",
- "version": "2022-03-07",
- "attributes": {
- "shippingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "billingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}
}
}
], - "sections": [
- {
- "sectionType": "text",
- "content": {
- "contentType": "text/html",
- "content": "<p><strong>Bold Text</string></p>"
}, - "position": {
- "relativeTo": "head",
- "placement": "before"
}
}
], - "externalId": "string",
- "testing": false,
- "attachments": [
- {
- "contentType": "application/pdf",
- "location": {
}, - "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}
]
}, - "links": {
- "self": "../dictionary",
- "original": "../dictionary",
- "copy": "../dictionary",
- "permalink": "../dictionary"
}
}
}
Delete a sale
Delete a sale
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
sale_id required | string^[a-zA-Z0-9]+$ Id of the sale |
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
Responses
Response samples
- 400
- 401
- 403
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}
List sale versions
List sale versions by id in descending order (newest first)
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
sale_id required | string^[a-zA-Z0-9]+$ Id of the sale |
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 406
- 429
- 500
{- "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}, - "data": [
- {
- "id": "stringstri",
- "type": "sales",
- "attributes": {
- "version": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
- "urn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:sales:NrcJUTXnPi",
- "country": "string",
- "locale": "en",
- "createdAt": "2020-02-08T09:30:26.123Z",
- "updatedAt": "2020-02-08T09:30:26.123Z",
- "deletedAt": "2020-02-08T09:30:26.123Z",
- "timestamp": "2020-02-08T09:30:26.123Z",
- "cashRegister": {
- "cashRegisterId": "string",
- "cashDrawerId": "string",
- "meta": { }
}, - "cashier": {
- "cashierId": "string",
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "meta": { }
}, - "order": {
- "orderId": "162",
- "meta": { }
}, - "receipt": {
- "receiptId": "162",
- "original": false,
- "document": {
- "contentType": "application/pdf",
- "location": {
}, - "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}, - "meta": { }
}, - "retailer": {
- "name": "A1 Telekom Austria",
- "branch": {
- "name": "A1 Shop Graz Zentrum"
}, - "companyName": "A1 Telekom Austria AG"
}, - "customer": {
- "customerId": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "loyaltyCardNumber": "8e561e73-4664-56d6-a0ca-23a9d97e48b2",
- "employeeId": "34875392",
- "warrifyUserId": "d02c1cb5-840d-5d56-91f2-5423d113a0ce",
- "taxId": "123456",
- "address": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "contact": {
- "email": "user@example.com",
- "phone": "+436601234567"
}, - "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "locale": "en",
- "meta": { }
}, - "lineItems": [
- {
- "lineItemId": "LZM0OxDfLI",
- "name": "Bio Vollmilch - Ja! Natürlich",
- "sku": "08732",
- "articleId": "115432",
- "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "10",
- "taxAmount": {
- "amount": "1.15",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "11.55",
- "currency": "EUR"
}
}
], - "gtin": {
- "format": "GTIN-13",
- "content": "9005182001747"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "grossUnitPrice": {
- "currency": "EUR",
- "amount": "1.27"
}, - "baseGrossUnitPrice": {
- "currency": "EUR",
- "amount": "1.69"
}, - "totalTax": {
- "currency": "EUR",
- "amount": "1.15"
}, - "grossTotal": {
- "currency": "EUR",
- "amount": "12.70"
}, - "netTotal": {
- "currency": "EUR",
- "amount": "11.55"
}, - "baseGrossTotal": {
- "currency": "EUR",
- "amount": "16.90"
}
}
], - "taxes": [
- {
- "taxType": "VAT",
- "code": "A",
- "percentage": "20",
- "taxAmount": {
- "amount": "12.73",
- "currency": "EUR"
}, - "netAmount": {
- "amount": "63.65",
- "currency": "EUR"
}
}
], - "discounts": [
- {
- "totalGrossAmount": {
- "currency": "EUR",
- "amount": "4.20"
}, - "unitGrossAmount": {
- "currency": "EUR",
- "amount": "0.42"
}, - "quantity": {
- "quantity": "10",
- "unit": "pieces"
}, - "percentage": "25",
- "description": {
- "contentType": "text/markdown",
- "content": "**-25% on organic milk**"
}
}
], - "totals": {
- "grossAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "netAmount": {
- "currency": "EUR",
- "amount": "44.00"
}, - "taxAmount": {
- "currency": "EUR",
- "amount": "12.00"
}
}, - "payments": [
- {
- "totalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "amount": {
- "currency": "EUR",
- "amount": "56.00"
}, - "tip": {
- "currency": "EUR",
- "amount": "56.00"
}, - "paymentMethod": "CASH",
- "handed": {
- "currency": "EUR",
- "amount": "56.00"
}, - "returned": {
- "currency": "EUR",
- "amount": "56.00"
}, - "foreignTotalAmount": {
- "currency": "EUR",
- "amount": "56.00"
}
}
], - "extensions": [
- {
- "extensionId": "com.warrify.order-fulfillment",
- "version": "2022-03-07",
- "attributes": {
- "shippingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}, - "billingAddress": {
- "fullName": "John Doe",
- "givenName": "John",
- "familyName": "Doe",
- "attention": "John Doe",
- "company": "ACME Ltd.",
- "line1": "Marxergasse 4",
- "line2": "Apartment 3",
- "city": "Wien",
- "postalCode": "1030",
- "countryName": "Österreich",
- "country": "at",
- "postOfficeBoxNumber": "PO.1234",
- "region": "Wien",
- "coordinates": {
- "latitude": "48.2082",
- "longitude": "16.3738"
}, - "meta": { }
}
}
}
], - "sections": [
- {
- "sectionType": "text",
- "content": {
- "contentType": "text/html",
- "content": "<p><strong>Bold Text</string></p>"
}, - "position": {
- "relativeTo": "head",
- "placement": "before"
}
}
], - "externalId": "string",
- "testing": false,
- "attachments": [
- {
- "contentType": "application/pdf",
- "location": {
}, - "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:attachments:attachment_c87b543a-69b6-5fc5-96ef-9ace70077799.pdf",
- "blobVersion": "string"
}
]
}, - "links": {
- "self": "../dictionary",
- "original": "../dictionary",
- "copy": "../dictionary",
- "permalink": "../dictionary"
}
}
]
}
Get sale receipt document
Get sale receipt document by id
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
sale_id required | string^[a-zA-Z0-9]+$ Id of the sale |
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
Accept |
Responses
Response samples
- 400
- 401
- 403
- 404
- 406
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}
Describe an attachment
Describe an attachment
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
attachment_name required | string [ 10 .. 1024 ] characters ^[a-zA-Z0-9][a-zA-Z0-9_\-]+\.[a-z]{1,10}$ Examples:
The unique name of the attachment including a file extension. The name must be unique within the tenant. It MUST not use any special characters except for |
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
Accept | |
If-Match | |
If-Modified-Since | |
If-None-Match | |
If-Unmodified-Since |
Responses
Response samples
- 400
- 401
- 403
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}
Download an attachment
Download an attachment
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
attachment_name required | string [ 10 .. 1024 ] characters ^[a-zA-Z0-9][a-zA-Z0-9_\-]+\.[a-z]{1,10}$ Examples:
The unique name of the attachment including a file extension. The name must be unique within the tenant. It MUST not use any special characters except for |
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
If-Match | |
If-Modified-Since | |
If-None-Match | |
If-Unmodified-Since |
Responses
Response samples
- 400
- 401
- 403
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}
Upload an attachment
Upload an attachment
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
attachment_name required | string [ 10 .. 1024 ] characters ^[a-zA-Z0-9][a-zA-Z0-9_\-]+\.[a-z]{1,10}$ Examples:
The unique name of the attachment including a file extension. The name must be unique within the tenant. It MUST not use any special characters except for |
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
Content-Type required | |
Content-Encoding | |
Content-Language |
Request Body schema: */*required
The contents of the file
Responses
Response samples
- 400
- 401
- 403
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}
List attachment versions
List attachment versions
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
attachment_name required | string [ 10 .. 1024 ] characters ^[a-zA-Z0-9][a-zA-Z0-9_\-]+\.[a-z]{1,10}$ Examples:
The unique name of the attachment including a file extension. The name must be unique within the tenant. It MUST not use any special characters except for |
query Parameters
page[size] | number The size limit of the returned page. The brackets MUST be URL encoded. |
page[after] | string The cursor to use as an |
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
{- "jsonapi": {
- "version": "1.0",
- "meta": { }
}, - "meta": { },
- "links": {
- "property1": "../dictionary",
- "property2": "../dictionary"
}, - "data": [
- {
- "id": "3/L4kqtJl40Nr8X8gdRQBpUMLUo",
- "type": "attachment-versions",
- "attributes": {
- "etag": "\"fba9dede5f27731c9771645a39863328\"",
- "latest": true,
- "blobUrn": "urn:warrify-com:93470541-20e6-4085-917a-40b36510e0e3:eu-1:checkout:sales:NrcJUTXnPi",
- "lastModified": "2019-08-24T14:15:22Z"
}, - "links": {
- "self": "../dictionary"
}
}
]
}
Describe an attachment version
Describe an attachment version
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
attachment_name required | string [ 10 .. 1024 ] characters ^[a-zA-Z0-9][a-zA-Z0-9_\-]+\.[a-z]{1,10}$ Examples:
The unique name of the attachment including a file extension. The name must be unique within the tenant. It MUST not use any special characters except for |
blob_version required | string Examples:
The version id of the blob |
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
Accept | |
If-Match | |
If-Modified-Since | |
If-None-Match | |
If-Unmodified-Since |
Responses
Response samples
- 400
- 401
- 403
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}
Download an attachment version
Download an attachment version
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
attachment_name required | string [ 10 .. 1024 ] characters ^[a-zA-Z0-9][a-zA-Z0-9_\-]+\.[a-z]{1,10}$ Examples:
The unique name of the attachment including a file extension. The name must be unique within the tenant. It MUST not use any special characters except for |
blob_version required | string Examples:
The version id of the blob |
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
If-Match | |
If-Modified-Since | |
If-None-Match | |
If-Unmodified-Since |
Responses
Response samples
- 400
- 401
- 403
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}
Delete an attachment version
Delete an attachment version
Authorizations:
path Parameters
tenant_id required | string <uuid> The id of the tenant |
attachment_name required | string [ 10 .. 1024 ] characters ^[a-zA-Z0-9][a-zA-Z0-9_\-]+\.[a-z]{1,10}$ Examples:
The unique name of the attachment including a file extension. The name must be unique within the tenant. It MUST not use any special characters except for |
blob_version required | string Examples:
The version id of the blob |
header Parameters
Warrify-Version required | string <date> Value: "2022-03-07" Version of the API request in date format |
Responses
Response samples
- 400
- 401
- 403
- 429
- 500
{- "errors": [
- {
- "id": "51dc0030-8ae0-4176-8f89-6037627c3787",
- "status": "400",
- "code": "InvalidParameterValue",
- "title": "Unexpected Query Parameter",
- "detail": "The include query parameter may only be included in for resources that support this operation",
- "source": {
- "parameter": "include"
}
}
]
}