Sign in
Products

Create a Product

Create a new Product with the provided details

post/products

Request body

metadataobject nullable

Metadata used by merchants to store additional information about the entity.

namestring required

Name of the product

descriptionstring

Description of the product. Not visible to end customers

statementDescriptorstring

Statement descriptor for the product. Max 22 characters.

category'digital' | 'physical'

Category of the product, sent to the payment provider so the VAT split between digital services and physical goods can be reconstructed from the provider reports. Plays no part in fulfillment.

shippableboolean

Whether the product takes part in Order Management: a payment for one of its prices becomes an order item. Defaults to false. Settable whether or not the Order Management addon is enabled, so a catalogue can be prepared before switching it on.

skustring nullable

Stock Keeping Unit the warehouse ships this product under, used on the 3PL manifest. For a shippable product it decides whether the resulting order item physically ships. The same SKU covers every price of the product — 1-pack, 3-pack and per-currency variants all ship the same item. Send null to clear it.

Example request

{
  "metadata": {
    "orderId": "12345",
    "notes": "Urgent delivery"
  },
  "name": "My product",
  "description": "...",
  "statementDescriptor": "Some statement descriptor",
  "category": "digital",
  "sku": "FY-YOGA-MAT-01"
}

Response

OK

createdAtstring date-time required

The date and time when the entity was created.

updatedAtstring date-time nullable required

The date and time when the entity was last updated.

metadataobject nullable

Metadata used by merchants to store additional information about the entity.

idstring required

ID of the product

activeboolean required

Indicates if the product is currently active. Inactive products will be hidden from the dashboard, but can still be used in the API.

namestring

Name of the product. Only available from the dashboard or the API using a secret key.

descriptionstring nullable

Description of the product. Only available from the dashboard or the API using a secret key.

statementDescriptorstring nullable

Statement descriptor for the product that will be used in the bank statement

category'digital' | 'physical' | 'null' nullable

Category of the product, sent to the payment provider so the VAT split between digital services and physical goods can be reconstructed from the provider reports. Plays no part in fulfillment. Only available from the dashboard or the API using a secret key.

shippableboolean

Whether the product takes part in Order Management: a payment for one of its prices becomes an order item. Only available from the dashboard or the API using a secret key.

skustring nullable

Stock Keeping Unit the warehouse ships this product under, used on the 3PL manifest. For a shippable product it decides whether the resulting order item physically ships: an item without one is kept on the order but never fulfilled. Null when the product has none. Only available from the dashboard or the API using a secret key.

Example response

{
  "createdAt": "2024-02-18T12:00:00Z",
  "updatedAt": "2024-02-21T12:15:00Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "id": "prod_2QC7PqoUeOxQEWscJJt6B3PkvyL",
  "active": true,
  "name": "My product",
  "description": "Best selling product",
  "statementDescriptor": "Face Yoga subscription",
  "category": "digital",
  "sku": "FY-YOGA-MAT-01"
}

Changes

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