Batch Upsert Catalog Objects Request
| Name | Type | Tags | Description |
|---|---|---|---|
idempotency_key |
str |
Required | A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See Idempotency for more information. Constraints: Minimum Length: 1 |
batches |
List Catalog Object Batch |
Required | A batch of CatalogObjects to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its updated_at field is ignored and replaced with a current timestamp, and itsis_deleted field must not be set to true.To modify an existing object, supply its ID. To create a new object, use an ID starting with #. These IDs may be used to create relationships between an object and attributes ofother objects that reference it. For example, you can create a CatalogItem with ID #ABC and a CatalogItemVariation with its item_id attribute set to#ABC in order to associate the CatalogItemVariation with its parentCatalogItem. Any #-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs.Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. |
{
"batches": [
{
"objects": [
{
"id": "#Tea",
"item_data": {
"categories": [
{
"id": "#Beverages"
}
],
"description_html": "<p><strong>Hot</strong> Leaf Juice</p>",
"name": "Tea",
"tax_ids": [
"#SalesTax"
],
"variations": [
{
"id": "#Tea_Mug",
"item_variation_data": {
"item_id": "#Tea",
"name": "Mug",
"price_money": {
"amount": 150,
"currency": "USD"
},
"pricing_type": "FIXED_PRICING"
},
"present_at_all_locations": true,
"type": "ITEM_VARIATION"
}
]
},
"present_at_all_locations": true,
"type": "ITEM",
"updated_at": "updated_at2",
"version": 164,
"is_deleted": false,
"custom_attribute_values": {
"key0": {
"name": "name8",
"string_value": "string_value2",
"custom_attribute_definition_id": "custom_attribute_definition_id4",
"type": "STRING",
"number_value": "number_value8"
},
"key1": {
"name": "name8",
"string_value": "string_value2",
"custom_attribute_definition_id": "custom_attribute_definition_id4",
"type": "STRING",
"number_value": "number_value8"
}
},
"catalog_v1_ids": [
{
"catalog_v1_id": "catalog_v1_id4",
"location_id": "location_id4"
},
{
"catalog_v1_id": "catalog_v1_id4",
"location_id": "location_id4"
},
{
"catalog_v1_id": "catalog_v1_id4",
"location_id": "location_id4"
}
]
},
{
"id": "#Coffee",
"item_data": {
"categories": [
{
"id": "#Beverages"
}
],
"description_html": "<p>Hot <em>Bean Juice</em></p>",
"name": "Coffee",
"tax_ids": [
"#SalesTax"
],
"variations": [
{
"id": "#Coffee_Regular",
"item_variation_data": {
"item_id": "#Coffee",
"name": "Regular",
"price_money": {
"amount": 250,
"currency": "USD"
},
"pricing_type": "FIXED_PRICING"
},
"present_at_all_locations": true,
"type": "ITEM_VARIATION"
},
{
"id": "#Coffee_Large",
"item_variation_data": {
"item_id": "#Coffee",
"name": "Large",
"price_money": {
"amount": 350,
"currency": "USD"
},
"pricing_type": "FIXED_PRICING"
},
"present_at_all_locations": true,
"type": "ITEM_VARIATION"
}
]
},
"present_at_all_locations": true,
"type": "ITEM",
"updated_at": "updated_at2",
"version": 164,
"is_deleted": false,
"custom_attribute_values": {
"key0": {
"name": "name8",
"string_value": "string_value2",
"custom_attribute_definition_id": "custom_attribute_definition_id4",
"type": "STRING",
"number_value": "number_value8"
},
"key1": {
"name": "name8",
"string_value": "string_value2",
"custom_attribute_definition_id": "custom_attribute_definition_id4",
"type": "STRING",
"number_value": "number_value8"
}
},
"catalog_v1_ids": [
{
"catalog_v1_id": "catalog_v1_id4",
"location_id": "location_id4"
},
{
"catalog_v1_id": "catalog_v1_id4",
"location_id": "location_id4"
},
{
"catalog_v1_id": "catalog_v1_id4",
"location_id": "location_id4"
}
]
},
{
"category_data": {
"name": "Beverages"
},
"id": "#Beverages",
"present_at_all_locations": true,
"type": "CATEGORY",
"updated_at": "updated_at2",
"version": 164,
"is_deleted": false,
"custom_attribute_values": {
"key0": {
"name": "name8",
"string_value": "string_value2",
"custom_attribute_definition_id": "custom_attribute_definition_id4",
"type": "STRING",
"number_value": "number_value8"
},
"key1": {
"name": "name8",
"string_value": "string_value2",
"custom_attribute_definition_id": "custom_attribute_definition_id4",
"type": "STRING",
"number_value": "number_value8"
}
},
"catalog_v1_ids": [
{
"catalog_v1_id": "catalog_v1_id4",
"location_id": "location_id4"
},
{
"catalog_v1_id": "catalog_v1_id4",
"location_id": "location_id4"
},
{
"catalog_v1_id": "catalog_v1_id4",
"location_id": "location_id4"
}
]
},
{
"id": "#SalesTax",
"present_at_all_locations": true,
"tax_data": {
"applies_to_custom_amounts": true,
"calculation_phase": "TAX_SUBTOTAL_PHASE",
"enabled": true,
"inclusion_type": "ADDITIVE",
"name": "Sales Tax",
"percentage": "5.0"
},
"type": "TAX",
"updated_at": "updated_at2",
"version": 164,
"is_deleted": false,
"custom_attribute_values": {
"key0": {
"name": "name8",
"string_value": "string_value2",
"custom_attribute_definition_id": "custom_attribute_definition_id4",
"type": "STRING",
"number_value": "number_value8"
},
"key1": {
"name": "name8",
"string_value": "string_value2",
"custom_attribute_definition_id": "custom_attribute_definition_id4",
"type": "STRING",
"number_value": "number_value8"
}
},
"catalog_v1_ids": [
{
"catalog_v1_id": "catalog_v1_id4",
"location_id": "location_id4"
},
{
"catalog_v1_id": "catalog_v1_id4",
"location_id": "location_id4"
},
{
"catalog_v1_id": "catalog_v1_id4",
"location_id": "location_id4"
}
]
}
]
}
],
"idempotency_key": "789ff020-f723-43a9-b4b5-43b5dc1fa3dc"
}