docs: updated documentations for catalog APIs to include JSON data ty…

…pe support
braze-inc · Feb 15, 2023 · f217245 · f217245
1 parent 234cbf7
commit f217245
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 0 deletions.
diff --git a/.../_api/endpoints/catalogs/catalog_items/asynchronous/patch_catalog_items_bulk.md b/.../_api/endpoints/catalogs/catalog_items/asynchronous/patch_catalog_items_bulk.md
@@ -48,6 +48,10 @@ curl --location --request PATCH 'https://rest.iad-03.braze.com/catalogs/restaura
       "id": "restaurant1",
       "Name": "Restaurant",
       "Loyalty_Program": false,
+      "Location": {
+        "Latitude": 33.6112,
+        "Longitude": -117.8711
+      },
       "Open_Time": "2021-09-03T09:03:19.967+00:00"
     },
     {
@@ -112,6 +116,8 @@ The following table lists possible returned errors and their associated troubles
 | `items-too-large` | Item values can't exceed 5,000 characters. |
 | `invalid-fields` | Confirm that the fields in the request exist in the catalog. |
 | `unable-to-coerce-value` | Item types can't be converted. |
+| `invalid-keys-in-value-object` | Item object keys can't include `.` or `$`. |
+| `too-deep-nesting-in-value-object` | Item objects can't have more than 50 levels of nesting. |
 {: .reset-td-br-1 .reset-td-br-2}
 
 {% endapi %}
diff --git a/...endpoints/catalogs/catalog_items/asynchronous/post_create_catalog_items_bulk.md b/...endpoints/catalogs/catalog_items/asynchronous/post_create_catalog_items_bulk.md
@@ -50,6 +50,10 @@ curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restauran
       "Cuisine": "American",
       "Rating": 5,
       "Loyalty_Program": true,
+      "Location": {
+        "Latitude": 33.6112,
+        "Longitude": -117.8711
+      },
       "Created_At": "2022-11-01T09:03:19.967+00:00"
     },
     {
@@ -59,6 +63,10 @@ curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restauran
       "Cuisine": "American",
       "Rating": 10,
       "Loyalty_Program": true,
+      "Location": {
+        "Latitude": 40.7413,
+        "Longitude": -73.9764
+      },
       "Created_At": "2022-11-02T09:03:19.967+00:00"
     },
     {
@@ -68,6 +76,10 @@ curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restauran
       "Cuisine": "American",
       "Rating": 3,
       "Loyalty_Program": false,
+      "Location": {
+        "Latitude": 40.7489,
+        "Longitude": -73.9972
+      },
       "Created_At": "2022-11-03T09:03:19.967+00:00"
     }
   ]
@@ -128,6 +140,8 @@ The following table lists possible returned errors and their associated troubles
 | `invalid-fields` | Confirm that the fields in the request exist in the catalog. |
 | `fields-do-not-match` | Updated fields must match the fields in the catalog. |
 | `unable-to-coerce-value` | Item types can't be converted. |
+| `invalid-keys-in-value-object` | Item object keys can't include `.` or `$`. |
+| `too-deep-nesting-in-value-object` | Item objects can't have more than 50 levels of nesting. |
 {: .reset-td-br-1 .reset-td-br-2}
 
 {% endapi %}
diff --git a/_docs/_api/endpoints/catalogs/catalog_items/synchronous/patch_catalog_item.md b/_docs/_api/endpoints/catalogs/catalog_items/synchronous/patch_catalog_item.md
@@ -47,6 +47,10 @@ curl --location --request PATCH 'https://rest.iad-03.braze.com/catalogs/restaura
     {
       "Name": "Restaurant",
       "Loyalty_Program": false,
+      "Location": {
+        "Latitude": 33.6112,
+        "Longitude": -117.8711
+      },
       "Open_Time": "2021-09-03T09:03:19.967+00:00"
     }
   ]
@@ -107,6 +111,8 @@ The following table lists possible returned errors and their associated troubles
 | `unable-to-coerce-value` | Item types can't be converted. |
 | `filtered-set-field-too-long` | The field value is being used in a filtered set that exceeds the character limit for an item. |
 | `arbitrary-error` | An arbitrary error occurred. Please try again or contact [Support]({{site.baseurl}}/support_contact/). |
+| `invalid-keys-in-value-object` | Item object keys can't include `.` or `$`. |
+| `too-deep-nesting-in-value-object` | Item objects can't have more than 50 levels of nesting. |
 {: .reset-td-br-1 .reset-td-br-2}
 
 {% endapi %}
diff --git a/...s/_api/endpoints/catalogs/catalog_items/synchronous/post_create_catalog_item.md b/...s/_api/endpoints/catalogs/catalog_items/synchronous/post_create_catalog_item.md
@@ -50,6 +50,10 @@ curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restauran
       "Cuisine": "American",
       "Rating": 5,
       "Loyalty_Program": true,
+      "Location": {
+        "Latitude": 33.6112,
+        "Longitude": -117.8711
+      },
       "Created_At": "2022-11-01T09:03:19.967+00:00"
     }
   ]
@@ -113,6 +117,8 @@ The following table lists possible returned errors and their associated troubles
 | `already-reached-company-item-limit` | Maximum number of catalog items reached. Contact your Braze account manager for more information. | 
 | `unable-to-coerce-value` | Item types can't be converted. |
 | `arbitrary-error` | An arbitrary error occurred. Please try again or contact [Support]({{site.baseurl}}/support_contact/). |
+| `invalid-keys-in-value-object` | Item object keys can't include `.` or `$`. |
+| `too-deep-nesting-in-value-object` | Item objects can't have more than 50 levels of nesting. |
 {: .reset-td-br-1 .reset-td-br-2}
 
 {% endapi %}
diff --git a/...s/_api/endpoints/catalogs/catalog_management/synchronous/post_create_catalog.md b/...s/_api/endpoints/catalogs/catalog_management/synchronous/post_create_catalog.md
@@ -73,6 +73,10 @@ curl --location --request POST 'https://rest.iad-03.braze.com/catalogs' \
           "name": "Loyalty_Program",
           "type": "boolean"
         },
+        {
+          "name": "Location",
+          "type": "object"
+        },
         {
           "name": "Created_At",
           "type": "time"
@@ -121,6 +125,10 @@ The status code `201` could return the following response body.
           "name": "Loyalty_Program",
           "type": "boolean"
         },
+        {
+          "name": "Location",
+          "type": "object"
+        },
         {
           "name": "Created_At",
           "type": "time"