Skip to main content
Version: 202201

Product List

GET 
/openapi/2022-01/products

Retrieve a list of products with pagination.

Request​

Query Parameters

    ids string

    Product's IDs, separated by comma, for example: 9e79ca1f-9ff2-409b-976f-98be343d38a3,9e79ca1f-9ff2-409b-976f-98be343d38ae

    title string

    Product's title

    collection_id string

    The Collection ID uniquely identifies a group of products within a collection. It shows the collection which contains the product.for example: 9e79ca1f-9ff2-409b-976f-98be343d38a3

    created_at_min string

    Filter products created at or after date, for example: 2018-10-01T16:15:47-04:00

    created_at_max string

    Filter products created at or before date, for example: 2018-10-01T16:15:47-04:00

    updated_at_min string

    Filter products last updated at or after date, for example: 2018-10-01T16:15:47-04:00

    updated_at_max string

    Filter products last updated at or before date, for example: 2018-10-01T16:15:47-04:00

    published_at_min string

    Filter products published at or after date, for example: 2018-10-01T16:15:47-04:00

    published_at_max string

    Filter products published at or before date, for example: 2018-10-01T16:15:47-04:00

    published_status string

    Filter by published status: published, unpublished, any

    spus string

    Product's SPUs, separated by comma, for example: spu1,spu2

    pre_cursor string

    Pre cursor-based pagination

    cursor string

    Cursor-based pagination

    per_page int32

    Limit per page，maximum 250

    fields string

    Filter fields return in responses, separated by comma, for example: title, id

    vendors string

    precise matching by product's vendor。Multiple keys are separated by commas.

    vendors_match string

    Prefix matching by product's vendor. eg:if vendor="abcd", then "a" ,"ab","abc","abcd" is matched. but "bc","bcd" is not matched. if vendors and vendors_match are both filter,The result is the intersection of the two.

    handles string

    Filter products by handle, for example: handle_1,handle2

Responses​

200

Schema
    cursorstring
    Example: MjAyNC0wNC0xN1QwMjoxNToxOFojYTFhODhiZTAtYTFkNC00N2U0LWEyZjItYmE2ZTEzMWNmNDQ3
    pre_cursorstring
    Example: MjAyNC0wNC0xN1QwMjoxNToxOFojYTFhODhiZTAtYTFkNC00N2U0LWEyZjItYmE2ZTEzMWNmNDQ3
    products object[]
  • Array [
    • briefstring
    Example: shirt
    created_atstring
    Example: 2024-04-17T02:15:18Z
    descriptionstring
    Example: <p>Desc</p>
    display_fake_salesboolean
    Default value: true
    Example: true
    fake_salesinteger
    Default value: 0
    Example: 10
    handlestring
    Example: shirt
    has_only_default_variantboolean
    Default value: true
    Example: false
    idstring
    Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    image object
    srcstring
    Example: //cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg
    widthinteger
    Default value: 0
    Example: 174
    heightinteger
    Default value: 0
    Example: 180
    pathstring
    Example: ccf0794c594bad32a320eea0d6bfe40c.jpeg
    altstring
    Example:
    category object
    idinteger
    Default value: 0
    Example: 368313940138040900
    namestring
    Example: 3
    google_idinteger
    Default value: 0
    Example: 0
    levelinteger
    Default value: 0
    Example: 3
    pathstring
    Example: 368313940138008142,368313940138024526,368313940138040910
    images object[]
  • Array [
    • idstring
    Example: 8ef098c5-5a08-44b4-b5fb-89214bb507dc
    product_idstring
    Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    positioninteger
    Default value: 0
    Example: 1
    srcstring
    Example: //cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg
    widthinteger
    Default value: 0
    Example: 174
    heightinteger
    Default value: 0
    Example: 180
    altstring
    Example:
    created_atstring
    Example: 2024-04-17T02:15:18Z
    updated_atstring
    Example: 2024-04-17T02:15:35Z
  • ]
    • inventory_policystring
    Example: continue
    inventory_quantityinteger
    Default value: 0
    Example: 72
    inventory_trackingboolean
    Default value: true
    Example: true
    mixed_wholesaleboolean
    Default value: true
    Example: false
    need_variant_imageboolean
    Default value: true
    Example: true
    notestring
    Example:
    options object[]
  • Array [
    • idstring
    Example: a4fc1abf-86fb-4e45-b774-9ff3b3f8ef90
    product_idstring
    Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    positioninteger
    Default value: 0
    Example: 1
    namestring
    Example: size
    valuesstring[]
  • ]
    • publishedboolean
    Default value: true
    Example: false
    published_atstring
    Example: 1970-01-01T00:00:00Z
    requires_shippingboolean
    Default value: true
    Example: true
    seo_descriptionstring
    Example: Desc
    seo_keywordsstring
    Example:
    seo_titlestring
    Example: shirt
    spustring
    Example: T-M
    tagsstring
    Example: s1-s2
    taxableboolean
    Default value: true
    Example: true
    titlestring
    Example: shirt
    updated_atstring
    Example: 2024-04-17T02:15:35Z
    variants object[]
  • Array [
    • idstring
    Example: 88e68830-4ef5-4125-bf7d-aef8047176b2
    product_idstring
    Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    image_idstring
    Example: 8ef098c5-5a08-44b4-b5fb-89214bb507dc
    created_atstring
    Example: 2024-04-17T02:15:18Z
    updated_atstring
    Example: 2024-04-17T02:15:35Z
    titlestring
    Example: S-blue-T
    option1string
    Example: S
    option2string
    Example: blue
    option3string
    Example: T
    image object
    srcstring
    Example: //cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg
    widthinteger
    Default value: 0
    Example: 174
    heightinteger
    Default value: 0
    Example: 180
    pathstring
    Example: ccf0794c594bad32a320eea0d6bfe40c.jpeg
    altstring
    Example:
    positioninteger
    Default value: 0
    Example: 1
    compare_at_pricestring
    Example: 12.10
    pricestring
    Example: 10.10
    skustring
    Example: T-M-S-blue-T-A001004
    barcodestring
    Example: 6929000212340
    notestring
    Example: node
    inventory_quantityinteger
    Default value: 0
    Example: 10
    weightstring
    Example: 1.10
    weight_unitstring
    Example: kg
    cost_pricestring
    Example: 1.10
    wholesale_price object[]
  • Array [
    • pricestring
    Example: 10.10
    min_quantityinteger
    Default value: 0
    Example: 1
  • ]
    • extend object
    lengthinteger
    Default value: 0
    Example: 10
    widthinteger
    Default value: 0
    Example: 10
    heightinteger
    Default value: 0
    Example: 10
    dimension_unitstring
    Example: in
    origin_country_codestring
    Example: AG
    hs_codestring
    Example: 62114390
  • ]
    • vendorstring
    Example: shoplazza
    vendor_urlstring
    Example: https://shoplazza.com
  • ]