Orders (Tenant Managed)

Manage tenant orders.

Retrieving orders

get

Retrieves tenant orders for administrative purposes. To be used by tenant employees.

Required scopes

This endpoint requires the following scopes:

• : Needed to read order.
• : The scope allows vendor to read order with assigned vendor.
• : The scope allows vendor to manage order with assigned vendor.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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.

Responses

200

The request was successful. List of orders with details are returned.

application/json

400

Request was syntactically incorrect. Details of the error are included in the response payload.

application/json

403

Access forbidden. The caller is not allowed to access this resource.

application/json

500

Some server side error occurred.

application/json

get

/order-v2/{tenant}/salesorders

HTTPcURLJavaScriptPython

GET /order-v2/{tenant}/salesorders HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
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": "[email protected]"
    },
    "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,
        "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": "[email protected]"
    },
    "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 by the tenant employee, on behalf of a customer.

Note: The entries.originalAmount is DEPRECATED. Use the entries.originalPrice field instead.

Required scopes

This endpoint requires the following scopes:

• : Needed to create new order by merchant.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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]+$

Body

application/json

all ofOptional

Responses

201

The collection resource has been successfully created.

application/json

400

Request syntactically incorrect. Details of the error are included in 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. Details of the error are included in the response payload.

application/json

500

Some server side error occurred.

application/json

post

/order-v2/{tenant}/salesorders

HTTPcURLJavaScriptPython

POST /order-v2/{tenant}/salesorders HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 5458

{
  "status": "IN_CHECKOUT",
  "entries": [
    {
      "id": "BC10033--BC10033-43",
      "itemYrn": "urn:yaas:saasag:caasproduct:product:test;BC10033--BC10033-43",
      "amount": 3,
      "orderedAmount": 3,
      "effectiveQuantity": 3,
      "calculatedUnitPrice": {
        "netValue": 100,
        "grossValue": 119,
        "taxValue": 19,
        "taxCode": "STANDARD",
        "taxRate": 19
      },
      "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"
      },
      "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
        }
      },
      "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": "[email protected]"
  },
  "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"
    }
  ],
  "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"
    }
  },
  "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": {}
  }
}

{
  "id": "1234546"
}

Retrieving the number of orders

head

Retrieves the number of orders for the specified query and siteCode. To be used by tenant employees.

Required scopes

This endpoint requires the following scopes:

• : Needed to read order.
• : The scope allows vendor to read order with assigned vendor.
• : The scope allows vendor to manage order with assigned vendor.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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

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

Responses

200

The request was successful. Number of orders returned in header.

400

Request syntactically incorrect. Details of the error are included in the response payload.

application/json

403

Access forbidden. The caller is not allowed to access this resource.

application/json

500

Some server side error occurred.

application/json

head

/order-v2/{tenant}/salesorders

HTTPcURLJavaScriptPython

HEAD /order-v2/{tenant}/salesorders HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Searching for orders

post

Searches for tenant orders for administrative purposes. To be used by tenant employees.

Required scopes

This endpoint requires the following scopes:

• : Needed to read order.
• : The scope allows vendor to read order with assigned vendor.
• : The scope allows vendor to manage order with assigned vendor.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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

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.

Body

application/json

qstringOptional

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

See: Standard practises - Query parameter

Responses

200

The request was successful. List of orders with details are returned.

application/json

400

Request was syntactically incorrect. Details of the error are included in the response payload.

application/json

403

Access forbidden. The caller is not allowed to access this resource.

application/json

500

Some server side error occurred.

application/json

post

/order-v2/{tenant}/salesorders/search

HTTPcURLJavaScriptPython

POST /order-v2/{tenant}/salesorders/search HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "q": "id:EON1007"
}

[
  {
    "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": "[email protected]"
    },
    "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,
        "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": "[email protected]"
    },
    "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 a specific order by ID

get

Retrieves a specific order by order ID. To be used by tenant employees.

Required scopes

This endpoint requires the following scopes:

• : Needed to read order.
• : The scope allows vendor to read order with assigned vendor.
• : The scope allows vendor to manage order with assigned vendor.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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]+$

Responses

200

The request was successful. Given order details are returned.

application/json

Responseall of

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

/order-v2/{tenant}/salesorders/{orderId}

HTTPcURLJavaScriptPython

