List catalog items using a pricing table

curl --request GET \
  --url https://server.twicecommerce.com/v1/admin/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://server.twicecommerce.com/v1/admin/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://server.twicecommerce.com/v1/admin/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items', 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/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://server.twicecommerce.com/v1/admin/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://server.twicecommerce.com/v1/admin/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.twicecommerce.com/v1/admin/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

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

{
  "id": "<string>",
  "name": "<string>",
  "internalName": "<string>",
  "description": "<string>",
  "taxonomyCategoryId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "salesChannelAdmin": true,
  "salesChannelOnline": true,
  "salesChannelStore": true,
  "addonOnly": true,
  "addonPricePercentage": 100,
  "relatedListingIds": [
    "<string>"
  ],
  "descriptionJson": null,
  "sections": {
    "id": "<string>",
    "heading": "<unknown>",
    "content": "<unknown>",
    "orderIndex": 123
  },
  "status": "active",
  "minBookingDuration": {
    "value": 123,
    "unit": "seconds"
  },
  "maxBookingDuration": {
    "value": 123,
    "unit": "seconds"
  },
  "bookingDurationIncrement": {
    "value": 123,
    "unit": "seconds"
  },
  "orderDeadline": {
    "type": "absolute",
    "value": 123,
    "unit": "minutes"
  },
  "rules": {
    "id": "<string>",
    "label": "<string>",
    "conditions": {
      "id": "<string>",
      "label": "<string>",
      "filters": {
        "key": "attribute",
        "operator": "startsWith",
        "values": [
          "<string>"
        ],
        "attributeId": "<string>"
      },
      "quantity": 123,
      "createdAt": "2023-11-07T05:31:56Z"
    },
    "quantity": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "isVisible": true,
    "variantRules": {
      "id": "<string>",
      "variantValueId": "<string>",
      "baseRuleId": "<string>",
      "conditions": {
        "id": "<string>",
        "label": "<string>",
        "filters": {
          "key": "attribute",
          "operator": "startsWith",
          "values": [
            "<string>"
          ],
          "attributeId": "<string>"
        },
        "quantity": 123,
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "quantity": 123,
      "createdAt": "2023-11-07T05:31:56Z"
    },
    "revenueSplitRate": 123
  },
  "serviceLocationLinks": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "catalogItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "serviceLocation": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "isDefault": true,
      "isActive": true,
      "timezone": "Africa/Abidjan",
      "createdAt": "2023-11-07T05:31:56Z",
      "useAutoAssign": true,
      "publicName": "<string>",
      "description": "<string>",
      "costCenter": "<string>",
      "address": "<string>",
      "country": "<string>",
      "state": "<string>",
      "city": "<string>",
      "street": "<string>",
      "zipCode": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "openingHours": {
        "validityDateRange": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "weekday": 4,
        "specificDate": "2023-11-07T05:31:56Z",
        "timeRanges": {
          "start": "<string>",
          "end": "<string>"
        },
        "isClosed": false,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "serviceLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "fulfillmentHours": {
        "validityDateRange": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "weekday": 4,
        "specificDate": "2023-11-07T05:31:56Z",
        "timeRanges": {
          "start": "<string>",
          "end": "<string>"
        },
        "isClosed": false,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "serviceLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "scheduleType": "pickup"
      },
      "fulfillmentSettings": {
        "scheduleType": "pickup",
        "source": "opening_hours",
        "startBufferMinutes": 4503599627370495,
        "endBufferMinutes": 4503599627370495
      },
      "orderFulfillmentEnabled": true,
      "orderFulfillmentUseSpecificRules": true,
      "orderReturnsEnabled": true,
      "orderReturnsUseSpecificRules": true,
      "salesChannelAdmin": true,
      "salesChannelOnline": true,
      "salesChannelStore": true,
      "fulfillmentRules": {
        "ruleType": "fulfillment",
        "purchaseType": "booking",
        "serviceLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "inStoreEnabled": true,
        "shippingEnabled": true,
        "localDeliveryEnabled": true
      },
      "archivedAt": "2023-11-07T05:31:56Z",
      "orderNumbering": {
        "format": {
          "prefix": "<string>",
          "suffix": "<string>",
          "minNumberLength": 10,
          "padCharacter": "<string>"
        },
        "sequence": {
          "nextValue": 4503599627370495
        }
      }
    }
  },
  "pricingTables": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "catalogItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "availabilityRange": {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z"
    },
    "isDefault": true,
    "bookingsEnabled": true,
    "salesEnabled": true,
    "subscriptionsEnabled": true,
    "bookingPricingRows": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "pricingTableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "<string>",
      "weekdays": [
        4
      ],
      "timeOfDayRange": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "timeUnit": "seconds",
      "timeUnitAmount": 123,
      "timeUnitPrice": 0,
      "timeCalculation": "standard",
      "timeBasis": "rolling",
      "counterTimeUnitPrice": 0,
      "additionalTimeUnitPrice": 0,
      "additionalTimeUnitCalculationType": "add",
      "isHidden": true,
      "isDynamicPricing": true,
      "isEnabled": true,
      "translatedLabel": "<string>",
      "availabilityRange": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    },
    "salesPricingRows": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "pricingTableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "price": 4503599627370495,
      "compareAtPrice": 4503599627370495,
      "isEnabled": true,
      "availabilityRange": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    },
    "subscriptionPricingRows": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "pricingTableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "<string>",
      "price": 123,
      "commitmentCycles": 123,
      "paymentCycleUnit": "days",
      "paymentCycleAmount": 123,
      "initialChargeType": "order_creation",
      "renewalType": "none",
      "cancellationLeadTimeUnit": "hours",
      "cancellationLeadTimeAmount": 123,
      "isEnabled": true,
      "translatedLabel": "<string>",
      "collectionMethod": "charge_automatically",
      "renewalPrice": 123,
      "availabilityRange": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "isShared": true,
    "linkedCatalogItemsCount": 123,
    "variants": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "variantName": "<string>",
      "values": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "value": "<string>",
        "orderIndex": 123
      },
      "booking": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rateMultiplier": 123,
        "basePricingRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "additionalRateMultiplier": 123
      },
      "sales": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rateMultiplier": 123,
        "basePricingRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "subscription": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rateMultiplier": 123,
        "basePricingRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "rateMultiplier": 123,
      "pricingTableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "archivedAt": "2023-11-07T05:31:56Z"
  },
  "taxonomyCategory": {
    "id": "<string>",
    "name": "<string>",
    "fullName": "<string>",
    "level": 123,
    "parentId": "<string>",
    "isLeaf": true
  },
  "archivedAt": "2023-11-07T05:31:56Z",
  "inventoryTrackingEnabled": true,
  "pageTitle": "<string>",
  "metaDescription": "<string>",
  "urlHandle": "<string>",
  "slug": "<string>",
  "slugs": [
    "<string>"
  ],
  "ogTitle": "<string>",
  "ogDescription": "<string>",
  "ogImage": {
    "id": "<string>",
    "tenantId": "<string>",
    "fileUrl": "<string>",
    "mimeType": "<string>",
    "originalName": "<string>",
    "folderPath": "<string>",
    "size": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "updatedById": "<string>",
    "createdById": "<string>"
  },
  "noindex": true,
  "media": {
    "fileId": "<string>",
    "catalogItemId": "<string>",
    "orderIndex": 123,
    "media": {
      "id": "<string>",
      "tenantId": "<string>",
      "fileUrl": "<string>",
      "mimeType": "<string>",
      "originalName": "<string>",
      "folderPath": "<string>",
      "size": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "updatedById": "<string>",
      "createdById": "<string>"
    }
  },
  "documents": {
    "fileId": "<string>",
    "catalogItemId": "<string>",
    "orderIndex": 123,
    "comment": "<string>",
    "document": {
      "id": "<string>",
      "tenantId": "<string>",
      "fileUrl": "<string>",
      "mimeType": "<string>",
      "originalName": "<string>",
      "folderPath": "<string>",
      "size": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "updatedById": "<string>",
      "createdById": "<string>"
    },
    "attachToOrderConfirmation": true,
    "copyToOrder": true
  },
  "tags": {
    "id": "<string>",
    "value": "<string>",
    "scope": "inventory",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "variants": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "catalogItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "orderIndex": 123,
    "values": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>",
      "orderIndex": 123
    }
  },
  "checkoutRequirements": {
    "assignToCustomer": true,
    "fields": {
      "id": "<string>",
      "name": "<string>",
      "type": "text",
      "placeholder": "<string>",
      "required": true,
      "internal": true,
      "attributeId": "<string>",
      "attributeFormat": "text",
      "valueMasks": [
        "<string>"
      ],
      "options": {
        "name": "<string>"
      }
    }
  },
  "taxes": {
    "id": "<string>",
    "label": "<string>",
    "decimalRate": 0.5,
    "locationOverrides": {}
  },
  "aggregateData": {
    "totalCount": 123,
    "lastCreated": "2023-11-07T05:31:56Z",
    "lastUpdated": "2023-11-07T05:31:56Z"
  },
  "attributes": {
    "id": "<string>",
    "name": "<string>",
    "key": "<string>",
    "value": "<string>",
    "format": "text",
    "groupId": "<string>",
    "groupName": "<string>",
    "systemGroup": "sustainability",
    "origin": "article"
  },
  "addonPricingMode": "standalone",
  "bookingDeposit": 4503599627370495
}

