Developer Reference - Amrod Data Feed v2

Document 18 Sep 2019

Date

Author Llewellyn Breedt

Status DRAFT

Feed Status IN REVIEW

Overview
Amrod provides its client access to their catalogue through an XML data feed. This data feed consists of one or more data tables that interlink to represent
the Amrod Catalogue Hierarchy. The feed will always represent the latest data as per the Website. It is the responsibility of the client to ensure they update
their data regularly.
The feed is supplied as is, and any manipulation of the data to conform to the consumer’s data structure is the responsibility of the consumer.

Terminology
Term Description

Simple The Product SKU excluding the Colour or Size Variant. This is the code as printed in the Amrod/Altitude Catalogues and as it appears on the
Code Web sites

ItemCo The Product Full SKU. This includes the colour and size variant codes.
de

Set A product consisting of multiple items, where the stock of the items is determined by the product within the set with the least amount of stock.

Compo A product consisting of multiple items, where some or all product within the set can be changed to either a different product of a different colour
nentSet variant.

Compo A product that forms part of a componentSet. These items can usually not be purchased on their own and serves no purpose without the main
nent item. Example a Lid of a water bottle.

Flags A Value represented as a single Int32 / Int64 value. The value is derived by combining multiple values to depict a single state. Example: New
and On Special can be applied to a single product where New has a value of 1 and On Special value of 2. The combined value of the Flag is
then 3 (New | On Special).

Compa Represents a 3 digit code for the Amrod Company or Region. Every Branch of Amrod that falls outside of South Africa a separate legal entity
nyCode and thus has it's own pricing structures. Example: Kenya is Represented as KNY, Botswana as BOT ...

Numbe Represents the number of Printing Colours that can/will be used for Printing. The Number of Print colours is tied to the Price of Branding.
rOfCol Certain branding methods do not use ink or use a full-colour print, these branding methods will use a -1 or -2 to indicate this.
ours
BrandingPrintColours
public enum FeedOptions
{
//
// Summary:
// Digital Printing with no Colour Restrictions
FullColour = -1,
//
// Summary:
// Non Ink based Printing, Laser Engraving, Debossing ...
NotApplicable= -2,
}

Downloading the Amrod Data Feed

Catalogue URL Status Review URL
Amrod South Africa https://www.amrod.co.za/feed/v2 ACTIVE

Altitude https://www.altitude.co.za/feed/v2 ACTIVE

Amrod Kenya https://www.amrod.co.ke/feed/v2 ACTIVE

Amrod Zambia https://www.amrod.co.zm/feed/v2 ACTIVE

Amrod Botswana https://www.amrod.co.bw/feed/v2 ACTIVE

Amrod Nigeria https://www.amrod.ng/feed/v2 ACTIVE

Input Parameters
Parameter Type Optional Possible Values Description

FeedOptions long: Yes FeedOptions Instructs the Feed processor to what data is
Flag being requested.
[Flags]
public enum FeedOptions The value is constructed by combining the
{ represented enum values with a bitwise "or"
// operation.
// Summary:
// Include all Product See this article on stackoverflow for a
information detailed explanation.
Products = 1,
// The default value if not supplied is:
// Summary: Products | Categories | Branding
// Include the Catalogue
Hierarchy
Categories = 2,
//
// Summary:
// Include Product
Branding Positional Data
Branding = 4,
//
// Summary:
// Include Product Image
Catalogue, Should be run on it's own due to the
size
Images = 8,
//
// Summary:
// Include the Leadtime
Matrix. This is a table for calculating the
production leadtime for branding any product
with any branding process
LeadTime = 128,
//
// Summary:
// Include the supplied
box information. Current only case level
information is supplied
PackingDetails = 256,
//
// Summary:
// Include additional
product attributes (Page numbers, High Value,
Dangerous goods ...)
ProductAdditionalAttributes = 512
}

Markup deci Yes decimal values between 1.00 - 10.00 The Markup param is used to specify an
mal additional Markup percentage to be added
to the price.
The Value of the Markup param is
expressed as a floating-point value, where 1
= 0% and 2 = 100%.
CR string Yes Valid account numbers Amrod account number.

String of maximum 20 characters The account number is used to determine

the ALP Tier.

By supplying the Amrod account number,

the feed processor will return pricing
corresponding to the ALP tier the account is
linked to.

By omitting the Amrod account number, the

feed processor will return pricing for the ALP
Jade tier.

Response
Status Code 200

content-type text/xml

content-disposition attachment;filename="AmrodFeed.xml"

Catalogue Feed Entity Diagram

Data Reference

Product
Column Datatype Description Optional

ItemCo string Product SKU No

de

Name string Product Short Name No

Descript string Product Full description. This field can contain Rich Text and HTML tags. No
ion

Prices float The Price of the product Excl. The price is determined by the Region and the CR Code that is supplied. By omitting the No
CR code the Price will be in Jade or Quartz for Over the Border

Flags long Specifies a Flagged value identifying numerous behaviours and characteristics of the Product. Possible Values: No

ProductFlags
public enum ProductFlags
{
/// <summary>
/// This indicates that there are no additional flags associated with a product.
/// </summary>
NONE = 0,
/// <summary>
/// This indicates that this product is a branding process and is used to get Jade
/Quartz pricing for Branding.
/// </summary>
NONE = 1,
}

Simple string Product base SKU. No colour or Variant. No

Code

ProductId guid A unique product Id used for uniquely identifying a product in the system. The Unique Id is unique for every SimpleCode No
in the system and for all its variant. When a product is decoupled from the Master Product (this can happen for various
reasons, most common would be when a product variant is being discontinued and offer at a reduced price, compared
to its other variants). When the product is decoupled from the master it receives a new Unique Id. This is very important
to note as an ItemCode BAG-612-R might have a Unique Id of "AA-BB-CC" today but tomorrow it can have a Unique Id
of "AA-BC-DD". It is highly recommended to not rely on this Unique Id to uniquely identify a product in the system but
only to use for linking withing the Product Hierarchy.

Size string This is the Segment code that specifies the size of the Product. Amrod uses familiar (S, M, L) size codes, and also Kids Yes
ages (8,10,12) for the kids ranges. Other size codes include length for Belts

Colour string This is the Segment code that specifies the colour of the Product. The colour lookup with descriptions is available on Yes
the Supplied Price-list on the Website as well as in the printed and digital versions of the catalogue.
Promoti numeric This is a status field that specifies the Promotional status of a product. Possible Values: No
on
ProductPromotionEnum
public enum ProductPromotionEnum
{
/// <summary>
/// This indicates that there are no promotional codes associated with a product.
/// </summary>
NONE = 0,

/// <summary>
/// This indicates that a product is on special.
/// </summary>
ON_SPECIAL = 1,

/// <summary>
/// This indicates that a product is new.
/// </summary>
NEW = 2,

/// <summary>
/// This indicates that a product is reduced to clear.
/// </summary>
REDUCED_TO_CLEAR = 3,

DISCONTINUED = 4
}

Gender string This specifies the Gender of the Product. Male, Female, Unisex or Kid Yes

Gender string This specifies the corresponding ItemCode. Example: SLAZ-816-BL-S will be Gender listed "Male" and GenderMatch Yes
Match will be listed "SLAZ-817-BL-S" as the Female corresponding product

IsSet bool Is this product a Set that consists of multiple products. See SetInfo and SetContents for more information and the list of No
products that make up this set.

IsComp bool Is this product a ComponentSet that consists of multiple products and components. See SetInfo and SetComponents No
onent for more information and the list of products that make up this component set.

Behavior numeric Depicts the behaviour of the product. This is mostly used for internal use "Display on the home page" .., but can be No
used to mimic behaviour from the Armod website. Possible values:

