Module: Peddler::Types::VendorDirectFulfillmentOrdersV1

Defined in:

lib/peddler/types/vendor_direct_fulfillment_orders_v1/error.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/order.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/address.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/order_item.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/order_list.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/pagination.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/tax_details.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/gift_details.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/item_quantity.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/order_details.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/shipment_dates.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/transaction_id.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/shipment_details.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/get_order_response.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/get_orders_response.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/party_identification.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/acknowledgement_status.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/tax_registration_details.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/order_acknowledgement_item.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/order_item_acknowledgement.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/scheduled_delivery_shipment.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/submit_acknowledgement_request.rb,
lib/peddler/types/vendor_direct_fulfillment_orders_v1/submit_acknowledgement_response.rb

Constant Summary

Error =

Error response returned when the request is unsuccessful.

Structure.new do
  # @return [String] An error code that identifies the type of error that occurred.
  attribute(:code, String)

  # @return [String] A message that describes the error condition.
  attribute(:message, String)

  # @return [String] Additional details that can help the caller understand or fix the issue.
  attribute(:details, String)
end

Order =

Represents a purchase order.

Structure.new do
  # @return [String] The purchase order number for this order. Formatting Notes: alpha-numeric code.
  attribute(:purchase_order_number, String, from: "purchaseOrderNumber")

  # @return [OrderDetails] Purchase order details.
  attribute(:order_details, OrderDetails, from: "orderDetails")
end

Address =

Address of the party.

Structure.new do
  # @return [String] 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`.
  attribute(:name, String)

  # @return [String] 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`.
  attribute(:attention, String)

  # @return [String] First line of the address. For Amazon label only vendors, this field will have the value
  # `xxxxx` within the object `shipToParty`.
  attribute(:address_line1, String, from: "addressLine1")

  # @return [String] Additional address information, if required. For Amazon label only vendors, this field will
  # have the value `xxxxx` within the object `shipToParty`.
  attribute(:address_line2, String, from: "addressLine2")

  # @return [String] Additional address information, if required. For Amazon label only vendors, this field will
  # have the value `xxxxx` within the object `shipToParty`.
  attribute(:address_line3, String, from: "addressLine3")

  # @return [String] 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`.
  attribute(:city, String)

  # @return [String] 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`.
  attribute(:county, String)

  # @return [String] 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`.
  attribute(:district, String)

  # @return [String] The state or region where person, business or institution is located.
  attribute(:state_or_region, String, from: "stateOrRegion")

  # @return [String] The postal code of that address. It conatins a series of letters or digits or both, sometimes
  # including spaces or punctuation.
  attribute(:postal_code, String, from: "postalCode")

  # @return [String] The two digit country code. In ISO 3166-1 alpha-2 format.
  attribute(:country_code, String, from: "countryCode")

  # @return [String] 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`.
  attribute(:phone, String)
end

OrderItem =

An item within an order

Structure.new do
  # @return [String] Numbering of the item on the purchase order. The first item will be 1, the second 2, and so
  # on.
  attribute(:item_sequence_number, String, from: "itemSequenceNumber")

  # @return [String] Buyer's standard identification number (ASIN) of an item.
  attribute(:buyer_product_identifier, String, from: "buyerProductIdentifier")

  # @return [String] The vendor selected product identification of the item.
  attribute(:vendor_product_identifier, String, from: "vendorProductIdentifier")

  # @return [String] Title for the item.
  attribute(:title, String)

  # @return [ItemQuantity] Item quantity ordered.
  attribute(:ordered_quantity, ItemQuantity, from: "orderedQuantity")

  # @return [ScheduledDeliveryShipment] Details for the scheduled delivery shipment.
  attribute(:scheduled_delivery_shipment, ScheduledDeliveryShipment, from: "scheduledDeliveryShipment")

  # @return [GiftDetails] Gift message and wrapId details.
  attribute(:gift_details, GiftDetails, from: "giftDetails")

  # @return [Money] Net price (before tax) to vendor with currency details.
  attribute(:net_price, Money, from: "netPrice")

  # @return [Hash] Total tax details for the line item.
  attribute(:tax_details, Hash, from: "taxDetails")

  # @return [Money] The price to Amazon each (cost).
  attribute(:total_price, Money, from: "totalPrice")
end

OrderList =

A list of purchase orders returned as response.

Structure.new do
  # @return [Pagination] The pagination elements required to retrieve the remaining data.
  attribute(:pagination, Pagination)

  # @return [Array<Order>] Represents a purchase order within the OrderList.
  attribute(:orders, [Order])