GET

admin

pricing-tables

pricing-table

{pricingTableId}

connected-catalog-items

List catalog items using a pricing table

curl --request GET \
  --url https://server.twicecommerce.com/v1/admin/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://server.twicecommerce.com/v1/admin/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://server.twicecommerce.com/v1/admin/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items', 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/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://server.twicecommerce.com/v1/admin/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://server.twicecommerce.com/v1/admin/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.twicecommerce.com/v1/admin/pricing-tables/pricing-table/{pricingTableId}/connected-catalog-items")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

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

{
  "id": "<string>",
  "name": "<string>",
  "internalName": "<string>",
  "description": "<string>",
  "taxonomyCategoryId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "salesChannelAdmin": true,
  "salesChannelOnline": true,
  "salesChannelStore": true,
  "addonOnly": true,
  "addonPricePercentage": 100,
  "relatedListingIds": [
    "<string>"
  ],
  "descriptionJson": null,
  "sections": {
    "id": "<string>",
    "heading": "<unknown>",
    "content": "<unknown>",
    "orderIndex": 123
  },
  "status": "active",
  "minBookingDuration": {
    "value": 123,
    "unit": "seconds"
  },
  "maxBookingDuration": {
    "value": 123,
    "unit": "seconds"
  },
  "bookingDurationIncrement": {
    "value": 123,
    "unit": "seconds"
  },
  "orderDeadline": {
    "type": "absolute",
    "value": 123,
    "unit": "minutes"
  },
  "rules": {
    "id": "<string>",
    "label": "<string>",
    "conditions": {
      "id": "<string>",
      "label": "<string>",
      "filters": {
        "key": "attribute",
        "operator": "startsWith",
        "values": [
          "<string>"
        ],
        "attributeId": "<string>"
      },
      "quantity": 123,
      "createdAt": "2023-11-07T05:31:56Z"
    },
    "quantity": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "isVisible": true,
    "variantRules": {
      "id": "<string>",
      "variantValueId": "<string>",
      "baseRuleId": "<string>",
      "conditions": {
        "id": "<string>",
        "label": "<string>",
        "filters": {
          "key": "attribute",
          "operator": "startsWith",
          "values": [
            "<string>"
          ],
          "attributeId": "<string>"
        },
        "quantity": 123,
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "quantity": 123,
      "createdAt": "2023-11-07T05:31:56Z"
    },
    "revenueSplitRate": 123
  },
  "serviceLocationLinks": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "catalogItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "serviceLocation": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "isDefault": true,
      "isActive": true,
      "timezone": "Africa/Abidjan",
      "createdAt": "2023-11-07T05:31:56Z",
      "useAutoAssign": true,
      "publicName": "<string>",
      "description": "<string>",
      "costCenter": "<string>",
      "address": "<string>",
      "country": "<string>",
      "state": "<string>",
      "city": "<string>",
      "street": "<string>",
      "zipCode": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "openingHours": {
        "validityDateRange": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "weekday": 4,
        "specificDate": "2023-11-07T05:31:56Z",
        "timeRanges": {
          "start": "<string>",
          "end": "<string>"
        },
        "isClosed": false,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "serviceLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "fulfillmentHours": {
        "validityDateRange": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "weekday": 4,
        "specificDate": "2023-11-07T05:31:56Z",
        "timeRanges": {
          "start": "<string>",
          "end": "<string>"
        },
        "isClosed": false,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "serviceLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "scheduleType": "pickup"
      },
      "fulfillmentSettings": {
        "scheduleType": "pickup",
        "source": "opening_hours",
        "startBufferMinutes": 4503599627370495,
        "endBufferMinutes": 4503599627370495
      },
      "orderFulfillmentEnabled": true,
      "orderFulfillmentUseSpecificRules": true,
      "orderReturnsEnabled": true,
      "orderReturnsUseSpecificRules": true,
      "salesChannelAdmin": true,
      "salesChannelOnline": true,
      "salesChannelStore": true,
      "fulfillmentRules": {
        "ruleType": "fulfillment",
        "purchaseType": "booking",
        "serviceLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "inStoreEnabled": true,
        "shippingEnabled": true,
        "localDeliveryEnabled": true
      },
      "archivedAt": "2023-11-07T05:31:56Z",
      "orderNumbering": {
        "format": {
          "prefix": "<string>",
          "suffix": "<string>",
          "minNumberLength": 10,
          "padCharacter": "<string>"
        },
        "sequence": {
          "nextValue": 4503599627370495
        }
      }
    }
  },
  "pricingTables": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "catalogItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "availabilityRange": {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z"
    },
    "isDefault": true,
    "bookingsEnabled": true,
    "salesEnabled": true,
    "subscriptionsEnabled": true,
    "bookingPricingRows": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "pricingTableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "<string>",
      "weekdays": [
        4
      ],
      "timeOfDayRange": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "timeUnit": "seconds",
      "timeUnitAmount": 123,
      "timeUnitPrice": 0,
      "timeCalculation": "standard",
      "timeBasis": "rolling",
      "counterTimeUnitPrice": 0,
      "additionalTimeUnitPrice": 0,
      "additionalTimeUnitCalculationType": "add",
      "isHidden": true,
      "isDynamicPricing": true,
      "isEnabled": true,
      "translatedLabel": "<string>",
      "availabilityRange": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    },
    "salesPricingRows": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "pricingTableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "price": 4503599627370495,
      "compareAtPrice": 4503599627370495,
      "isEnabled": true,
      "availabilityRange": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    },
    "subscriptionPricingRows": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "pricingTableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "<string>",
      "price": 123,
      "commitmentCycles": 123,
      "paymentCycleUnit": "days",
      "paymentCycleAmount": 123,
      "initialChargeType": "order_creation",
      "renewalType": "none",
      "cancellationLeadTimeUnit": "hours",
      "cancellationLeadTimeAmount": 123,
      "isEnabled": true,
      "translatedLabel": "<string>",
      "collectionMethod": "charge_automatically",
      "renewalPrice": 123,
      "availabilityRange": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "isShared": true,
    "linkedCatalogItemsCount": 123,
    "variants": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "variantName": "<string>",
      "values": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "value": "<string>",
        "orderIndex": 123
      },
      "booking": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rateMultiplier": 123,
        "basePricingRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "additionalRateMultiplier": 123
      },
      "sales": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rateMultiplier": 123,
        "basePricingRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "subscription": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rateMultiplier": 123,
        "basePricingRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "rateMultiplier": 123,
      "pricingTableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "archivedAt": "2023-11-07T05:31:56Z"
  },
  "taxonomyCategory": {
    "id": "<string>",
    "name": "<string>",
    "fullName": "<string>",
    "level": 123,
    "parentId": "<string>",
    "isLeaf": true
  },
  "archivedAt": "2023-11-07T05:31:56Z",
  "inventoryTrackingEnabled": true,
  "pageTitle": "<string>",
  "metaDescription": "<string>",
  "urlHandle": "<string>",
  "slug": "<string>",
  "slugs": [
    "<string>"
  ],
  "ogTitle": "<string>",
  "ogDescription": "<string>",
  "ogImage": {
    "id": "<string>",
    "tenantId": "<string>",
    "fileUrl": "<string>",
    "mimeType": "<string>",
    "originalName": "<string>",
    "folderPath": "<string>",
    "size": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "updatedById": "<string>",
    "createdById": "<string>"
  },
  "noindex": true,
  "media": {
    "fileId": "<string>",
    "catalogItemId": "<string>",
    "orderIndex": 123,
    "media": {
      "id": "<string>",
      "tenantId": "<string>",
      "fileUrl": "<string>",
      "mimeType": "<string>",
      "originalName": "<string>",
      "folderPath": "<string>",
      "size": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "updatedById": "<string>",
      "createdById": "<string>"
    }
  },
  "documents": {
    "fileId": "<string>",
    "catalogItemId": "<string>",
    "orderIndex": 123,
    "comment": "<string>",
    "document": {
      "id": "<string>",
      "tenantId": "<string>",
      "fileUrl": "<string>",
      "mimeType": "<string>",
      "originalName": "<string>",
      "folderPath": "<string>",
      "size": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "updatedById": "<string>",
      "createdById": "<string>"
    },
    "attachToOrderConfirmation": true,
    "copyToOrder": true
  },
  "tags": {
    "id": "<string>",
    "value": "<string>",
    "scope": "inventory",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "variants": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "catalogItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "orderIndex": 123,
    "values": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>",
      "orderIndex": 123
    }
  },
  "checkoutRequirements": {
    "assignToCustomer": true,
    "fields": {
      "id": "<string>",
      "name": "<string>",
      "type": "text",
      "placeholder": "<string>",
      "required": true,
      "internal": true,
      "attributeId": "<string>",
      "attributeFormat": "text",
      "valueMasks": [
        "<string>"
      ],
      "options": {
        "name": "<string>"
      }
    }
  },
  "taxes": {
    "id": "<string>",
    "label": "<string>",
    "decimalRate": 0.5,
    "locationOverrides": {}
  },
  "aggregateData": {
    "totalCount": 123,
    "lastCreated": "2023-11-07T05:31:56Z",
    "lastUpdated": "2023-11-07T05:31:56Z"
  },
  "attributes": {
    "id": "<string>",
    "name": "<string>",
    "key": "<string>",
    "value": "<string>",
    "format": "text",
    "groupId": "<string>",
    "groupName": "<string>",
    "systemGroup": "sustainability",
    "origin": "article"
  },
  "addonPricingMode": "standalone",
  "bookingDeposit": 4503599627370495
}

