...
Configuration
Field | Description | WSDL Data Type | SQL Data Type | Required | Best Practice |
PartArray | An array of Parts and their pricing and configuration data | ARRAY | ARRAY | TRUE | |
LocationArray | An array of Locations and their pricing and configuration data | ARRAY | ARRAY | FALSE | Required for hard goods. |
productId | The product family. This is how the part is marketed. | STRING | VARCHAR(64) | TRUE | |
currency | The currency the request of the request in ISO 4217 formatSTRING | VARCHAR(64) | TRUE | ||
FobArray | An array of FOB points that support this configuration | ARRAY | ARRAY | TRUE | |
fobPostalCode | The postal code of the FOB pointSTRING | VARCHAR(64) | FALSE | ||
priceType | The type of price requested. Values are enumerated: {List, Net, Customer}. | STRING | VARCHAR(64) | TRUE |
Part
Field | Description | WSDL Data Type | SQL Data Type | Required | Best Practice |
partId | The partId | STRING | VARCHAR(64) | TRUE | |
partDescription | A description of the partId | STRING | VARCHAR(128) | FALSE | Should describe part and not contain any product description. |
PartPriceArray | An array of prices and quantities | ARRAY | ARRAY | FALSE | |
partGroup | A numeric identifier grouping mutually exclusive parts together. When configuring data, always start with part group “1” | NUMBER | INT | TRUE | |
nextPartGroup | The next mutually exclusive partGroup to complete configuration of the product | NUMBER | INT | 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. | BOOLEAN | BOOLEAN | TRUE | |
partGroupDescription | A description of the partGroup. Examples: “Main Product”, “Optional Lid”, “Straw”, etc. | STRING | VARCHAR(64) | 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 .125DOUBLE | DECIMAL (12,4) | TRUE | ||
defaultPart | This part is included in the “Basic Pricing Configuration” service price. This field is optional, but highly encouraged. | BOOLEAN | BOOLEAN | FALSE | |
LocationIdArray | An array of LocationIDs that are available for decoration because the select part has been configured. | ARRAY | ARRAY | FALSE |
Part Price
Field | Description | WSDL Data Type | SQL Data Type | Required | Best Practice |
minQuantity | The minimum quantity for the price break. | INT | INT | TRUE | |
price | The base price of the good without decoration | DOUBLE | DECIMAL (12,4) | TRUE | |
discountCode | The industry discount code associated with the price. | STRING | VARCHAR(1) | 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 | STRING | VARCHAR(2) | TRUE | |
priceEffectiveDate | The date the price is effective in ISO8601 format. | DATE | DATE | TRUE | |
priceExpiryDate | The date the price is no longer effective in ISO8601 format.DATE | DATE | TRUE |
Location
Field | Description | WSDL Data Type | SQL Data Type | Required | Best Practice |
locationId | The Id of the location | INT | INT | TRUE | |
locationName | The name of the location | STRING | VARCHAR(64) | TRUE | |
DecorationArray | An array of decorations that are valid for the given location | ARRAY | ARRAY | TRUE | |
decorationsIncluded | The number of decorations included in the price | INT | INT | TRUE | |
defaultLocation | Signifies default location for the product. | BOOLEAN | BOOLEAN | TRUE | Yes. |
maxDecoration | The maximum amount of decorations for this location | INT | INT | TRUE | |
minDecoration | The minimum amount of decorations for this location | INT | INT | TRUE | |
locationRank | Popularity of location based on supplier experience | INT | INT | FALSE |
Decoration
Field | DescriptionWSDL Data Type | SQL Data Type | Required | Best Practice | |
decorationId | The ID of the decoration | INT | INT | TRUE | |
decorationName | The name of the decoration | STRING | VARCHAR(64) | FALSE | |
decorationGeometry | The geometry of the decoration. Values are enumerated: {Circle, Rectangle, Other}. | STRING | VARCHAR(64) | TRUE | |
decorationHeight | The maximum imprint height of the decoration; leave blank if the imprint is not rectangularDOUBLE | DECIMAL (12,4) | FALSE | ||
decorationWidth | The maximum imprint width of the decoration; leave blank if the imprint is not rectangularDOUBLE | DECIMAL (12,4) | FALSE | ||
decorationDiameter | The maximum imprint diameter of the decoration; leave blank if the imprint is not circularDOUBLE | DECIMAL (12,4) | 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_385163498STRING | VARCHAR(64) | TRUE | ||
allowSubForDefaultLocation | Buyer is allowed to substitute a decoration location without changing the priceBOOLEAN | BOOLEAN | TRUE | ||
allowSubForDefaultMethod | Buyer is allowed to substitute this decoration method without changing the price | BOOLEAN | BOOLEAN | TRUE | |
itemPartQuantityLTM | Specifies the Part Quantity that is the absolute minimum that can be ordered with a Less Than Minimum (LTM) charge. | INT | INT | FALSE | |
ChargeArray | An array of setup charge dataARRAY | ARRAY | 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” | INT | INT | FALSE | |
decorationUnitsIncludedUom | Values are enumerated: {Colors, Inches, Other, Stitches, SquareInches }. | STRING | STRING | FALSE | |
decorationUnitsMax | This is the max number of decoration units for this decoration/location combination. | INT | INT | FALSE | |
defaultDecoration | Specifies whether this is the default decoration for this location | BOOLEAN | BOOLEAN | TRUE | Yes. Helps to display a default price to customers. |
leadTime | The leadtime for the given decoration | INT | INT | FALSE | |
rushLeadTime | The lead time for rush service for a given decoration (rush charges may apply)INT | INT | FALSE |
Charge
Field | Description | WSDL Data Type | SQL Data Type | Required | Best Practice |
chargeId | The Id of the charge | INT | INT | TRUE | |
chargeName | The name of the charge | STRING | VARCHAR(64) | TRUE | |
chargeType | The type of charge. Values are enumerated {Order, Run, Setup}.STRING | VARCHAR(64) | TRUE | ||
chargeDescription | The charge description | STRING | VARCHAR(256) | TRUE | |
ChargePriceArray | An array of charge prices | ARRAY | ARRAY | TRUE | |
chargeAppliesLTM | This charge is applied with ordering Less than Minimum (LTM). | BOOLEAN | BOOLEAN | TRUE | |
chargesPerLocation | The number of times a charge will occur per location | INT | INT | FALSE | |
chargesPerColor | The number of times a charge will occur per color | INT | INT | FALSE |
Charge Price
Field | DescriptionWSDL Data Type | SQL Data Type | Required | Best Practice | |
chargeId | The Id of the charge | INT | INT | TRUE | |
chargeName | The name of the charge | STRING | VARCHAR(64) | TRUE | |
chargeType | The type of charge. Values are enumerated {Order, Run, Setup}.STRING | VARCHAR(64) | TRUE | ||
chargeDescription | The charge description | STRING | VARCHAR(256) | TRUE | |
ChargePriceArray | An array of charge prices | ARRAY | ARRAY | TRUE | |
chargeAppliesLTM | This charge is applied with ordering Less than Minimum (LTM). | BOOLEAN | BOOLEAN | TRUE | |
chargesPerLocation | The number of times a charge will occur per location | INT | INT | FALSE | |
chargesPerColor | The number of times a charge will occur per color | INT | INT | FALSE |