Module: Peddler::Types::ShipmentInvoicingV0

Defined in:

lib/peddler/types/shipment_invoicing_v0/error.rb,
lib/peddler/types/shipment_invoicing_v0/address.rb,
lib/peddler/types/shipment_invoicing_v0/shipment_item.rb,
lib/peddler/types/shipment_invoicing_v0/buyer_tax_info.rb,
lib/peddler/types/shipment_invoicing_v0/shipment_detail.rb,
lib/peddler/types/shipment_invoicing_v0/tax_classification.rb,
lib/peddler/types/shipment_invoicing_v0/payment_information.rb,
lib/peddler/types/shipment_invoicing_v0/marketplace_tax_info.rb,
lib/peddler/types/shipment_invoicing_v0/submit_invoice_request.rb,
lib/peddler/types/shipment_invoicing_v0/submit_invoice_response.rb,
lib/peddler/types/shipment_invoicing_v0/get_invoice_status_response.rb,
lib/peddler/types/shipment_invoicing_v0/shipment_invoice_status_info.rb,
lib/peddler/types/shipment_invoicing_v0/get_shipment_details_response.rb,
lib/peddler/types/shipment_invoicing_v0/shipment_invoice_status_response.rb

Constant Summary

Error =

An 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

Address =

The shipping address details of the shipment.

Structure.new do
  # @return [String] The name.
  attribute(:name, String, from: "Name")

  # @return [String] The street address.
  attribute(:address_line1, String, from: "AddressLine1")

  # @return [String] Additional street address information, if required.
  attribute(:address_line2, String, from: "AddressLine2")

  # @return [String] Additional street address information, if required.
  attribute(:address_line3, String, from: "AddressLine3")

  # @return [String] The city.
  attribute(:city, String, from: "City")

  # @return [String] The county.
  attribute(:county, String, from: "County")

  # @return [String] The district.
  attribute(:district, String, from: "District")

  # @return [String] The state or region.
  attribute(:state_or_region, String, from: "StateOrRegion")

  # @return [String] The postal code.
  attribute(:postal_code, String, from: "PostalCode")

  # @return [String] The country code.
  attribute(:country_code, String, from: "CountryCode")

  # @return [String] The phone number.
  attribute(:phone, String, from: "Phone")

  # @return [String]
  attribute(:address_type, String, from: "AddressType")
end

ShipmentItem =

The shipment item information required by a seller to issue a shipment invoice.

Structure.new do
  # @return [String] The Amazon Standard Identification Number (ASIN) of the item.
  attribute(:asin, String, from: "ASIN")

  # @return [String] The seller SKU of the item.
  attribute(:seller_sku, String, from: "SellerSKU")

  # @return [String] The Amazon-defined identifier for the order item.
  attribute(:order_item_id, String, from: "OrderItemId")

  # @return [String] The name of the item.
  attribute(:title, String, from: "Title")

  # @return [Float] The number of items ordered.
  attribute(:quantity_ordered, Float, from: "QuantityOrdered")

  # @return [Money] The selling price of the item multiplied by the quantity ordered. Note that ItemPrice excludes
  # ShippingPrice and GiftWrapPrice.
  attribute(:item_price, Money, from: "ItemPrice")

  # @return [Money] The shipping price of the item.
  attribute(:shipping_price, Money, from: "ShippingPrice")

  # @return [Money] The gift wrap price of the item.
  attribute(:gift_wrap_price, Money, from: "GiftWrapPrice")

  # @return [Money] The discount on the shipping price.
  attribute(:shipping_discount, Money, from: "ShippingDiscount")

  # @return [Money] The total of all promotional discounts in the offer.
  attribute(:promotion_discount, Money, from: "PromotionDiscount")

  # @return [Array] The list of serial numbers.
  attribute(:serial_numbers, Array, from: "SerialNumbers")
end

BuyerTaxInfo =

Tax information about the buyer.

Structure.new do
  # @return [String] The legal name of the company.
  attribute(:company_legal_name, String, from: "CompanyLegalName")

  # @return [String] The country or region imposing the tax.
  attribute(:taxing_region, String, from: "TaxingRegion")

  # @return [Array<TaxClassification>]
  attribute(:tax_classifications, [TaxClassification], from: "TaxClassifications")
end

ShipmentDetail =

The information required by a selling partner to issue a shipment invoice.

