{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ecommerce:codat-commerce/list-customers":{"get":{"operationId":"ecommerce_codat_commerce_list_customers","summary":"List customers","description":"GET /companies/{companyId}/connections/{connectionId}/data/commerce-customers","tags":["ecommerce"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"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":"byok"}},"/v1/ecommerce:codat-commerce/list-disputes":{"get":{"operationId":"ecommerce_codat_commerce_list_disputes","summary":"List disputes","description":"GET /companies/{companyId}/connections/{connectionId}/data/commerce-disputes","tags":["ecommerce"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"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":"byok"}},"/v1/ecommerce:codat-commerce/get-company-info":{"get":{"operationId":"ecommerce_codat_commerce_get_company_info","summary":"Get company info","description":"GET /companies/{companyId}/connections/{connectionId}/data/commerce-info","tags":["ecommerce"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}}],"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":"byok"}},"/v1/ecommerce:codat-commerce/list-locations":{"get":{"operationId":"ecommerce_codat_commerce_list_locations","summary":"List locations","description":"GET /companies/{companyId}/connections/{connectionId}/data/commerce-locations","tags":["ecommerce"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}}],"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":"byok"}},"/v1/ecommerce:codat-commerce/list-orders":{"get":{"operationId":"ecommerce_codat_commerce_list_orders","summary":"List orders","description":"GET /companies/{companyId}/connections/{connectionId}/data/commerce-orders","tags":["ecommerce"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"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":"byok"}},"/v1/ecommerce:codat-commerce/list-payment-methods":{"get":{"operationId":"ecommerce_codat_commerce_list_payment_methods","summary":"List payment methods","description":"GET /companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods","tags":["ecommerce"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"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":"byok"}},"/v1/ecommerce:codat-commerce/list-payments":{"get":{"operationId":"ecommerce_codat_commerce_list_payments","summary":"List payments","description":"GET /companies/{companyId}/connections/{connectionId}/data/commerce-payments","tags":["ecommerce"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"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":"byok"}},"/v1/ecommerce:codat-commerce/list-product-categories":{"get":{"operationId":"ecommerce_codat_commerce_list_product_categories","summary":"List product categories","description":"GET /companies/{companyId}/connections/{connectionId}/data/commerce-productCategories","tags":["ecommerce"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"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":"byok"}},"/v1/ecommerce:codat-commerce/list-products":{"get":{"operationId":"ecommerce_codat_commerce_list_products","summary":"List products","description":"GET /companies/{companyId}/connections/{connectionId}/data/commerce-products","tags":["ecommerce"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"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":"byok"}},"/v1/ecommerce:codat-commerce/get-tax-components":{"get":{"operationId":"ecommerce_codat_commerce_get_tax_components","summary":"List tax components","description":"GET /companies/{companyId}/connections/{connectionId}/data/commerce-taxComponents","tags":["ecommerce"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}}],"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":"byok"}},"/v1/ecommerce:codat-commerce/list-transactions":{"get":{"operationId":"ecommerce_codat_commerce_list_transactions","summary":"List transactions","description":"GET /companies/{companyId}/connections/{connectionId}/data/commerce-transactions","tags":["ecommerce"],"parameters":[{"name":"companyId","in":"query","required":true,"description":"Unique identifier for your SMB in Codat.","schema":{"type":"string","description":"Unique identifier for your SMB in Codat."}},{"name":"connectionId","in":"query","required":true,"description":"Unique identifier for a company's data connection.","schema":{"type":"string","description":"Unique identifier for a company's data connection."}},{"name":"page","in":"query","required":true,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":1,"description":"Page number. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"pageSize","in":"query","required":false,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).","schema":{"type":"integer","default":100,"description":"Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."}},{"name":"query","in":"query","required":false,"description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).","schema":{"type":"string","description":"Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."}},{"name":"orderBy","in":"query","required":false,"description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).","schema":{"type":"string","description":"Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."}}],"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":"byok"}}},"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"}}}}}}}