ProductBehavior
public enum ProductBehaviorEnum
{
/// <summary>
/// This indicates that the product should behave normally.
/// </summary>
NONE = 0,

/// <summary>
/// This indicates that the product is a featured product. Featured products
could appear on the home page.
/// </summary>
SHOW_ON_HOME_PAGE = 1,

/// <summary>
/// This indicates that the product should not be displayed anyhwere in the
store, only in the backoffice.
/// </summary>
DO_NOT_DISPLAY = 2
}

InStock bool Indicates whether the product has the stock or not, when the item has stock it will be true else false instead of showing No
the actual stock figure.

Category
 Column Datatype Description Optional

Name string The name of the Category No

ParentCategory guid The Unique Id of the parent category for this category. Used to build the Category hierarchy. Yes
Id

CategoryId guid The Unique Id of the category. No

Path string The complete path (breadcrumb) to the category. Example: Corporate gifts\Bags\Laptop Bags. The path is No
separated by a "\"

ProductCategory
This represents the Catalogue Hierarchy. All Categories and their linked products. The Product SimpleCode is used to link back to Product on a unique
basis, The ProductId is used to link to a specific Variant when disconnected from the master.

Column Datatype Description Optional

SimpleCode string The product Simple code for easy lookup. No

CategoryId guid The Unique Id of the Category this product is linked to. No

ProductId guid The Unique Id of the Product that indicates that this product is linked to the CategoryId. No

It is important to note that a Product can be linked-to Multiple Categories, but will always be linked to at least one.

SetInfo
Identifies any products that consist of multiple products of parts(components). There are 2 types of Sets:

1. Giftsets
A gift set is a product that consists of a fixed set of products. The products are not configurable and is linked to the master code. Example: Looking
at a Giftset in a specific Colour/Size variant, all the products within that set would be fixed variants linked to the master product. A Green giftset
would consist of Green child products (most of the time), and a 6GB version of the Giftset would consist of a 6GB Memory stick product.
Reference Product: GIFTSET-7465, GIFTSET-1710
2. Component (Mix n Match)
A Component is a product that consists of fixed and configurable parts. A Component Mug can be configured with a different colour lid and sleeve.
this creates a vast variety of configurable combinations. Reference Product: KOOSH-8300, KOOSH-9000

It is very important to build the configuring Flagged values into your site. The Flagged values give a lot of rules and configuration details on how the product
functions.

Column Datatype Description Optional

Simple string The SimpleCode identifying this Set or ComponentSet. No

Code

ItemCo string The Full Product SKU of the Set/ComponentSet including all possible variant codes. No
de

Descript string A description/short name of the Set or ComponentSet code. No

ion
 Flags long Specifies a Flagged value identifying numerous behaviours and characteristics of the Set / ComponentSet. Possible No
Values:

StockSetFlags
public enum StockSetFlags
{
//
// Summary:
// Add the Set Code to the invoice on Accounting Package
InvoiceSetCode = 1,
//
// Summary:
// Set Code is Added to Accounting Package at 100% discount with this
Identification
// code
ApplySetCodeDiscount = 2,
//
// Summary:
// The Set's price is calculated from Parts/contents
SetPriceCalculatedFromParts = 4,
//
// Summary:
// The set is made up of Coloured Parts based on Size Code identifying the
Part, ComponentSet
MixedParts = 8,
//
// Summary:
// Available stock is dependent on the lowest stock level of parts
SetStockLevelPartDependent = 16,
//
// Summary:
// This set is not currently available.
Disabled = 32,
//
// Summary:
// This set is a virtual item. The actual set code does not exists and
only the parts
// are invoiced
VirtualItem = 64,
//
// Summary:
// Include the Stock Level of the Set Code when Calculating stock
IncludeSetItemStockInCalculation = 128,
//
// Summary:
// Do not display as a group. List individual Itemcodes (internal use)
DoNotGroup = 256,
//
// Summary:
// Is not picked by warehouse (internal Use)
NonWarehouseAble = 512,
//
// Summary:
// No need to consolidate. This item is consolidated during production and
does not add additional time to the production lead time
NoConsolidationNeeded = 1024,
//
// Summary:
// The set is build from mixed components with various options.
ComponentSet
MixedComponents = 2048,
//
// Summary:
// The set is manufactured and can not be disassembled and returned to
stock. Indicates no RTS possible
NoDisassembly = 4096
}

