1. Products
OrderMesh
  • Introduction to our API
    • Getting Started
    • Product Catalog
    • Webhooks Overview
    • Merchant Notifications Guide
  • User
    • Client
      • Generate Service Client Access Token
    • User
      • Login User by Username and Password
      • Login User with Refresh Token
    • Schemas
      • AssignUserRoleDto
      • BulkResponse
      • BulkResponseItem
      • ClientTokenResponseDTO
      • ConflictErrorResponse
      • CreateInvitationDto
      • CreateInvitationDtoBulkModel
      • CreateInvitationResponse
      • CreateRoleDTO
      • CreateServiceClientDto
      • CreateServiceClientResponseDTO
      • CreateUserDto
      • CreateVendorInvitationDto
      • CreateVendorInvitationDtoBulkModel
      • CreateVendorInvitationResponse
      • DeleteInvitationResponse
      • DeleteVendorInvitationResponse
      • Error
      • ExternalErrorResponse
      • ForbiddenErrorResponse
      • ForgotPasswordDTO
      • FutureAssociationsDTO
      • GetInvitationResponse
      • GetInvitationsByMerchantIdResponse
      • GetInvitationsByMerchantIdResponseDto
      • GetServiceClientTokenDto
      • GetVendorInvitationResponse
      • GetVendorInvitationsByVendorIdResponse
      • GetVendorInvitationsByVendorIdResponseDto
      • InvitationDeliveryMethodEnum
      • InvitationDeliveryResponse
      • InvitationStatusEnum
      • InvitationsByMerchantIdSortByEnum
      • LoginUserDto
      • LoginUserWithAuthorizationCode
      • LoginUserWithRefreshToken
      • NotFoundErrorResponse
      • OnboardUserDto
      • PasswordPolicyDTO
      • PatchUserDTO
      • PermissionDTO
      • PermissionSet
      • PermissionSetsRequestDTO
      • PermissionSetsResponseDTO
      • ResendInvitationResponse
      • ResendVendorInvitationResponse
      • ResetPasswordDTO
      • ResourceDTO
      • RoleDTO
      • RolePermissionDTO
      • RoleWithPermissionDTO
      • SearchRolesEnum
      • SearchRolesResponseDTO
      • SearchUsersEnum
      • SearchUsersResponseDTO
      • ServiceClientResponseDTO
      • StringBulkModel
      • TokenResponseDTO
      • UnassignUserRoleDTO
      • UnauthorizedErrorResponse
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdateAssociationTypeDTO
      • UpdateAttributesDto
      • UpdateRoleDTO
      • UpdateRolePermissionsDTO
      • UserResponseDTO
      • ValidateEmailsResponse
      • ValidationErrorResponse
      • ValidationResponseDTO
  • Order
    • OrderItems
      • Search for order items based on various criteria and filters
    • Orders
      • Create a New Order.
      • Search for orders based on various criteria and filters.
      • Create multiple orders
      • Retrieve multiple orders
      • Update multiple orders
      • Retrieve a list of orders
      • Retrieve an order by Order ID.
      • Update order data.
      • Retrieve an order by Safe ID
      • Retrieve order item by Order Item ID
      • Update an item within an order.
      • Cancel Order or order items
      • Change the order status to Customer Care Hold
      • Retrieve audit logs for a specific order.
      • Retrieve audit logs for a specific order.
      • Retrieve audit logs for a specific order item.
      • Add a Refund Request.
    • Schemas
      • APIClientInfoModel
      • AddRefundItemModel
      • AddRefundModel
      • AddressModel
      • AttributeModel
      • BaseAddressModel
      • BillingInfoModel
      • BulkResponse
      • BulkResponseItem
      • CancelOrderItemModel
      • CancelOrderModel
      • CancelOrderResponse
      • ConflictErrorResponse
      • CoordinatesModel
      • CreateOrderCustomerPaymentMethodModel
      • CreateOrderCustomerTransactionModel
      • CreateOrderItemImageModel
      • CreateOrderItemModel
      • CreateOrderModel
      • CreateOrderModelBulkModel
      • CreateOrderResponse
      • CustomerCareHoldOrderResponse
      • Error
      • ForbiddenErrorResponse
      • GetAuditLogResponse
      • GetOrderCustomerPaymentMethodModel
      • GetOrderCustomerTransactionModel
      • GetOrderItemImageModel
      • GetOrderItemModel
      • GetOrderItemRefundDataItemModel
      • GetOrderItemRefundDataModel
      • GetOrderItemResponse
      • GetOrderModel
      • GetOrderResponse
      • GetOrdersCountByStatusResponse
      • GetOrdersPollingStoppedCountResponse
      • ListOrderModel
      • ListOrdersResponse
      • NotFoundErrorResponse
      • OptionModel
      • OrderItemStatus
      • OrderStatus
      • OrdersCountByStatus
      • PriceModel
      • RefreshProcessingModel
      • RefreshProcessingResponse
      • ReprintCostCoverageModel
      • ReprintModel
      • ReprintShipmentItemModel
      • ReprintShipmentModel
      • ResourceFormat
      • SearchOrderItemsResponse
      • SearchOrderModel
      • SearchOrdersResponse
      • ShipmentMetadata
      • StartProcessingModel
      • StartProcessingResponse
      • StringAuditEvent
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdateOrderItemImageModel
      • UpdateOrderItemModel
      • UpdateOrderItemResponse
      • UpdateOrderModel
      • UpdateOrderModelBulkModel
      • UpdateOrderResponse
      • UpdatePriceModel
      • ValidationErrorResponse
      • VariantAttribute
      • VariantOption
  • Note
    • Notes
      • Create a New Note
      • Search All Notes
      • View Note by ID
      • Update Note
      • Delete Note
      • View Note Audit Logs
    • Schemas
      • CreateNoteModel
      • CreateNoteReponse
      • Error
      • ForbiddenErrorResponse
      • GetAuditLogResponse
      • GetNoteByIdResponse
      • GetNoteResponseItemModel
      • GetNotesResponse
      • NotFoundErrorResponse
      • ResourceFormat
      • ResourceReferenceModel
      • StringAuditEvent
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdateNotePayload
      • UpdateNoteResponse
      • UserReferenceModel
      • ValidationErrorResponse
  • Catalog
    • Categories
      • View all product categories
      • Create a new category
      • Update category
      • Delete category
      • Get audit logs of a category
    • MerchantCatalog
      • Create a merchant catalog
      • Update a merchant catalog
      • Partially update a merchant catalog
      • Get a list of merchant catalogs
      • Delete a merchant catalog
      • Get a merchant catalog and search variants in it
      • Get a merchant catalog with variants
      • Get a list of variants the merchant can use in accordance with their enabled catalog
      • Search for variants in enabled merchant catalog with fallback to global catalog
      • Get audit logs of a merchant catalog
    • Products
      • View all products
        GET
      • Retrieve product variant details
        GET
      • Create a new product
        POST
      • Search products
        GET
      • Bulk create products
        POST
      • Bulk update products
        PUT
      • Update product
        PUT
      • Delete product
        DELETE
      • Update variant
        PUT
      • Get audit logs of a product
        GET
    • Variants
      • Delete variant
      • Create a variant
      • Search product variants
      • Get audit logs of a variant
    • MerchantVariants
      • Add new variants to a merchant catalog
      • Update a merchant catalog variants
      • Update a merchant catalog by removing variants
    • Schemas
      • AddMerchantVariantsDto
      • AddMerchantVariantsResponse
      • BulkResponse
      • BulkResponseItem
      • CategoryModel
      • CreateCategoryModel
      • CreateCategoryResponse
      • CreateMerchantCatalogDto
      • CreateMerchantCatalogResponse
      • CreateProductModel
      • CreateProductModelBulkModel
      • CreateProductResponse
      • CreateVariantModel
      • CreateVariantResult
      • DecorationModel
      • DeleteMerchantVariantsDto
      • DeleteMerchantVariantsResponse
      • Error
      • ForbiddenErrorResponse
      • GetAuditLogResponse
      • GetCategoriesResponse
      • GetEffectiveProductsResponse
      • GetEffectiveVariantListResponse
      • GetEffectiveVariantsByProductResponse
      • GetProductVariantsResponse
      • GetProductsResponse
      • ListMerchantCatalogsResponse
      • MerchantCatalogDto
      • MerchantVariantAttributeDto
      • MerchantVariantDto
      • MultiPrice
      • MultiPriceModel
      • NotFoundErrorResponse
      • PatchMerchantCatalogDto
      • PatchMerchantCatalogResponse
      • Price
      • PriceModel
      • PrintImageModel
      • PrintImageUploadStatus
      • PrintMethod
      • ProductAttributeModel
      • ProductAttributeValueModel
      • ProductExtraModel
      • ProductModel
      • ProductStatus
      • ResourceFormat
      • SearchEffectiveVariantsDto
      • SearchEffectiveVariantsResponse
      • SearchEffectiveVariantsSeparateDto
      • SearchEffectiveVariantsSeparateResponse
      • SearchMerchantCatalogVariantsResponse
      • SearchMerchantVariantDto
      • SearchProductsResponse
      • SearchVariantsModel
      • StringAuditEvent
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdateCategoryModel
      • UpdateMerchantCatalogDto
      • UpdateMerchantCatalogResponse
      • UpdateMerchantVariantsDto
      • UpdateMerchantVariantsResponse
      • UpdateProductModel
      • UpdateProductModelBulkModel
      • UpdateProductResponse
      • UpdateProductVariantModel
      • UpdateProductVariantResponse
      • ValidationErrorResponse
      • VariantAttributeModel
      • VariantModel
  • Shipment
    • Packing Slip
      • Generates a packing slip for a specific shipment by Shipment ID.
    • Shipments
      • Get details of a specific shipment by Shipment ID.
      • Update details of a specific shipment by Shipment ID.
      • Create packages for a specific shipment.
      • Delete shipment with packages.
      • Get all shipments for an order by Order ID.
      • Create shipment for order, vendor, and order items.
      • Get shipment with packages for order and vendor.
      • Get shipment details by Order Item ID.
      • Update a specific shipment package.
      • Delete a specific shipment package.
      • Cancel shipment.
      • Unassign items to shipment.
      • Shipment resubmission to assigned facility.
      • Retry outbound polling for a shipment by publishing an OutboundShipmentUpdate event.
      • Search shipments.
      • Reroute shipment.
      • Rejects a shipment.
      • Bulk reroute shipments.
      • Get shipment audit logs.
      • Get package audit logs.
      • Get message audit logs for shipment updates.
      • Assign Shipment.
    • Schemas
      • AssignDTO
      • AssignShipmentResponse
      • BulkResponse
      • BulkResponseItem
      • CancelShipmentDto
      • ConflictErrorResponse
      • CountryCodes
      • CreatePackageDTO
      • CreatePackagesResponse
      • CreateShipmentDTO
      • CreateShipmentResponse
      • CurrencyCodes
      • Error
      • ExternalErrorResponse
      • ForbiddenErrorResponse
      • GeneratePackingSlipResponse
      • GetAuditLogResponse
      • GetOrdersCountByFacilityResponse
      • GetShipmentPollingStoppedCountResponse
      • GetShipmentsCountByStatusResponse
      • GetVendorShipmentsCountByStatusResponse
      • LanguageCodes
      • NotFoundErrorResponse
      • OrderCount
      • OrderItem
      • OrderItemDTO
      • OrderItemImage
      • OrderItemImageDTO
      • OrderItemStatus
      • PackageDTO
      • PackageOrderItemDTO
      • PackingSlipDto
      • Price
      • Reject
      • RejectResponse
      • ReprintDTO
      • Reroute
      • RerouteBulkModel
      • RerouteOrderItem
      • RerouteResponse
      • ResourceFormat
      • SearchShipmentModel
      • SearchShipmentResponse
      • SelectedCarrierShippingServiceMethodDTO
      • SelectedShippingMappingDTO
      • SelectedShippingMappingMethodDTO
      • SelectedVendorMappingDTO
      • ShipmentDTO
      • ShipmentStatus
      • ShipmentsCountByStatus
      • ShippingAddressDTO
      • StringAuditEvent
      • UnassignOrderItemDTO
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdatePackageDTO
      • UpdateShipmentDTO
      • ValidationErrorResponse
      • VendorOrderItemModel
      • VendorPackageModel
      • VendorReassignShipmentDTO
      • VendorReassignShipmentResponse
      • VendorRejectShipmentDTO
      • VendorSearchShipmentModel
      • VendorSearchShipmentResponse
      • VendorShipmentResponse
      • VendorUpdateShipmentStatusEnumDTO
      • VendorUpdateTrackingDTO
      • VendorUploadItemImageDTO
      • VendorUploadItemImageResponse
  • Schemas
    • Schemas
      • CreateNoteModel
      • APIClientInfoModel
      • CreateNoteReponse
      • AddRefundItemModel
      • AddRefundModel
      • Error
      • AddressModel
      • ForbiddenErrorResponse
      • AttributeModel
      • GetAuditLogResponse
      • GetNoteByIdResponse
      • BaseAddressModel
      • GetNoteResponseItemModel
      • BillingInfoModel
      • GetNotesResponse
      • BulkResponse
      • BulkResponseItem
      • NotFoundErrorResponse
      • CancelOrderItemModel
      • ResourceFormat
      • ResourceReferenceModel
      • CancelOrderModel
      • CancelOrderResponse
      • StringAuditEvent
      • ConflictErrorResponse
      • UnauthorizedResult
      • CoordinatesModel
      • UnhandledErrorResponse
      • UpdateNotePayload
      • CreateOrderCustomerPaymentMethodModel
      • UpdateNoteResponse
      • CreateOrderCustomerTransactionModel
      • UserReferenceModel
      • CreateOrderItemImageModel
      • CreateOrderItemModel
      • ValidationErrorResponse
      • CreateOrderModel
      • CreateOrderModelBulkModel
      • CreateOrderResponse
      • CustomerCareHoldOrderResponse
      • GetOrderCustomerPaymentMethodModel
      • GetOrderCustomerTransactionModel
      • GetOrderItemImageModel
      • GetOrderItemModel
      • GetOrderItemRefundDataItemModel
      • GetOrderItemRefundDataModel
      • GetOrderItemResponse
      • GetOrderModel
      • GetOrderResponse
      • GetOrdersCountByStatusResponse
      • GetOrdersPollingStoppedCountResponse
      • ListOrderModel
      • ListOrdersResponse
      • OptionModel
      • OrderItemStatus
      • OrderStatus
      • OrdersCountByStatus
      • PriceModel
      • RefreshProcessingModel
      • RefreshProcessingResponse
      • ReprintCostCoverageModel
      • ReprintModel
      • ReprintShipmentItemModel
      • ReprintShipmentModel
      • SearchOrderItemsResponse
      • SearchOrderModel
      • SearchOrdersResponse
      • ShipmentMetadata
      • StartProcessingModel
      • StartProcessingResponse
      • UpdateOrderItemImageModel
      • UpdateOrderItemModel
      • UpdateOrderItemResponse
      • UpdateOrderModel
      • UpdateOrderModelBulkModel
      • UpdateOrderResponse
      • UpdatePriceModel
      • VariantAttribute
      • VariantOption
  1. Products

