Products

Create a product, optionally with its price (default_price_data)

post/products

Request

Base URL: https://shieldz.cash/api/v1
URL: https://shieldz.cash/api/v1/products
Auth: HTTP bearer

Request body

namestring required

What the buyer sees, e.g. "Blue hoodie".

descriptionstring

Optional, shown under the name.

image_urlstring uri

A public https image URL. To upload a file instead, use the dashboard (Products → image).

idempotency_keystring

Retrying with the same key returns the first object (200, idempotent_replay: true) instead of creating another. The SDKs add one for you.

Example request

{
  "name": "Blue hoodie",
  "description": "Heavyweight cotton, unisex.",
  "image_url": "https://yourstore.com/img/hoodie.jpg",
  "default_price_data": {
    "unit_amount_usd_cents": 4999
  }
}

Response

Created

idstring

object'product'

namestring

Shown to the buyer on the payment link page and on invoices.

descriptionstring nullable

Shown under the name on the payment link page.

image_urlstring uri nullable

Product image. Images uploaded in the dashboard are served from this host.

activeboolean

false once archived. Links selling an archived product show as unavailable.

created_atinteger

Unix milliseconds.

updated_atinteger

Unix milliseconds.

Example response

{
  "id": "prod_3hQ8ZpW2Nc6Ty0Lk",
  "default_price": {
    "id": "price_9fK2LmQx7Rt4Vb1N"
  }
}

Changes

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