GET /order-v2/{tenant}/salesorders/{orderId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "EON1200",
  "createdBy": "45620894",
  "status": "CREATED",
  "lastStatusChange": "2025-06-10T12:31:39.614Z",
  "created": "2025-06-10T12:31:39.614Z",
  "channel": {
    "name": "storefront",
    "source": "https://your-storefront.com/"
  },
  "cartId": "68481e9e8bf22744fc578572",
  "entries": [
    {
      "id": "0_SLI_mobile-phone-s24-gross",
      "itemYrn": "urn:yaas:saasag:caasproduct:product:b2b2cstage;mobile-phone-s24-gross",
      "keepAsSeparateLineItem": true,
      "type": "INTERNAL",
      "amount": 2,
      "orderedAmount": 2,
      "effectiveQuantity": 2,
      "originalAmount": 350,
      "originalPrice": 350,
      "unitPrice": 350,
      "calculatedUnitPrice": {
        "netValue": 294.118,
        "grossValue": 350,
        "taxValue": 55.882,
        "taxCode": "STANDARD",
        "taxRate": 19
      },
      "totalPrice": 700,
      "authorizedAmount": 700,
      "product": {
        "id": "mobile-phone-s24-gross",
        "sku": "Mobile Phone s24 gross",
        "name": "Mobile Phone s24 gross",
        "localizedName": {
          "en": "Mobile Phone s24 gross"
        },
        "published": true,
        "images": [
          {
            "id": "67169928ceaab717e17f3734",
            "url": "http://res.cloudinary.com/saas-ag/image/upload/v1729534248/b2b2cstage/media/67169928ceaab717e17f3734",
            "stored": false
          }
        ],
        "productType": "BASIC"
      },
      "tax": {
        "lines": [
          {
            "amount": 111.76,
            "currency": "EUR",
            "code": "STANDARD",
            "name": "STANDARD",
            "rate": 19,
            "sequenceId": 0,
            "inclusive": true
          }
        ],
        "total": {
          "amount": 0,
          "currency": "EUR",
          "inclusive": true
        }
      },
      "price": {
        "priceId": "679ca63dbcdefe5b380c98bc",
        "priceListId": "abc123",
        "currency": "EUR",
        "originalAmount": 350,
        "effectiveAmount": 350,
        "basePrice": {},
        "presentationPrice": {},
        "metadata": {
          "createdAt": "2025-01-31T10:30:21.998Z",
          "modifiedAt": "2025-01-31T10:30:21.998Z",
          "version": 1
        }
      },
      "totalDiscount": {
        "amount": 84.06,
        "currency": "EUR"
      },
      "fees": {
        "elements": [
          {
            "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;677d49ca3a421b451eab23f2",
            "name": {
              "de": "Apple Picking Fee",
              "en": "Apple Picking Fee"
            },
            "taxCode": "REDUCED",
            "total": {
              "subTotal": 3.5,
              "totalTax": 0,
              "total": 3.08
            }
          }
        ],
        "total": {
          "subTotal": 3.5,
          "totalTax": 0,
          "total": 3.08
        }
      },
      "metadata": {
        "mixins": {
          "fees": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
        }
      },
      "mixins": {
        "fees": {
          "elements": [
            {
              "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;677d49ca3a421b451eab23f2",
              "name": {
                "de": "Apple Picking Fee",
                "en": "Apple Picking Fee"
              },
              "taxCode": "REDUCED",
              "total": {
                "subTotal": 3.5,
                "totalTax": 0,
                "total": 3.08,
                "discount": 0.42
              }
            }
          ],
          "total": {
            "subTotal": 3.5,
            "totalTax": 0,
            "total": 3.08,
            "discount": 0.42
          }
        }
      },
      "calculatedPrice": {
        "price": {
          "netValue": 588.235,
          "grossValue": 700,
          "taxValue": 111.765,
          "taxCode": "STANDARD",
          "taxRate": 19
        },
        "discountedPrice": {
          "netValue": 282.862,
          "grossValue": 336.606,
          "taxValue": 53.744,
          "taxCode": "STANDARD",
          "taxRate": 19,
          "appliedDiscounts": [
            {
              "value": 83.394,
              "price": {
                "netValue": 70.079,
                "grossValue": 83.394,
                "taxValue": 13.315,
                "taxCode": "STANDARD",
                "taxRate": 19
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            },
            {
              "id": "buy-2-get-1-free",
              "value": 280,
              "price": {
                "netValue": 235.294,
                "grossValue": 280,
                "taxValue": 44.706,
                "taxCode": "STANDARD",
                "taxRate": 19
              },
              "discountType": "PERCENT",
              "origin": "EXTERNAL"
            }
          ]
        },
        "fees": [
          {
            "id": "677d49ca3a421b451eab23f2",
            "type": "ABSOLUTE",
            "origin": "INTERNAL",
            "name": {
              "de": "Apple Picking Fee",
              "en": "Apple Picking Fee"
            },
            "price": {
              "netValue": 3.5,
              "grossValue": 3.745,
              "taxValue": 0.245,
              "taxCode": "REDUCED",
              "taxRate": 7
            },
            "discountedPrice": {
              "netValue": 3.083,
              "grossValue": 3.299,
              "taxValue": 0.216,
              "taxCode": "REDUCED",
              "taxRate": 7,
              "appliedDiscounts": [
                {
                  "value": 0.446,
                  "price": {
                    "netValue": 0.417,
                    "grossValue": 0.446,
                    "taxValue": 0.029,
                    "taxCode": "REDUCED",
                    "taxRate": 7
                  },
                  "discountType": "ABSOLUTE",
                  "origin": "INTERNAL"
                }
              ]
            }
          }
        ],
        "totalFee": {
          "netValue": 3.083,
          "grossValue": 3.299,
          "taxValue": 0.216,
          "taxCode": "REDUCED",
          "taxRate": 7,
          "appliedDiscounts": [
            {
              "value": 0.446,
              "price": {
                "netValue": 0.417,
                "grossValue": 0.446,
                "taxValue": 0.029,
                "taxCode": "REDUCED",
                "taxRate": 7
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            }
          ]
        },
        "totalDiscount": {
          "calculationType": "ApplyDiscountAfterTax",
          "value": 363.84,
          "price": {
            "netValue": 305.79,
            "grossValue": 363.84,
            "taxValue": 58.05
          },
          "appliedDiscounts": [
            {
              "value": 83.84,
              "price": {
                "netValue": 70.496,
                "grossValue": 83.84,
                "taxValue": 13.344
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            },
            {
              "id": "buy-2-get-1-free",
              "value": 280,
              "price": {
                "netValue": 235.294,
                "grossValue": 280,
                "taxValue": 44.706,
                "taxCode": "STANDARD",
                "taxRate": 19
              },
              "discountType": "PERCENT",
              "origin": "EXTERNAL"
            }
          ]
        },
        "finalPrice": {
          "netValue": 285.945,
          "grossValue": 339.905,
          "taxValue": 53.96
        }
      },
      "priceMatchDetails": {
        "netValue": 294.11764705882354,
        "grossValue": 350,
        "taxValue": 55.88235294117647,
        "taxCode": "STANDARD",
        "taxRate": 19,
        "taxCountry": "DE"
      },
      "externalDiscounts": [
        {
          "id": "buy-2-get-1-free",
          "discountType": "PERCENT",
          "value": 40,
          "sequence": 1
        }
      ]
    },
    {
      "id": "shirt--301722c1-23e8-42b4-a4d8-1a5480fe3ea5",
      "itemYrn": "urn:yaas:saasag:caasproduct:product:b2b2cstage;shirt--301722c1-23e8-42b4-a4d8-1a5480fe3ea5",
      "keepAsSeparateLineItem": false,
      "type": "INTERNAL",
      "amount": 1,
      "orderedAmount": 1,
      "effectiveQuantity": 1,
      "originalAmount": 10,
      "originalPrice": 10,
      "unitPrice": 10,
      "calculatedUnitPrice": {
        "netValue": 9.346,
        "grossValue": 10,
        "taxValue": 0.654,
        "taxCode": "REDUCED",
        "taxRate": 7
      },
      "totalPrice": 10,
      "authorizedAmount": 10,
      "product": {
        "metadata": {
          "mixins": {
            "productTemplateAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/b2b2cstage/6818bfed8844a34a391a566e-templateAttributes_v1.json",
            "productVariantAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/b2b2cstage/6818bfed8844a34a391a566e-variantAttributes_v1.json"
          }
        },
        "id": "shirt--301722c1-23e8-42b4-a4d8-1a5480fe3ea5",
        "sku": "shirt--red",
        "name": "shirt",
        "localizedName": {
          "en": "shirt"
        },
        "description": "[de:, en:, pl:]",
        "published": true,
        "images": [],
        "mixins": {
          "productVariantAttributes": {
            "color": "red"
          }
        },
        "productType": "VARIANT"
      },
      "tax": {
        "lines": [
          {
            "amount": 0.65,
            "currency": "EUR",
            "code": "REDUCED",
            "name": "REDUCED",
            "rate": 7,
            "sequenceId": 0,
            "inclusive": true
          }
        ],
        "total": {
          "amount": 0,
          "currency": "EUR",
          "inclusive": true
        }
      },
      "price": {
        "priceId": "6818c032524d1c16623037e2",
        "currency": "EUR",
        "originalAmount": 10,
        "effectiveAmount": 10,
        "basePrice": {},
        "presentationPrice": {},
        "metadata": {
          "createdAt": "2025-05-05T13:42:10.674Z",
          "modifiedAt": "2025-05-05T13:44:20.599Z",
          "version": 2
        }
      },
      "totalDiscount": {
        "amount": 1.19,
        "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": 9.346,
          "grossValue": 10,
          "taxValue": 0.654,
          "taxCode": "REDUCED",
          "taxRate": 7
        },
        "discountedPrice": {
          "netValue": 8.233,
          "grossValue": 8.809,
          "taxValue": 0.576,
          "taxCode": "REDUCED",
          "taxRate": 7,
          "appliedDiscounts": [
            {
              "value": 1.191,
              "price": {
                "netValue": 1.113,
                "grossValue": 1.191,
                "taxValue": 0.078,
                "taxCode": "REDUCED",
                "taxRate": 7
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            }
          ]
        },
        "totalDiscount": {
          "calculationType": "ApplyDiscountAfterTax",
          "value": 1.191,
          "price": {
            "netValue": 1.113,
            "grossValue": 1.191,
            "taxValue": 0.078,
            "taxCode": "REDUCED",
            "taxRate": 7
          },
          "appliedDiscounts": [
            {
              "value": 1.191,
              "price": {
                "netValue": 1.113,
                "grossValue": 1.191,
                "taxValue": 0.078,
                "taxCode": "REDUCED",
                "taxRate": 7
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            }
          ]
        },
        "finalPrice": {
          "netValue": 8.233,
          "grossValue": 8.809,
          "taxValue": 0.576,
          "taxCode": "REDUCED",
          "taxRate": 7
        }
      },
      "priceMatchDetails": {
        "netValue": 9.345794392523365,
        "grossValue": 10,
        "taxValue": 0.6542056074766355,
        "taxCode": "REDUCED",
        "taxRate": 7,
        "taxCountry": "DE"
      }
    },
    {
      "id": "2_SLI_mobile-phone-s27-gross",
      "itemYrn": "urn:yaas:saasag:caasproduct:product:b2b2cstage;mobile-phone-s27-gross",
      "keepAsSeparateLineItem": true,
      "type": "INTERNAL",
      "amount": 2,
      "orderedAmount": 2,
      "effectiveQuantity": 2,
      "originalAmount": 55,
      "originalPrice": 55,
      "unitPrice": 55,
      "calculatedUnitPrice": {
        "netValue": 51.402,
        "grossValue": 55,
        "taxValue": 3.598,
        "taxCode": "REDUCED",
        "taxRate": 7
      },
      "totalPrice": 110,
      "authorizedAmount": 143,
      "product": {
        "id": "mobile-phone-s27-gross",
        "sku": "mobile-phone-s27-gross",
        "name": "mobile-phone-s27-gross",
        "localizedName": {
          "en": "mobile-phone-s27-gross"
        },
        "description": "[en:mobile-phone-s27-gross]",
        "published": true,
        "images": [],
        "productType": "BASIC"
      },
      "tax": {
        "lines": [
          {
            "amount": 7.2,
            "currency": "EUR",
            "code": "REDUCED",
            "name": "REDUCED",
            "rate": 7,
            "sequenceId": 0,
            "inclusive": true
          }
        ],
        "total": {
          "amount": 0,
          "currency": "EUR",
          "inclusive": true
        }
      },
      "price": {
        "priceId": "6797da2f3537716a5a537ecf",
        "currency": "EUR",
        "originalAmount": 55,
        "effectiveAmount": 55,
        "basePrice": {},
        "presentationPrice": {},
        "metadata": {
          "createdAt": "2025-01-27T19:10:39.966Z",
          "modifiedAt": "2025-04-14T07:54:30.431Z",
          "version": 23
        }
      },
      "totalDiscount": {
        "amount": 13.56,
        "currency": "EUR"
      },
      "fees": {
        "elements": [
          {
            "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;677d49ca3a421b451eab23f2",
            "name": "Apple Picking Fee",
            "taxCode": "REDUCED",
            "total": {
              "subTotal": 3.5,
              "totalTax": 0,
              "total": 3.08
            }
          }
        ],
        "total": {
          "subTotal": 3.5,
          "totalTax": 0,
          "total": 3.08
        }
      },
      "metadata": {
        "mixins": {
          "fees": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
        }
      },
      "mixins": {
        "fees": {
          "elements": [
            {
              "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;677d49ca3a421b451eab23f2",
              "name": "Apple Picking Fee",
              "taxCode": "REDUCED",
              "total": {
                "subTotal": 3.5,
                "totalTax": 0,
                "total": 3.08,
                "discount": 0.42
              }
            }
          ],
          "total": {
            "subTotal": 3.5,
            "totalTax": 0,
            "total": 3.08,
            "discount": 0.42
          }
        }
      },
      "calculatedPrice": {
        "price": {
          "netValue": 102.804,
          "grossValue": 110,
          "taxValue": 7.196,
          "taxCode": "REDUCED",
          "taxRate": 7
        },
        "upliftValue": {
          "netValue": 30.841,
          "grossValue": 33,
          "taxValue": 2.159,
          "taxCode": "REDUCED",
          "taxRate": 7
        },
        "discountedPrice": {
          "netValue": 90.556,
          "grossValue": 96.895,
          "taxValue": 6.339,
          "taxCode": "REDUCED",
          "taxRate": 7,
          "appliedDiscounts": [
            {
              "value": 13.105,
              "price": {
                "netValue": 12.248,
                "grossValue": 13.105,
                "taxValue": 0.857,
                "taxCode": "REDUCED",
                "taxRate": 7
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            }
          ]
        },
        "fees": [
          {
            "id": "677d49ca3a421b451eab23f2",
            "type": "ABSOLUTE",
            "origin": "INTERNAL",
            "name": "Apple Picking Fee",
            "price": {
              "netValue": 3.5,
              "grossValue": 3.745,
              "taxValue": 0.245,
              "taxCode": "REDUCED",
              "taxRate": 7
            },
            "discountedPrice": {
              "netValue": 3.083,
              "grossValue": 3.299,
              "taxValue": 0.216,
              "taxCode": "REDUCED",
              "taxRate": 7,
              "appliedDiscounts": [
                {
                  "value": 0.446,
                  "price": {
                    "netValue": 0.417,
                    "grossValue": 0.446,
                    "taxValue": 0.029,
                    "taxCode": "REDUCED",
                    "taxRate": 7
                  },
                  "discountType": "ABSOLUTE",
                  "origin": "INTERNAL"
                }
              ]
            }
          }
        ],
        "totalFee": {
          "netValue": 3.083,
          "grossValue": 3.299,
          "taxValue": 0.216,
          "taxCode": "REDUCED",
          "taxRate": 7,
          "appliedDiscounts": [
            {
              "value": 0.446,
              "price": {
                "netValue": 0.417,
                "grossValue": 0.446,
                "taxValue": 0.029,
                "taxCode": "REDUCED",
                "taxRate": 7
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            }
          ]
        },
        "totalDiscount": {
          "calculationType": "ApplyDiscountAfterTax",
          "value": 13.551,
          "price": {
            "netValue": 12.665,
            "grossValue": 13.551,
            "taxValue": 0.886,
            "taxCode": "REDUCED",
            "taxRate": 7
          },
          "appliedDiscounts": [
            {
              "value": 13.551,
              "price": {
                "netValue": 12.665,
                "grossValue": 13.551,
                "taxValue": 0.886,
                "taxCode": "REDUCED",
                "taxRate": 7
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            }
          ]
        },
        "finalPrice": {
          "netValue": 93.639,
          "grossValue": 100.194,
          "taxValue": 6.555,
          "taxCode": "REDUCED",
          "taxRate": 7
        }
      },
      "priceMatchDetails": {
        "netValue": 51.401869158878505,
        "grossValue": 55,
        "taxValue": 3.5981308411214954,
        "taxCode": "REDUCED",
        "taxRate": 7,
        "taxCountry": "DE"
      }
    }
  ],
  "discounts": [
    {
      "code": "TOTAL",
      "amount": 100,
      "currency": "EUR",
      "sequenceId": 1,
      "categoryRestricted": false
    },
    {
      "code": "LS100EUROTOTAL",
      "amount": 100,
      "currency": "EUR",
      "name": "LS100EUROTOTAL",
      "calculationType": "ApplyDiscountBeforeTax",
      "discountType": "ABSOLUTE",
      "discountCalculationType": "TOTAL",
      "categoryRestricted": false
    }
  ],
  "customer": {
    "id": "45620894",
    "name": "John Dutton",
    "firstName": "John",
    "lastName": "Dutton",
    "email": "[email protected]"
  },
  "siteCode": "GrossSite",
  "countryCode": "DE",
  "billingAddress": {
    "contactName": "Dom",
    "street": "Kochanowskiego",
    "streetNumber": "21",
    "streetAppendix": "",
    "zipCode": "44-122",
    "city": "Gliwice",
    "country": "DE",
    "state": "Slaskie",
    "contactPhone": ""
  },
  "shippingAddress": {
    "contactName": "Dom",
    "street": "Kochanowskiego",
    "streetNumber": "21",
    "streetAppendix": "",
    "zipCode": "44-122",
    "city": "Gliwice",
    "country": "DE",
    "state": "Slaskie",
    "contactPhone": ""
  },
  "payments": [
    {
      "status": "PENDING",
      "method": "invoice",
      "paidAmount": 0,
      "currency": "EUR",
      "provider": "stripe"
    }
  ],
  "shipping": {
    "total": {
      "amount": 10.71,
      "currency": "EUR"
    },
    "lines": [
      {
        "amount": 10,
        "currency": "EUR",
        "code": "Pickup",
        "name": "Pickup",
        "localizedName": {
          "en": "Pickup"
        },
        "tax": {
          "total": {
            "amount": 1.9,
            "currency": "EUR",
            "inclusive": false
          },
          "rate": 19
        },
        "shippingTaxCode": "STANDARD"
      }
    ]
  },
  "tax": {
    "lines": [
      {
        "amount": 7.85,
        "currency": "EUR",
        "code": "REDUCED",
        "name": "REDUCED",
        "rate": 7,
        "sequenceId": 0,
        "inclusive": false
      },
      {
        "amount": 113.66,
        "currency": "EUR",
        "code": "STANDARD",
        "name": "STANDARD",
        "rate": 19,
        "sequenceId": 1,
        "inclusive": false
      }
    ],
    "total": {
      "amount": 1.9,
      "currency": "EUR",
      "inclusive": false
    }
  },
  "subTotalPrice": 820,
  "totalPrice": 812.79,
  "totalAuthorizedAmount": 534.829,
  "currency": "EUR",
  "metadata": {
    "mixins": {
      "payments": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json",
      "generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/orderGeneralAttributesMixIn.v9.json"
    },
    "version": 1
  },
  "mixins": {
    "payments": {
      "elements": [
        {
          "paymentMethodYrn": "urn:yaas:hybris:payments:payment-method:b2b2cstage;invoice",
          "fees": {
            "elements": [
              {
                "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;678f552a949c723de46bdb14",
                "name": {
                  "de": "Payment fee",
                  "en": "Payment fee"
                },
                "taxCode": "REDUCED",
                "total": {
                  "subTotal": 73.89,
                  "totalTax": 0,
                  "total": 73.89,
                  "discount": 0
                }
              }
            ],
            "total": {
              "subTotal": 0,
              "totalTax": 0,
              "total": 0,
              "discount": 0
            }
          },
          "total": {
            "subTotal": 73.89,
            "totalTax": 0,
            "total": 73.89,
            "discount": 0
          }
        }
      ],
      "total": {
        "subTotal": 73.89,
        "totalTax": 0,
        "total": 73.89,
        "discount": 0
      }
    },
    "generalAttributes": {
      "extendedOrderStatus": "10",
      "customerFirstOrder": false,
      "orderNumber": "EON1200"
    }
  },
  "feeYrnAggregate": {
    "elements": [
      {
        "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;677d49ca3a421b451eab23f2",
        "name": {
          "de": "Apple Picking Fee",
          "en": "Apple Picking Fee"
        },
        "taxCode": "REDUCED",
        "total": {
          "subTotal": 7,
          "totalTax": 0,
          "total": 6.16
        }
      },
      {
        "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;678f552a949c723de46bdb14",
        "name": {
          "de": "Payment fee",
          "en": "Payment fee"
        },
        "taxCode": "REDUCED",
        "total": {
          "subTotal": 73.89,
          "totalTax": 0,
          "total": 73.89
        }
      }
    ],
    "total": {
      "subTotal": 80.89,
      "totalTax": 0,
      "total": 80.05
    }
  },
  "calculatedPrice": {
    "price": {
      "netValue": 700.385,
      "grossValue": 820,
      "taxValue": 119.615
    },
    "upliftValue": {
      "netValue": 30.841,
      "grossValue": 33,
      "taxValue": 2.159,
      "taxCode": "REDUCED",
      "taxRate": 7
    },
    "discountedPrice": {
      "netValue": 381.651,
      "grossValue": 442.31,
      "taxValue": 60.659,
      "appliedDiscounts": [
        {
          "value": 97.69,
          "price": {
            "netValue": 83.44,
            "grossValue": 97.69,
            "taxValue": 14.25
          },
          "discountType": "ABSOLUTE",
          "origin": "INTERNAL"
        },
        {
          "id": "buy-2-get-1-free",
          "value": 280,
          "price": {
            "netValue": 235.294,
            "grossValue": 280,
            "taxValue": 44.706,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          "discountType": "PERCENT",
          "origin": "EXTERNAL"
        }
      ]
    },
    "paymentFees": [
      {
        "id": "678f552a949c723de46bdb14",
        "type": "PERCENT",
        "origin": "INTERNAL",
        "name": {
          "de": "Payment fee",
          "en": "Payment fee"
        },
        "price": {
          "netValue": 39.663,
          "grossValue": 42.439,
          "taxValue": 2.776,
          "taxCode": "REDUCED",
          "taxRate": 7
        }
      }
    ],
    "fees": {
      "netValue": 46.663,
      "grossValue": 49.929,
      "taxValue": 3.266,
      "taxCode": "REDUCED",
      "taxRate": 7
    },
    "totalFee": {
      "netValue": 45.829,
      "grossValue": 49.037,
      "taxValue": 3.208,
      "taxCode": "REDUCED",
      "taxRate": 7,
      "appliedDiscounts": [
        {
          "value": 0.892,
          "price": {
            "netValue": 0.834,
            "grossValue": 0.892,
            "taxValue": 0.058,
            "taxCode": "REDUCED",
            "taxRate": 7
          },
          "discountType": "ABSOLUTE",
          "origin": "INTERNAL"
        }
      ]
    },
    "shipping": {
      "netValue": 10,
      "grossValue": 11.9,
      "taxValue": 1.9,
      "taxCode": "STANDARD",
      "taxRate": 19
    },
    "totalShipping": {
      "netValue": 8.808,
      "grossValue": 10.482,
      "taxValue": 1.674,
      "taxCode": "STANDARD",
      "taxRate": 19,
      "appliedDiscounts": [
        {
          "value": 1.418,
          "price": {
            "netValue": 1.192,
            "grossValue": 1.418,
            "taxValue": 0.226,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          "discountType": "ABSOLUTE",
          "origin": "INTERNAL"
        }
      ]
    },
    "totalDiscount": {
      "calculationType": "ApplyDiscountAfterTax",
      "value": 380,
      "price": {
        "netValue": 320.76,
        "grossValue": 380,
        "taxValue": 59.24
      },
      "appliedDiscounts": [
        {
          "value": 100,
          "price": {
            "netValue": 85.466,
            "grossValue": 100,
            "taxValue": 14.534
          },
          "discountType": "ABSOLUTE",
          "origin": "INTERNAL"
        },
        {
          "id": "buy-2-get-1-free",
          "value": 280,
          "price": {
            "netValue": 235.294,
            "grossValue": 280,
            "taxValue": 44.706,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          "discountType": "PERCENT",
          "origin": "EXTERNAL"
        }
      ]
    },
    "finalPrice": {
      "netValue": 436.288,
      "grossValue": 501.829,
      "taxValue": 65.541,
      "taxAggregate": {
        "lines": [
          {
            "netValue": 144.618,
            "grossValue": 154.741,
            "taxValue": 10.123,
            "taxCode": "REDUCED",
            "taxRate": 7
          },
          {
            "netValue": 291.67,
            "grossValue": 347.088,
            "taxValue": 55.418,
            "taxCode": "STANDARD",
            "taxRate": 19
          }
        ]
      }
    }
  }
}

Updating an order

put

Updates an order with the specified order ID. To be used by tenant employees.

Required scopes

This endpoint requires the following scopes:

• : Needed to update an order.
• : Needed to update an order with a `completed` status.
• : The scope allows vendor to manage order with assigned vendor.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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]+$

Query parameters

recalculatebooleanOptional

Flag that enforces order recalculation. If set to true, the whole order, including the coupon discounts, will be recalculated.

Default: false

Body

application/json

all ofOptional

Responses

204

Successful order update

400

Request syntactically incorrect. Details of the error are included in 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

409

Optimistic locking failed. User sends metadata/version attribute which is outdated (someone else updated order in the time user was performing his changes). User should retrieve the latest order data and retry the request.

application/json

500

Some server side error occurred.

application/json

put

/order-v2/{tenant}/salesorders/{orderId}

HTTPcURLJavaScriptPython

PUT /order-v2/{tenant}/salesorders/{orderId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 5458

{
  "status": "IN_CHECKOUT",
  "entries": [
    {
      "id": "BC10033--BC10033-43",
      "itemYrn": "urn:yaas:saasag:caasproduct:product:test;BC10033--BC10033-43",
      "amount": 3,
      "orderedAmount": 3,
      "effectiveQuantity": 3,
      "calculatedUnitPrice": {
        "netValue": 100,
        "grossValue": 119,
        "taxValue": 19,
        "taxCode": "STANDARD",
        "taxRate": 19
      },
      "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"
      },
      "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
        }
      },
      "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": "[email protected]"
  },
  "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"
    }
  ],
  "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"
    }
  },
  "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": {}
}

No content

Deleting an order

delete

Deletes order with the specified ID. To be used by tenant employees.

Required scopes

This endpoint requires the following scopes:

• : Needed to delete an order.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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]+$

Responses

204

Successful deletion

400

Request syntactically incorrect. Details of the error are included in 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

delete

/order-v2/{tenant}/salesorders/{orderId}

HTTPcURLJavaScriptPython

DELETE /order-v2/{tenant}/salesorders/{orderId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Partially updating an order

patch

Updates partially an order with the specified order ID. To be used by tenant employees.

Required scopes

This endpoint requires the following scopes:

• : Needed to update an order.
• : Needed to update an order with a `completed` status.
• : The scope allows vendor to manage order with assigned vendor.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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]+$

Query parameters

recalculatebooleanOptional

Flag that enforces order recalculation. If set to true, the whole order, including the coupon discounts, will be recalculated.

Default: false

Body

application/json

all ofOptional

Responses

204

Successful order update

400

Request syntactically incorrect. Details of the error are included in 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

409

Optimistic locking failed. User sends metadata/version attribute which is outdated (someone else updated order in the time user was performing his changes). User should retrieve the latest order data and retry the request.

application/json

500

Some server side error occurred.

application/json

patch

/order-v2/{tenant}/salesorders/{orderId}

HTTPcURLJavaScriptPython

PATCH /order-v2/{tenant}/salesorders/{orderId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 5458

{
  "status": "IN_CHECKOUT",
  "entries": [
    {
      "id": "BC10033--BC10033-43",
      "itemYrn": "urn:yaas:saasag:caasproduct:product:test;BC10033--BC10033-43",
      "amount": 3,
      "orderedAmount": 3,
      "effectiveQuantity": 3,
      "calculatedUnitPrice": {
        "netValue": 100,
        "grossValue": 119,
        "taxValue": 19,
        "taxCode": "STANDARD",
        "taxRate": 19
      },
      "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"
      },
      "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
        }
      },
      "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": "[email protected]"
  },
  "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"
    }
  ],
  "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"
    }
  },
  "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": {}
}

