SnowBee Public API

Browse the endpoints below for request parameters and response fields. The complete machine-readable document is available as openapi.json.

OpenAPI 3.1.0 · 84 operations

General

GET/healthcheck/healthcheck

Authentication

POST/oauth2/tokenCreate an access token POST/v1/tenants/{tenantId}/oauth2/v2.0/tokenCreate an access token using the tenant-scoped compatibility endpoint

E-commerce

GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/settingsGet e-commerce settings GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/product_schema/brandsGet product schema for brands GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/product_schema/product_categoriesGet product schema for product categories GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/product_schema/main_product_groupsGet product schema for main product groups GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/product_schema/sub_product_groupsGet product schema for sub product groups GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/product_schema/product_conceptsGet product schema for product concepts GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/product_schema/exclusivity_levelsGet product schema for exclusivity levels GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/product_schema/product_colorsGet product schema for product colors GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/product_schema/sizesGet product schema for sizes GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/product_schema/dynamic_attributesGet product schema for dynamic attributes GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/product_schema/dynamic_attributes_optionsGet product schema for dynamic attributes options GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/product_schema/unit_of_measuresGet unit of measures GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/productsList product IDs GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/products/{productId}Get product GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/skus/{skuId}/inventoryGet SKU available inventory GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/retail_storesGet retail stores GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/campaignsGet campaigns POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/products/trigger_eventsTrigger product events POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/inventory/trigger_eventsTrigger inventory events POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/ordersCreate sales order GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/orders/{orderId}Get sales order GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/customers/{customerId}/ordersGet customer order history POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/click_and_collectCreate click & collect reservation GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/customers/{customerId}Get customer PUT/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/customers/{customerId}Create or update customer GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/customers/by_email/{email}Get customer by email POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/customers/{customerId}/loyalty_membershipRegister or re-invite a loyalty customer PUT/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/customers/{customerId}/addressesUpdate customer addresses PUT/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/push-customerPush customer from eCommerce Auth POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/orders/{salesOrderId}/captures/{captureId}/payment_captureUpdate payment capture status POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/orders/{salesOrderId}/refunds/{refundId}/confirmConfirm refund GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/barcodes/code128/{value}Generate Code128 barcode SVG

CartsExperimental

POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/cartsCreate an empty cart GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}Get a cart POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}/linesAdd a SKU to a cart PUT/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}/customerBind a cart to a logged-in shopper DELETE/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}/customerUnbind a cart from its shopper PUT/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}/lines/{lineId}Set a cart line's quantity DELETE/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}/lines/{lineId}Remove a line from a cart POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}/checkoutCheck out a cart POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}/payment_sessionOpen a payment session for a cart POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}/delivery_optionsList delivery options for a cart POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}/pickup_pointsList pickup points for a delivery option

CatalogExperimental

GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/products/searchList and search the store's products GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/products/frequently_bought_togetherList products frequently bought together with given products

StoreExperimental

GET/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/storeThe store

Loyalty Programs

GET/v1/tenants/{tenantId}/loyalty_programs/{loyaltyProgramId}/retail_storesGet retail stores for loyalty program

Demand PlanningExperimental

GET/v1/tenants/{tenantId}/demand_planning/limitsPublished upload limits GET/v1/tenants/{tenantId}/demand_planning/retail_storesList retail stores GET/v1/tenants/{tenantId}/demand_planning/ecom_storesList ecom stores GET/v1/tenants/{tenantId}/demand_planning/sales_forecast_batches/{batchId}Get the status of a batch of sales forecasts PUT/v1/tenants/{tenantId}/demand_planning/sales_forecast_batches/{batchId}Upload a batch of sales forecasts GET/v1/tenants/{tenantId}/demand_planning/replenishment_parameter_batches/{batchId}Get the status of a batch of replenishment parameters PUT/v1/tenants/{tenantId}/demand_planning/replenishment_parameter_batches/{batchId}Upload a batch of replenishment parameters GET/v1/tenants/{tenantId}/demand_planning/sales_forecastsList the sales forecasts SnowBee currently holds GET/v1/tenants/{tenantId}/demand_planning/replenishment_parametersList effective replenishment parameters

CoreExperimental

GET/v1/tenants/{tenantId}/core/brandsSynchronize brands POST/v1/tenants/{tenantId}/core/brandsCreate a brand GET/v1/tenants/{tenantId}/core/retail_chainsSynchronize retail_chains GET/v1/tenants/{tenantId}/core/organisational_units/companiesSynchronize companies GET/v1/tenants/{tenantId}/core/organisational_units/warehousesSynchronize warehouses GET/v1/tenants/{tenantId}/core/product_categoriesSynchronize product_categories GET/v1/tenants/{tenantId}/core/main_product_groupsSynchronize main_product_groups GET/v1/tenants/{tenantId}/core/sub_product_groupsSynchronize sub_product_groups GET/v1/tenants/{tenantId}/core/product_conceptsSynchronize product_concepts GET/v1/tenants/{tenantId}/core/product_lifecycle_statesSynchronize product_lifecycle_states GET/v1/tenants/{tenantId}/core/sizesSynchronize sizes GET/v1/tenants/{tenantId}/core/sales_order_typesSynchronize sales_order_types GET/v1/tenants/{tenantId}/core/reason_codesSynchronize reason_codes GET/v1/tenants/{tenantId}/core/resourcesSynchronize resources GET/v1/tenants/{tenantId}/core/dynamic_attributesSynchronize dynamic_attributes GET/v1/tenants/{tenantId}/core/vat_groupsSynchronize vat_groups GET/v1/tenants/{tenantId}/core/loyalty_programsSynchronize loyalty_programs GET/v1/tenants/{tenantId}/core/organisational_units/retail_storesSynchronize retail_stores GET/v1/tenants/{tenantId}/core/organisational_units/ecom_storesSynchronize ecom_stores GET/v1/tenants/{tenantId}/core/customers/b2bSynchronize b2b_customers GET/v1/tenants/{tenantId}/core/customers/b2cSynchronize b2c_customers GET/v1/tenants/{tenantId}/core/suppliers/externalSynchronize external_suppliers GET/v1/tenants/{tenantId}/core/transactions/sales_ordersSynchronize sales_orders GET/v1/tenants/{tenantId}/core/transactions/invoicesSynchronize invoices GET/v1/tenants/{tenantId}/core/brands/{id}Get a brand

Schemas

Reusable request and response definitions.