Skip to main content

Using the create order item function in Sitecore CDP REST API

Abstract

Provides a cURL command to create an order item in Sitecore CDP REST API (Data model 2.0).

You can use the Order REST API to perform a create order item function to create an order item.

To create an order item in the Sitecore CDP, use the following:

POST: https://apiEndpoint/v2/orders/orderRef/orderItems

Attribute

Description

Type

orderRef

The reference of the order.

string

$curl  --request POST 'https://{apiEndpoint}/v2/orders/0840ff0d-685a-41c8-8f29-4dd9fa2e3245/orderItems' \
--header 'Content-Type: application/json'  \
--data-raw '{
    "type": "FLIGHT",
    "productId": "DUB-LAS",
    "orderedAt": "2016-07-23T16:17:16.000Z",
    "quantity": 1,
    "price": 100.00,
    "currencyCode": "EUR",
    "originalPrice": 112.00,
    "originalCurrencyCode": "USD",
    "referenceId": "B94TXY",
    "status": "PURCHASED",
    "name": "Flight DUB-LAS",
    "description": "Flight DUB-LAS",
    "vendor": "unknown",
    "channel": "WEB",
    "language": "EN",
    "passengerTypeCode": "ADT",
    "flightSegments": [{
        "id": "1234",
        "origin": "DUB",
        "destination": "LHR",
        "originDestination": "DUB-LHR",
        "departureDateTime": "2016-08-15T16:00:00.000Z",
        "arrivalDateTime": "2016-08-15T17:30:00.000Z",
        "fareClass": "Economy",
        "fareFamily": "Plus",
        "bookingClass": "Y",
        "carrier": "BX",
        "flightNumber": "459",
        "operatingCarrier": "BX",
        "operatingFlightNumber": "1459" 
    },
    {
        "id": "1235",
        "origin": "LHR",
        "destination": "LAS",
        "originDestination": "LHR-LAS",
        "departureDateTime": "2016-08-15T19:00:00.000Z",
        "arrivalDateTime": "2016-08-15T21:30:00.000Z",
        "fareClass": "Economy",
        "fareFamily": "Plus",
        "bookingClass": "Y",
        "carrier": "BX",
        "flightNumber": "460",
        "operatingCarrier": "BX",
        "operatingFlightNumber": "1460"
    }]
}' 

The following is a 201 response:

{
    "type": "FLIGHT",
    "href": "https://{apiEndpoint}/v2/orderItems/7737242c-1ec4-4644-b4be-ca8a3882fba9",
    "ref": "7737242c-1ec4-4644-b4be-ca8a3882fba9",
    "order": {
        "href": "https://{apiEndpoint}/v2/orders/0840ff0d-685a-41c8-8f29-4dd9fa2e3245"
    },
    "createdAt": "2017-11-08T22:00:37.075Z",
    "modifiedAt": "2017-11-08T22:00:37.075Z",
    "orderedAt": "2016-07-15T16:00:00.000Z",
    "productId": "DUB-LAS",
    "price": 100,
    "currencyCode": "EUR",
    "originalPrice": 112,
    "originalCurrencyCode": "USD",
    "referenceId": "B94TXY",
    "vendor": "unknown",
    "status": "PURCHASED",
    "language": "EN",
    "name": "Flight DUB-LAS",
    "description": "Flight DUB-LAS",
    "quantity": 1,
    "channel": "WEB",
    "flightSegments": [
        {
            "id": "1234",
            "origin": "DUB",
            "destination": "LHR",
            "departureDateTime": "2016-08-15T16:00:00.000Z",
            "arrivalDateTime": "2016-08-15T17:30:00.000Z",
            "flightNumber": "459",
            "fareClass": "Economy",
            "fareFamily": "Plus",
            "carrier": "BX",
            "originDestination": "DUB-LHR",
            "bookingClass": "Y",
            "operatingCarrier": "BX"
        },
        {
            "id": "1235",
            "origin": "LHR",
            "destination": "LAS",
            "departureDateTime": "2016-08-15T19:00:00.000Z",
            "arrivalDateTime": "2016-08-15T21:30:00.000Z",
            "flightNumber": "460",
            "fareClass": "Economy",
            "fareFamily": "Plus",
            "carrier": "BX",
            "originDestination": "LHR-LAS",
            "bookingClass": "Y",
            "operatingCarrier": "BX"
        }
    ],
    "passengerTypeCode": "ADT",
    "consumerTypeCode": "ADT",
    "sku": "DUB-LAS"
}