Item Write

Summary

image-20240321-163709.png
image-20240321-194739.png

These set of APIs will let you:

  1. Will let you add item(s).

  2. Remove all items purchased by a registrant via their badge number.

 

EndPoints:

  • Item/Add

  • Item/RemoveAllByBadge

 

Response

Field

Data Type

Definition

AuthKey

String

Authorization Key needed to call API endpoint.

OrderNumber

Integer

A unique ID provided to an order

ModifiedDate

String

Date the order was modified

ThirdPartyKey

String

Unique ID provided by a third party integration.

RecordStatus

Integer

Status flag indicating whether the item is active or not.

PackageKey

Integer

Key value of packaged items

TaxTypeId

Integer

Determines the type of item to be taxed.

ConsumptionId

Integer

Indicates consumption tax applied (Onsite or Offsite)

TaxCategoryId

Integer

Unique identifier assigned to a particular tax category chosen by the client. The Tax category ID is derived from the provider of the Tax software.

TaxRate

Number

Rate the item is taxed

TaxAmount

Number

Amount the item is taxed

ItemCode

String

Unique code provided to an item

Qty

Integer

Number of Items purchased.

Badge

Integer

Unique ID given to a Registrant.

ItemPriceKey

Integer

Item key associated with a specific price point

ItemDate

String

Date the Item was purchased

ItemStatus

String

Status flag of item: A(ctive), R(emoved), U(pgrade), W(aitlist))

ModifiedBy

String

Person the order was changed by.

ItemNotes

String

Notes created for the item

PrintTicket

Integer

Flag indicating if the item is printable as ticket

PackageItemKey

String

Key value of primary item of package

Price

Integer

Price of an Item

ItemPriceTier

String

Pricing Tiers set by client.

PromoCode

String

Promo code to provide discounts to the customer.

ItemPriceTier 2-5

String

Pricing Tiers set by client.

Related content