LogoLogo
  • General
    • Overview
    • Mode of Operation
    • Key Services and Logistics Requirements
  • Know Your Customer (KYC) FAQs
  • User Guide
    • General Product Information
    • Create Products
    • Product Image Requirements
    • Manage and Publish Products
    • Manage Stock and Prices
    • Orders and Shipments
    • User Management
  • API
    • Getting Started
      • API Authentication
      • Sandbox Environment
      • Make your first API request
    • Products
      • Get Products
      • Create and Update Products
      • Get Product Batch Results
      • Update Product Status (and Publish)
      • Get Product Status Update Batch Results
      • List Product Categories
      • List Product Attribute Groups
    • Stock and Prices
      • Update Stock
      • Get Stock Batch Results
      • Update Price
      • Get Price Batch Results
    • Orders and Shipment
      • Get Orders
      • Ship Order Items
      • Get Shipped Order Batch Results
      • Cancel Order Items
      • Get Cancelled Order Item Batch Results
      • Return Order Items
      • Get Returned Order Batch Results
    • Webhooks
      • Order Delegation Webhook
  • Shopify Plugin
    • Getting Started
      • Intro
      • Add Custom App to your Store
      • Sync your Shop in the Sellers Center
      • Product Preparations
      • Sync Products
      • Connect Products to the Seller Center
    • Order Handling
    • Additional Information
      • Permissions
      • Stock Safety Margin
      • Price Markup
On this page

Was this helpful?

Export as PDF
  1. API
  2. Products

Get Products

PreviousProductsNextCreate and Update Products

Last updated 1 month ago

Was this helpful?

Get Products

get
Authorizations
Query parameters
style_keyany ofOptional

Style key to search for

stringOptional
or
nullOptional
skuany ofOptional

SKU to search for

stringOptional
or
nullOptional
statusany ofOptional

Status of the product to filter by. Choose from: "draft", "pending_approval", "rejected", "pending_active", "active", "inactive", "archived".

string · enumOptionalPossible values:
or
nullOptional
pageinteger · min: 1Optional

Page number to retrieve items from

Default: 1
per_pageinteger · min: 1 · max: 100Optional

Number of items per page

Default: 20
Responses
200
OK
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
get
GET /api/v1/products/ HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "items": [
    {
      "style_key": "text",
      "status": "text",
      "sku": "text",
      "ean": "text",
      "hs_code": "text",
      "name": "text",
      "description": "text",
      "color": 1,
      "size": 1,
      "second_size": 1,
      "brand": 1,
      "category": 1,
      "quantity": 1,
      "weight": 1,
      "countries": [
        "text"
      ],
      "country_of_origin": "text",
      "attributes": [
        1
      ],
      "material_composition_textile": [
        {
          "cluster_id": 1,
          "components": [
            {
              "material_id": 1,
              "fraction": 100
            }
          ]
        }
      ],
      "material_composition_non_textile": [
        {
          "cluster_id": 1,
          "components": [
            {
              "material_id": 1
            }
          ]
        }
      ],
      "prices": [
        {
          "country_code": "DE",
          "retail_price": 100,
          "sale_price": 80
        }
      ],
      "images": [
        "text"
      ]
    }
  ],
  "pagination": {
    "per_page": 1,
    "page": 1,
    "pages": 1,
    "total": 1,
    "next": "text",
    "prev": "text"
  }
}