Skip to main content
GuidesAPI Reference

List Products

GET 
/commerce/products

List products for a specified connection

Request​

Query Parameters

    credentialId stringrequired

    The ID of the credential.

    pageNumber string

    The page number of the results. Default is 1.

    pageSize int32

    The maximum number of results to show on a page. Default is 50. Maximum is 100.

    productType string

    A string used to retrieve products with a specific product type.

    productTypeContains string

    A string used to retrieve products with a product type containing a specific value.

    productTypeNotEquals string

    A string that should not match the product type of products to be retrieved.

    productName string

    A string used to retrieve products with a specific product name.

    productNameContains string

    A string used to retrieve products with a product name containing a specific value.

    productNameNotEquals string

    A string that should not match the product name of products to be retrieved.

    description string

    A string used to retrieve products with a specific description.

    descriptionContains string

    A string used to retrieve products with a description containing a specific value.

    descriptionNotEquals string

    A string that should not match the description of products to be retrieved.

    productStatus string

    Possible values: [DRAFT, ACTIVE, INACTIVE, UNLISTED]

    A string used to retrieve products with a specific product status.

    productStatusContains string

    A string used to retrieve products with a product status containing a specific value.

    productStatusNotEquals string

    A string that should not match the product status of products to be retrieved.

    vendor string

    A string used to retrieve products from a specific vendor.

    vendorContains string

    A string used to retrieve products with a vendor name containing a specific value.

    vendorNotEquals string

    A string that should not match the vendor name of products to be retrieved.

    remoteCreatedAtMin date

    Filter objects created in the third-party application after a specified date.

    remoteCreatedAtMax date

    Filter objects created in the third-party application before a specified date.

    remoteUpdatedAtMin date

    Filter objects last updated in the third-party application after a specified date.

    remoteUpdatedAtMax date

    Filter objects last updated in the third-party application before a specified date.

    createdAtMin date

    Filter objects created after a specified date.

    createdAtMax date

    Filter objects created before a specified date.

    updatedAtMin date

    Filter objects last updated after a specified date.

    updatedAtMax date

    Filter objects last updated before a specified date.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Responses​

200

Schema

    any

Loading...