Customer
The Customer API endpoints allow fetching all orders associated with a customer.
Gets all the finalized Order of a Customer
GET/umbraco/commerce/storefront/api/v1/customer/{customerReferenceOrEmail}/orders
Path parameters
customerReferenceOrEmail*string
A custom reference or email of an existing customer. Can be UrlBase64 encoded.
"cust_14c7ba32-367d-42f3-83b1-e59c839e5d22"Query parameters
Header parameters
Response
Success
Body
idstring (uuid)
cartNumbernullable string
orderNumbernullable string
languageIsoCodenullable string
currencyCurrencyReferenceDto (object)
taxClassTaxClassReferenceDto (object)
taxRatenullable number (double)
orderStatusOrderStatusReferenceDto (object)
customerInfoOrderCustomerInfoResponseDto (object)
paymentInfoOrderPaymentInfoResponseDto (object)
shippingInfoOrderShippingInfoResponseDto (object)
transactionInfoOrderTransactionInfoResponseDto (object)
discountCodesnullable array of OrderAppliedDiscountCodeResponseDto (object)
discountsnullable array of DiscountReferenceDto (object)
giftCardsnullable array of GiftCardReferenceDto (object)
totalQuantitynullable number (double)
subtotalPriceAdjustedPriceWithPreviousAdjustmentsDto (object)
totalPriceAdjustedPriceWithPreviousAdjustmentsDto (object)
transactionAmountAdjustedAmountDto (object)
orderLinesnullable array of OrderLineResponseDto (object)
propertiesnullable object
tagsnullable array of string
createDatenullable string (date-time)
updateDatenullable string (date-time)
finalizedDatenullable string (date-time)
isFinalizednullable boolean
Request
const response = await fetch('/umbraco/commerce/storefront/api/v1/customer/{customerReferenceOrEmail}/orders', {
method: 'GET',
headers: {
"Api-Key": "text",
"Store": "text"
},
});
const data = await response.json();Response
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"cartNumber": "text",
"orderNumber": "text",
"languageIsoCode": "text",
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"taxClass": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text"
},
"taxRate": 0,
"orderStatus": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text"
},
"customerInfo": {
"customerReference": "text",
"firstName": "text",
"lastName": "text",
"email": "text"
},
"paymentInfo": {
"country": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"region": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"paymentMethod": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text"
},
"taxRate": 0,
"totalPrice": {
"adjustments": [
{
"name": "text",
"type": "text",
"price": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"originalPrice": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
}
],
"withoutAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"adjustment": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"value": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
}
},
"shippingInfo": {
"country": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"region": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"shippingMethod": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text"
},
"taxRate": 0,
"totalPrice": {
"adjustments": [
{
"name": "text",
"type": "text",
"price": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"originalPrice": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
}
],
"withoutAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"adjustment": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"value": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
}
},
"transactionInfo": {
"transactionId": "text",
"authorizedAmount": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"value": 0,
"formatted": {
"value": "text"
}
},
"feeAmount": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"value": 0,
"formatted": {
"value": "text"
}
},
"baseCurrencyExchangeRate": 0,
"paymentStatus": "Initialized"
},
"discountCodes": [
{
"discount": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text"
},
"code": "text",
"isFulfilled": false
}
],
"discounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text"
}
],
"giftCards": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
}
],
"totalQuantity": 0,
"subtotalPrice": {
"adjustments": [
{
"name": "text",
"type": "text",
"price": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"originalPrice": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
}
],
"withoutAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"adjustment": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"value": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"previousAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"withPreviousAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"totalAdjustment": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
},
"totalPrice": {
"adjustments": [
{
"name": "text",
"type": "text",
"price": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"originalPrice": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
}
],
"withoutAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"adjustment": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"value": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"previousAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"withPreviousAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"totalAdjustment": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
},
"transactionAmount": {
"adjustments": [
{
"name": "text",
"type": "text",
"amount": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"value": 0,
"formatted": {
"value": "text"
}
},
"originalAmount": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"value": 0,
"formatted": {
"value": "text"
}
}
}
],
"withoutAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"value": 0,
"formatted": {
"value": "text"
}
},
"adjustment": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"value": 0,
"formatted": {
"value": "text"
}
},
"value": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"value": 0,
"formatted": {
"value": "text"
}
}
},
"orderLines": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productReference": "text",
"productVariantReference": "text",
"sku": "text",
"name": "text",
"quantity": 0,
"taxClass": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"alias": "text"
},
"bundleId": "text",
"orderLines": [],
"attributes": [
{
"name": {
"alias": "text",
"name": "text"
},
"value": {
"alias": "text",
"name": "text"
}
}
],
"basePrice": {
"adjustments": [
{
"name": "text",
"type": "text",
"price": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"originalPrice": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
}
],
"withoutAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"adjustment": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"value": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
},
"unitPrice": {
"adjustments": [
{
"name": "text",
"type": "text",
"price": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"originalPrice": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
}
],
"withoutAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"adjustment": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"value": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
},
"taxRate": 0,
"totalPrice": {
"adjustments": [
{
"name": "text",
"type": "text",
"price": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"originalPrice": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
}
],
"withoutAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"adjustment": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"value": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"previousAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"withPreviousAdjustments": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
},
"totalAdjustment": {
"currency": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text"
},
"withoutTax": 0,
"tax": 0,
"withTax": 0,
"formatted": {
"withoutTax": "text",
"tax": "text",
"withTax": "text"
}
}
}
}
],
"tags": [
"text"
],
"createDate": "2024-11-21T11:54:38.481Z",
"updateDate": "2024-11-21T11:54:38.481Z",
"finalizedDate": "2024-11-21T11:54:38.481Z",
"isFinalized": false
}
]Last updated