Authorizations

X-API-KEY

string

header

required

API key for the Twice API

Path Parameters

pricingTableId

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

Response

200

string

required

name

string

required

internalName

string | null

required

description

string | null

required

taxonomyCategoryId

string | null

required

createdAt

string<date-time>

required

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

salesChannelAdmin

boolean

required

salesChannelOnline

boolean

required

salesChannelStore

boolean

required

addonOnly

boolean

required

addonPricePercentage

integer | null

required

Required range: 1 <= x <= 200

descriptionJson

unknown

sections

object | null

Hide child attributes

sections.id

string

required

sections.heading

any

required

sections.content

any

required

sections.orderIndex

number

required

status

enum<string>

Available options:

active,

draft,

template

minBookingDuration

object | null

Hide child attributes

minBookingDuration.value

integer

required

Required range: x <= 9007199254740991

minBookingDuration.unit

enum<string>

required

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

maxBookingDuration

object | null

Hide child attributes

maxBookingDuration.value

integer

required

Required range: x <= 9007199254740991

maxBookingDuration.unit

enum<string>

required

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

bookingDurationIncrement

object | null

Hide child attributes

bookingDurationIncrement.value

integer

required

Required range: x <= 9007199254740991

bookingDurationIncrement.unit

enum<string>

required

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

