NAnash
Store Catalog

Get Product by External Identifier

Retrieve a product from the store catalog using your external identifier.

get/v1/product/external_identifier/{externalIdentifier}

Request

  • Base URL
    https://api.sandbox.usenash.com
  • Auth
    none declared

Path parameters

externalIdentifierstring required

product external identifier

Example:ext_001

Response

OK

idstring required
externalIdentifierstring nullable

The external ID of the product from an external system

skustring nullable

The Stock Keeping Unit (SKU) for the product

namestring required

The name of the product

descriptionstring nullable

The description of the product

imageUrlsstring[] nullable

List of image URLs for the product

categoriesstring[] nullable

List of categories the product belongs to

weightnumber nullable

The weight of the product

attributesstring[] nullable

List of attributes for the product

Example response

{
  "externalIdentifier": "ext_001",
  "sku": "11111",
  "name": "Organic Bananas",
  "description": "Fresh organic bananas, perfect for smoothies and baking",
  "imageUrls": [
    "https://example.com/bananas1.jpg",
    "https://example.com/bananas2.jpg"
  ],
  "categories": [
    "Produce",
    "Fruits",
    "Organic"
  ],
  "weight": 0.5,
  "dimensions": {
    "depth": 10.5,
    "width": 5,
    "height": 15.2
  },
  "identifiers": [
    {
      "type": "UPC",
      "value": "123456789012"
    }
  ],
  "attributes": [
    "WEIGHTED"
  ],
  "details": {
    "weightedItemInfo": {
      "weightPerItem": 0.5,
      "weightUnit": "kg"
    },
    "sizeSpecification": {
      "value": 100,
      "description": "Large"
    },
    "packSizeSpecification": {
      "description": "Large"
    }
  },
  "providerConfigs": [
    {
      "categories": [
        "Produce",
        "Fruits",
        "Organic"
      ],
      "provider": "X",
      "serviceType": "pick_and_deliver"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.