vendor_direct_fulfillment_orders_2021_12_28_models

type AcknowledgementStatus struct {

	// Acknowledgement code is a unique two digit value which indicates the status of the acknowledgement. For a list of acknowledgement codes that Amazon supports, see the Vendor Direct Fulfillment APIs Use Case Guide.
	Code string `json:"code,omitempty"`

	// Reason for the acknowledgement code.
	Description string `json:"description,omitempty"`
}

type Address struct {

	// First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	// Required: true
	AddressLine1 *string `json:"addressLine1"`

	// Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	AddressLine2 string `json:"addressLine2,omitempty"`

	// Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	AddressLine3 string `json:"addressLine3,omitempty"`

	// The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	Attention string `json:"attention,omitempty"`

	// The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	City string `json:"city,omitempty"`

	// The two digit country code. In ISO 3166-1 alpha-2 format.
	// Required: true
	CountryCode *string `json:"countryCode"`

	// The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	County string `json:"county,omitempty"`

	// The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	District string `json:"district,omitempty"`

	// The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	// Required: true
	Name *string `json:"name"`

	// The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	Phone string `json:"phone,omitempty"`

	// The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
	PostalCode string `json:"postalCode,omitempty"`

	// The state or region where person, business or institution is located.
	// Required: true
	StateOrRegion *string `json:"stateOrRegion"`
}

type BuyerCustomizedInfoDetail struct {

	// A [Base 64](https://datatracker.ietf.org/doc/html/rfc4648#section-4) encoded URL using the UTF-8 character set. The URL provides the location of the zip file that specifies the types of customizations or configurations allowed by the vendor, along with types and ranges for the attributes of their products.
	CustomizedURL string `json:"customizedUrl,omitempty"`
}

type Decimal string

type Error struct {

	// An error code that identifies the type of error that occurred.
	// Required: true
	Code *string `json:"code"`

	// Additional details that can help the caller understand or fix the issue.
	Details string `json:"details,omitempty"`

	// A message that describes the error condition.
	// Required: true
	Message *string `json:"message"`
}

type ErrorList struct {

	// errors
	// Required: true
	Errors []*Error `json:"errors"`
}

type GiftDetails struct {

	// Gift message to be printed in shipment.
	GiftMessage string `json:"giftMessage,omitempty"`

	// Gift wrap identifier for the gift wrapping, if any.
	GiftWrapID string `json:"giftWrapId,omitempty"`
}

type ItemQuantity struct {

	// Acknowledged quantity. This value should not be zero.
	Amount int64 `json:"amount,omitempty"`

	// Unit of measure for the acknowledged quantity.
	// Enum: [Each]
	UnitOfMeasure string `json:"unitOfMeasure,omitempty"`
}

type Money struct {

	// amount
	Amount Decimal `json:"amount,omitempty"`

	// Three digit currency code in ISO 4217 format. String of length 3.
	CurrencyCode string `json:"currencyCode,omitempty"`
}

type Order struct {

	// Purchase order details.
	OrderDetails *OrderDetails `json:"orderDetails,omitempty"`

	// The purchase order number for this order. Formatting Notes: alpha-numeric code.
	// Required: true
	PurchaseOrderNumber *string `json:"purchaseOrderNumber"`
}

type OrderAcknowledgementItem struct {

	// The date and time when the order is acknowledged, in ISO-8601 date/time format. For example: 2018-07-16T23:00:00Z / 2018-07-16T23:00:00-05:00 / 2018-07-16T23:00:00-08:00.
	// Required: true
	// Format: date-time
	AcknowledgementDate *strfmt.DateTime `json:"acknowledgementDate"`

	// Status of acknowledgement.
	// Required: true
	AcknowledgementStatus *AcknowledgementStatus `json:"acknowledgementStatus"`

	// Item details including acknowledged quantity.
	// Required: true
	ItemAcknowledgements []*OrderItemAcknowledgement `json:"itemAcknowledgements"`

	// The purchase order number for this order. Formatting Notes: alpha-numeric code.
	// Required: true
	PurchaseOrderNumber *string `json:"purchaseOrderNumber"`

	// PartyID as vendor code.
	// Required: true
	SellingParty *PartyIdentification `json:"sellingParty"`

	// PartyID as the vendor's warehouseId.
	// Required: true
	ShipFromParty *PartyIdentification `json:"shipFromParty"`

	// The vendor's order number for this order.
	// Required: true
	VendorOrderNumber *string `json:"vendorOrderNumber"`
}