orderDeadline

object

Option 1
Option 2

Hide child attributes

orderDeadline.type

enum<string>

required

Available options:

absolute

orderDeadline.value

integer

required

Required range: x <= 9007199254740991

orderDeadline.unit

enum<string>

required

Available options:

minutes,

hours,

days

rules

object

Hide child attributes

rules.id

string

required

rules.label

string

required

rules.conditions

object

required

Hide child attributes

rules.conditions.id

string

required

rules.conditions.label

string

required

rules.conditions.filters

object | null

required

Hide child attributes

rules.conditions.filters.key

enum<string>

required

Available options:

attribute,

item_code,

sku_code,

item_name,

sku_name

rules.conditions.filters.operator

enum<string>

required

Available options:

startsWith,

endsWith,

contains,

doesNotContain,

eq,

ne,

gt,

gte,

lt,

lte,

inArray,

notInArray,

between,

notBetween,

isEmpty,

isNotEmpty

rules.conditions.filters.values

(string | number | boolean)[]

required

rules.conditions.filters.attributeId

string

rules.conditions.quantity

number

required

rules.conditions.createdAt

string<date-time>

required

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

rules.quantity

number

required

rules.createdAt

string<date-time>

required

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

rules.isVisible

boolean

required

rules.variantRules

object

Hide child attributes

rules.variantRules.id

string

required

rules.variantRules.variantValueId

string

required

rules.variantRules.baseRuleId

string

required

rules.variantRules.conditions

object

required

Hide child attributes

rules.variantRules.conditions.id

string

required

rules.variantRules.conditions.label

string

required

rules.variantRules.conditions.filters

object | null

required

Hide child attributes

rules.variantRules.conditions.filters.key

enum<string>

required

Available options:

attribute,

item_code,

sku_code,

item_name,

sku_name

rules.variantRules.conditions.filters.operator

enum<string>

required

Available options:

startsWith,

endsWith,

contains,

doesNotContain,

eq,

ne,

gt,

gte,

lt,

lte,

inArray,

notInArray,

between,

notBetween,

isEmpty,

isNotEmpty

rules.variantRules.conditions.filters.values

(string | number | boolean)[]

required

rules.variantRules.conditions.filters.attributeId

string

rules.variantRules.conditions.quantity

number

required

rules.variantRules.conditions.createdAt

string<date-time>

required

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

rules.variantRules.quantity

number

required

rules.variantRules.createdAt

string<date-time>

required

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

rules.revenueSplitRate

number | null

serviceLocationLinks

object

Hide child attributes

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

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

serviceLocationLinks.serviceLocationId

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

serviceLocationLinks.createdAt

string<date-time>

required

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

serviceLocationLinks.serviceLocation

object

Hide child attributes

serviceLocationLinks.serviceLocation.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)$

serviceLocationLinks.serviceLocation.name

string

required

serviceLocationLinks.serviceLocation.isDefault

boolean

required

serviceLocationLinks.serviceLocation.isActive

boolean

required

serviceLocationLinks.serviceLocation.timezone

enum<string>

required

Available options:

Africa/Abidjan,

Africa/Accra,

Brazil/Acre,

Australia/ACT,

America/Adak,

Africa/Addis_Ababa,

Australia/Adelaide,

Asia/Aden,

US/Alaska,

US/Aleutian,

Africa/Algiers,

Asia/Almaty,

Asia/Amman,

Europe/Amsterdam,

Asia/Anadyr,

America/Anchorage,

Europe/Andorra,

America/Anguilla,

Indian/Antananarivo,

America/Antigua,

Pacific/Apia,

Asia/Aqtau,

Asia/Aqtobe,

America/Araguaina,

US/Arizona,

America/Aruba,

Asia/Ashgabat,

Asia/Ashkhabad,

Africa/Asmara,

Africa/Asmera,

Europe/Astrakhan,

America/Asuncion,

Europe/Athens,

America/Atikokan,

America/Atka,

Canada/Atlantic,

Asia/Atyrau,

Pacific/Auckland,

Atlantic/Azores,

Asia/Baghdad,

America/Bahia,

America/Bahia_Banderas,

Asia/Bahrain,

Mexico/BajaNorte,

Mexico/BajaSur,

Asia/Baku,

Africa/Bamako,

Asia/Bangkok,

Africa/Bangui,

Africa/Banjul,

America/Barbados,

Asia/Barnaul,

Asia/Beirut,

America/Belem,

Europe/Belfast,

Europe/Belgrade,

America/Belize,

Europe/Berlin,

Atlantic/Bermuda,

America/North_Dakota/Beulah,

Asia/Bishkek,

Africa/Bissau,

America/Blanc-Sablon,

Africa/Blantyre,

America/Boa_Vista,

America/Bogota,

America/Boise,

Pacific/Bougainville,

Europe/Bratislava,

Africa/Brazzaville,

Australia/Brisbane,

Australia/Broken_Hill,

Asia/Brunei,

Europe/Brussels,

Europe/Bucharest,

Europe/Budapest,

America/Buenos_Aires,

America/Argentina/Buenos_Aires,

Africa/Bujumbura,

Europe/Busingen,

Africa/Cairo,

Asia/Calcutta,

America/Cambridge_Bay,

America/Campo_Grande,

Atlantic/Canary,

Australia/Canberra,

America/Cancun,

Atlantic/Cape_Verde,

America/Caracas,

Africa/Casablanca,

Antarctica/Casey,

America/Catamarca,

America/Argentina/Catamarca,

America/Cayenne,

America/Cayman,

America/North_Dakota/Center,

US/Central,

Canada/Central,

CET,

Africa/Ceuta,

Indian/Chagos,

Pacific/Chatham,

America/Chicago,

America/Chihuahua,

Europe/Chisinau,

Asia/Chita,

Asia/Choibalsan,

Asia/Chongqing,

Indian/Christmas,

Asia/Chungking,

Pacific/Chuuk,

Indian/Cocos,

Asia/Colombo,

America/Argentina/ComodRivadavia,

Indian/Comoro,

Africa/Conakry,

Chile/Continental,

Europe/Copenhagen,

America/Coral_Harbour,

America/Cordoba,

America/Argentina/Cordoba,

America/Costa_Rica,

America/Creston,

CST6CDT,

Cuba,

America/Cuiaba,

America/Curacao,

Australia/Currie,

Asia/Dacca,

Africa/Dakar,

Asia/Damascus,

America/Danmarkshavn,

Africa/Dar_es_Salaam,

Australia/Darwin,

Antarctica/Davis,

America/Dawson,

America/Dawson_Creek,

Brazil/DeNoronha,

America/Denver,

America/Detroit,

Asia/Dhaka,

Asia/Dili,

Africa/Djibouti,

