Sign in
latestOpenAPI 3.0.02026-08-1056429755.6 KB

a6efafc1669c

Retrieve Product (Synchronous API)

Get an individual or base product information

Provide detailed information on the individual product or base product. If the product is a base product, the response provides the product variation URLs for that base product, instead of the entire details for each product variation.

get/v1/products/{productId}

Path parameters

productIdstring required

The product identifier of either an individual product or a base product.

Query parameters

version'DEPLOYED' | 'RETIRED'

Get the specific version of the product by state.

Headers

x-erid-as-pidboolean

Set to true if you want to use the external reference identifier (ERID) in the path instead of the product identifier (productId).

Response

Successful response.

productType'BASE' | 'INDIVIDUAL'

Indicates the type of product as either an individual or base product. A base product has one or more product variations such as different colors, sizes, or versions. An individual product a single item or many single items sold as a single product (such as a colection or box set.

companyIdstring

The company identifier.

siteIdsstring[]

The site identifier.

idstring

The individual product identifier or base product identifier for the product.

state'Deployed' | 'Design' | 'Retired' | 'Deployed: Pending Start' | 'Deployed: Partially Started'

The status of the product.

  • Deployed: The current product setup is the same product setup that is available for sale on your store.
  • Design: The current product setup (also called in the version) has not yet been deployed to your store.
  • Retired: The version of the product cannot be purchased or seen on your store.
  • Deployed: Pending Start: This state appears when a future Start Date is set for base, individual or variation product, and also the product is deployed. Meaning there is a version that is available for sale on your store. And there is another newer version will be available for sale on your store when the Start Date arrived.
  • Deployed: Partially Started: This state appears when the base product is now ready for sale, but a future Start Date is set for any of its variations, and also the product is deployed.
lockedboolean

When the product is locked, the product is not editable.

versioninteger

Version of the product.

Example response

[
  {
    "companyId": "digitalriver",
    "siteIds": [
      "domoSite1",
      "domoSite2"
    ],
    "id": "1234567800",
    "version": 1,
    "deploymentRequiredChanges": {
      "otherFulfillmentIntegration": {
        "fulfillerIds": [
          "digitalRiver"
        ]
      },
      "transferProduct": "2234567800",
      "upgradeProducts": [
        "3234567800"
      ],
      "downgradeProducts": [
        "4234567800"
      ]
    },
    "liveChanges": {
      "externalReferenceId": "sku-1234-5678-xyz",
      "catalogs": [
        {
          "catalogId": "123456000",
          "catalogName": "a catalog",
          "categories": [
            {
              "categoryId": "19000000",
              "categoryName": "a category"
            }
          ],
          "prices": [
            {
              "priceListName": "Unit Price",
              "prices": [
                {
                  "currency": "USD",
                  "locale": "en_US",
                  "configuredPrice": 15.99
                }
              ]
            }
          ]
        }
      ]
    },
    "localizations": [
      {
        "locale": "en_US",
        "groups": [
          {
            "groupId": "11000",
            "groupName": "Storefront Settings"
          }
        ]
      }
    ]
  }
]