Model: globalItems

1 min

Model Parameters

globalItems
- itemsobject[]
  Description
  [OPTIONAL]
  - isUpsellstring<true | false>
    Description
    [OPTIONAL] Indicates if item was upsold.
    Allowed
    truefalse
  - itemTypestring<giftCard | parking | physicalGood | reservation | subscription | ticket | other>
    Description
    [OPTIONAL] Nature of item.
    Allowed
    giftCardparkingphysicalGoodreservationsubscriptionticketother
  - brandNamestring
    Example
    Apple
    Description
    [OPTIONAL] Item's brand name. Maximum field length = 20 characters.
  - categorystring
    Example
    Computer
    Description
    [OPTIONAL] Item category. Maximum field length = 100 characters.
  - descriptionstring
    Example
    Macbook Pro
    Description
    [OPTIONAL] Short description. Maximum field length = 40 characters.
  - itemIDstring
    Example
    SKU123
    Description
    [OPTIONAL] Item identifier, such as a SKU number, that you provide. Maximum field length = 20 characters.
  - pricenumber
    Example
    9.99
    Description
    [OPTIONAL] Item price. Format = two decimals.
  - faceValueAmountnumber
    Example
    19.99
    Description
    [OPTIONAL] Original cost of the transacted item. For some items, such as tickets, this could be more or less than the value in the price field. Format = two decimals.
  - quantitynumber
    Example
    3
    Description
    [OPTIONAL] Quantity (supports decimals). Maximum field length = 12 characters.
  - addressIDstring
    Example
    23kj423klj234j
    Description
    [OPTIONAL] Identifier you apply to addresses to differentiate orders with multiples. Maximum field length = 40 characters.
  - productConditionstring<new | openPackage | other | refurbished | used>
    Description
    [OPTIONAL] Condition of the product.
    Allowed
    newopenPackageotherrefurbishedused
  - shippingCompanystring<dhl | fedex | ups | usps | other>
    Description
    [OPTIONAL] Name of shipping company for merchant-to-consumer initial delivery.
    Allowed
    dhlfedexupsuspsother
  - shippingMethodstring<digital | ground | international | other | nextDay | sameDay | storePickup | twoDay | threeDay>
    Description
    [OPTIONAL] Shipping method.
    Allowed
    digitalgroundinternationalothernextDaysameDaystorePickuptwoDaythreeDay
  - shippingTrackingNumberstring
    Example
    23l4fdswerea02
    Description
    [OPTIONAL] Carrier tracking number. Maximum field length = 30 characters.
  - isLargeItemDeliverystring<true | false>
    Description
    [OPTIONAL] Whether delivery is for a large item.
    Allowed
    truefalse
  - promoCodestring
    Example
    ABC12
    Description
    [OPTIONAL] Line‑level promo code if applied here. Maximum field length = 100 characters.
  - promoAmountnumber
    Example
    5555
    Description
    [OPTIONAL] Promotion or discount amount applied in the currency specified by the transaction currencyCode field. Format = two decimals.
  - promoTypestring<bogo | bundle | employeeDiscount | freeShipping | loyaltyDiscount | newMemberDiscount | percentage | quantityPromotion | other>
    Description
    [OPTIONAL] Type of discount applied to this line item.
    Allowed
    bogobundleemployeeDiscountfreeShippingloyaltyDiscountnewMemberDiscountpercentagequantityPromotionother
  - pickupLocationstring<curbside | dropBox | inStore | other>
    Description
    [OPTIONAL] Type of pickup location when applicable.
    Allowed
    curbsidedropBoxinStoreother
  - pickupLocationDescriptionstring
    Example
    At the main entrance
    Description
    [OPTIONAL] Freeform description of pickup location. Maximum field length = 100 characters.
  - pickupPersonFirstNamePrimarystring
    Example
    Betty
    Description
    [OPTIONAL] Primary pickup person's first name. Maximum field length = 40 characters.
  - pickupPersonLastNamePrimarystring
    Example
    Smith
    Description
    [OPTIONAL] Primary pickup person's last name. Maximum field length = 40 characters.
  - pickupPersonFirstNameAlternatestring
    Example
    Mary
    Description
    [OPTIONAL] Alternate pickup person's first name. Maximum field length = 40 characters.
  - pickupPersonLastNameAlternatestring
    Example
    Jones
    Description
    [OPTIONAL] Alternate pickup person's last name. Maximum field length = 40 characters.
  - pickupVerificationMethodstring<idCard | signature | other>
    Description
    [OPTIONAL] Method used to verify pickup identity.
    Allowed
    idCardsignatureother
  - pickupDateTimestring<date-time>
    Example
    2021-03-02T17:07:24-07:00
    Description
    [OPTIONAL] Date and time the item was picked up (send as an update) formatted in yyyy-MMdd'T'HH:mm
    .
    Format
    date-time
  - pickupVerificationSignatureImagestring
    Description
    [OPTIONAL] Base64 signature image captured on pickup. Maximum field length = 4000 characters.
  - pickupVerificationIDCardImagestring
    Description
    [OPTIONAL] Base64 ID card image captured on pickup. Maximum field length = 4000 characters.

Line‑item details across product types.