America/Dominica,

Africa/Douala,

Asia/Dubai,

Europe/Dublin,

Antarctica/DumontDUrville,

Asia/Dushanbe,

Brazil/East,

US/East-Indiana,

Pacific/Easter,

Chile/EasterIsland,

US/Eastern,

Canada/Eastern,

America/Edmonton,

EET,

Pacific/Efate,

Egypt,

Eire,

America/Eirunepe,

Africa/El_Aaiun,

America/El_Salvador,

Pacific/Enderbury,

America/Ensenada,

EST,

EST5EDT,

Australia/Eucla,

Atlantic/Faeroe,

Pacific/Fakaofo,

Asia/Famagusta,

Atlantic/Faroe,

Pacific/Fiji,

America/Fort_Nelson,

America/Fort_Wayne,

America/Fortaleza,

Africa/Freetown,

Pacific/Funafuti,

Africa/Gaborone,

Pacific/Galapagos,

Pacific/Gambier,

Asia/Gaza,

GB,

GB-Eire,

Mexico/General,

Europe/Gibraltar,

America/Glace_Bay,

Etc/GMT,

GMT,

GMT-0,

Etc/GMT-0,

Etc/GMT-1,

Etc/GMT-10,

Etc/GMT-11,

Etc/GMT-12,

Etc/GMT-13,

Etc/GMT-14,

Etc/GMT-2,

Etc/GMT-3,

Etc/GMT-4,

Etc/GMT-5,

Etc/GMT-6,

Etc/GMT-7,

Etc/GMT-8,

Etc/GMT-9,

Etc/GMT+0,

GMT+0,

Etc/GMT+1,

Etc/GMT+10,

Etc/GMT+11,

Etc/GMT+12,

Etc/GMT+2,

Etc/GMT+3,

Etc/GMT+4,

Etc/GMT+5,

Etc/GMT+6,

Etc/GMT+7,

Etc/GMT+8,

Etc/GMT+9,

Etc/GMT0,

GMT0,

America/Godthab,

America/Goose_Bay,

America/Grand_Turk,

Etc/Greenwich,

Greenwich,

America/Grenada,

Pacific/Guadalcanal,

America/Guadeloupe,

Pacific/Guam,

America/Guatemala,

America/Guayaquil,

Europe/Guernsey,

America/Guyana,

America/Halifax,

Africa/Harare,

Asia/Harbin,

America/Havana,

US/Hawaii,

Asia/Hebron,

Europe/Helsinki,

America/Hermosillo,

Asia/Ho_Chi_Minh,

Australia/Hobart,

Asia/Hong_Kong,

Hongkong,

Pacific/Honolulu,

Asia/Hovd,

HST,

Iceland,

US/Indiana-Starke,

America/Indiana/Indianapolis,

America/Indianapolis,

America/Inuvik,

America/Iqaluit,

Iran,

Asia/Irkutsk,

Europe/Isle_of_Man,

Israel,

Asia/Istanbul,

Europe/Istanbul,

Asia/Jakarta,

Jamaica,

America/Jamaica,

Atlantic/Jan_Mayen,

Japan,

Asia/Jayapura,

Europe/Jersey,

Asia/Jerusalem,

Africa/Johannesburg,

Pacific/Johnston,

Africa/Juba,

America/Jujuy,

America/Argentina/Jujuy,

America/Juneau,

Asia/Kabul,

Europe/Kaliningrad,

Asia/Kamchatka,

Africa/Kampala,

Asia/Karachi,

Asia/Kashgar,

Asia/Kathmandu,

Asia/Katmandu,

Indian/Kerguelen,

Asia/Khandyga,

Africa/Khartoum,

Europe/Kiev,

Africa/Kigali,

Africa/Kinshasa,

Pacific/Kiritimati,

Europe/Kirov,

America/Indiana/Knox,

America/Knox_IN,

Asia/Kolkata,

Pacific/Kosrae,

America/Kralendijk,

Asia/Krasnoyarsk,

Asia/Kuala_Lumpur,

Asia/Kuching,

Asia/Kuwait,

Kwajalein,

Pacific/Kwajalein,

America/La_Paz,

America/Argentina/La_Rioja,

Africa/Lagos,

Australia/LHI,

Africa/Libreville,

Libya,

America/Lima,

Australia/Lindeman,

Europe/Lisbon,

Europe/Ljubljana,

Africa/Lome,

Europe/London,

Arctic/Longyearbyen,

Australia/Lord_Howe,

America/Los_Angeles,

America/Louisville,

America/Kentucky/Louisville,

America/Lower_Princes,

Africa/Luanda,

Africa/Lubumbashi,

Africa/Lusaka,

Europe/Luxembourg,

Asia/Macao,

Asia/Macau,

America/Maceio,

Antarctica/Macquarie,

Atlantic/Madeira,

Europe/Madrid,

Asia/Magadan,

Indian/Mahe,

Pacific/Majuro,

Asia/Makassar,

Africa/Malabo,

Indian/Maldives,

Europe/Malta,

America/Managua,

America/Manaus,

Asia/Manila,

Africa/Maputo,

America/Indiana/Marengo,

Europe/Mariehamn,

America/Marigot,

Pacific/Marquesas,

America/Martinique,

Africa/Maseru,

America/Matamoros,

Indian/Mauritius,

Antarctica/Mawson,

Indian/Mayotte,

America/Mazatlan,

Africa/Mbabane,

Antarctica/McMurdo,

Australia/Melbourne,

America/Mendoza,

America/Argentina/Mendoza,

America/Menominee,

America/Merida,

MET,

America/Metlakatla,

America/Mexico_City,

US/Michigan,

Pacific/Midway,

Europe/Minsk,

America/Miquelon,

Africa/Mogadishu,

Europe/Monaco,

America/Moncton,

Africa/Monrovia,

America/Monterrey,

America/Montevideo,

America/Kentucky/Monticello,

America/Montreal,

America/Montserrat,

Europe/Moscow,

US/Mountain,

Canada/Mountain,

MST,

MST7MDT,

Asia/Muscat,

Africa/Nairobi,

America/Nassau,

Pacific/Nauru,

Navajo,

Africa/Ndjamena,

America/North_Dakota/New_Salem,

America/New_York,

Canada/Newfoundland,

Africa/Niamey,

Europe/Nicosia,

Asia/Nicosia,

America/Nipigon,

Pacific/Niue,

America/Nome,

Pacific/Norfolk,

America/Noronha,

Australia/North,

Africa/Nouakchott,

Pacific/Noumea,

Asia/Novokuznetsk,

Asia/Novosibirsk,

Australia/NSW,

America/Nuuk,

NZ,

NZ-CHAT,

America/Ojinaga,

Asia/Omsk,

Asia/Oral,

Europe/Oslo,

Africa/Ouagadougou,

