Headers
Global Webshop Client Id
UUID of the sales channel
Path Parameters
Response
200 - application/json
Successful response
curl --request GET \
--url https://api.pricenow.dev/api/orders/by-checkout/{checkoutId} \
--header 'pratiq-client-id: <pratiq-client-id>'{
"data": {
"id": 123,
"purchasedAt": "2023-11-07T05:31:56Z",
"lastUpdateAt": "2023-11-07T05:31:56Z",
"status": "EXPIRED",
"referenceNumber": "<string>",
"currency": "<string>",
"listPriceGross": 123,
"listPriceNet": 123,
"promoCodeDiscount": 123,
"autoDiscountAmount": 123,
"totalDiscountGross": 123,
"totalDiscountNet": 123,
"totalGross": 123,
"totalNet": 123,
"items": [
{
"id": 123,
"parentItemId": 123,
"status": "RESERVED",
"productVariant": {
"productId": 123,
"id": 123,
"attributes": [
{
"name": "<any>",
"identifier": "<any>",
"value": "<any>",
"sortOrder": "<any>",
"metaInformation": "<any>"
}
],
"name": "<string>",
"vatRate": 123,
"product": {
"id": 123,
"sortOrder": 123,
"name": "<string>",
"identifier": "<string>",
"type": "TICKET",
"isSubscription": true,
"standalone": true,
"hasValidity": true,
"imageUrl": "<string>"
},
"availableMedia": [
{
"type": "SKIDATA",
"id": 123,
"priceComponents": [
{
"price": 123,
"productVariant": {
"id": 123,
"name": "<string>",
"vatRate": 123,
"productId": 123,
"attributes": [
"<any>"
]
},
"intent": "SENDING_FEE"
}
]
}
]
},
"validity": {
"from": "<string>",
"to": "<string>"
},
"parentItem": {},
"childItems": [
{}
],
"person": {
"id": 123,
"fields": {},
"createdAt": "<string>",
"lastUpdateAt": "<string>",
"isOwner": true
},
"keycard": {
"id": 123,
"dataCarrierId": "<string>",
"personId": 123,
"metaInformation": {},
"type": "SKIDATA"
},
"medium": "<any>",
"listPriceGross": 123,
"listPriceNet": 123,
"promoCodeDiscount": 123,
"autoDiscount": {
"id": 123,
"displayName": "<string>",
"description": "<string>",
"discountType": "ABSOLUTE",
"discount": 123
},
"autoDiscountAmount": 123,
"totalDiscountGross": 123,
"totalDiscountNet": 123,
"donation": {
"type": "CAUSE_WE_CARE",
"amount": 123
},
"totalGross": 123,
"totalNet": 123,
"vatRate": 123,
"displayPrice": true,
"requiresPersonalization": true,
"requiresValidation": true,
"requiresMedium": true,
"isConfirmationRequired": true,
"isFlexTicket": true,
"isMaxOneTicketPerPerson": true,
"isUniqueItem": true
}
],
"salesChannel": {
"uuid": "<string>",
"name": "<string>",
"type": "CONSUMPTION"
},
"checkoutConditions": {
"defaultValues": {},
"formDefinition": {},
"values": {}
},
"promoCodes": [
{
"id": 123,
"code": "<string>",
"displayName": "<string>",
"description": "<string>",
"discount": 123,
"discountType": "ABSOLUTE",
"valid": true
}
],
"autoDiscounts": [
{
"id": 123,
"displayName": "<string>",
"description": "<string>",
"discountType": "ABSOLUTE",
"discount": 123
}
],
"donation": {
"type": "CAUSE_WE_CARE",
"amount": 123
},
"billingAddress": {
"id": 123,
"addressLine1": "<string>",
"addressLine2": "<string>",
"zip": "<string>",
"city": "<string>",
"state": "<string>",
"countryCode": "<string>",
"purpose": [
"BILLING"
]
},
"shippingAddress": {
"id": 123,
"addressLine1": "<string>",
"addressLine2": "<string>",
"zip": "<string>",
"city": "<string>",
"state": "<string>",
"countryCode": "<string>",
"purpose": [
"BILLING"
]
},
"payment": {
"status": "FAILED",
"totalAmount": 123,
"currency": "<string>",
"errors": [
"<string>"
],
"primaryPaymentProvider": {
"type": "ON_SITE",
"status": "FAILED",
"paymentMethod": "<any>",
"amount": 123
},
"secondaryPaymentProviders": [
{
"type": "INCERT",
"status": "FAILED",
"paymentMethod": "<any>",
"amount": 123
}
]
},
"vouchers": [
{
"code": "<string>",
"system": "INCERT",
"amount": 123
}
]
}
}Get an order by checkout id.
curl --request GET \
--url https://api.pricenow.dev/api/orders/by-checkout/{checkoutId} \
--header 'pratiq-client-id: <pratiq-client-id>'{
"data": {
"id": 123,
"purchasedAt": "2023-11-07T05:31:56Z",
"lastUpdateAt": "2023-11-07T05:31:56Z",
"status": "EXPIRED",
"referenceNumber": "<string>",
"currency": "<string>",
"listPriceGross": 123,
"listPriceNet": 123,
"promoCodeDiscount": 123,
"autoDiscountAmount": 123,
"totalDiscountGross": 123,
"totalDiscountNet": 123,
"totalGross": 123,
"totalNet": 123,
"items": [
{
"id": 123,
"parentItemId": 123,
"status": "RESERVED",
"productVariant": {
"productId": 123,
"id": 123,
"attributes": [
{
"name": "<any>",
"identifier": "<any>",
"value": "<any>",
"sortOrder": "<any>",
"metaInformation": "<any>"
}
],
"name": "<string>",
"vatRate": 123,
"product": {
"id": 123,
"sortOrder": 123,
"name": "<string>",
"identifier": "<string>",
"type": "TICKET",
"isSubscription": true,
"standalone": true,
"hasValidity": true,
"imageUrl": "<string>"
},
"availableMedia": [
{
"type": "SKIDATA",
"id": 123,
"priceComponents": [
{
"price": 123,
"productVariant": {
"id": 123,
"name": "<string>",
"vatRate": 123,
"productId": 123,
"attributes": [
"<any>"
]
},
"intent": "SENDING_FEE"
}
]
}
]
},
"validity": {
"from": "<string>",
"to": "<string>"
},
"parentItem": {},
"childItems": [
{}
],
"person": {
"id": 123,
"fields": {},
"createdAt": "<string>",
"lastUpdateAt": "<string>",
"isOwner": true
},
"keycard": {
"id": 123,
"dataCarrierId": "<string>",
"personId": 123,
"metaInformation": {},
"type": "SKIDATA"
},
"medium": "<any>",
"listPriceGross": 123,
"listPriceNet": 123,
"promoCodeDiscount": 123,
"autoDiscount": {
"id": 123,
"displayName": "<string>",
"description": "<string>",
"discountType": "ABSOLUTE",
"discount": 123
},
"autoDiscountAmount": 123,
"totalDiscountGross": 123,
"totalDiscountNet": 123,
"donation": {
"type": "CAUSE_WE_CARE",
"amount": 123
},
"totalGross": 123,
"totalNet": 123,
"vatRate": 123,
"displayPrice": true,
"requiresPersonalization": true,
"requiresValidation": true,
"requiresMedium": true,
"isConfirmationRequired": true,
"isFlexTicket": true,
"isMaxOneTicketPerPerson": true,
"isUniqueItem": true
}
],
"salesChannel": {
"uuid": "<string>",
"name": "<string>",
"type": "CONSUMPTION"
},
"checkoutConditions": {
"defaultValues": {},
"formDefinition": {},
"values": {}
},
"promoCodes": [
{
"id": 123,
"code": "<string>",
"displayName": "<string>",
"description": "<string>",
"discount": 123,
"discountType": "ABSOLUTE",
"valid": true
}
],
"autoDiscounts": [
{
"id": 123,
"displayName": "<string>",
"description": "<string>",
"discountType": "ABSOLUTE",
"discount": 123
}
],
"donation": {
"type": "CAUSE_WE_CARE",
"amount": 123
},
"billingAddress": {
"id": 123,
"addressLine1": "<string>",
"addressLine2": "<string>",
"zip": "<string>",
"city": "<string>",
"state": "<string>",
"countryCode": "<string>",
"purpose": [
"BILLING"
]
},
"shippingAddress": {
"id": 123,
"addressLine1": "<string>",
"addressLine2": "<string>",
"zip": "<string>",
"city": "<string>",
"state": "<string>",
"countryCode": "<string>",
"purpose": [
"BILLING"
]
},
"payment": {
"status": "FAILED",
"totalAmount": 123,
"currency": "<string>",
"errors": [
"<string>"
],
"primaryPaymentProvider": {
"type": "ON_SITE",
"status": "FAILED",
"paymentMethod": "<any>",
"amount": 123
},
"secondaryPaymentProviders": [
{
"type": "INCERT",
"status": "FAILED",
"paymentMethod": "<any>",
"amount": 123
}
]
},
"vouchers": [
{
"code": "<string>",
"system": "INCERT",
"amount": 123
}
]
}
}Global Webshop Client Id
UUID of the sales channel
Successful response
Show child attributes