{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ecommerce:cloud-elements-ecwid/create-bulk-download":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_create_bulk_download","summary":"Create a new bulk download job (asynchronous)","description":"POST /bulk/download","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-bulk-jobs":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_bulk_jobs","summary":"Fetch all the bulk jobs for an instance","description":"GET /bulk/jobs","tags":["ecommerce"],"parameters":[{"name":"where","in":"query","required":false,"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example to get all upload jobs the…","schema":{"type":"string","description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example to get all upload jobs the…"}},{"name":"nextPage","in":"query","required":false,"description":"The next page cursor, taken from the response header: `elements-next-page-token`","schema":{"type":"string","description":"The next page cursor, taken from the response header: `elements-next-page-token`"}},{"name":"pageSize","in":"query","required":false,"description":"The page size for pagination, which defaults to 200 if not supplied","schema":{"type":"integer","description":"The page size for pagination, which defaults to 200 if not supplied"}},{"name":"fields","in":"query","required":false,"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","schema":{"type":"string","description":"The fields to return on the response. Can be a single field or a comma-separated list of fields"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/create-bulk-query":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_create_bulk_query","summary":"Create an asynchronous bulk query job.","description":"POST /bulk/query","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Elements-Async-Callback-Url":{"type":"string","description":"The Url to send the notification to when the Job is completed"},"q":{"type":"string","description":"The CEQL query. When this parameter is omitted, all objects of the given type are returned via the bulk job. Endpoint limiters may still…"},"lastRunDate":{"type":"string","description":"The last time this query was run. This is optional. You can also have this parameter in the query and leave this blank - optional eg.…"},"from":{"type":"string","description":"The created/updated date of the object to filter on - optional eg. '2014-10-06T13:22:17-08:00'"},"to":{"type":"string","description":"The created/updated date of the object to filter on - optional eg. '2014-10-06T13:22:17-08:00'"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/replace-bulk-cancel":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_replace_bulk_cancel","summary":"Cancel an asynchronous bulk query job.","description":"PUT /bulk/{id}/cancel","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the bulk job to cancel."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-bulk-errors":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_bulk_errors","summary":"Retrieve the errors of a bulk job.","description":"GET /bulk/{id}/errors","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the bulk job to retrieve its errors.","schema":{"type":"string","description":"The ID of the bulk job to retrieve its errors."}},{"name":"pageSize","in":"query","required":false,"description":"The page size for pagination, which defaults to 200 if not supplied","schema":{"type":"integer","description":"The page size for pagination, which defaults to 200 if not supplied"}},{"name":"nextPage","in":"query","required":false,"description":"The next page cursor, taken from the response header: `elements-next-page-token`","schema":{"type":"string","description":"The next page cursor, taken from the response header: `elements-next-page-token`"}},{"name":"fields","in":"query","required":false,"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","schema":{"type":"string","description":"The fields to return on the response. Can be a single field or a comma-separated list of fields"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-bulk-status":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_bulk_status","summary":"Retrieve the status of a bulk job.","description":"GET /bulk/{id}/status","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the bulk job to retrieve its status.","schema":{"type":"string","description":"The ID of the bulk job to retrieve its status."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-bulk-by-object-name":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_bulk_by_object_name","summary":"Retrieve the results of an asynchronous bulk query.","description":"GET /bulk/{id}/{objectName}","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the bulk job","schema":{"type":"string","description":"The ID of the bulk job"}},{"name":"objectName","in":"query","required":true,"description":"The name of the object","schema":{"type":"string","description":"The name of the object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/create-bulk-by-object-name":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_create_bulk_by_object_name","summary":"Upload a file of objects to be bulk uploaded to the provider.","description":"POST /bulk/{objectName}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["objectName"],"properties":{"Elements-Async-Callback-Url":{"type":"string","description":"The Url to send the notification to when the Job is completed"},"objectName":{"type":"string","description":"The name of the object for which data needs to be uploaded."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-customers":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_customers","summary":"Find customers in the eCommerce system, using the provided CEQL search expression. If no search expression…","description":"GET /customers","tags":["ecommerce"],"parameters":[{"name":"where","in":"query","required":false,"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query (i.e. field='value'). Supported search…","schema":{"type":"string","description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query (i.e. field='value'). Supported search…"}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned","schema":{"type":"integer","description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned"}},{"name":"nextPage","in":"query","required":false,"description":"The next page cursor, taken from the response header: `elements-next-page-token`","schema":{"type":"string","description":"The next page cursor, taken from the response header: `elements-next-page-token`"}},{"name":"fields","in":"query","required":false,"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","schema":{"type":"string","description":"The fields to return on the response. Can be a single field or a comma-separated list of fields"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/create-customer":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_create_customer","summary":"Create a new customer in eCommerce system.With the exception of the 'id' field, the required fields…","description":"POST /customers","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-customer-by-id":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_customer_by_id","summary":"Retrieve a customer associated with a given ID from the eCommerce system. Specifying a customer with an ID…","description":"GET /customers/{id}","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the customer to retrieve from the eCommerce system","schema":{"type":"string","description":"The ID of the customer to retrieve from the eCommerce system"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/update-customer-by-id":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_update_customer_by_id","summary":"Update an customer associated with a given ID in the eCommerce system.The update API uses the PATCH HTTP…","description":"PATCH /customers/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The ID of the customer to update in the eCommerce system"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/delete-customer-by-id":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_delete_customer_by_id","summary":"Delete a customer associated with a given ID from your eCommerce system. Specifying a customer associated…","description":"DELETE /customers/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the customer to delete from the eCommerce system"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-customers-orders":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_customers_orders","summary":"Find orders in the customer associated with a given ID. If the customer does not exist, an error response…","description":"GET /customers/{id}/orders","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the customer to get orders form in the eCommerce system","schema":{"type":"string","description":"The ID of the customer to get orders form in the eCommerce system"}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned","schema":{"type":"integer","description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned"}},{"name":"nextPage","in":"query","required":false,"description":"The next page cursor, taken from the response header: `elements-next-page-token`","schema":{"type":"string","description":"The next page cursor, taken from the response header: `elements-next-page-token`"}},{"name":"fields","in":"query","required":false,"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","schema":{"type":"string","description":"The fields to return on the response. Can be a single field or a comma-separated list of fields"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-objects":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_objects","summary":"Get a list of all the available objects.","description":"GET /objects","tags":["ecommerce"],"parameters":[{"name":"Elements-Version","in":"query","required":false,"description":"Elements Version to be used for getting metadata, possible options are Hydrogen, Helium. Default value is Hydrogen","schema":{"type":"string","enum":["Hydrogen","Helium"],"description":"Elements Version to be used for getting metadata, possible options are Hydrogen, Helium. Default value is Hydrogen"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-objects-object-name-docs":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_objects_object_name_docs","summary":"Get swagger docs for an object.","description":"GET /objects/{objectName}/docs","tags":["ecommerce"],"parameters":[{"name":"objectName","in":"query","required":true,"description":"The name of the object","schema":{"type":"string","description":"The name of the object"}},{"name":"discovery","in":"query","required":false,"description":"Include discovery metadata in definitions","schema":{"type":"boolean","description":"Include discovery metadata in definitions"}},{"name":"resolveReferences","in":"query","required":false,"description":"Optionally resolve swagger references for an inline object definition","schema":{"type":"boolean","description":"Optionally resolve swagger references for an inline object definition"}},{"name":"basic","in":"query","required":false,"description":"Include only OpenAPI / Swagger properties in definitions","schema":{"type":"boolean","description":"Include only OpenAPI / Swagger properties in definitions"}},{"name":"version","in":"query","required":false,"description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger","schema":{"type":"string","default":"-1","description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-objects-object-name-metadata":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_objects_object_name_metadata","summary":"Get a list of all the field for an object.","description":"GET /objects/{objectName}/metadata","tags":["ecommerce"],"parameters":[{"name":"objectName","in":"query","required":true,"description":"The name of the object","schema":{"type":"string","description":"The name of the object"}},{"name":"Elements-Version","in":"query","required":false,"description":"Elements Version to be used for getting metadata, possible options are Hydrogen, Helium. Default value is Hydrogen","schema":{"type":"string","enum":["Hydrogen","Helium"],"description":"Elements Version to be used for getting metadata, possible options are Hydrogen, Helium. Default value is Hydrogen"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-orders":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_orders","summary":"Find orders in the eCommerce system, using the provided CEQL search expression. If no search expression is…","description":"GET /orders","tags":["ecommerce"],"parameters":[{"name":"where","in":"query","required":false,"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query (i.e. field='value'). Supported search…","schema":{"type":"string","description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query (i.e. field='value'). Supported search…"}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned","schema":{"type":"integer","description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned"}},{"name":"nextPage","in":"query","required":false,"description":"The next page cursor, taken from the response header: `elements-next-page-token`","schema":{"type":"string","description":"The next page cursor, taken from the response header: `elements-next-page-token`"}},{"name":"fields","in":"query","required":false,"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","schema":{"type":"string","description":"The fields to return on the response. Can be a single field or a comma-separated list of fields"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/create-order":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_create_order","summary":"Create an order in the eCommerce system.With the exception of the 'id' field, the required fields indicated…","description":"POST /orders","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-order-by-id":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_order_by_id","summary":"Retrieve an order associated with a given ID from the eCommerce system. Specifying an order with an ID that…","description":"GET /orders/{id}","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the order to retrieve from the eCommerce system","schema":{"type":"string","description":"The ID of the order to retrieve from the eCommerce system"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/update-order-by-id":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_update_order_by_id","summary":"Update an order associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb,…","description":"PATCH /orders/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The ID of the order to update in the eCommerce system"},"action":{"type":"string","description":"An action to perform on the order: cancel, reopen or close. If left blank then the order is updated but no action is taken"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/delete-order-by-id":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_delete_order_by_id","summary":"Delete an order associated with a given ID from your eCommerce system. Specifying an order associated with a…","description":"DELETE /orders/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the order to delete from the eCommerce system"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-orders-payments":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_orders_payments","summary":"Retrieve the payments in the eCommerce system for the specified order","description":"GET /orders/{orderId}/payments","tags":["ecommerce"],"parameters":[{"name":"orderId","in":"query","required":true,"description":"The ID of the order to retrieve payments from in the eCommerce system","schema":{"type":"string","description":"The ID of the order to retrieve payments from in the eCommerce system"}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned","schema":{"type":"integer","description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned"}},{"name":"nextPage","in":"query","required":false,"description":"The next page cursor, taken from the response header: `elements-next-page-token`","schema":{"type":"string","description":"The next page cursor, taken from the response header: `elements-next-page-token`"}},{"name":"fields","in":"query","required":false,"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","schema":{"type":"string","description":"The fields to return on the response. Can be a single field or a comma-separated list of fields"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-orders-refunds":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_orders_refunds","summary":"Retrieve the refunds in the eCommerce system for the specified order","description":"GET /orders/{orderId}/refunds","tags":["ecommerce"],"parameters":[{"name":"orderId","in":"query","required":true,"description":"The ID of the order to retrieve refunds from in the eCommerce system","schema":{"type":"string","description":"The ID of the order to retrieve refunds from in the eCommerce system"}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned","schema":{"type":"integer","description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned"}},{"name":"nextPage","in":"query","required":false,"description":"The next page cursor, taken from the response header: `elements-next-page-token`","schema":{"type":"string","description":"The next page cursor, taken from the response header: `elements-next-page-token`"}},{"name":"fields","in":"query","required":false,"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","schema":{"type":"string","description":"The fields to return on the response. Can be a single field or a comma-separated list of fields"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-ping":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_ping","summary":"Ping the Element to confirm that the Hub Element has a heartbeat. If the Element does not have a heartbeat,…","description":"GET /ping","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-products":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_products","summary":"Find products in the eCommerce system, using the provided CEQL search expression. The search expression in…","description":"GET /products","tags":["ecommerce"],"parameters":[{"name":"where","in":"query","required":false,"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query (i.e. field='value'). Supported search…","schema":{"type":"string","description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query (i.e. field='value'). Supported search…"}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned","schema":{"type":"integer","description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned"}},{"name":"nextPage","in":"query","required":false,"description":"The next page cursor, taken from the response header: `elements-next-page-token`","schema":{"type":"string","description":"The next page cursor, taken from the response header: `elements-next-page-token`"}},{"name":"fields","in":"query","required":false,"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","schema":{"type":"string","description":"The fields to return on the response. Can be a single field or a comma-separated list of fields"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/create-product":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_create_product","summary":"Create a new product in eCommerce system.With the exception of the 'id' field, the required fields indicated…","description":"POST /products","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-product-by-id":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_product_by_id","summary":"Retrieve a product associated with a given ID from the eCommerce system. Specifying a product with an ID…","description":"GET /products/{id}","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the product to retrieve from the eCommerce system","schema":{"type":"string","description":"The ID of the product to retrieve from the eCommerce system"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/update-product-by-id":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_update_product_by_id","summary":"Update a product associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP…","description":"PATCH /products/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The ID of the product to update in the eCommerce system"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/delete-product-by-id":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_delete_product_by_id","summary":"Delete a product associated with a given ID from your eCommerce system. Specifying a product associated with…","description":"DELETE /products/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the product to delete from the eCommerce system"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-by-object-name":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_by_object_name","summary":"Search for {objectName}","description":"GET /{objectName}","tags":["ecommerce"],"parameters":[{"name":"objectName","in":"query","required":true,"description":"The name of the object","schema":{"type":"string","description":"The name of the object"}},{"name":"where","in":"query","required":false,"description":"The CEQL search expression.","schema":{"type":"string","description":"The CEQL search expression."}},{"name":"pageSize","in":"query","required":false,"description":"The page size. Defaults to 200 if not provided. Maximum of 5000.","schema":{"type":"integer","description":"The page size. Defaults to 200 if not provided. Maximum of 5000."}},{"name":"nextPage","in":"query","required":false,"description":"The next page cursor, taken from the response header: `elements-next-page-token`","schema":{"type":"string","description":"The next page cursor, taken from the response header: `elements-next-page-token`"}},{"name":"fields","in":"query","required":false,"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","schema":{"type":"string","description":"The fields to return on the response. Can be a single field or a comma-separated list of fields"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/create-by-object-name":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_create_by_object_name","summary":"Create an {objectName}","description":"POST /{objectName}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["objectName","body"],"properties":{"objectName":{"type":"string","description":"The name of the object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-object-name-by-object-id":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_object_name_by_object_id","summary":"Retrieve an {objectName}","description":"GET /{objectName}/{objectId}","tags":["ecommerce"],"parameters":[{"name":"objectName","in":"query","required":true,"description":"The name of the object","schema":{"type":"string","description":"The name of the object"}},{"name":"objectId","in":"query","required":true,"description":"The {objectName} ID","schema":{"type":"string","description":"The {objectName} ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/replace-object-name-by-object-id":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_replace_object_name_by_object_id","summary":"Update an {objectName}","description":"PUT /{objectName}/{objectId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["objectName","objectId","body"],"properties":{"objectName":{"type":"string","description":"The name of the object"},"objectId":{"type":"string","description":"The {objectName} ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/update-object-name-by-object-id":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_update_object_name_by_object_id","summary":"Update an {objectName}","description":"PATCH /{objectName}/{objectId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["objectName","objectId","body"],"properties":{"objectName":{"type":"string","description":"The name of the object"},"objectId":{"type":"string","description":"The {objectName} ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/delete-object-name-by-object-id":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_delete_object_name_by_object_id","summary":"Delete an {objectName}","description":"DELETE /{objectName}/{objectId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["objectName","objectId"],"properties":{"objectName":{"type":"string","description":"The name of the object"},"objectId":{"type":"string","description":"The {objectName} ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-object-name-by-child-object-name":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_object_name_by_child_object_name","summary":"Search for {childObjectName}","description":"GET /{objectName}/{objectId}/{childObjectName}","tags":["ecommerce"],"parameters":[{"name":"objectName","in":"query","required":true,"description":"The name of the object","schema":{"type":"string","description":"The name of the object"}},{"name":"objectId","in":"query","required":true,"description":"The {objectName} ID","schema":{"type":"string","description":"The {objectName} ID"}},{"name":"childObjectName","in":"query","required":true,"description":"The name of the childObjectName","schema":{"type":"string","description":"The name of the childObjectName"}},{"name":"where","in":"query","required":false,"description":"The CEQL search expression.","schema":{"type":"string","description":"The CEQL search expression."}},{"name":"pageSize","in":"query","required":false,"description":"The page size. Defaults to 200 if not provided. Maximum of 5000.","schema":{"type":"integer","description":"The page size. Defaults to 200 if not provided. Maximum of 5000."}},{"name":"nextPage","in":"query","required":false,"description":"The next page cursor, taken from the response header: `elements-next-page-token`","schema":{"type":"string","description":"The next page cursor, taken from the response header: `elements-next-page-token`"}},{"name":"fields","in":"query","required":false,"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","schema":{"type":"string","description":"The fields to return on the response. Can be a single field or a comma-separated list of fields"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/create-object-name-by-child-object-name":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_create_object_name_by_child_object_name","summary":"Create an {objectName}","description":"POST /{objectName}/{objectId}/{childObjectName}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["objectName","objectId","childObjectName","body"],"properties":{"objectName":{"type":"string","description":"The name of the object"},"objectId":{"type":"string","description":"The {objectName} ID"},"childObjectName":{"type":"string","description":"The name of the object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/get-object-name-by-child-object-id":{"get":{"operationId":"ecommerce_cloud_elements_ecwid_get_object_name_by_child_object_id","summary":"Retrieve an {childObjectName}","description":"GET /{objectName}/{objectId}/{childObjectName}/{childObjectId}","tags":["ecommerce"],"parameters":[{"name":"objectName","in":"query","required":true,"description":"The name of the object","schema":{"type":"string","description":"The name of the object"}},{"name":"childObjectName","in":"query","required":true,"description":"The name of the childObjectName","schema":{"type":"string","description":"The name of the childObjectName"}},{"name":"objectId","in":"query","required":true,"description":"The {objectName} ID","schema":{"type":"string","description":"The {objectName} ID"}},{"name":"childObjectId","in":"query","required":true,"description":"The {childObjectName} ID","schema":{"type":"string","description":"The {childObjectName} ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/replace-object-name-by-child-object-id":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_replace_object_name_by_child_object_id","summary":"Update an {childObjectName}","description":"PUT /{objectName}/{objectId}/{childObjectName}/{childObjectId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["objectName","childObjectName","objectId","childObjectId","body"],"properties":{"objectName":{"type":"string","description":"The name of the object"},"childObjectName":{"type":"string","description":"The name of the childObjectName"},"objectId":{"type":"string","description":"The {objectName} ID"},"childObjectId":{"type":"string","description":"The {childObjectName} ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/update-object-name-by-child-object-id":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_update_object_name_by_child_object_id","summary":"Update an {childObjectName}","description":"PATCH /{objectName}/{objectId}/{childObjectName}/{childObjectId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["objectName","childObjectName","objectId","childObjectId","body"],"properties":{"objectName":{"type":"string","description":"The name of the object"},"childObjectName":{"type":"string","description":"The name of the childObjectName"},"objectId":{"type":"string","description":"The {objectName} ID"},"childObjectId":{"type":"string","description":"The {childObjectName} ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/ecommerce:cloud-elements-ecwid/delete-object-name-by-child-object-id":{"post":{"operationId":"ecommerce_cloud_elements_ecwid_delete_object_name_by_child_object_id","summary":"Delete an {childObjectName}","description":"DELETE /{objectName}/{objectId}/{childObjectName}/{childObjectId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["objectName","childObjectName","objectId","childObjectId"],"properties":{"objectName":{"type":"string","description":"The name of the object"},"childObjectName":{"type":"string","description":"The name of the childObjectName"},"objectId":{"type":"string","description":"The {objectName} ID"},"childObjectId":{"type":"string","description":"The {childObjectName} ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}