This guide is intended for customers with custom-built third-party API integrations. This article lists the ID parameters required when working with custom API endpoints across different modules. Each ID parameter must be provided in the correct format for the endpoint to function correctly.
Where is the ID displayed?
The ID for every parameter is listed within the URL web address, additionally some will display an ID field on Mintsoft.
Within the URL
Specific ID field
Order Management
When working with order-related custom API endpoints (https://api.mintsoft.co.uk/swagger/ui/index#!/Order), the following ID parameters are required:
OrderId: Required for order operations, updates, cancellation, and despatch.
ItemId (OrderItemId): Required for order item updates and deletion.
ClientId: Required for order filtering and creation.
WarehouseId: Required for order filtering.
CourierServiceId: Required for order filtering and creation.
ChannelId: Required for order filtering.
CurrencyId: Required for order creation.
OrderStatusId: Required for order filtering.
TrackingStatusId: Required for shipment tracking events filtering.
QueryId: Required for order query comments.
Product Management
When working with product-related custom API endpoints (https://api.mintsoft.co.uk/swagger/ui/index#!/Product), the following ID parameters are required:
ProductId (id): Required for product operations, deletion, inventory, and stock flow.
ClientId: Required for product listing and filtering (admin users).
WarehouseId: Required for stock flow filtering and inventory breakdown.
CartonId: Required for carton deletion.
CountryOfManufactureId: Required for product creation.
Warehouse Operations
When working with warehouse-related custom API endpoints (https://api.mintsoft.co.uk/swagger/ui/index#!/Warehouse), the following ID parameters are required:
WarehouseId: Required for all warehouse operations, locations, and stock movements.
LocationId: Required for location lookups and operations.
ProductId: Required for stock movements filtering.
LocationTypeId: Required for reference data for location types.
SourceWarehouseId: Required for warehouse transfer filtering.
DestinationWarehouseId: Required for warehouse transfer filtering.
WarehouseTransferId (id): Required to get, update, confirm, cancel, and delete warehouse transfers.
Advanced Shipping Notice (ASN)
When working with ASN-related custom API endpoints (https://api.mintsoft.co.uk/swagger/ui/index#!/ASN), the following ID parameters are required:
ASNId (id): Required for ASN operations, booking, and confirmation.
ASNStatusId: Required for ASN listing and filtering.
ClientId: Required for ASN filtering (3PL admin users).
WarehouseId: Required for ASN filtering.
Batch Processing
When working with batch-related custom API endpoints (https://api.mintsoft.co.uk/swagger/ui/index#!/Batch), the following ID parameters are required:
BatchId (id): Required for batch operations, status updates, and despatch.
OrderId (OrderID): Required for assigning orders to users.
OrderStatusId (OrderStatus): Required for batch status updates.
BatchTemplateId: Required for creating batches from templates.
Returns Management
When working with return-related custom API endpoints (https://api.mintsoft.co.uk/swagger/ui/index#!/Return), the following ID parameters are required:
ReturnId (id): Required for return operations, items, and confirmation.
OrderId: Required for creating returns.
ReturnitemId: Required for allocating item locations.
LocationId: Required for allocating return items to locations.
Reporting
When working with report-related custom API endpoints (https://api.mintsoft.co.uk/swagger/ui/index#!/Reports), the following ID parameters are required:
CourierId: Required for courier despatch report filtering.
WarehouseId: Required for report filtering.
ClientId: Required for report filtering.
LocationTypeId: Required for products in location report filtering.
ProductId: Required for product usage report filtering.
Accounting and Invoicing
When working with accounting-related custom API endpoints (https://api.mintsoft.co.uk/swagger/ui/index#!/Accounting), the following ID parameters are required:
InvoiceId (id): Required for invoice operations, orders, returns, and goods in.
ClientId: Required for invoice listing and filtering.
OrderId: Required for invoice item lookup.
WarehouseId: Required for adding additional invoice items.