Update order item

curl --request PUT \
  --url https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems/{lineItemId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customPrice": 123,
  "customDeposit": 4503599627370495,
  "pricingRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manualDiscount": 4503599627370495,
  "startDate": "<string>",
  "endDate": "<string>",
  "note": "<string>",
  "addonOfLineItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "selectedVariants": {},
  "subscription": {
    "price": 123,
    "renewalPrice": 123,
    "commitmentCycles": 123,
    "cancellationLeadTimeAmount": 123
  }
}
'

import requests

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

payload = {
    "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customPrice": 123,
    "customDeposit": 4503599627370495,
    "pricingRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "manualDiscount": 4503599627370495,
    "startDate": "<string>",
    "endDate": "<string>",
    "note": "<string>",
    "addonOfLineItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "selectedVariants": {},
    "subscription": {
        "price": 123,
        "renewalPrice": 123,
        "commitmentCycles": 123,
        "cancellationLeadTimeAmount": 123
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    orderCustomerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customPrice: 123,
    customDeposit: 4503599627370495,
    pricingRowId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    manualDiscount: 4503599627370495,
    startDate: '<string>',
    endDate: '<string>',
    note: '<string>',
    addonOfLineItemId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    selectedVariants: {},
    subscription: {
      price: 123,
      renewalPrice: 123,
      commitmentCycles: 123,
      cancellationLeadTimeAmount: 123
    }
  })
};

fetch('https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems/{lineItemId}', 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/{lineItemId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'orderCustomerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'customPrice' => 123,
    'customDeposit' => 4503599627370495,
    'pricingRowId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'manualDiscount' => 4503599627370495,
    'startDate' => '<string>',
    'endDate' => '<string>',
    'note' => '<string>',
    'addonOfLineItemId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'selectedVariants' => [
        
    ],
    'subscription' => [
        'price' => 123,
        'renewalPrice' => 123,
        'commitmentCycles' => 123,
        'cancellationLeadTimeAmount' => 123
    ]
  ]),
  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/{lineItemId}"

	payload := strings.NewReader("{\n  \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customPrice\": 123,\n  \"customDeposit\": 4503599627370495,\n  \"pricingRowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manualDiscount\": 4503599627370495,\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"note\": \"<string>\",\n  \"addonOfLineItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"selectedVariants\": {},\n  \"subscription\": {\n    \"price\": 123,\n    \"renewalPrice\": 123,\n    \"commitmentCycles\": 123,\n    \"cancellationLeadTimeAmount\": 123\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems/{lineItemId}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customPrice\": 123,\n  \"customDeposit\": 4503599627370495,\n  \"pricingRowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manualDiscount\": 4503599627370495,\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"note\": \"<string>\",\n  \"addonOfLineItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"selectedVariants\": {},\n  \"subscription\": {\n    \"price\": 123,\n    \"renewalPrice\": 123,\n    \"commitmentCycles\": 123,\n    \"cancellationLeadTimeAmount\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customPrice\": 123,\n  \"customDeposit\": 4503599627370495,\n  \"pricingRowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manualDiscount\": 4503599627370495,\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"note\": \"<string>\",\n  \"addonOfLineItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"selectedVariants\": {},\n  \"subscription\": {\n    \"price\": 123,\n    \"renewalPrice\": 123,\n    \"commitmentCycles\": 123,\n    \"cancellationLeadTimeAmount\": 123\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>"
  }
}

PUT

admin

orders

{orderId}

lineItems

{lineItemId}

Update order item

curl --request PUT \
  --url https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems/{lineItemId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customPrice": 123,
  "customDeposit": 4503599627370495,
  "pricingRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manualDiscount": 4503599627370495,
  "startDate": "<string>",
  "endDate": "<string>",
  "note": "<string>",
  "addonOfLineItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "selectedVariants": {},
  "subscription": {
    "price": 123,
    "renewalPrice": 123,
    "commitmentCycles": 123,
    "cancellationLeadTimeAmount": 123
  }
}
'

import requests

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