No content

Retrieving status transitions for an order

get

Retrieves all possible status transitions for a specific order. To be used by tenant employees.

Required scopes

This endpoint requires the following scopes:

• : Needed to read order.
• : Needed to update an order.
• : Needed to update an order with a `completed` status.
• : The scope allows vendor to read order with assigned vendor.
• : The scope allows vendor to manage order with assigned vendor.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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]+$

Responses

200

The request was successful. Status transitions for specific order returned.

application/json

400

Request syntactically incorrect. Details of the error are included in 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

get

/order-v2/{tenant}/salesorders/{orderId}/transitions

HTTPcURLJavaScriptPython

GET /order-v2/{tenant}/salesorders/{orderId}/transitions HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "status": "CONFIRMED"
  }
]

Updating order status

post

Updates the status of a specific order. To be used by tenant employees.

Required scopes

This endpoint requires the following scopes:

• : Needed to update an order.
• : Needed to update an order with a `completed` status.
• : The scope allows vendor to manage order with assigned vendor.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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]+$

Body

application/json

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 request was successful. Order was successfully updated.

400

Request syntactically incorrect. Details of the error are included in 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

/order-v2/{tenant}/salesorders/{orderId}/transitions

HTTPcURLJavaScriptPython

POST /order-v2/{tenant}/salesorders/{orderId}/transitions HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "status": "DECLINED"
}

