uStoreProvider api products - XMPieLab/uStore-NG GitHub Wiki

getProductIDByFriendlyID(friendlyID) ⇒ Promise.<GUID>

Gets the product's unique ID by its friendly ID.

getProducts(categoryID, pageNumber, pageSize) ⇒ Promise.<ProductListModel>

Gets the online products of a specific product category, using pagination.

getProductsByIDs(IDs) ⇒ Promise.<ProductModelArray>

Gets the products by their unique IDs.

getProductByID(productID, retrieveTypeSpecificData) ⇒ Promise.<void>

Gets the product by its unique ID.

getProductThumbnails(productID) ⇒ Promise.<ThumbnailsModel>

Gets product thumbnails.

createProofPreview(orderItemID, properties) ⇒ Promise.<PreviewResponseModel>

Creates preview for the dynamic product by order product ID.

getProofPreview(orderItemID, previewID) ⇒ Promise.<PreviewResponseModel>

Gets preview status.

downloadProofPreview(orderItemID, previewID, fileName) ⇒ Promise.<Buffer>

Returns binary content of the preview file by file name.

createProof(orderItemID) ⇒ Promise.<ProofResponseModel>

Creates proof for the dynamic product by order product ID.

downloadProof(orderItemID, fileName) ⇒ Promise.<Buffer>

Returns binary content of the proof file by file name.

search(search, pageNumber, pageSize) ⇒ Promise.<ProductListModel>

Gets the products using a search string.

checkProofStatus(orderItemIds) ⇒ Promise.<ProofStatusModelArray>

Gets information about proof status

ProductModelArray : Array.<ProductModel>

A list of the products

ProofStatusModelArray : Array.<ProofStatusModel>

A collection of information about proof status.

GUID : string

globally unique identifier

ProductInventoryModel : Object

Provides information about a product inventory.

ProductUnitTypeModel : Object

Provides information about a product unit type.

ProductUnitModel : Object

Provides information about a product unit.
The unit can be a single item, multiple items or a pack of items.

ProductPriceModel : Object

Provides information about a product's price and tax.

SeoConfigurationModel : Object

Provides information about the SEO configuration of a category or product.

ProductQuantityItemModel : Object

Provides information about a product's quantity option.

ProductQuantityModel : Object

Provides information about a product's quantity configuration.

ProductConfigurationModel : Object

Provides information about a product's configuration.

ProductModel : Object

Provides information about a product.

ProductDetailsModel : Object

Provides information about a product, including additional data such as SEO configuration.

ProductListModel : Object

Provides a list of products according to the pagination.

ThumbnailModel : Object

Provides information about thumbnail.

ThumbnailsModel : Object

Provides information about thumbnails.

OrderItemPropertyModel : Object

Added/updated Dial Value

CreatePreviewRequestModel : Object

Request model with the data for the preview (fast-proof or immediate) uProduce job.

OutputItemModel : Object

Provides DTO for preview files.

PreviewResponseModel : Object

Provides preview DTO.

ProofResponseModel : Object

Provides proof DTO.

ProofStatusModel : Object

Provides information about proof status

Product types.

Kind: global enum
Properties

Name	Type	Default	Description
Dynamic	number	1	Dynamic product.
Static	number	2	Static product.
Email	number	3	Email product
Uploaded	number	4	Uploaded product.
Composite	number	5	Composite product.
DynamicWithPurl	number	6	Dynamic product with PURL.
EmailWithPurl	number	7	Email product with PURL.
CircleProject	number	8	Circle project's product.
PrintTouchPoint	number	9	Print touchpoint's product.
EmailTouchPoint	number	10	Email touchpoint's product.
WebTouchPoint	number	11	Web touchpoint's product.
PdfOnDemandTouchPoint	number	12	PDF on-demand touchpoint's product.
TriggeredEmailTouchPoint	number	13	Triggered email touchpoint's product.
Kit	number	14	Kit product.

Enum values present async activity status

Kind: global enum
Properties

Name	Type	Default
InProgress	number	1
Completed	number	2
Failed	number	3
PartiallyFailed	number	4

Enum values present uProduce job output format.

Kind: global enum
Properties

Name	Type	Default
Undefined	number	0
PDF	number	1
JPG	number	2

Gets the product's unique ID by its friendly ID.

Kind: global function
Returns: Promise.<GUID> - Returns a unique ID for the requested product.

Param	Type	Description
friendlyID	number	The friendly ID of the product.

Gets the online products of a specific product category, using pagination.