US/Pacific,

Canada/Pacific,

Pacific/Pago_Pago,

Pacific/Palau,

Antarctica/Palmer,

America/Panama,

America/Pangnirtung,

America/Paramaribo,

Europe/Paris,

Australia/Perth,

America/Indiana/Petersburg,

Asia/Phnom_Penh,

America/Phoenix,

Pacific/Pitcairn,

Europe/Podgorica,

Pacific/Pohnpei,

Poland,

Pacific/Ponape,

Asia/Pontianak,

Pacific/Port_Moresby,

America/Port_of_Spain,

America/Port-au-Prince,

America/Porto_Acre,

America/Porto_Velho,

Africa/Porto-Novo,

Portugal,

Europe/Prague,

PRC,

PST8PDT,

America/Puerto_Rico,

America/Punta_Arenas,

Asia/Pyongyang,

Asia/Qatar,

Asia/Qostanay,

Australia/Queensland,

Asia/Qyzylorda,

America/Rainy_River,

Asia/Rangoon,

America/Rankin_Inlet,

Pacific/Rarotonga,

America/Recife,

America/Regina,

America/Resolute,

Indian/Reunion,

Atlantic/Reykjavik,

Europe/Riga,

America/Rio_Branco,

America/Argentina/Rio_Gallegos,

Asia/Riyadh,

ROC,

ROK,

Europe/Rome,

America/Rosario,

Antarctica/Rothera,

Asia/Saigon,

Pacific/Saipan,

Asia/Sakhalin,

America/Argentina/Salta,

Europe/Samara,

Asia/Samarkand,

Pacific/Samoa,

US/Samoa,

America/Argentina/San_Juan,

America/Argentina/San_Luis,

Europe/San_Marino,

America/Santa_Isabel,

America/Santarem,

America/Santiago,

America/Santo_Domingo,

America/Sao_Paulo,

Africa/Sao_Tome,

Europe/Sarajevo,

Europe/Saratov,

Canada/Saskatchewan,

America/Scoresbysund,

Asia/Seoul,

Asia/Shanghai,

America/Shiprock,

Europe/Simferopol,

Asia/Singapore,

Singapore,

America/Sitka,

Europe/Skopje,

Europe/Sofia,

Australia/South,

Atlantic/South_Georgia,

Antarctica/South_Pole,

Asia/Srednekolymsk,

America/St_Barthelemy,

Atlantic/St_Helena,

America/St_Johns,

America/St_Kitts,

America/St_Lucia,

America/St_Thomas,

America/St_Vincent,

Atlantic/Stanley,

Europe/Stockholm,

America/Swift_Current,

Australia/Sydney,

Antarctica/Syowa,

Pacific/Tahiti,

Asia/Taipei,

Europe/Tallinn,

Pacific/Tarawa,

Asia/Tashkent,

Australia/Tasmania,

Asia/Tbilisi,

America/Tegucigalpa,

Asia/Tehran,

Asia/Tel_Aviv,

America/Indiana/Tell_City,

Asia/Thimbu,

Asia/Thimphu,

America/Thule,

America/Thunder_Bay,

America/Tijuana,

Africa/Timbuktu,

Europe/Tirane,

Europe/Tiraspol,

Asia/Tokyo,

Asia/Tomsk,

Pacific/Tongatapu,

America/Toronto,

America/Tortola,

Africa/Tripoli,

Antarctica/Troll,

Pacific/Truk,

America/Argentina/Tucuman,

Africa/Tunis,

Turkey,

Etc/UCT,

UCT,

Asia/Ujung_Pandang,

Asia/Ulaanbaatar,

Asia/Ulan_Bator,

Europe/Ulyanovsk,

Etc/Universal,

Universal,

Asia/Urumqi,

America/Argentina/Ushuaia,

Asia/Ust-Nera,

UTC,

Etc/UTC,

Europe/Uzhgorod,

Europe/Vaduz,

America/Vancouver,

Europe/Vatican,

America/Indiana/Vevay,

Australia/Victoria,

Europe/Vienna,

Asia/Vientiane,

Europe/Vilnius,

America/Indiana/Vincennes,

America/Virgin,

Asia/Vladivostok,

Europe/Volgograd,

Antarctica/Vostok,

W-SU,

Pacific/Wake,

Pacific/Wallis,

Europe/Warsaw,

Brazil/West,

Australia/West,

WET,

America/Whitehorse,

America/Indiana/Winamac,

Africa/Windhoek,

America/Winnipeg,

America/Yakutat,

Asia/Yakutsk,

Australia/Yancowinna,

Asia/Yangon,

Pacific/Yap,

Asia/Yekaterinburg,

America/Yellowknife,

Asia/Yerevan,

Canada/Yukon,

Europe/Zagreb,

Europe/Zaporozhye,

Etc/Zulu,

Zulu,

Europe/Zurich

serviceLocationLinks.serviceLocation.createdAt

string<date-time>

required

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

serviceLocationLinks.serviceLocation.useAutoAssign

boolean

required

serviceLocationLinks.serviceLocation.publicName

string | null

serviceLocationLinks.serviceLocation.description

string | null

serviceLocationLinks.serviceLocation.costCenter

string | null

serviceLocationLinks.serviceLocation.address

string | null

serviceLocationLinks.serviceLocation.country

string | null

serviceLocationLinks.serviceLocation.state

string | null

serviceLocationLinks.serviceLocation.city

string | null

serviceLocationLinks.serviceLocation.street

string | null

serviceLocationLinks.serviceLocation.zipCode

string | null

serviceLocationLinks.serviceLocation.email

string | null

serviceLocationLinks.serviceLocation.phone

string | null

serviceLocationLinks.serviceLocation.openingHours

object | null

Hide child attributes

serviceLocationLinks.serviceLocation.openingHours.validityDateRange

object | null

required

Hide child attributes

serviceLocationLinks.serviceLocation.openingHours.validityDateRange.start

string<date-time>

required

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

serviceLocationLinks.serviceLocation.openingHours.validityDateRange.end

string<date-time>

required

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

serviceLocationLinks.serviceLocation.openingHours.weekday

number | null

required

Required range: 1 <= x <= 7

serviceLocationLinks.serviceLocation.openingHours.specificDate

string<date-time> | null

required

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

serviceLocationLinks.serviceLocation.openingHours.timeRanges

object | null

required

Hide child attributes

serviceLocationLinks.serviceLocation.openingHours.timeRanges.start

string

required

serviceLocationLinks.serviceLocation.openingHours.timeRanges.end

string

required

serviceLocationLinks.serviceLocation.openingHours.isClosed

boolean

default:false

required

serviceLocationLinks.serviceLocation.openingHours.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)$

serviceLocationLinks.serviceLocation.openingHours.serviceLocationId

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

