Sign in
ecommerce/products

List Products

get/ecommerce/products

Query parameters

remote_databoolean

Set to true to include data from the original software.

limitnumber

Set to get the number of records.

cursorstring

Set to get the number of records after this cursor.

Headers

x-connection-tokenstring required

The connection token

Response

prev_cursorstring nullable required
next_cursorstring nullable required

Example response

{
  "data": [
    {
      "product_url": "https://product_url/tee",
      "product_type": "teeshirt",
      "product_status": "ACTIVE",
      "images_urls": [
        "https://myproduct/image"
      ],
      "description": "best tee ever",
      "vendor": "vendor_extern",
      "variants": [
        {
          "title": "teeshirt",
          "price": 20,
          "sku": "3",
          "options": null,
          "weight": 10,
          "inventory_quantity": 100
        }
      ],
      "tags": [
        "tag_1"
      ],
      "field_mappings": {
        "fav_dish": "broccoli",
        "fav_color": "red"
      },
      "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "remote_id": "id_1",
      "remote_data": {
        "fav_dish": "broccoli",
        "fav_color": "red"
      },
      "created_at": "2024-10-01T12:00:00Z",
      "modified_at": "2024-10-01T12:00:00Z"
    }
  ]
}

Changes

Changed in 6 of the 18 revisions of this API.1634

  • ef360d76c6581See the full diff
    • ▲

      for the query request parameter limit, default value 50 was removed

      request-parameter-default-value-removed

    This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • be3dc330edf33See the full diff
    • ○

      removed the ACTIVE enum value from the allOf[subschema #2]/data/items/product_status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ARCHIVED enum value from the allOf[subschema #2]/data/items/product_status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the DRAFT enum value from the allOf[subschema #2]/data/items/product_status response property for the response status 200

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 17251bf7794f1See the full diff
    • ▲

      for the query request parameter limit, default value 50 was added

      request-parameter-default-value-added

  • 3539cfe8509c1See the full diff
    • ▲

      for the query request parameter limit, default value 30 was removed

      request-parameter-default-value-removed

  • 87189baf7791133See the full diff
    • ▲

      the response property allOf[subschema #2]/data/items/created_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/field_mappings became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/images_urls became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/modified_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/product_status became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/product_type became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/product_url became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/remote_data became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/remote_id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/tags became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/vendor became nullable for the status 200

      response-property-became-nullable

    • ●

      added the new ACTIVE enum value to the allOf[subschema #2]/data/items/product_status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ARCHIVED enum value to the allOf[subschema #2]/data/items/product_status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new DRAFT enum value to the allOf[subschema #2]/data/items/product_status response property for the response status 200

      response-property-enum-value-added

  • 3ce49f5aad531See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog