Description |
This method can be called to create new products in SupplyStream. If you have not created any products then this should be the first method you call. |
System behaviours
- The SKU is defined by the ProductCode (unique identifier)
- SKU's cannot be deleted once created
- SKU is created in status 'In production'
- In CSV, multiple suppliers can be loaded as long as the row for the product entity are together.
Available formats
Entity Relationships
This diagram shows the high level relationship between the entities detailed in the Field Level Details section of this page.
Field level details
ProductMaster | ||||||
Field | Description | Data Type | Value Limits | Requirement | Use on standard documents | Field returned in service ID/table/field (multi services split by ";") |
ProductCode | Unique SKU identifier code. This is the reference that is used to identify the SKU in other services | nvarchar(100) | Mandatory | Dispatch Note, Commercial Inv | ||
ProductDescription | Short description of SKU | nvarchar(200) | Mandatory | Dispatch Note, Commercial Inv | ||
ProductLongDescription | Open reference field | nvarchar(500) | ||||
EAN | SKU International Article Number/Barcode. Must be unique to the SKU. | nvarchar(50) | Conditional: if required by DC | |||
HTSCode | Commodity code used to classify and define internationally traded goods. Must be numeric. | nvarchar(100) | Must be numeric | Conditional: if required for shipping | Commercial Inv | |
Hazardous | If set to true, the SKU will be marked as Hazardous in SupplyStream | boolean | true, false | Conditional: if the Product is a Hazardous SKU | ||
GrossWeight | Gross weight of SKU. Accepts up to 4 decimal places. | decimal(18, 4) | Mandatory | |||
GrossWeightUOM | The Unit of Measure of the GrossWeight | char(2) | KG | Mandatory | ||
LotControlled | Set to true if lot numbers are to be recorded on inbound/outbound | boolean | true, false | |||
DateControlled | Set to true if SKU has a best before date. System will automatically operate on FEFO basis. | boolean | true, false | |||
CountryOfOrigin | Specifies which country the goods were manufactured | nvarchar(2) | ISO-2 | Conditional: if required for shipping | Commercial Inv | 25 |
Brand | Product Brand | nvarchar(100) | ||||
Colour | Colour of SKU i.e. Blue | nvarchar(100) | ||||
Size | Size of SKU I.e Small | nvarchar(100) | ||||
GroupIdentifier | A group value for SKU classification i.e. Homeware, Coats, Glassware. | nvarchar(100) | ||||
QCControlled | If a product is marked as QCControlled = True, a percentage value will need to be sent to annotate what percentage of a delivery needs to be Quality Checked. | boolean | ||||
QCPercentage | The percentage of the delivery that needs to be Quality Checked. | int | ||||
SerialNumberControlled | Serial Number Controlled flag | boolean | ||||
InwardProcessing | Inward Processing flag | boolean | ||||
WetBond | Wet Bond flag | boolean | ||||
UnitPrice | Unit price of SKU. | decimal(18, 4) | 25 | |||
LeadTime | Lead time in days to deliveries | int | 25 | |||
Category1 | Category 1 | nvarchar(50) | 25 | |||
Category2 | Category 2 | nvarchar(50) | 25 | |||
MOQ | Minimum Order Quantity | int | 25 | |||
Currency | Currency of unit price. No ISO-3 validation. | nchar(3) | 25 | |||
ProductUse | Product Use. Open text field. | nvarchar(50) | 25 | |||
ClientProductStatus | Product Status. Open text field. Does not show on SupplyStream | nvarchar(50) | 25 | |||
Business | Business open text field | nvarchar(50) | 25 | |||
Bonded | Bonded flag | boolean | ||||
SecondaryCurrencyCode | Secondary currency, for example, the purchase currency. No ISO-3 validation | nchar(3) | ||||
SecondaryPrice | Secondary price, for example, the purchase price | decimal(18, 4) | ||||
StyleCode | Style code open text field | nvarchar(100) |
SupplierMapping | ||||||
Field | Description | Data Type | Value Limits | Requirement | Use on standard documents | Field returned in service ID/table/field (multi services split by ";") |
SupplierCode | Supplier code of the supplier to be assigned to the SKU. Supplier code created in Load Companies using CompanyCode. SupplierCode can also be created 'on the fly', but no Supplier address details will be recorded. | nvarchar(100) | Conditional: if required by DC | |||
SupplierDescription | Name of supplier. If the SupplierCode specified already exists, the existing Supplier Description will be used rather than the one specified in this field. | nvarchar(200) | Conditional: if 'SupplierMapping → SupplierCode' provided | |||
UOM | Placeholder | int |
ShipToCompanyMapping | ||||||
Field | Description | Data Type | Value Limits | Requirement | Use on standard documents | Field returned in service ID/table/field (multi services split by ";") |
MappedCode | Placeholder. | nvarchar(100) | ||||
CompanyCode | Placeholder. | nvarchar(100) | ||||
BranchCode | Placeholder. | nvarchar(50) |
ProductCategory | ||||||
Field | Description | Data Type | Value Limits | Requirement | Use on standard documents | Field returned in service ID/table/field (multi services split by ";") |
CategoryCode | Placeholder. | nvarchar(100) |
ProductIdentifier | ||||||
Field | Description | Data Type | Value Limits | Requirement | Use on standard documents | Field returned in service ID/table/field (multi services split by ";") |
Name | Different attributes that can be assigned to a SKU. | nvarchar(100) | Material | 'Material' appears on Commercial Inv | ||
Values | This the value in which you want to assign to the attribute specified in ProductIdentifier → Name. | nvarchar(200) | Conditional: if 'ProductIdentifier → Name' provided | 'Material' appears on Commercial Inv |
Image | ||||||
Field | Description | Data Type | Value Limits | Requirement | Use on standard documents | Field returned in service ID/table/field (multi services split by ";") |
ImageData | Placeholder. | byte[] | ||||
DefaultImage | Placeholder. | Boolean | true, false |