logo

Retrieve a product

Retrieve a product with specified identifier string.

SecuritySecretApiKey or JWT or ApplicationJWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Responses
200

Product was retrieved successfully.

Response Schema: application/json
name
required
string <= 255 characters

The product name.

id
string <= 50 characters

The product ID.

unitLabel
string <= 50 characters
Default: "unit"

The unit label, such as per seat or per unit.

description
string <= 512 characters

The product description.

requiresShipping
boolean

If the product requires shipping, shipping calculations will be applied.

options
Array of strings

The product options such as color, size, etc. The product options definition does not include option values. Those are defined within the plans.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

createdTime
string <date-time>

The product created time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

taxCategoryId
string

The product's tax category identifier string.

Enum: "00000" "99999" "20010" "40030" "51020" "51010" "31000" "30070"
accountingCode
string

The product accounting code.

Array of objects (Self) non-empty

The links related to resource.

Array (non-empty)
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/products/{id}
Request samples
const product = await api.products.get({id: 'foobar-001'});
console.log(product.fields.name);
Response samples
application/json
{
  • "id": "membership",
  • "name": "Premium membership",
  • "unitLabel": "seat",
  • "description": "string",
  • "requiresShipping": false,
  • "options": [
    ],
  • "customFields": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "taxCategoryId": "00000",
  • "accountingCode": "4010",
  • "_links": [
    ]
}
➔ Next to Upsert a product with predefined ID