openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 118 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"email":"support@cloud-elements.com"},"title":"ecwid","version":"api-v2","x-apisguru-categories":["ecommerce"],"x-element-hub":"ecommerce","x-element-id":52,"x-element-key":"ecwid","x-element-name":"Ecwid","x-logo":{"url":"https://cloud-elements.com/wp-content/uploads/2019/05/ces_favicon_32x32.png"},"x-origin":[{"format":"swagger","url":"https://api.cloud-elements.com/elements/api-v2/elements/52/docs?version=-1","version":"2.0"}],"x-providerName":"cloud-elements.com","x-serviceName":"ecwid"},"tags":[{"name":"ping"},{"name":"objects"},{"name":"objectName"},{"name":"orders"},{"name":"customers"},{"name":"bulk"},{"name":"products"}],"paths":{"/bulk/download":{"post":{"operationId":"createBulkDownload","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkDownloadRequest"}}},"description":"The object body","required":true},"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BulkQuery"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new bulk download job (asynchronous)","tags":["bulk"]}},"/bulk/jobs":{"get":{"operationId":"getBulkJobs","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"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 expression would be where=job_direction='UPLOAD'. The following fields are valid search fields 'object_name', 'job_status', 'job_direction', 'record_count'","in":"query","name":"where","required":false,"schema":{"type":"string"}},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"schema":{"type":"string"}},{"description":"The page size for pagination, which defaults to 200 if not supplied","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BulkJobList"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Fetch all the bulk jobs for an instance","tags":["bulk"]}},"/bulk/query":{"post":{"operationId":"createBulkQuery","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The Url to send the notification to when the Job is completed","in":"header","name":"Elements-Async-Callback-Url","required":false,"schema":{"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 apply.","in":"query","name":"q","required":false,"schema":{"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. '2014-10-06T13:22:17-08:00'","in":"query","name":"lastRunDate","required":false,"schema":{"type":"string"}},{"description":"The created/updated date of the object to filter on - optional eg. '2014-10-06T13:22:17-08:00'","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"The created/updated date of the object to filter on - optional eg. '2014-10-06T13:22:17-08:00'","in":"query","name":"to","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"metaData":{"description":"Optional JSON MetaData that contains callback-payload and fileName, ex: {\"callback-payload\" : <Json> , \"fileName\" : \"{Date format}_Name of the file\"}. If the fileName is MyFile then pass metadata as {\"fileName\" : \"{yyyy-MM-dd HH:mm:ss}_MyFile\"}. The valid date formats are \"yyyy-MM-dd'T'HH:mm:ssXXX\", \"yyyy-MM-dd'T'HH:mm:ss'Z'\", \"yyyy-MM-dd'T'HH:mm:ss.SXXX\", \"yyyy-MM-dd'T'HH:mm:ss.SSSXXX\", \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\", \"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'\", \"yyyy-MM-dd HH:mm:ss\", \"yyyy.MM.dd G 'at' HH:mm:ss z\", \"h:mm a\", \"yyyyy.MMMMM.dd GGG hh:mm aaa\" and \"yyMMddHHmmssZ\". callback-payload - is passed back in bulk job notification ","type":"string"}}}}}},"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BulkQuery"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create an asynchronous bulk query job.","tags":["bulk"]}},"/bulk/{id}/cancel":{"put":{"operationId":"replaceBulkCancel","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The ID of the bulk job to cancel.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BulkStatus"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Cancel an asynchronous bulk query job.","tags":["bulk"]}},"/bulk/{id}/errors":{"get":{"operationId":"getBulkErrors","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The ID of the bulk job to retrieve its errors.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The page size for pagination, which defaults to 200 if not supplied","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"schema":{"type":"string"}},{"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"items":{"type":"string"},"type":"array"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the errors of a bulk job.","tags":["bulk"]}},"/bulk/{id}/status":{"get":{"operationId":"getBulkStatus","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The ID of the bulk job to retrieve its status.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BulkStatus"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the status of a bulk job.","tags":["bulk"]}},"/bulk/{id}/{objectName}":{"get":{"operationId":"getBulkByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The ID of the bulk job","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The name of the object","in":"path","name":"objectName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"text/csv":{"schema":{"type":"string","format":"binary"}},"application/json":{"schema":{"type":"string","format":"binary"}},"application/jsonl":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the results of an asynchronous bulk query.","tags":["bulk"]}},"/bulk/{objectName}":{"post":{"operationId":"createBulkByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The Url to send the notification to when the Job is completed","in":"header","name":"Elements-Async-Callback-Url","required":false,"schema":{"type":"string"}},{"description":"The name of the object for which data needs to be uploaded.","in":"path","name":"objectName","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"metaData":{"description":"Optional JSON MetaData that contains callback-payload, path or format, ex: {\"path\" :<path for the sub resource>, \"format\": <json/csv>, \"callback-payload\":<json>}. path - is passed to the endpoint for bulk loading the data into a nested object. Optional JSON Metadata that contains identifierFieldName, action, listId or campaignId. The identifierField name is used for upserts and the optional fields like listId or campaignId. Example: {\"listId\":\"1014\",\"action\":\"upsert\"}. If the Upload format is JSON pass metadata as {\"format\":\"json\"}. callback-payload - is passed back in bulk job notification ","type":"string"},"file":{"description":"The file of objects to bulk load. If the JSON file upload, each JSON record should be in a single line","type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BulkUploadResponse"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Upload a file of objects to be bulk uploaded to the provider.","tags":["bulk"]}},"/customers":{"get":{"operationId":"getCustomers","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"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'). <p>Supported search terms: customer_id and customer_email. All other search criteria are ignored. NOTE: When searching by customer_id, do not quote the value (ex: customer_id=15693430), as the ID is a number rather than a string. When searching by email, quote the value (ex: customer_email='a@b.c'), as the email parameter is a string","in":"query","name":"where","required":false,"schema":{"type":"string"}},{"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"schema":{"type":"string"}},{"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Customer"},"type":"array"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find customers in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved","tags":["customers"]},"post":{"operationId":"createCustomer","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPost"}}},"description":"The customer object to be created","required":true},"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Customer"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create a new customer in eCommerce system.With the exception of the 'id' field, the required fields indicated in the 'Customer' model are those required to create a new customer","tags":["customers"]}},"/customers/{id}":{"delete":{"operationId":"deleteCustomerById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The ID of the customer to delete from the eCommerce system","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete a customer associated with a given ID from your eCommerce system. Specifying a customer associated with a given ID that does not exist will result in an error message","tags":["customers"]},"get":{"operationId":"getCustomerById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The ID of the customer to retrieve from the eCommerce system","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Customer"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve a customer associated with a given ID from the eCommerce system. Specifying a customer with an ID that does not exist will result in an error response","tags":["customers"]},"patch":{"operationId":"updateCustomerById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The ID of the customer to update in the eCommerce system","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerPatch"}}},"description":"The customer object to be created","required":true},"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Customer"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an customer associated with a given ID in the eCommerce system.The update API uses the PATCH HTTP verb, so only those fields provided in the customer object will be updated, and those fields not provided will be left alone. Updating a customer with a specified ID that does not exist will result in an error response","tags":["customers"]}},"/customers/{id}/orders":{"get":{"operationId":"getCustomersOrders","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The ID of the customer to get orders form in the eCommerce system","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"schema":{"type":"string"}},{"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Order"},"type":"array"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find orders in the customer associated with a given ID. If the customer does not exist, an error response will be returned. If no orders are found in the given customer then an empty array will be returned","tags":["customers"]}},"/objects":{"get":{"operationId":"getObjects","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Elements Version to be used for getting metadata, possible options are Hydrogen, Helium. Default value is Hydrogen","in":"header","name":"Elements-Version","required":false,"schema":{"type":"string","enum":["Hydrogen","Helium"]}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"items":{"type":"string"},"type":"array"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Get a list of all the available objects.","tags":["objects"]}},"/objects/{objectName}/docs":{"get":{"operationId":"getObjectsObjectNameDocs","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The name of the object","in":"path","name":"objectName","required":true,"schema":{"type":"string"}},{"description":"Include discovery metadata in definitions","in":"query","name":"discovery","required":false,"schema":{"type":"boolean"}},{"description":"Optionally resolve swagger references for an inline object definition","in":"query","name":"resolveReferences","required":false,"schema":{"type":"boolean"}},{"description":"Include only OpenAPI / Swagger properties in definitions","in":"query","name":"basic","required":false,"schema":{"type":"boolean"}},{"description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger","in":"query","name":"version","required":false,"schema":{"type":"string","default":"-1"}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/swaggerDocs"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Get swagger docs for an object.","tags":["objects"]}},"/objects/{objectName}/metadata":{"get":{"operationId":"getObjectsObjectNameMetadata","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The name of the object","in":"path","name":"objectName","required":true,"schema":{"type":"string"}},{"description":"Elements Version to be used for getting metadata, possible options are Hydrogen, Helium. Default value is Hydrogen","in":"header","name":"Elements-Version","required":false,"schema":{"type":"string","enum":["Hydrogen","Helium"]}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/objectsMetadata"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Get a list of all the field for an object.","tags":["objects"]}},"/orders":{"get":{"operationId":"getOrders","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"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'). <p>Supported search terms: date, from_date, to_date, from_update_date, to_update_date, order, from_order, to_order, customer_id, customer_email and statuses. All other search criteria are ignored","in":"query","name":"where","required":false,"schema":{"type":"string"}},{"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"schema":{"type":"string"}},{"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Order"},"type":"array"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Find orders in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved","tags":["orders"]},"post":{"operationId":"createOrder","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderPost"}}},"description":"The order object to be created","required":true},"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create an order in the eCommerce system.With the exception of the 'id' field, the required fields indicated in the 'Order' model are those required to create a new order.The paymentStatus can only be AWAITING_PAYMENT or INCOMPLETE.The fulfillmentStatus can only be AWAITING_PROCESSING","tags":["orders"]}},"/orders/{id}":{"delete":{"operationId":"deleteOrderById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The ID of the order to delete from the eCommerce system","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an order associated with a given ID from your eCommerce system. Specifying an order associated with a given ID that does not exist will result in an error message","tags":["orders"]},"get":{"operationId":"getOrderById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The ID of the order to retrieve from the eCommerce system","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an order associated with a given ID from the eCommerce system. Specifying an order with an ID that does not exist will result in an error response","tags":["orders"]},"patch":{"operationId":"updateOrderById","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The ID of the order to update in the eCommerce system","in":"path","name":"id","required":true,"schema":{"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","in":"query","name":"action","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderPatch"}}},"description":"The order object, with those fields that are to be updated","required":true},"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an order associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb, so only those fields provided in the order object will be updated, and those fields not provided will be left alone. Updating an order with a specified ID that does not exist will result in an error response</strong>","tags":["orders"]}},"/orders/{orderId}/payments":{"get":{"operationId":"getOrdersPayments","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The ID of the order to retrieve payments from in the eCommerce system","in":"path","name":"orderId","required":true,"schema":{"type":"string"}},{"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"schema":{"type":"string"}},{"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Payment"},"type":"array"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the payments in the eCommerce system for the specified order","tags":["orders"]}},"/orders/{orderId}/refunds":{"get":{"operationId":"getOrdersRefunds","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"The ID of the order to retrieve refunds from in the eCommerce system","in":"path","name":"orderId","required":true,"schema":{"type":"string"}},{"description":"The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned","in":"query","name":"pageSize","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"schema":{"type":"string"}},{"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK - Everything worked as expected","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Payment"},"type":"array"}}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the refunds in the eCommerce system for the specified order","tags":["orders"]}},"/ping":{"get":{"operationId":"getPing","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"