NMnmi
Products

Create Product

Create a new product in the Product Manager. Products can be used in invoices and other payment flows.

post/v5/products

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v5/products
  • Auth
    API key in header Authorization

Request body

product_skustring required

The unique alpha-numeric SKU for this product. An error will be returned if the SKU is already in use by another product.

product_descriptionstring required

The user-facing name of the product.

product_costnumber required

The cost of the product before any tax or discounts. Format: x.xx

product_currencystring required

The currency for the product's price (e.g., USD, EUR).

product_commodity_codestring

Product commodity code.

product_unit_of_measurestring

The unit of measure for the product. Default - NAR

product_tax_amountnumber

The tax that should be added to the product cost. This is a fixed amount, not a percentage.

product_discount_amountnumber

The discount that will be subtracted from the cost of the product.

product_image_namestring

The file name of the image being added with product_image_data. Required for image upload.

product_image_datastring

Image for the product, size must be 2MB or smaller. Format: base64 encoded JPG, PNG, or GIF. Required for image upload.

product_categorystring

Product category.

Response

Product created successfully

object'product' required

Resource type identifier

idstring required

Product ID (transaction_id)

product_skustring

Product SKU

product_descriptionstring

Product description

product_categorystring

Product category

product_commodity_codestring

Product commodity code

product_unit_of_measurestring

Product unit of measure

product_coststring

Product cost

product_currencystring

Product currency (ISO 4217)

product_tax_amountstring

Product tax amount

product_discount_amountstring

Product discount amount

product_image_namestring

Product image name

product_image_urlstring

Product image URL

Changes

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