Configuration
Field | Description | Required | Best Practice |
PartArray | An array of Parts and their pricing and configuration data | TRUE | |
LocationArray | An array of Locations and their pricing and configuration data | FALSE | Required for hard goods. |
productId | The product family. This is how the part is marketed. | TRUE | |
currency | The currency the request of the request in ISO 4217 format | TRUE | |
FobArray | An array of FOB points that support this configuration | TRUE | |
fobPostalCode | The postal code of the FOB point | FALSE | |
priceType | The type of price requested. Values are enumerated: {List, Net, Customer}. | TRUE |
Part
Field | Description | Required | Best Practice |
partId | The partId | TRUE | |
partDescription | A description of the partId | FALSE | Should describe part and not contain any product description. |
PartPriceArray | An array of prices and quantities | FALSE | |
partGroup | A numeric identifier grouping mutually exclusive parts together. When configuring data, always start with part group “1” | TRUE | |
nextPartGroup | The next mutually exclusive partGroup to complete configuration of the product | FALSE | |
partGroupRequired | A boolean value specifying if this partGroup is required for the product configuration. If set to TRUE, a selection in the partGroup is required for ordering. | TRUE | |
partGroupDescription | A description of the partGroup. Examples: “Main Product”, “Optional Lid”, “Straw”, etc. | TRUE | Yes. Helps even if there is only one part group. |
ratio | Describes how the amount of partIds that need to be added to the order based on the number of products ordered. Example: If 8 partIds would be required per 1 product ordered, then 8 should be used as the ratio. If one partId is required for every 8 products, than use .125 | TRUE | |
defaultPart | This part is included in the “Basic Pricing Configuration” service price. This field is optional, but highly encouraged. | FALSE | |
LocationIdArray | An array of LocationIDs that are available for decoration because the select part has been configured. | FALSE |
Part Price
Field | Description | Required | Best Practice |
minQuantity | The minimum quantity for the price break. | TRUE | |
price | The base price of the good without decoration | TRUE | |
discountCode | The industry discount code associated with the price. | FALSE | |
priceUom | Enumerated list of unit of measure used to describe the price. Values are: {BX, CA, DZ, EA, KT, PR, PK, RL, ST, SL, TH} BX - Box CA - Case DZ - Dozen EA - Each KT - Kit PR - Pair PK - Package RL - Roll ST - Set SL - Sleeve TH - Thousand | TRUE | |
priceEffectiveDate | The date the price is effective in ISO8601 format. | TRUE | |
priceExpiryDate | The date the price is no longer effective in ISO8601 format. | TRUE |
Location
Field | Description | Required | Best Practice |
locationId | The Id of the location | TRUE | |
locationName | The name of the location | TRUE | |
DecorationArray | An array of decorations that are valid for the given location | TRUE | |
decorationsIncluded | The number of decorations included in the price | TRUE | |
defaultLocation | Signifies default location for the product. | TRUE | Yes. |
maxDecoration | The maximum amount of decorations for this location | TRUE | |
minDecoration | The minimum amount of decorations for this location | TRUE | |
locationRank | Popularity of location based on supplier experience | FALSE |
Decoration
Field | Description | Required | Best Practice |
decorationId | The ID of the decoration | TRUE | |
decorationName | The name of the decoration | FALSE | |
decorationGeometry | The geometry of the decoration. Values are enumerated: {Circle, Rectangle, Other}. | TRUE | |
decorationHeight | The maximum imprint height of the decoration; leave blank if the imprint is not rectangular | FALSE | |
decorationWidth | The maximum imprint width of the decoration; leave blank if the imprint is not rectangular | FALSE | |
decorationDiameter | The maximum imprint diameter of the decoration; leave blank if the imprint is not circular | FALSE | |
decorationUom | The unit of measure for the decoration area in ISO 20022 https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/codesets/_Y4XF0tp-Ed-ak6NoX_4Aeg_385163498 | TRUE | |
allowSubForDefaultLocation | Buyer is allowed to substitute a decoration location without changing the price | TRUE | |
allowSubForDefaultMethod | Buyer is allowed to substitute this decoration method without changing the price | TRUE | |
itemPartQuantityLTM | Specifies the Part Quantity that is the absolute minimum that can be ordered with a Less Than Minimum (LTM) charge. | FALSE | |
ChargeArray | An array of setup charge data | FALSE | |
decorationUnitsIncluded | The number of included decoration units. For example, if 1 color decoration is included set value to “1”. If 7,500 stiches are included set value to “7500” | FALSE | |
decorationUnitsIncludedUom | Values are enumerated: {Colors, Inches, Other, Stitches, SquareInches }. | FALSE | |
decorationUnitsMax | This is the max number of decoration units for this decoration/location combination. | FALSE | |
defaultDecoration | Specifies whether this is the default decoration for this location | TRUE | Yes. Helps to display a default price to customers. |
leadTime | The leadtime for the given decoration | FALSE | |
rushLeadTime | The lead time for rush service for a given decoration (rush charges may apply) | FALSE |
Charge
Field | Description | Required | Best Practice |
chargeId | The Id of the charge | TRUE | |
chargeName | The name of the charge | TRUE | |
chargeType | The type of charge. Values are enumerated {Order, Run, Setup}. | TRUE | |
chargeDescription | The charge description | TRUE | |
ChargePriceArray | An array of charge prices | TRUE | |
chargeAppliesLTM | This charge is applied with ordering Less than Minimum (LTM). | TRUE | |
chargesPerLocation | The number of times a charge will occur per location | FALSE | |
chargesPerColor | The number of times a charge will occur per color | FALSE |
Charge Price
Field | Description | Required | Best Practice |
chargeId | The Id of the charge | TRUE | |
chargeName | The name of the charge | TRUE | |
chargeType | The type of charge. Values are enumerated {Order, Run, Setup}. | TRUE | |
chargeDescription | The charge description | TRUE | |
ChargePriceArray | An array of charge prices | TRUE | |
chargeAppliesLTM | This charge is applied with ordering Less than Minimum (LTM). | TRUE | |
chargesPerLocation | The number of times a charge will occur per location | FALSE | |
chargesPerColor | The number of times a charge will occur per color | FALSE |
...