No content

Recalculating number of entries

post

Updates the number of entries in the specific order and recalculates it. To be used by tenant employees.

Required scopes

This endpoint requires the following scopes:

• : Needed to update an order.
• : Needed to update an order with a `completed` status.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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]+$

Body

application/json

Responses

200

Order recalculated successfully

No content

400

Bad Request

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

/order-v2/{tenant}/salesorders/{orderId}/calculations

HTTPcURLJavaScriptPython

POST /order-v2/{tenant}/salesorders/{orderId}/calculations HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "entries": [
    {
      "entryId": "5c336893a981210009900071",
      "deliveredAmount": 10
    },
    {
      "entryId": "5c336893a981210009900072",
      "deliveredAmount": 1000,
      "unit": "GRM"
    }
  ]
}

No content

Adding entries to an order

post

Updates the entries in the specific order and recalculates it. If provided entry is already assigned to the order then quantity of this entry is updated. If you want to remove entry from order then set quantity to 0.

Required scopes

This endpoint requires the following scopes:

• : Needed to update an order.
• : The scope allows vendor to manage order with assigned vendor.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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]+$

Query parameters

storebooleanOptional

This endpoint adds entries to the order and recalculates it. The result is returned. This flag can control whether the result should be stored in the database or not. By setting this flag to false, your order won't be updated.