Kind: global function
Returns: Promise.<ProductListModel> - Returns a list of online products according the requested parameters.

Param	Type	Description
categoryID	GUID	The unique ID of the parent category.
pageNumber	number	The requested page number.
pageSize	number	The number of products on a single page. The maximum is 200.

Gets the products by their unique IDs.

Kind: global function
Returns: Promise.<ProductModelArray> - Returns a list of the requested products.

Param	Type	Description
IDs	Array.<GUID>	The list of unique IDs of the products.

Gets the product by its unique ID.

Kind: global function

Param	Type	Description
productID	GUID	The unique ID of the product.
retrieveTypeSpecificData	boolean	Indicates if the model should be basic, or with specific data. For instance, kitting has the Items property, which is unique to this product type.

Gets product thumbnails.

Kind: global function
Returns: Promise.<ThumbnailsModel> - Returns a product thumbnails.

Param	Type	Description
productID	GUID	The unique ID of the product.

Creates preview for the dynamic product by order product ID.

Kind: global function
Returns: Promise.<PreviewResponseModel> - Returns DTO with created preview details.

Param	Type	Description
orderItemID	GUID	order product ID
properties	CreatePreviewRequestModel	Customization values

Gets preview status.

Kind: global function
Returns: Promise.<PreviewResponseModel> - Returns DTO about preview.

Param	Type	Description
orderItemID	GUID	order product ID
previewID	GUID	preview ID

Returns binary content of the preview file by file name.

Kind: global function
Returns: Promise.<Buffer> - Returns binary content of the preview file.

Param	Type	Description
orderItemID	GUID	order product ID
previewID	GUID	preview ID
fileName	string	preview file name

Creates proof for the dynamic product by order product ID.

Kind: global function
Returns: Promise.<ProofResponseModel> - Returns DTO with created proof details.

Param	Type	Description
orderItemID	GUID	order product ID

Returns binary content of the proof file by file name.

Kind: global function
Returns: Promise.<Buffer> - Returns binary content of the proof file.

Param	Type	Description
orderItemID	GUID	order product ID
fileName	string	proof file name

Gets the products using a search string.

Kind: global function
Returns: Promise.<ProductListModel> - Returns a list of online products according the requested parameters.

Param	Type	Description
search	string	The search string.
pageNumber	number	The requested page number.
pageSize	number	The number of products on a single page. The maximum is 200.

Gets information about proof status

Kind: global function
Returns: Promise.<ProofStatusModelArray> - Returns a collection of information about proof status.

Param	Type	Description
orderItemIds	Array.<GUID>	The collections os orders.

A list of the products

Kind: global typedef

A collection of information about proof status.

Kind: global typedef

globally unique identifier

Kind: global typedef

Provides information about a product inventory.

Kind: global typedef
Properties

Name	Type	Description
Quantity	number	The number of units available in the inventory.
AllowOutOfStockPurchase	boolean	Indicates whether ordering is allowed, despite the inventory being out-of-stock.

Provides information about a product unit type.

Kind: global typedef
Properties

Name	Type	Description
Name	string	The singular form of the product unit name (e.g. "Box", "Item", "Pack", "Piece").
PluralName	string	The plural form of the product unit name (e.g. "Boxes", "Items", "Packs", "Pieces").

Provides information about a product unit.
The unit can be a single item, multiple items or a pack of items.

Kind: global typedef
Properties

Name	Type	Description
ItemQuantity	number	The number of items that make up the unit.
ItemType	ProductUnitTypeModel	The type of item.
PackType	ProductUnitTypeModel	The type of pack. The value is undefined (equals null) for units that are not sold in packs.

Provides information about a product's price and tax.

Kind: global typedef
Properties

Name	Type	Description
Price	number	The price of the product excluding tax, in the store's primary currency.
Tax	number	The tax of the product, in the store's primary currency.

Provides information about the SEO configuration of a category or product.

Kind: global typedef
Properties

Name	Type	Description
Title	string	The title of a webpage.
Description	string	The description of a webpage.

Provides information about a product's quantity option.

Kind: global typedef
Properties

Name	Type	Description
Name	string	The quantity option name.
Value	number	The quantity option value.

Provides information about a product's quantity configuration.

Kind: global typedef
Properties

Name	Type	Description
Minimum	number	The minimum number of units that can be purchased.
Maximum	number	The maximum number of units that can be purchased.
Changeable	boolean	Indicates whether the shopper can select the number of units to be purchased.
Options	Array.<ProductQuantityItemModel>	The list of the available quantities.