end

Pagination =

The pagination elements required to retrieve the remaining data.

Structure.new do
  # @return [String] 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.
  attribute(:next_token, String, from: "nextToken")
end

TaxDetails =

The tax details for the order. Note: Amazon calculates tax on the list price (Amazon retail price).

Structure.new do
  # @return [String]
  attribute(:tax_rate, String, from: "taxRate")

  # @return [Money]
  attribute(:tax_amount, Money, from: "taxAmount")

  # @return [Money]
  attribute(:taxable_amount, Money, from: "taxableAmount")

  # @return [String] Tax type.
  attribute(:type, String)
end

GiftDetails =

Gift details for the item.

Structure.new do
  # @return [String] Gift message to be printed in shipment.
  attribute(:gift_message, String, from: "giftMessage")

  # @return [String] Gift wrap identifier for the gift wrapping, if any.
  attribute(:gift_wrap_id, String, from: "giftWrapId")
end

ItemQuantity =

Details of quantity ordered.

Structure.new do
  # @return [Integer] Acknowledged quantity. This value should not be zero.
  attribute(:amount, Integer)

  # @return [String] Unit of measure for the acknowledged quantity.
  attribute(:unit_of_measure, String, from: "unitOfMeasure")
end

OrderDetails =

Details of an order.

Structure.new do
  # @return [String] The customer order number.
  attribute(:customer_order_number, String, from: "customerOrderNumber")

  # @return [String] 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.
  attribute(:order_date, String, from: "orderDate")

  # @return [String] Current status of the order.
  attribute(:order_status, String, from: "orderStatus")

  # @return [ShipmentDetails]
  attribute(:shipment_details, ShipmentDetails, from: "shipmentDetails")

  # @return [Hash] The total Tax object within shipment that relates to the order.
  attribute(:tax_total, Hash, from: "taxTotal")

  # @return [PartyIdentification] PartyID of vendor code.
  attribute(:selling_party, PartyIdentification, from: "sellingParty")

  # @return [PartyIdentification] PartyID of vendor's warehouse.
  attribute(:ship_from_party, PartyIdentification, from: "shipFromParty")

  # @return [Address] Name/Address and tax details of the ship to party.
  attribute(:ship_to_party, Address, from: "shipToParty")

  # @return [PartyIdentification] Name/Address and tax details of the bill to party.
  attribute(:bill_to_party, PartyIdentification, from: "billToParty")

  # @return [Array<OrderItem>] A list of items in this purchase order.
  attribute(:items, [OrderItem])
end

ShipmentDates =

Shipment dates.

Structure.new do
  # @return [String] Time by which the vendor is required to ship the order.
  attribute(:required_ship_date, String, from: "requiredShipDate")

  # @return [String] Delivery date promised to the Amazon customer.
  attribute(:promised_delivery_date, String, from: "promisedDeliveryDate")
end

TransactionId =

Response containing the transaction ID.

Structure.new do
  # @return [String] 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.
  attribute(:transaction_id, String, from: "transactionId")
end

ShipmentDetails =

Shipment details required for the shipment.

Structure.new do
  # @return [:boolean] When true, this is a priority shipment.
  attribute(:priority_shipment, :boolean, from: "isPriorityShipment")

  # @return [:boolean] When true, this order is part of a scheduled delivery program.
  attribute(:scheduled_delivery_shipment, :boolean, from: "isScheduledDeliveryShipment")

  # @return [:boolean] When true, a packing slip is required to be sent to the customer.
  attribute(:pslip_required, :boolean, from: "isPslipRequired")

  # @return [:boolean] When true, the order contain a gift. Include the gift message and gift wrap information.
  attribute(:gift, :boolean, from: "isGift")

  # @return [String] 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'.
  attribute(:ship_method, String, from: "shipMethod")

  # @return [ShipmentDates]
  attribute(:shipment_dates, ShipmentDates, from: "shipmentDates")

  # @return [String] Message to customer for order status.
  attribute(:message_to_customer, String, from: "messageToCustomer")
end

GetOrderResponse =

The response schema for the getOrder operation.

Structure.new do
  # @return [Order] The payload for the getOrder operation.
  attribute(:payload, Order)

  # @return [Array<Error>]
  attribute(:errors, [Error])
end

GetOrdersResponse =

The response schema for the getOrders operation.

Structure.new do
  # @return [OrderList] A list of purchase orders.
  attribute(:payload, OrderList)

  # @return [Array<Error>]
  attribute(:errors, [Error])
