apirequest

type AddressInput struct {
	// Display name of the address.
	Name string `json:"name" validate:"required,min=1,max=255"`
	// Phone number associated with the address.
	Phone field.Optional[string] `json:"phone,omitzero" validate:"omitempty,max=255"`
	// Email address associated with the address.
	Email field.Optional[string] `json:"email,omitzero" validate:"omitempty,custom_email,max=255"`
	// How the address is used.
	//
	// - `standard`: a normal shipping or billing address.
	// - `drop_ship`: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.
	Type field.Optional[constants.AddressType] `json:"type,omitzero" default:"standard"`
	// The operating calendar naming the days this dock accepts freight, overriding the customer's own.
	ReceiveCalendarID field.Optional[string] `json:"receive_calendar_id,omitzero" validate:"omitempty"`
	// First line of the street address.
	StreetLine1 field.Optional[string] `json:"street_line_1,omitzero" validate:"omitempty,max=255"`
	// Second line of the street address.
	StreetLine2 field.Optional[string] `json:"street_line_2,omitzero" validate:"omitempty,max=255"`
	// City or locality.
	Locality field.Optional[string] `json:"locality,omitzero" validate:"omitempty,max=255"`
	// State or administrative area.
	State field.Optional[string] `json:"state,omitzero" validate:"omitempty,max=255"`
	// Postal or ZIP code.
	PostalCode field.Optional[string] `json:"postal_code,omitzero" validate:"omitempty,max=255"`
	// Two-letter ISO 3166-1 country code, such as `US`.
	Country string `json:"country" validate:"required,max=2"`
}

type ItemIdentifier struct {
	// Item ID.
	ID string `json:"id,omitempty" validate:"omitempty,max=255"`
	// Item SKU, matched case-insensitively against the account's items.
	SKU string `json:"sku,omitempty" validate:"omitempty,max=255"`
}

type ObjectIdentifier struct {
	// Object ID.
	ID string `json:"id,omitempty" validate:"omitempty,max=255"`
	// Object name, matched case-insensitively.
	Name string `json:"name,omitempty" validate:"omitempty,max=255"`
}

type OrderLineInput struct {
	// ID of the product being ordered.
	ProductID string `json:"product_id" validate:"required"`
	// ID of the inventory item this line is linked to.
	//
	// Stock received against the line is booked into this item, so lines for goods you hold in inventory should reference one. Supplying an item also records the item's material as sourced from this order's supplier, with `product_sku` as the supplier part number, when that link does not exist yet.
	ItemID field.Optional[string] `json:"item_id,omitzero" validate:"omitempty"`
	// The product SKU recorded on the line.
	//
	// Stored on the line itself, so it stays stable even if the product's SKU changes later.
	ProductSKU string `json:"product_sku" validate:"required,max=255"`
	// The product description recorded on the line.
	ProductDescription field.Optional[string] `json:"product_description,omitzero"`
	// Quantity ordered from the supplier.
	Quantity QuantityInput `json:"quantity" validate:"required"`
	// Agreed purchase price per unit for this line.
	//
	// This is also the cost carried into inventory: stock received against the line is costed at this rate.
	UnitPrice RateInput `json:"unit_price" validate:"required"`
	// Cost per unit recorded on the line, if you capture it separately from the agreed purchase price.
	//
	// Kept for reference only; it does not affect how stock received against the line is costed.
	UnitCost field.Optional[RateInput] `json:"unit_cost,omitzero"`
}

type QuantityInput struct {
	// Decimal value, as a string to preserve precision.
	Value string `json:"value" validate:"required" format:"decimal"`
	// ID of the unit of measure for the value.
	UnitID string `json:"unit_id" validate:"required"`
}

type RateInput struct {
	// Decimal value of the rate, expressed as the amount of the numerator unit per one denominator unit.
	Value string `json:"value" validate:"required" format:"decimal"`
	// ID of the unit for the rate's numerator (e.g. the currency of a price).
	NumeratorUnitID string `json:"numerator_unit_id" validate:"required"`
	// ID of the unit for the rate's denominator (the per-unit basis).
	DenominatorUnitID string `json:"denominator_unit_id" validate:"required"`
}

type UnitIdentifier struct {
	// Unit ID.
	ID string `json:"id,omitempty" validate:"omitempty,max=255"`
	// Unit name, matched case-insensitively against the account's units.
	Name string `json:"name,omitempty" validate:"omitempty,max=255"`
	// Unit abbreviation, matched case-insensitively against the account's units.
	Abbreviation string `json:"abbreviation,omitempty" validate:"omitempty,max=255"`
}