type OrderDetails struct {

	// Name/Address and tax details of the bill to party.
	// Required: true
	BillToParty *PartyIdentification `json:"billToParty"`

	// The customer order number.
	// Required: true
	CustomerOrderNumber *string `json:"customerOrderNumber"`

	// A list of items in this purchase order.
	// Required: true
	Items []*OrderItem `json:"items"`

	// The date the order was placed. This  field is expected to be in ISO-8601 date/time format, for example:2018-07-16T23:00:00Z/ 2018-07-16T23:00:00-05:00 /2018-07-16T23:00:00-08:00. If no time zone is specified, UTC should be assumed.
	// Required: true
	// Format: date-time
	OrderDate *strfmt.DateTime `json:"orderDate"`

	// Current status of the order.
	// Enum: [NEW SHIPPED ACCEPTED CANCELLED]
	OrderStatus string `json:"orderStatus,omitempty"`

	// PartyID of vendor code.
	// Required: true
	SellingParty *PartyIdentification `json:"sellingParty"`

	// PartyID of vendor's warehouse.
	// Required: true
	ShipFromParty *PartyIdentification `json:"shipFromParty"`

	// Name/Address and tax details of the ship to party.
	// Required: true
	ShipToParty *Address `json:"shipToParty"`

	// shipment details
	// Required: true
	ShipmentDetails *ShipmentDetails `json:"shipmentDetails"`

	// tax total
	TaxTotal *TaxItemDetails `json:"taxTotal,omitempty"`
}

type OrderItem struct {

	// The buyer information for products the vendor has configured as customizable, specifying the types of customizations or configurations along with types and ranges for their product. This provides the ability for buyers to customize multiple aspects of the products according to what the vendor allows.
	BuyerCustomizedInfo *BuyerCustomizedInfoDetail `json:"buyerCustomizedInfo,omitempty"`

	// Buyer's standard identification number (ASIN) of an item.
	BuyerProductIdentifier string `json:"buyerProductIdentifier,omitempty"`

	// Gift message and wrapId details.
	GiftDetails *GiftDetails `json:"giftDetails,omitempty"`

	// Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.
	// Required: true
	ItemSequenceNumber *string `json:"itemSequenceNumber"`

	// Net price (before tax) to vendor with currency details.
	// Required: true
	NetPrice *Money `json:"netPrice"`

	// Item quantity ordered.
	// Required: true
	OrderedQuantity *ItemQuantity `json:"orderedQuantity"`

	// Details for the scheduled delivery shipment.
	ScheduledDeliveryShipment *ScheduledDeliveryShipment `json:"scheduledDeliveryShipment,omitempty"`

	// Total tax details for the line item.
	TaxDetails *TaxItemDetails `json:"taxDetails,omitempty"`

	// Title for the item.
	Title string `json:"title,omitempty"`

	// The price to Amazon each (cost).
	TotalPrice *Money `json:"totalPrice,omitempty"`

	// The vendor selected product identification of the item.
	VendorProductIdentifier string `json:"vendorProductIdentifier,omitempty"`
}

type OrderItemAcknowledgement struct {

	// Details of quantity acknowledged with the above acknowledgement code.
	// Required: true
	AcknowledgedQuantity *ItemQuantity `json:"acknowledgedQuantity"`

	// Buyer's standard identification number (ASIN) of an item.
	BuyerProductIdentifier string `json:"buyerProductIdentifier,omitempty"`

	// Line item sequence number for the item.
	// Required: true
	ItemSequenceNumber *string `json:"itemSequenceNumber"`

	// The vendor selected product identification of the item. Should be the same as was provided in the purchase order.
	VendorProductIdentifier string `json:"vendorProductIdentifier,omitempty"`
}

type OrderList struct {

	// orders
	Orders []*Order `json:"orders"`

	// pagination
	Pagination *Pagination `json:"pagination,omitempty"`
}

type Pagination struct {

	// A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return.
	NextToken string `json:"nextToken,omitempty"`
}

