OMomnisend
Products

Create product

Creates a new product

Scopes: products.write

Rate Limiting: This endpoint is rate limited to 400 requests per minute.

<br><a href="https://www.postman.com/omnisend-api/workspace/omnisend/overview" target="_blank">Open Postman collection</a>

post/products

Request

  • Base URL
    https://api.omnisend.com/api
  • URL
    https://api.omnisend.com/api/products
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://app.omnisend.com/oauth2/token scopes: products.write
    • or API key in header Authorization

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Request body

categoryIDsstring[]
createdAtstring
currencystring required
defaultImageUrlstring

DefaultImageUrl is recommended if more than one image is needed. Other product images should be added to the Images array.

descriptionstring

Description is a short description of the product. It can be used in the email body.

idstring required
imagesstring[]
status'inStock' | 'outOfStock' | 'notAvailable' required

Status can be inStock, outOfStock, or notAvailable. We recommended to keep it in sync with your shop product to ensure that Omnisend can avoid sending out-of-stock products to your customers.

tagsstring[]

Tags can be used to categorize products.

titlestring required
typestring

Product type can be used to categorize products.

updatedAtstring
urlstring required

Url should point to the product page on the website.

vendorstring

Vendor is the manufacturer or the brand of the product.

Example request

{
  "categoryIDs": [
    "1234567890",
    "99934567890"
  ],
  "createdAt": "2021-01-01T00:00:00Z",
  "currency": "USD",
  "defaultImageUrl": "https://example.com/image.jpg",
  "description": "My product description",
  "id": "1234567890",
  "images": [
    "https://example.com/image.jpg",
    "https://example.com/image2.jpg"
  ],
  "status": "inStock",
  "tags": [
    "tag1",
    "tag2",
    "tag3"
  ],
  "title": "My Product",
  "type": "Super Product",
  "updatedAt": "2021-01-01T00:00:00Z",
  "url": "https://example.com/product",
  "variants": [
    {
      "defaultImageUrl": "https://example.com/variantImage.jpg",
      "description": "My variant description",
      "id": "1234567890",
      "images": [
        "https://example.com/variant/image.jpg",
        "https://example.com/variant/image2.jpg"
      ],
      "price": 9.99,
      "sku": "SKU1234567890",
      "status": "inStock",
      "strikeThroughPrice": 19.99,
      "title": "My Variant",
      "url": "https://example.com/variant"
    }
  ],
  "vendor": "My Vendor"
}

Response

Product created successfully with the given ID

idstring

Example response

{
  "id": "shoes-blue-123"
}

Changes

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