id
required |
string (uuid)
|
The unique identifier for the line item.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
productCode
required |
string
|
The product code. Maximum length is 25 characters.
Conditional: When ProductCode is not null. Max length: 25.
nullablemax length 25
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
commodityCode
required |
string
|
The commodity code. Maximum length is 25 characters.
Conditional: When CommodityCode is not null. Max length: 25.
nullablemax length 25
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
description
required |
string
|
The description of the item. Maximum length is 25 characters.
Conditional: When Description is not null. Max length: 25.
nullablemax length 25
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
upc
required |
string
|
The Universal Product Code (UPC). Maximum length is 25 characters.
Conditional: When Upc is not null. Max length: 25.
nullablemax length 25
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
invoiceNumber
required |
string
|
The invoice number. Maximum length is 25 characters.
Conditional: When InvoiceNumber is not null. Max length: 25.
nullablemax length 25
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
taxType
required |
string
|
The tax type.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
quantity
required |
number (double)
|
The quantity of the item. Must be non-negative.
Conditional: When Quantity is not null. Must be > 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
unitOfMeasure
required |
string
|
The unit of measure. Maximum length is 30 characters.
Conditional: When UnitOfMeasure is not null. Max length: 30.
nullablemax length 30
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
unitPrice
required |
number (double)
|
The unit price of the item. Must be positive.
Conditional: When UnitPrice is not null. Must be >= 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
discountAmount
required |
number (double)
|
The discount amount. Must be non-negative.
Conditional: When DiscountAmount is not null. Must be >= 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
totalAmount
required |
number (double)
|
The total amount for the line item. Must be positive.
Conditional: When TotalAmount is not null. Must be >= 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
taxAmount
required |
number (double)
|
The tax amount. Must be non-negative.
Conditional: When TaxAmount is not null. Must be >= 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
taxRate
required |
number (double)
|
The tax rate. Must be non-negative.
Conditional: When TaxRate is not null. Must be >= 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
extendedAmount
required |
number (double)
|
The extended amount. Must be non-negative.
Conditional: When ExtendedAmount is not null. Must be >= 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
freightAmount
required |
number (double)
|
The freight amount. Must be non-negative.
Conditional: When FreightAmount is not null. Must be >= 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
dutyAmount
required |
number (double)
|
The duty amount. Must be non-negative.
Conditional: When DutyAmount is not null. Must be >= 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
taxIncluded
required |
boolean
|
Value indicating whether tax is included in the price.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
wicFoodCategoryCode
required |
string
|
The USDA WIC food category code for the item (e.g. the 2-digit category in the WIC
Authorized Product List). Optional; only populated for eWIC line items. Maximum length
is 25 characters.
Conditional: When WicFoodCategoryCode is not null. Max length: 25.
nullablemax length 25
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
wicSubcategoryCode
required |
string
|
The USDA WIC food subcategory code for the item, where the category is further
subdivided. Optional; only populated for eWIC line items. Maximum length is 25 characters.
Conditional: When WicSubcategoryCode is not null. Max length: 25.
nullablemax length 25
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
wicBenefitType
required |
WicBenefitType
WicBenefitType |
The coarse eWIC benefit mechanism this line redeems against. See
`WicBenefitType`. Optional; only populated
for eWIC line items.
Conditional: When WicBenefitType is not null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Unspecified |
Benefit mechanism not specified. Default for line items that carry other eWIC data (e.g. a category code) without an explicit mechanism classification. | FoodBenefit |
Standard fixed-quantity food benefit, redeemed by USDA food category/subcategory against the cardholder's remaining prescribed balance for that category. | CashValueBenefit |
Cash Value Benefit (CVB) / Cash Value Voucher (CVV): a dollar-denominated benefit for fruits and vegetables, redeemed against a remaining dollar balance rather than a fixed quantity. | InfantFormula |
Infant formula. Handled distinctly from standard food benefits because of contract-brand restrictions and manufacturer rebate accounting. |
|
voucherReference
required |
string
|
The processor-issued voucher / benefit reference this line redeems against. Optional;
only populated for eWIC line items. Maximum length is 25 characters. Format is not
enforced here because it is processor-specific (the initial eWIC processor is selected
later in the epic).
Conditional: When VoucherReference is not null. Max length: 25.
nullablemax length 25
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
wicUnitOfMeasure
required |
string
|
The WIC-specific unit of measure for the item, which can differ from the generic
`unitOfMeasure` (WIC programs prescribe benefits in program-specific units).
Optional; only populated for eWIC line items. Maximum length is 30 characters.
Conditional: When WicUnitOfMeasure is not null. Max length: 30.
nullablemax length 30
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
wicEligibleQuantity
required |
number (double)
|
The quantity of this line that is WIC-eligible, which can be less than the cart-line
`quantity` when only part of the purchased quantity falls within the
cardholder's benefit. Must be non-negative. Optional; only populated for eWIC line items.
Conditional: When WicEligibleQuantity is not null. Must be >= 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
wicEligibleAmount
required |
number (double)
|
The amount of this line that is WIC-eligible, which can be less than the cart-line
`totalAmount` when only part of the line is covered by the benefit. Must be
non-negative. Optional; only populated for eWIC line items.
Conditional: When WicEligibleAmount is not null. Must be >= 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|