SetContent
Set contents is for giftset products and identifies the child products and their configurations within a gift set.

Column Datatype Description Optional

 SetItemC string The Full Product SKU of the Set/ComponentSet including all possible variant codes. This is the link back to SetInfo No
ode

SimpleC string The SimpleCode of the Product part in the set No

ode

Colour string The Colour variant segment of the Product part in the set Yes

Size string The Size variant segment of the Product part in the set Yes

Sequence numeric The display sequence of the Product part in the set No

Multiplier numeric A value indicating the number of units to add for every 1 set sold. Example: GIFTSET-7250, consists of a presentation No
box and two of DW-7008

Flags long Specifies a Flagged value identifying numerous behaviours and characteristics of the Set Part. Possible Values: No

SetContentFlags
public enum StockSetContentFlags
{
//
// Summary:
// Not visible on customer invoice
HidenOnInvoice = 1,
//
// Summary:
// Invoice out at R 0.00
ZeroPrice = 2,
//
// Summary:
// Item Auto adds to invoice at specified sequence, is not required to be
specified
AutoAddition = 4,
//
// Summary:
// Does not affect stock level for Set Item
DoesNotRequireStock = 8,
//
// Summary:
// Should be excluded from JobCard Stock
NotBrandable = 16,
//
// Summary:
// Discontinued item should use non discontinued item's Price (highest
price for
// colours)
UseNearestCousin = 32,
//
// Summary:
// Hides this Component on Stock Check And Quotes to Clients (Internal Use)
HideOnQuotes = 64,
//
// Summary:
// Does not create a warehouse pick instruction when ordering (Internal
Use)
NonWarehouseAble = 128,
//
// Summary:
// The set is manufactured and can not be disassembled and returned to
stock. Indicates no RTS possible
NoDisassembly = 256,
//
// Summary:
// Hides this Component on The Website
HideOnWebsite = 512
}

SetComponent
Set components is for Component sets and identifies the fixed and configurable components within the Component Set.
The Prefix groups the configurable items together. Example: All Lids will usually be grouped under the Prefix "LID" and same for "SLEEVE". Some
components are only configurable on a colour variant level, thus the colour of the Lid can be changed, but there is only one type of Lid that can be selected
from. Other components are configurable on the SimpleCode level, thus a different product may be Configured within the set. This is true for the Cheese set
in the below example (AC-2135), where the Cheeseboard can be selected from a selection of 4 different products.

AC-2135

It is important to note, that some components can not be purchased on their own, these are items like a REFILL, a clip for a pen and so on.

Some Components are manufactured on-premises and there is no physical stock of the item. These components are flagged with "NoDissasebly".

Column Datatype Description Optional

SetItemCode string The Full Product SKU of the Set/ComponentSet including all possible variant codes. This is the link back to No
SetInfo

SimpleCode string The SimpleCode of the Product part in the set No

Prefix string A value grouping multiple options together. Example: AC-2135 has 4 options for the cheese board (AC-2180, No
AC-2185, AC-2190 or AC-2195)

Description string A description of the part choice. No

Sequence numeric The display sequence of the component within the set No

AutoAdditionIte string This is a fixed item and there is no configuration possible. this item will always join the set. This is the Full SKU Yes
mCode of the item.
 Flags long Specifies a Flagged value identifying numerous behaviours and characteristics of the Set Part. Possible Values: No

