UNPKG

@bebapps/rapyd-sdk

Version:

An un-official [Rapyd](https://rapyd.net) SDK for Node.js.

51 lines (50 loc) 1.8 kB
export interface CreateProductRequest { /** * Indicates whether the product is currently available for purchase. Default is true. */ active?: boolean; /** * 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. */ attributes?: string; /** * Full text description of the product. */ description?: string; /** * Unique 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\_**. */ id?: string; /** * An array of images. Each image is a string in Base64 encoding. */ images?: string; /** * A JSON object defined by the client. */ metadata?: object; /** * The name of the product or service that is displayed to the customer. */ name: string; /** * Describes the physical size and weight of the product. Relevant when `type` is *goods*. Contains the following fields: `height` `length` `weight` `width` */ package_dimensions?: object; /** * Indicates whether the product is physically shipped to the customer. Relevant when `type` is **goods**. Default is *false*. */ shippable?: boolean; /** * A text description that appears in the customer's invoice. Limited to 22 characters. Relevant when `type` is **service**. */ statement_descriptor?: string; /** * One of the following: **services**, **goods** */ type: string; /** * A label that represents units of this product, such as seats, on customers’ invoices. Relevant when `type` is **service**. */ unit_label?: string; };