LogoLogo
CommunitySupport PortalYouTubeStart a free trial
  • Welcome
  • Commerce Engine
  • Orchestration Engine
  • API Documentation
  • Release Notes
  • Changelog
  • Emporix API
    • List of API Services
  • OpenAPI Generator
  • Standard Practices
    • General Info
    • Mixins
    • Query Parameter
    • Translations
    • Custom ID
    • Upsert
    • B2B Token
  • API Guides and References
    • Authorization
      • OAuth Service
        • API Reference
          • Customer Token
          • Anonymous Token
          • Service Access Token
          • Models
        • View Raw API Specification
    • Artificial Intelligence
      • AI Service
        • AI Tutorials
        • API Reference
          • Text Generation
          • AI Completions
          • Models
        • View Raw API Specification
    • Configuration
      • Configuration Service
        • Language Tutorials
        • API Reference
          • Tenant configurations
          • Client configurations
          • Global configurations
          • Models
        • View Raw API Specification
      • Country Service
        • Country Tutorial
        • API Reference
          • Countries
          • Regions
          • Models
        • View Raw API Specification
      • Currency Service
        • Currency Tutorial
        • API Reference
          • Currencies
          • Currency exchange
          • Models
        • View Raw API Specification
      • Unit Handling Service
        • Unit Handling Tutorial
        • API Reference
          • Unit management
          • Type management
          • Unit conversion
          • Models
        • View Raw API Specification
      • Site Settings Service
        • Site Settings Tutorial
        • API Reference
          • Mixins
          • Site settings
          • Models
        • View Raw API Specification
      • Indexing Service
        • Indexing Tutorial
        • API Reference
          • Configuration
          • Public Configuration
          • Reindex
          • Models
        • View Raw API Specification
    • Catalogs and Categories
      • Catalog Service
        • Catalog Tutorials
        • API Reference
          • List catalogs
          • Catalog management
          • Models
        • View Raw API Specification
      • Category Service
        • Category Tutorials
        • API Reference
          • Category Resources
          • Category Assignment Resources
          • Assignment Resources
          • Category Tree Resources
          • Models
        • View Raw API Specification
    • Products, Labels and Brands
      • Product Service
        • Product Tutorial
        • API Reference
          • Products
          • Product Templates
          • Models
        • View Raw API Specification
      • Label Service
        • Label Tutorial
        • API Reference
          • Label
          • Media
          • Models
        • View Raw API Specification
      • Brand Service
        • Brand Tutorial
        • API Reference
          • Brands
          • Media
          • Models
        • View Raw API Specification
    • Prices and Taxes
      • Price Service
        • Price Tutorials
        • API Reference
          • Price lists
          • Price matching
          • Price models
          • Prices
          • Prices assigned to price lists
          • Models
        • View Raw API Specification
      • Tax Service
        • Tax Tutorials
        • API Reference
          • Taxes
          • Tax calculation
          • Models
        • View Raw API Specification
    • Users and Permissions
      • IAM Service
        • IAM Tutorial
        • API Reference
          • Access Controls
          • Group Assignments
          • Groups
          • Permissions
          • Resources
          • Roles
          • Access Control Templates
          • Users
          • Management Dashboard Users
          • Models
        • View Raw API Specification
      • Session-context Service
        • Session-context Tutorial
        • API Reference
          • Session management
          • Session context modification
          • Own session management
          • Own session context modification
          • Models
        • View Raw API Specification
    • Companies and Customers
      • Customer Management
        • Customer Management Tutorial
        • API Reference
          • Locations
          • Contact Assignments
          • Legal Entities
          • Models
        • View Raw API Specification
      • Customer Service (Customer Managed)
        • API Reference
          • Addresses
          • Authentication and authorization
          • Account and profile
          • Double opt In
          • Credentials
          • Models
        • View Raw API Specification
      • Customer Service (Tenant Managed)
        • API Reference
          • Account and profile
          • Addresses
          • Models
        • View Raw API Specification
      • Customer Segments
        • Segments Tutorial
        • API Reference
          • Segments
          • Customers Assignments
          • Items Assignments
          • Models
        • View Raw API Specification
      • Approval Service
        • Approval Tutorials
        • API Reference
          • Approvals
          • Approval
          • Search
          • Models
        • View Raw API Specification
    • Delivery and Shipping
      • Shipping Service
        • Shipping Tutorial
        • API Reference
          • Customer Group Relations
          • Delivery Windows
          • Shipping Cost
          • Shipping Methods
          • Shipping Zones
          • Shipping Groups
          • Sites
          • Delivery Times Management
          • Delivery Times Slots Management
          • Delivery Cycles
          • Models
        • View Raw API Specification
      • Delivery Providers Service
        • API Reference
          • Delivery Orders
          • Delivery Plan
          • Models
        • View Raw API Specification
    • Rewards and Promotions
      • Coupon Service
        • Coupon Tutorial
        • API Reference
          • Coupon Management
          • Coupon Validation
          • Coupon Redemption
          • Referral Coupon Management
          • Models
        • View Raw API Specification
      • Reward-points Service
        • Reward-points Tutorial
        • API Reference
          • Redeem Options Management
          • Signed In Customer Reward Points
          • Reward Points Management
          • Models
        • View Raw API Specification
    • Quotes
      • Quote Service
        • Quote Tutorial
        • API Reference
          • Quote management
          • Quote history
          • Quote pdf
          • Quote reason
          • Models
        • View Raw API Specification
    • Checkout
      • Cart Service
        • Cart Tutorial
        • API Reference
          • Carts
          • Cart items
          • Discounts
          • Models
        • View Raw API Specification
      • Payment-gateway Service
        • Payment-gateway Tutorial
        • API Reference
          • Payment
          • Payment frontend
          • Payment mode
          • Transaction
          • Payment mode frontend
          • Models
        • View Raw API Specification
      • Checkout Service
        • Checkout Tutorial
        • API Reference
          • Checkouts
          • Models
        • View Raw API Specification
      • Fee Service
        • Fee Tutorial
        • API Reference
          • Fee management
          • Item Fee management
          • Product Fees management
          • Item Fee search
          • Models
        • View Raw API Specification
      • Shopping List
        • API Reference
          • Shopping Lists
          • Models
        • View Raw API Specification
    • Orders
      • Availability Service
        • Availability Tutorial
        • API Reference
          • Locations
          • Availabilities
          • Models
        • View Raw API Specification
      • Order Service
        • Order Tutorial
        • API Reference
          • Orders (tenant Managed)
          • Orders (customer Managed)
          • Models
        • View Raw API Specification
      • Pick-pack Service
        • API Reference
          • Orders
          • Assignees
          • Order cycles
          • Recalculations
          • Events
          • Models
        • View Raw API Specification
      • Invoice Service
        • Invoice Tutorial
        • API Reference
          • Invoice Jobs
          • Models
        • View Raw API Specification
      • Returns Service
        • Returns Tutorial
        • API Reference
          • Returns
          • Models
        • View Raw API Specification
      • SEPA Export Service
        • API Reference
          • Files
          • Jobs
          • Models
        • View Raw API Specification
    • Utilities
      • Schema Service
        • Schema Tutorial
        • API Reference
          • Schema
          • Type
          • Reference
          • Custom Schema Type
          • Custom Instance
          • Models
        • View Raw API Specification
      • Sequential-id Service
        • Sequential-id Tutorial
        • API Reference
          • Sequential IDs management
          • Models
        • View Raw API Specification
    • Media
      • Media Service
        • Media Tutorial
        • API Reference
          • Assets
          • Models
        • View Raw API Specification
    • Webhooks
      • Webhook Service
        • Webhooks Tutorial
        • API Reference
          • Config
          • Events
          • Svix Emporix Shared Account
          • Models
        • View Raw API Specification
      • Events-Availability
      • Events-Cart
      • Events-Catalog
      • Events-Category
      • Events-Client Management
      • Events-Customer
      • Events-Index
      • Events-Order
      • Events-Price
      • Events-Product
      • Events-Quote
      • Events-Product
    • Integrations
      • Identity Providers
        • Auth0
      • Workflow Automation
        • Emporix and Make
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. API Guides and References
  2. Orders
  3. Order Service
  4. API Reference

Orders (customer Managed)

PreviousOrders (tenant Managed)NextModels

Was this helpful?

LogoLogo

Resources

  • Emporix.com
  • Developer Policy
  • Terms of Use

Find us

  • LinkedIn

© 2025 Emporix. All Rights Reserved.

Manage customer orders

Retrieving order details

get

Retrieves details of an order. To be used by customers on the storefront.

Required scopes

  • order.history_view for logged in customers only.

Authorizations
Path parameters
orderIdstringRequired

Unique identifier of an order.

tenantstring · min: 3 · max: 16Required

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Pattern: ^[a-z][a-z0-9]+$
Header parameters
saas-tokenstringRequired

Token used to identify logged-in users. This token has an expiry date and is signed with a passphrase.

Responses
200
The request was successful. Order details are returned.
application/json
Responseall of

The order visible for a customer, which includes all ordered items, customer addresses, information about ordered products etc.