Search products

GET
/v1/products
This API request enables you to retrieve a list of products according to any specified filter criteria and sort options.

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Query Params

Responses

🟢200
application/json
OK
Body

🟠400
🟠401
🟠403
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.ordermesh.io/catalog/v1/products?id=undefined&category=undefined&productType=undefined&page=undefined&pageSize=undefined&sortBy=undefined&sortAsc=undefined' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Success
{
    "products": [
        {
            "id": "123456789",
            "title": "Ceramic Coffee Mug",
            "description": "A high-quality ceramic mug for coffee or tea.",
            "type": "Mugs",
            "brand": "MugBrand",
            "model": "MB-2024",
            "attributes": [
                {
                    "id": "color",
                    "name": "Color",
                    "values": [
                        {
                            "id": "white",
                            "name": "White"
                        }
                    ]
                }
            ],
            "options": [
                {
                    "id": "size",
                    "name": "Size",
                    "values": [
                        {
                            "id": "12oz",
                            "name": "12 oz"
                        },
                        {
                            "id": "16oz",
                            "name": "16 oz"
                        }
                    ]
                }
            ],
            "categories": [
                "trending",
                "kitchenware"
            ],
            "subCategories": [
                "drinkware"
            ],
            "images": [
                "https://example.com/images/mug1.jpg"
            ],
            "tags": [
                "coffee",
                "tea",
                "ceramic"
            ],
            "minPrice": {
                "currencies": [
                    {
                        "amount": 9.99,
                        "currency": "USD"
                    },
                    {
                        "amount": 8.99,
                        "currency": "EUR"
                    }
                ],
                "amount": 9.99,
                "currency": "USD"
            },
            "maxPrice": {
                "currencies": [
                    {
                        "amount": 14.99,
                        "currency": "USD"
                    },
                    {
                        "amount": 13.49,
                        "currency": "EUR"
                    }
                ],
                "amount": 14.99,
                "currency": "USD"
            },
            "shippingMinPrice": {
                "currencies": [
                    {
                        "amount": 2.99,
                        "currency": "USD"
                    },
                    {
                        "amount": 2.49,
                        "currency": "EUR"
                    }
                ],
                "amount": 2.99,
                "currency": "USD"
            },
            "status": "Active",
            "extras": [
                {
                    "name": "Care Instructions",
                    "values": [
                        "Dishwasher safe",
                        "Microwave safe"
                    ]
                }
            ]
        }
    ],
    "total": 1
}
Modified at 2026-05-27 12:48:51
Previous
Create a new product
Next
Bulk create products
Built with