Skip to main content

V1ProductsBody

Properties

NameTypeRequiredDescription
namestrThe name of the product or service that is displayed to the customer.
type_V1ProductsBodyTypeOne of the following - services, goods
activeboolIndicates whether the product is currently available for purchase. Default is true.
attributesList[str]Array of up to 5 alphanumeric strings defined by the merchant. Each string defines the key in a key-value pair in the 'attributes' object in the corresponding 'sku' objects.
descriptionstrFull text description of the product.
id_strUnique string for identification of the product. Legal input includes all the English alphanumeric characters and the underscore () character. If the merchant does not define an ID, Rapyd generates it with a string that starts with product
imagesList[str]An array of images. Each image is a string in Base64 encoding.
metadatadictA JSON object defined by the client.
package_dimensionsV1productsPackageDimensionsDescribes the physical size and weight of the product. Relevant when type is goods.
shippableboolIndicates whether the product is physically shipped to the customer. Relevant when type is goods. Default is false.
statement_descriptorstrA text description that appears in the customer's invoice. Limited to 22 characters. Relevant when type is service.
unit_labelstrA label that represents units of this product, such as seats, on customers’ invoices. Relevant when type is service.

V1ProductsBodyType

One of the following - services, goods

Properties

NameTypeRequiredDescription
SERVICESstr"services"
GOODSstr"goods"

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →