Skip to main content
POST
/
v1
/
products
Create or update products
curl --request POST \
  --url https://api.sandbox.usenash.com/v1/products \
  --header 'Content-Type: application/json' \
  --data '{
  "products": [
    {
      "externalIdentifier": "ext_001",
      "sku": "ORG-BAN-001",
      "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": 8,
        "height": 4,
        "width": 12
      },
      "identifiers": [
        {
          "type": "UPC",
          "value": "123456789012"
        }
      ],
      "attributes": [
        "WEIGHTED"
      ],
      "details": {
        "packSizeSpecification": {
          "description": "10 units per pack",
          "value": 10
        },
        "sizeSpecification": {
          "description": "ea",
          "value": 1
        },
        "weightedItemInfo": {
          "weightPerItem": 0.12,
          "weightUnit": "kg"
        }
      },
      "providerConfigs": [
        {
          "categories": [
            "Produce",
            "Fruits",
            "Organic"
          ],
          "provider": "X",
          "serviceType": "pick_and_deliver"
        }
      ]
    }
  ]
}'
[
  {
    "id": "<string>",
    "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": 8,
      "height": 4,
      "width": 12
    },
    "identifiers": [
      {
        "type": "UPC",
        "value": "123456789012"
      }
    ],
    "attributes": [
      "WEIGHTED"
    ],
    "details": {
      "packSizeSpecification": {
        "description": "10 units per pack",
        "value": 10
      },
      "sizeSpecification": {
        "description": "ea",
        "value": 1
      },
      "weightedItemInfo": {
        "weightPerItem": 0.12,
        "weightUnit": "kg"
      }
    },
    "providerConfigs": [
      {
        "categories": [
          "Produce",
          "Fruits",
          "Organic"
        ],
        "provider": "X",
        "serviceType": "pick_and_deliver"
      }
    ]
  }
]

Body

application/json
​
products
ProductInputSerializer · object[]
required

List of products to create

Response

OK

Expected output when listing products, it will return an array of ProductOutputSerializer.

​
id
string
required
​
name
string
required

The name of the product

Example:

"Organic Bananas"

​
externalIdentifier
string | null

The external ID of the product from an external system

Example:

"ext_001"

​
sku
string | null

The Stock Keeping Unit (SKU) for the product

Example:

"11111"

​
description
string | null

The description of the product

Example:

"Fresh organic bananas, perfect for smoothies and baking"

​
imageUrls
string[] | null

List of image URLs for the product

Example:
[
  "https://example.com/bananas1.jpg",
  "https://example.com/bananas2.jpg"
]
​
categories
string[] | null

List of categories the product belongs to

Example:
["Produce", "Fruits", "Organic"]
​
weight
number | null

The weight of the product

Example:

0.5

​
dimensions
object | null

Dimensions of the product

Example:
{ "depth": 8, "height": 4, "width": 12 }
​
identifiers
IdentifierOutputSerializer · object[] | null

List of identifiers for the product

Example:
[{ "type": "UPC", "value": "123456789012" }]
​
attributes
string[] | null

List of attributes for the product

Example:
["WEIGHTED"]
​
details
object | null

Additional product details including weight and size specifications

Example:
{
  "packSizeSpecification": {
    "description": "10 units per pack",
    "value": 10
  },
  "sizeSpecification": { "description": "ea", "value": 1 },
  "weightedItemInfo": { "weightPerItem": 0.12, "weightUnit": "kg" }
}
​
providerConfigs
ProviderConfigOutputSerializer · object[] | null

Provider-specific configurations for this product

Example:
[
  {
    "categories": ["Produce", "Fruits", "Organic"],
    "provider": "X",
    "serviceType": "pick_and_deliver"
  }
]