payload = {
    "orderCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customPrice": 123,
    "customDeposit": 4503599627370495,
    "pricingRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "manualDiscount": 4503599627370495,
    "startDate": "<string>",
    "endDate": "<string>",
    "note": "<string>",
    "addonOfLineItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "selectedVariants": {},
    "subscription": {
        "price": 123,
        "renewalPrice": 123,
        "commitmentCycles": 123,
        "cancellationLeadTimeAmount": 123
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    orderCustomerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customPrice: 123,
    customDeposit: 4503599627370495,
    pricingRowId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    manualDiscount: 4503599627370495,
    startDate: '<string>',
    endDate: '<string>',
    note: '<string>',
    addonOfLineItemId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    selectedVariants: {},
    subscription: {
      price: 123,
      renewalPrice: 123,
      commitmentCycles: 123,
      cancellationLeadTimeAmount: 123
    }
  })
};

fetch('https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems/{lineItemId}', 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/{lineItemId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'orderCustomerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'customPrice' => 123,
    'customDeposit' => 4503599627370495,
    'pricingRowId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'manualDiscount' => 4503599627370495,
    'startDate' => '<string>',
    'endDate' => '<string>',
    'note' => '<string>',
    'addonOfLineItemId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'selectedVariants' => [
        
    ],
    'subscription' => [
        'price' => 123,
        'renewalPrice' => 123,
        'commitmentCycles' => 123,
        'cancellationLeadTimeAmount' => 123
    ]
  ]),
  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/{lineItemId}"

	payload := strings.NewReader("{\n  \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customPrice\": 123,\n  \"customDeposit\": 4503599627370495,\n  \"pricingRowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manualDiscount\": 4503599627370495,\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"note\": \"<string>\",\n  \"addonOfLineItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"selectedVariants\": {},\n  \"subscription\": {\n    \"price\": 123,\n    \"renewalPrice\": 123,\n    \"commitmentCycles\": 123,\n    \"cancellationLeadTimeAmount\": 123\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://server.twicecommerce.com/v1/admin/orders/{orderId}/lineItems/{lineItemId}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customPrice\": 123,\n  \"customDeposit\": 4503599627370495,\n  \"pricingRowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manualDiscount\": 4503599627370495,\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"note\": \"<string>\",\n  \"addonOfLineItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"selectedVariants\": {},\n  \"subscription\": {\n    \"price\": 123,\n    \"renewalPrice\": 123,\n    \"commitmentCycles\": 123,\n    \"cancellationLeadTimeAmount\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"orderCustomerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customPrice\": 123,\n  \"customDeposit\": 4503599627370495,\n  \"pricingRowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"manualDiscount\": 4503599627370495,\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"note\": \"<string>\",\n  \"addonOfLineItemId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"selectedVariants\": {},\n  \"subscription\": {\n    \"price\": 123,\n    \"renewalPrice\": 123,\n    \"commitmentCycles\": 123,\n    \"cancellationLeadTimeAmount\": 123\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)$

lineItemId

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

name

object

Hide child attributes

name.def

string

required

name.{key}

string

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)$

customPrice

number | null

customDeposit

integer | null

Required range: 0 <= x <= 9007199254740991

pricingRowId

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)$

manualDiscount

integer | null

Required range: 0 <= x <= 9007199254740991

startDate

string

endDate

string | null

purchaseType

enum<string>

Available options:

booking,

sale,

subscription,

buyback

fulfillmentState

enum<string>

Available options:

pending,

reserved,

on-hold,

ready,

cancelled,

fulfilled,

returned

checkoutFields

object

Hide child attributes

checkoutFields.id

string

required

Line item checkout field id

checkoutFields.value

required

checkoutFields.name

string

checkoutFields.type

enum<string>

Available options:

text,

select,

number,

checkbox,

customer_attribute

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

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)$

selectedVariants

object

Hide child attributes

selectedVariants.{key}

string

subscription

object

Hide child attributes

subscription.price

integer

Required range: x <= 9007199254740991

subscription.renewalPrice

integer | null

Required range: x <= 9007199254740991

subscription.commitmentCycles

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

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