Extensions, also known as extended values, are arbitrary key values that can be applied to resources. Extensions may be used for various purposes, from UI customization to extra order metadata. Extensions are defined via an Extension array field on a resource item. They should specify an ElementType and a Value.

Extensions are copied over to their corresponding Order fields on Order Exports. For example, Customer Extensions will show up on the Customer section of an Order, and Product Extensions will appear on the Order Products.

List of Extension Types

📘
Items marked with a star ⭐ are more commonly used.

Extensions For Customers

ElementType	Notes
ADDRESS3
ADDRESS4
AIMSCUSTOMERID
AIMSCUSTOMERSTOREID
AMBASSADORLEVEL
BRANDLIMIT
CHANNELCODE
CLASSIFICATIONCODE
CONTACT
CSREMAIL
CURRENCY
CUSTOMERGROUP
CUST_REF_FLG1
DEFAULTSHIPPINGACCOUNT
EMAIL ⭐
FREIGHTTERMS
GROUPTYPE	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 GROUPTYPE, must also have the GROUPTYPE in their Customer Extensions with matching Values. For example, this can be used for exclusive collections that are restricted to certain customer groups.
HOLDDESCRIPTION
LICENSE
NOTES
PFASEXEMPT
PRESEASONTIER
PRODUCTGROUP
RESORTACCOUNT
SERIESNAME
SERVICEDISCOUNT
SHIPPINGNOTES
SKIPINCENTIVE
SUBDIVISIONCODE
TAXCODECUSTOMER
USESDISTRIBUTORPRICINGCUSTOMER
USESRETAIL
VATGROUP
VATSTATUS
WAREHOUSE ⭐	Defines the inventory locations (warehouses) available to a customer. Uses a location's Id value (can be obtained by using a GET call on the InventoryLocation resource).

Extensions For Orders

ElementType	Notes
ACCOUNTNUMBER
ADDRESS
ADDRESS3
ADDRESS4
ADMINHOLD
ADMINHOLDREASON
AGE
AIMSCUSTOMERID
CHILDFIRSTNAME
CHILDLASTNAME
CITY
COMMENTTYPE
CONFIRMATIONHOLD
CRESTCONTACTNAME
CRESTINGNOTES
CRESTPHONEEMAIL
CURRENCY
DEPARTMENT
DROPSHIPEMAIL
EMAILADDRESS
EMBROIDEREDLOGO
ERPORDERTYPE
FIVEPERDISCOUNT
FREEEMBROIDERY
FREEFREIGHT
FREEFREIGHTREASON
FREIGHTTERMS
GRADE
HANGTAG
HASCRESTING
ITEMDISCOUNT
LAST4CC
LOGOINSTRUCTIONS
MICROSITEUSEREMAIL
MICROSITEUSERLOCATION
MLBEMBROIDEREDLOGO
NEWLOGO1
NEWLOGO2
NEWLOGO3
ORDERCONTACT
ORDERORIGIN
ORDERTYPE
POLYBAG
PROMOCODE ⭐	Stores a promotion code entered on the Order Header.
PUD25DISCOUNT	Can be configured (Contact RepSpark Professional Services) so sales representatives may toggle this boolean field on the Order Header to apply a 25% off Personal Use Discount.
PUD40DISCOUNT	Can be configured (Contact RepSpark Professional Services) so sales representatives may toggle this boolean field on the Order Header to apply a 40% off Personal Use Discount.
REFERENCE
REGIONCODE
SERVICEDISCOUNT
SERVICEHOLD	Can be added if certain custom validation conditions (Contact RepSpark Professional Services) should trigger a service hold status.
SERVICEHOLDTEXT	Informational text that can be associated with the SERVICEHOLD status extension.
SHIPCOMPLETE
SHIPEARLY
SHIPPINGACCOUNT
SHIPPINGINSTRUCTIONS
SHIPPINGNOTES	An extra free-form field used to store notes related to shipping. Contact RepSpark Professional Services to set up order header input.
SOURCE
STATE
STREET
SUBMISSIONERROR
TELEPHONE
TENPERDISCOUNT
TRADESHOW
TWENTYFIVEPERDISCOUNT
UPCLABEL
USEDISTRIBUTORPRICINGORDER
VALIDATEDWITH
VALIDATIONERROR
WAREHOUSE
ZIP

Extensions for Products

