Products

Create a product

Adds a product to one of your stores. It goes on sale at once unless you create it as a draft.

Headers#

• Idempotency-KeystringRequired

  Client-generated key that makes the request safe to retry. Replaying the key with an identical payload returns the original response; replaying it with a different payload is rejected. Up to 255 characters.

Body parameters#

• namestringRequired

  Up to 120 characters.

• price_minorintegerRequired

  At least 1.

• storefront_iduuidRequired

  The store to add it to.

• category_iduuidOptional
• delivery_notestringOptional

  Up to 1000 characters.

• descriptionstringOptional

  Up to 2000 characters.

• fulfillmentstringOptional

  One of shipping, pickup, shipping_or_pickup.

• kindstringOptional

  Physical when left out. One of physical, digital.

• sale_price_minorintegerOptional

  At least 1.

• shipping_notestringOptional

  Up to 300 characters.

• statusstringOptional

  Active when left out. One of active, draft, archived.

• stockintegerOptional

  Leave out to not track stock. At least 0.

• tagsarray of stringOptional

Responses#

• 201Product created
• 401The secret key is missing, invalid or revoked.
• 403The key is not allowed to do this, or the request came from an address that is not on its allowlist.
• 404Nothing was found for this business and mode.
• 409The request clashes with the current state, such as a reference reused with different details.
• 422A field is missing or not valid.