Provides information about a product's configuration.

Kind: global typedef
Properties

Name	Type	Description
AllowQuickAddToCart	boolean	Indicates whether the shopper can quick add product to cart from list
Quantity	ProductQuantityModel	The configuration of the product's quantity.
Properties	Array.<ProductQuantityModel>	The properties of the product.

Provides information about a product.

Kind: global typedef
Properties

Name	Type	Description
ID	GUID	The unique ID of the product.
FriendlyID	number	The friendly ID of the product.
Name	string	The name of the product.
ShortDescription	string	The short description of the product.
Description	string	The full description of the product.
ExternalID	string	The ID of the product in an external application.
CatalogNumber	string	The catalog number of the product. The value is undefined (equals null) if the user does not have permission to view the catalog number.
HasPricing	boolean	Indicates whether a price was defined for the product.
ImageUrl	string	The URL of the product image.
Thumbnails	Array.<string>	The product thumbnails.
Inventory	ProductInventoryModel	The inventory of the product. The value is undefined (equals null) if the user does not have permission to view the product inventory.
Unit	ProductUnitModel	The unit of the product.
MinimumQuantity	number	The minimum number of units that can be purchased.
MinimumPrice	ProductPriceModel	The minimum price of the product. The value is undefined (equals null) if the user does not have permission to view the product price.
Type	ProductType	The type of the product.
Configuration	ProductConfigurationModel	The configuration of the product.

Provides information about a product, including additional data such as SEO configuration.

Kind: global typedef
Properties

Name	Type	Description
SeoConfiguration	SeoConfigurationModel	The SEO configuration.
ID	GUID	The unique ID of the product.
FriendlyID	number	The friendly ID of the product.
Name	string	The name of the product.
ShortDescription	string	The short description of the product.
Description	string	The full description of the product.
ExternalID	string	The ID of the product in an external application.
CatalogNumber	string	The catalog number of the product. The value is undefined (equals null) if the user does not have permission to view the catalog number.
HasPricing	boolean	Indicates whether a price was defined for the product.
ImageUrl	string	The URL of the product image.
Thumbnails	Array.<string>	The product thumbnails.
Inventory	ProductInventoryModel	The inventory of the product. The value is undefined (equals null) if the user does not have permission to view the product inventory.
Unit	ProductUnitModel	The unit of the product.
MinimumQuantity	number	The minimum number of units that can be purchased.
MinimumPrice	ProductPriceModel	The minimum price of the product. The value is undefined (equals null) if the user does not have permission to view the product price.
Type	ProductType	The type of the product.
Configuration	ProductConfigurationModel	The configuration of the product.

Provides a list of products according to the pagination.

Kind: global typedef
Properties

Name	Type	Description
Products	Array.<ProductModel>	The list of the products according to the pagination.
Count	number	The total number of products without pagination.

Provides information about thumbnail.

Kind: global typedef
Properties

Name	Type	Description
Url	string	The URL of the thumbnail.
DisplayName	string	The name of the thumbnail.

Provides information about thumbnails.

Kind: global typedef
Properties

Name	Type	Description
Thumbnails	Array.<ThumbnailModel>	A thumbnail list representation.

Added/updated Dial Value

Kind: global typedef
Properties

Name	Type	Description
ID	string	The unique ID of the property.
Value	Object	The value of the property.

Request model with the data for the preview (fast-proof or immediate) uProduce job.

Kind: global typedef
Properties

Name	Type	Description
Properties	Array.<OrderItemPropertyModel>	Customization values

Provides DTO for preview files.

Kind: global typedef
Properties

Name	Type	Description
Url	string	Preview file URL.
Title	string	Localized title for the proof output file

Provides preview DTO.

Kind: global typedef
Properties

Name	Type	Description
PreviewID	GUID	Preview ID.
Status	ActivityStatus	Production status.
Format	OutputFormat	Preview format.
Items	Array.<OutputItemModel>	Collection of the preview files.

Provides proof DTO.

Kind: global typedef
Properties

Name	Type	Description
ProofID	GUID	Preview ID.
Status	ActivityStatus	Production status.
Format	OutputFormat	Preview format.
Items	Array.<OutputItemModel>	Collection of the preview files.

Provides information about proof status

Kind: global typedef
Properties

Name	Type	Description
OrderItemID	GUID	The unique ID of the order item
Status	ActivityStatus	The status of the proof
ThumbnailUrl	string	The thumbnail url of the proof