Sign in
ecommerce/products

Retrieve Products

Retrieve products from any connected Ats software

get/ecommerce/products/{id}

Path parameters

idstring required

id of the product you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Ats software.

Headers

x-connection-tokenstring required

The connection token

Response

product_urlstring nullable

The URL of the product

product_typestring nullable

The type of the product

product_statusstring nullable

The status of the product. Either ACTIVE, DRAFT OR ARCHIVED.

images_urlsstring[] nullable

The URLs of the product images

descriptionstring nullable

The description of the product

vendorstring nullable

The vendor of the product

variantsVariant[]

The variants of the product

tagsstring[] nullable

The tags associated with the product

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the product

remote_idstring nullable

The remote ID of the product in the context of the 3rd Party

remote_dataobject nullable

The remote data of the customer in the context of the 3rd Party

created_atstring nullable

The created date of the object

modified_atstring nullable

The modified date of the object

Example response

{
  "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 3 of the 18 revisions of this API.1334

  • be3dc330edf33See the full diff
    • ○

      removed the ACTIVE enum value from the product_status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ARCHIVED enum value from the product_status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the DRAFT enum value from the 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

  • 87189baf7791133See the full diff
    • ▲

      the response property created_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property field_mappings became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property images_urls became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property modified_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property product_status became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property product_type became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property product_url became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property remote_data became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property remote_id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property tags became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property vendor became nullable for the status 200

      response-property-became-nullable

    • ●

      added the new ACTIVE enum value to the product_status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ARCHIVED enum value to the product_status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new DRAFT enum value to the 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