latestOpenAPI 3.0.32026-08-083681145.6 KB

19558399745c

Products

GET /products

This endpoint retrieves a list of products, ordered ascending by updated_at. By default, it only returns products that are not deleted.

get/products

Query parameters

limitinteger
pageinteger
updated_at_minstring
skustring
include_deletedboolean
cursorstring

Response

Successful response

pageinteger

The current page number.

limitinteger

The maximum number of products per page.

updated_at_minstring

The minimum updated_at timestamp used to filter products.

cursorstring

A cursor for pagination. Use this value in subsequent requests to get the next page of results.

Example response

{
  "products": [
    {
      "id": "p_123",
      "created_at": "2019-03-14T00:09:15.000Z",
      "updated_at": "2019-03-15T00:09:15.000Z",
      "brand_id": "b_abc",
      "name": "Faire's fantastic candle",
      "description": "Glad you decided to read our description! We have significantly more characters to describe to you just how good our candles smell.",
      "short_description": "Our candles smell fantastic. Want to know how good? Read our description!",
      "variants": [
        {
          "id": "po_abc123",
          "created_at": "2024-01-15T10:30:00Z",
          "updated_at": "2024-01-20T14:45:00Z",
          "name": "Vanilla Scent",
          "idempotence_token": "rrc23negw",
          "sku": "vanilla-2019",
          "available_quantity": 42,
          "backordered_until": "20190208T000915.000Z",
          "tariff_code": "340600",
          "images": [
            {
              "id": "i_adqaiy3htm",
              "width": 1000,
              "height": 1000,
              "url": "https://cdn.faire.com/374cd3041a4c4.png",
              "original_url": "https://example.com/original-image.png"
            }
          ],
          "options": [
            {
              "name": "Scent",
              "value": "Vanilla"
            }
          ],
          "prices": [
            {
              "geo_constraint": {
                "country": "USA",
                "country_group": "EUROPEAN_UNION"
              },
              "wholesale_price": {
                "amount_minor": 4999,
                "currency": "USD"
              },
              "retail_price": {
                "amount_minor": 4999,
                "currency": "USD"
              }
            }
          ],
          "variant_preorder_details": {
            "expected_ship_date": "2021-05-21",
            "expected_ship_window_end_date": "2021-05-24",
            "stop_selling_at": 1619827200000
          },
          "measurements": {
            "weight": 1.5,
            "length": 10.5,
            "width": 8,
            "height": 3.2
          },
          "gtin": "012345678905",
          "case_measurements": {
            "weight": 1.5,
            "length": 10.5,
            "width": 8,
            "height": 3.2
          }
        }
      ],
      "idempotence_token": "4aytry2ust",
      "unit_multiplier": 2,
      "minimum_order_quantity": 8,
      "images": [
        {
          "id": "i_adqaiy3htm",
          "width": 1000,
          "height": 1000,
          "url": "https://cdn.faire.com/374cd3041a4c4.png",
          "original_url": "https://example.com/original-image.png"
        }
      ],
      "variant_option_sets": [
        {
          "name": "Scent"
        }
      ],
      "preorder_details": {
        "order_by_date": "2021-04-01",
        "expected_ship_date": "2021-05-21",
        "expected_ship_window_end_date": "2021-05-24"
      },
      "product_attributes": [
        {
          "name": "Material",
          "value": "Cotton"
        }
      ]
    }
  ]
}