type PartyIdentification struct {

	// Address details of the party.
	Address *Address `json:"address,omitempty"`

	// Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details.
	// Required: true
	PartyID *string `json:"partyId"`

	// Tax registration details of the entity.
	TaxInfo *TaxRegistrationDetails `json:"taxInfo,omitempty"`
}

type ScheduledDeliveryShipment struct {

	// Earliest nominated delivery date for the scheduled delivery.
	// Format: date-time
	EarliestNominatedDeliveryDate strfmt.DateTime `json:"earliestNominatedDeliveryDate,omitempty"`

	// Latest nominated delivery date for the scheduled delivery.
	// Format: date-time
	LatestNominatedDeliveryDate strfmt.DateTime `json:"latestNominatedDeliveryDate,omitempty"`

	// Scheduled delivery service type.
	ScheduledDeliveryServiceType string `json:"scheduledDeliveryServiceType,omitempty"`
}

type ShipmentDates struct {

	// Delivery date promised to the Amazon customer.
	// Format: date-time
	PromisedDeliveryDate strfmt.DateTime `json:"promisedDeliveryDate,omitempty"`

	// Time by which the vendor is required to ship the order.
	// Required: true
	// Format: date-time
	RequiredShipDate *strfmt.DateTime `json:"requiredShipDate"`
}

type ShipmentDetails struct {

	// When true, the order contain a gift. Include the gift message and gift wrap information.
	IsGift bool `json:"isGift,omitempty"`

	// When true, this is a priority shipment.
	// Required: true
	IsPriorityShipment *bool `json:"isPriorityShipment"`

	// When true, a packing slip is required to be sent to the customer.
	// Required: true
	IsPslipRequired *bool `json:"isPslipRequired"`

	// When true, this order is part of a scheduled delivery program.
	IsScheduledDeliveryShipment bool `json:"isScheduledDeliveryShipment,omitempty"`

	// Message to customer for order status.
	// Required: true
	MessageToCustomer *string `json:"messageToCustomer"`

	// Ship method to be used for shipping the order. Amazon defines ship method codes indicating the shipping carrier and shipment service level. To see the full list of ship methods in use, including both the code and the friendly name, search the 'Help' section on Vendor Central for 'ship methods'.
	// Required: true
	ShipMethod *string `json:"shipMethod"`

	// shipment dates
	// Required: true
	ShipmentDates *ShipmentDates `json:"shipmentDates"`
}

type SubmitAcknowledgementRequest struct {

	// A list of one or more purchase orders.
	OrderAcknowledgements []*OrderAcknowledgementItem `json:"orderAcknowledgements"`
}

type SubmitAcknowledgementResponse struct {

	// errors
	Errors *ErrorList `json:"errors,omitempty"`

	// The payload for the submitAcknowledgement operation.
	Payload *TransactionID `json:"payload,omitempty"`
}

type TaxDetails struct {

	// tax amount
	// Required: true
	TaxAmount *Money `json:"taxAmount"`

	// tax rate
	TaxRate Decimal `json:"taxRate,omitempty"`

	// taxable amount
	TaxableAmount *Money `json:"taxableAmount,omitempty"`

	// Tax type.
	// Enum: [CONSUMPTION GST MwSt. PST TOTAL TVA VAT]
	Type string `json:"type,omitempty"`
}

type TaxItemDetails struct {

	// Tax details.
	TaxLineItem TaxLineItem `json:"taxLineItem,omitempty"`
}

type TaxLineItem []*TaxDetails

type TaxRegistrationDetails struct {

	// Address associated with the tax registration number.
	TaxRegistrationAddress *Address `json:"taxRegistrationAddress,omitempty"`

	// Tax registration message that can be used for additional tax related details.
	TaxRegistrationMessages string `json:"taxRegistrationMessages,omitempty"`

	// Tax registration number for the party. For example, VAT ID.
	// Required: true
	TaxRegistrationNumber *string `json:"taxRegistrationNumber"`

	// Tax registration type for the entity.
	// Enum: [VAT GST]
	TaxRegistrationType string `json:"taxRegistrationType,omitempty"`
}

type TransactionID struct {

	// GUID assigned by Amazon to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.
	TransactionID string `json:"transactionId,omitempty"`
}