Add item to order

curl --request POST \
  --url https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": {
    "def": "<string>"
  },
  "customPrice": 123,
  "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manualDiscount": 4503599627370495,
  "discountCodes": {},
  "customDeposit": 4503599627370495,
  "stockItems": [
    {
      "inventoryArticleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "note": "<string>"
    }
  ],
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "note": "<string>",
  "customCheckoutFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "internal": true
    }
  ],
  "addonData": {
    "type": "cart",
    "cartAddonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "addons": [
    {
      "catalogItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 4503599627370496,
      "customPrice": 4503599627370495,
      "addonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "selectedVariants": {},
      "manualDiscount": 4503599627370495,
      "discountCodes": {},
      "customDeposit": 4503599627370495,
      "checkoutFields": [
        {
          "fieldId": "<string>",
          "value": "<string>"
        }
      ],
      "customCheckoutFields": [
        {
          "name": "<string>",
          "value": "<string>",
          "internal": true
        }
      ],
      "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "subscription": {
    "label": "<string>",
    "price": 123,
    "renewalPrice": 123,
    "commitmentCycles": 123,
    "paymentCycleAmount": 123,
    "cancellationLeadTimeAmount": 123
  },
  "subscriptionDiscounts": [
    {
      "code": "<string>",
      "value": 123,
      "subscriptionDurationCycles": 123,
      "discountPeriodTo": "<string>"
    }
  ]
}
'

import requests

url = "https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems"

