# Table of Contents
- [Label Emmaüs API - Public](#label-emma-s-api-public)
---
# Label Emmaüs API - Public
* 0 - Authentication
* postUser Login
* 1 - Create Product
* getGet Product Schema (Step 1/3)
* postCreate Product
* getGet Category Attributes (Step 2/3)
* postUpload Product Image (Step 3/3)
* 2 - Modify Product
* patchActivate Product
* getGet Product Details
* patchUpdate Product
* 3 - My Catalog
* getList Products (Elasticsearch-based)
* getExport Products to CSV
* 4 - My Orders
* getList Merchant Orders
* getExport Orders to CSV
* 5 - Order Details
* getGet Order Details
* getGet Order Transition Logs
* getGet Order Refunds
* getGet Order Returns
* 6 - Order Actions
* postCancel Order Item
* postCancel Entire Order
* postConfirm Order
* postMark Order as Processed
* 7 - Package Management
* getGet Package Tracking Information
* postAdd Package Tracking Information
* getList Merchant Shipping Options
* 8 - Return Management Actions
* postAccept Return Request
* postReject Return Request
* postMark Return as Received
[API docs by Redocly](https://redocly.com/redoc/)
Label Emmaüs API - Public (1.0.0)
=================================
Download OpenAPI specification:[Download](blob:https://www.label-emmaus.co/2670e54f-bae5-4c8c-8ce6-a5e1f7644b13)
The Label Emmaüs API enables partners to integrate with the Label Emmaüs second-hand marketplace platform. This comprehensive REST API provides full product lifecycle management, order processing, and catalog synchronization capabilities.
**Core Features:**
* **Product Management**: Complete 3-step product creation workflow (schema → attributes → images → creation)
* **Catalog Operations**: Advanced search with dual backend support (Elasticsearch for rich search, MongoDB for real-time data)
* **Order Management**: Comprehensive order processing with detailed customer analytics and fulfillment tracking
* **Package Tracking**: Integration with shipping carriers for complete logistics management
* **Return Management**: Full return workflow handling from request to completion
* **Data Export**: CSV export capabilities for products and orders with advanced filtering
* **Authentication**: Secure SSO authentication with merchant-based permissions
**Integration Highlights:**
* Seamless synchronization with Izberg e-commerce platform
* Advanced image processing with optional AI enhancement
* Real-time inventory management with stock tracking
* Comprehensive filtering and search capabilities
* Multi-merchant support with permission-based access control
This API serves Label Emmaüs partners who want to create, manage, and sell products on the Label Emmaüs marketplace while maintaining full control over their inventory and order fulfillment processes.
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/0-Authentication)
0 - Authentication
-------------------------------------------------------------------------------------------------
User authentication and session management
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/0-Authentication/operation/userLogin)
User Login
-------------------------------------------------------------------------------------------------------------
Authenticates a user to the Label Emmaüs API, enabling access to other API endpoints (product creation/modification, catalog access, etc.).
Returns user information and associated merchant permissions.
##### Request Body schema: application/json
| | |
| --- | --- |
| username
required | string
User email address |
| password
required | string
User password |
| remember\_me | boolean
Default: false
If true, extends session to 30 days instead of 48 hours |
### Responses
**200**
Successful authentication
**400**
Invalid credentials or user without merchant access
post/user/sso/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/user/sso/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/user/sso/
### Request samples
* Payload
Content type
application/json
Copy
`{ * "username": "labo+1000@label-emmaus.co", * "password": "Labo+1000", * "remember_me": true }`
### Response samples
* 200
* 400
Content type
application/json
Copy
Expand all Collapse all
`{ * "success": true, * "data": { * "id": "string", * "type": "string", * "display_name": "string", * "first_name": "string", * "last_name": "string", * "email": "string", * "merchants": [ * { * "id": "string", * "name": "string", * "merchant_slug": "string", * "status": "string", * "access": "string" } ] } }`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/1-Create-Product)
1 - Create Product
-------------------------------------------------------------------------------------------------
3-step product creation workflow (schema → attributes → images → creation)
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/1-Create-Product/operation/getProductSchema)
Get Product Schema (Step 1/3)
---------------------------------------------------------------------------------------------------------------------------------------
Retrieves the schema required for creating a product on Label Emmaüs.
This endpoint returns all the fields needed for product creation. After choosing the product category, use the /category/{category\_id}/attributes/ endpoint to get category-specific attributes (Step 2), then /upload\_image/ for images (Step 3), before finally creating the product with POST.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
##### query Parameters
| | |
| --- | --- |
| without\_categories | string
Example: without\_categories=True
Default False; set to True to exclude categories from response |
| without\_sku | string
Example: without\_sku=True
Default False; set to True to exclude auto-generated SKU from response |
### Responses
**200**
Product schema retrieved successfully
**401**
Authentication required
**403**
Insufficient permissions for this merchant
get/{merchant\_id}/product/create/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/product/create/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/product/create/
### Response samples
* 200
Content type
application/json
Copy
Expand all Collapse all
`{ * "message": null, * "success": true, * "data": { * "components": [ * { * "status": "draft", * "created_on": "2019-08-24T14:15:22Z", * "last_modified": "2019-08-24T14:15:22Z", * "is_labo_product_more_updated": true, * "openai_calls_count": 0, * "label_url": "string", * "components": [ * { * "key": "gestion", * "position": 1, * "label": "Gestion", * "type": "fieldset", * "components": [ * { * "key": "sku", * "label": "SKU", * "type": "string", * "default_value": "1048076-20250916-002", * "validation_rules": { * "max_length": 40, * "required": true } }, * { * "key": "price_with_vat", * "label": "Prix TTC", * "type": "decimal", * "validation_rules": { * "required": true } } ] } ] } ] } }`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/1-Create-Product/operation/createProduct)
Create Product
---------------------------------------------------------------------------------------------------------------------
Creates a new product on Label Emmaüs.
**Prerequisites:** 1. Use GET /{merchant\_id}/product/create/ to get the product schema 2. Use GET /category/{category\_id}/attributes/ to get category-specific attributes 3. Use POST /upload\_image/ to upload product images
The SKU must be unique per merchant. The system validates all product data and creates both the product and offer on Izberg platform.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
##### Request Body schema: application/json
required
| | |
| --- | --- |
| merchant
required | string
Merchant ID (must match the merchant\_id in URL) |
| components
required | Array of objects
Array containing the product data |
### Responses
**200**
Product created successfully
**400**
Invalid product data or duplicate SKU
**401**
Authentication required
**403**
Insufficient permissions for this merchant
**422**
Validation error
post/{merchant\_id}/product/create/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/product/create/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/product/create/
### Request samples
* Payload
Content type
application/json
Copy
Expand all Collapse all
`{ * "merchant": "{{merchant_id}}", * "components": [ * { * "title": "Example product title", * "description": "This is an example description of a product sold on the Label Emmaüs website. We recommend writing a description of at least 50 characters.", * "price_with_vat": "11", * "previous_price_with_vat": "", * "stock": 1, * "sku": "{{merchant_id}}-{{date_du_jour}}-001", * "package_weight": "4", * "emplacement": "Y", * "categorie": [ ], * "attributes": { }, * "images": [ ], * "coupdecoeur": false, * "creation": false, * "labelselection": [ ], * "type": "" } ] }`
### Response samples
* 200
* 400
* 422
Content type
application/json
Copy
Expand all Collapse all
`{ * "success": true, * "data": { * "labo_product_id": "string", * "product_id": "string", * "best_offer_id": "string", * "slug": "string" } }`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/1-Create-Product/operation/getCategoryAttributes)
Get Category Attributes (Step 2/3)
-------------------------------------------------------------------------------------------------------------------------------------------------
Retrieves the specific attributes that must be added to a product based on its category.
This endpoint returns all category-specific attributes and their validation rules based on the category selected in Step 1. Use this after selecting a category and before uploading images (Step 3) and creating the product.
Each category has different required and optional attributes (e.g., size, color, brand, condition, material, etc.).
##### path Parameters
| | |
| --- | --- |
| category\_id
required | string
Example: 22346
The category ID to get attributes for |
##### query Parameters
| | |
| --- | --- |
| full\_list | string
Example: full\_list=false
Set to true to get all attributes including hidden ones |
### Responses
**200**
Category attributes retrieved successfully
**400**
Invalid category ID
**401**
Authentication required
**403**
Insufficient permissions
get/category/{category\_id}/attributes/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/category/{category\_id}/attributes/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/category/{category\_id}/attributes/
### Response samples
* 200
* 400
Content type
application/json
Copy
Expand all Collapse all
`{ * "message": null, * "success": true, * "data": { * "components": { * "key": "attributes", * "position": 4, * "label": "Attributs", * "helptext": "", * "type": "fieldset", * "components": [ * { * "key": "etat", * "label": "État", * "type": "select", * "required": true, * "position": 1, * "choices": [ * { * "id": "parfait_etat", * "value": "parfait état" }, * { * "id": "tres_bon_etat", * "value": "très bon état" } ] }, * { * "key": "couleur", * "label": "Couleur", * "type": "string", * "required": false, * "position": 2 } ] } } }`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/1-Create-Product/operation/uploadProductImage)
Upload Product Image (Step 3/3)
-------------------------------------------------------------------------------------------------------------------------------------------
Uploads a single product image to be used in product creation.
This endpoint handles image upload and processing, including: - File validation (JPG only, max 2.5MB) - Upload to internal storage system - Registration with Izberg platform - Generation of unique image identifiers
Use this endpoint after getting the product schema (Step 1) and category attributes (Step 2), but before creating the product. The returned image data should be included in the product creation request.
**File Requirements:** - Format: JPG only - Size: Maximum 2.5MB - One image per request (make multiple calls for multiple images)
##### query Parameters
| | |
| --- | --- |
| PIXR\_CLIENT\_KEY
required | string
Example: PIXR\_CLIENT\_KEY=labo
PIXR service client key |
| path
required | string
Example: path=labo
Upload path identifier |
##### header Parameters
| | |
| --- | --- |
| Content-Type
required | string
Example: multipart/form-data
Must be multipart/form-data for file upload |
##### Request Body schema: multipart/form-data
required
| | |
| --- | --- |
| file
required | string
JPG image file (max 2.5MB) |
### Responses
**200**
Image uploaded successfully
**400**
Invalid file or upload error
**401**
Authentication required
**413**
File too large
**429**
Rate limit exceeded
**500**
Internal server error during upload processing
post/upload\_image/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/upload\_image/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/upload\_image/
### Response samples
* 200
* 400
* 401
* 413
* 429
* 500
Content type
application/json
Copy
`{ * "success": true, * "path": "/path/to/uploaded/image.jpg", * "url": "[https://dev.label-emmaus.co/media/_uploaded/orig/labo/903f992fb003b3ecc23100c547c9c210.jpeg](https://dev.label-emmaus.co/media/_uploaded/orig/labo/903f992fb003b3ecc23100c547c9c210.jpeg) ", * "image_id": 28817790, * "labo_id": "image123e4567-e89b-12d3-a456-426614174000" }`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/2-Modify-Product)
2 - Modify Product
-------------------------------------------------------------------------------------------------
Product updates, activation, and detailed retrieval
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/2-Modify-Product/operation/activateProduct)
Activate Product
-------------------------------------------------------------------------------------------------------------------------
Activates a product on the Label Emmaüs platform, making it available for purchase.
This endpoint performs comprehensive validation before activation: - Validates all required fields are present - Ensures at least one product image exists - Activates the offer on the Izberg platform - Optionally applies Photoroom image enhancement
**Required fields:** category, stock, price\_with\_vat, package\_weight, title, description **Category-specific attributes:** Additional required attributes based on selected category
The product must have been created and configured before activation. After successful activation, the product becomes publicly visible and purchaseable on Label Emmaüs.
##### path Parameters
| | |
| --- | --- |
| product\_id
required | string
Example: 507f1f77bcf86cd799439011
The product identifier. Can be either: - Internal Label product ID (MongoDB ObjectId) - Izberg product ID (integer) |
##### query Parameters
| | |
| --- | --- |
| skip\_photoroom | string
Example: skip\_photoroom=false
Set to 'true' to skip automatic Photoroom image enhancement. Default: false (Photoroom processing enabled if merchant has it activated) |
### Responses
**200**
Product activated successfully
**400**
Validation error or missing required fields
**401**
Authentication required
**403**
Insufficient permissions for this merchant
**404**
Product not found
**405**
Invalid HTTP method
**500**
Izberg platform error during activation
patch/product/{product\_id}/activate/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/product/{product\_id}/activate/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/product/{product\_id}/activate/
### Response samples
* 200
* 400
* 401
* 403
* 404
* 405
* 500
Content type
application/json
Copy
Expand all Collapse all
`{ * "success": true, * "message": null, * "data": { * "labo_product_id": "507f1f77bcf86cd799439011", * "product_id": "12345678", * "best_offer_id": "87654321" } }`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/2-Modify-Product/operation/getProductDetails)
Get Product Details
------------------------------------------------------------------------------------------------------------------------------
Retrieves detailed information about an existing product for editing purposes.
This endpoint returns the complete product schema populated with current values, allowing you to see all current product data before making modifications. The response includes all product fields, category information, attributes, images, and other configuration details.
**Note:** This endpoint returns comprehensive product data. The response can be verbose as it includes all available product information for editing purposes.
##### path Parameters
| | |
| --- | --- |
| product\_id
required | string
Example: 507f1f77bcf86cd799439011
The product identifier. Can be either: - Internal Label product ID (MongoDB ObjectId) - Izberg product ID (integer) |
##### query Parameters
| | |
| --- | --- |
| without\_categories | string
Example: without\_categories=False
Set to 'True' to exclude category information from the response. Default: 'False' (includes categories) |
| openai\_laboproduct\_current\_count | string
Internal parameter to preserve OpenAI API call count during product recreation. Used for system optimization purposes. |
### Responses
**200**
Product details retrieved successfully
**401**
Authentication required
**403**
Insufficient permissions for this merchant
**404**
Product not found
get/product/{product\_id}/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/product/{product\_id}/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/product/{product\_id}/
### Response samples
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
`{ * "success": true, * "message": null, * "data": { * "components": [ * { * "title": "Example product title", * "description": "Detailed product description with at least 50 characters recommended.", * "price_with_vat": "15.99", * "stock": 1, * "sku": "MERCHANT-20240101-001", * "package_weight": "2.5", * "attributes": { }, * "categorie": [ ], * "images": [ ] } ] } }`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/2-Modify-Product/operation/updateProduct)
Update Product
---------------------------------------------------------------------------------------------------------------------
Updates an existing product with new information. This endpoint handles comprehensive product modifications including:
**Core Features:** - Field validation and data normalization - SKU uniqueness validation per merchant - Complex image management (upload, reorder, removal) - Automatic tax calculations (VAT to excluding VAT conversion) - Izberg platform synchronization - Thesaurus updates for attribute autocomplete - Inspiration collections management
**Image Management:** - Supports adding, removing, and reordering images - Handles images with or without image\_id - Automatic image upload for legacy images - Synchronizes image assignments with Izberg offers
**Important:** After modification, the product typically needs to be activated using the /product/{product\_id}/activate/ endpoint to make changes visible.
Uses the same format as "POST Create Product" but for updating existing products.
##### path Parameters
| | |
| --- | --- |
| product\_id
required | string
Example: 507f1f77bcf86cd799439011
The product identifier. Can be either: - Internal Label product ID (MongoDB ObjectId) - Izberg product ID (integer) |
##### query Parameters
| | |
| --- | --- |
| without\_categories | string
Example: without\_categories=False
Set to 'True' to exclude categories during update processing |
| openai\_laboproduct\_current\_count | string
Preserve OpenAI API call count during product updates |
##### Request Body schema: application/json
required
| | |
| --- | --- |
| merchant
required | string
Merchant ID for the product |
| components
required | Array of objects
Array containing the product update data |
### Responses
**200**
Product updated successfully
**400**
Validation error or invalid data
**401**
Authentication required
**403**
Insufficient permissions for this merchant
**404**
Product not found or deleted from Izberg
**422**
Model validation error
**429**
Rate limit exceeded
**500**
Izberg platform error during update
patch/product/{product\_id}/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/product/{product\_id}/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/product/{product\_id}/
### Request samples
* Payload
Content type
application/json
Copy
Expand all Collapse all
`{ * "merchant": "{{merchant_id}}", * "components": [ * { * "title": "Updated product title", * "description": "Here is an example description of a product sold on Label Emmaüs. We recommend writing a description of at least 50 characters.", * "price_with_vat": "15.99", * "previous_price_with_vat": "", * "stock": 1, * "sku": "{{merchant_id}}-{{date_du_jour}}-002", * "package_weight": "2.5", * "emplacement": "A1-B2", * "attributes": { }, * "categorie": [ ], * "images": [ ], * "labelselection": [ ], * "coupdecoeur": false, * "creation": false } ] }`
### Response samples
* 200
* 400
* 404
* 422
* 429
* 500
Content type
application/json
Copy
Expand all Collapse all
`{ * "success": true, * "message": null, * "data": { * "labo_product_id": "507f1f77bcf86cd799439011", * "product_id": "12345678", * "best_offer_id": "87654321" } }`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/3-My-Catalog)
3 - My Catalog
-----------------------------------------------------------------------------------------
Product catalog management with advanced search and CSV export
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/3-My-Catalog/operation/listProductsElastic)
List Products (Elasticsearch-based)
--------------------------------------------------------------------------------------------------------------------------------------------
Retrieves all products added by a merchant to their Label Emmaüs catalog using Elasticsearch for advanced search capabilities.
**Key Features:** - Advanced text search with relevance scoring - Complex filtering and faceted search - Category hierarchy navigation - Special search operators (sku:, titre:) - Good deals and promotions filtering - Attribute-based filtering with aggregations - "Sleeping" products detection (active products older than 6 months)
**Search Delay:** Products appear in search results ~5 minutes after creation/modification due to synchronization.
**Special Status:** "sleeping" = active products with stock, created >6 months ago
This endpoint provides comprehensive search and filtering capabilities with faceted results for building advanced product management interfaces.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string
Example: 12345
The merchant ID to retrieve products for |
##### query Parameters
| | |
| --- | --- |
| q | string
Example: q=iPhone 12
Text search query. Supports special operators: - "sku:ABC123" for SKU-based search - "titre:keyword" for title-only search - Regular text for full-text search across name, description, attributes |
| text\_search | string
Alternative parameter name for text search query |
| date\_created\_min | string
Example: date\_created\_min=2024-01-01
Minimum creation date (YYYY-MM-DD format) |
| date\_created\_max | string
Example: date\_created\_max=2024-12-31
Maximum creation date (YYYY-MM-DD format) |
| date\_modified\_min | string
Example: date\_modified\_min=2024-01-01
Minimum modification date (YYYY-MM-DD format) |
| date\_modified\_max | string
Example: date\_modified\_max=2024-12-31
Maximum modification date (YYYY-MM-DD format) |
| stock | string
Example: stock=in\_stock
Stock status filter: - 'in\_stock' or '1' or 'true': Products with stock > 0 - 'out\_of\_stock' or '0' or 'false': Products with stock = 0 |
| status | string
Example: status=active
Product status filter (comma-separated for multiple): - 'draft': Draft products - 'pending': Pending approval - 'active': Active/published products - 'sleeping': Active products older than 6 months (auto-converted to active + date filter) |
| prix\_min | string
Example: prix\_min=10.00
Minimum price filter (including VAT) |
| prix\_max | string
Example: prix\_max=100.00
Maximum price filter (including VAT) |
| categoryIds | string
Example: categoryIds=12345,67890
Comma-separated category IDs to filter by |
| affaire | string
Example: affaire=1
Good deals filter: - '1': Show only good deals - '-1': Exclude good deals - '0' or omit: Show all products |
| good\_deals | string
Example: good\_deals=promo-informatique,destockage
Comma-separated good deal category slugs to filter by |
| limit | string
Example: limit=50
Number of results per page (default: 100, max: 10000) |
| page | string
Example: page=1
Page number for pagination (default: 1) |
| sort | string
Example: sort=0
Sort order: - '0': By creation date (default) - Other values: Custom sorting options |
| tri | string
Alternative parameter name for sort |
### Responses
**200**
Products retrieved successfully with search facets
**401**
Authentication required
**403**
Insufficient permissions for this merchant
**404**
Merchant not found
get/{merchant\_id}/products/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/products/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/products/
### Response samples
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
`{ * "success": true, * "message": null, * "data": { * "total": 1250, * "buckets": [ * { * "key": "attributes", * "label": "Attributes", * "choices": [ * { * "key": "brand", * "label": "Brand", * "doc_count": 45 } ] } ], * "results": [ * { * "product_id": "12345678", * "categories": [ * { * "id": 0, * "value": "string", * "children": [ ] } ], * "created_on": "2024-01-15 14:30:00", * "modified_on": "2024-02-01 09:15:00", * "sku": "MERCHANT-20240115-001", * "image": "[https://dev.label-emmaus.co/media/_uploaded/orig/image.jpg](https://dev.label-emmaus.co/media/_uploaded/orig/image.jpg) ", * "price_with_vat": "25.99", * "previous_price_with_vat": "29.99", * "title": "iPhone 12 - Good condition", * "status": "active", * "stock": "1", * "attributes": { }, * "is_labo_product_more_updated": true, * "good_deal": "promo-informatique" } ] } }`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/3-My-Catalog/operation/exportProductsCSV)
Export Products to CSV
-----------------------------------------------------------------------------------------------------------------------------
Exports all products from a merchant's Label Emmaüs catalog to CSV format.
This endpoint accepts the same filtering parameters as the products catalog endpoint (/{merchant\_id}/products/) and returns the filtered results as a downloadable CSV file instead of JSON.
**Note:** Uses the same request parameters as /{merchant\_id}/products/ endpoint.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string
The merchant ID to export products for |
##### query Parameters
| | |
| --- | --- |
| q | string
Same as products catalog endpoint - text search query |
| date\_created\_min | string
Same as products catalog endpoint - minimum creation date |
| date\_created\_max | string
Same as products catalog endpoint - maximum creation date |
| date\_modified\_min | string
Same as products catalog endpoint - minimum modification date |
| date\_modified\_max | string
Same as products catalog endpoint - maximum modification date |
| stock | string
Same as products catalog endpoint - stock status filter |
| status | string
Same as products catalog endpoint - product status filter |
| prix\_min | string
Same as products catalog endpoint - minimum price filter |
| prix\_max | string
Same as products catalog endpoint - maximum price filter |
| limit | string
Same as products catalog endpoint - number of results |
### Responses
**200**
CSV file with exported products
**401**
Authentication required
**403**
Insufficient permissions for this merchant
get/{merchant\_id}/products/export/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/products/export/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/products/export/
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/4-My-Orders)
4 - My Orders
---------------------------------------------------------------------------------------
Order listing, filtering, and CSV export capabilities
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/4-My-Orders/operation/listMerchantOrders)
List Merchant Orders
---------------------------------------------------------------------------------------------------------------------------
Retrieves orders for a specific merchant. This endpoint provides comprehensive order management capabilities with extensive filtering, sorting, and pagination options.
**Filtering Options:**
* Filter by creation and modification dates
* Filter by order number, customer details (email, name)
* Filter by item details (SKU, name)
* Filter by order status and incident status
* Filter by shipping method
**Sorting Options:** Use the 'sort' parameter: '1' for creation date (default), '2' for order number, '3' for shipping options.
**Response Structure:** The response contains two main nodes:
* `buckets`: Lists available filter options (status, incident status, shipping options)
* `objects`: Contains the actual order data with comprehensive details
**Status Codes:**
* 60: Order Payment Authorised
* 80: Order confirmed
* 85: Order shipped
* 110: Order finalized
* 2000: Order canceled
**Incident Status:**
* no\_incident: No issues
* processing: Incident being processed
* pending\_merchant: Waiting for merchant action
* pending\_customer: Waiting for customer action
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string
Merchant ID to retrieve orders for |
##### query Parameters
| | |
| --- | --- |
| date\_created\_min | string
Example: date\_created\_min=2019-11-20
Filter orders created after this date (YYYY-MM-DD format) |
| date\_created\_max | string
Example: date\_created\_max=2020-01-28
Filter orders created before this date (YYYY-MM-DD format) |
| date\_modified\_min | string
Example: date\_modified\_min=2019-11-28
Filter orders modified after this date (YYYY-MM-DD format) |
| date\_modified\_max | string
Example: date\_modified\_max=2019-12-20
Filter orders modified before this date (YYYY-MM-DD format) |
| order\_id\_number | string
Example: order\_id\_number=191218E1646274
Filter by exact order number |
| useremail | string
Example: useremail=customer@example.com
Filter by customer email address (partial match) |
| username | string
Example: username=John
Filter by customer display name (partial match) |
| first\_name | string
Example: first\_name=John
Filter by customer first name (partial match) |
| last\_name | string
Example: last\_name=Smith
Filter by customer last name (partial match) |
| item\_sku | string
Example: item\_sku=ITEM123
Filter by exact item SKU |
| item\_sku\_like | string
Example: item\_sku\_like=ITEM
Filter by partial item SKU match |
| item\_name | string
Example: item\_name=Blue Sweater Size M
Filter by item name (partial match) |
| shipping\_option.id | string
Example: shipping\_option.id=1819
Filter by shipping option assignment ID |
| status | Array of strings
Items Enum: "60" "80" "85" "90" "2000"
Example: status=60&status=80
Filter by order status (multiple values supported). 60=confirmed, 80=processed, 85=shipped, 90=delivered, 2000=canceled. Note: Status 85 and 90 are linked (filtering 85 includes 90 and vice versa). |
| incident\_status | string
Example: incident\_status=no\_incident
no\_incident, processing, pending\_merchant, pending\_customer supportés. 0 peut être envoyé pour récupérer les commandes qui n'ont pas d'incident et 1 pour récupèrer toutes les autres. |
| shipping\_options\_method | string
Example: shipping\_options\_method=home
home, relay\_point, pickup\_and\_collect supportés. |
| sort | string
Example: sort=1
1 : datecrea (default), 2 : id\_number, 3 : shipping\_options. |
| limit | string
Example: limit=100
50 par défault |
| page | string
Example: page=3
numéro de la page (1 par défault) |
| offset | string
Example: offset=50
Number of orders to skip (alternative to page parameter) |
### Responses
**200**
Successful response with order list
**400**
Bad request - Invalid parameters
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Merchant does not exist
get/{merchant\_id}/orders/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/
### Response samples
* 200
Content type
application/json
Copy
Expand all Collapse all
`{ * "success": true, * "data": { * "total": 150, * "results": { * "buckets": { }, * "objects": [ * { * "id": "string", * "id_number": "191218E1646274", * "created_on": "2019-08-24T14:15:22Z", * "last_modified": "2019-08-24T14:15:22Z", * "amount_vat_included": 45.9, * "items_count": 2, * "items": [ ], * "user": { * "display_name": "string", * "id": "string" }, * "status_localized": "string", * "incident_status": "no_incident", * "shipping_options": [ ], * "workflow": "string" } ] } } }`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/4-My-Orders/operation/exportOrdersCsv)
Export Orders to CSV
------------------------------------------------------------------------------------------------------------------------
Exports merchant orders to CSV format with the same filtering capabilities as the order list endpoint. Each row in the CSV represents one order item, so orders with multiple items will generate multiple rows.
**CSV Columns:**
* id: Internal order ID
* id\_number: Human-readable order number
* created\_on: Order creation timestamp
* last\_modified: Order last modification timestamp
* amount\_vat\_included: Total order amount including VAT
* items\_count: Number of items in the order
* items\_id: Individual item ID
* items\_sku: Individual item SKU
* items\_name: Individual item name
* items\_quantity: Individual item quantity
* user\_name: Customer display name
* status\_localized: Localized order status
* incident\_status: Current incident status
* shipping\_options\_name: Shipping option name
* shipping\_vat\_included: Shipping cost including VAT
**Note:** This endpoint accepts the same filtering and sorting parameters as the main orders endpoint. Use this for bulk order data analysis and reporting.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string
Merchant ID to export orders for |
##### query Parameters
| | |
| --- | --- |
| date\_created\_min | string
Example: date\_created\_min=2019-11-20 |
| date\_modified\_min | string
Example: date\_modified\_min=2019-11-28 |
| date\_modified\_max | string
Example: date\_modified\_max=2019-12-20 |
| order\_id\_number | string
Example: order\_id\_number=191218E1646274 |
| useremail | string
Example: useremail=gmeunier@label-emmaus.c |
| username | string
Example: username=Grégoire |
| item\_sku | string
Example: item\_sku=TEST500G2 |
| item\_sku\_like | string
Example: item\_sku\_like=TEST |
| item\_name | string
Example: item\_name=TEST produit 500g |
| shipping\_option.id | string
Example: shipping\_option.id=1819 |
| status | string
Example: status=60
60, 80, 85, 2000 supportés. |
| incident\_status | string
Example: incident\_status=no\_incident
no\_incident, processing, pending\_merchant, pending\_customer supportés. 0 peut être envoyé pour récupérer les commandes qui n'ont pas d'incident et 1 pour récupèrer toutes les autres. |
| shipping\_options\_method | string
Example: shipping\_options\_method=home
home, relay\_point, pickup\_and\_collect supportés. |
| sort | string
Example: sort=1
1 : datecrea (default), 2 : id\_number, 3 : shipping\_options. |
| limit | string
Example: limit=100
50 par défault |
| page | string
Example: page=3
numéro de la page (1 par défault) |
| offset | string
Example: offset=50
Number of orders to skip (alternative to page parameter) |
### Responses
**200**
CSV file download
**400**
Bad request - Invalid parameters
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Merchant does not exist
get/{merchant\_id}/orders/export/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/export/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/export/
### Response samples
* 200
Content type
text/csv
Copy
id,id\_number,created\_on,last\_modified,amount\_vat\_included,items\_count,items\_id,items\_sku,items\_name,items\_quantity,user\_name,status\_localized,incident\_status,shipping\_options\_name,shipping\_vat\_included
507f1f77bcf86cd799439011,191218E1646274,2019-12-18T16:46:27Z,2019-12-20T10:30:15Z,45.90,2,item1,ITEM123/RACK-A,Blue Sweater Size M,1,John Smith,Order confirmed,no\_incident,Standard Delivery,5.90
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/5-Order-Details)
5 - Order Details
-----------------------------------------------------------------------------------------------
Detailed order information and Izberg proxy endpoints
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/5-Order-Details/operation/getOrderDetails)
Get Order Details
-------------------------------------------------------------------------------------------------------------------------
Retrieves comprehensive details of a specific merchant order, including complete order information, detailed item data with product dimensions and weights, customer information with order history, and shipping options.
**Order Information Includes:**
* Complete order financial data (amounts, discounts, VAT, shipping costs)
* Order status and workflow information
* Billing and shipping addresses
* Detailed item information with product attributes
**Enhanced Item Details:**
* Product dimensions (height, length, width) and weight
* Storage location (emplacement) extracted from SKU
* Pricing information including discounts and previous prices
* Item status and quantity details
**Customer Analytics:**
* Total order count across all merchants
* Order count for this specific merchant
* Incident/refund history count
* Date of customer's first order
**Shipping Information:**
* Available shipping options with method details
* Carrier information and delivery preferences
* Items assigned to each shipping option
This endpoint provides complete order context for order management, customer service, and fulfillment operations.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string
Example: 12345
Merchant ID to retrieve the order for |
| merchant\_order\_id
required | string
Example: 507f1f77bcf86cd799439011
Specific order ID to retrieve details for |
### Responses
**200**
Order details retrieved successfully
**400**
Bad request - Invalid order ID
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Order does not exist for this merchant
get/{merchant\_id}/orders/{merchant\_order\_id}/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/
### Response samples
* 200
Content type
application/json
Copy
Expand all Collapse all
`{ * "success": true, * "data": { * "id_number": "191218E1646274", * "amount": 38.25, * "amount_vat_included": 45.9, * "amount_vat_included_before_discount": 50, * "created_on": "2019-12-18T16:46:27Z", * "incident_status": "no_incident", * "items_count": 1, * "items": [ * { * "id": "item1", * "name": "Blue Sweater Size M", * "sku": "ITEM123/RACK-A", * "price": 45.9, * "quantity": 1, * "weight": 350.5, * "emplacement": "RACK-A", * "dimensions": { * "hauteur": "25cm", * "longueur": "30cm", * "largeur": "5cm" } } ], * "user": { * "email": "customer@example.com", * "first_name": "John", * "last_name": "Smith", * "total_order_count": 15, * "this_merchant_order_count": 3, * "refunded_order_count": 1 }, * "shipping_options": [ * { * "name": "Standard Delivery", * "items": [ * "item1" ], * "method": "home" } ] } }`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/5-Order-Details/operation/getOrderTransitionLogs)
Get Order Transition Logs
----------------------------------------------------------------------------------------------------------------------------------------
Retrieves the transition history of an order, showing all status changes (confirmed, sent, canceled, refunded, etc.).
**Note:** This endpoint is a proxy to the Izberg platform and returns data directly from Izberg.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
| merchant\_order\_id
required | string |
### Responses
**200**
Order transition logs retrieved successfully (proxied from Izberg)
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Order does not exist
get/{merchant\_id}/orders/{merchant\_order\_id}/transition\_log/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/transition\_log/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/transition\_log/
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/5-Order-Details/operation/getOrderRefunds)
Get Order Refunds
-------------------------------------------------------------------------------------------------------------------------
Retrieves detailed information about an order and all refunds that have occurred on the merchant order.
**Note:** This endpoint is a proxy to the Izberg platform and returns data directly from Izberg.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
| merchant\_order\_id
required | string |
### Responses
**200**
Order refunds retrieved successfully (proxied from Izberg)
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Order does not exist
get/{merchant\_id}/orders/{merchant\_order\_id}/refunds/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/refunds/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/refunds/
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/5-Order-Details/operation/getOrderReturns)
Get Order Returns
-------------------------------------------------------------------------------------------------------------------------
Retrieves detailed information about an order and all returns that have occurred on the merchant order.
**Note:** This endpoint is a proxy to the Izberg platform and returns data directly from Izberg.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
| merchant\_order\_id
required | string |
### Responses
**200**
Order returns retrieved successfully (proxied from Izberg)
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Order does not exist
get/{merchant\_id}/orders/{merchant\_order\_id}/returns/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/returns/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/returns/
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/6-Order-Actions)
6 - Order Actions
-----------------------------------------------------------------------------------------------
Order state management (confirm, cancel, send) via Izberg proxy
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/6-Order-Actions/operation/cancelOrderItem)
Cancel Order Item
-------------------------------------------------------------------------------------------------------------------------
Cancels a specific item belonging to a merchant order. The rest of the order is not canceled - this is a partial cancellation.
**Note:** This endpoint is a proxy to the Izberg platform and forwards the action directly to Izberg.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
| merchant\_order\_id
required | string |
| item\_id
required | string |
### Responses
**200**
Item canceled successfully (action processed by Izberg)
**400**
Bad request - Invalid item or order ID
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Order or item does not exist
post/{merchant\_id}/orders/{merchant\_order\_id}/{item\_id}/cancel
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/{item\_id}/cancel
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/{item\_id}/cancel
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/6-Order-Actions/operation/cancelEntireOrder)
Cancel Entire Order
-----------------------------------------------------------------------------------------------------------------------------
Cancels an entire order. This is a total cancellation - all items in the order are canceled from the sale.
**Note:** This endpoint is a proxy to the Izberg platform and forwards the action directly to Izberg.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
| merchant\_order\_id
required | string |
### Responses
**200**
Order canceled successfully (action processed by Izberg)
**400**
Bad request - Invalid order ID or order cannot be canceled
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Order does not exist
post/{merchant\_id}/orders/{merchant\_order\_id}/cancel
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/cancel
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/cancel
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/6-Order-Actions/operation/confirmOrder)
Confirm Order
------------------------------------------------------------------------------------------------------------------
Confirms the order by the merchant. The order will then be ready to ship or for in-store pickup depending on the associated delivery method.
**Note:** This endpoint is a proxy to the Izberg platform and forwards the action directly to Izberg.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
| merchant\_order\_id
required | string |
### Responses
**200**
Order confirmed successfully (action processed by Izberg)
**400**
Bad request - Invalid order ID or order cannot be confirmed
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Order does not exist
post/{merchant\_id}/orders/{merchant\_order\_id}/confirm
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/confirm
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/confirm
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/6-Order-Actions/operation/markOrderAsSent)
Mark Order as Processed
-------------------------------------------------------------------------------------------------------------------------------
Marks the order as shipped / processed by the merchant.
**Note:** This endpoint is a proxy to the Izberg platform and forwards the action directly to Izberg.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
| merchant\_order\_id
required | string |
### Responses
**200**
Order marked as sent successfully (action processed by Izberg)
**400**
Bad request - Invalid order ID or order cannot be marked as sent
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Order does not exist
post/{merchant\_id}/orders/{merchant\_order\_id}/process
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/process
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/process
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/7-Package-Management)
7 - Package Management
---------------------------------------------------------------------------------------------------------
Package tracking and shipping options management
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/7-Package-Management/operation/getPackageTracking)
Get Package Tracking Information
------------------------------------------------------------------------------------------------------------------------------------------------
Retrieves detailed package tracking information for a merchant order. Returns tracking data from the shipping carrier if tracking information has been registered for this order.
**Note:** This endpoint retrieves tracking information through the Izberg platform integration.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
| merchant\_order\_id
required | string |
### Responses
**200**
Package tracking information retrieved successfully
**400**
Bad request - Invalid merchant or order ID
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - No package tracking registered for this merchant order
get/{merchant\_id}/orders/{merchant\_order\_id}/package\_tracking/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/package\_tracking/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/package\_tracking/
### Response samples
* 200
Content type
application/json
Copy
`{ }`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/7-Package-Management/operation/addPackageTracking)
Add Package Tracking Information
------------------------------------------------------------------------------------------------------------------------------------------------
Adds package tracking information for specific order items within a merchant order. This endpoint allows merchants to register tracking numbers and carrier information for shipped items, enabling customers to track their packages.
**Important Validation Rules:**
* The carrier must be configured in the merchant's shipping options
* The merchant order must exist and belong to the specified merchant
* The merchant must have shipping options configured (no tracking possible for pickup-only merchants)
* The tracking\_number is mandatory
**Item Targeting:**
* If `order_item_id` is provided: tracking applies only to specified items
* If `order_item_id` is omitted or empty: all items in the order are linked to this tracking number
**Carrier Name Handling:**
* Carrier names are automatically normalized (e.g., "Mondial Relay C.pourToi" → "Livraison en point relais")
* Only carriers configured in merchant's shipping options are accepted
**Note:** This endpoint integrates with the Izberg platform for tracking management.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
| merchant\_order\_id
required | string |
##### Request Body schema: application/json
| | |
| --- | --- |
| carrier
required | string
Shipping carrier name. Must match one of the carriers configured in the merchant's shipping options. Carrier names are normalized automatically. |
| order\_item\_id | Array of numbers
Optional array of specific order item IDs to track. If omitted or empty, all items in the order will be linked to this tracking number. When provided, must be a valid array (not a single number). |
| tracking\_number
required | string
The tracking number provided by the shipping carrier (required) |
### Responses
**200**
Package tracking information added successfully
**400**
Bad request - Invalid data: - Invalid JSON in request body - Carrier not in merchant's shipping options list - order\_item\_id is not an array - Missing required tracking\_number
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found: - Merchant does not exist - Order does not exist for this merchant - Merchant has no shipping options configured
post/{merchant\_id}/orders/{merchant\_order\_id}/package\_tracking/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/package\_tracking/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/package\_tracking/
### Request samples
* Payload
Content type
application/json
Example
Track specific itemsTrack all items in orderTrack specific items
Copy
Expand all Collapse all
`{ * "carrier": "USPS", * "order_item_id": [ * 176730, * 176731 ], * "tracking_number": "1Z999AA1234567890" }`
### Response samples
* 200
Content type
application/json
Copy
`{ }`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/7-Package-Management/operation/listMerchantShippingOptions)
List Merchant Shipping Options
-------------------------------------------------------------------------------------------------------------------------------------------------------
Retrieves the configured shipping options for a merchant, including available carriers and delivery methods. This information is essential for package tracking and order fulfillment.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
### Responses
**200**
Shipping options retrieved successfully
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Merchant does not exist
get/{merchant\_id}/shipping\_options/
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/shipping\_options/
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/shipping\_options/
### Response samples
* 200
Content type
application/json
Copy
Expand all Collapse all
`[ * { } ]`
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/8-Return-Management-Actions)
8 - Return Management Actions
-----------------------------------------------------------------------------------------------------------------------
Return workflow management (accept, reject, receive) via Izberg proxy
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/8-Return-Management-Actions/operation/acceptReturnRequest)
Accept Return Request
---------------------------------------------------------------------------------------------------------------------------------------------
Confirms and accepts a return request for a specific item in an order, allowing the customer to send the item back to the merchant.
**Note:** This endpoint is a proxy to the Izberg platform and forwards the action directly to Izberg.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
| merchant\_order\_id
required | string |
| item\_id
required | string |
### Responses
**200**
Return request accepted successfully (action processed by Izberg)
**400**
Bad request - Invalid item or order ID
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Order or item does not exist
post/{merchant\_id}/orders/{merchant\_order\_id}/returns/{item\_id}/confirm
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/returns/{item\_id}/confirm
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/returns/{item\_id}/confirm
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/8-Return-Management-Actions/operation/rejectReturnRequest)
Reject Return Request
---------------------------------------------------------------------------------------------------------------------------------------------
Rejects a return request for a specific item in an order, preventing the customer from sending the item back to the merchant.
**Note:** This endpoint is a proxy to the Izberg platform and forwards the action directly to Izberg.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
| merchant\_order\_id
required | string |
| item\_id
required | string |
### Responses
**200**
Return request rejected successfully (action processed by Izberg)
**400**
Bad request - Invalid item or order ID
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Order or item does not exist
post/{merchant\_id}/orders/{merchant\_order\_id}/returns/{item\_id}/cancel
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/returns/{item\_id}/cancel
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/returns/{item\_id}/cancel
[](https://www.label-emmaus.co/static/labo-api-docs.html#tag/8-Return-Management-Actions/operation/markReturnAsReceived)
Mark Return as Received
------------------------------------------------------------------------------------------------------------------------------------------------
Confirms that a returned item has been physically received by the merchant. This finalizes the return process for the specific item.
**Note:** This endpoint is a proxy to the Izberg platform and forwards the action directly to Izberg.
##### path Parameters
| | |
| --- | --- |
| merchant\_id
required | string |
| merchant\_order\_id
required | string |
| item\_id
required | string |
### Responses
**200**
Return marked as received successfully (action processed by Izberg)
**400**
Bad request - Invalid item or order ID
**401**
Unauthorized - Authentication required
**403**
Forbidden - Insufficient permissions for this merchant
**404**
Not found - Order or item does not exist
post/{merchant\_id}/orders/{merchant\_order\_id}/returns/{item\_id}/receive
Development Environment - Label Emmaüs API
https://labodev.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/returns/{item\_id}/receive
Production Environment - Label Emmaüs API
https://labo.label-emmaus.co/labo/api/{merchant\_id}/orders/{merchant\_order\_id}/returns/{item\_id}/receive
---