{"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:billbee/automatic-provisioning-create-account":{"post":{"operationId":"ecommerce_billbee_automatic_provisioning_create_account","summary":"Creates a new Billbee user account with the data passed","description":"POST /api/v1/automaticprovision/createaccount","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":"byok"}},"/v1/ecommerce:billbee/automatic-provisioning-terms-info":{"get":{"operationId":"ecommerce_billbee_automatic_provisioning_terms_info","summary":"Returns infos about Billbee terms and conditions","description":"GET /api/v1/automaticprovision/termsinfo","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":"byok"}},"/v1/ecommerce:billbee/cloud-storage-api-get-list":{"get":{"operationId":"ecommerce_billbee_cloud_storage_api_get_list","summary":"Gets a list of all connected cloud storage devices","description":"GET /api/v1/cloudstorages","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":"byok"}},"/v1/ecommerce:billbee/customer-addresses-get-all":{"get":{"operationId":"ecommerce_billbee_customer_addresses_get_all","summary":"Get a list of all customer addresses","description":"GET /api/v1/customer-addresses","tags":["ecommerce"],"parameters":[{"name":"page","in":"query","required":false,"description":"The current page to request starting with 1 (default is 1)","schema":{"type":"integer","description":"The current page to request starting with 1 (default is 1)"}},{"name":"pageSize","in":"query","required":false,"description":"The page size for the result list. Values between 1 and 250 are allowed. (default is 50)","schema":{"type":"integer","description":"The page size for the result list. Values between 1 and 250 are allowed. (default is 50)"}}],"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:billbee/customer-addresses-create":{"post":{"operationId":"ecommerce_billbee_customer_addresses_create","summary":"Creates a new customer address","description":"POST /api/v1/customer-addresses","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":"byok"}},"/v1/ecommerce:billbee/customer-addresses-get-one":{"get":{"operationId":"ecommerce_billbee_customer_addresses_get_one","summary":"Queries a single customer address by id","description":"GET /api/v1/customer-addresses/{id}","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the address to query","schema":{"type":"integer","description":"The id of the address to query"}}],"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:billbee/customer-addresses-update":{"post":{"operationId":"ecommerce_billbee_customer_addresses_update","summary":"Updates a customer address by id","description":"PUT /api/v1/customer-addresses/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The id of the address"},"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":"byok"}},"/v1/ecommerce:billbee/customer-get-all":{"get":{"operationId":"ecommerce_billbee_customer_get_all","summary":"Get a list of all customers","description":"GET /api/v1/customers","tags":["ecommerce"],"parameters":[{"name":"page","in":"query","required":false,"description":"The current page to request starting with 1","schema":{"type":"integer","description":"The current page to request starting with 1"}},{"name":"pageSize","in":"query","required":false,"description":"The pagesize for the result list. Values between 1 and 250 are allowed","schema":{"type":"integer","description":"The pagesize for the result list. Values between 1 and 250 are allowed"}}],"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:billbee/customer-create":{"post":{"operationId":"ecommerce_billbee_customer_create","summary":"Creates a new customer","description":"POST /api/v1/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":"byok"}},"/v1/ecommerce:billbee/customer-get-customer-address":{"get":{"operationId":"ecommerce_billbee_customer_get_customer_address","summary":"Queries a single address from a customer","description":"GET /api/v1/customers/addresses/{id}","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the address","schema":{"type":"integer","description":"The id of the address"}}],"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:billbee/customer-update-address":{"post":{"operationId":"ecommerce_billbee_customer_update_address","summary":"Updates all fields of an address","description":"PUT /api/v1/customers/addresses/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The id of the address"},"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":"byok"}},"/v1/ecommerce:billbee/customer-patch-address":{"post":{"operationId":"ecommerce_billbee_customer_patch_address","summary":"Updates one or more fields of an address","description":"PATCH /api/v1/customers/addresses/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The id of the address"},"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":"byok"}},"/v1/ecommerce:billbee/customer-get-one":{"get":{"operationId":"ecommerce_billbee_customer_get_one","summary":"Queries a single customer by id","description":"GET /api/v1/customers/{id}","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the customer to query","schema":{"type":"integer","description":"The id of the customer to query"}}],"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:billbee/customer-update":{"post":{"operationId":"ecommerce_billbee_customer_update","summary":"Updates a customer by id","description":"PUT /api/v1/customers/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The id of the customer"},"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":"byok"}},"/v1/ecommerce:billbee/customer-get-customer-addresses":{"get":{"operationId":"ecommerce_billbee_customer_get_customer_addresses","summary":"Queries a list of addresses from a customer","description":"GET /api/v1/customers/{id}/addresses","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the customer","schema":{"type":"integer","description":"The id of the customer"}},{"name":"page","in":"query","required":false,"description":"The current page to request starting with 1","schema":{"type":"integer","description":"The current page to request starting with 1"}},{"name":"pageSize","in":"query","required":false,"description":"The pagesize for the result list. Values between 1 and 250 are allowed","schema":{"type":"integer","description":"The pagesize for the result list. Values between 1 and 250 are allowed"}}],"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:billbee/customer-add-customer-address":{"post":{"operationId":"ecommerce_billbee_customer_add_customer_address","summary":"Adds a new address to a customer","description":"POST /api/v1/customers/{id}/addresses","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"CustomerId to attach the new address to."},"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":"byok"}},"/v1/ecommerce:billbee/customer-get-customer-orders":{"get":{"operationId":"ecommerce_billbee_customer_get_customer_orders","summary":"Queries a list of orders from a customer","description":"GET /api/v1/customers/{id}/orders","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the customer","schema":{"type":"integer","description":"The id of the customer"}},{"name":"page","in":"query","required":false,"description":"The current page to request starting with 1","schema":{"type":"integer","description":"The current page to request starting with 1"}},{"name":"pageSize","in":"query","required":false,"description":"The pagesize for the result list. Values between 1 and 250 are allowed","schema":{"type":"integer","description":"The pagesize for the result list. Values between 1 and 250 are allowed"}}],"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:billbee/enum-api-get-order-states":{"get":{"operationId":"ecommerce_billbee_enum_api_get_order_states","summary":"Returns a list with all defined orderstates","description":"GET /api/v1/enums/orderstates","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":"byok"}},"/v1/ecommerce:billbee/enum-api-get-payment-types":{"get":{"operationId":"ecommerce_billbee_enum_api_get_payment_types","summary":"Returns a list with all defined paymenttypes","description":"GET /api/v1/enums/paymenttypes","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":"byok"}},"/v1/ecommerce:billbee/enum-api-get-shipment-types":{"get":{"operationId":"ecommerce_billbee_enum_api_get_shipment_types","summary":"Returns a list with all defined shipmenttypes","description":"GET /api/v1/enums/shipmenttypes","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":"byok"}},"/v1/ecommerce:billbee/enum-api-get-shipping-carriers":{"get":{"operationId":"ecommerce_billbee_enum_api_get_shipping_carriers","summary":"Returns a list with all defined shippingcarriers","description":"GET /api/v1/enums/shippingcarriers","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":"byok"}},"/v1/ecommerce:billbee/event-api-get-list":{"get":{"operationId":"ecommerce_billbee_event_api_get_list","summary":"Get a list of all events optionally filtered by date. This request is extra throttled to 2 calls per page…","description":"GET /api/v1/events","tags":["ecommerce"],"parameters":[{"name":"minDate","in":"query","required":false,"description":"Specifies the oldest date to include in the response","schema":{"type":"string","description":"Specifies the oldest date to include in the response"}},{"name":"maxDate","in":"query","required":false,"description":"Specifies the newest date to include in the response","schema":{"type":"string","description":"Specifies the newest date to include in the response"}},{"name":"page","in":"query","required":false,"description":"Specifies the page to request","schema":{"type":"integer","description":"Specifies the page to request"}},{"name":"pageSize","in":"query","required":false,"description":"Specifies the pagesize. Defaults to 50, max value is 250","schema":{"type":"integer","description":"Specifies the pagesize. Defaults to 50, max value is 250"}},{"name":"typeId","in":"query","required":false,"description":"Filter for specific event types","schema":{"type":"array","description":"Filter for specific event types"}},{"name":"orderId","in":"query","required":false,"description":"Filter for specific order id","schema":{"type":"integer","description":"Filter for specific order 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":"byok"}},"/v1/ecommerce:billbee/layout-api-get-list":{"get":{"operationId":"ecommerce_billbee_layout_api_get_list","summary":"GET /api/v1/layouts","description":"GET /api/v1/layouts","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":"byok"}},"/v1/ecommerce:billbee/order-api-get-list":{"get":{"operationId":"ecommerce_billbee_order_api_get_list","summary":"Get a list of all orders optionally filtered by date","description":"GET /api/v1/orders","tags":["ecommerce"],"parameters":[{"name":"minOrderDate","in":"query","required":false,"description":"Specifies the oldest order date to include in the response","schema":{"type":"string","description":"Specifies the oldest order date to include in the response"}},{"name":"maxOrderDate","in":"query","required":false,"description":"Specifies the newest order date to include in the response","schema":{"type":"string","description":"Specifies the newest order date to include in the response"}},{"name":"page","in":"query","required":false,"description":"Specifies the page to request","schema":{"type":"integer","description":"Specifies the page to request"}},{"name":"pageSize","in":"query","required":false,"description":"Specifies the pagesize. Defaults to 50, max value is 250","schema":{"type":"integer","description":"Specifies the pagesize. Defaults to 50, max value is 250"}},{"name":"shopId","in":"query","required":false,"description":"Specifies a list of shop ids for which invoices should be included","schema":{"type":"array","description":"Specifies a list of shop ids for which invoices should be included"}},{"name":"orderStateId","in":"query","required":false,"description":"Specifies a list of state ids to include in the response","schema":{"type":"array","description":"Specifies a list of state ids to include in the response"}},{"name":"tag","in":"query","required":false,"description":"Specifies a list of tags the order must have attached to be included in the response","schema":{"type":"array","description":"Specifies a list of tags the order must have attached to be included in the response"}},{"name":"minimumBillBeeOrderId","in":"query","required":false,"description":"If given, all delivered orders have an Id greater than or equal to the given minimumOrderId","schema":{"type":"integer","description":"If given, all delivered orders have an Id greater than or equal to the given minimumOrderId"}},{"name":"modifiedAtMin","in":"query","required":false,"description":"If given, the last modification has to be newer than the given date","schema":{"type":"string","description":"If given, the last modification has to be newer than the given date"}},{"name":"modifiedAtMax","in":"query","required":false,"description":"If given, the last modification has to be older or equal than the given date.","schema":{"type":"string","description":"If given, the last modification has to be older or equal than the given date."}},{"name":"articleTitleSource","in":"query","required":false,"description":"The source field for the article title. 0 = Order Position (default), 1 = Article Title, 2 = Article Invoice Text","schema":{"type":"integer","enum":[0,1,2,3],"description":"The source field for the article title. 0 = Order Position (default), 1 = Article Title, 2 = Article Invoice Text"}},{"name":"excludeTags","in":"query","required":false,"description":"If true the list of tags passed to the call are used to filter orders to not include these tags","schema":{"type":"boolean","description":"If true the list of tags passed to the call are used to filter orders to not include these tags"}}],"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:billbee/order-api-post-new-order":{"post":{"operationId":"ecommerce_billbee_order_api_post_new_order","summary":"Creates a new order in the Billbee account","description":"POST /api/v1/orders","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"shopId":{"type":"integer","description":"Deprecated, if orderData.ApiAccountId is set, it will be used instead of 'shopId'"},"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":"byok"}},"/v1/ecommerce:billbee/order-api-create-delivery-note":{"post":{"operationId":"ecommerce_billbee_order_api_create_delivery_note","summary":"Create an delivery note for an existing order. This request is extra throttled by order and api key to a…","description":"POST /api/v1/orders/CreateDeliveryNote/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The internal billbee id of the order"},"includePdf":{"type":"boolean","description":"If true, the PDF is included in the response as base64 encoded string"},"sendToCloudId":{"type":"integer","description":"Optionally specify the id of a billbee connected cloud device to send the pdf to"}}}}}},"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":"byok"}},"/v1/ecommerce:billbee/order-api-create-invoice":{"post":{"operationId":"ecommerce_billbee_order_api_create_invoice","summary":"Create an invoice for an existing order. This request is extra throttled by order and api key to a maximum…","description":"POST /api/v1/orders/CreateInvoice/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The internal billbee id of the order"},"includeInvoicePdf":{"type":"boolean","description":"If true, the PDF is included in the response as base64 encoded string"},"templateId":{"type":"integer","description":"You can pass the id of an invoice template to overwrite the assigned template for invoice creation"},"sendToCloudId":{"type":"integer","description":"You can pass the id of a connected cloud printer/storage to send the invoice to it"}}}}}},"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":"byok"}},"/v1/ecommerce:billbee/order-api-get-patchable-fields":{"get":{"operationId":"ecommerce_billbee_order_api_get_patchable_fields","summary":"Returns a list of fields which can be updated with the orders/{id} patch call","description":"GET /api/v1/orders/PatchableFields","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":"byok"}},"/v1/ecommerce:billbee/order-api-get-by-ext-ref":{"get":{"operationId":"ecommerce_billbee_order_api_get_by_ext_ref","summary":"Get a single order by its external order number","description":"GET /api/v1/orders/findbyextref/{extRef}","tags":["ecommerce"],"parameters":[{"name":"extRef","in":"query","required":true,"description":"The extern order number of the order","schema":{"type":"string","description":"The extern order number of the order"}}],"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:billbee/order-api-get-invoice-list":{"get":{"operationId":"ecommerce_billbee_order_api_get_invoice_list","summary":"Get a list of all invoices optionally filtered by date. This request ist throttled to 1 per 1 minute for…","description":"GET /api/v1/orders/invoices","tags":["ecommerce"],"parameters":[{"name":"minInvoiceDate","in":"query","required":false,"description":"Specifies the oldest invoice date to include","schema":{"type":"string","description":"Specifies the oldest invoice date to include"}},{"name":"maxInvoiceDate","in":"query","required":false,"description":"Specifies the newest invoice date to include","schema":{"type":"string","description":"Specifies the newest invoice date to include"}},{"name":"page","in":"query","required":false,"description":"Specifies the page to request","schema":{"type":"integer","description":"Specifies the page to request"}},{"name":"pageSize","in":"query","required":false,"description":"Specifies the pagesize. Defaults to 50, max value is 250","schema":{"type":"integer","description":"Specifies the pagesize. Defaults to 50, max value is 250"}},{"name":"shopId","in":"query","required":false,"description":"Specifies a list of shop ids for which invoices should be included","schema":{"type":"array","description":"Specifies a list of shop ids for which invoices should be included"}},{"name":"orderStateId","in":"query","required":false,"description":"Specifies a list of state ids to include in the response","schema":{"type":"array","description":"Specifies a list of state ids to include in the response"}},{"name":"tag","in":"query","required":false,"schema":{"type":"array"}},{"name":"minPayDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"maxPayDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"includePositions","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"excludeTags","in":"query","required":false,"description":"If true the list of tags passed to the call are used to filter orders to not include these tags","schema":{"type":"boolean","description":"If true the list of tags passed to the call are used to filter orders to not include these tags"}}],"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:billbee/order-api-get":{"get":{"operationId":"ecommerce_billbee_order_api_get","summary":"Get a single order by its internal billbee id. This request is throttled to 6 calls per order in one minute","description":"GET /api/v1/orders/{id}","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The internal billbee id of the order","schema":{"type":"integer","description":"The internal billbee id of the order"}},{"name":"articleTitleSource","in":"query","required":false,"description":"The source field for the article title. 0 = Order Position (default), 1 = Article Title, 2 = Article Invoice Text","schema":{"type":"integer","enum":[0,1,2,3],"description":"The source field for the article title. 0 = Order Position (default), 1 = Article Title, 2 = Article Invoice Text"}}],"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:billbee/order-api-patch-order":{"post":{"operationId":"ecommerce_billbee_order_api_patch_order","summary":"Updates one or more fields of an order","description":"PATCH /api/v1/orders/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer"},"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":"byok"}},"/v1/ecommerce:billbee/order-api-update-state":{"post":{"operationId":"ecommerce_billbee_order_api_update_state","summary":"Changes the main state of a single order","description":"PUT /api/v1/orders/{id}/orderstate","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The internal id of the order"},"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":"byok"}},"/v1/ecommerce:billbee/order-api-parse-placeholders":{"post":{"operationId":"ecommerce_billbee_order_api_parse_placeholders","summary":"Parses a text and replaces all placeholders","description":"POST /api/v1/orders/{id}/parse-placeholders","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The id of the order"},"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":"byok"}},"/v1/ecommerce:billbee/order-api-send-message":{"post":{"operationId":"ecommerce_billbee_order_api_send_message","summary":"Sends a message to the buyer","description":"POST /api/v1/orders/{id}/send-message","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The id of the order"},"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":"byok"}},"/v1/ecommerce:billbee/order-api-add-shipment":{"post":{"operationId":"ecommerce_billbee_order_api_add_shipment","summary":"Add a shipment to a given order","description":"POST /api/v1/orders/{id}/shipment","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The internal billbee id of the order"},"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":"byok"}},"/v1/ecommerce:billbee/order-api-tags-create":{"post":{"operationId":"ecommerce_billbee_order_api_tags_create","summary":"Attach one or more tags to an order","description":"POST /api/v1/orders/{id}/tags","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The internal id of the order"},"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":"byok"}},"/v1/ecommerce:billbee/order-api-tags-update":{"post":{"operationId":"ecommerce_billbee_order_api_tags_update","summary":"Sets the tags attached to an order","description":"PUT /api/v1/orders/{id}/tags","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The internal id of the order"},"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":"byok"}},"/v1/ecommerce:billbee/order-api-trigger-event":{"post":{"operationId":"ecommerce_billbee_order_api_trigger_event","summary":"Triggers a rule event","description":"POST /api/v1/orders/{id}/trigger-event","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The id of the order"},"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":"byok"}},"/v1/ecommerce:billbee/article-get-list":{"get":{"operationId":"ecommerce_billbee_article_get_list","summary":"Get a list of all products","description":"GET /api/v1/products","tags":["ecommerce"],"parameters":[{"name":"page","in":"query","required":false,"description":"The current page to request starting with 1","schema":{"type":"integer","description":"The current page to request starting with 1"}},{"name":"pageSize","in":"query","required":false,"description":"The pagesize for the result list. Values between 1 and 250 are allowed","schema":{"type":"integer","description":"The pagesize for the result list. Values between 1 and 250 are allowed"}},{"name":"minCreatedAt","in":"query","required":false,"description":"Optional the oldest create date of the articles to be returned","schema":{"type":"string","description":"Optional the oldest create date of the articles to be returned"}},{"name":"minimumBillBeeArticleId","in":"query","required":false,"schema":{"type":"integer"}},{"name":"maximumBillBeeArticleId","in":"query","required":false,"schema":{"type":"integer"}}],"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:billbee/article-create-article":{"post":{"operationId":"ecommerce_billbee_article_create_article","summary":"Creates a new product","description":"POST /api/v1/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":"byok"}},"/v1/ecommerce:billbee/article-get-patchable-fields":{"get":{"operationId":"ecommerce_billbee_article_get_patchable_fields","summary":"Returns a list of fields which can be updated with the patch call","description":"GET /api/v1/products/PatchableFields","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":"byok"}},"/v1/ecommerce:billbee/article-get-category":{"get":{"operationId":"ecommerce_billbee_article_get_category","summary":"GEts a list of all defined categories","description":"GET /api/v1/products/category","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":"byok"}},"/v1/ecommerce:billbee/article-get-custom-fields":{"get":{"operationId":"ecommerce_billbee_article_get_custom_fields","summary":"Queries a list of all custom fields","description":"GET /api/v1/products/custom-fields","tags":["ecommerce"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer"}}],"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:billbee/article-get-custom-field":{"get":{"operationId":"ecommerce_billbee_article_get_custom_field","summary":"Queries a single custom field","description":"GET /api/v1/products/custom-fields/{id}","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the custom field to query","schema":{"type":"integer","description":"The id of the custom field to query"}}],"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:billbee/article-delete-images":{"post":{"operationId":"ecommerce_billbee_article_delete_images","summary":"Delete multiple images by id","description":"POST /api/v1/products/images/delete","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":"byok"}},"/v1/ecommerce:billbee/article-get-image":{"get":{"operationId":"ecommerce_billbee_article_get_image","summary":"Returns a single image by id","description":"GET /api/v1/products/images/{imageId}","tags":["ecommerce"],"parameters":[{"name":"imageId","in":"query","required":true,"description":"The Id of the image","schema":{"type":"integer","description":"The Id of the image"}}],"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:billbee/article-delete-image":{"post":{"operationId":"ecommerce_billbee_article_delete_image","summary":"Deletes a single image by id","description":"DELETE /api/v1/products/images/{imageId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["imageId"],"properties":{"imageId":{"type":"integer","description":"The image 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":"byok"}},"/v1/ecommerce:billbee/article-get-reserved-amount":{"get":{"operationId":"ecommerce_billbee_article_get_reserved_amount","summary":"Queries the reserved amount for a single article by id or by sku","description":"GET /api/v1/products/reservedamount","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id or the sku of the article to query","schema":{"type":"string","description":"The id or the sku of the article to query"}},{"name":"lookupBy","in":"query","required":false,"description":"Either the value id or the value sku to specify the meaning of the id parameter","schema":{"type":"string","description":"Either the value id or the value sku to specify the meaning of the id parameter"}},{"name":"stockId","in":"query","required":false,"description":"Optional the stock id if the multi stock feature is enabled","schema":{"type":"integer","description":"Optional the stock id if the multi stock feature is enabled"}}],"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:billbee/article-get-stocks":{"get":{"operationId":"ecommerce_billbee_article_get_stocks","summary":"Query all defined stock locations","description":"GET /api/v1/products/stocks","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":"byok"}},"/v1/ecommerce:billbee/article-update-stock":{"post":{"operationId":"ecommerce_billbee_article_update_stock","summary":"Update the stock qty of an article","description":"POST /api/v1/products/updatestock","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":"byok"}},"/v1/ecommerce:billbee/article-update-stock-code":{"post":{"operationId":"ecommerce_billbee_article_update_stock_code","summary":"Update the stock code of an article","description":"POST /api/v1/products/updatestockcode","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":"byok"}},"/v1/ecommerce:billbee/article-update-stock-multiple":{"post":{"operationId":"ecommerce_billbee_article_update_stock_multiple","summary":"Update the stock qty for multiple articles at once","description":"POST /api/v1/products/updatestockmultiple","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":"byok"}},"/v1/ecommerce:billbee/article-get-article":{"get":{"operationId":"ecommerce_billbee_article_get_article","summary":"Queries a single article by id or by sku","description":"GET /api/v1/products/{id}","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id or the sku of the article to query","schema":{"type":"string","description":"The id or the sku of the article to query"}},{"name":"lookupBy","in":"query","required":false,"description":"Either the value id, ean or the value sku to specify the meaning of the id parameter.","schema":{"type":"string","description":"Either the value id, ean or the value sku to specify the meaning of the id parameter."}}],"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:billbee/article-patch-article":{"post":{"operationId":"ecommerce_billbee_article_patch_article","summary":"Updates one or more fields of a product","description":"PATCH /api/v1/products/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"The id of the Product"},"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":"byok"}},"/v1/ecommerce:billbee/article-delete-article":{"post":{"operationId":"ecommerce_billbee_article_delete_article","summary":"Deletes a product","description":"DELETE /api/v1/products/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"The id of the Product"}}}}}},"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":"byok"}},"/v1/ecommerce:billbee/article-get-images":{"get":{"operationId":"ecommerce_billbee_article_get_images","summary":"Returns a list of all images of the product","description":"GET /api/v1/products/{productId}/images","tags":["ecommerce"],"parameters":[{"name":"productId","in":"query","required":true,"description":"The Id of the product","schema":{"type":"integer","description":"The Id of the product"}}],"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:billbee/article-put-images":{"post":{"operationId":"ecommerce_billbee_article_put_images","summary":"Add multiple images to a product or replace the product images by the given images","description":"PUT /api/v1/products/{productId}/images","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["productId","body"],"properties":{"productId":{"type":"integer","description":"The id of the product"},"replace":{"type":"boolean","description":"If you pass true, the images will be replaced by the passed images. Otherwise the passed images will be appended to the product."},"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":"byok"}},"/v1/ecommerce:billbee/article-get-image-from-product":{"get":{"operationId":"ecommerce_billbee_article_get_image_from_product","summary":"Returns a single image by id","description":"GET /api/v1/products/{productId}/images/{imageId}","tags":["ecommerce"],"parameters":[{"name":"productId","in":"query","required":true,"description":"The Id of the product","schema":{"type":"integer","description":"The Id of the product"}},{"name":"imageId","in":"query","required":true,"description":"The Id of the image","schema":{"type":"integer","description":"The Id of the image"}}],"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:billbee/article-put-image":{"post":{"operationId":"ecommerce_billbee_article_put_image","summary":"Add or update an existing image of a product","description":"PUT /api/v1/products/{productId}/images/{imageId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["productId","imageId","body"],"properties":{"productId":{"type":"integer","description":"The product id"},"imageId":{"type":"integer","description":"The image id. If you pass 0, the image will be added"},"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":"byok"}},"/v1/ecommerce:billbee/article-delete-image-from-product":{"post":{"operationId":"ecommerce_billbee_article_delete_image_from_product","summary":"Deletes a single image from a product","description":"DELETE /api/v1/products/{productId}/images/{imageId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["productId","imageId"],"properties":{"productId":{"type":"integer","description":"The product id"},"imageId":{"type":"integer","description":"The image 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":"byok"}},"/v1/ecommerce:billbee/search-search":{"post":{"operationId":"ecommerce_billbee_search_search","summary":"Search for products, customers and orders. Type can be \"order\", \"product\" and / or \"customer\" Term can…","description":"POST /api/v1/search","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":"byok"}},"/v1/ecommerce:billbee/shipment-get-ping":{"get":{"operationId":"ecommerce_billbee_shipment_get_ping","summary":"GET /api/v1/shipment/ping","description":"GET /api/v1/shipment/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":"byok"}},"/v1/ecommerce:billbee/shipment-post-shipment":{"post":{"operationId":"ecommerce_billbee_shipment_post_shipment","summary":"Creates a new shipment with the selected Shippingprovider","description":"POST /api/v1/shipment/shipment","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":"byok"}},"/v1/ecommerce:billbee/shipment-get-list":{"get":{"operationId":"ecommerce_billbee_shipment_get_list","summary":"Get a list of all shipments optionally filtered by date. All parameters are optional.","description":"GET /api/v1/shipment/shipments","tags":["ecommerce"],"parameters":[{"name":"page","in":"query","required":false,"description":"Specifies the page to request.","schema":{"type":"integer","description":"Specifies the page to request."}},{"name":"pageSize","in":"query","required":false,"description":"Specifies the pagesize. Defaults to 50, max value is 250","schema":{"type":"integer","description":"Specifies the pagesize. Defaults to 50, max value is 250"}},{"name":"createdAtMin","in":"query","required":false,"description":"Specifies the oldest shipment date to include in the response","schema":{"type":"string","description":"Specifies the oldest shipment date to include in the response"}},{"name":"createdAtMax","in":"query","required":false,"description":"Specifies the newest shipment date to include in the response","schema":{"type":"string","description":"Specifies the newest shipment date to include in the response"}},{"name":"orderId","in":"query","required":false,"description":"Get shipments for this order only.","schema":{"type":"integer","description":"Get shipments for this order only."}},{"name":"minimumShipmentId","in":"query","required":false,"description":"Get Shipments with a shipment greater or equal than this id. New shipments have a greater id than older shipments.","schema":{"type":"integer","description":"Get Shipments with a shipment greater or equal than this id. New shipments have a greater id than older shipments."}},{"name":"shippingProviderId","in":"query","required":false,"description":"Get Shippings for the specified shipping provider only.","schema":{"type":"integer","description":"Get Shippings for the specified shipping provider only."}}],"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:billbee/shipment-get-shipping-carrier":{"get":{"operationId":"ecommerce_billbee_shipment_get_shipping_carrier","summary":"Queries the currently available shipping carriers.","description":"GET /api/v1/shipment/shippingcarriers","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":"byok"}},"/v1/ecommerce:billbee/shipment-get-shippingproviders":{"get":{"operationId":"ecommerce_billbee_shipment_get_shippingproviders","summary":"Query all defined shipping providers","description":"GET /api/v1/shipment/shippingproviders","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":"byok"}},"/v1/ecommerce:billbee/shipment-ship-with-label":{"post":{"operationId":"ecommerce_billbee_shipment_ship_with_label","summary":"Creates a shipment for an order in billbee","description":"POST /api/v1/shipment/shipwithlabel","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":"byok"}},"/v1/ecommerce:billbee/web-hook-management-get":{"get":{"operationId":"ecommerce_billbee_web_hook_management_get","summary":"Gets all registered WebHooks for a given user.","description":"GET /api/v1/webhooks","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":"byok"}},"/v1/ecommerce:billbee/web-hook-management-post":{"post":{"operationId":"ecommerce_billbee_web_hook_management_post","summary":"Registers a new WebHook for a given user.","description":"POST /api/v1/webhooks","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":"byok"}},"/v1/ecommerce:billbee/web-hook-management-delete-all":{"post":{"operationId":"ecommerce_billbee_web_hook_management_delete_all","summary":"Deletes all existing WebHook registrations.","description":"DELETE /api/v1/webhooks","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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:billbee/web-hook-management-get-filters":{"get":{"operationId":"ecommerce_billbee_web_hook_management_get_filters","summary":"Returns a list of all known filters you can use to register webhooks","description":"GET /api/v1/webhooks/filters","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":"byok"}},"/v1/ecommerce:billbee/web-hook-management-lookup":{"get":{"operationId":"ecommerce_billbee_web_hook_management_lookup","summary":"Looks up a registered WebHook with the given {id} for a given user.","description":"GET /api/v1/webhooks/{id}","tags":["ecommerce"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"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:billbee/web-hook-management-put":{"post":{"operationId":"ecommerce_billbee_web_hook_management_put","summary":"Updates an existing WebHook registration.","description":"PUT /api/v1/webhooks/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The WebHook 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":"byok"}},"/v1/ecommerce:billbee/web-hook-management-delete":{"post":{"operationId":"ecommerce_billbee_web_hook_management_delete","summary":"Deletes an existing WebHook registration.","description":"DELETE /api/v1/webhooks/{id}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The WebHook 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":"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"}}}}}}}