Search Products

POST

/v1/products

Request

Header Params

Body Params application/json

Example

{
    "page": 1,
    "per_page": 10,
    "sort_by": "final_price",
    "sort_order": "desc",
    "networks": {
        "335": {
            "affiliate_id": "112342343214321432",
            "sub_id": "subid123"
        }
    },
    "search": [
        {
            "field": "on_sale",
            "value": true
        },
        {
            "field": "currency",
            "value": "USD",
            "operator": "="
        },
        {
            "field": "name||description",
            "value": "3 person tent",
            "operator": "LIKE"
        },
        {
            "field": "brand",
            "value": "Chopard||Unknown",
            "operator": "NOT LIKE"
        },
        {
            "field": "regular_price",
            "value": "2000",
            "operator": ">"
        },
        {
            "field": "merchant.id",
            "value": "11111",
            "operator": "="
        },
        {
            "field": "network.id",
            "value": "222222",
            "operator": "!="
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/products' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page": 1,
    "per_page": 10,
    "sort_by": "final_price",
    "sort_order": "desc",
    "networks": {
        "335": {
            "affiliate_id": "112342343214321432",
            "sub_id": "subid123"
        }
    },
    "search": [
        {
            "field": "on_sale",
            "value": true
        },
        {
            "field": "currency",
            "value": "USD",
            "operator": "="
        },
        {
            "field": "name||description",
            "value": "3 person tent",
            "operator": "LIKE"
        },
        {
            "field": "brand",
            "value": "Chopard||Unknown",
            "operator": "NOT LIKE"
        },
        {
            "field": "regular_price",
            "value": "2000",
            "operator": ">"
        },
        {
            "field": "merchant.id",
            "value": "11111",
            "operator": "="
        },
        {
            "field": "network.id",
            "value": "222222",
            "operator": "!="
        }
    ]
}'

Responses

🟢200OK

application/json

Body

Example

{
    "meta": {
        "total": 150,
        "from": 1,
        "to": 2,
        "current_page": 1,
        "last_page": 15,
        "per_page": 10,
        "fields": [
            "id",
            "barcode",
            "name",
            "description",
            "commission_url",
            "direct_url",
            "image_url",
            "urls",
            "currency",
            "regular_price",
            "final_price",
            "on_sale",
            "sale_discount",
            "availability",
            "stock_quantity",
            "commissionable_status",
            "mpn",
            "sku",
            "brand",
            "category",
            "size",
            "color",
            "gender",
            "material",
            "country",
            "condition",
            "genre",
            "manufacturer",
            "model",
            "author",
            "artist",
            "tags",
            "network",
            "merchant",
            "updated_at",
            "started_at"
        ],
        "after": null,
        "sort_by": "finalprice",
        "sort_order": "desc",
        "trace_id": "01988abc-1234-5678-9def-123456789012"
    },
    "data": [
        {
            "id": "prod_12345678901234567890",
            "barcode": "1234567890123",
            "name": "Professional Outdoor Storage Shelter 60'x40'x15'",
            "description": "Heavy-duty waterproof storage shelter perfect for commercial and industrial use. Features reinforced steel frame construction with weather-resistant materials. Ideal for equipment storage, workshops, or temporary warehousing. Easy assembly with detailed installation manual included.",
            "commission_url": "https://outclick.co/a/eyJpdiI6InplQjZOQnRSamVpcloxbDUvZGo0amc9PSIsInZhbHVlIjoiMnZFb05uaThxakhhcTRFQk1XZ25OT3g4aHQ5cUJQUFo5L3NsaWxzdVhKcnhyK3JlTlV2UHlpNWxXYjY0d3dROHhEbHBoNExlN3k4RUF2MDZmcERzb05pQXZvcHdxQ1M5MC9FOTdsUFBhckJWK0hSaEFob3ZZVVZiQ0dKMXVLZWdpUENtYmlFdjNpSldPMUt6V2VFTTVxQnJzOUZMTEZTZ2ZWZEladjJpb2Y3MjRHQ3VVYllWVUxUcDNTNlF0Q05YUytuQTNHWW1tbUtkRDZXMTZUQVQwdnoxdnFZZ2JoRlUwRThta08yaVlZaUJCbmRJRUZHbVE3bDFaenUydGxHS1VHY0hkYzhRZmM3ZXRlaXVXTXF3ODlOK3dsL3NaRUZjbTdpaTZ3WUNZSHJtMlc2aTRnQmVERHc1NVRLK3RvTVBrTDlMbUU4UlNRM1FYK09NaDdtcmhxNldCSlVvYm9ZQVRPcU1kYlNCQzlYT0FsaCtXQTFkV1RpZ1JJNGNOYVVxR2M4bGUxd2FuZVFhdFpINVQwNW1FYmFYSVBzR3hUaG5UNW9iYzJJcVI3MEo2a0YvRnl1SGJUcXEyNHNiNXd1QVJvbG54WHB0RjlOVmVXa1FGN2dSbC9qdFZTZ1p0b1JTaGoyOVNkaXpNYWhKM2UxNGJIMDNuUUtWZXdtNXQ5KzFWVThsbC9IeWVsS3FvQnB5UzVTRXlCb2dRdk5PazRReDA4TmdMcGZjSDhBWHVobWR0blpHb09DWHNPMk9Zbk92RFB2S3NPdFRRYjZsZE5WeXlkeW1paStiTVR3eVJja0FqbmxBQ0NFNkNPSldCekZrOE1iazh3Y0lYSWFINTR0UllyUUZsWmkvL0U1NTZINUV5UHVTd3JMT0xOWXVrTCsvajZUekQ3VTFxbk16SmZUTDl5OTBvbk95amxDQUhzQ3BjS3N4Smt0TDcyb3FMOWlJRzZ2ZWVidWRkUDNCUXZEaE1YMVFYVUZQUlhnaG9TSG1FL3R4Rk9RQ08rc3JNekFRN3BjeUtJN3FNNjRTd2grR21HTUd1Um85OHlxUncvaWhzR1FSaEZsQm04YjhCa2djZHRvRUx4VUhkczNsNTlzd1VwRFVoNU1uNzRkenljT3JpSVZmY0JMYTcrK2I4dFBWNHZqSTJmbHAzNFhOdGd4UnF6bVRjaEZCTmtqaE1HeFZOTVRlWFNONUI2NHBuZ0VieEVXYk93K1pVek5LM2dPQ1d4ZUFubzNKR21oblhZK1VmNjdFUmI2a1FBSW5FdEU5cGt1Qko5M05sNnVaeS8wcTlyQmh1Zz09IiwibWFjIjoiZGM2N2NkZDkxNjU4NjhmZDg5MzcyMzRhODEyMWE5Nzk3M2VmN2YxNWU5OTEyZWNhNTFhZWUzZDUyM2RmMDA2MCIsInRhZyI6IiJ9?affiliate_id=@@@&sub_id=###",
            "direct_url": "https://shop.example-retailer.com/products/outdoor-shelter-60x40x15",
            "image_url": "https://cdn.example-retailer.com/images/shelter-main-view.jpg",
            "urls": {
                "outclick": "https://outclick.co/a/eyJpdiI6InplQjZOQnRSamVpcloxbDUvZGo0amc9PSIsInZhbHVlIjoiMnZFb05uaThxakhhcTRFQk1XZ25OT3g4aHQ5cUJQUFo5L3NsaWxzdVhKcnhyK3JlTlV2UHlpNWxXYjY0d3dROHhEbHBoNExlN3k4RUF2MDZmcERzb05pQXZvcHdxQ1M5MC9FOTdsUFBhckJWK0hSaEFob3ZZVVZiQ0dKMXVLZWdpUENtYmlFdjNpSldPMUt6V2VFTTVxQnJzOUZMTEZTZ2ZWZEladjJpb2Y3MjRHQ3VVYllWVUxUcDNTNlF0Q05YUytuQTNHWW1tbUtkRDZXMTZUQVQwdnoxdnFZZ2JoRlUwRThta08yaVlZaUJCbmRJRUZHbVE3bDFaenUydGxHS1VHY0hkYzhRZmM3ZXRlaXVXTXF3ODlOK3dsL3NaRUZjbTdpaTZ3WUNZSHJtMlc2aTRnQmVERHc1NVRLK3RvTVBrTDlMbUU4UlNRM1FYK09NaDdtcmhxNldCSlVvYm9ZQVRPcU1kYlNCQzlYT0FsaCtXQTFkV1RpZ1JJNGNOYVVxR2M4bGUxd2FuZVFhdFpINVQwNW1FYmFYSVBzR3hUaG5UNW9iYzJJcVI3MEo2a0YvRnl1SGJUcXEyNHNiNXd1QVJvbG54WHB0RjlOVmVXa1FGN2dSbC9qdFZTZ1p0b1JTaGoyOVNkaXpNYWhKM2UxNGJIMDNuUUtWZXdtNXQ5KzFWVThsbC9IeWVsS3FvQnB5UzVTRXlCb2dRdk5PazRReDA4TmdMcGZjSDhBWHVobWR0blpHb09DWHNPMk9Zbk92RFB2S3NPdFRRYjZsZE5WeXlkeW1paStiTVR3eVJja0FqbmxBQ0NFNkNPSldCekZrOE1iazh3Y0lYSWFINTR0UllyUUZsWmkvL0U1NTZINUV5UHVTd3JMT0xOWXVrTCsvajZUekQ3VTFxbk16SmZUTDl5OTBvbk95amxDQUhzQ3BjS3N4Smt0TDcyb3FMOWlJRzZ2ZWVidWRkUDNCUXZEaE1YMVFYVUZQUlhnaG9TSG1FL3R4Rk9RQ08rc3JNekFRN3BjeUtJN3FNNjRTd2grR21HTUd1Um85OHlxUncvaWhzR1FSaEZsQm04YjhCa2djZHRvRUx4VUhkczNsNTlzd1VwRFVoNU1uNzRkenljT3JpSVZmY0JMYTcrK2I4dFBWNHZqSTJmbHAzNFhOdGd4UnF6bVRjaEZCTmtqaE1HeFZOTVRlWFNONUI2NHBuZ0VieEVXYk93K1pVek5LM2dPQ1d4ZUFubzNKR21oblhZK1VmNjdFUmI2a1FBSW5FdEU5cGt1Qko5M05sNnVaeS8wcTlyQmh1Zz09IiwibWFjIjoiZGM2N2NkZDkxNjU4NjhmZDg5MzcyMzRhODEyMWE5Nzk3M2VmN2YxNWU5OTEyZWNhNTFhZWUzZDUyM2RmMDA2MCIsInRhZyI6IiJ9?affiliate_id=@@@&sub_id=###",
                "direct": "https://shop.example-retailer.com/products/outdoor-shelter-60x40x15",
                "affiliate": "https://partners.example-network.com/click?merchant=12345&product=67890&aff=@@@",
                "shopnomix": null
            },
            "currency": "USD",
            "regular_price": 12599,
            "final_price": 11999,
            "on_sale": true,
            "sale_discount": 5,
            "availability": "in_stock",
            "stock_quantity": 25,
            "commissionable_status": "confirmed_commissionable",
            "mpn": "OS-60-40-15-HD",
            "sku": "SHELTER60401522",
            "brand": "ProShelter Industries",
            "category": "Home & Garden > Outdoor Storage > Shelters",
            "size": "60' x 40' x 15'",
            "color": "Green",
            "gender": null,
            "material": "Steel Frame, PVC Tarpaulin",
            "country": "USA",
            "condition": "new",
            "genre": null,
            "manufacturer": "ProShelter Industries",
            "model": "PS-604015-DT",
            "author": null,
            "artist": null,
            "tags": [
                "outdoor",
                "storage",
                "commercial",
                "waterproof"
            ],
            "network": {
                "id": 123,
                "name": "ExampleAffiliate Network",
                "logo_url": "https://cdn.affiliate-logos.com/networks/example/128x128.png"
            },
            "merchant": {
                "id": 45678,
                "name": "Example Industrial Supply Co.",
                "logo_url": "https://cdn.merchant-logos.com/example-industrial/logo.png"
            },
            "updated_at": "2025-08-06 15:54:53",
            "started_at": "2025-08-06 15:54:53"
        },
        {
            "id": "prod_09876543210987654321",
            "barcode": "9876543210987",
            "name": "Compact Storage Canopy 40'x40'x15' - Heavy Duty",
            "description": "Durable square-footprint storage canopy designed for versatile outdoor use. Double-reinforced frame system provides excellent stability in various weather conditions. Perfect for vehicle storage, equipment protection, or temporary shelter needs.",
            "commission_url": "https://api.example-affiliate.com/click/ghi789jkl012?aff_id=@@@&sub_id=###",
            "direct_url": "https://shop.example-retailer.com/products/compact-canopy-40x40x15",
            "image_url": "https://cdn.example-retailer.com/images/canopy-compact-view.jpg",
            "urls": {
                "outclick": "https://api.example-affiliate.com/outbound/mno345?aff_id=@@@&sub_id=###",
                "direct": "https://shop.example-retailer.com/products/compact-canopy-40x40x15",
                "affiliate": "https://partners.example-network.com/click?merchant=12345&product=54321&aff=@@@",
                "shopnomix": null
            },
            "currency": "USD",
            "regular_price": 8999,
            "final_price": 7999,
            "on_sale": true,
            "sale_discount": 11,
            "availability": "low_stock",
            "stock_quantity": 3,
            "commissionable_status": "assumed_commissionable",
            "mpn": "CC-40-40-15-DT",
            "sku": "CANOPY404015DT",
            "brand": "ProShelter Industries",
            "category": "Home & Garden > Outdoor Storage > Canopies",
            "size": "40' x 40' x 15'",
            "color": "Gray",
            "gender": null,
            "material": "Galvanized Steel, Heavy Duty PVC",
            "country": "USA",
            "condition": "new",
            "genre": null,
            "manufacturer": "ProShelter Industries",
            "model": "PS-404015-CC",
            "author": null,
            "artist": null,
            "tags": [
                "compact",
                "storage",
                "canopy",
                "heavy-duty"
            ],
            "network": {
                "id": 123,
                "name": "ExampleAffiliate Network",
                "logo_url": "https://cdn.affiliate-logos.com/networks/example/128x128.png"
            },
            "merchant": {
                "id": 45678,
                "name": "Example Industrial Supply Co.",
                "logo_url": "https://cdn.merchant-logos.com/example-industrial/logo.png"
            },
            "updated_at": "2025-08-06 15:54:53",
            "started_at": "2025-08-06 15:54:53"
        }
    ]
}

🟠404Record not found

🟠429Rate Limit Exceeded

🟠422Invalid Network Parameters

Modified at 2025-12-22 15:43:16

Products

Omni