Default: false

Body

application/json

Responses

200

The request was successful. Recalculated order is returned.

application/json

Responseall of

400

Bad Request

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

/order-v2/{tenant}/salesorders/{orderId}/entries

HTTPcURLJavaScriptPython

POST /order-v2/{tenant}/salesorders/{orderId}/entries HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "entries": [
    {
      "productId": "1010234",
      "quantity": 1
    }
  ]
}

Add new product to orderModify quantityRemove entry

{
  "id": "EON1200",
  "createdBy": "45620894",
  "status": "CREATED",
  "lastStatusChange": "2025-06-10T12:31:39.614Z",
  "created": "2025-06-10T12:31:39.614Z",
  "channel": {
    "name": "storefront",
    "source": "https://your-storefront.com/"
  },
  "cartId": "68481e9e8bf22744fc578572",
  "entries": [
    {
      "id": "0_SLI_mobile-phone-s24-gross",
      "itemYrn": "urn:yaas:saasag:caasproduct:product:b2b2cstage;mobile-phone-s24-gross",
      "keepAsSeparateLineItem": true,
      "type": "INTERNAL",
      "amount": 2,
      "orderedAmount": 2,
      "effectiveQuantity": 2,
      "originalAmount": 350,
      "originalPrice": 350,
      "unitPrice": 350,
      "calculatedUnitPrice": {
        "netValue": 294.118,
        "grossValue": 350,
        "taxValue": 55.882,
        "taxCode": "STANDARD",
        "taxRate": 19
      },
      "totalPrice": 700,
      "authorizedAmount": 700,
      "product": {
        "id": "mobile-phone-s24-gross",
        "sku": "Mobile Phone s24 gross",
        "name": "Mobile Phone s24 gross",
        "localizedName": {
          "en": "Mobile Phone s24 gross"
        },
        "published": true,
        "images": [
          {
            "id": "67169928ceaab717e17f3734",
            "url": "http://res.cloudinary.com/saas-ag/image/upload/v1729534248/b2b2cstage/media/67169928ceaab717e17f3734",
            "stored": false
          }
        ],
        "productType": "BASIC"
      },
      "tax": {
        "lines": [
          {
            "amount": 111.76,
            "currency": "EUR",
            "code": "STANDARD",
            "name": "STANDARD",
            "rate": 19,
            "sequenceId": 0,
            "inclusive": true
          }
        ],
        "total": {
          "amount": 0,
          "currency": "EUR",
          "inclusive": true
        }
      },
      "price": {
        "priceId": "679ca63dbcdefe5b380c98bc",
        "priceListId": "abc123",
        "currency": "EUR",
        "originalAmount": 350,
        "effectiveAmount": 350,
        "basePrice": {},
        "presentationPrice": {},
        "metadata": {
          "createdAt": "2025-01-31T10:30:21.998Z",
          "modifiedAt": "2025-01-31T10:30:21.998Z",
          "version": 1
        }
      },
      "totalDiscount": {
        "amount": 84.06,
        "currency": "EUR"
      },
      "fees": {
        "elements": [
          {
            "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;677d49ca3a421b451eab23f2",
            "name": {
              "de": "Apple Picking Fee",
              "en": "Apple Picking Fee"
            },
            "taxCode": "REDUCED",
            "total": {
              "subTotal": 3.5,
              "totalTax": 0,
              "total": 3.08
            }
          }
        ],
        "total": {
          "subTotal": 3.5,
          "totalTax": 0,
          "total": 3.08
        }
      },
      "metadata": {
        "mixins": {
          "fees": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
        }
      },
      "mixins": {
        "fees": {
          "elements": [
            {
              "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;677d49ca3a421b451eab23f2",
              "name": {
                "de": "Apple Picking Fee",
                "en": "Apple Picking Fee"
              },
              "taxCode": "REDUCED",
              "total": {
                "subTotal": 3.5,
                "totalTax": 0,
                "total": 3.08,
                "discount": 0.42
              }
            }
          ],
          "total": {
            "subTotal": 3.5,
            "totalTax": 0,
            "total": 3.08,
            "discount": 0.42
          }
        }
      },
      "calculatedPrice": {
        "price": {
          "netValue": 588.235,
          "grossValue": 700,
          "taxValue": 111.765,
          "taxCode": "STANDARD",
          "taxRate": 19
        },
        "discountedPrice": {
          "netValue": 282.862,
          "grossValue": 336.606,
          "taxValue": 53.744,
          "taxCode": "STANDARD",
          "taxRate": 19,
          "appliedDiscounts": [
            {
              "value": 83.394,
              "price": {
                "netValue": 70.079,
                "grossValue": 83.394,
                "taxValue": 13.315,
                "taxCode": "STANDARD",
                "taxRate": 19
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            },
            {
              "id": "buy-2-get-1-free",
              "value": 280,
              "price": {
                "netValue": 235.294,
                "grossValue": 280,
                "taxValue": 44.706,
                "taxCode": "STANDARD",
                "taxRate": 19
              },
              "discountType": "PERCENT",
              "origin": "EXTERNAL"
            }
          ]
        },
        "fees": [
          {
            "id": "677d49ca3a421b451eab23f2",
            "type": "ABSOLUTE",
            "origin": "INTERNAL",
            "name": {
              "de": "Apple Picking Fee",
              "en": "Apple Picking Fee"
            },
            "price": {
              "netValue": 3.5,
              "grossValue": 3.745,
              "taxValue": 0.245,
              "taxCode": "REDUCED",
              "taxRate": 7
            },
            "discountedPrice": {
              "netValue": 3.083,
              "grossValue": 3.299,
              "taxValue": 0.216,
              "taxCode": "REDUCED",
              "taxRate": 7,
              "appliedDiscounts": [
                {
                  "value": 0.446,
                  "price": {
                    "netValue": 0.417,
                    "grossValue": 0.446,
                    "taxValue": 0.029,
                    "taxCode": "REDUCED",
                    "taxRate": 7
                  },
                  "discountType": "ABSOLUTE",
                  "origin": "INTERNAL"
                }
              ]
            }
          }
        ],
        "totalFee": {
          "netValue": 3.083,
          "grossValue": 3.299,
          "taxValue": 0.216,
          "taxCode": "REDUCED",
          "taxRate": 7,
          "appliedDiscounts": [
            {
              "value": 0.446,
              "price": {
                "netValue": 0.417,
                "grossValue": 0.446,
                "taxValue": 0.029,
                "taxCode": "REDUCED",
                "taxRate": 7
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            }
          ]
        },
        "totalDiscount": {
          "calculationType": "ApplyDiscountAfterTax",
          "value": 363.84,
          "price": {
            "netValue": 305.79,
            "grossValue": 363.84,
            "taxValue": 58.05
          },
          "appliedDiscounts": [
            {
              "value": 83.84,
              "price": {
                "netValue": 70.496,
                "grossValue": 83.84,
                "taxValue": 13.344
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            },
            {
              "id": "buy-2-get-1-free",
              "value": 280,
              "price": {
                "netValue": 235.294,
                "grossValue": 280,
                "taxValue": 44.706,
                "taxCode": "STANDARD",
                "taxRate": 19
              },
              "discountType": "PERCENT",
              "origin": "EXTERNAL"
            }
          ]
        },
        "finalPrice": {
          "netValue": 285.945,
          "grossValue": 339.905,
          "taxValue": 53.96
        }
      },
      "priceMatchDetails": {
        "netValue": 294.11764705882354,
        "grossValue": 350,
        "taxValue": 55.88235294117647,
        "taxCode": "STANDARD",
        "taxRate": 19,
        "taxCountry": "DE"
      },
      "externalDiscounts": [
        {
          "id": "buy-2-get-1-free",
          "discountType": "PERCENT",
          "value": 40,
          "sequence": 1
        }
      ]
    },
    {
      "id": "shirt--301722c1-23e8-42b4-a4d8-1a5480fe3ea5",
      "itemYrn": "urn:yaas:saasag:caasproduct:product:b2b2cstage;shirt--301722c1-23e8-42b4-a4d8-1a5480fe3ea5",
      "keepAsSeparateLineItem": false,
      "type": "INTERNAL",
      "amount": 1,
      "orderedAmount": 1,
      "effectiveQuantity": 1,
      "originalAmount": 10,
      "originalPrice": 10,
      "unitPrice": 10,
      "calculatedUnitPrice": {
        "netValue": 9.346,
        "grossValue": 10,
        "taxValue": 0.654,
        "taxCode": "REDUCED",
        "taxRate": 7
      },
      "totalPrice": 10,
      "authorizedAmount": 10,
      "product": {
        "metadata": {
          "mixins": {
            "productTemplateAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/b2b2cstage/6818bfed8844a34a391a566e-templateAttributes_v1.json",
            "productVariantAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/b2b2cstage/6818bfed8844a34a391a566e-variantAttributes_v1.json"
          }
        },
        "id": "shirt--301722c1-23e8-42b4-a4d8-1a5480fe3ea5",
        "sku": "shirt--red",
        "name": "shirt",
        "localizedName": {
          "en": "shirt"
        },
        "description": "[de:, en:, pl:]",
        "published": true,
        "images": [],
        "mixins": {
          "productVariantAttributes": {
            "color": "red"
          }
        },
        "productType": "VARIANT"
      },
      "tax": {
        "lines": [
          {
            "amount": 0.65,
            "currency": "EUR",
            "code": "REDUCED",
            "name": "REDUCED",
            "rate": 7,
            "sequenceId": 0,
            "inclusive": true
          }
        ],
        "total": {
          "amount": 0,
          "currency": "EUR",
          "inclusive": true
        }
      },
      "price": {
        "priceId": "6818c032524d1c16623037e2",
        "currency": "EUR",
        "originalAmount": 10,
        "effectiveAmount": 10,
        "basePrice": {},
        "presentationPrice": {},
        "metadata": {
          "createdAt": "2025-05-05T13:42:10.674Z",
          "modifiedAt": "2025-05-05T13:44:20.599Z",
          "version": 2
        }
      },
      "totalDiscount": {
        "amount": 1.19,
        "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": 9.346,
          "grossValue": 10,
          "taxValue": 0.654,
          "taxCode": "REDUCED",
          "taxRate": 7
        },
        "discountedPrice": {
          "netValue": 8.233,
          "grossValue": 8.809,
          "taxValue": 0.576,
          "taxCode": "REDUCED",
          "taxRate": 7,
          "appliedDiscounts": [
            {
              "value": 1.191,
              "price": {
                "netValue": 1.113,
                "grossValue": 1.191,
                "taxValue": 0.078,
                "taxCode": "REDUCED",
                "taxRate": 7
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            }
          ]
        },
        "totalDiscount": {
          "calculationType": "ApplyDiscountAfterTax",
          "value": 1.191,
          "price": {
            "netValue": 1.113,
            "grossValue": 1.191,
            "taxValue": 0.078,
            "taxCode": "REDUCED",
            "taxRate": 7
          },
          "appliedDiscounts": [
            {
              "value": 1.191,
              "price": {
                "netValue": 1.113,
                "grossValue": 1.191,
                "taxValue": 0.078,
                "taxCode": "REDUCED",
                "taxRate": 7
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            }
          ]
        },
        "finalPrice": {
          "netValue": 8.233,
          "grossValue": 8.809,
          "taxValue": 0.576,
          "taxCode": "REDUCED",
          "taxRate": 7
        }
      },
      "priceMatchDetails": {
        "netValue": 9.345794392523365,
        "grossValue": 10,
        "taxValue": 0.6542056074766355,
        "taxCode": "REDUCED",
        "taxRate": 7,
        "taxCountry": "DE"
      }
    },
    {
      "id": "2_SLI_mobile-phone-s27-gross",
      "itemYrn": "urn:yaas:saasag:caasproduct:product:b2b2cstage;mobile-phone-s27-gross",
      "keepAsSeparateLineItem": true,
      "type": "INTERNAL",
      "amount": 2,
      "orderedAmount": 2,
      "effectiveQuantity": 2,
      "originalAmount": 55,
      "originalPrice": 55,
      "unitPrice": 55,
      "calculatedUnitPrice": {
        "netValue": 51.402,
        "grossValue": 55,
        "taxValue": 3.598,
        "taxCode": "REDUCED",
        "taxRate": 7
      },
      "totalPrice": 110,
      "authorizedAmount": 143,
      "product": {
        "id": "mobile-phone-s27-gross",
        "sku": "mobile-phone-s27-gross",
        "name": "mobile-phone-s27-gross",
        "localizedName": {
          "en": "mobile-phone-s27-gross"
        },
        "description": "[en:mobile-phone-s27-gross]",
        "published": true,
        "images": [],
        "productType": "BASIC"
      },
      "tax": {
        "lines": [
          {
            "amount": 7.2,
            "currency": "EUR",
            "code": "REDUCED",
            "name": "REDUCED",
            "rate": 7,
            "sequenceId": 0,
            "inclusive": true
          }
        ],
        "total": {
          "amount": 0,
          "currency": "EUR",
          "inclusive": true
        }
      },
      "price": {
        "priceId": "6797da2f3537716a5a537ecf",
        "currency": "EUR",
        "originalAmount": 55,
        "effectiveAmount": 55,
        "basePrice": {},
        "presentationPrice": {},
        "metadata": {
          "createdAt": "2025-01-27T19:10:39.966Z",
          "modifiedAt": "2025-04-14T07:54:30.431Z",
          "version": 23
        }
      },
      "totalDiscount": {
        "amount": 13.56,
        "currency": "EUR"
      },
      "fees": {
        "elements": [
          {
            "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;677d49ca3a421b451eab23f2",
            "name": "Apple Picking Fee",
            "taxCode": "REDUCED",
            "total": {
              "subTotal": 3.5,
              "totalTax": 0,
              "total": 3.08
            }
          }
        ],
        "total": {
          "subTotal": 3.5,
          "totalTax": 0,
          "total": 3.08
        }
      },
      "metadata": {
        "mixins": {
          "fees": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
        }
      },
      "mixins": {
        "fees": {
          "elements": [
            {
              "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;677d49ca3a421b451eab23f2",
              "name": "Apple Picking Fee",
              "taxCode": "REDUCED",
              "total": {
                "subTotal": 3.5,
                "totalTax": 0,
                "total": 3.08,
                "discount": 0.42
              }
            }
          ],
          "total": {
            "subTotal": 3.5,
            "totalTax": 0,
            "total": 3.08,
            "discount": 0.42
          }
        }
      },
      "calculatedPrice": {
        "price": {
          "netValue": 102.804,
          "grossValue": 110,
          "taxValue": 7.196,
          "taxCode": "REDUCED",
          "taxRate": 7
        },
        "upliftValue": {
          "netValue": 30.841,
          "grossValue": 33,
          "taxValue": 2.159,
          "taxCode": "REDUCED",
          "taxRate": 7
        },
        "discountedPrice": {
          "netValue": 90.556,
          "grossValue": 96.895,
          "taxValue": 6.339,
          "taxCode": "REDUCED",
          "taxRate": 7,
          "appliedDiscounts": [
            {
              "value": 13.105,
              "price": {
                "netValue": 12.248,
                "grossValue": 13.105,
                "taxValue": 0.857,
                "taxCode": "REDUCED",
                "taxRate": 7
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            }
          ]
        },
        "fees": [
          {
            "id": "677d49ca3a421b451eab23f2",
            "type": "ABSOLUTE",
            "origin": "INTERNAL",
            "name": "Apple Picking Fee",
            "price": {
              "netValue": 3.5,
              "grossValue": 3.745,
              "taxValue": 0.245,
              "taxCode": "REDUCED",
              "taxRate": 7
            },
            "discountedPrice": {
              "netValue": 3.083,
              "grossValue": 3.299,
              "taxValue": 0.216,
              "taxCode": "REDUCED",
              "taxRate": 7,
              "appliedDiscounts": [
                {
                  "value": 0.446,
                  "price": {
                    "netValue": 0.417,
                    "grossValue": 0.446,
                    "taxValue": 0.029,
                    "taxCode": "REDUCED",
                    "taxRate": 7
                  },
                  "discountType": "ABSOLUTE",
                  "origin": "INTERNAL"
                }
              ]
            }
          }
        ],
        "totalFee": {
          "netValue": 3.083,
          "grossValue": 3.299,
          "taxValue": 0.216,
          "taxCode": "REDUCED",
          "taxRate": 7,
          "appliedDiscounts": [
            {
              "value": 0.446,
              "price": {
                "netValue": 0.417,
                "grossValue": 0.446,
                "taxValue": 0.029,
                "taxCode": "REDUCED",
                "taxRate": 7
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            }
          ]
        },
        "totalDiscount": {
          "calculationType": "ApplyDiscountAfterTax",
          "value": 13.551,
          "price": {
            "netValue": 12.665,
            "grossValue": 13.551,
            "taxValue": 0.886,
            "taxCode": "REDUCED",
            "taxRate": 7
          },
          "appliedDiscounts": [
            {
              "value": 13.551,
              "price": {
                "netValue": 12.665,
                "grossValue": 13.551,
                "taxValue": 0.886,
                "taxCode": "REDUCED",
                "taxRate": 7
              },
              "discountType": "ABSOLUTE",
              "origin": "INTERNAL"
            }
          ]
        },
        "finalPrice": {
          "netValue": 93.639,
          "grossValue": 100.194,
          "taxValue": 6.555,
          "taxCode": "REDUCED",
          "taxRate": 7
        }
      },
      "priceMatchDetails": {
        "netValue": 51.401869158878505,
        "grossValue": 55,
        "taxValue": 3.5981308411214954,
        "taxCode": "REDUCED",
        "taxRate": 7,
        "taxCountry": "DE"
      }
    }
  ],
  "discounts": [
    {
      "code": "TOTAL",
      "amount": 100,
      "currency": "EUR",
      "sequenceId": 1,
      "categoryRestricted": false
    },
    {
      "code": "LS100EUROTOTAL",
      "amount": 100,
      "currency": "EUR",
      "name": "LS100EUROTOTAL",
      "calculationType": "ApplyDiscountBeforeTax",
      "discountType": "ABSOLUTE",
      "discountCalculationType": "TOTAL",
      "categoryRestricted": false
    }
  ],
  "customer": {
    "id": "45620894",
    "name": "John Dutton",
    "firstName": "John",
    "lastName": "Dutton",
    "email": "[email protected]"
  },
  "siteCode": "GrossSite",
  "countryCode": "DE",
  "billingAddress": {
    "contactName": "Dom",
    "street": "Kochanowskiego",
    "streetNumber": "21",
    "streetAppendix": "",
    "zipCode": "44-122",
    "city": "Gliwice",
    "country": "DE",
    "state": "Slaskie",
    "contactPhone": ""
  },
  "shippingAddress": {
    "contactName": "Dom",
    "street": "Kochanowskiego",
    "streetNumber": "21",
    "streetAppendix": "",
    "zipCode": "44-122",
    "city": "Gliwice",
    "country": "DE",
    "state": "Slaskie",
    "contactPhone": ""
  },
  "payments": [
    {
      "status": "PENDING",
      "method": "invoice",
      "paidAmount": 0,
      "currency": "EUR",
      "provider": "stripe"
    }
  ],
  "shipping": {
    "total": {
      "amount": 10.71,
      "currency": "EUR"
    },
    "lines": [
      {
        "amount": 10,
        "currency": "EUR",
        "code": "Pickup",
        "name": "Pickup",
        "localizedName": {
          "en": "Pickup"
        },
        "tax": {
          "total": {
            "amount": 1.9,
            "currency": "EUR",
            "inclusive": false
          },
          "rate": 19
        },
        "shippingTaxCode": "STANDARD"
      }
    ]
  },
  "tax": {
    "lines": [
      {
        "amount": 7.85,
        "currency": "EUR",
        "code": "REDUCED",
        "name": "REDUCED",
        "rate": 7,
        "sequenceId": 0,
        "inclusive": false
      },
      {
        "amount": 113.66,
        "currency": "EUR",
        "code": "STANDARD",
        "name": "STANDARD",
        "rate": 19,
        "sequenceId": 1,
        "inclusive": false
      }
    ],
    "total": {
      "amount": 1.9,
      "currency": "EUR",
      "inclusive": false
    }
  },
  "subTotalPrice": 820,
  "totalPrice": 812.79,
  "totalAuthorizedAmount": 534.829,
  "currency": "EUR",
  "metadata": {
    "mixins": {
      "payments": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json",
      "generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/orderGeneralAttributesMixIn.v9.json"
    },
    "version": 1
  },
  "mixins": {
    "payments": {
      "elements": [
        {
          "paymentMethodYrn": "urn:yaas:hybris:payments:payment-method:b2b2cstage;invoice",
          "fees": {
            "elements": [
              {
                "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;678f552a949c723de46bdb14",
                "name": {
                  "de": "Payment fee",
                  "en": "Payment fee"
                },
                "taxCode": "REDUCED",
                "total": {
                  "subTotal": 73.89,
                  "totalTax": 0,
                  "total": 73.89,
                  "discount": 0
                }
              }
            ],
            "total": {
              "subTotal": 0,
              "totalTax": 0,
              "total": 0,
              "discount": 0
            }
          },
          "total": {
            "subTotal": 73.89,
            "totalTax": 0,
            "total": 73.89,
            "discount": 0
          }
        }
      ],
      "total": {
        "subTotal": 73.89,
        "totalTax": 0,
        "total": 73.89,
        "discount": 0
      }
    },
    "generalAttributes": {
      "extendedOrderStatus": "10",
      "customerFirstOrder": false,
      "orderNumber": "EON1200"
    }
  },
  "feeYrnAggregate": {
    "elements": [
      {
        "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;677d49ca3a421b451eab23f2",
        "name": {
          "de": "Apple Picking Fee",
          "en": "Apple Picking Fee"
        },
        "taxCode": "REDUCED",
        "total": {
          "subTotal": 7,
          "totalTax": 0,
          "total": 6.16
        }
      },
      {
        "yrn": "urn:yaas:saasag:fee:fee:b2b2cstage;678f552a949c723de46bdb14",
        "name": {
          "de": "Payment fee",
          "en": "Payment fee"
        },
        "taxCode": "REDUCED",
        "total": {
          "subTotal": 73.89,
          "totalTax": 0,
          "total": 73.89
        }
      }
    ],
    "total": {
      "subTotal": 80.89,
      "totalTax": 0,
      "total": 80.05
    }
  },
  "calculatedPrice": {
    "price": {
      "netValue": 700.385,
      "grossValue": 820,
      "taxValue": 119.615
    },
    "upliftValue": {
      "netValue": 30.841,
      "grossValue": 33,
      "taxValue": 2.159,
      "taxCode": "REDUCED",
      "taxRate": 7
    },
    "discountedPrice": {
      "netValue": 381.651,
      "grossValue": 442.31,
      "taxValue": 60.659,
      "appliedDiscounts": [
        {
          "value": 97.69,
          "price": {
            "netValue": 83.44,
            "grossValue": 97.69,
            "taxValue": 14.25
          },
          "discountType": "ABSOLUTE",
          "origin": "INTERNAL"
        },
        {
          "id": "buy-2-get-1-free",
          "value": 280,
          "price": {
            "netValue": 235.294,
            "grossValue": 280,
            "taxValue": 44.706,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          "discountType": "PERCENT",
          "origin": "EXTERNAL"
        }
      ]
    },
    "paymentFees": [
      {
        "id": "678f552a949c723de46bdb14",
        "type": "PERCENT",
        "origin": "INTERNAL",
        "name": {
          "de": "Payment fee",
          "en": "Payment fee"
        },
        "price": {
          "netValue": 39.663,
          "grossValue": 42.439,
          "taxValue": 2.776,
          "taxCode": "REDUCED",
          "taxRate": 7
        }
      }
    ],
    "fees": {
      "netValue": 46.663,
      "grossValue": 49.929,
      "taxValue": 3.266,
      "taxCode": "REDUCED",
      "taxRate": 7
    },
    "totalFee": {
      "netValue": 45.829,
      "grossValue": 49.037,
      "taxValue": 3.208,
      "taxCode": "REDUCED",
      "taxRate": 7,
      "appliedDiscounts": [
        {
          "value": 0.892,
          "price": {
            "netValue": 0.834,
            "grossValue": 0.892,
            "taxValue": 0.058,
            "taxCode": "REDUCED",
            "taxRate": 7
          },
          "discountType": "ABSOLUTE",
          "origin": "INTERNAL"
        }
      ]
    },
    "shipping": {
      "netValue": 10,
      "grossValue": 11.9,
      "taxValue": 1.9,
      "taxCode": "STANDARD",
      "taxRate": 19
    },
    "totalShipping": {
      "netValue": 8.808,
      "grossValue": 10.482,
      "taxValue": 1.674,
      "taxCode": "STANDARD",
      "taxRate": 19,
      "appliedDiscounts": [
        {
          "value": 1.418,
          "price": {
            "netValue": 1.192,
            "grossValue": 1.418,
            "taxValue": 0.226,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          "discountType": "ABSOLUTE",
          "origin": "INTERNAL"
        }
      ]
    },
    "totalDiscount": {
      "calculationType": "ApplyDiscountAfterTax",
      "value": 380,
      "price": {
        "netValue": 320.76,
        "grossValue": 380,
        "taxValue": 59.24
      },
      "appliedDiscounts": [
        {
          "value": 100,
          "price": {
            "netValue": 85.466,
            "grossValue": 100,
            "taxValue": 14.534
          },
          "discountType": "ABSOLUTE",
          "origin": "INTERNAL"
        },
        {
          "id": "buy-2-get-1-free",
          "value": 280,
          "price": {
            "netValue": 235.294,
            "grossValue": 280,
            "taxValue": 44.706,
            "taxCode": "STANDARD",
            "taxRate": 19
          },
          "discountType": "PERCENT",
          "origin": "EXTERNAL"
        }
      ]
    },
    "finalPrice": {
      "netValue": 436.288,
      "grossValue": 501.829,
      "taxValue": 65.541,
      "taxAggregate": {
        "lines": [
          {
            "netValue": 144.618,
            "grossValue": 154.741,
            "taxValue": 10.123,
            "taxCode": "REDUCED",
            "taxRate": 7
          },
          {
            "netValue": 291.67,
            "grossValue": 347.088,
            "taxValue": 55.418,
            "taxCode": "STANDARD",
            "taxRate": 19
          }
        ]
      }
    }
  }
}

Splitting order

post

Splits order into suborders based on the given criteria. It works for:

• orders with CREATED status

• orders where orderType = null, meaning that the order has not been split and there are not suborders of a master order.

• orders without discounts, the ones with included discounts are not supported

Required scopes

This endpoint requires the following scopes:

• : Needed to update an order.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

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]+$

Body

application/json

splitBystring · enumOptional

Specifies the criteria used to split a master order into suborders. Currently, only VENDOR_ID is supported.

Possible values:

Responses

200

The order has been successfully split.

application/json

400

Bad Request

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

/order-v2/{tenant}/salesorders/{orderId}/split

HTTPcURLJavaScriptPython

POST /order-v2/{tenant}/salesorders/{orderId}/split HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "splitBy": "VENDOR_ID"
}

{
  "masterOrder": "EON1227",
  "splitBy": "VENDOR_ID",
  "subOrders": [
    {
      "id": "EON1228",
      "uniqueValue": "6879eecd1cc84b218acaaec7"
    },
    {
      "id": "EON1229",
      "uniqueValue": "6879ecf11cc84b218acaaec6"
    }
  ]
}