end

PartyIdentification =

Name, address and tax details of a party.

Structure.new do
  # @return [String] Assigned identification for the party. For example, warehouse code or vendor code. Please
  # refer to specific party for more details.
  attribute(:party_id, String, from: "partyId")

  # @return [Address] Address details of the party.
  attribute(:address, Address)

  # @return [TaxRegistrationDetails] Tax registration details of the entity.
  attribute(:tax_info, TaxRegistrationDetails, from: "taxInfo")
end

AcknowledgementStatus =

Status of acknowledgement.

Structure.new do
  # @return [String] 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.
  attribute(:code, String)

  # @return [String] Reason for the acknowledgement code.
  attribute(:description, String)
end

TaxRegistrationDetails =

Tax registration details of the entity.

Structure.new do
  # @return [String] Tax registration type for the entity.
  attribute(:tax_registration_type, String, from: "taxRegistrationType")

  # @return [String] Tax registration number for the party. For example, VAT ID.
  attribute(:tax_registration_number, String, from: "taxRegistrationNumber")

  # @return [Address] Address associated with the tax registration number.
  attribute(:tax_registration_address, Address, from: "taxRegistrationAddress")

  # @return [String] Tax registration message that can be used for additional tax related details.
  attribute(:tax_registration_messages, String, from: "taxRegistrationMessages")
end

OrderAcknowledgementItem =

Details of an individual order being acknowledged.

Structure.new do
  # @return [String] The purchase order number for this order. Formatting Notes: alpha-numeric code.
  attribute(:purchase_order_number, String, from: "purchaseOrderNumber")

  # @return [String] The vendor's order number for this order.
  attribute(:vendor_order_number, String, from: "vendorOrderNumber")

  # @return [String] 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.
  attribute(:acknowledgement_date, String, from: "acknowledgementDate")

  # @return [AcknowledgementStatus] Status of acknowledgement.
  attribute(:acknowledgement_status, AcknowledgementStatus, from: "acknowledgementStatus")

  # @return [PartyIdentification] PartyID as vendor code.
  attribute(:selling_party, PartyIdentification, from: "sellingParty")

  # @return [PartyIdentification] PartyID as the vendor's warehouseId.
  attribute(:ship_from_party, PartyIdentification, from: "shipFromParty")

  # @return [Array<OrderItemAcknowledgement>] Item details including acknowledged quantity.
  attribute(:item_acknowledgements, [OrderItemAcknowledgement], from: "itemAcknowledgements")
end

OrderItemAcknowledgement =

Details of an individual item within the order being acknowledged.

Structure.new do
  # @return [String] Line item sequence number for the item.
  attribute(:item_sequence_number, String, from: "itemSequenceNumber")

  # @return [String] Buyer's standard identification number (ASIN) of an item.
  attribute(:buyer_product_identifier, String, from: "buyerProductIdentifier")

  # @return [String] The vendor selected product identification of the item. Should be the same as was provided in
  # the purchase order.
  attribute(:vendor_product_identifier, String, from: "vendorProductIdentifier")

  # @return [ItemQuantity] Details of quantity acknowledged with the above acknowledgement code.
  attribute(:acknowledged_quantity, ItemQuantity, from: "acknowledgedQuantity")
end

ScheduledDeliveryShipment =

Dates for the scheduled delivery shipments.

Structure.new do
  # @return [String] Scheduled delivery service type.
  attribute(:scheduled_delivery_service_type, String, from: "scheduledDeliveryServiceType")

  # @return [String] Earliest nominated delivery date for the scheduled delivery.
  attribute(:earliest_nominated_delivery_date, String, from: "earliestNominatedDeliveryDate")

  # @return [String] Latest nominated delivery date for the scheduled delivery.
  attribute(:latest_nominated_delivery_date, String, from: "latestNominatedDeliveryDate")
end

SubmitAcknowledgementRequest =

The request schema for the submitAcknowledgement operation.

Structure.new do
  # @return [Array<OrderAcknowledgementItem>] A list of one or more purchase orders.
  attribute(:order_acknowledgements, [OrderAcknowledgementItem], from: "orderAcknowledgements")
end

SubmitAcknowledgementResponse =

The response schema for the submitAcknowledgement operation.

Structure.new do
  # @return [TransactionId] The payload for the submitAcknowledgement operation.
  attribute(:payload, TransactionId)

  # @return [Array<Error>]
  attribute(:errors, [Error])
end