and
403
Given authorization scopes are not sufficient and do not match required scopes.
application/json
404
Order does not exist
application/json
500
Some server side error occurred.
application/json
get
GET /order-v2/{tenant}/orders/{orderId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
saas-token: text
Accept: */*
{
  "status": "IN_CHECKOUT",
  "entries": [
    {
      "id": "BC10033--BC10033-43",
      "itemYrn": "urn:yaas:saasag:caasproduct:product:test;BC10033--BC10033-43",
      "amount": 3,
      "orderedAmount": 3,
      "effectiveQuantity": 3,
      "originalAmount": 100,
      "originalPrice": 100,
      "unitPrice": 100,
      "calculatedUnitPrice": {
        "netValue": 100,
        "grossValue": 119,
        "taxValue": 19,
        "taxCode": "STANDARD",
        "taxRate": 19
      },
      "totalPrice": 300,
      "authorizedAmount": 300,
      "product": {
        "metadata": {
          "mixins": {
            "productTemplateAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/test/63ec98500522b25c90b9e632-templateAttributes_v1.json",
            "productVariantAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/test/63ec98500522b25c90b9e632-variantAttributes_v1.json"
          }
        },
        "id": "BC10033--BC10033-43",
        "sku": "8033546091234",
        "name": "Safety shoes high Reptile RS S3 SRC, black",
        "localizedName": {
          "de": "Hohe Sicherheitsschuhe Reptile RS S3 SRC, schwarz",
          "en": "Safety shoes high Reptile RS S3 SRC, black"
        },
        "description": "[de:Sicherheitsstiefel, klassisch und robust, U-Power Style&Job Linie, Obermaterial aus wasserabweisendem, bedrucktem Leder, Stahlkappe, Durchtrittsicherheit, rutschfest, ergonomisches Inox Laminat und PU/PU Sohle, RS S3 SRC., en:Safety shoes high, U-Power, classic and strong of the \"Style & Job\" range, with water repellent printed leather upper, steel toe cap, anti-puncture, anti-slip, ergonomic steel foil and PU / PU sole, RS S3 SRC.]",
        "published": true,
        "images": [
          {
            "id": "6437eb7f8fc03d22f4e856ce",
            "url": "http://res.cloudinary.com/saas-ag/image/upload/v1681386368/test/media/6437eb7f8fc03d22f4e856ce",
            "stored": false
          }
        ],
        "mixins": {
          "productVariantAttributes": {
            "size": 43
          }
        },
        "productType": "VARIANT"
      },
      "tax": {
        "lines": [
          {
            "amount": 57,
            "currency": "EUR",
            "code": "STANDARD",
            "name": "STANDARD",
            "rate": 19,
            "sequenceId": 0,
            "inclusive": false
          }
        ],
        "total": {
          "amount": 0,
          "currency": "EUR",
          "inclusive": false
        }
      },
      "price": {
        "priceId": "6763cd21139f370cd9244d37",
        "currency": "EUR",
        "originalAmount": 100,
        "effectiveAmount": 100,
        "basePrice": {},
        "presentationPrice": {},
        "metadata": {
          "createdAt": "2024-12-19T07:37:05.559Z",
          "modifiedAt": "2024-12-19T07:37:05.559Z",
          "version": 1
        }
      },
      "totalDiscount": {
        "amount": 0,
        "currency": "EUR"
      },
      "fees": {
        "total": {
          "subTotal": 0,
          "totalTax": 0,
          "total": 0
        }
      },
      "metadata": {
        "mixins": {
          "fees": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
        }
      },
      "mixins": {
        "fees": {
          "total": {
            "subTotal": 0,
            "totalTax": 0,
            "total": 0,
            "discount": 0
          }
        }
      },
      "calculatedPrice": {
        "price": {
          "netValue": 300,
          "grossValue": 357,
          "taxValue": 57,
          "taxCode": "STANDARD",
          "taxRate": 19
        },
        "finalPrice": {
          "netValue": 300,
          "grossValue": 357,
          "taxValue": 57,
          "taxCode": "STANDARD",
          "taxRate": 19
        }
      },
      "priceMatchDetails": {
        "netValue": 100,
        "grossValue": 119,
        "taxValue": 19,
        "taxCode": "STANDARD",
        "taxRate": 19,
        "taxCountry": "DE"
      }
    }
  ],
  "discounts": [],
  "customer": {
    "id": "61443563",
    "name": "Test name",
    "firstName": "John",
    "lastName": "Smith",
    "company": "Emporix",
    "email": "test@test.com"
  },
  "siteCode": "DE",
  "countryCode": "DE",
  "billingAddress": {
    "contactName": "Templatecompany",
    "companyName": "Templatecompany",
    "street": "Strasse 1",
    "streetNumber": "",
    "zipCode": "12221",
    "city": "Berlin",
    "country": "DE",
    "state": "DE"
  },
  "shippingAddress": {
    "contactName": "Templatecompany",
    "companyName": "Templatecompany",
    "street": "Strasse 1",
    "streetNumber": "",
    "zipCode": "12221",
    "city": "Berlin",
    "country": "DE",
    "state": "DE"
  },
  "payments": [
    {
      "status": "PENDING",
      "method": "invoice",
      "paymentResponse": "Payment is handled externally",
      "paidAmount": 0,
      "currency": "EUR",
      "transactionId": "fcc2bf50-f064-4dc3-833f-0909a7857387",
      "authorizedAmount": 373.12,
      "provider": "payment-gateway"
    }
  ],
  "shipping": {
    "total": {
      "amount": 39.2,
      "currency": "EUR"
    },
    "lines": [
      {
        "amount": 35,
        "currency": "EUR",
        "code": "pickup",
        "name": "pickup",
        "localizedName": {
          "en": "pickup",
          "de": "pickup"
        },
        "tax": {
          "total": {
            "amount": 4.2,
            "currency": "EUR",
            "inclusive": false
          },
          "rate": 12
        },
        "shippingTaxCode": "REDUCED"
      }
    ]
  },
  "tax": {
    "lines": [
      {
        "amount": 4.2,
        "currency": "EUR",
        "code": "REDUCED",
        "name": "REDUCED",
        "rate": 12,
        "sequenceId": 0,
        "inclusive": false
      },
      {
        "amount": 57,
        "currency": "EUR",
        "code": "STANDARD",
        "name": "STANDARD",
        "rate": 19,
        "sequenceId": 1,
        "inclusive": false
      }
    ],
    "total": {
      "amount": 0,
      "currency": "EUR",
      "inclusive": false
    }
  },
  "subTotalPrice": 300,
  "totalPrice": 333.92,
  "totalAuthorizedAmount": 373.12,
  "currency": "EUR",
  "metadata": {
    "mixins": {
      "payments": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json",
      "deliveryTime": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryTimeMixIn.v2.json",
      "generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/orderGeneralAttributesMixIn.v9.json",
      "payment": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/paymentMixIn.v3.json"
    },
    "version": 1
  },
  "mixins": {
    "payments": {
      "elements": [
        {
          "paymentMethodYrn": "urn:yaas:hybris:payments:payment-method:test;invoice",
          "fees": {
            "elements": [
              {
                "yrn": "urn:yaas:saasag:fee:fee:test;678f552a949c723de46bdb14",
                "name": {
                  "de": "Payment fee",
                  "en": "Payment fee"
                },
                "taxCode": "REDUCED",
                "total": {
                  "subTotal": 33.92,
                  "totalTax": 0,
                  "total": 33.92,
                  "discount": 0
                }
              }
            ],
            "total": {
              "subTotal": 0,
              "totalTax": 0,
              "total": 0,
              "discount": 0
            }
          },
          "total": {
            "subTotal": 33.92,
            "totalTax": 0,
            "total": 33.92,
            "discount": 0
          }
        }
      ],
      "total": {
        "subTotal": 33.92,
        "totalTax": 0,
        "total": 33.92,
        "discount": 0
      }
    },
    "deliveryTime": {
      "deliveryTimeId": "64e36da5814eba1635228dfe",
      "deliveryDate": "2025-02-07T11:00:00.000Z",
      "deliveryTimeFrom": "10:00",
      "deliveryTimeTo": "14:30",
      "deliveryTimeZoneId": "deliveryarea",
      "deliveryTimeMethodId": "pickup",
      "deliveryCosts": 35
    },
    "generalAttributes": {
      "extendedOrderStatus": "05",
      "customerFirstOrder": false,
      "orderNumber": "EON2076"
    },
    "payment": {
      "paymentType": "invoice"
    }
  },
  "deliveryWindow": {
    "id": "64e36da5814eba1635228dfe",
    "slotId": "c291c677-5460-4efb-b893-145c866a2af2",
    "deliveryDate": "2025-02-07",
    "deliveryCycle": "2025-02-07-15pickupFriday1000-1430",
    "deliveryCycleName": "pickupFriday1000-1430",
    "deliveryTimeRange": {
      "timeFrom": "10:00",
      "timeTo": "14:30"
    }
  },
  "feeYrnAggregate": {
    "elements": [
      {
        "yrn": "urn:yaas:saasag:fee:fee:test;678f552a949c723de46bdb14",
        "name": {
          "de": "Payment fee",
          "en": "Payment fee"
        },
        "taxCode": "REDUCED",
        "total": {
          "subTotal": 33.92,
          "totalTax": 0,
          "total": 33.92
        }
      }
    ],
    "total": {
      "subTotal": 33.92,
      "totalTax": 0,
      "total": 33.92
    }
  },
  "calculatedPrice": {
    "price": {
      "netValue": 300,
      "grossValue": 357,
      "taxValue": 57,
      "taxCode": "STANDARD",
      "taxRate": 19
    },
    "paymentFees": [
      {
        "id": "678f552a949c723de46bdb14",
        "type": "PERCENT",
        "name": {
          "de": "Payment fee",
          "en": "Payment fee"
        },
        "price": {
          "netValue": 33.5,
          "grossValue": 37.52,
          "taxValue": 4.02,
          "taxCode": "REDUCED",
          "taxRate": 12
        }
      }
    ],
    "totalFee": {
      "netValue": 33.5,
      "grossValue": 37.52,
      "taxValue": 4.02,
      "taxCode": "REDUCED",
      "taxRate": 12
    },
    "totalShipping": {
      "netValue": 35,
      "grossValue": 39.2,
      "taxValue": 4.2,
      "taxCode": "REDUCED",
      "taxRate": 12
    },
    "finalPrice": {
      "netValue": 368.5,
      "grossValue": 433.72,
      "taxValue": 65.22,
      "taxAggregate": {
        "lines": [
          {
            "netValue": 33.5,
            "grossValue": 37.52,
            "taxValue": 4.02,
            "taxCode": "REDUCED",
            "taxRate": 12
          },
          {
            "netValue": 300,
            "grossValue": 357,
            "taxValue": 57,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          {
            "netValue": 35,
            "grossValue": 39.2,
            "taxValue": 4.2,
            "taxCode": "REDUCED",
            "taxRate": 12
          }
        ]
      }
    }
  },
  "channel": {},
  "created": "2025-01-30T13:45:34.406Z",
  "lastStatusChange": "2025-01-30T13:45:34.406Z",
  "id": "EON2076",
  "createdBy": "61443563"
}

Retrieving status transitions for a specific order

get

Retrieves possible status transitions for a specific order. To be used by customers on the storefront.

Required scopes

  • order.order_updateascustomer

Authorizations
Path parameters
orderIdstringRequired

Unique identifier of an order.

tenantstring · min: 3 · max: 16Required

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Pattern: ^[a-z][a-z0-9]+$
Header parameters
saas-tokenstringRequired

Token used to identify logged-in users. This token has an expiry date and is signed with a passphrase.

Responses
200
The request was successful. Status transition for given order returned.
application/json
403
Access forbidden. The caller is not allowed to access this resource.
application/json
404
Order does not exist
application/json
500
Some server side error occurred.
application/json
get
GET /order-v2/{tenant}/orders/{orderId}/transitions HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
saas-token: text
Accept: */*
[
  {
    "status": "CONFIRMED"
  }
]

Retrieving legal entity orders

get

Retrieves a list of orders related to a particular legal entity for a customer. To be used by B2B customers on the storefront.

Required scopes

  • order.order_read_le

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Pattern: ^[a-z][a-z0-9]+$
legalEntityIdstringRequired

Identifier of the legal entity within which the operations are carried out.

Query parameters
sortstringOptional

The list of comma-separated properties used to sort the results. By default, the column values are sorted in ascending order. Can either be in the form of fieldName or fieldName:asc,fieldName:desc. If you want to sort by localized attributes, you must use the following form: fieldName.language or fieldName.language:asc,fieldName.language:desc.

pageNumberinteger · min: 1Optional

The page number to be retrieved where the size of the pages must be specified by the pageSize parameter. The number of the first page is 1.

Default: 1
pageSizeinteger · min: 1Optional

The number of documents being retrieved on the page.

Default: 16
qstringOptional

A standard query parameter is used to search for specific values.

  • Searching for an item by string property: q=currency:USD where currency is the name of string field and USD is its required value.
  • Searching for items by number-based property:
    • Searching for items with specific value: q=tax.total.amount:20
    • Searching for items with value greater than: q=tax.total.amount:>20
    • Searching for items with value lower than: q=tax.total.amount:<20
    • Searching for items with value greater or equal than: q=tax.total.amount:>=20
    • Searching for items with value lower or equal than: q=tax.total.amount:<=20
    • Searching for items with within a range of values: q=tax.total.amount:(>=10 AND <=20)
      where tax.total.amount is name of number-based field and 20 is it's querying value.
  • Searching for items by date property. All number-based property queries are valid also for dates. In that case the date should be placed within double quotes: q=created:(>="2021-05-18T07:27:27.455Z" AND <"2021-05-20T07:27:27.455Z")
  • Searching for items by boolean value: q=customer.mixins.generalAttributes.invoiceNotDeliveryAddress:true where customer.mixins.generalAttributes.invoiceNotDeliveryAddress is a name of boolean field and 'true' is it`s required value.
  • Searching for items with non existing or empty property: q=billingAddress.contactPhone:null where billingAddress.contactPhone is a name of fields that has value null.
  • Searching for items with existing property: q=mixin:exists where mixin is a name of field that has non null value.
  • Searching for items by multiple specific values: q=id:(order_id1,order_id2) where id is name of field and strings within a bracket are it's required value.
  • Searching for items by multiple fields: q=id:order_id1 status:COMPLETED where id and status are the names of fields. All documents that contain given values of these fields are returned. Multiple fields separated by space can be specified. Multiple values for each field can be also specified in a format presented above.
Example: currency:USD
fieldsstringOptional

A list of comma-separated fields names of the Order. If the field is empty then full order is returned. Otherwise, only the indicated fields will be populated in a response.

Header parameters
saas-tokenstringRequired

Token used to identify logged-in users. This token has an expiry date and is signed with a passphrase.

Responses
200
The request was successful. List of legal entity orders with details are returned.
application/json
400
Request was syntactically incorrect. Any details will be provided within the response payload.
application/json
403
Given authorization scopes are not sufficient and do not match required scopes.
application/json
500
Some server side error occurred.
application/json
get
GET /order-v2/{tenant}/legal-entity-orders/{legalEntityId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
saas-token: text
Accept: */*
[
  {
    "id": "text",
    "quoteId": "text",
    "createdBy": "text",
    "assistedBuying": {
      "entries": [
        {
          "employeeId": "text",
          "operation": "CREATE",
          "timestamp": "text"
        }
      ]
    },
    "channel": {
      "name": "text",
      "source": "text"
    },
    "created": "text",
    "completed": "text",
    "lastStatusChange": "text",
    "shipments": [
      {
        "shippedDate": "text",
        "carrier": "text",
        "trackingNumber": "text",
        "expectDeliveryOn": "text"
      }
    ],
    "status": "IN_CHECKOUT",
    "cartId": "text",
    "entries": [
      {
        "id": "text",
        "itemYrn": "text",
        "amount": 1,
        "orderedAmount": 1,
        "packedAmountInPc": 1,
        "effectiveQuantity": 1,
        "calculatedUnitPrice": {
          "netValue": 1,
          "grossValue": 1,
          "taxValue": 1,
          "taxCode": "text",
          "taxRate": 1
        },
        "measurementUnit": {
          "unit": "text",
          "value": 1
        },
        "link": "text",
        "product": {
          "id": "text",
          "sku": "text",
          "code": "text",
          "name": "text",
          "localizedName": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "description": "text",
          "published": true,
          "productType": "BASIC",
          "bundledProducts": [
            {
              "amount": 1,
              "productId": "text"
            }
          ],
          "images": [
            {
              "id": "text",
              "url": "text",
              "stored": false
            }
          ],
          "mixins": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "metadata": {
            "mixins": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "version": 1,
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "price": {
          "priceId": "text",
          "priceListId": "text",
          "effectiveAmount": 1,
          "originalAmount": 1,
          "currency": "text",
          "salePrice": {
            "discountAmount": 1,
            "discountRate": 1,
            "description": "text"
          }
        },
        "metadata": {
          "mixins": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "version": 1,
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "mixins": {},
        "calculatedPrice": {
          "price": {
            "netValue": 1,
            "grossValue": 1,
            "taxValue": 1,
            "taxCode": "text",
            "taxRate": 1
          },
          "upliftValue": {
            "netValue": 1,
            "grossValue": 1,
            "taxValue": 1,
            "taxCode": "text",
            "taxRate": 1
          },
          "discountedPrice": {
            "netValue": 1,
            "grossValue": 1,
            "taxValue": 1,
            "taxRate": 1,
            "taxCode": "text",
            "appliedDiscounts": [
              {
                "id": "text",
                "value": 1,
                "price": {
                  "netValue": 1,
                  "grossValue": 1,
                  "taxValue": 1,
                  "taxCode": "text",
                  "taxRate": 1
                },
                "discountType": "PERCENT",
                "origin": "INTERNAL"
              }
            ]
          },
          "fees": [
            {
              "id": "text",
              "type": "PERCENT",
              "name": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "origin": "INTERNAL",
              "price": {
                "netValue": 1,
                "grossValue": 1,
                "taxValue": 1,
                "taxCode": "text",
                "taxRate": 1
              },
              "discountedPrice": {
                "netValue": 1,
                "grossValue": 1,
                "taxValue": 1,
                "taxCode": "text",
                "taxRate": 1,
                "appliedDiscounts": [
                  {
                    "id": "text",
                    "value": 1,
                    "price": {
                      "netValue": 1,
                      "grossValue": 1,
                      "taxValue": 1,
                      "taxCode": "text",
                      "taxRate": 1
                    },
                    "discountType": "PERCENT",
                    "origin": "INTERNAL"
                  }
                ]
              }
            }
          ],
          "totalFee": {
            "netValue": 1,
            "grossValue": 1,
            "taxValue": 1,
            "taxRate": 1,
            "taxCode": "text",
            "appliedDiscounts": [
              {
                "id": "text",
                "value": 1,
                "price": {
                  "netValue": 1,
                  "grossValue": 1,
                  "taxValue": 1,
                  "taxCode": "text",
                  "taxRate": 1
                },
                "discountType": "PERCENT",
                "origin": "INTERNAL"
              }
            ]
          },
          "totalDiscount": {
            "calculationType": "ApplyDiscountBeforeTax",
            "value": 1,
            "appliedDiscounts": [
              {
                "id": "text",
                "value": 1,
                "price": {
                  "netValue": 1,
                  "grossValue": 1,
                  "taxValue": 1,
                  "taxCode": "text",
                  "taxRate": 1
                },
                "discountType": "PERCENT",
                "origin": "INTERNAL"
              }
            ],
            "price": {
              "netValue": 1,
              "grossValue": 1,
              "taxValue": 1,
              "taxCode": "text",
              "taxRate": 1
            }
          },
          "finalPrice": {
            "netValue": 1,
            "grossValue": 1,
            "taxValue": 1,
            "taxRate": 1,
            "taxCode": "text"
          }
        },
        "priceMatchDetails": {
          "netValue": 1,
          "grossValue": 1,
          "taxValue": 1,
          "taxCode": "text",
          "taxRate": 1,
          "taxCountry": "text"
        },
        "externalDiscounts": [
          {
            "id": "text",
            "discountType": "PERCENT",
            "value": 1,
            "includeFees": true,
            "sequence": 1
          }
        ]
      }
    ],
    "discounts": [],
    "customer": {
      "id": "ANONYMOUS",
      "name": "text",
      "title": "text",
      "firstName": "text",
      "middleName": "text",
      "lastName": "text",
      "company": "text",
      "email": "text",
      "metadata": {
        "mixins": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "version": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "mixins": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "siteCode": "text",
    "countryCode": "text",
    "billingAddress": {
      "contactName": "text",
      "companyName": "text",
      "street": "text",
      "streetNumber": "text",
      "streetAppendix": "text",
      "extraLine1": "text",
      "extraLine2": "text",
      "extraLine3": "text",
      "extraLine4": "text",
      "zipCode": "text",
      "city": "text",
      "state": "text",
      "country": "text",
      "contactPhone": "text",
      "metadata": {
        "mixins": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "version": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "mixins": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "shippingAddress": {
      "contactName": "text",
      "companyName": "text",
      "street": "text",
      "streetNumber": "text",
      "streetAppendix": "text",
      "extraLine1": "text",
      "extraLine2": "text",
      "extraLine3": "text",
      "extraLine4": "text",
      "zipCode": "text",
      "city": "text",
      "state": "text",
      "country": "text",
      "contactPhone": "text",
      "metadata": {
        "mixins": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "version": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "mixins": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "payments": [
      {
        "method": "text",
        "status": "PENDING",
        "paymentResponse": "text",
        "paidAmount": 1,
        "refundAmount": 1,
        "currency": "text",
        "transactionId": "text",
        "redirectUrl": "text",
        "authorizedAmount": 1,
        "provider": "text"
      }
    ],
    "totalAuthorizedAmount": 1,
    "currency": "text",
    "orderCycle": "text",
    "deliveryWindowId": "text",
    "deliveryWindow": {
      "id": "text",
      "deliveryDate": "2025-06-21",
      "slotId": "text",
      "deliveryTimeRange": {
        "timeFrom": "11:36:28",
        "timeTo": "11:36:28"
      },
      "deliveryCycle": "text",
      "deliveryCycleName": "text"
    },
    "metadata": {
      "mixins": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "version": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "mixins": {},
    "calculatedPrice": {
      "price": {
        "netValue": 1,
        "grossValue": 1,
        "taxValue": 1,
        "taxCode": "text",
        "taxRate": 1
      },
      "upliftValue": {
        "netValue": 1,
        "grossValue": 1,
        "taxValue": 1,
        "taxCode": "text",
        "taxRate": 1
      },
      "discountedPrice": {
        "netValue": 1,
        "grossValue": 1,
        "taxValue": 1,
        "taxCode": "text",
        "taxRate": 1,
        "appliedDiscounts": [
          {
            "id": "text",
            "value": 1,
            "price": {
              "netValue": 1,
              "grossValue": 1,
              "taxValue": 1,
              "taxCode": "text",
              "taxRate": 1
            },
            "discountType": "PERCENT",
            "origin": "INTERNAL"
          }
        ]
      },
      "paymentFees": [
        {
          "id": "text",
          "type": "PERCENT",
          "name": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "price": {
            "netValue": 1,
            "grossValue": 1,
            "taxValue": 1,
            "taxCode": "text",
            "taxRate": 1
          }
        }
      ],
      "fees": {
        "netValue": 1,
        "grossValue": 1,
        "taxValue": 1,
        "taxCode": "text",
        "taxRate": 1
      },
      "totalFee": {
        "netValue": 1,
        "grossValue": 1,
        "taxValue": 1,
        "taxRate": 1,
        "taxCode": "text",
        "appliedDiscounts": [
          {
            "id": "text",
            "value": 1,
            "price": {
              "netValue": 1,
              "grossValue": 1,
              "taxValue": 1,
              "taxCode": "text",
              "taxRate": 1
            },
            "discountType": "PERCENT",
            "origin": "INTERNAL"
          }
        ]
      },
      "totalDiscount": {
        "calculationType": "ApplyDiscountBeforeTax",
        "value": 1,
        "appliedDiscounts": [
          {
            "id": "text",
            "value": 1,
            "price": {
              "netValue": 1,
              "grossValue": 1,
              "taxValue": 1,
              "taxCode": "text",
              "taxRate": 1
            },
            "discountType": "PERCENT",
            "origin": "INTERNAL"
          }
        ],
        "price": {
          "netValue": 1,
          "grossValue": 1,
          "taxValue": 1,
          "taxCode": "text",
          "taxRate": 1
        }
      },
      "shipping": {
        "netValue": 1,
        "grossValue": 1,
        "taxValue": 1,
        "taxCode": "text",
        "taxRate": 1
      },
      "totalShipping": {
        "netValue": 1,
        "grossValue": 1,
        "taxValue": 1,
        "taxCode": "text",
        "taxRate": 1,
        "appliedDiscounts": [
          {
            "id": "text",
            "value": 1,
            "price": {
              "netValue": 1,
              "grossValue": 1,
              "taxValue": 1,
              "taxCode": "text",
              "taxRate": 1
            },
            "discountType": "PERCENT",
            "origin": "INTERNAL"
          }
        ]
      },
      "finalPrice": {
        "netValue": 1,
        "grossValue": 1,
        "taxValue": 1,
        "taxRate": 1,
        "taxCode": "text",
        "taxAggregate": {
          "lines": [
            {
              "netValue": 1,
              "grossValue": 1,
              "taxValue": 1,
              "taxCode": "text",
              "taxRate": 1
            }
          ]
        }
      }
    },
    "legalEntityId": "text"
  }
]

Retrieving legal entity order

get

Retrieves an order related to a particular legal entity for a customer. To be used by B2B customers on the storefront.

Required scopes

  • order.order_read_le

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Pattern: ^[a-z][a-z0-9]+$
legalEntityIdstringRequired

Identifier of the legal entity within which the operations are carried out.

orderIdstringRequired

Unique identifier of an order.

Header parameters
saas-tokenstringRequired

Token used to identify logged-in users. This token has an expiry date and is signed with a passphrase.

Responses
200
The request was successful. The legal entity order with details is returned.
application/json
Responseall of
and
400
Request was syntactically incorrect. Any details will be provided within the response payload.
application/json
403
Given authorization scopes are not sufficient and do not match required scopes.
application/json
404
Order does not exist
application/json
500
Some server side error occurred.
application/json
get
GET /order-v2/{tenant}/legal-entity-orders/{legalEntityId}/{orderId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
saas-token: text
Accept: */*
{
  "id": "text",
  "quoteId": "text",
  "createdBy": "text",
  "assistedBuying": {
    "entries": [
      {
        "employeeId": "text",
        "operation": "CREATE",
        "timestamp": "text"
      }
    ]
  },
  "channel": {
    "name": "text",
    "source": "text"
  },
  "created": "text",
  "completed": "text",
  "lastStatusChange": "text",
  "shipments": [
    {
      "shippedDate": "text",
      "carrier": "text",
      "trackingNumber": "text",
      "expectDeliveryOn": "text"
    }
  ],
  "status": "IN_CHECKOUT",
  "cartId": "text",
  "entries": [
    {
      "id": "text",
      "itemYrn": "text",
      "amount": 1,
      "orderedAmount": 1,
      "packedAmountInPc": 1,
      "effectiveQuantity": 1,
      "calculatedUnitPrice": {
        "netValue": 1,
        "grossValue": 1,
        "taxValue": 1,
        "taxCode": "text",
        "taxRate": 1
      },
      "measurementUnit": {
        "unit": "text",
        "value": 1
      },
      "link": "text",
      "product": {
        "id": "text",
        "sku": "text",
        "code": "text",
        "name": "text",
        "localizedName": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "description": "text",
        "published": true,
        "productType": "BASIC",
        "bundledProducts": [
          {
            "amount": 1,
            "productId": "text"
          }
        ],
        "images": [
          {
            "id": "text",
            "url": "text",
            "stored": false
          }
        ],
        "mixins": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "metadata": {
          "mixins": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "version": 1,
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "price": {
        "priceId": "text",
        "priceListId": "text",
        "effectiveAmount": 1,
        "originalAmount": 1,
        "currency": "text",
        "salePrice": {
          "discountAmount": 1,
          "discountRate": 1,
          "description": "text"
        }
      },
      "metadata": {
        "mixins": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "version": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "mixins": {},
      "calculatedPrice": {
        "price": {
          "netValue": 1,
          "grossValue": 1,
          "taxValue": 1,
          "taxCode": "text",
          "taxRate": 1
        },
        "upliftValue": {
          "netValue": 1,
          "grossValue": 1,
          "taxValue": 1,
          "taxCode": "text",
          "taxRate": 1
        },
        "discountedPrice": {
          "netValue": 1,
          "grossValue": 1,
          "taxValue": 1,
          "taxRate": 1,
          "taxCode": "text",
          "appliedDiscounts": [
            {
              "id": "text",
              "value": 1,
              "price": {
                "netValue": 1,
                "grossValue": 1,
                "taxValue": 1,
                "taxCode": "text",
                "taxRate": 1
              },
              "discountType": "PERCENT",
              "origin": "INTERNAL"
            }
          ]
        },
        "fees": [
          {
            "id": "text",
            "type": "PERCENT",
            "name": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "origin": "INTERNAL",
            "price": {
              "netValue": 1,
              "grossValue": 1,
              "taxValue": 1,
              "taxCode": "text",
              "taxRate": 1
            },
            "discountedPrice": {
              "netValue": 1,
              "grossValue": 1,
              "taxValue": 1,
              "taxCode": "text",
              "taxRate": 1,
              "appliedDiscounts": [
                {
                  "id": "text",
                  "value": 1,
                  "price": {
                    "netValue": 1,
                    "grossValue": 1,
                    "taxValue": 1,
                    "taxCode": "text",
                    "taxRate": 1
                  },
                  "discountType": "PERCENT",
                  "origin": "INTERNAL"
                }
              ]
            }
          }
        ],
        "totalFee": {
          "netValue": 1,
          "grossValue": 1,
          "taxValue": 1,
          "taxRate": 1,
          "taxCode": "text",
          "appliedDiscounts": [
            {
              "id": "text",
              "value": 1,
              "price": {
                "netValue": 1,
                "grossValue": 1,
                "taxValue": 1,
                "taxCode": "text",
                "taxRate": 1
              },
              "discountType": "PERCENT",
              "origin": "INTERNAL"
            }
          ]
        },
        "totalDiscount": {
          "calculationType": "ApplyDiscountBeforeTax",
          "value": 1,
          "appliedDiscounts": [
            {
              "id": "text",
              "value": 1,
              "price": {
                "netValue": 1,
                "grossValue": 1,
                "taxValue": 1,
                "taxCode": "text",
                "taxRate": 1
              },
              "discountType": "PERCENT",
              "origin": "INTERNAL"
            }
          ],
          "price": {
            "netValue": 1,
            "grossValue": 1,
            "taxValue": 1,
            "taxCode": "text",
            "taxRate": 1
          }
        },
        "finalPrice": {
          "netValue": 1,
          "grossValue": 1,
          "taxValue": 1,
          "taxRate": 1,
          "taxCode": "text"
        }
      },
      "priceMatchDetails": {
        "netValue": 1,
        "grossValue": 1,
        "taxValue": 1,
        "taxCode": "text",
        "taxRate": 1,
        "taxCountry": "text"
      },
      "externalDiscounts": [
        {
          "id": "text",
          "discountType": "PERCENT",
          "value": 1,
          "includeFees": true,
          "sequence": 1
        }
      ]
    }
  ],
  "discounts": [],
  "customer": {
    "id": "ANONYMOUS",
    "name": "text",
    "title": "text",
    "firstName": "text",
    "middleName": "text",
    "lastName": "text",
    "company": "text",
    "email": "text",
    "metadata": {
      "mixins": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "version": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "mixins": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "siteCode": "text",
  "countryCode": "text",
  "billingAddress": {
    "contactName": "text",
    "companyName": "text",
    "street": "text",
    "streetNumber": "text",
    "streetAppendix": "text",
    "extraLine1": "text",
    "extraLine2": "text",
    "extraLine3": "text",
    "extraLine4": "text",
    "zipCode": "text",
    "city": "text",
    "state": "text",
    "country": "text",
    "contactPhone": "text",
    "metadata": {
      "mixins": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "version": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "mixins": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "shippingAddress": {
    "contactName": "text",
    "companyName": "text",
    "street": "text",
    "streetNumber": "text",
    "streetAppendix": "text",
    "extraLine1": "text",
    "extraLine2": "text",
    "extraLine3": "text",
    "extraLine4": "text",
    "zipCode": "text",
    "city": "text",
    "state": "text",
    "country": "text",
    "contactPhone": "text",
    "metadata": {
      "mixins": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "version": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "mixins": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "payments": [
    {
      "method": "text",
      "status": "PENDING",
      "paymentResponse": "text",
      "paidAmount": 1,
      "refundAmount": 1,
      "currency": "text",
      "transactionId": "text",
      "redirectUrl": "text",
      "authorizedAmount": 1,
      "provider": "text"
    }
  ],
  "totalAuthorizedAmount": 1,
  "currency": "text",
  "orderCycle": "text",
  "deliveryWindowId": "text",
  "deliveryWindow": {
    "id": "text",
    "deliveryDate": "2025-06-21",
    "slotId": "text",
    "deliveryTimeRange": {
      "timeFrom": "11:36:28",
      "timeTo": "11:36:28"
    },
    "deliveryCycle": "text",
    "deliveryCycleName": "text"
  },
  "metadata": {
    "mixins": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "version": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "mixins": {},
  "calculatedPrice": {
    "price": {
      "netValue": 1,
      "grossValue": 1,
      "taxValue": 1,
      "taxCode": "text",
      "taxRate": 1
    },
    "upliftValue": {
      "netValue": 1,
      "grossValue": 1,
      "taxValue": 1,
      "taxCode": "text",
      "taxRate": 1
    },
    "discountedPrice": {
      "netValue": 1,
      "grossValue": 1,
      "taxValue": 1,
      "taxCode": "text",
      "taxRate": 1,
      "appliedDiscounts": [
        {
          "id": "text",
          "value": 1,
          "price": {
            "netValue": 1,
            "grossValue": 1,
            "taxValue": 1,
            "taxCode": "text",
            "taxRate": 1
          },
          "discountType": "PERCENT",
          "origin": "INTERNAL"
        }
      ]
    },
    "paymentFees": [
      {
        "id": "text",
        "type": "PERCENT",
        "name": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "price": {
          "netValue": 1,
          "grossValue": 1,
          "taxValue": 1,
          "taxCode": "text",
          "taxRate": 1
        }
      }
    ],
    "fees": {
      "netValue": 1,
      "grossValue": 1,
      "taxValue": 1,
      "taxCode": "text",
      "taxRate": 1
    },
    "totalFee": {
      "netValue": 1,
      "grossValue": 1,
      "taxValue": 1,
      "taxRate": 1,
      "taxCode": "text",
      "appliedDiscounts": [
        {
          "id": "text",
          "value": 1,
          "price": {
            "netValue": 1,
            "grossValue": 1,
            "taxValue": 1,
            "taxCode": "text",
            "taxRate": 1
          },
          "discountType": "PERCENT",
          "origin": "INTERNAL"
        }
      ]
    },
    "totalDiscount": {
      "calculationType": "ApplyDiscountBeforeTax",
      "value": 1,
      "appliedDiscounts": [
        {
          "id": "text",
          "value": 1,
          "price": {
            "netValue": 1,
            "grossValue": 1,
            "taxValue": 1,
            "taxCode": "text",
            "taxRate": 1
          },
          "discountType": "PERCENT",
          "origin": "INTERNAL"
        }
      ],
      "price": {
        "netValue": 1,
        "grossValue": 1,
        "taxValue": 1,
        "taxCode": "text",
        "taxRate": 1
      }
    },
    "shipping": {
      "netValue": 1,
      "grossValue": 1,
      "taxValue": 1,
      "taxCode": "text",
      "taxRate": 1
    },
    "totalShipping": {
      "netValue": 1,
      "grossValue": 1,
      "taxValue": 1,
      "taxCode": "text",
      "taxRate": 1,
      "appliedDiscounts": [
        {
          "id": "text",
          "value": 1,
          "price": {
            "netValue": 1,
            "grossValue": 1,
            "taxValue": 1,
            "taxCode": "text",
            "taxRate": 1
          },
          "discountType": "PERCENT",
          "origin": "INTERNAL"
        }
      ]
    },
    "finalPrice": {
      "netValue": 1,
      "grossValue": 1,
      "taxValue": 1,
      "taxRate": 1,
      "taxCode": "text",
      "taxAggregate": {
        "lines": [
          {
            "netValue": 1,
            "grossValue": 1,
            "taxValue": 1,
            "taxCode": "text",
            "taxRate": 1
          }
        ]
      }
    }
  },
  "legalEntityId": "text"
}
  • GETRetrieving a list of orders
  • POSTCreating a new order
  • GETRetrieving order details
  • GETRetrieving status transitions for a specific order
  • POSTUpdating order status
  • GETRetrieving legal entity orders
  • GETRetrieving legal entity order

Retrieving a list of orders

get

Retrieves a list of orders for a customer. To be used by customers on the storefront.

Required scopes

  • order.history_view for logged in customers only.

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Pattern: ^[a-z][a-z0-9]+$
Query parameters
sortstringOptional

The list of comma-separated properties used to sort the results. By default, the column values are sorted in ascending order. Can either be in the form of fieldName or fieldName:asc,fieldName:desc. If you want to sort by localized attributes, you must use the following form: fieldName.language or fieldName.language:asc,fieldName.language:desc.

pageNumberinteger · min: 1Optional

The page number to be retrieved where the size of the pages must be specified by the pageSize parameter. The number of the first page is 1.

Default: 1
pageSizeinteger · min: 1Optional

The number of documents being retrieved on the page.

Default: 16
qstringOptional

A standard query parameter is used to search for specific values.

  • Searching for an item by string property: q=currency:USD where currency is the name of string field and USD is its required value.
  • Searching for items by number-based property:
    • Searching for items with specific value: q=tax.total.amount:20
    • Searching for items with value greater than: q=tax.total.amount:>20
    • Searching for items with value lower than: q=tax.total.amount:<20
    • Searching for items with value greater or equal than: q=tax.total.amount:>=20
    • Searching for items with value lower or equal than: q=tax.total.amount:<=20
    • Searching for items with within a range of values: q=tax.total.amount:(>=10 AND <=20)
      where tax.total.amount is name of number-based field and 20 is it's querying value.
  • Searching for items by date property. All number-based property queries are valid also for dates. In that case the date should be placed within double quotes: q=created:(>="2021-05-18T07:27:27.455Z" AND <"2021-05-20T07:27:27.455Z")
  • Searching for items by boolean value: q=customer.mixins.generalAttributes.invoiceNotDeliveryAddress:true where customer.mixins.generalAttributes.invoiceNotDeliveryAddress is a name of boolean field and 'true' is it`s required value.
  • Searching for items with non existing or empty property: q=billingAddress.contactPhone:null where billingAddress.contactPhone is a name of fields that has value null.
  • Searching for items with existing property: q=mixin:exists where mixin is a name of field that has non null value.
  • Searching for items by multiple specific values: q=id:(order_id1,order_id2) where id is name of field and strings within a bracket are it's required value.
  • Searching for items by multiple fields: q=id:order_id1 status:COMPLETED where id and status are the names of fields. All documents that contain given values of these fields are returned. Multiple fields separated by space can be specified. Multiple values for each field can be also specified in a format presented above.
Example: currency:USD
fieldsstringOptional

A list of comma-separated fields names of the Order. If the field is empty then full order is returned. Otherwise, only the indicated fields will be populated in a response.

Header parameters
saas-tokenstringRequired

Token used to identify logged-in users. This token has an expiry date and is signed with a passphrase.

Responses
200
Some server side error occurred.
application/json
400
Request was syntactically incorrect. Any details will be provided within the response payload.
application/json
403
Given authorization scopes are not sufficient and do not match required scopes.
application/json
500
Some server side error occurred.
application/json
get
GET /order-v2/{tenant}/orders HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
saas-token: text
Accept: */*
[
  {
    "status": "IN_CHECKOUT",
    "entries": [
      {
        "id": "BC10033--BC10033-43",
        "itemYrn": "urn:yaas:saasag:caasproduct:product:test;BC10033--BC10033-43",
        "amount": 3,
        "orderedAmount": 3,
        "effectiveQuantity": 3,
        "originalAmount": 100,
        "originalPrice": 100,
        "unitPrice": 100,
        "calculatedUnitPrice": {
          "netValue": 100,
          "grossValue": 119,
          "taxValue": 19,
          "taxCode": "STANDARD",
          "taxRate": 19
        },
        "totalPrice": 300,
        "authorizedAmount": 300,
        "product": {
          "metadata": {
            "mixins": {
              "productTemplateAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/test/63ec98500522b25c90b9e632-templateAttributes_v1.json",
              "productVariantAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/test/63ec98500522b25c90b9e632-variantAttributes_v1.json"
            }
          },
          "id": "BC10033--BC10033-43",
          "sku": "8033546091234",
          "name": "Safety shoes high Reptile RS S3 SRC, black",
          "localizedName": {
            "de": "Hohe Sicherheitsschuhe Reptile RS S3 SRC, schwarz",
            "en": "Safety shoes high Reptile RS S3 SRC, black"
          },
          "description": "[de:Sicherheitsstiefel, klassisch und robust, U-Power Style&Job Linie, Obermaterial aus wasserabweisendem, bedrucktem Leder, Stahlkappe, Durchtrittsicherheit, rutschfest, ergonomisches Inox Laminat und PU/PU Sohle, RS S3 SRC., en:Safety shoes high, U-Power, classic and strong of the \"Style & Job\" range, with water repellent printed leather upper, steel toe cap, anti-puncture, anti-slip, ergonomic steel foil and PU / PU sole, RS S3 SRC.]",
          "published": true,
          "images": [
            {
              "id": "6437eb7f8fc03d22f4e856ce",
              "url": "http://res.cloudinary.com/saas-ag/image/upload/v1681386368/test/media/6437eb7f8fc03d22f4e856ce",
              "stored": false
            }
          ],
          "mixins": {
            "productVariantAttributes": {
              "size": 43
            }
          },
          "productType": "VARIANT"
        },
        "tax": {
          "lines": [
            {
              "amount": 57,
              "currency": "EUR",
              "code": "STANDARD",
              "name": "STANDARD",
              "rate": 19,
              "sequenceId": 0,
              "inclusive": false
            }
          ],
          "total": {
            "amount": 0,
            "currency": "EUR",
            "inclusive": false
          }
        },
        "price": {
          "priceId": "6763cd21139f370cd9244d37",
          "currency": "EUR",
          "originalAmount": 100,
          "effectiveAmount": 100,
          "basePrice": {},
          "presentationPrice": {},
          "metadata": {
            "createdAt": "2024-12-19T07:37:05.559Z",
            "modifiedAt": "2024-12-19T07:37:05.559Z",
            "version": 1
          }
        },
        "totalDiscount": {
          "amount": 0,
          "currency": "EUR"
        },
        "fees": {
          "total": {
            "subTotal": 0,
            "totalTax": 0,
            "total": 0
          }
        },
        "metadata": {
          "mixins": {
            "fees": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
          }
        },
        "mixins": {
          "fees": {
            "total": {
              "subTotal": 0,
              "totalTax": 0,
              "total": 0,
              "discount": 0
            }
          }
        },
        "calculatedPrice": {
          "price": {
            "netValue": 300,
            "grossValue": 357,
            "taxValue": 57,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          "finalPrice": {
            "netValue": 300,
            "grossValue": 357,
            "taxValue": 57,
            "taxCode": "STANDARD",
            "taxRate": 19
          }
        },
        "priceMatchDetails": {
          "netValue": 100,
          "grossValue": 119,
          "taxValue": 19,
          "taxCode": "STANDARD",
          "taxRate": 19,
          "taxCountry": "DE"
        }
      }
    ],
    "discounts": [],
    "customer": {
      "id": "61443563",
      "name": "Test name",
      "firstName": "John",
      "lastName": "Smith",
      "company": "Emporix",
      "email": "test@test.com"
    },
    "siteCode": "DE",
    "countryCode": "DE",
    "billingAddress": {
      "contactName": "Templatecompany",
      "companyName": "Templatecompany",
      "street": "Strasse 1",
      "streetNumber": "",
      "zipCode": "12221",
      "city": "Berlin",
      "country": "DE",
      "state": "DE"
    },
    "shippingAddress": {
      "contactName": "Templatecompany",
      "companyName": "Templatecompany",
      "street": "Strasse 1",
      "streetNumber": "",
      "zipCode": "12221",
      "city": "Berlin",
      "country": "DE",
      "state": "DE"
    },
    "payments": [
      {
        "status": "PENDING",
        "method": "invoice",
        "paymentResponse": "Payment is handled externally",
        "paidAmount": 0,
        "currency": "EUR",
        "transactionId": "fcc2bf50-f064-4dc3-833f-0909a7857387",
        "authorizedAmount": 373.12,
        "provider": "payment-gateway"
      }
    ],
    "shipping": {
      "total": {
        "amount": 39.2,
        "currency": "EUR"
      },
      "lines": [
        {
          "amount": 35,
          "currency": "EUR",
          "code": "pickup",
          "name": "pickup",
          "localizedName": {
            "en": "pickup",
            "de": "pickup"
          },
          "tax": {
            "total": {
              "amount": 4.2,
              "currency": "EUR",
              "inclusive": false
            },
            "rate": 12
          },
          "shippingTaxCode": "REDUCED"
        }
      ]
    },
    "tax": {
      "lines": [
        {
          "amount": 4.2,
          "currency": "EUR",
          "code": "REDUCED",
          "name": "REDUCED",
          "rate": 12,
          "sequenceId": 0,
          "inclusive": false
        },
        {
          "amount": 57,
          "currency": "EUR",
          "code": "STANDARD",
          "name": "STANDARD",
          "rate": 19,
          "sequenceId": 1,
          "inclusive": false
        }
      ],
      "total": {
        "amount": 0,
        "currency": "EUR",
        "inclusive": false
      }
    },
    "subTotalPrice": 300,
    "totalPrice": 333.92,
    "totalAuthorizedAmount": 373.12,
    "currency": "EUR",
    "metadata": {
      "mixins": {
        "payments": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json",
        "deliveryTime": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryTimeMixIn.v2.json",
        "generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/orderGeneralAttributesMixIn.v9.json",
        "payment": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/paymentMixIn.v3.json"
      },
      "version": 1
    },
    "mixins": {
      "payments": {
        "elements": [
          {
            "paymentMethodYrn": "urn:yaas:hybris:payments:payment-method:test;invoice",
            "fees": {
              "elements": [
                {
                  "yrn": "urn:yaas:saasag:fee:fee:test;678f552a949c723de46bdb14",
                  "name": {
                    "de": "Payment fee",
                    "en": "Payment fee"
                  },
                  "taxCode": "REDUCED",
                  "total": {
                    "subTotal": 33.92,
                    "totalTax": 0,
                    "total": 33.92,
                    "discount": 0
                  }
                }
              ],
              "total": {
                "subTotal": 0,
                "totalTax": 0,
                "total": 0,
                "discount": 0
              }
            },
            "total": {
              "subTotal": 33.92,
              "totalTax": 0,
              "total": 33.92,
              "discount": 0
            }
          }
        ],
        "total": {
          "subTotal": 33.92,
          "totalTax": 0,
          "total": 33.92,
          "discount": 0
        }
      },
      "deliveryTime": {
        "deliveryTimeId": "64e36da5814eba1635228dfe",
        "deliveryDate": "2025-02-07T11:00:00.000Z",
        "deliveryTimeFrom": "10:00",
        "deliveryTimeTo": "14:30",
        "deliveryTimeZoneId": "deliveryarea",
        "deliveryTimeMethodId": "pickup",
        "deliveryCosts": 35
      },
      "generalAttributes": {
        "extendedOrderStatus": "05",
        "customerFirstOrder": false,
        "orderNumber": "EON2076"
      },
      "payment": {
        "paymentType": "invoice"
      }
    },
    "deliveryWindow": {
      "id": "64e36da5814eba1635228dfe",
      "slotId": "c291c677-5460-4efb-b893-145c866a2af2",
      "deliveryDate": "2025-02-07",
      "deliveryCycle": "2025-02-07-15pickupFriday1000-1430",
      "deliveryCycleName": "pickupFriday1000-1430",
      "deliveryTimeRange": {
        "timeFrom": "10:00",
        "timeTo": "14:30"
      }
    },
    "feeYrnAggregate": {
      "elements": [
        {
          "yrn": "urn:yaas:saasag:fee:fee:test;678f552a949c723de46bdb14",
          "name": {
            "de": "Payment fee",
            "en": "Payment fee"
          },
          "taxCode": "REDUCED",
          "total": {
            "subTotal": 33.92,
            "totalTax": 0,
            "total": 33.92
          }
        }
      ],
      "total": {
        "subTotal": 33.92,
        "totalTax": 0,
        "total": 33.92
      }
    },
    "calculatedPrice": {
      "price": {
        "netValue": 300,
        "grossValue": 357,
        "taxValue": 57,
        "taxCode": "STANDARD",
        "taxRate": 19
      },
      "paymentFees": [
        {
          "id": "678f552a949c723de46bdb14",
          "type": "PERCENT",
          "name": {
            "de": "Payment fee",
            "en": "Payment fee"
          },
          "price": {
            "netValue": 33.5,
            "grossValue": 37.52,
            "taxValue": 4.02,
            "taxCode": "REDUCED",
            "taxRate": 12
          }
        }
      ],
      "totalFee": {
        "netValue": 33.5,
        "grossValue": 37.52,
        "taxValue": 4.02,
        "taxCode": "REDUCED",
        "taxRate": 12
      },
      "totalShipping": {
        "netValue": 35,
        "grossValue": 39.2,
        "taxValue": 4.2,
        "taxCode": "REDUCED",
        "taxRate": 12
      },
      "finalPrice": {
        "netValue": 368.5,
        "grossValue": 433.72,
        "taxValue": 65.22,
        "taxAggregate": {
          "lines": [
            {
              "netValue": 33.5,
              "grossValue": 37.52,
              "taxValue": 4.02,
              "taxCode": "REDUCED",
              "taxRate": 12
            },
            {
              "netValue": 300,
              "grossValue": 357,
              "taxValue": 57,
              "taxCode": "STANDARD",
              "taxRate": 19
            },
            {
              "netValue": 35,
              "grossValue": 39.2,
              "taxValue": 4.2,
              "taxCode": "REDUCED",
              "taxRate": 12
            }
          ]
        }
      }
    },
    "channel": {},
    "created": "2025-01-30T13:45:34.406Z",
    "lastStatusChange": "2025-01-30T13:45:34.406Z",
    "id": "EON2076",
    "createdBy": "61443563"
  },
  {
    "status": "IN_CHECKOUT",
    "entries": [
      {
        "id": "BC10033--BC10033-43",
        "itemYrn": "urn:yaas:saasag:caasproduct:product:test;BC10033--BC10033-43",
        "amount": 3,
        "orderedAmount": 3,
        "effectiveQuantity": 3,
        "originalAmount": 100,
        "originalPrice": 100,
        "unitPrice": 100,
        "totalPrice": 300,
        "authorizedAmount": 300,
        "product": {
          "metadata": {
            "mixins": {
              "productTemplateAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/test/63ec98500522b25c90b9e632-templateAttributes_v1.json",
              "productVariantAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/test/63ec98500522b25c90b9e632-variantAttributes_v1.json"
            }
          },
          "id": "BC10033--BC10033-43",
          "sku": "8033546091234",
          "name": "Safety shoes high Reptile RS S3 SRC, black",
          "localizedName": {
            "de": "Hohe Sicherheitsschuhe Reptile RS S3 SRC, schwarz",
            "en": "Safety shoes high Reptile RS S3 SRC, black"
          },
          "description": "[de:Sicherheitsstiefel, klassisch und robust, U-Power Style&Job Linie, Obermaterial aus wasserabweisendem, bedrucktem Leder, Stahlkappe, Durchtrittsicherheit, rutschfest, ergonomisches Inox Laminat und PU/PU Sohle, RS S3 SRC., en:Safety shoes high, U-Power, classic and strong of the \"Style & Job\" range, with water repellent printed leather upper, steel toe cap, anti-puncture, anti-slip, ergonomic steel foil and PU / PU sole, RS S3 SRC.]",
          "published": true,
          "images": [
            {
              "id": "6437eb7f8fc03d22f4e856ce",
              "url": "http://res.cloudinary.com/saas-ag/image/upload/v1681386368/test/media/6437eb7f8fc03d22f4e856ce",
              "stored": false
            }
          ],
          "mixins": {
            "productVariantAttributes": {
              "size": 43
            }
          },
          "productType": "VARIANT"
        },
        "tax": {
          "lines": [
            {
              "amount": 57,
              "currency": "EUR",
              "code": "STANDARD",
              "name": "STANDARD",
              "rate": 19,
              "sequenceId": 0,
              "inclusive": false
            }
          ],
          "total": {
            "amount": 0,
            "currency": "EUR",
            "inclusive": false
          }
        },
        "price": {
          "priceId": "6763cd21139f370cd9244d37",
          "currency": "EUR",
          "originalAmount": 100,
          "effectiveAmount": 100,
          "basePrice": {},
          "presentationPrice": {},
          "metadata": {
            "createdAt": "2024-12-19T07:37:05.559Z",
            "modifiedAt": "2024-12-19T07:37:05.559Z",
            "version": 1
          }
        },
        "totalDiscount": {
          "amount": 0,
          "currency": "EUR"
        },
        "fees": {
          "total": {
            "subTotal": 0,
            "totalTax": 0,
            "total": 0
          }
        },
        "metadata": {
          "mixins": {
            "fees": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
          }
        },
        "mixins": {
          "fees": {
            "total": {
              "subTotal": 0,
              "totalTax": 0,
              "total": 0,
              "discount": 0
            }
          }
        },
        "calculatedPrice": {
          "price": {
            "netValue": 300,
            "grossValue": 357,
            "taxValue": 57,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          "finalPrice": {
            "netValue": 300,
            "grossValue": 357,
            "taxValue": 57,
            "taxCode": "STANDARD",
            "taxRate": 19
          }
        },
        "priceMatchDetails": {
          "netValue": 100,
          "grossValue": 119,
          "taxValue": 19,
          "taxCode": "STANDARD",
          "taxRate": 19,
          "taxCountry": "DE"
        }
      }
    ],
    "discounts": [],
    "customer": {
      "id": "61443563",
      "name": "Test name",
      "firstName": "John",
      "lastName": "Smith",
      "company": "Emporix",
      "email": "test@test.com"
    },
    "siteCode": "DE",
    "countryCode": "DE",
    "billingAddress": {
      "contactName": "Templatecompany",
      "companyName": "Templatecompany",
      "street": "Strasse 1",
      "streetNumber": "",
      "zipCode": "12221",
      "city": "Berlin",
      "country": "DE",
      "state": "DE"
    },
    "shippingAddress": {
      "contactName": "Templatecompany",
      "companyName": "Templatecompany",
      "street": "Strasse 1",
      "streetNumber": "",
      "zipCode": "12221",
      "city": "Berlin",
      "country": "DE",
      "state": "DE"
    },
    "payments": [
      {
        "status": "PENDING",
        "method": "invoice",
        "paymentResponse": "Payment is handled externally",
        "paidAmount": 0,
        "currency": "EUR",
        "transactionId": "fcc2bf50-f064-4dc3-833f-0909a7857387",
        "authorizedAmount": 373.12,
        "provider": "payment-gateway"
      }
    ],
    "shipping": {
      "total": {
        "amount": 39.2,
        "currency": "EUR"
      },
      "lines": [
        {
          "amount": 35,
          "currency": "EUR",
          "code": "pickup",
          "name": "pickup",
          "localizedName": {
            "en": "pickup",
            "de": "pickup"
          },
          "tax": {
            "total": {
              "amount": 4.2,
              "currency": "EUR",
              "inclusive": false
            },
            "rate": 12
          },
          "shippingTaxCode": "REDUCED"
        }
      ]
    },
    "tax": {
      "lines": [
        {
          "amount": 4.2,
          "currency": "EUR",
          "code": "REDUCED",
          "name": "REDUCED",
          "rate": 12,
          "sequenceId": 0,
          "inclusive": false
        },
        {
          "amount": 57,
          "currency": "EUR",
          "code": "STANDARD",
          "name": "STANDARD",
          "rate": 19,
          "sequenceId": 1,
          "inclusive": false
        }
      ],
      "total": {
        "amount": 0,
        "currency": "EUR",
        "inclusive": false
      }
    },
    "subTotalPrice": 300,
    "totalPrice": 333.92,
    "totalAuthorizedAmount": 373.12,
    "currency": "EUR",
    "metadata": {
      "mixins": {
        "payments": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json",
        "deliveryTime": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryTimeMixIn.v2.json",
        "generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/orderGeneralAttributesMixIn.v9.json",
        "payment": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/paymentMixIn.v3.json"
      },
      "version": 1
    },
    "mixins": {
      "payments": {
        "elements": [
          {
            "paymentMethodYrn": "urn:yaas:hybris:payments:payment-method:test;invoice",
            "fees": {
              "elements": [
                {
                  "yrn": "urn:yaas:saasag:fee:fee:test;678f552a949c723de46bdb14",
                  "name": {
                    "de": "Payment fee",
                    "en": "Payment fee"
                  },
                  "taxCode": "REDUCED",
                  "total": {
                    "subTotal": 33.92,
                    "totalTax": 0,
                    "total": 33.92,
                    "discount": 0
                  }
                }
              ],
              "total": {
                "subTotal": 0,
                "totalTax": 0,
                "total": 0,
                "discount": 0
              }
            },
            "total": {
              "subTotal": 33.92,
              "totalTax": 0,
              "total": 33.92,
              "discount": 0
            }
          }
        ],
        "total": {
          "subTotal": 33.92,
          "totalTax": 0,
          "total": 33.92,
          "discount": 0
        }
      },
      "deliveryTime": {
        "deliveryTimeId": "64e36da5814eba1635228dfe",
        "deliveryDate": "2025-02-07T11:00:00.000Z",
        "deliveryTimeFrom": "10:00",
        "deliveryTimeTo": "14:30",
        "deliveryTimeZoneId": "deliveryarea",
        "deliveryTimeMethodId": "pickup",
        "deliveryCosts": 35
      },
      "generalAttributes": {
        "extendedOrderStatus": "05",
        "customerFirstOrder": false,
        "orderNumber": "EON2076"
      },
      "payment": {
        "paymentType": "invoice"
      }
    },
    "deliveryWindow": {
      "id": "64e36da5814eba1635228dfe",
      "slotId": "c291c677-5460-4efb-b893-145c866a2af2",
      "deliveryDate": "2025-02-07",
      "deliveryCycle": "2025-02-07-15pickupFriday1000-1430",
      "deliveryCycleName": "pickupFriday1000-1430",
      "deliveryTimeRange": {
        "timeFrom": "10:00",
        "timeTo": "14:30"
      }
    },
    "feeYrnAggregate": {
      "elements": [
        {
          "yrn": "urn:yaas:saasag:fee:fee:test;678f552a949c723de46bdb14",
          "name": {
            "de": "Payment fee",
            "en": "Payment fee"
          },
          "taxCode": "REDUCED",
          "total": {
            "subTotal": 33.92,
            "totalTax": 0,
            "total": 33.92
          }
        }
      ],
      "total": {
        "subTotal": 33.92,
        "totalTax": 0,
        "total": 33.92
      }
    },
    "calculatedPrice": {
      "price": {
        "netValue": 300,
        "grossValue": 357,
        "taxValue": 57,
        "taxCode": "STANDARD",
        "taxRate": 19
      },
      "paymentFees": [
        {
          "id": "678f552a949c723de46bdb14",
          "type": "PERCENT",
          "name": {
            "de": "Payment fee",
            "en": "Payment fee"
          },
          "price": {
            "netValue": 33.5,
            "grossValue": 37.52,
            "taxValue": 4.02,
            "taxCode": "REDUCED",
            "taxRate": 12
          }
        }
      ],
      "totalFee": {
        "netValue": 33.5,
        "grossValue": 37.52,
        "taxValue": 4.02,
        "taxCode": "REDUCED",
        "taxRate": 12
      },
      "totalShipping": {
        "netValue": 35,
        "grossValue": 39.2,
        "taxValue": 4.2,
        "taxCode": "REDUCED",
        "taxRate": 12
      },
      "finalPrice": {
        "netValue": 368.5,
        "grossValue": 433.72,
        "taxValue": 65.22,
        "taxAggregate": {
          "lines": [
            {
              "netValue": 33.5,
              "grossValue": 37.52,
              "taxValue": 4.02,
              "taxCode": "REDUCED",
              "taxRate": 12
            },
            {
              "netValue": 300,
              "grossValue": 357,
              "taxValue": 57,
              "taxCode": "STANDARD",
              "taxRate": 19
            },
            {
              "netValue": 35,
              "grossValue": 39.2,
              "taxValue": 4.2,
              "taxCode": "REDUCED",
              "taxRate": 12
            }
          ]
        }
      }
    },
    "channel": {},
    "created": "2025-01-30T13:45:34.406Z",
    "lastStatusChange": "2025-01-30T13:45:34.406Z",
    "id": "EON2076",
    "createdBy": "61443563"
  },
  {
    "status": "IN_CHECKOUT",
    "entries": [
      {
        "id": "BC10033--BC10033-43",
        "itemYrn": "urn:yaas:saasag:caasproduct:product:test;BC10033--BC10033-43",
        "amount": 3,
        "orderedAmount": 3,
        "effectiveQuantity": 3,
        "originalAmount": 100,
        "originalPrice": 100,
        "unitPrice": 100,
        "totalPrice": 300,
        "authorizedAmount": 300,
        "product": {
          "metadata": {
            "mixins": {
              "productTemplateAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/test/63ec98500522b25c90b9e632-templateAttributes_v1.json",
              "productVariantAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/test/63ec98500522b25c90b9e632-variantAttributes_v1.json"
            }
          },
          "id": "BC10033--BC10033-43",
          "sku": "8033546091234",
          "name": "Safety shoes high Reptile RS S3 SRC, black",
          "localizedName": {
            "de": "Hohe Sicherheitsschuhe Reptile RS S3 SRC, schwarz",
            "en": "Safety shoes high Reptile RS S3 SRC, black"
          },
          "description": "[de:Sicherheitsstiefel, klassisch und robust, U-Power Style&Job Linie, Obermaterial aus wasserabweisendem, bedrucktem Leder, Stahlkappe, Durchtrittsicherheit, rutschfest, ergonomisches Inox Laminat und PU/PU Sohle, RS S3 SRC., en:Safety shoes high, U-Power, classic and strong of the \"Style & Job\" range, with water repellent printed leather upper, steel toe cap, anti-puncture, anti-slip, ergonomic steel foil and PU / PU sole, RS S3 SRC.]",
          "published": true,
          "images": [
            {
              "id": "6437eb7f8fc03d22f4e856ce",
              "url": "http://res.cloudinary.com/saas-ag/image/upload/v1681386368/test/media/6437eb7f8fc03d22f4e856ce",
              "stored": false
            }
          ],
          "mixins": {
            "productVariantAttributes": {
              "size": 43
            }
          },
          "productType": "VARIANT"
        },
        "tax": {
          "lines": [
            {
              "amount": 57,
              "currency": "EUR",
              "code": "STANDARD",
              "name": "STANDARD",
              "rate": 19,
              "sequenceId": 0,
              "inclusive": false
            }
          ],
          "total": {
            "amount": 0,
            "currency": "EUR",
            "inclusive": false
          }
        },
        "price": {
          "priceId": "6763cd21139f370cd9244d37",
          "currency": "EUR",
          "originalAmount": 100,
          "effectiveAmount": 100,
          "basePrice": {},
          "presentationPrice": {},
          "metadata": {
            "createdAt": "2024-12-19T07:37:05.559Z",
            "modifiedAt": "2024-12-19T07:37:05.559Z",
            "version": 1
          }
        },
        "totalDiscount": {
          "amount": 0,
          "currency": "EUR"
        },
        "fees": {
          "total": {
            "subTotal": 0,
            "totalTax": 0,
            "total": 0
          }
        },
        "metadata": {
          "mixins": {
            "fees": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
          }
        },
        "mixins": {
          "fees": {
            "total": {
              "subTotal": 0,
              "totalTax": 0,
              "total": 0,
              "discount": 0
            }
          }
        },
        "calculatedPrice": {
          "price": {
            "netValue": 300,
            "grossValue": 357,
            "taxValue": 57,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          "finalPrice": {
            "netValue": 300,
            "grossValue": 357,
            "taxValue": 57,
            "taxCode": "STANDARD",
            "taxRate": 19
          }
        },
        "priceMatchDetails": {
          "netValue": 100,
          "grossValue": 119,
          "taxValue": 19,
          "taxCode": "STANDARD",
          "taxRate": 19,
          "taxCountry": "DE"
        }
      }
    ],
    "discounts": [],
    "customer": {
      "id": "61443563",
      "name": "Test name",
      "firstName": "John",
      "lastName": "Smith",
      "company": "Emporix",
      "email": "test@test.com"
    },
    "siteCode": "DE",
    "countryCode": "DE",
    "billingAddress": {
      "contactName": "Templatecompany",
      "companyName": "Templatecompany",
      "street": "Strasse 1",
      "streetNumber": "",
      "zipCode": "12221",
      "city": "Berlin",
      "country": "DE",
      "state": "DE"
    },
    "shippingAddress": {
      "contactName": "Templatecompany",
      "companyName": "Templatecompany",
      "street": "Strasse 1",
      "streetNumber": "",
      "zipCode": "12221",
      "city": "Berlin",
      "country": "DE",
      "state": "DE"
    },
    "payments": [
      {
        "status": "PENDING",
        "method": "invoice",
        "paymentResponse": "Payment is handled externally",
        "paidAmount": 0,
        "currency": "EUR",
        "transactionId": "fcc2bf50-f064-4dc3-833f-0909a7857387",
        "authorizedAmount": 373.12,
        "provider": "payment-gateway"
      }
    ],
    "shipping": {
      "total": {
        "amount": 39.2,
        "currency": "EUR"
      },
      "lines": [
        {
          "amount": 35,
          "currency": "EUR",
          "code": "pickup",
          "name": "pickup",
          "localizedName": {
            "en": "pickup",
            "de": "pickup"
          },
          "tax": {
            "total": {
              "amount": 4.2,
              "currency": "EUR",
              "inclusive": false
            },
            "rate": 12
          },
          "shippingTaxCode": "REDUCED"
        }
      ]
    },
    "tax": {
      "lines": [
        {
          "amount": 4.2,
          "currency": "EUR",
          "code": "REDUCED",
          "name": "REDUCED",
          "rate": 12,
          "sequenceId": 0,
          "inclusive": false
        },
        {
          "amount": 57,
          "currency": "EUR",
          "code": "STANDARD",
          "name": "STANDARD",
          "rate": 19,
          "sequenceId": 1,
          "inclusive": false
        }
      ],
      "total": {
        "amount": 0,
        "currency": "EUR",
        "inclusive": false
      }
    },
    "subTotalPrice": 300,
    "totalPrice": 333.92,
    "totalAuthorizedAmount": 373.12,
    "currency": "EUR",
    "metadata": {
      "mixins": {
        "payments": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json",
        "deliveryTime": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryTimeMixIn.v2.json",
        "generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/orderGeneralAttributesMixIn.v9.json",
        "payment": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/paymentMixIn.v3.json"
      },
      "version": 1
    },
    "mixins": {
      "payments": {
        "elements": [
          {
            "paymentMethodYrn": "urn:yaas:hybris:payments:payment-method:test;invoice",
            "fees": {
              "elements": [
                {
                  "yrn": "urn:yaas:saasag:fee:fee:test;678f552a949c723de46bdb14",
                  "name": {
                    "de": "Payment fee",
                    "en": "Payment fee"
                  },
                  "taxCode": "REDUCED",
                  "total": {
                    "subTotal": 33.92,
                    "totalTax": 0,
                    "total": 33.92,
                    "discount": 0
                  }
                }
              ],
              "total": {
                "subTotal": 0,
                "totalTax": 0,
                "total": 0,
                "discount": 0
              }
            },
            "total": {
              "subTotal": 33.92,
              "totalTax": 0,
              "total": 33.92,
              "discount": 0
            }
          }
        ],
        "total": {
          "subTotal": 33.92,
          "totalTax": 0,
          "total": 33.92,
          "discount": 0
        }
      },
      "deliveryTime": {
        "deliveryTimeId": "64e36da5814eba1635228dfe",
        "deliveryDate": "2025-02-07T11:00:00.000Z",
        "deliveryTimeFrom": "10:00",
        "deliveryTimeTo": "14:30",
        "deliveryTimeZoneId": "deliveryarea",
        "deliveryTimeMethodId": "pickup",
        "deliveryCosts": 35
      },
      "generalAttributes": {
        "extendedOrderStatus": "05",
        "customerFirstOrder": false,
        "orderNumber": "EON2076"
      },
      "payment": {
        "paymentType": "invoice"
      }
    },
    "deliveryWindow": {
      "id": "64e36da5814eba1635228dfe",
      "slotId": "c291c677-5460-4efb-b893-145c866a2af2",
      "deliveryDate": "2025-02-07",
      "deliveryCycle": "2025-02-07-15pickupFriday1000-1430",
      "deliveryCycleName": "pickupFriday1000-1430",
      "deliveryTimeRange": {
        "timeFrom": "10:00",
        "timeTo": "14:30"
      }
    },
    "feeYrnAggregate": {
      "elements": [
        {
          "yrn": "urn:yaas:saasag:fee:fee:test;678f552a949c723de46bdb14",
          "name": {
            "de": "Payment fee",
            "en": "Payment fee"
          },
          "taxCode": "REDUCED",
          "total": {
            "subTotal": 33.92,
            "totalTax": 0,
            "total": 33.92
          }
        }
      ],
      "total": {
        "subTotal": 33.92,
        "totalTax": 0,
        "total": 33.92
      }
    },
    "calculatedPrice": {
      "price": {
        "netValue": 300,
        "grossValue": 357,
        "taxValue": 57,
        "taxCode": "STANDARD",
        "taxRate": 19
      },
      "paymentFees": [
        {
          "id": "678f552a949c723de46bdb14",
          "type": "PERCENT",
          "name": {
            "de": "Payment fee",
            "en": "Payment fee"
          },
          "price": {
            "netValue": 33.5,
            "grossValue": 37.52,
            "taxValue": 4.02,
            "taxCode": "REDUCED",
            "taxRate": 12
          }
        }
      ],
      "totalFee": {
        "netValue": 33.5,
        "grossValue": 37.52,
        "taxValue": 4.02,
        "taxCode": "REDUCED",
        "taxRate": 12
      },
      "totalShipping": {
        "netValue": 35,
        "grossValue": 39.2,
        "taxValue": 4.2,
        "taxCode": "REDUCED",
        "taxRate": 12
      },
      "finalPrice": {
        "netValue": 368.5,
        "grossValue": 433.72,
        "taxValue": 65.22,
        "taxAggregate": {
          "lines": [
            {
              "netValue": 33.5,
              "grossValue": 37.52,
              "taxValue": 4.02,
              "taxCode": "REDUCED",
              "taxRate": 12
            },
            {
              "netValue": 300,
              "grossValue": 357,
              "taxValue": 57,
              "taxCode": "STANDARD",
              "taxRate": 19
            },
            {
              "netValue": 35,
              "grossValue": 39.2,
              "taxValue": 4.2,
              "taxCode": "REDUCED",
              "taxRate": 12
            }
          ]
        }
      }
    },
    "channel": {},
    "created": "2025-01-30T13:45:34.406Z",
    "lastStatusChange": "2025-01-30T13:45:34.406Z",
    "id": "EON2076",
    "createdBy": "61443563"
  }
]

Creating a new order

post

Creates an order. To be used by customers on the storefront.

Required scopes

  • order.order_post

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Pattern: ^[a-z][a-z0-9]+$
Header parameters
saas-tokenstringRequired

Token used to identify logged-in users. This token has an expiry date and is signed with a passphrase.

Body
all ofOptional

The order creation DTO.

and
Responses
201
The collection resource has been successfully created.
application/json
400
Request syntactically incorrect. Any details will be provided within the response payload.
application/json
403
Given authorization scopes are not sufficient and do not match required scopes.
application/json
409
Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.
application/json
500
Some server side error occurred.
application/json
post
POST /order-v2/{tenant}/orders HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
saas-token: text
Content-Type: application/json
Accept: */*
Content-Length: 7018

{
  "entries": [
    {
      "id": "BC10033--BC10033-43",
      "itemYrn": "urn:yaas:saasag:caasproduct:product:test;BC10033--BC10033-43",
      "amount": 3,
      "orderedAmount": 3,
      "effectiveQuantity": 3,
      "originalAmount": 100,
      "originalPrice": 100,
      "unitPrice": 100,
      "calculatedUnitPrice": {
        "netValue": 100,
        "grossValue": 119,
        "taxValue": 19,
        "taxCode": "STANDARD",
        "taxRate": 19
      },
      "totalPrice": 300,
      "authorizedAmount": 300,
      "product": {
        "metadata": {
          "mixins": {
            "productTemplateAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/test/63ec98500522b25c90b9e632-templateAttributes_v1.json",
            "productVariantAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/test/63ec98500522b25c90b9e632-variantAttributes_v1.json"
          }
        },
        "id": "BC10033--BC10033-43",
        "sku": "8033546091234",
        "name": "Safety shoes high Reptile RS S3 SRC, black",
        "localizedName": {
          "de": "Hohe Sicherheitsschuhe Reptile RS S3 SRC, schwarz",
          "en": "Safety shoes high Reptile RS S3 SRC, black"
        },
        "description": "[de:Sicherheitsstiefel, klassisch und robust, U-Power Style&Job Linie, Obermaterial aus wasserabweisendem, bedrucktem Leder, Stahlkappe, Durchtrittsicherheit, rutschfest, ergonomisches Inox Laminat und PU/PU Sohle, RS S3 SRC., en:Safety shoes high, U-Power, classic and strong of the \"Style & Job\" range, with water repellent printed leather upper, steel toe cap, anti-puncture, anti-slip, ergonomic steel foil and PU / PU sole, RS S3 SRC.]",
        "published": true,
        "images": [
          {
            "id": "6437eb7f8fc03d22f4e856ce",
            "url": "http://res.cloudinary.com/saas-ag/image/upload/v1681386368/test/media/6437eb7f8fc03d22f4e856ce",
            "stored": false
          }
        ],
        "mixins": {
          "productVariantAttributes": {
            "size": 43
          }
        },
        "productType": "VARIANT"
      },
      "tax": {
        "lines": [
          {
            "amount": 57,
            "currency": "EUR",
            "code": "STANDARD",
            "name": "STANDARD",
            "rate": 19,
            "sequenceId": 0,
            "inclusive": false
          }
        ],
        "total": {
          "amount": 0,
          "currency": "EUR",
          "inclusive": false
        }
      },
      "price": {
        "priceId": "6763cd21139f370cd9244d37",
        "currency": "EUR",
        "originalAmount": 100,
        "effectiveAmount": 100,
        "basePrice": {},
        "presentationPrice": {},
        "metadata": {
          "createdAt": "2024-12-19T07:37:05.559Z",
          "modifiedAt": "2024-12-19T07:37:05.559Z",
          "version": 1
        }
      },
      "totalDiscount": {
        "amount": 0,
        "currency": "EUR"
      },
      "fees": {
        "total": {
          "subTotal": 0,
          "totalTax": 0,
          "total": 0
        }
      },
      "metadata": {
        "mixins": {
          "fees": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
        }
      },
      "mixins": {
        "fees": {
          "total": {
            "subTotal": 0,
            "totalTax": 0,
            "total": 0,
            "discount": 0
          }
        }
      },
      "calculatedPrice": {
        "price": {
          "netValue": 300,
          "grossValue": 357,
          "taxValue": 57,
          "taxCode": "STANDARD",
          "taxRate": 19
        },
        "finalPrice": {
          "netValue": 300,
          "grossValue": 357,
          "taxValue": 57,
          "taxCode": "STANDARD",
          "taxRate": 19
        }
      },
      "priceMatchDetails": {
        "netValue": 100,
        "grossValue": 119,
        "taxValue": 19,
        "taxCode": "STANDARD",
        "taxRate": 19,
        "taxCountry": "DE"
      }
    }
  ],
  "discounts": [],
  "customer": {
    "id": "61443563",
    "name": "Test name",
    "firstName": "John",
    "lastName": "Smith",
    "company": "Emporix",
    "email": "test@test.com"
  },
  "siteCode": "DE",
  "countryCode": "DE",
  "billingAddress": {
    "contactName": "Templatecompany",
    "companyName": "Templatecompany",
    "street": "Strasse 1",
    "streetNumber": "",
    "zipCode": "12221",
    "city": "Berlin",
    "country": "DE",
    "state": "DE"
  },
  "shippingAddress": {
    "contactName": "Templatecompany",
    "companyName": "Templatecompany",
    "street": "Strasse 1",
    "streetNumber": "",
    "zipCode": "12221",
    "city": "Berlin",
    "country": "DE",
    "state": "DE"
  },
  "payments": [
    {
      "status": "PENDING",
      "method": "invoice",
      "paymentResponse": "Payment is handled externally",
      "paidAmount": 0,
      "currency": "EUR",
      "transactionId": "fcc2bf50-f064-4dc3-833f-0909a7857387",
      "authorizedAmount": 373.12,
      "provider": "payment-gateway"
    }
  ],
  "shipping": {
    "total": {
      "amount": 39.2,
      "currency": "EUR"
    },
    "lines": [
      {
        "amount": 35,
        "currency": "EUR",
        "code": "pickup",
        "name": "pickup",
        "localizedName": {
          "en": "pickup",
          "de": "pickup"
        },
        "tax": {
          "total": {
            "amount": 4.2,
            "currency": "EUR",
            "inclusive": false
          },
          "rate": 12
        },
        "shippingTaxCode": "REDUCED"
      }
    ]
  },
  "tax": {
    "lines": [
      {
        "amount": 4.2,
        "currency": "EUR",
        "code": "REDUCED",
        "name": "REDUCED",
        "rate": 12,
        "sequenceId": 0,
        "inclusive": false
      },
      {
        "amount": 57,
        "currency": "EUR",
        "code": "STANDARD",
        "name": "STANDARD",
        "rate": 19,
        "sequenceId": 1,
        "inclusive": false
      }
    ],
    "total": {
      "amount": 0,
      "currency": "EUR",
      "inclusive": false
    }
  },
  "subTotalPrice": 300,
  "totalPrice": 333.92,
  "totalAuthorizedAmount": 373.12,
  "currency": "EUR",
  "metadata": {
    "mixins": {
      "payments": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json",
      "deliveryTime": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryTimeMixIn.v2.json",
      "generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/orderGeneralAttributesMixIn.v9.json",
      "payment": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/paymentMixIn.v3.json"
    },
    "version": 1
  },
  "mixins": {
    "payments": {
      "elements": [
        {
          "paymentMethodYrn": "urn:yaas:hybris:payments:payment-method:test;invoice",
          "fees": {
            "elements": [
              {
                "yrn": "urn:yaas:saasag:fee:fee:test;678f552a949c723de46bdb14",
                "name": {
                  "de": "Payment fee",
                  "en": "Payment fee"
                },
                "taxCode": "REDUCED",
                "total": {
                  "subTotal": 33.92,
                  "totalTax": 0,
                  "total": 33.92,
                  "discount": 0
                }
              }
            ],
            "total": {
              "subTotal": 0,
              "totalTax": 0,
              "total": 0,
              "discount": 0
            }
          },
          "total": {
            "subTotal": 33.92,
            "totalTax": 0,
            "total": 33.92,
            "discount": 0
          }
        }
      ],
      "total": {
        "subTotal": 33.92,
        "totalTax": 0,
        "total": 33.92,
        "discount": 0
      }
    },
    "deliveryTime": {
      "deliveryTimeId": "64e36da5814eba1635228dfe",
      "deliveryDate": "2025-02-07T11:00:00.000Z",
      "deliveryTimeFrom": "10:00",
      "deliveryTimeTo": "14:30",
      "deliveryTimeZoneId": "deliveryarea",
      "deliveryTimeMethodId": "pickup",
      "deliveryCosts": 35
    },
    "generalAttributes": {
      "extendedOrderStatus": "05",
      "customerFirstOrder": false,
      "orderNumber": "EON2076"
    },
    "payment": {
      "paymentType": "invoice"
    }
  },
  "deliveryWindow": {
    "id": "64e36da5814eba1635228dfe",
    "slotId": "c291c677-5460-4efb-b893-145c866a2af2",
    "deliveryDate": "2025-02-07",
    "deliveryCycle": "2025-02-07-15pickupFriday1000-1430",
    "deliveryCycleName": "pickupFriday1000-1430",
    "deliveryTimeRange": {
      "timeFrom": "10:00",
      "timeTo": "14:30"
    }
  },
  "feeYrnAggregate": {
    "elements": [
      {
        "yrn": "urn:yaas:saasag:fee:fee:test;678f552a949c723de46bdb14",
        "name": {
          "de": "Payment fee",
          "en": "Payment fee"
        },
        "taxCode": "REDUCED",
        "total": {
          "subTotal": 33.92,
          "totalTax": 0,
          "total": 33.92
        }
      }
    ],
    "total": {
      "subTotal": 33.92,
      "totalTax": 0,
      "total": 33.92
    }
  },
  "calculatedPrice": {
    "price": {
      "netValue": 300,
      "grossValue": 357,
      "taxValue": 57,
      "taxCode": "STANDARD",
      "taxRate": 19
    },
    "paymentFees": [
      {
        "id": "678f552a949c723de46bdb14",
        "type": "PERCENT",
        "name": {
          "de": "Payment fee",
          "en": "Payment fee"
        },
        "price": {
          "netValue": 33.5,
          "grossValue": 37.52,
          "taxValue": 4.02,
          "taxCode": "REDUCED",
          "taxRate": 12
        }
      }
    ],
    "totalFee": {
      "netValue": 33.5,
      "grossValue": 37.52,
      "taxValue": 4.02,
      "taxCode": "REDUCED",
      "taxRate": 12
    },
    "totalShipping": {
      "netValue": 35,
      "grossValue": 39.2,
      "taxValue": 4.2,
      "taxCode": "REDUCED",
      "taxRate": 12
    },
    "finalPrice": {
      "netValue": 368.5,
      "grossValue": 433.72,
      "taxValue": 65.22,
      "taxAggregate": {
        "lines": [
          {
            "netValue": 33.5,
            "grossValue": 37.52,
            "taxValue": 4.02,
            "taxCode": "REDUCED",
            "taxRate": 12
          },
          {
            "netValue": 300,
            "grossValue": 357,
            "taxValue": 57,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          {
            "netValue": 35,
            "grossValue": 39.2,
            "taxValue": 4.2,
            "taxCode": "REDUCED",
            "taxRate": 12
          }
        ]
      }
    }
  },
  "channel": {},
  "created": "2025-01-30T13:45:34.406Z",
  "lastStatusChange": "2025-01-30T13:45:34.406Z",
  "id": "EON2076",
  "createdBy": "61443563"
}
{
  "id": "1234546"
}

Updating order status

post

Updates the status of a specific order. To be used by customers on the storefront.Note: Customers can only change the order status from CREATED to DECLINED.

Required scopes

  • order.order_updateascustomer

Authorizations
Path parameters
orderIdstringRequired

Unique identifier of an order.

tenantstring · min: 3 · max: 16Required

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Pattern: ^[a-z][a-z0-9]+$
Header parameters
saas-tokenstringRequired

Token used to identify logged-in users. This token has an expiry date and is signed with a passphrase.

Body

Order status transition.

statusstring · enumOptional

Status of the order. Supported order statuses are IN_CHECKOUT, CREATED, CONFIRMED, DECLINED, SHIPPED, COMPLETED'. Customers can only change the order status from CREATED to DECLINED.

Possible values:
Responses
204
The transition was successful.
400
Request syntactically incorrect. Any details will be provided within the response payload.
application/json
403
Access forbidden. The caller is not allowed to access this resource.
application/json
404
Order does not exist
application/json
500
Some server side error occurred.
application/json
post
POST /order-v2/{tenant}/orders/{orderId}/transitions HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
saas-token: text
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "status": "DECLINED"
}

No content