SetComponentFlags
public enum StockSetComponentFlags
{
//
// Summary:
// Not visible on customer invoice
HidenOnInvoice = 1,
//
// Summary:
// Invoice out at R 0.00
ZeroPrice = 2,
//
// Summary:
// Item Auto adds to invoice at specified sequence, is not required
to be specified
AutoAddition = 4,
//
// Summary:
// Does not affect stock level for Set Item
DoesNotRequireStock = 8,
//
// Summary:
// Should be excluded from JobCard Stock
NotBrandable = 16,
//
// Summary:
// Discontinued item should use non discontinued item's Price
(highest price for
// colours)
UseNearestCousin = 32,
//
// Summary:
// Hides this Component on Stock Check And Quotes to Clients
HideOnQuotes = 64,
//
// Summary:
// Does not create a warehouse pick instruction when ordering
(Internal Use)
NonWarehouseAble = 128,
//
// Summary:
// The set is manufactured and can not be disassembled and returned
to stock. Indicates no RTS possible
NoDisassembly = 256,
//
// Summary:
// Hides this Component on The Website
HideOnWebsite = 512
}

ProductImage
This is the catalogue of product images. Amrod's systems pre-size the images in set sizes optimized for its website and client portals. These sizes are
documented below and it is advised to try and use one of the sizes already created rather than loading the High-res images.

To match a product to an Image the SimpleCode is used from the Product Table to the ProductImage table. To match to a colour variant, the colour
segment is amended to the SimpleCode with a joining "-" character and then matched on SimpleCode and ImageName. Thus querying the images with a
SimpleCode of "BAG-612" will return all images in all sizes that are associated with BAG-612. This would include additional images and model shots. To get
the Green variant image one would query the images with SimpleCode "BAG-612" and ImageName "BAG-612-G".

Column Datatype Description Optional

Simple string The SimpleCode associated with this Image No

Code

ImageN string The Image name is used to associate Images to Product Variants, on Colour segment level. Example: Image with name No
ame BAG-612-BL is for Product BAG-612 in Colour variant BL.

The image name is also used for additional images (_model, side1, side2, ...)
 IsDefaul bool Specifies if this image is the Default display Image used when displaying the product, also known as the Hero image No
tImage

ImageW numeric Specifies the Width segment dimension of the Image. This is in Pixels. Amrod pre-sizes all images to specific sizes No
idth used on the Website in various areas. The standard sizes available are (270 x 150, 260 x 250, 46 x 45, 460 x 350, 151
x 141).

The High-Res images are identified by a -1 ImageWidth and ImageHeight

ImageH numeric Specifies the Height segment dimension of the Image. This is in Pixels. Amrod pre-sizes all images to specific sizes No
eight used on the Website in various areas. The standard sizes available are (270 x 150, 260 x 250, 46 x 45, 460 x 350, 151
x 141).

The High-Res images are identified by a -1 ImageWidth and ImageHeight

ImageU string The download URL of the Image on the Amrod CDN No
rl

PackingDetail
This provides the supplier box dimensions and packing quantities per box. The data is supplied at a Variant level as Colour and Size variants are not all
packed identically.

Column Datatype Description Optional

SimpleC string The SimplateCode associated with this Packing Entry No

ode

ItemCode string The Full ItemCode SKU associated with this Packing Entry. As Products are sold in different Size/Colour variants, No
these might not be packed identically per variant.

dim_Wid float The width of the Supplier Case No

th

dim_Hei float The height of the Supplier Case No

ght

dim_Len float The Length/Breath of the Supplier Case No

gth

Weight float The Weight of the Supplier Case (Including the box material) No

UnitDims string The Unit of measure, represented as a string, of the Dimensions of the Supplier Case(Currently in Centimeters "CM") No

UnitWei string The Unit of measure, represented as a string, of the Weight of the supplier boxes (Currently in Kilograms "KG") No
ght

Quantity numeric The number of units packed inside a Supplier Case. No

LeadTime
LeadTime provides the configuration of the Amrod Branding Leadtime Matrix. It provides the rules and calculations used to provide a LeadTime on all
Production Jobs. It is possible that by following the configured rules, you will receive a LeadTime of "-1". This is not a fault and indicates a Order that is not
within the normal parameters and a request should be made to your client's Account Manager.

The LeadTime matrix runs on a Hierarchical Rule structure where rules are checked in sequence and then subrule matching occurs. Example: The matrix
will first look for a rule for the Branding Department (Screen Print, Laser, Digital ...), if a match is found it will then look for a matching sub-rule, and so on
until a LeadTime is found. As mentioned, the rules are checked in sequence and the first match is the rule that will produce the LeadTime. Example: A rule
for Gifts and Giftset products can be configured, and because all Giftsets are classified as Gifts the rule with the Higher Priority sequence will be applied.

Types of Rule Criteria:

1. Print Department
Every match starts by matching to the print department the product will be branded in
a. Inventory Type
Matched on what type of product is being branded, Gifts are easier to brand than clothing as clothing might have to be refolded, ironed and
packed into original packaging after branding.
b. Branding Code
Matched on the specific or partial match of the Branding Code. Screenprint in SA, SB, SC may all attract a different LeadTime
c. ItemCode Prefix
Matched on the Prefix of the ItemCode. Example BAG, SLAZ, PEN
d. A list of Products
Matched on a list of products. This is used for items that require a very specific LeadTime configuration
 A Visual representation of the Rule Hierarchy

Column Datatype Description Optional

PrintDepa string The name of the Print Department this Leadtime rule applies to No
rtment

Departme long No
ntFlags

GroupNa string A name for the Group, to visually group Leadtime rules together No
me

GroupPrio numeric The Priority sequence the rule is validated. A Group with a 0 will be validated and if the Print criteria is matched will No
rity then halt the matching of the next Group.

GroupFilt string Specifies that this Group will only match on Products that start with this particular Prefix. Example: A Prefix of "BAG" Yes
erPrefix will only match bags in the Amrod Catalogue.

GroupFilt numeric Specifies that this Group will only match on certain Inventory Types. Possible values are: Yes
erInventor
yType InventoryType
public enum InventoryType
{
//
// Summary:
// An Amrod Gifting Product. These are printed in the Gifting Catalogue
and Gifting Pricelist
Gift = 1,
//
// Summary:
// An Amrod Clothing Product. These are printed in the Clothing Catalogue
and Clothing Pricelist
Clothing = 2,
//
// Summary:
// An Amrod Branding SKU. These are used to identify Branding on Order
and associated Setup Charges
Branding = 3,
//
// Summary:
// An Amrod Headwear Product. These are printed in the Clothing Catalogue
and Pricelist
Headwear = 4,
//
// Summary:
// An non-categorized Item.
Unknown = 99
}

GroupFilt string Specifies that this Group will only match on Products that is being branded with this Print Code. This Filter supports Yes
erPrintCo partial lookups. Example: "SA" will match on SA-1-A, SA-1-B ...
de
 GroupFla long Specifies the Type of Filter rule that applies on this Group. Possible values are: No
gs
ldmGroupFilterFlags
[Flags]
public enum ldmGroupFilterFlags
{
//
// Summary:
// No Rule
None = 0,
//
// Summary:
// The rule applies on the Prefix of the Product SKU: Example BAG in BAG-
612
FilterProductPrefix = 1,
//
// Summary:
// The rule applies on the inventory type of the Product
FilterInventoryType = 2,
//
// Summary:
// The rule applies to a list of Products, see fields
"GrolupItemSimpleCode", "GroupItemColour", "GroupItemSize"
FilterProductList = 4,
//
// Summary:
// The rule applies only to a subset of branding codes. Example: Screen
Print consists of multiple Print Codes, LA, LB, LC ..., this rule makes it possible
to adjust leadtime on these sub print codes within a Branding Department
FilterPrintCode = 8
}

GroupIte string Specifies the Item's Simple code that will be matched on Yes
mSimple
Code

GroupIte string Specifies the Item's Colour segment that will be matched on Yes
mColour

GroupIte string Specifies the Item's Size segment that will be matched on Yes
mSize

GroupMin numeric Specifies the bottom range of the Print Quantity that this group will match on. Note: Branding with a Screen Print 2 No
PrintQuan colour, 7 units will be yield a Print Quantity of 14
tity

GroupMa numeric Specifies the top range of the Print Quantity that this group will match on No
xPrintQua
ntity

GroupLea numeric Specifies the Leadtime for this Group. Example: BAG-612 will match on Group with a Prefix filter of "BAG" with a Print No
dtime Quantity of 20 Units equals 2 Days (Branding Leadtime)

GroupLea numeric Specifies a temporary adjustment to All Leadtimes in this Group. Leadtime will then be = GroupLeadtime + Yes
dtimeAdju GroupLeadtimeAdjustment
stment

GroupLea numeric Specifies a temporary override to All Leadtimes in the Group. Leadtime will then be = GroupLeadtimeOverride Yes
dtimeOve
rride

InclusiveBranding
Amrod offers most products with an inclusive branding position. This usually is the preferred and most popular branding method of the product.

The below table describes the rules needed to apply these inclusive branding to your clients.

Column Datatype Description Optional

SpecialNa string A display name to uniquely identify the Special No

me

SpecialFlags long No
BrandingPo int The Type of position this special applies to. A Position type can be seen as a rule to specify that only 1 position is No
sitionType inclusive or the only the first position is inclusive but any additional positions are offered at a discounted price. The
possible values for position types are:

ProductSpecialBrandigPositionType
public enum ProductSpecialBrandigPositionType
{
//
// Summary:
// Any Position following the first initial inclusive branding position
AndThereafter = -1,
//
// Summary:
// Any single one Position
AnyOnePosition = -2,
//
// Summary:
// All Positions, no limit of the number of positions applicable to
AnyPosition = -3,
//
// Summary:
// The first Position Only. Being it A, B or C ...
AnyPosition = 1,
//
// Summary:
// The second Position Only.
AnyPosition = 2,
//
// Summary:
// The third Position Only.
AnyPosition = 3,
//
// Summary:
// The fourth Position Only.
AnyPosition = 4,
//
// Summary:
// The fith Position Only.
AnyPosition = 5,
//
// Summary:
// The six Position Only.
AnyPosition = 6
}

BrandingM string The branding method that this special applies to No

ethod

BrandingRe string The replacement code that will be invoiced when this special applies. SA-1-A will normally be replaced by SA-FREE Yes
placementC when an inclusive branding special is applied
ode

NumberOfC numeric The number of Branding colours that this special is applicable for. Most specials are only applicable to 1 colour No
olours branding

MinQuantity numeric The minimum number of products required to make this special applicable Yes
 BrandingFl long Specifies addition detail on the behaviour of a branding special: Possible Values are No
ags
ProductSpecialBrandingDetailFlags
[Flags]
public enum ProductSpecialBrandigDetailFlags
{
//
// Summary:
// No Addition info
None = 0,
//
// Summary:
// The price will always be 0 for this branding special, even if the
price field has a value
ZeroPricing = 1,
//
// Summary:
// The price will be calculated from the configured Tier price per
Amrod's Accounting system. This value is provided as "BrandingPrice" field
UsePastelPricing = 2
}

ValidFrom date The date from which this special is valid from No

ValidTo date The date to which this special is valid. Any specials that have passed the ValidTo date will no longer be included in No
the Feed and should be removed

BrandingCo string The code of the branding method that can be used with this branding special Yes
de

SimpleCode string The product SimpleCode that for which this special applies to. No

Colour string The product segment colour for which this special applies to. Most specials apply to All colour variants, but with the Yes
exception, there will be that are only applicable to select colour variants.

InclusiveBrandingPricing
Inclusing Branding Prices. As all prices are not zero, some are only a discounted rate. Use this table to correctly find the discounted price

Column Datatype Description Optional

BrandingReplace string The Branding Code for which this price is for. This is the link between InclusiveBranding and No
mentCode InclusiveBrandingPricing Tables

BrandingPrice float The price of the Special. Note most specials are discount 100% excluding setup. It is important to check that No
the replacement code pricing is applied when quoting your clients

BrandingPriceDis string The Pricing tier this price is applicable for: Example: Bronze, Gold, Diamond ... No
playName

ProductAttribute
Column Datatype Description Optional

SimpleCode string The product SimpleCode this attribute/value is applicable for No

ItemCode string The product full SKU this attribute/value is applicable for No

Section string A grouping name to group similar attributes together. Example: Warehouse, Invoicing ... No

Name string The unique name for the attribute. An Attribute uniqueness is determined by a combined key of Section No
and Name

Datatype string The data type of value in the Value field. Supported types are: VARCHAR, BOOL, OPTION, FLOAT, TEXT No

Value string (See The value of the Attribute represented as a string. See Datatype for casting Yes
Datatype)

BrandingPosition
Column Datatype Description Option

SimpleCo string The product SimpleCode this branding position info is applicable for No
de

PositionC string The branding position code. This is a 1 character code that corresponds to the branding guide. It uniquely identifies a No
ode branding position to a product area

PositionN string The branding position display name. This is a name describing the branding area. Example: On the front of the bag No
ame

PositionC string A comment that details some additional information about this branding area. Yes
omment

PositionFl long Reserved for future use. No

ags

PositionM numeric A position multiplier is used when a branding area is duplicated on either side of the product or on multiple panels on an Yes
uiltiplier umbrella. Example: A branding position on a Pen is usually configured to a multiplier of 2. This indicates that one can
brand on either side of the Pen.

Compone string Specifies the product within a GiftSet item that this position is for. Position A on USB, Position B on Notebook ... Yes
ntItemCo
de

DisplayIn numeric Indicates the preferred branding methods by ascending order. No

dex

Branding guid The branding method unique GUID identifier No

Guid

Branding string The name of the branding method that can be used on this branding area No
Method

Branding string The code of the branding method that can be used on this branding area No
Code

NumberO numeric The number of colours that can be used with the specified branding method on this branding area. Some branding No
fColours methods does not have colour options or support full-colour branding.

PrintArea float The Max branding width that can be used. A value of -1 indicates that this information is not currently available No
Width

PrintArea float The Max branding height that can be used. A value of -1 indicates that this information is not currently available No
Height

PrintMeth string Additional information regarding the branding method on this branding area Yes
odComm
ents

IsLogo24 bool Specifies that this entry is for a Logo24 position. NOTE: a Product can have two Branding Positions with the Code A, No
Position One for normal branding where the IsLogo24Position will be false and one where it will be true.

MinBrand numeric Specifies the minimum number of units that must be ordered to allow for Logo24 on this product Yes
ingQuanti
ty

MaxBran numeric Specifies the maximum number of units that can be ordered to allow for Logo24 on this product Yes
dingQuan
tity

BrandingPrice

Column Datatype Description Optional

BrandinGuid guid The branding method unique GUID identified No

BrandingMethod string The name of the branding method the price is applicable for No

BrandingCode string The code of the branding method the price is applicable for No

PrintCode string The Full SKU Print Code that will be used for invoicing, before any inclusive branding rules have been applied No

SetupCode string The full SKU Setup Code that will be used for invoicing, before any inclusive branding rules have been applied No

MinQuantity numeric The Min unit quantity range this price is applicable for No
MaxQuantity numeric The Max unit quantity range this price is applicable for No

NumberOfColours numeric The number of Print Colours this price is applicable for No

Price float The Branding price for the combination No

SetupCharge float The Setup Charge for the combination No