Skip to content
Get started

API Reference

Libraries

dotnet add package Colleqtive.Sdk
pip install colleqtive-sdk
npm install @colleqtive/sdk

API Overview

Categories

List Categories
GET/api/v2/public/categories
Create or Update Categories
POST/api/v2/public/categories

Stores

List Stores
GET/api/v2/public/stores
Create Stores
POST/api/v2/public/stores

Locations

List Locations
GET/api/v2/public/stores/{store_number}/locations
List Location Products
GET/api/v2/public/stores/{store_number}/locations/{location_code}/products
List Locations Products
GET/api/v2/public/stores/{store_number}/locations/products

Reason Codes

List Reason Codes
GET/api/v2/public/reasoncodes
Create Reason Codes
POST/api/v2/public/reasoncodes

Store Product Logs

List Store Product Logs
GET/api/v2/public/products/stock/storeproductlogs
Create Store Product Logs
POST/api/v2/public/stores/{store_number}/products/stock/storeproductlogs

Store Products

List Store Products Stock
GET/api/v2/public/storeproducts/stock
Retrieve Store Product Stock
GET/api/v2/public/stores/{store_number}/products/{product_number}/stock
Retrieve Store Product Surrounding
GET/api/v2/public/stores/{store_number}/storeproducts/{product_number}/surrounding
Update Store Products
PUT/api/v2/public/stores/{store_number}/storeproducts
Create Store Products
POST/api/v2/public/stores/{store_number}/storeproducts

Counting Lines

Create External Counting Lines
POST/api/v2/public/externalcountinglines

Products

Create or Update Products
POST/api/v2/public/products
List Products
GET/api/v2/public/products
Delete Products
DELETE/api/v2/public/products
Update Product Attributes
PUT/api/v2/public/products/attributes
Create Prices
POST/api/v2/public/products/prices
Create Discount Prices
POST/api/v2/public/products/discountprices
Create Product Free Fields
POST/api/v2/public/products/freefields

Movement

Create Movement
Deprecated
POST/api/v2/public/stores/{store_number}/storeproductlocation/movement

Deliveries

List Deliveries
GET/api/v2/public/orders/deliveries
Create Store Deliveries
POST/api/v2/public/stores/{store_number}/orders/deliveries
Create Multi Store Deliveries
POST/api/v2/public/orders/deliveries

Receipts

List Receipts
GET/api/v2/public/orders/receipts
List Store Receipts
GET/api/v2/public/stores/{store_number}/orders/receipts

Product Lists

Create Product List
POST/api/v2/public/stores/{store_number}/productlists
List Product Lists
GET/api/v2/public/stores/{store_number}/productlists
Delete Product List
DELETE/api/v2/public/stores/{store_number}/productlists
Update Product List Lines
POST/api/v2/public/stores/{store_number}/productlists/{id}

Product List Types

List Product List Types
GET/api/v2/public/productlisttypes
Create Product List Type
POST/api/v2/public/productlisttypes
Delete Product List Type
DELETE/api/v2/public/productlisttypes/{id}

Suppliers

List Suppliers
GET/api/v2/public/suppliers

Movement Assignments

Reopen Movement Assignment
PUT/api/v2/public/stores/{store_number}/movementassignment/reopen

Replenishment Advice Lines History

Delete Replenishment Advice Lines History
DELETE/api/v2/public/replenishmentadvicelineshistory

Customer Orders

List Customer Orders
GET/api/v2/public/stores/{store_number}/orders/customerorders
Create Customer Orders
POST/api/v2/public/stores/{store_number}/orders/customerorders
Create Multi Store Customer Orders
POST/api/v2/public/orders/customerorders
Update Customer Order
PUT/api/v2/public/stores/{store_number}/orders/customerorder
Create Customer Order Clearance
POST/api/v2/public/customerorders/clearance