ElementType	Notes
ADMINVIEW
AGE
AIMSSTYLEID
ALTERNATEPRICES
APMAAPPROVED
ARTISTNAME
ARTLIMIT
ARTNAME
AVAILABLEDATE
BACK_IN_STOCK
BLOCKCODE
BLUETOOTH
BODYTYPE
CARRYOVER
CATALOGHIDDENSIZES
CATALOGORDER
CATALOGPAGE
CATEGORY
CHANNELCODE
CLASSIFICATIONCODE
CLOSEOUT
COLLECTION :star:	Arbitrary product group or collection, referenced via Product Extensions, used for filtering or metadata purposes. The key-values should also be defined in Options with the same ElementType. The value specified should be the placement location keycode used in Options.
COLORDESCRIPTION
COLORGROUP :star:	Arbitrary color groupings/families used by Products, used for filtering or metadata. If used for filtering, then the key-values also need to be defined in Options.
COLORSTORY :star:	Arbitrary color labels used by Products, used for filtering or metadata. Unlike with the Color ElementType, ColorStory does not define uniqueness. If used for filtering, then the key-values also need to be defined in Options.
COMMONNAME
CONTENTCODE
COUNTRYOFORIGIN	Indicates the country a product is manufactured in, can be used for display purposes on the product popup view.
CUSTOMERCODELIMIT :star:	Used to restrict items that can only be purchased by specified customers, referenced via their customer code. Can be used multiple times per product to specify multiple customers.
DELIVERYTIMING
DELIVERYWINDOW
DEPARTMENT
DEXTERITY
EMBELLISHMENTDESCRIPTION
EXCLUDEDPLACEMENT
EXTERNALPRODUCTREFERENCE
FABRICATION
FABRICCODE	Indicates the type of fabric used, can be used for display or filtering purposes.
FABRICGROUP	Arbitrary fabric groupings/families used by Products, used for filtering or metadata. If used for filtering, then the key-values also need to be defined in Options.
FABRICPATTERN	Indicates the type of fabric pattern used, can be used for display or filtering purposes.
FABRICTYPE
FEATURE
FINISHLOCATIONLIMIT
FINISHTYPE	Can be used to define certain types of embroidery finishes that can be used on a certain body product (ProductType = 2) for attached logos.
FOOTBED
GARMENTCLASS
GROUP
GROUPTYPE	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 GROUPTYPE, must also have the GROUPTYPE in their Customer Extensions with matching Values. For example, this can be used for exclusive collections that are restricted to certain customer groups.
HASMIC
HEADPHONETYPE
HEELHEIGHT
INSEAMCODE
INTRODATE
ISCOLLEGIATE
ISPFAS
LICENSEE
LINING
LONGDESCRIPTION
MARKERCODE
MERCHANTCOLLECTION
MICTYPE
MINIMUMUNITS
MISCELLANEOUS
MSRP
MUSTHAVE
NEWPRODUCT
NOTWATERPROOF
NRFCODE
OFFPRICE
OFFPRICEBIT
ORDERTYPEEXCLUSIVEPRODUCTS
ORIGINALDELVRY
OUTSOLE
PLACEMENTLIMIT :star:	Used to define the placement locations available to a body product (ProductType = 2) Can be used multiple times per product to specify multiple placements. The value specified should be the placement location keycode as defined in Options (ElementType of Placement). Products missing PlacementLimit extensions have all placements available.
POLARIZATION
PREBOOKELIGIBLEPRODUCT
PRIMARY
PRODUCTCOLLECTION	Arbitrary product group or collection, referenced via Product Extensions, used for filtering or metadata purposes. The key-values should also be defined in Options with the same ElementType. The value specified should be the placement location keycode used in Options. Same functionality as Collections.
PRODUCTGROUP :star:	Arbitrary product groupings used to restrict visibility of Products, used for filtering or metadata. The key-values should also be defined in Options with the same ElementType. Customers that would like to purchase products with a specific group, must have the ProductGroup in their Customer Extensions. For example, this can be used for exclusive collections that are restricted to certain customer groups. Not to be confused with the ProductGroup Resource.
PRODUCTICONS
PRODUCTSTATUS
PRODUCTSTATUSINFORMATION
PRODUCTTYPE
PROMODESCRIPTION
PROMOTION
PURPOSE
REMOVABLEINSOLE
REPORTCODE
ROYALTYCODE
SEASON
SECONDARYCOPY
SERIESNAME
SILHOUETTE
SIZEPACK
SIZES
SIZESTEXT
SKU	An arbitrary SKU number that is typically referenced on the exported payload, for ERP importing purposes.
SLIPRESISTANT
SPIKED
SPIKELESS
STORECODELIMIT
STYLELABEL
SUBCLASSIFICATIONCODE
SUGGESTEDDELIVERY
SUGGESTEDDROPS
TAXONOMY
TECHNOLOGYCODE
UPC
UPPER
VANITY
VOLUME
WAREHOUSE
WATERPROOF
WHSL
YEAR