Veeqo

gem "veeqo"

Veeqo.configure do |config|
  config.api_key = "SECRET_API_KEY"
end

Veeqo.configuration.api_key = "SECRET_API_KEY"

Veeqo::Order.list(
  page: 1,
  page_size: 25,
  since_id: since_id,
  status: "awaiting_fulfillment",
  created_at_min: "2017-01-01 11:10:01",
  updated_at_min: "2017-01-01 11:10:01",
)

# Create a new order for customer
#
# Please pay close attention to the argumetns construction.
# Some attrbitues require some nested attributes, that's why
# we've extracted those to make it easier to understand, but
# you don't have to do it unelss you prefer a clean code :)

Veeqo::Order.create(
  channel_id: store_id,
  customer_id: customer_id,
  delivery_method_id: deliver_method_id,
  deliver_to_id: deliver_to_id,
  total_discounts: 0,
  total_tax: 0,
  due_date: "",
  send_notification_email: false,
  deliver_to_attributes: deliver_to_attributes,
  line_items_attributes: [line_item_one_attributes]
  payment_attributes: payment_attributes,
)

# Delivery Attributes
#
# This includes the details attributes to specify the
# delivery details for that specific order.

deliver_to_attributes = {
  address1: "294 queenstown road",
  address2: "",
  city: "london",
  company: "",
  country: "GB",
  customer_id: customer_id,
  first_name: "Sky",
  last_name: "Schonhuber",
  phone: "07734450718",
  state: "london",
  zip: "sw8 4lt",
}

# Line Item Attributes
#
# This includes the details about a specific
# Line items for the new order

line_item_one_attributes = {
  price_per_unit: 13.99,
  quantity: "1",
  sellable_id: 1226615,
  tax_rate: 0
}

# Payment Attributes
#
# Include the payment details with the order

payment_attributes = {
  payment_type: "bank_transfer",
  reference_number: "123456789",
}

Veeqo::Order.find(order_id)

Veeqo::Order.update(order_id, new_attributes)

Veeqo::Order.delete(order_id)

Veeqo::Allocation.create(
  order_id: 123_456,
  warehouse_id: 456_789,
  line_items: [{
    quantity: 1,
    sellable_id: 123_456,
  }],
)

Veeqo::Allocation.update(
  allocation_id,
  order_id: 123_456,
  warehouse_id: 456_789,
  line_items: [{
    quantity: 2,
    sellable_id: 123_456,
  }],
)

Veeqo::Allocation.delete(order_id, allocation_id)

Veeqo::Product.list(
  since_id: 123_45, page: 1, page_size: 12
)

# Create a new product
#
# Pay close attension to the argument constructions. It
# simlify the process, and the `variants` and `images`
# supports mutiple item, and we can pass those as an
# array, please check the example bellow for inspiration

Veeqo::Product.create(
  title: "T Shirt",
  description: "The best t-shirt!",
  estimated_delivery: 3,
  notes: "This is a limited addtion!",
  variants: [variant_one_attributes],
  images: [image_one_attributes],
)

# Variant attributes
variant_one_attributes = {
  cost_price: "10",
  min_reorder_level: "0",
  price: "15",
  quantity_to_reorder: "0",
  sku_code: "t-shirt-large",
  tax_rate: "0",
  title: "Large",
}

# Image attributes
image_one_attributes = {
  display_position: "1"
  src: "http://veeqo.com/t-shirt.jpg",
}

Veeqo::Product.find(product_id)

Veeqo::Product.update(product_id, new_attributes)

Veeqo::Product.delete(product_id)

Veeqo::PurchaseOrder.list(
  page: 1, page_size: 12, show_complete: false
)

Veeqo::Supplier.list(page: 1, page_size: 12)

Veeqo::Supplier.create(name: "ACME")

Veeqo::Supplier.find(supplier_id)

Veeqo::Supplier.update(supplier_id, new_attributes_hash)

Veeqo::Supplier.delete(supplier_id)

Veeqo::Company.find

Veeqo::Company.update(new_attributes_hash)

Veeqo::Warehouse.list(page: 1, page_size: 12)

Veeqo::Warehouse.create(name: "My Warehouse")

Veeqo::Warehouse.find(warehouse_id)

Veeqo::Warehouse.update(warehouse_id, new_attributes_hash)

Veeqo::Warehouse.delete(warehouse_id)

Veeqo::Customer.list(page: 1, page_size: 12)

Veeqo::Customer.create(
  email: "customer@example.com",
  phone: "01792 720740",
  mobile: "07329023903",
  billing_address_attributes: {
    first_name: "John",
    last_name: "Doe",
    company: "FooBar Ltd",
    address1: "221 High Street Lane",
    city: "Swansea",
    country: "GB",
    zip: "SA1 1NW",
  }
)

Veeqo::Customer.find(customer_id)

Veeqo::Customer.update(
  customer_id, new_attributes_hash
)

Veeqo::Customer.delete(customer_id)

Veeqo::Store.list(page: 1, page_size: 12)

Veeqo::Store.create(name: "Phone", type_code: "direct")

Veeqo::Store.find(store_id)

Veeqo::Store.update(store_id, new_attributes_hash)

Veeqo::Store.delete(store_id)

Veeqo::DeliveryMethod.list(page: 1, page_size: 12)

Veeqo::DeliveryMethod.create(name: "Next Day Delivery")

Veeqo::DeliveryMethod.find(delivery_method_id)

Veeqo::DeliveryMethod.update(delivery_method_id, new_attributes_hash)

Veeqo::DeliveryMethod.delete(delivery_method_id)

# Create a new shipment
#
# Please pay close attention to the construciton of
# the arugments, This simplified some attrbitues, so
# the developer does not need to worry about the too
# much details on how it needs to structured.

Veeqo::Shipment.create(
  order_id: 1,
  allocation_id: 1,
  shipment: {
    carrier_id: 3,
    notify_customer: false,
    update_remote_order: false,
    tracking_number: "12345679ABC",
  },
)

Veeqo::Tag.list

Veeqo::Shipment.delete(shipment_id)

Veeqo::Order.list