GetProductByIdParameters
Definition of graphql parameters for getting product by id
interface GetProductByIdParameters extends BaseParameters {
currencyCode?: CurrencyCode;
entityId?: number;
hideOutOfStock?: boolean;
includeCustomFields?: boolean;
includeModifiers?: boolean;
includeOptions?: boolean;
modifiersLimit?: number;
modifiersPage?: number;
optionsLimit?: number;
optionsPage?: number;
variantsAfter?: string;
variantsLimit?: number;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
currencyCode | Optional | CurrencyCode | Currency Code e.g USD, GBP, EUR |
entityId | Optional | number | Product Entity ID e.g (117, 144, 12) |
hideOutOfStock | Optional | boolean | Determine if the list should hide out of stock items |
includeCustomFields | Optional | boolean | Include custom fields |
includeModifiers | Optional | boolean | Include modifiers |
includeOptions | Optional | boolean | Include options |
modifiersLimit | Optional | number | Limit the number of modifiers returned max 50 only |
modifiersPage | Optional | number | Page number of modifiers |
optionsLimit | Optional | number | Limit the number of options returned max 50 only |
optionsPage | Optional | number | Page number of options |
variantsAfter | Optional | string | Cursor-pointer to determine the page the user is in which is before the ID/value |
variantsLimit | Optional | number | Limit the number of variants returned |