post https://{environment}.repspark.net/api/option
An Option represents a key-value lookup for most of the codes used throughout the RepSpark API.
ElementTypes
Options can have the following types:
Core Types
| ElementType | Definition |
|---|---|
| Color | A short label that represents the colors available to Product records. In most cases, ColorCodes are used in uniqueness and often used in filtering. A Product can only have one color at a time. |
| ColorChoice | (Embroidery) The type of color choice that should be used on an insignia e.g. Club Colors, or Color-Coordinated |
| Country | We recommend standard two-letter or three-letter country codes in the KeyCode field, however this field supports longer codes when short codes are not available. Can be used to populate dropdowns where Country is user-selectable. |
| CustomerTerms | Purchasing terms contracts used by the customers. It denotes the agreed-upon conditions and time frame within which the customer is expected to make payments for their orders. |
| Division | Divisions allow you to arbitrarily segment data for security and visibility purposes. Divisions are versatile and can be applied to distinguish various elements such as geographical regions (e.g., North America vs. Europe), business verticals (e.g., wholesale vs. ecommerce), or even brands. |
| Gender | A short label associated with the intended gender characteristic of a Product, if applicable. Can be used to filter and sort Products. |
| Placement | (Embroidery) The placement location of an insignia on a body product. Placement limits that restrict an item to only certain placements is defined on the Extensions of a given Product. Alternatively, Placements can also be restricted by entire product categories: to do this, set the StringValue2 of the Option item to the corresponding ProductCategory keycode - there should be a Placement entry for each ProductCategory that requires restriction. For example, if RCH placement should be present on JACKETS and POLOS, then there would be 2 RCH placements, one with StringValue2 JACKETS and another with StringValue2 POLOS. |
| ProductCategory | A product category in which a product can belong to. A product can only belong to a single category at a time. |
| SalesPerson | Entries for the names and shortened codes for sales representatives or sales groups. |
| Season | Available selling seasons. Alternatively, for advanced uses, seasons can be defined via the Season resource sync when more metadata is required, such as defining applicable date ranges. |
| ShippingOption | Available shipping methods used on orders. |
| State | The name of the county, province, or region. Can be used to populate dropdowns where State is user-selectable. |
Advanced Types
| ElementType | Definition |
|---|---|
| BlockCode | An arbitrary ERP block code, can be used for grouping or applying a category to a product that is later referenced in the ERP via a keycode. Rarely used. |
| Catalog | An arbitrary value used for applying a catalog property to a Product, referenced via Product Extensions. |
| ClassificationCode | Arbitrary classification code used for labeling and filtering, or other customizations. |
| Collections | Arbitrary product group or collection, referenced via Product Extensions, used for filtering or metadata purposes. |
| ColorGroup | Arbitrary color groupings/families used by Products, referenced via Product Extensions, used for filtering or metadata. |
| ColorStory | Arbitrary color labels used by Products, referenced via Product Extensions, used for filtering or metadata. Unlike with the Color ElementType, ColorStory does not define uniqueness. |
| ContentCode | Arbitrary material/content labels used by Products, referenced via Product Extensions, used for advanced display purposes. Contact RepSpark Professional Services for more information. |
| CreditStatus | Payment credit statuses applicable to customer, referenced in Customer Extensions, can be used for ERP reference purposes, as this is exported on the Order JSON. |
| CustomerType | Arbitrary customer types, referenced in Customer Extensions, can be used for customization logic or for ERP reference purposes once exported. |
| DecorationChoice | (Embroidery) The type of decoration that should be applied to an insignia. |
| Dimension | Dimension values that can applied to a product, referenced via Product Extensions. |
| EmbroideredLogo | Used for collegiate customizations, contact RepSpark Professional Services for more information. |
| FinishType | (Embroidery) The type of finish, if applicable, that can be applied for an insignia. |
| ItemDiscount | A discount code that may be applied to a Product via Extensions. For instance, a product may have a discount of 30% and in your ERP this may map to a code 123. Once exported, you can pull this from the Product Extension array and apply the discount on your ERP. |
| LogoType | (Embroidery) The type of insignia. |
| MarketingSeason | A season value that is used separately from the selling season. |
| MerchantCollection | Arbitrary product group or collection, referenced via Product Extensions, used for filtering or metadata purposes. Same functionality as Collections. |
| PricingTier | Arbitrary pricing tier given to products. |
| ProductCollection | Arbitrary product group or collection, referenced via Product Extensions, used for filtering or metadata purposes. Same functionality as Collections. |
| ProductGroup | Arbitrary product groupings commonly used to restrict visibility of Products, referenced via Product Extensions, used for filtering or metadata. To restrict visibility, customers that would like to purchase products with a specific group, must also have the ProductGroup in their Customer Extensions. For example, this can be used for exclusive collections that are restricted to certain customer groups. If a Customer entry has any ProductGroup Extensions specified, then the Customer can ONLY see Products with those associated ProductGroups. If no ProductGroup Extensions are not present on the Product, they will not be visible to the Customer. Thus we recommend always setting the ProductGroup on all Products, if this feature is used at all. If no Customer Extensions contain ProductGroup, then ProductGroups will not be locked to Customers. Not to be confused with the ProductGroup Resource. |
| ProductType | Arbitrary product types, referenced in Product Extensions, used for filtering or metadata. |
| RegionCode | A region label. |
| ServiceDiscount | A discount code that may be applied to a Customer via Extensions. For instance, a customer may be allowed Free Shipping and in your ERP this may map to a code 12345. Once exported, you can pull this from the Customer Extension array and apply the discount on your ERP. |
| StyleLabel | Arbitrary label applied to Products and referenced via Product Extensions, used for filtering or metadata. For example, can use this as a pseudo-product category. |
| SuggestedDelivery | A label used to define (through Product Extensions) the date or season a product should be delivered by. |
| TechnologyCode | An arbitrary product technology that can be used for filtering, corresponding to Extension values on Products. |
| Thread | (Embroidery) If applicable, the type of thread that should be used in an insignia. |
Recommended sync cadence
Once per day and on-demand when needed.