FHC API v1.1
§ Reference
Field constraints & allowed values

Codes, constraints & allowed values.

The authoritative reference for every caller-controllable field: which accept only coded values, what those codes mean, what the length limits are, and what the server does to your input. Start with the field matrix in § 01, then drill into the enumerations and processing rules below.

§ 01 / Fields

Every caller-controllable field, at a glance.

Field matrix

One row per field. Required means the request will be rejected without it; all other fields are optional and fall back to server-side defaults when omitted. Max is the server-side storage width — values longer than this are either silently truncated (on the truncating fields listed in § 04) or stored up to the listed limit. Field names are case-sensitive.

Top-level order fields

FieldTypeRequiredMaxNotes
JOB_NAMEstringoptional20Job / project name. Prints on packing slip and order documents. Silently truncated to 20 chars server-side.
SHIP_TO_FNAMEstringoptionalFirst name of ship-to contact. Combined with SHIP_TO_LNAME. Combined contact name is stored up to ~30 chars.
SHIP_TO_LNAMEstringoptionalLast name of ship-to contact.
SHIP_TO_COMPANYstringoptional30Ship-to company / business name. Silently truncated to 30 chars.
SHIP_TO_ADDRESSstringoptional30Single-line street address. Include suite / unit in this field. Silently truncated to 30 chars.
SHIP_TO_CITYstringoptionalComposed with state, ZIP, country into a single display line server-side.
SHIP_TO_STATEstringoptional2Two-letter US state / province code.
SHIP_TO_ZIPstringoptional10NNNNN or NNNNN-NNNN.
SHIP_TO_COUNTRYstringoptional2ISO 3166-1 alpha-2 code. Defaults to US.
SHIP_TO_PHONEstringoptionalAny format. Server strips non-digits, drops leading 1 if 11 digits, reformats as NNN/NNN-NNNN.
SHIP_VIAstring, enumoptional2Carrier code. See § 03. If omitted, FHC default carrier used. Server may substitute based on customer & destination.
PURCHASE_ORDERstringoptional15Your internal PO reference. Silently truncated to 15 chars.
ORDER_COMMENTSstringoptionalunlimitedFree text. Split server-side at 30-char word boundaries and stored as a multi-value list.
ORDR_EMAILstring, emailoptional~40Contact email. Note attribute spelling (ORDR_EMAIL, not ORDER_EMAIL).
LOCstring, enumoptional2Warehouse code. See § 02.
REQUESTED_BYstringoptional~15Name of the person requesting the order.
ORDER_LINESarrayrequiredAt least one line item.

ORDER_LINES item fields

FieldTypeRequiredMaxNotes
PRODUCT_CODEstringrequired15FHC product SKU. Uppercase required — pattern ^[A-Z0-9-]+$.
ORDER_QUANTITYintegerrequired6-digitPositive integer, minimum 1.

Injected server-side (do not send)

FieldTypeSourceMaxNotes
CUSTOMER_NUMBERintegertokenForce-injected from the authenticated token. Any value in request body is ignored.
§ 02 / LOC

Warehouse locations.

String enum

The LOC field specifies the FHC warehouse the order should ship from. Only these five integer-valued codes are accepted. If omitted, FHC routes based on the customer's default and the ship-to address.

1
California
2
Texas
6
New Jersey
10
Washington
22
South Carolina
§ 03 / SHIP_VIA

Carrier codes.

String enum

The SHIP_VIA field specifies carrier and service level. Two-character codes, case-sensitive. If omitted, FHC default carrier for the region is used. Carrier substitution rules may override the submitted code based on customer preferences and destination state.

UPS

CodeService
04UPS (default)
UGUPS Ground
U1UPS Next Day Air
UEUPS Next Day Early AM
U4UPS Next Day Saver
U2UPS 2-Day
U5UPS 2nd Day AM
U3UPS 3-Day Select
USUPS Saturday Delivery

FedEx

CodeService
FGFedEx Ground
FAFedEx Air
FFFedEx Freight

USPS

CodeService
05USPS
UPUSPS Priority

Freight & other

CodeService
03Common Carrier
TCTrump Card
WCWill Call (customer pickup)
07No ship (hold on account)
§ 04 / Server-side processing

What the server does to your input.

Behavior

Several fields receive server-side transformations. These are documented here so you can anticipate what shows up on the final order record.

Silent length truncation

FieldWidthNotes
JOB_NAME20Longer values silently truncated; original preserved in order audit
SHIP_TO_COMPANY30Longer values silently truncated
SHIP_TO_ADDRESS30Single line; include suite / unit in this field
PURCHASE_ORDER15Longer values silently truncated

Transformations

FieldBehavior
SHIP_TO_PHONENon-digits stripped. If 11 digits, leading 1 dropped. Reformatted as NNN/NNN-NNNN.
ORDER_COMMENTSSplit at 30-character word boundaries (break chars: space - _ , ; : . ! ?) and stored as multi-value list.
PRODUCT_CODECase-sensitive lookup; must be uppercase.
SHIP_TO_CITY / STATE / ZIP / COUNTRYComposed into a single display line: City, ST ZIP (US) or City ST COUNTRY ZIP (non-US).
All text fields have characters below ASCII 32 or above 126 stripped before storage.

Defaults (when omitted)

FieldDefault
SHIP_TO_COUNTRYUS
SHIP_VIAFHC's default carrier for the ship-to region
LOCCustomer's default warehouse / region routing
CUSTOMER_NUMBERForce-injected from the authenticated token