Jump to Content
Home
Guides
API Reference
Release Notes
v3.109.0
Log In
API Reference
Log In
v3.109.0
Home
Guides
API Reference
Release Notes
Classification Categories Administration
All
Pages
Start typing to search…
JUMP TO
Front API Definitions
Assets
Get asset filtered by sizeType
Bundles
Get a bundle by external id
Get items of a bundle by bundle external id
Buying Lists
Fetch a user buying lists
Create a new buying list
Delete a buying list by id
Fetch a buying list
Update a buying list
Change buying list's owner
Delete buying list items
Add or Update Buying List Items
Fetch a user buying lists
Carts
Initialize orders in draft
Update a cart
Retrieve one cart
Delete one cart
Create a cart
Retrieve paginated carts in context
Delete all carts in context
Delete cart for one user
Get the cart of the specified user
Create empty cart for one user
Get cart import processing progress
Import cart from uploaded file. This operation will delete any already existing cart for the connected user.
Get cart import error report
Set or Update billing address or for this cart
Delete cart lines using offer price ids
Add or update offer with quantity in cart
Cart Lines
Delete cart lines on an existing cart
Retrieve paginated cart lines of a cart
Add or update or delete cart lines on an existing cart
Add or update or delete cart lines on an existing cart
Custom Fields
/v1/shop/custom-fields
/v1/shop/custom-fields/{id}/media
/v1/shop/custom-fields/{id}/media
Customer Accounts
/v1/shop/customer-accounts
/v1/shop/customer-accounts
Update Customer Account
Retrieve shipping or billing addresses of customer account
Create new address
Delete address
Update existing address
Get custom fields available for customer accounts
Get orders of customer account
Retrieve current customer account users.
/v2/shop/customer-accounts
Incidents
Create order incident
Get incidents
Get incidents by type
Get order incidents
Navigation Categories
Get all navigation category
Get online navigation category
Get all navigation category
Get all navigation category
Offer Inventories
Get paginated front offer inventories
Retrieve paginated offer inventories of a variant
Get paginated front offer custom fields
Offer Prices
Get paginated offer prices
Operations
OPERATION-500 - Return a single Operation by ID
OPERATION-550 - List ACTIVE Operations visible to the caller
OPERATION-551 - List Operation lines
Suppliers
Recherche paginée des fournisseurs
Fetch one supplier by id
Orders
Update order shipping information
Update order logistics to CREATED
Update the billing address of a commercial order
ORDER-100 - Create a new commercial order
ORDER-104 - Create credit card registration
ORDER-108 - Create order
ORDER-150 - Update commercial order lines
ORDER-213 - Update the billing address of a commercial order
ORDER-500 - Retrieve a commercial order by ID
ORDER-560 - Retrieve paginated list of commercial orders
ORDER-560 - Retrieve paginated list of commercial orders
ORDER-561 - Retrieve paginated lines of a commercial order
Update order logistics to CREATED
Update status of order logistics to DRAFT_ORDER_ON_HOLD
Get payment page url for an order
Create preauthorization
Update order shipping address
Update order shipping information
Update order shipping type
Get all logistic orders paginated
Get all logistic orders paginated
Get order logistic custom fields
Get order logistic line custom fields
Create order incident
Create order incident
Get logistic order by id
Update order logistic custom fields value
Get all accounting documents from an order
Download an order accounting document
Approve logistic order
Fetch logistic order approvers
Update order billing Information
Cancel order logistic
Confirm reception of logistic order
Update DRAFT_ORDER_ON_HOLD logistic order status to CREATED
Disapprove logistic order
Download the order documents
Download the order documents
Get all order logistic lines paginated
Update confirmed quantity and custom field values of DRAFT_ORDER_ON_HOLD logistic order lines
Update order logistic line custom fields value
Update confirmed quantity of DRAFT_ORDER_ON_HOLD logistic order
Update order shipping Address
Find shipping information for order logistic
Update order shipping information
Update order shipping Type
Get the main reason types
Retrieve a rating and review on an order.
Add a rating and review on an order.
Get the main reason types
Get the main reason types
ORDER-300 - Delete a commercial order
ORDER-222 - Update custom fields on a commercial order
ORDER-350 - Delete one or more lines from a commercial order
Create a thread on the logistic order incident
Get thread associated to the incident by id
Add a message to the thread associated to the order incident
Add attachments to the thread associated to the order incident
Get the threads associated to the order
Create a thread on the order
Get thread associated to the order by its id
Add a message to the thread associated to the order
Add attachments to the thread associated to the order
Payments
Create a Mangopay customer account on provided account id
Get Mangopay customer account by account id
PAY-300 - Delete a stored payment method
PAY-501 - Retrieve available payment methods
PAY-102 - Retrieve additional payment details
PAY-101 - Initiate a payment
PAY-502 - Precheck Purchasing Card Level 3 readiness
Product Attributes
List attributes
Quotes
Get master quotes
Create a master quote
Delete a master quote
Get a master quote by id
Update a master quote
Create supplier quotes
Retrieve one supplier quote
Accept supplier quote and save it for later use
Update supplier quote custom fields
Decline supplier quote
Post message to quote
Init draft orders from supplier quote
Settings
Get settings for Front Office
Stores
Get Store by id
Customer Users
Fetch one customer user
Fetch one customer user
/v1/shop/customer-accounts/organisations
/v1/shop/customer-accounts/organisations
Update Customer Account Organisation
/v1/shop/customer-accounts/organisations/{organisationId}/addresses
Delete Organisation address
Update existing organisation address
Get orders for organisation
/v1/shop/customer-accounts/organisations/{organisationId}/users
/v1/shop/customer-users/{customerUserId}
/v1/shop/customer-users
/v1/shop/customer-users
/v1/shop/customer-users/activate
/v1/shop/customer-users/activate
Retrieve the addresses of the account and the organisations to which the user belongs
/v1/shop/customer-users/organisations
/v1/shop/customer-users/resend-activation-request
Update existing customer organisation user
/v1/shop/customer-users/{customerUserId}/customer-accounts
/v1/shop/customer-users/{customerUserId}/customer-accounts
Auth API Definitions
authentication
Return true if token exists and is not expired
Ask for an access token from a refresh token
Reset password
Delete current token session token
Send email for reset password
Ask for an access token
sso-authentication-controller
/auth/sso/init
/auth/sso/providers
/auth/sso/token
Admin API Definitions
DAM Administration
Fetch tenant configuration by client id
save tenant configuration
/v1/dam/links/{skuProduct}
Accounts Administration
ADM-ADDRESS-300 - Delete address
Validate Account
Update Customer Account payment type
Creating Customer User
Fetch paginated users from customer account id
Add sub organisation to customer account's organisation
Update Customer Account Organisation
Add organisation to customer account
Update existing address
Create new address
Retrieve shipping or billing addresses of customer account
Update Customer Account
Retrieve detail of customer account
Retrieve customer account names from djust
Create Customer Account
Update customer accounts status
Retrieve paginated customer account from djust
Get customer user accounts ADM-CUSTOMER-USER-550
Link accounts to a customer user ADM-CUSTOMER-USER-250
Product Units Administration
Fetch all unit
Create a new unit
Delete a product unit
Fetch a unit
Update a product unit
User Groups Administration
List users groups
List users groups for all clients
List users groups for all clients
Create group
delete group
List linked users roles by groupId
add roles to group
add roles to group
List users by groupId
Remove a user from group
Add a user in the group
Administration Settings
ADM-SETTINGS-500 - Get ITS settings
ADM-SETTINGS-201 - Update ITS settings
Assortments Administration
ADM-ASSORTMENT-350 - Remove variants from an assortment
Documents Administration
Delete aws document
Fetch documents by orderLogisticId
Upload new order document
Add aws document
Delete document
/v1/documents/{documentId}
Buying Policies Administration
Fetch paginated users from buying policy id
Replace buying policy approvers
Fetch one buying policy
Replace buying policy buyers
Does one buying policy exist, by name
Create a buying policy
Activate or deactivate buying policies
Fetch paginated buying policies
ADM-BUYING-POLICY-150 - Create credit hold(s) for Customer Accounts
ADM-BUYING-POLICY-151 - Create grace amounts for Customer Accounts
ADM-BUYING-POLICY-152 - Create quota rules for multiple account x supplier pairs
ADM-BUYING-POLICY-153 - Create quota groups (co-validation sets)
ADM-BUYING-POLICY-200 - Update credit control policy activation status
ADM-BUYING-POLICY-201 - Update default credit limit
ADM-BUYING-POLICY-202 - Update a credit hold
ADM-BUYING-POLICY-203 - Update a grace amount entry
ADM-BUYING-POLICY-204 - Update quota policy activation status
ADM-BUYING-POLICY-205 - Update default min quota value
ADM-BUYING-POLICY-206 - Update a specific quota override for a Customer Account x Supplier
ADM-BUYING-POLICY-207 - Update a quota group
ADM-BUYING-POLICY-300 - Delete a credit hold
ADM-BUYING-POLICY-301 - Delete a grace amount entry
ADM-BUYING-POLICY-302 - Delete a specific quota override for a Customer Account x Supplier
ADM-BUYING-POLICY-303 - Delete a quota group
ADM-BUYING-POLICY-500 - Get credit control policy configuration
ADM-BUYING-POLICY-501 - Get the current configuration of the quota buying policy
ADM-BUYING-POLICY-550 - List active or scheduled credit holds
ADM-BUYING-POLICY-551 - List all grace amounts
ADM-BUYING-POLICY-552 - Get blocking reasons for logistic orders
ADM-BUYING-POLICY-553 - Get specific quota configurations for Customer Account x Supplier pairs
ADM-BUYING-POLICY-554 - List quota groups
Catalog Views Administration
Add products to a catalog view
Fetch a catalog view products
Remove products to a catalog view
Add accounts to a catalog view
Fetch a catalog view accounts
Remove accounts from a catalog view
Fetch a catalog view
Create a new catalog view
Activate or deactivate catalog views
Fetch paginated catalog views
Delete catalog views
Add variants to a catalog view
Fetch a catalog view product variants
Remove variants from a catalog view
List products of a catalog view ADM-CATALOG-VIEW-PRODUCTS-550
Currency Exchange Rates Administration
Fetch currency exchange rates
Update currency exchange rates
Document Types Administration
/v1/documents/types
/v1/documents/types
/v1/documents/types/{documentTypeId}
Locales Administration
Get all locales that have been set based on its status
Add a new locale settings
Get available locales
Get main locale
Delete an existing locale settings
Update the active status of an existing locale settings
Offer Inventories Administration
Delete an offer price
Update offer prices
Create offer prices
Update offer prices status
Update offer inventory by id
Get one offer inventory by id
/v1/offer-inventories/export
Create offer inventories
Update offer inventories status
Get paginated offer inventories
Delete offers inventories
Get paginated offer inventories
Offer Prices Administration
Delete price list
Fetch all price lists
Create or update price lists
Operations Administration
ADM-OPERATION-100 - Create a new Operation
ADM-OPERATION-200 - Update a new Operation
ADM-OPERATION-201 - Update Operation status (activation / deactivation)
ADM-OPERATION-250 - Add variants to an Operation
ADM-OPERATION-251 - Add accounts to a PRIVATE Operation
ADM-OPERATION-300 - Delete an Operation
ADM-OPERATION-350 - Remove variants from an Operation
ADM-OPERATION-351 - Remove accounts from a PRIVATE Operation
ADM-OPERATION-500 - Return a single Operation by ID
ADM-OPERATION-550 - Return a paginated list of Operations
ADM-OPERATION-552 - Get accounts linked to a PRIVATE Operation
ADM-OPERATION-551 - Get variants associated with an Operation
Orders Administration
Validate order logistic payment
/v1/logistic-orders/{orderLogisticId}/payment/reconcile
Invalidate order logistic payment
/v1/logistic-orders/{orderLogisticId}/lines/{orderLogisticLineId}/threads
/v1/logistic-orders/{orderLogisticId}/lines/{orderLogisticLineId}/delete
Update confirmed quantity and price
Update custom field value
/v1/logistic-orders/{orderLogisticId}/lines
Get logistic order's history
Trigger export order in Integration
Decline fulfillment of logistic order
Update order logistic status to CREATED
Confirm shipment of logistic order
Update order logistic status to completed
Update an incident
Cancel order logistic
Fetch logistic order approvals
Accept logistic order
Get logistic order by id
/v1/logistic-orders/export
Get all logistic orders paginated
ADM-ORDER-551 - Retrieve logistic orders (with filters)
ADM-ORDER-550 – Retrieve forced validation history for a specific order
ADM-ORDER-150 - Force manual validation of blocked orders
ADM-ORDER-500 - Get payment information for a logistic order
ADM-ORDER-100 - Initiate a refund for a logistic order
Operator Users Administration
Order Incident Threads Administration
Get a thread associated to the incident by id
Close a thread associated to the order by id
Add a message to the thread associated to the incident
Update attachments of a message associated to the thread by id
Product Attributes Administration
List attributes
Create new attribute
Get attribute by id
Update attribute
Quotes Administration
get all supplier quotes filtered
Get one supplier quote
Update supplier quote status
Update supplier quote
Post message to supplier quote
Get one supplier quote related logistic orders
Order Threads Administration
/v1/order-thread-reasons/{threadReasonId}
/v1/order-thread-reasons/{threadReasonId}
/v1/order-thread-reasons
/v1/order-thread-reasons
Get all threads associated to the order
Get a thread associated to the order by id
Close a thread associated to the order by id
Add a message to the thread associated to the order
Update attachments a message associated to the thread by id
Payments Administration
ADM-TRANSACTION-552 - Get transaction event details by eventId
ADM-TRANSACTION-551 - List transaction events with search, filters and sorting
ADM-TRANSACTION-550 - List transactions with search, filters and sorting
Capture an authorized payment
Find all unreconciled transactions
ADM-PAY-103 - Create marketplace commission for supplier
ADM-PAY-300 - Delete a marketplace commission line
ADM-PAY-500 - Get marketplace commission for a supplier
ADM-PAY-201 - Update the status of a marketplace commission line
Roles Administration
List all client roles
Create Role at djust
Customer Users Administration
Fetch paginated customer users
Activate or deactivate customer user
Creating Customer User
Fetch one customer user
Create new address
Update customer user
Update customer user's groups
Payment Commissions Administration
ADM-PAY-501
ADM-PAY-200 - Update marketplace commission for supplier
ADM-SETTINGS-503 - Retrieve the platform payment commissions
ADM-SETTINGS-204 - Update platform payment commissions
Products Administration
Search result regrouping product, variant, attributes and offers
Search product with text expression for search and autocomplete
Update a product review
create a new product review
Get product variant attributes by product sku
Get stat reviews by product sku
Get product's reviews
Get related products by product sku
Get product's paginated offers - This route will replace PRODUCT-502
Get product's offers - This route will be replaced by PRODUCT-509
Get product by product identifier
Get product variant's suppliers
Get variant's offers
Get product variant by externalId
Get paginated product variant
Get thumbnails of a product regrouping product, stat reviews, attributs and bestOffer
Search product with text expression for search and autocomplete
Add related products
Delete related products
Get related products
Update a product
Delete product
Retrieve a product given its id
Retrieve paginated simple products view for back office
Retrieve paginated simple products view for back office
Update products status
/v1/products/export
Retrieve paginated simple products view from catalog view id
Create new product
Update products status
Retrieve products by skus
Update a product
Retrieve assortments containing variants of the product
Retrieve catalog views containing variants of the product
Product Variants Administration
Update a product variant
/v1/product-variants/{productVariantId}
Ajout d'un produit variant
Activate or deactivate product variant
Get paginated product variant
ADM-PRODUCT-VARIANT-550 - Get assortments linked to a product variant
ADM-PRODUCT-VARIANT-551 - Get catalog views linked to a product variant
ADM-PRODUCT-VARIANT-552 - Get navigation categories linked to a product variant
Get one product variant with offers and bestOffer
Navigation Categories Administration
Get root navigation category
Create new navigation category
Delete navigation category
Get navigation category
Update navigation category
Remove assortments from navigation category
Add assortments to navigation category
Remove classification category from navigation category
Add classification category to navigation category
/v1/navigation-categories/{navigationCategoryId}/custom-fields
Get navigation category with parent tree
/v1/navigation-categories/{navigationCategoryId}/status
Supplier Users Administration
Activate or deactivate supplier user
Get supplier user by Id
Update supplier user
Stores Administration
Update store view
Get one store view
Delete store view
Add store view urls
Add store view url
Get store view urls
Create new store view
Get all store views from current Store
Get paginated Stores
Create a new Store
Update a Store
Get a Store
Get all store locales
Add locale to the store
Update locale
Delete locale from the store
Tenant Settings
/v1/tenants/init/{apiKey}
ADM-SETTINGS-200 - Update Mirakl connector settings
Transactions Administration
ADM-TRANSACTION-550 - List transactions with search, filters and sorting
ADM-TRANSACTION-551 - List transaction events.
ADM-TRANSACTION-570 - Get a transaction event
Core Settings
/v2/settings/indexation
/v2/settings/indexation
Return Store settings
/v1/settings/search
/v1/settings/search
Retrieve the current mapping of product fields
Retrieve the current settings mirakl
Set a new mapping of mailer
Update properties of mailer setting
Retrieve the current mapping of mailer
Get config on pay for lemonway
Retrieve the current mapping of keycloak
/v1/settings/indexation/custom-fields-supplier-options
/v1/settings/indexation/custom-fields-supplier
/v1/settings/indexation/custom-fields-supplier
/v1/settings/indexation/custom-fields-offer-options
/v1/settings/indexation/custom-fields-offer
/v1/settings/indexation/custom-fields-offer
/v1/settings/general
Return if specific price is enabled
/v1/settings/cart
/v1/settings/cart
Set a new mapping of keycloak
Update config on pay for lemonway
Set a new settings mirakl
Set a new mapping of product fields
Suppliers Administration
Fetch supplier evaluations
Fetch supplier by id
Fetch suppliers
get supplier user
Add users to supplier
post
Update supplier
Create new suppliers
Update suppliers status
/v1/suppliers/{supplierId}/customer-accounts
get
/v1/suppliers/{supplierId}/customer-accounts
Secured Feature Flags
/v1/feature-flags/{feature}
/v1/feature-flags
/v1/secured/feature-flags
/v1/secured/feature-flags/{feature}
/v1/secured/feature-flags/{feature}
Product Tags Administration
/v1/product-tags
/v1/product-tags
Batch tag assignation or unassignation
/v1/product-tags/{id}
/v1/product-tags/{id}
Custom Fields Administration
/v1/custom-fields
/v1/custom-fields
/v1/custom-fields/{id}
/v1/custom-fields/{id}
Activate or deactivate custom field
/v1/custom-fields/{id}
/v1/custom-fields/{id}/media
/v1/custom-fields/{id}/media
Customer Tags Administration
Delete customer tag
Fetch all customer groups
Create customer groups
Update customer tags
Mail Templates Administration
Get mail templates
Get mail content for the specified template id
Get mail content for the specified template id
Enable mail template
Create or update mail content for the specified template id
Product Indexations Administration
/v1/full
/v1/full/status
Dynamic Assortment Engine Administration
/v1/rules
/v1/rules
/v1/rules/{id}
/v1/rules/{id}
/v1/rules/{id}
Custom Field Roles Administration
/v1/custom-field-roles
/v1/custom-field-roles
Organisations Administration
Update customer main organisation
Update customer organisations by customer user id
Get customer organisations by customer user id
Retrieve paginated customer organisations
Activate or deactivate customer organisation
Add users to organisations
Get all organisations from customer account
Remove users from organisations
Delete the organisation
Retrieve one customer organisations
Create and add a new address to the organisation
Delete address
Update existing address
Retrieve all customer users in organisation
Classification Categories Administration
Get root classification category
Create classification category
Delete classification category
Get classification category
Update classification category
Delete attribute settings on a classification category
Update attribute settings on a classification category
Assign attribute settings to a classification category
Get classification category with parent tree
Statistics Administration
Count number of orders per days
DATA HUB API DEFINITIONS
clientConfigurationMapper
Fetch all client configuration
Create a client configuration
Test a client configuration
Delete a client configuration
Fetch one client configuration
Update client configuration status active/inactive
Update a client configuration
Test an existing client configuration
jobOutStatusMapper
Download mapped content exported
Fetch last status for an export job
Fetch all status for an export job
jobMapper
Fetch one job
Stop last job execution
ADM-JOB-100 - Create a duplicate of a job
Fetch all job
Create a job
Fetch mapping template
Start a specific job
Delete a job
Fetch one export job
Update job status active/inactive
Update a job
Stop last job execution
jobOutMapper
Fetch mapping template
Fetch all job
Create an export job
Fetch all export job
Fetch one export job
Update an export job
Fetch all exported item statuses by job out id
Transcoding
/v1/mapper/job/{jobId}/transcodings
/v1/mapper/job/{jobId}/transcodings
/v1/mapper/job/{jobId}/transcodings/{transcodingId}
/v1/mapper/job/{jobId}/transcodings/{transcodingId}
/v1/mapper/job/{jobId}/transcodings
jobParameters
Get parameters for a job type
jobMapperV2
Patch a job
Create a job
Get generic job types
Fetch mapping template
MappingConfigurationMapper
Fetch all mapping configuration
Create a mapping configuration
Fetch mapping template
Delete a mapping configuration
Fetch one mapping configuration
Update a mapping configuration
jobStatusMapper
Stop job execution by Job Status ID
Fetch all job status for a job
Fetch last job status for a job
Get signed URL for report integration
Core settings v3
/v3/settings/indexation
/v3/settings/indexation
jobs
Fetch Jobs
Run Scheduled Jobs
Fetch Jobs types
Djust OpenApi Spec
Logistic Orders Administration
ADM-ORDER-201 - Update Logistic Order
Assortments
ADM-ASSORTMENT-550 - List assortments
ADM-ASSORTMENT-100 - Create assortment
ADM-ASSORTMENT-300 - Delete assortment by id
ADM-ASSORTMENT-500 - Get assortment by id
ADM-ASSORTMENT-200 - Update assortment by id
ADM-ASSORTMENT-560 - List assortment products
ADM-ASSORTMENT-360 - Add products to an assortment
ADM-ASSORTMENT-370 - Remove variants from an assortment
ADM-ASSORTMENT-570 - List assortment variants
ADM-ASSORTMENT-250 - Add variants to an assortment
Operator Users Administration
ADM-OPERATOR-USER-550 - List Operator Users
ADM-OPERATOR-USER-250 - Bulk Update Operator User Status
ADM-OPERATOR-USER-100 - Create Operator User
ADM-OPERATOR-USER-202 - Update Authenticated Operator User
ADM-OPERATOR-USER-552 - List Operator User Groups
ADM-OPERATOR-USER-203 - Update Operator User
ADM-OPERATOR-USER-500 - Get Operator User
ADM-OPERATOR-USER-350 - Remove Operator User Stores
ADM-OPERATOR-USER-551 - List Operator User Stores
ADM-OPERATOR-USER-252 - Add Operator User Stores
ADM-OPERATOR-USER-251 - Replace Operator User Stores
Orders
ORDER-223 - Synchronise a commercial order
clientConfigurationMapper
jobMapper
jobMapperV2
jobOutMapper
Jobs Administration
Transcoding
Powered by
Classification Categories Administration
Ask AI
