Product
Product Entity
To manage stock inventory or process orders, you must first create a product catalog. This guide walks you through all endpoints related to products and their structure.
The Product entity represents an individual item in the system. It includes key attributes such as productSku, internalSku, name, hsCode, dimensions, weight, category, and more.
Product Types in Mailship
Mailship supports three types of products:
Physical product: An item that is processed in orders, shipping advices, etc.
Virtual product: An item that appears in orders but does not physically exist in stock (e.g., an ebook, a voucher).
Bundle: A collection of multiple physical products combined into one package (e.g., a cosmetic set containing mascara and lipstick). In orders, a bundle breaks down into its individual products. Since bundles are not physically stocked, stock advices are not created for them; only the individual products are managed in inventory.
Each product is uniquely identified by its id and belongs to an organization.
For more details on how products are created and processed, please refer to the Knowledge Base.
Product catalog
Get list of Product | Retrieves a list of all products in the catalog. | |
Get Product | Fetches all data about a specific product. | |
Update Product | Updates an existing product. | |
Create Product | Creates a new product. | |
Activate Product | Activates a product in Mailship. | |
Deactivate Product | Deactivates a product in Mailship. | |
Activate multiple Products | Bulk activation of multiple products. | |
Deactivate multiple Products | Bulk deactivation of multiple products. |
For more details, please visit other subsections in the expedition category.
Additional Product Catalog Actions
Beyond creating and updating products, you can also manage product images and assign product services.
Product Image
This endpoint allows you to upload an image for a specific product identified by {productId}.
Upload Product Image (JSON) | Upload an image to a product using a JSON request. | |
Upload Product Image (FORM) | Upload an image to a product using a form request. | |
Get Product Image | Retrieve the product image. | |
Delete Product Image | Remove the product image. |
Product Service
A product service is a specialized feature associated with a product.
If you are interested in activating product service on your product, please contact our customer service.
Currently, Mailship supports the following product service:
Inbound Localisation Check