Module: Peddler::Types::VendorDirectFulfillmentInventoryV1

Defined in:

lib/peddler/types/vendor_direct_fulfillment_inventory_v1/error.rb,
lib/peddler/types/vendor_direct_fulfillment_inventory_v1/item_details.rb,
lib/peddler/types/vendor_direct_fulfillment_inventory_v1/item_quantity.rb,
lib/peddler/types/vendor_direct_fulfillment_inventory_v1/inventory_update.rb,
lib/peddler/types/vendor_direct_fulfillment_inventory_v1/party_identification.rb,
lib/peddler/types/vendor_direct_fulfillment_inventory_v1/transaction_reference.rb,
lib/peddler/types/vendor_direct_fulfillment_inventory_v1/submit_inventory_update_request.rb,
lib/peddler/types/vendor_direct_fulfillment_inventory_v1/submit_inventory_update_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

ItemDetails =

Updated inventory details for an item.

Structure.new do
  # @return [String] The buyer selected product identification of the item. Either buyerProductIdentifier or
  # vendorProductIdentifier should be submitted.
  attribute(:buyer_product_identifier, String, from: "buyerProductIdentifier")

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

  # @return [ItemQuantity] Total item quantity available in the warehouse.
  attribute(:available_quantity, ItemQuantity, from: "availableQuantity")

  # @return [:boolean] When true, the item is permanently unavailable.
  attribute(:obsolete, :boolean, from: "isObsolete")
end

ItemQuantity =

Details of item quantity.

Structure.new do
  # @return [Integer] Quantity of units available for a specific item.
  attribute(:amount, Integer)

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

InventoryUpdate =

Inventory details required to update some or all items for the requested warehouse.

Structure.new do
  # @return [PartyIdentification] ID of the selling party or vendor.
  attribute(:selling_party, PartyIdentification, from: "sellingParty")

  # @return [:boolean] When true, this request contains a full feed. Otherwise, this request contains a partial
  # feed. When sending a full feed, you must send information about all items in the warehouse. Any items not in
  # the full feed are updated as not available. When sending a partial feed, only include the items that need an
  # update to inventory. The status of other items will remain unchanged.
  attribute(:full_update, :boolean, from: "isFullUpdate")

  # @return [Array<ItemDetails>] A list of inventory items with updated details, including quantity available.
  attribute(:items, [ItemDetails])
end

PartyIdentification =

Name, address and tax details of a party.

Structure.new do
  # @return [String] Assigned identification for the party.
  attribute(:party_id, String, from: "partyId")
end

TransactionReference =

Response containing the transaction ID.

Structure.new do
  # @return [String] GUID 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

SubmitInventoryUpdateRequest =

The request body for the submitInventoryUpdate operation.

Structure.new do
  # @return [InventoryUpdate] Inventory details required to update some or all items for the requested warehouse.
  attribute(:inventory, InventoryUpdate)
end

SubmitInventoryUpdateResponse =

The response schema for the submitInventoryUpdate operation.

Structure.new do
  # @return [TransactionReference] The response payload for the submitInventoryUpdate operation.
  attribute(:payload, TransactionReference)

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