serviceLocationLinks.serviceLocation.openingHours.createdAt

string<date-time>

required

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

serviceLocationLinks.serviceLocation.fulfillmentHours

object | null

Hide child attributes

serviceLocationLinks.serviceLocation.fulfillmentHours.validityDateRange

object | null

required

Hide child attributes

serviceLocationLinks.serviceLocation.fulfillmentHours.validityDateRange.start

string<date-time>

required

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

serviceLocationLinks.serviceLocation.fulfillmentHours.validityDateRange.end

string<date-time>

required

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

serviceLocationLinks.serviceLocation.fulfillmentHours.weekday

number | null

required

Required range: 1 <= x <= 7

serviceLocationLinks.serviceLocation.fulfillmentHours.specificDate

string<date-time> | null

required

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

serviceLocationLinks.serviceLocation.fulfillmentHours.timeRanges

object | null

required

Hide child attributes

serviceLocationLinks.serviceLocation.fulfillmentHours.timeRanges.start

string

required

serviceLocationLinks.serviceLocation.fulfillmentHours.timeRanges.end

string

required

serviceLocationLinks.serviceLocation.fulfillmentHours.isClosed

boolean

default:false

required

serviceLocationLinks.serviceLocation.fulfillmentHours.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)$

serviceLocationLinks.serviceLocation.fulfillmentHours.serviceLocationId

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

serviceLocationLinks.serviceLocation.fulfillmentHours.createdAt

string<date-time>

required

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

serviceLocationLinks.serviceLocation.fulfillmentHours.scheduleType

enum<string>

required

Available options:

pickup,

dropoff

serviceLocationLinks.serviceLocation.fulfillmentSettings

object | null

Hide child attributes

serviceLocationLinks.serviceLocation.fulfillmentSettings.scheduleType

enum<string>

required

Available options:

pickup,

dropoff

serviceLocationLinks.serviceLocation.fulfillmentSettings.source

enum<string>

required

Available options:

opening_hours,

offset,

custom

serviceLocationLinks.serviceLocation.fulfillmentSettings.startBufferMinutes

integer

required

Required range: 0 <= x <= 9007199254740991

serviceLocationLinks.serviceLocation.fulfillmentSettings.endBufferMinutes

integer

required

Required range: 0 <= x <= 9007199254740991

serviceLocationLinks.serviceLocation.orderFulfillmentEnabled

boolean

serviceLocationLinks.serviceLocation.orderFulfillmentUseSpecificRules

boolean

serviceLocationLinks.serviceLocation.orderReturnsEnabled

boolean

serviceLocationLinks.serviceLocation.orderReturnsUseSpecificRules

boolean

serviceLocationLinks.serviceLocation.salesChannelAdmin

boolean

serviceLocationLinks.serviceLocation.salesChannelOnline

boolean

serviceLocationLinks.serviceLocation.salesChannelStore

boolean

serviceLocationLinks.serviceLocation.fulfillmentRules

object | null

Hide child attributes

serviceLocationLinks.serviceLocation.fulfillmentRules.ruleType

enum<string>

required

Available options:

fulfillment,

order_return

serviceLocationLinks.serviceLocation.fulfillmentRules.purchaseType

enum<string>

required

Available options:

booking,

sales,

subscription,

buyback

serviceLocationLinks.serviceLocation.fulfillmentRules.serviceLocationId

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

serviceLocationLinks.serviceLocation.fulfillmentRules.inStoreEnabled

boolean

serviceLocationLinks.serviceLocation.fulfillmentRules.shippingEnabled

boolean

serviceLocationLinks.serviceLocation.fulfillmentRules.localDeliveryEnabled

boolean

serviceLocationLinks.serviceLocation.archivedAt

string<date-time> | null

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

serviceLocationLinks.serviceLocation.orderNumbering

object | null

Hide child attributes

serviceLocationLinks.serviceLocation.orderNumbering.format

object | null

required

Hide child attributes

serviceLocationLinks.serviceLocation.orderNumbering.format.prefix

string | null

Maximum string length: 16

serviceLocationLinks.serviceLocation.orderNumbering.format.suffix

string | null

Maximum string length: 16

serviceLocationLinks.serviceLocation.orderNumbering.format.minNumberLength

integer | null

Required range: 0 <= x <= 20

serviceLocationLinks.serviceLocation.orderNumbering.format.padCharacter

string | null

Maximum string length: 1

serviceLocationLinks.serviceLocation.orderNumbering.sequence

object | null

Hide child attributes

serviceLocationLinks.serviceLocation.orderNumbering.sequence.nextValue

integer

required

Required range: 0 <= x <= 9007199254740991

pricingTables

object

Hide child attributes

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

pricingTables.catalogItemId

string<uuid> | null

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

pricingTables.label

string

required

pricingTables.availabilityRange

object | null

required

Hide child attributes

pricingTables.availabilityRange.start

string<date-time> | null

required

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

pricingTables.availabilityRange.end

string<date-time> | null

required

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

pricingTables.isDefault

boolean

required

pricingTables.bookingsEnabled

boolean

required

pricingTables.salesEnabled

boolean

required

pricingTables.subscriptionsEnabled

boolean

required

pricingTables.bookingPricingRows

object

required

Hide child attributes

pricingTables.bookingPricingRows.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)$

pricingTables.bookingPricingRows.pricingTableId

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

pricingTables.bookingPricingRows.label

string

required

pricingTables.bookingPricingRows.weekdays

integer[] | null

required

Required range: 1 <= x <= 7

pricingTables.bookingPricingRows.timeOfDayRange

object | null

required

Hide child attributes

pricingTables.bookingPricingRows.timeOfDayRange.start

string<date-time> | null

required

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

pricingTables.bookingPricingRows.timeOfDayRange.end

string<date-time> | null

required

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

pricingTables.bookingPricingRows.timeUnit

enum<string>

required

Available options:

seconds,

minutes,

hours,

days,

weeks,

months,

years

pricingTables.bookingPricingRows.timeUnitAmount

integer

required

Required range: x <= 9007199254740991

pricingTables.bookingPricingRows.timeUnitPrice

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

pricingTables.bookingPricingRows.timeCalculation

enum<string>

required

Available options:

standard,

cap_to_closing

pricingTables.bookingPricingRows.timeBasis

enum<string>

required

Available options:

rolling,

capped

pricingTables.bookingPricingRows.counterTimeUnitPrice

integer | null

required

Required range: -9007199254740991 <= x <= 9007199254740991

pricingTables.bookingPricingRows.additionalTimeUnitPrice

integer | null

required

Required range: -9007199254740991 <= x <= 9007199254740991

pricingTables.bookingPricingRows.additionalTimeUnitCalculationType

enum<string>

required

Available options:

add,

multiply

pricingTables.bookingPricingRows.isHidden