payload = {
    "name": { "def": "<string>" },
    "customPrice": 123,
    "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "manualDiscount": 4503599627370495,
    "discountCodes": {},
    "customDeposit": 4503599627370495,
    "stockItems": [
        {
            "inventoryArticleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "note": "<string>"
        }
    ],
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "note": "<string>",
    "customCheckoutFields": [
        {
            "name": "<string>",
            "value": "<string>",
            "internal": True
        }
    ],
    "addonData": {
        "type": "cart",
        "cartAddonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "addons": [
        {
            "catalogItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity": 4503599627370496,
            "customPrice": 4503599627370495,
            "addonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "startDate": "2023-11-07T05:31:56Z",
            "endDate": "2023-11-07T05:31:56Z",
            "selectedVariants": {},
            "manualDiscount": 4503599627370495,
            "discountCodes": {},
            "customDeposit": 4503599627370495,
            "checkoutFields": [
                {
                    "fieldId": "<string>",
                    "value": "<string>"
                }
            ],
            "customCheckoutFields": [
                {
                    "name": "<string>",
                    "value": "<string>",
                    "internal": True
                }
            ],
            "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
    ],
    "subscription": {
        "label": "<string>",
        "price": 123,
        "renewalPrice": 123,
        "commitmentCycles": 123,
        "paymentCycleAmount": 123,
        "cancellationLeadTimeAmount": 123
    },
    "subscriptionDiscounts": [
        {
            "code": "<string>",
            "value": 123,
            "subscriptionDurationCycles": 123,
            "discountPeriodTo": "<string>"
        }
    ]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: {def: '<string>'},
    customPrice: 123,
    orderCustomerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    manualDiscount: 4503599627370495,
    discountCodes: {},
    customDeposit: 4503599627370495,
    stockItems: [{inventoryArticleId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', note: '<string>'}],
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z',
    note: '<string>',
    customCheckoutFields: [{name: '<string>', value: '<string>', internal: true}],
    addonData: {type: 'cart', cartAddonId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
    addons: [
      {
        catalogItemId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        quantity: 4503599627370496,
        customPrice: 4503599627370495,
        addonId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        startDate: '2023-11-07T05:31:56Z',
        endDate: '2023-11-07T05:31:56Z',
        selectedVariants: {},
        manualDiscount: 4503599627370495,
        discountCodes: {},
        customDeposit: 4503599627370495,
        checkoutFields: [{fieldId: '<string>', value: '<string>'}],
        customCheckoutFields: [{name: '<string>', value: '<string>', internal: true}],
        orderCustomerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
      }
    ],
    subscription: {
      label: '<string>',
      price: 123,
      renewalPrice: 123,
      commitmentCycles: 123,
      paymentCycleAmount: 123,
      cancellationLeadTimeAmount: 123
    },
    subscriptionDiscounts: [
      {
        code: '<string>',
        value: 123,
        subscriptionDurationCycles: 123,
        discountPeriodTo: '<string>'
      }
    ]
  })
};

fetch('https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => [
        'def' => '<string>'
    ],
    'customPrice' => 123,
    'orderCustomerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'manualDiscount' => 4503599627370495,
    'discountCodes' => [
        
    ],
    'customDeposit' => 4503599627370495,
    'stockItems' => [
        [
                'inventoryArticleId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'note' => '<string>'
        ]
    ],
    'startDate' => '2023-11-07T05:31:56Z',
    'endDate' => '2023-11-07T05:31:56Z',
    'note' => '<string>',
    'customCheckoutFields' => [
        [
                'name' => '<string>',
                'value' => '<string>',
                'internal' => true
        ]
    ],
    'addonData' => [
        'type' => 'cart',
        'cartAddonId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'addons' => [
        [
                'catalogItemId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'quantity' => 4503599627370496,
                'customPrice' => 4503599627370495,
                'addonId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'startDate' => '2023-11-07T05:31:56Z',
                'endDate' => '2023-11-07T05:31:56Z',
                'selectedVariants' => [
                                
                ],
                'manualDiscount' => 4503599627370495,
                'discountCodes' => [
                                
                ],
                'customDeposit' => 4503599627370495,
                'checkoutFields' => [
                                [
                                                                'fieldId' => '<string>',
                                                                'value' => '<string>'
                                ]
                ],
                'customCheckoutFields' => [
                                [
                                                                'name' => '<string>',
                                                                'value' => '<string>',
                                                                'internal' => true
                                ]
                ],
                'orderCustomerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'subscription' => [
        'label' => '<string>',
        'price' => 123,
        'renewalPrice' => 123,
        'commitmentCycles' => 123,
        'paymentCycleAmount' => 123,
        'cancellationLeadTimeAmount' => 123
    ],
    'subscriptionDiscounts' => [
        [
                'code' => '<string>',
                'value' => 123,
                'subscriptionDurationCycles' => 123,
                'discountPeriodTo' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems"

	payload := strings.NewReader("{\n  \"name\": {\n    \"def\": \"<string>\"\n  },\n  \"customPrice\": 123,\n  \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manualDiscount\": 4503599627370495,\n  \"discountCodes\": {},\n  \"customDeposit\": 4503599627370495,\n  \"stockItems\": [\n    {\n      \"inventoryArticleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"note\": \"<string>\"\n    }\n  ],\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"note\": \"<string>\",\n  \"customCheckoutFields\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"internal\": true\n    }\n  ],\n  \"addonData\": {\n    \"type\": \"cart\",\n    \"cartAddonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"addons\": [\n    {\n      \"catalogItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 4503599627370496,\n      \"customPrice\": 4503599627370495,\n      \"addonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"startDate\": \"2023-11-07T05:31:56Z\",\n      \"endDate\": \"2023-11-07T05:31:56Z\",\n      \"selectedVariants\": {},\n      \"manualDiscount\": 4503599627370495,\n      \"discountCodes\": {},\n      \"customDeposit\": 4503599627370495,\n      \"checkoutFields\": [\n        {\n          \"fieldId\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"customCheckoutFields\": [\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"internal\": true\n        }\n      ],\n      \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"subscription\": {\n    \"label\": \"<string>\",\n    \"price\": 123,\n    \"renewalPrice\": 123,\n    \"commitmentCycles\": 123,\n    \"paymentCycleAmount\": 123,\n    \"cancellationLeadTimeAmount\": 123\n  },\n  \"subscriptionDiscounts\": [\n    {\n      \"code\": \"<string>\",\n      \"value\": 123,\n      \"subscriptionDurationCycles\": 123,\n      \"discountPeriodTo\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": {\n    \"def\": \"<string>\"\n  },\n  \"customPrice\": 123,\n  \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manualDiscount\": 4503599627370495,\n  \"discountCodes\": {},\n  \"customDeposit\": 4503599627370495,\n  \"stockItems\": [\n    {\n      \"inventoryArticleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"note\": \"<string>\"\n    }\n  ],\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"note\": \"<string>\",\n  \"customCheckoutFields\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"internal\": true\n    }\n  ],\n  \"addonData\": {\n    \"type\": \"cart\",\n    \"cartAddonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"addons\": [\n    {\n      \"catalogItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 4503599627370496,\n      \"customPrice\": 4503599627370495,\n      \"addonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"startDate\": \"2023-11-07T05:31:56Z\",\n      \"endDate\": \"2023-11-07T05:31:56Z\",\n      \"selectedVariants\": {},\n      \"manualDiscount\": 4503599627370495,\n      \"discountCodes\": {},\n      \"customDeposit\": 4503599627370495,\n      \"checkoutFields\": [\n        {\n          \"fieldId\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"customCheckoutFields\": [\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"internal\": true\n        }\n      ],\n      \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"subscription\": {\n    \"label\": \"<string>\",\n    \"price\": 123,\n    \"renewalPrice\": 123,\n    \"commitmentCycles\": 123,\n    \"paymentCycleAmount\": 123,\n    \"cancellationLeadTimeAmount\": 123\n  },\n  \"subscriptionDiscounts\": [\n    {\n      \"code\": \"<string>\",\n      \"value\": 123,\n      \"subscriptionDurationCycles\": 123,\n      \"discountPeriodTo\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": {\n    \"def\": \"<string>\"\n  },\n  \"customPrice\": 123,\n  \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manualDiscount\": 4503599627370495,\n  \"discountCodes\": {},\n  \"customDeposit\": 4503599627370495,\n  \"stockItems\": [\n    {\n      \"inventoryArticleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"note\": \"<string>\"\n    }\n  ],\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"note\": \"<string>\",\n  \"customCheckoutFields\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"internal\": true\n    }\n  ],\n  \"addonData\": {\n    \"type\": \"cart\",\n    \"cartAddonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"addons\": [\n    {\n      \"catalogItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 4503599627370496,\n      \"customPrice\": 4503599627370495,\n      \"addonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"startDate\": \"2023-11-07T05:31:56Z\",\n      \"endDate\": \"2023-11-07T05:31:56Z\",\n      \"selectedVariants\": {},\n      \"manualDiscount\": 4503599627370495,\n      \"discountCodes\": {},\n      \"customDeposit\": 4503599627370495,\n      \"checkoutFields\": [\n        {\n          \"fieldId\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"customCheckoutFields\": [\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"internal\": true\n        }\n      ],\n      \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"subscription\": {\n    \"label\": \"<string>\",\n    \"price\": 123,\n    \"renewalPrice\": 123,\n    \"commitmentCycles\": 123,\n    \"paymentCycleAmount\": 123,\n    \"cancellationLeadTimeAmount\": 123\n  },\n  \"subscriptionDiscounts\": [\n    {\n      \"code\": \"<string>\",\n      \"value\": 123,\n      \"subscriptionDurationCycles\": 123,\n      \"discountPeriodTo\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "name": {
    "def": "<string>"
  },
  "pricing": "<unknown>",
  "variants": {
    "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "variantValueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "variantLabel": "<string>",
    "variantValueLabel": "<string>"
  },
  "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "duration": "<string>",
  "startDate": "<string>",
  "endDate": "<string>",
  "returnedDate": "<string>",
  "purchaseType": "booking",
  "catalogItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "imageUrl": "<string>",
  "fulfillmentState": "pending",
  "checkoutFields": {
    "id": "<string>",
    "name": "<string>",
    "type": "text",
    "placeholder": "<string>",
    "required": true,
    "internal": true,
    "attributeId": "<string>",
    "attributeFormat": "text",
    "options": {
      "name": "<string>"
    },
    "value": "<string>",
    "checkoutFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "capturedTotal": 123,
  "refundedTotal": 123,
  "depositCapturedTotal": 123,
  "depositRefundedTotal": 123,
  "depositAuthorisedTotal": 123,
  "depositCancelledTotal": 123,
  "pricingRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "durationLabel": "<string>",
  "note": "<string>",
  "addonOfLineItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "catalogAddonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cartAddonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isAddon": "cart",
  "subscription": {
    "label": "<string>",
    "price": 123,
    "renewalPrice": 123,
    "commitmentCycles": 123,
    "paymentCycleUnit": "seconds",
    "paymentCycleAmount": 123,
    "initialChargeType": "order_creation",
    "renewalType": "none",
    "collectionMethod": "charge_automatically",
    "cancellationLeadTimeUnit": "seconds",
    "cancellationLeadTimeAmount": 123,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "orderLineItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "commitmentPeriodUnit": "seconds",
    "commitmentPeriodAmount": 123,
    "status": "active",
    "nextBillingAt": "<string>",
    "cancelAt": "<string>",
    "cancelledAt": "<string>"
  },
  "subscriptionDiscounts": {
    "code": "<string>",
    "valueType": "percentage",
    "value": 123,
    "subscriptionDuration": "once",
    "subscriptionDurationCycles": 123,
    "firstDiscountedCycleIndex": 123,
    "discountCodeId": "<string>",
    "discountPeriodTo": "<string>"
  }
}

POST

admin

orders

{orderId}

lineItems

Add item to order

curl --request POST \
  --url https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": {
    "def": "<string>"
  },
  "customPrice": 123,
  "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manualDiscount": 4503599627370495,
  "discountCodes": {},
  "customDeposit": 4503599627370495,
  "stockItems": [
    {
      "inventoryArticleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "note": "<string>"
    }
  ],
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "note": "<string>",
  "customCheckoutFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "internal": true
    }
  ],
  "addonData": {
    "type": "cart",
    "cartAddonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "addons": [
    {
      "catalogItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 4503599627370496,
      "customPrice": 4503599627370495,
      "addonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "selectedVariants": {},
      "manualDiscount": 4503599627370495,
      "discountCodes": {},
      "customDeposit": 4503599627370495,
      "checkoutFields": [
        {
          "fieldId": "<string>",
          "value": "<string>"
        }
      ],
      "customCheckoutFields": [
        {
          "name": "<string>",
          "value": "<string>",
          "internal": true
        }
      ],
      "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "subscription": {
    "label": "<string>",
    "price": 123,
    "renewalPrice": 123,
    "commitmentCycles": 123,
    "paymentCycleAmount": 123,
    "cancellationLeadTimeAmount": 123
  },
  "subscriptionDiscounts": [
    {
      "code": "<string>",
      "value": 123,
      "subscriptionDurationCycles": 123,
      "discountPeriodTo": "<string>"
    }
  ]
}
'

import requests

url = "https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems"

payload = {
    "name": { "def": "<string>" },
    "customPrice": 123,
    "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "manualDiscount": 4503599627370495,
    "discountCodes": {},
    "customDeposit": 4503599627370495,
    "stockItems": [
        {
            "inventoryArticleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "note": "<string>"
        }
    ],
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "note": "<string>",
    "customCheckoutFields": [
        {
            "name": "<string>",
            "value": "<string>",
            "internal": True
        }
    ],
    "addonData": {
        "type": "cart",
        "cartAddonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "addons": [
        {
            "catalogItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity": 4503599627370496,
            "customPrice": 4503599627370495,
            "addonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "startDate": "2023-11-07T05:31:56Z",
            "endDate": "2023-11-07T05:31:56Z",
            "selectedVariants": {},
            "manualDiscount": 4503599627370495,
            "discountCodes": {},
            "customDeposit": 4503599627370495,
            "checkoutFields": [
                {
                    "fieldId": "<string>",
                    "value": "<string>"
                }
            ],
            "customCheckoutFields": [
                {
                    "name": "<string>",
                    "value": "<string>",
                    "internal": True
                }
            ],
            "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
    ],
    "subscription": {
        "label": "<string>",
        "price": 123,
        "renewalPrice": 123,
        "commitmentCycles": 123,
        "paymentCycleAmount": 123,
        "cancellationLeadTimeAmount": 123
    },
    "subscriptionDiscounts": [
        {
            "code": "<string>",
            "value": 123,
            "subscriptionDurationCycles": 123,
            "discountPeriodTo": "<string>"
        }
    ]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: {def: '<string>'},
    customPrice: 123,
    orderCustomerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    manualDiscount: 4503599627370495,
    discountCodes: {},
    customDeposit: 4503599627370495,
    stockItems: [{inventoryArticleId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', note: '<string>'}],
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z',
    note: '<string>',
    customCheckoutFields: [{name: '<string>', value: '<string>', internal: true}],
    addonData: {type: 'cart', cartAddonId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
    addons: [
      {
        catalogItemId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        quantity: 4503599627370496,
        customPrice: 4503599627370495,
        addonId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        startDate: '2023-11-07T05:31:56Z',
        endDate: '2023-11-07T05:31:56Z',
        selectedVariants: {},
        manualDiscount: 4503599627370495,
        discountCodes: {},
        customDeposit: 4503599627370495,
        checkoutFields: [{fieldId: '<string>', value: '<string>'}],
        customCheckoutFields: [{name: '<string>', value: '<string>', internal: true}],
        orderCustomerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
      }
    ],
    subscription: {
      label: '<string>',
      price: 123,
      renewalPrice: 123,
      commitmentCycles: 123,
      paymentCycleAmount: 123,
      cancellationLeadTimeAmount: 123
    },
    subscriptionDiscounts: [
      {
        code: '<string>',
        value: 123,
        subscriptionDurationCycles: 123,
        discountPeriodTo: '<string>'
      }
    ]
  })
};

fetch('https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => [
        'def' => '<string>'
    ],
    'customPrice' => 123,
    'orderCustomerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'manualDiscount' => 4503599627370495,
    'discountCodes' => [
        
    ],
    'customDeposit' => 4503599627370495,
    'stockItems' => [
        [
                'inventoryArticleId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'note' => '<string>'
        ]
    ],
    'startDate' => '2023-11-07T05:31:56Z',
    'endDate' => '2023-11-07T05:31:56Z',
    'note' => '<string>',
    'customCheckoutFields' => [
        [
                'name' => '<string>',
                'value' => '<string>',
                'internal' => true
        ]
    ],
    'addonData' => [
        'type' => 'cart',
        'cartAddonId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'addons' => [
        [
                'catalogItemId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'quantity' => 4503599627370496,
                'customPrice' => 4503599627370495,
                'addonId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'startDate' => '2023-11-07T05:31:56Z',
                'endDate' => '2023-11-07T05:31:56Z',
                'selectedVariants' => [
                                
                ],
                'manualDiscount' => 4503599627370495,
                'discountCodes' => [
                                
                ],
                'customDeposit' => 4503599627370495,
                'checkoutFields' => [
                                [
                                                                'fieldId' => '<string>',
                                                                'value' => '<string>'
                                ]
                ],
                'customCheckoutFields' => [
                                [
                                                                'name' => '<string>',
                                                                'value' => '<string>',
                                                                'internal' => true
                                ]
                ],
                'orderCustomerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'subscription' => [
        'label' => '<string>',
        'price' => 123,
        'renewalPrice' => 123,
        'commitmentCycles' => 123,
        'paymentCycleAmount' => 123,
        'cancellationLeadTimeAmount' => 123
    ],
    'subscriptionDiscounts' => [
        [
                'code' => '<string>',
                'value' => 123,
                'subscriptionDurationCycles' => 123,
                'discountPeriodTo' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems"

	payload := strings.NewReader("{\n  \"name\": {\n    \"def\": \"<string>\"\n  },\n  \"customPrice\": 123,\n  \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manualDiscount\": 4503599627370495,\n  \"discountCodes\": {},\n  \"customDeposit\": 4503599627370495,\n  \"stockItems\": [\n    {\n      \"inventoryArticleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"note\": \"<string>\"\n    }\n  ],\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"note\": \"<string>\",\n  \"customCheckoutFields\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"internal\": true\n    }\n  ],\n  \"addonData\": {\n    \"type\": \"cart\",\n    \"cartAddonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"addons\": [\n    {\n      \"catalogItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 4503599627370496,\n      \"customPrice\": 4503599627370495,\n      \"addonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"startDate\": \"2023-11-07T05:31:56Z\",\n      \"endDate\": \"2023-11-07T05:31:56Z\",\n      \"selectedVariants\": {},\n      \"manualDiscount\": 4503599627370495,\n      \"discountCodes\": {},\n      \"customDeposit\": 4503599627370495,\n      \"checkoutFields\": [\n        {\n          \"fieldId\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"customCheckoutFields\": [\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"internal\": true\n        }\n      ],\n      \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"subscription\": {\n    \"label\": \"<string>\",\n    \"price\": 123,\n    \"renewalPrice\": 123,\n    \"commitmentCycles\": 123,\n    \"paymentCycleAmount\": 123,\n    \"cancellationLeadTimeAmount\": 123\n  },\n  \"subscriptionDiscounts\": [\n    {\n      \"code\": \"<string>\",\n      \"value\": 123,\n      \"subscriptionDurationCycles\": 123,\n      \"discountPeriodTo\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": {\n    \"def\": \"<string>\"\n  },\n  \"customPrice\": 123,\n  \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manualDiscount\": 4503599627370495,\n  \"discountCodes\": {},\n  \"customDeposit\": 4503599627370495,\n  \"stockItems\": [\n    {\n      \"inventoryArticleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"note\": \"<string>\"\n    }\n  ],\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"note\": \"<string>\",\n  \"customCheckoutFields\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"internal\": true\n    }\n  ],\n  \"addonData\": {\n    \"type\": \"cart\",\n    \"cartAddonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"addons\": [\n    {\n      \"catalogItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 4503599627370496,\n      \"customPrice\": 4503599627370495,\n      \"addonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"startDate\": \"2023-11-07T05:31:56Z\",\n      \"endDate\": \"2023-11-07T05:31:56Z\",\n      \"selectedVariants\": {},\n      \"manualDiscount\": 4503599627370495,\n      \"discountCodes\": {},\n      \"customDeposit\": 4503599627370495,\n      \"checkoutFields\": [\n        {\n          \"fieldId\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"customCheckoutFields\": [\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"internal\": true\n        }\n      ],\n      \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"subscription\": {\n    \"label\": \"<string>\",\n    \"price\": 123,\n    \"renewalPrice\": 123,\n    \"commitmentCycles\": 123,\n    \"paymentCycleAmount\": 123,\n    \"cancellationLeadTimeAmount\": 123\n  },\n  \"subscriptionDiscounts\": [\n    {\n      \"code\": \"<string>\",\n      \"value\": 123,\n      \"subscriptionDurationCycles\": 123,\n      \"discountPeriodTo\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": {\n    \"def\": \"<string>\"\n  },\n  \"customPrice\": 123,\n  \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manualDiscount\": 4503599627370495,\n  \"discountCodes\": {},\n  \"customDeposit\": 4503599627370495,\n  \"stockItems\": [\n    {\n      \"inventoryArticleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"note\": \"<string>\"\n    }\n  ],\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"note\": \"<string>\",\n  \"customCheckoutFields\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"internal\": true\n    }\n  ],\n  \"addonData\": {\n    \"type\": \"cart\",\n    \"cartAddonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  },\n  \"addons\": [\n    {\n      \"catalogItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 4503599627370496,\n      \"customPrice\": 4503599627370495,\n      \"addonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"startDate\": \"2023-11-07T05:31:56Z\",\n      \"endDate\": \"2023-11-07T05:31:56Z\",\n      \"selectedVariants\": {},\n      \"manualDiscount\": 4503599627370495,\n      \"discountCodes\": {},\n      \"customDeposit\": 4503599627370495,\n      \"checkoutFields\": [\n        {\n          \"fieldId\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"customCheckoutFields\": [\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"internal\": true\n        }\n      ],\n      \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"subscription\": {\n    \"label\": \"<string>\",\n    \"price\": 123,\n    \"renewalPrice\": 123,\n    \"commitmentCycles\": 123,\n    \"paymentCycleAmount\": 123,\n    \"cancellationLeadTimeAmount\": 123\n  },\n  \"subscriptionDiscounts\": [\n    {\n      \"code\": \"<string>\",\n      \"value\": 123,\n      \"subscriptionDurationCycles\": 123,\n      \"discountPeriodTo\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "name": {
    "def": "<string>"
  },
  "pricing": "<unknown>",
  "variants": {
    "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "variantValueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "variantLabel": "<string>",
    "variantValueLabel": "<string>"
  },
  "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "duration": "<string>",
  "startDate": "<string>",
  "endDate": "<string>",
  "returnedDate": "<string>",
  "purchaseType": "booking",
  "catalogItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "imageUrl": "<string>",
  "fulfillmentState": "pending",
  "checkoutFields": {
    "id": "<string>",
    "name": "<string>",
    "type": "text",
    "placeholder": "<string>",
    "required": true,
    "internal": true,
    "attributeId": "<string>",
    "attributeFormat": "text",
    "options": {
      "name": "<string>"
    },
    "value": "<string>",
    "checkoutFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "capturedTotal": 123,
  "refundedTotal": 123,
  "depositCapturedTotal": 123,
  "depositRefundedTotal": 123,
  "depositAuthorisedTotal": 123,
  "depositCancelledTotal": 123,
  "pricingRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "durationLabel": "<string>",
  "note": "<string>",
  "addonOfLineItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "catalogAddonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cartAddonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isAddon": "cart",
  "subscription": {
    "label": "<string>",
    "price": 123,
    "renewalPrice": 123,
    "commitmentCycles": 123,
    "paymentCycleUnit": "seconds",
    "paymentCycleAmount": 123,
    "initialChargeType": "order_creation",
    "renewalType": "none",
    "collectionMethod": "charge_automatically",
    "cancellationLeadTimeUnit": "seconds",
    "cancellationLeadTimeAmount": 123,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "orderLineItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "commitmentPeriodUnit": "seconds",
    "commitmentPeriodAmount": 123,
    "status": "active",
    "nextBillingAt": "<string>",
    "cancelAt": "<string>",
    "cancelledAt": "<string>"
  },
  "subscriptionDiscounts": {
    "code": "<string>",
    "valueType": "percentage",
    "value": 123,
    "subscriptionDuration": "once",
    "subscriptionDurationCycles": 123,
    "firstDiscountedCycleIndex": 123,
    "discountCodeId": "<string>",
    "discountPeriodTo": "<string>"
  }
}

Authorizations

X-API-KEY

string

header

required

API key for the Twice API

Path Parameters

orderId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

Body

Option 1
Option 2

name

object

required

Hide child attributes

name.def

string

required

name.{key}

string

customPrice

number

required

purchaseType

enum<string>

required

Available options:

booking,

sale,

subscription,

buyback

orderCustomerId

string<uuid>

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

manualDiscount

integer

Required range: 0 <= x <= 9007199254740991

discountCodes

object

Hide child attributes

discountCodes.{key}

object

Hide child attributes

discountCodes.{key}.quantity

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

discountCodes.{key}.totalDiscountValue

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

discountCodes.{key}.discountCodeId

string

customDeposit

integer

Security deposit for this custom line. Custom items have no catalog deposit.

Required range: 0 <= x <= 9007199254740991

stockItems

object[]

Option 1
Option 2

Hide child attributes

stockItems.inventoryArticleId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

stockItems.note

string

startDate

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

endDate

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

note

string

customCheckoutFields

object[]

Hide child attributes

customCheckoutFields.name

string

required

customCheckoutFields.type

enum<string>

required

Available options:

text,

select,

number,

checkbox,

customer_attribute

customCheckoutFields.value

customCheckoutFields.internal

boolean

addonData

object

Option 1
Option 2

Hide child attributes

addonData.type

enum<string>

required

Available options:

cart

addonData.cartAddonId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

addons

object[]

Hide child attributes

addons.catalogItemId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

addons.quantity

integer

required

Required range: 1 <= x <= 9007199254740991

addons.customPrice

integer

required

Required range: 0 <= x <= 9007199254740991

addons.addonId

string<uuid>

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

addons.purchaseType

enum<string>

Available options:

booking,

sale

addons.startDate

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

addons.endDate

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

addons.selectedVariants

object | null

Hide child attributes

addons.selectedVariants.{key}

string

addons.manualDiscount

integer

Required range: 0 <= x <= 9007199254740991

addons.discountCodes

object

Hide child attributes

addons.discountCodes.{key}

object

Hide child attributes

addons.discountCodes.{key}.quantity

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

addons.discountCodes.{key}.totalDiscountValue

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

addons.discountCodes.{key}.discountCodeId

string

addons.customDeposit

integer

Overrides the catalog-derived security deposit for this line. Omit to use the catalog item deposit.

Required range: 0 <= x <= 9007199254740991

addons.checkoutFields

object[]

Hide child attributes

addons.checkoutFields.fieldId

string

required

Checkout field id

addons.checkoutFields.value

required

addons.customCheckoutFields

object[]

Hide child attributes

addons.customCheckoutFields.name

string

required

addons.customCheckoutFields.type

enum<string>

required

Available options:

text,

select,

number,

checkbox,

customer_attribute

addons.customCheckoutFields.value

addons.customCheckoutFields.internal

boolean

addons.orderCustomerId

string<uuid>

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

subscription

object

Hide child attributes

subscription.label

string

Minimum string length: 1

subscription.price

integer

Required range: x <= 9007199254740991

subscription.renewalPrice

integer | null

Required range: x <= 9007199254740991

subscription.commitmentCycles

integer

Required range: x <= 9007199254740991

subscription.paymentCycleUnit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months,

years

subscription.paymentCycleAmount

integer

Required range: x <= 9007199254740991

subscription.initialChargeType

enum<string>

Available options:

order_creation,

subscription_start

subscription.renewalType

enum<string>

Available options:

none,

auto_renew

subscription.collectionMethod

enum<string>

Available options:

charge_automatically,

send_invoice

subscription.cancellationLeadTimeUnit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months,

years

subscription.cancellationLeadTimeAmount

integer

Required range: x <= 9007199254740991

subscriptionDiscount

object

Hide child attributes

subscriptionDiscount.code

string

required

subscriptionDiscount.valueType

enum<string>

required

Available options:

percentage,

fixed_per_order,

fixed_per_item

subscriptionDiscount.value

number

required

subscriptionDiscount.subscriptionDuration

enum<string> | null

required

Available options:

once,

repeating,

forever

subscriptionDiscount.subscriptionDurationCycles

number | null

required

subscriptionDiscount.discountPeriodTo

string | null

subscriptionDiscounts

object[]

Hide child attributes

subscriptionDiscounts.code

string

required

subscriptionDiscounts.valueType

enum<string>

required

Available options:

percentage,

fixed_per_order,

fixed_per_item

subscriptionDiscounts.value

number

required

subscriptionDiscounts.subscriptionDuration

enum<string> | null

required

Available options:

once,

repeating,

forever

subscriptionDiscounts.subscriptionDurationCycles

number | null

required

subscriptionDiscounts.discountPeriodTo

string | null

subscriptionPayNowPricing

object

Hide child attributes

subscriptionPayNowPricing.currency

string

required

subscriptionPayNowPricing.total

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

subscriptionPayNowPricing.subtotal

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

subscriptionPayNowPricing.totalTaxes

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

subscriptionPayNowPricing.totalDiscounts

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

subscriptionPayNowPricing.taxExcluded

boolean

required

subscriptionPayNowPricing.taxLines

object[]

required

Hide child attributes

subscriptionPayNowPricing.taxLines.price

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

subscriptionPayNowPricing.taxLines.rate

number

required

subscriptionPayNowPricing.taxLines.combinedLabel

object

Hide child attributes

subscriptionPayNowPricing.taxLines.combinedLabel.def

string

required

subscriptionPayNowPricing.taxLines.combinedLabel.{key}

string

subscriptionPayNowPricing.taxLines.label

object

Hide child attributes

subscriptionPayNowPricing.taxLines.label.def

string

required

subscriptionPayNowPricing.taxLines.label.{key}

string

subscriptionPayNowPricing.taxLines.taxableAmount

integer | null

Required range: -9007199254740991 <= x <= 9007199254740991

subscriptionPayNowPricing.listPrice

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

subscriptionPayNowPricing.originalListPrice

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

subscriptionPayNowPricing.additionalInfo

string

subscriptionPayNowPricing.discountCodes

object

Hide child attributes

subscriptionPayNowPricing.discountCodes.{key}

object

Hide child attributes

subscriptionPayNowPricing.discountCodes.{key}.quantity

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

subscriptionPayNowPricing.discountCodes.{key}.totalDiscountValue

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

subscriptionPayNowPricing.discountCodes.{key}.discountCodeId

string

subscriptionPayNowPricing.manualDiscount

integer

Required range: -9007199254740991 <= x <= 9007199254740991

subscriptionPayNowPricing.deposit

integer

Required range: -9007199254740991 <= x <= 9007199254740991

Response

200

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

createdAt

string

required

updatedAt

string

required

name

object

required

Hide child attributes

name.def

string

required

pricing

any

required

variants

object

Hide child attributes

variants.variantId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

variants.variantValueId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

variants.variantLabel

string

required

variants.variantValueLabel

string

required

orderCustomerId

string<uuid>

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

duration

string

startDate

string

endDate

string

returnedDate

string

purchaseType

enum<string>

Available options:

booking,

sale,

subscription,

buyback

catalogItemId

string<uuid>

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

imageUrl

string

fulfillmentState

enum<string>

Available options:

pending,

reserved,

on-hold,

ready,

cancelled,

fulfilled,

returned

checkoutFields

object

Hide child attributes

checkoutFields.id

string

required

checkoutFields.name

string

required

checkoutFields.type

enum<string>

required

Available options:

text,

select,

number,

checkbox,

customer_attribute

checkoutFields.placeholder

string

checkoutFields.required

boolean

checkoutFields.internal

boolean

checkoutFields.attributeId

string

checkoutFields.attributeFormat

enum<string>

Available options:

text,

number,

boolean,

date,

datetime,

formula,

select,

multiselect

checkoutFields.options

object

Hide child attributes

checkoutFields.options.name

string

required

checkoutFields.value

checkoutFields.checkoutFieldId

string<uuid>

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

capturedTotal

number

refundedTotal

number

depositCapturedTotal

number

depositRefundedTotal

number

depositAuthorisedTotal

number

depositCancelledTotal

number

pricingRowId

string<uuid>

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

durationLabel

string

note

string

addonOfLineItemId

string<uuid> | null

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

catalogAddonId

string<uuid> | null

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

cartAddonId

string<uuid> | null

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

isAddon

enum<string> | null

Available options:

cart,

catalog

subscription

object | null

Hide child attributes

subscription.label

string

required

Minimum string length: 1

subscription.price

integer

required

Required range: x <= 9007199254740991

subscription.renewalPrice

integer | null

required

Required range: x <= 9007199254740991

subscription.commitmentCycles

integer

required

Required range: x <= 9007199254740991

subscription.paymentCycleUnit

enum<string>

required

Available options:

seconds,

minutes,

hours,

days,

weeks,

months,

years

subscription.paymentCycleAmount

integer

required

Required range: x <= 9007199254740991

subscription.initialChargeType

enum<string>

required

Available options:

order_creation,

subscription_start

subscription.renewalType

enum<string>

required

Available options:

none,

auto_renew

subscription.collectionMethod

enum<string>

required

Available options:

charge_automatically,

send_invoice

subscription.cancellationLeadTimeUnit

enum<string>

required

Available options:

seconds,

minutes,

hours,

days,

weeks,

months,

years

subscription.cancellationLeadTimeAmount

integer

required

Required range: x <= 9007199254740991

subscription.id

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

subscription.orderLineItemId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

subscription.commitmentPeriodUnit

enum<string>

required

Available options:

seconds,

minutes,

hours,

days,

weeks,

months,

years

subscription.commitmentPeriodAmount

integer

required

Required range: x <= 9007199254740991

subscription.status

enum<string>

required

Available options:

active,

past_due,

failed,

completed,

cancelled

subscription.nextBillingAt

string | null

required

subscription.cancelAt

string | null

required

subscription.cancelledAt

string | null

required

subscriptionDiscounts

object

Hide child attributes

subscriptionDiscounts.code

string

required

subscriptionDiscounts.valueType

enum<string>

required

Available options:

percentage,

fixed_per_order,

fixed_per_item

subscriptionDiscounts.value

number

required

subscriptionDiscounts.subscriptionDuration

enum<string> | null

required

Available options:

once,

repeating,

forever

subscriptionDiscounts.subscriptionDurationCycles

number | null

required

subscriptionDiscounts.firstDiscountedCycleIndex

number

required

subscriptionDiscounts.discountCodeId

string | null

subscriptionDiscounts.discountPeriodTo

string | null