Structure.new do
  # @return [String] The Amazon-defined identifier for the warehouse.
  attribute(:warehouse_id, String, from: "WarehouseId")

  # @return [String] The Amazon-defined identifier for the order.
  attribute(:amazon_order_id, String, from: "AmazonOrderId")

  # @return [String] The Amazon-defined identifier for the shipment.
  attribute(:amazon_shipment_id, String, from: "AmazonShipmentId")

  # @return [String] The date and time when the order was created.
  attribute(:purchase_date, String, from: "PurchaseDate")

  # @return [Address]
  attribute(:shipping_address, Address, from: "ShippingAddress")

  # @return [Array]
  attribute(:payment_method_details, Array, from: "PaymentMethodDetails")

  # @return [Array<PaymentInformation>]
  attribute(:payments, [PaymentInformation], from: "Payments")

  # @return [String] The identifier for the marketplace where the order was placed.
  attribute(:marketplace_id, String, from: "MarketplaceId")

  # @return [String] The seller identifier.
  attribute(:seller_id, String, from: "SellerId")

  # @return [String] The name of the buyer.
  attribute(:buyer_name, String, from: "BuyerName")

  # @return [String] The county of the buyer.
  attribute(:buyer_county, String, from: "BuyerCounty")

  # @return [BuyerTaxInfo]
  attribute(:buyer_tax_info, BuyerTaxInfo, from: "BuyerTaxInfo")

  # @return [MarketplaceTaxInfo]
  attribute(:marketplace_tax_info, MarketplaceTaxInfo, from: "MarketplaceTaxInfo")

  # @return [String] The seller’s friendly name registered in the marketplace.
  attribute(:seller_display_name, String, from: "SellerDisplayName")

  # @return [Array<ShipmentItem>]
  attribute(:shipment_items, [ShipmentItem], from: "ShipmentItems")
end

TaxClassification =

The tax classification for the entity.

Structure.new do
  # @return [String] The type of tax.
  attribute(:name, String, from: "Name")

  # @return [String] The entity's tax identifier.
  attribute(:value, String, from: "Value")
end

PaymentInformation =

Payment transaction information

Structure.new do
  # @return [String] Payment method name
  attribute(:payment_method, String, from: "PaymentMethod")

  # @return [String] Government ID of acquirer
  attribute(:acquirer_id, String, from: "AcquirerId")

  # @return [String] Credit card brand (if payment method is CreditCard)
  attribute(:card_brand, String, from: "CardBrand")

  # @return [Money] Amount paid in this payment
  attribute(:payment_value, Money, from: "PaymentValue")

  # @return [String] Authorization code for this payment
  attribute(:authorization_code, String, from: "AuthorizationCode")
end

MarketplaceTaxInfo =

Tax information about the marketplace.

Structure.new do
  # @return [String] The legal name of the company.
  attribute(:company_legal_name, String, from: "CompanyLegalName")

  # @return [String] The country or region imposing the tax.
  attribute(:taxing_region, String, from: "TaxingRegion")

  # @return [Array<TaxClassification>]
  attribute(:tax_classifications, [TaxClassification], from: "TaxClassifications")
end

SubmitInvoiceRequest =

The request schema for the submitInvoice operation.

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

  # @return [String] An Amazon marketplace identifier.
  attribute(:marketplace_id, String, from: "MarketplaceId")

  # @return [String] MD5 sum for validating the invoice data. For more information about calculating this value,
  # see [Working with Content-MD5
  # Checksums](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_MD5.html).
  attribute(:content_md5_value, String, from: "ContentMD5Value")
end

SubmitInvoiceResponse =

The response schema for the submitInvoice operation.

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

GetInvoiceStatusResponse =

The response schema for the getInvoiceStatus operation.

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

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

ShipmentInvoiceStatusInfo =

The shipment invoice status information.

Structure.new do
  # @return [String] The Amazon-defined shipment identifier.
  attribute(:amazon_shipment_id, String, from: "AmazonShipmentId")

  # @return [String]
  attribute(:invoice_status, String, from: "InvoiceStatus")
end

GetShipmentDetailsResponse =

The response schema for the getShipmentDetails operation.

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

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

ShipmentInvoiceStatusResponse =

The shipment invoice status response.

Structure.new do
  # @return [ShipmentInvoiceStatusInfo]
  attribute(:shipments, ShipmentInvoiceStatusInfo, from: "Shipments")
end