boolean

required

pricingTables.bookingPricingRows.isDynamicPricing

boolean

required

pricingTables.bookingPricingRows.isEnabled

boolean

required

pricingTables.bookingPricingRows.translatedLabel

string

pricingTables.bookingPricingRows.availabilityRange

object | null

Hide child attributes

pricingTables.bookingPricingRows.availabilityRange.start

string<date-time> | null

required

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

pricingTables.bookingPricingRows.availabilityRange.end

string<date-time> | null

required

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

pricingTables.salesPricingRows

object

required

Hide child attributes

pricingTables.salesPricingRows.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)$

pricingTables.salesPricingRows.pricingTableId

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

pricingTables.salesPricingRows.price

integer

required

Required range: 0 <= x <= 9007199254740991

pricingTables.salesPricingRows.compareAtPrice

integer | null

required

Required range: 0 <= x <= 9007199254740991

pricingTables.salesPricingRows.isEnabled

boolean

required

pricingTables.salesPricingRows.availabilityRange

object | null

Hide child attributes

pricingTables.salesPricingRows.availabilityRange.start

string<date-time> | null

required

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

pricingTables.salesPricingRows.availabilityRange.end

string<date-time> | null

required

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

pricingTables.subscriptionPricingRows

object

required

Hide child attributes

pricingTables.subscriptionPricingRows.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)$

pricingTables.subscriptionPricingRows.pricingTableId

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

pricingTables.subscriptionPricingRows.label

string

required

Minimum string length: 1

pricingTables.subscriptionPricingRows.price

integer

required

Required range: x <= 9007199254740991

pricingTables.subscriptionPricingRows.commitmentCycles

integer

required

Required range: x <= 9007199254740991

pricingTables.subscriptionPricingRows.paymentCycleUnit

enum<string>

required

Available options:

days,

weeks,

months,

years

pricingTables.subscriptionPricingRows.paymentCycleAmount

integer

required

Required range: x <= 9007199254740991

pricingTables.subscriptionPricingRows.initialChargeType

enum<string>

required

Available options:

order_creation,

subscription_start

pricingTables.subscriptionPricingRows.renewalType

enum<string>

required

Available options:

none,

auto_renew

pricingTables.subscriptionPricingRows.cancellationLeadTimeUnit

enum<string>

required

Available options:

hours,

days,

weeks,

months,

years

pricingTables.subscriptionPricingRows.cancellationLeadTimeAmount

integer

required

Required range: x <= 9007199254740991

pricingTables.subscriptionPricingRows.isEnabled

boolean

required

pricingTables.subscriptionPricingRows.translatedLabel

string

pricingTables.subscriptionPricingRows.collectionMethod

enum<string>

Available options:

charge_automatically,

send_invoice

pricingTables.subscriptionPricingRows.renewalPrice

integer | null

Required range: x <= 9007199254740991

pricingTables.subscriptionPricingRows.availabilityRange

object | null

Hide child attributes

pricingTables.subscriptionPricingRows.availabilityRange.start

string<date-time> | null

required

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

pricingTables.subscriptionPricingRows.availabilityRange.end

string<date-time> | null

required

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

pricingTables.createdAt

string<date-time>

required

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

pricingTables.isShared

boolean

required

pricingTables.linkedCatalogItemsCount

number

required

pricingTables.variants

object

Hide child attributes

pricingTables.variants.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)$

pricingTables.variants.variantName

string

required

pricingTables.variants.values

object

required

Hide child attributes

pricingTables.variants.values.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)$

pricingTables.variants.values.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)$

pricingTables.variants.values.value

string

required

pricingTables.variants.values.orderIndex

number

required

pricingTables.variants.booking

object

required

Hide child attributes

pricingTables.variants.booking.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)$

pricingTables.variants.booking.rateMultiplier

number

required

pricingTables.variants.booking.basePricingRowId

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

pricingTables.variants.booking.additionalRateMultiplier

number

pricingTables.variants.sales

object

required

Hide child attributes

pricingTables.variants.sales.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)$

pricingTables.variants.sales.rateMultiplier

number

required

pricingTables.variants.sales.basePricingRowId

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

pricingTables.variants.subscription

object

required

Hide child attributes

pricingTables.variants.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)$

pricingTables.variants.subscription.rateMultiplier

number

required

pricingTables.variants.subscription.basePricingRowId

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

pricingTables.variants.rateMultiplier

number

required

pricingTables.variants.pricingTableId

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

pricingTables.archivedAt

string<date-time> | null

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

taxonomyCategory

object | null

Hide child attributes

taxonomyCategory.id

string

required

taxonomyCategory.name

string

required

taxonomyCategory.fullName

string

required

taxonomyCategory.level

number

required

taxonomyCategory.parentId

string | null

required

taxonomyCategory.isLeaf

boolean

required

archivedAt

string<date-time> | null

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

inventoryTrackingEnabled

boolean

pageTitle

string | null

metaDescription

string | null

urlHandle

string | null

slug

string | null

slugs

string[]

ogTitle

string | null

ogDescription

string | null

ogImage

object | null

Hide child attributes

ogImage.id

string

required

ogImage.tenantId

string

required

ogImage.fileUrl

string

required

ogImage.mimeType

string

required

ogImage.originalName

string

required

ogImage.folderPath

string | null

required

ogImage.size

number

required

ogImage.createdAt

string

required

ogImage.updatedAt

string

required

ogImage.deletedAt

string | null

required

ogImage.updatedById

string | null

required

ogImage.createdById

string | null

required

noindex

boolean

media

object | null

Hide child attributes

media.fileId

string

required

media.catalogItemId

string

required

media.orderIndex

number

required

media.media

object

Hide child attributes

media.media.id

string

required

media.media.tenantId

string

required

media.media.fileUrl

string

required

media.media.mimeType

string

required

media.media.originalName

string

required

media.media.folderPath

string | null

required

media.media.size

number

required

media.media.createdAt

string

required

media.media.updatedAt

string

required

media.media.deletedAt

string | null

required

media.media.updatedById

string | null

required

media.media.createdById

string | null

required

documents

object | null

Hide child attributes

documents.fileId

string

required

documents.catalogItemId

string

required

documents.orderIndex

number

required

documents.comment

string | null

required

documents.document

object

Hide child attributes

documents.document.id

string

required

documents.document.tenantId

string

required

documents.document.fileUrl

string

required

documents.document.mimeType

string

required

documents.document.originalName

string

required

documents.document.folderPath

string | null

required

documents.document.size

number

required

documents.document.createdAt

string

required

documents.document.updatedAt

string

required

documents.document.deletedAt

string | null

required

documents.document.updatedById

string | null

required

documents.document.createdById

string | null

required

documents.attachToOrderConfirmation

boolean

documents.copyToOrder

boolean