User Tools

Site Tools


udropship:batch:reference

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
udropship:batch:reference [2010/08/05 05:08]
unirgy
udropship:batch:reference [2021/12/29 13:56] (current)
wtsergo [Import Products]
Line 1: Line 1:
 +====== uDropshipBatch configuration reference ======
  
 +===== Templates =====
 +
 +==== Export Orders ====
 +
 +=== Format ===
 +
 +The fields can be used in:
 +  * simple format, using square brackets: <code>[order.increment_id]</code> or 
 +  * advanced format, using Magento CMS templating conventions: <code>{{var order.store.code}}</code>
 +
 +=== Fields ===
 +
 +^ Field ^ Notes ^ Shortcuts ^ Data Examples ^
 +| order.increment_id | | [order_id] | | 
 +| order.created_at | | | | 
 +| order.subtotal | | | |
 +| order.grand_total | | | | 
 +| order.store.code | Available only as advanced format | | |
 +| order.store.name | Available only as advanced format | | |
 +| order.customer_id | | | | 
 +| billing.prefix | | | | 
 +| billing.firstname | | | | 
 +| billing.middlename | | | | 
 +| billing.lastname | | | | 
 +| billing.suffix | | | |
 +| billing.company | | | | 
 +| billing.street | | | | 
 +| billing.city | | | | 
 +| billing.region | | | California | 
 +| billing.region_code | Available only as advanced format | | CA |
 +| billing.postcode | | | | 
 +| billing.country_id | | | | 
 +| billing.telephone | | | | 
 +| billing.fax | | | | 
 +| shipping.* | Same as billing.* | | | 
 +| po.increment_id | | [po_id] | | 
 +| po.created_at | | | |
 +| po.udropship_method | Shipping method | | ups_03 |
 +| item.sku | | | |
 +| item.name | | | |
 +| item.weight | | | |
 +| item.price | | | |
 +| item.qty | | | |
 +| product_options | Custom product options of the order item | | Option 1: Value 1; Option 2: Value 2 |
 +
 +=== Examples ===
 +
 +== Sample Vendor 1 ==
 +Header:
 +<code>
 +PO#    Account#    Shipper    Name    Address    Delivery     city    State    Zip    sku    quantity
 +</code>
 +Template:
 +<code>
 +[po_id] spfoxx UPS "[shipping.firstname] [shipping.lastname]" "[shipping.street]" residential "[shipping.city]" "{{var shipping.region_code}}" "[shipping.postcode]" "[item.sku]" "[item.qty]"
 +</code>
 +Output:
 +<code>
 +PO#    Account#    Shipper    Name    Address    Delivery    city    State    Zip    sku    quantity
 +198625 spfoxx UPS "NATE smith" "6666 MASSEY ST" residential DECATUR MS 88888 OP-TRPL-sdt 1
 +199097 spfoxx UPS "PAT DJohnson" "5555 WINDWARD" residential MASSILLON TX 47890 jh-ST-20-nhjo 1
 +</code>
 +
 +== Sample Vendor 2 ==
 +Template:
 +<code>
 +H 401950 [order.created_at] [po_id]  [shipping.firstname] [shipping.lastname] [shipping.street]  [shipping.city] {{var shipping.region_code}} [shipping.postcode] [shipping.telephone] GROUND PO1 [item.qty] [item.price] [item.name] [product.description]
 +</code>
 +Output:
 +<code>
 +H 401950 2009456 199166 20091127   DONNA GEAD 9999 ALVIN RD  CHARLOTTE CA 37589 492-222-2222 GROUND PO1 2 18.9 g5987  g5987-7  WINE GLASSES - SET OF TWO 14oz WINE GLASSES
 +H 401950 2009456 199236 20091127   ALMA STAY 8888 POPPY LANE  Los Angeles CA 95123 555-111-2222 GROUND PO1 1 15 GSHFS4-13  GSHFS4-13  16oz PINT ALE GLASSES  - SET OF TWO
 +</code>
 +
 +== Sample UPS WorldShip Integration ==
 +Header:
 +<code>
 +"Residential","country","ShipFNameLname","ShipLName","Shipcompany","ShipAddr","ShipCity","ShipState","ShipZip","OrderNumber","ShipPhone","Reference1","Reference2" Quantity SKU Name
 +</code>
 +Template:
 +<code>
 +"y","[shipping.country_id]","[order_id]"[shipping.firstname][shipping.lastname]","[shipping.lastname]","[shipping.company]","[shipping.street]","[shipping.city]","{{var shipping.region_code}}","[shipping.postcode]","[order_id]","[shipping.telephone]","[order_id]","[po_id]" [item.qty] [item.sku] [item.name]
 +</code>
 +
 +==== Import Orders ====
 +
 +=== Format ===
 +
 +The import template consists of 1 line, and will be used for order of fields and separator. 
 +The separator between 1st and 2nd columns will be used for all fields.
 +The separator can be a space (multiple spaces will be ignored), tab, or other symbol (comma, semicolon, pipe, etc).
 +The fields in imported file can be enclosed in double quotes.
 +
 +=== Fields === 
 +
 +^ Field ^ Required ^ Example ^ Description ^
 +| order_id | Yes* | 1000001 | order_id or po_id has to present, but not both |
 +| po_id | Yes* | 1000001-1 | |
 +| tracking_id | Yes | 1Z1234567890123456 | |
 +| shipping_date | | 2010-04-01 | If not supplied, today's date will be used |
 +| carrier | | ups | Valid values: custom, ups, usps, fedex, dhl |
 +| title | | Some Custom Carrier | Free value title of the shipping method |
 +
 +=== Examples ===
 +
 +== Sample Vendor 1 ==
 +Template:
 +<code>
 +[po_id]  [tracking_id]  [shipping_date]
 +</code>
 +
 +Input file:
 +<code>
 +10000001-1 1Z1234567890123456 2010-04-01
 +10000002-1 1Z2345678901234567 2010-04-02
 +</code>
 +
 +== Sample Vendor 2 ==
 +
 +Template:
 +<code>
 +[order_id];[tracking_id]
 +</code>
 +
 +Input file:
 +<code>
 +10000001;1Z1234567890123456
 +10000002;1Z2345678901234567
 +</code>
 +
 +==== Import Inventory ====
 +
 +=== Format ===
 +
 +same as for Import Orders
 +
 +=== Fields === 
 +
 +^ Field ^ Required ^ Example ^ Description ^
 +| sku | Yes* | zol_g_med  | sku or vendor_sku has to present, this required to find correct product |
 +| vendor_sku | Yes* | zol_g_med-vendor1 | |
 +| stock_qty | | 10 | | new stock qty value
 +| stock_qty_add | | 3 | | stock qty could be incremented/decremented instead of set as in prev fielf
 +| vendor_cost | | 99.95 | supported if using multivendor add-on |
 +| stock_status | | 0 or 1 for "out of stock" or "in stock" | supported if NOT using multivendor add-on |
 +| status | | 0, 1, -1 for "inactive", "active", "pending" | status of vendor offer in multivendor data |
 +| priority | | any numeric value | third parameter to check in decision method (after in stock and stock qty) |
 +
 +=== Price Comparison add-on specific Fields === 
 +
 +^ Field ^ Required ^ Example ^ Description ^
 +| vendor_price |  | 19.99 | vendor offer price |
 +| special_price |  | 17.99 | vendor offer special price during special from/to date range |
 +| special_from_date | | 2015-05-01 | special price starting date |
 +| special_to_date | | 2015-05-11 | special price ending date |
 +| state | | New | offer state/condition defined in global/udropship/product_state config.xml node |
 +| state_descr | | any text | state/condition detailed description |
 +| vendor_title | | any text | promo title that will be included in offers table on product view page |
 +
 +=== Examples ===
 +
 +== Sample Vendor 1 ==
 +Template:
 +<code>
 +[sku]  [vendor_sku]  [stock_qty]
 +</code>
 +
 +Input file:
 +<code>
 +zol_g_med zol_g_med-vendor1 10
 +</code>
 +
 +== Sample Vendor 2 ==
 +
 +Template:
 +<code>
 +[vendor_sku];[stock_qty_add]
 +</code>
 +
 +Input file:
 +<code>
 +zol_g_med-vendor2;3
 +</code>
 +
 +=== Import new vendor/product associations ===
 +
 +New vendor/product associations you can import only from admin area \\
 +''//Sales > Dropship > Batches import/export > Batches > Create Inventory Import Batch//'' \\
 +Also you need to set "Yes" in \\
 +''//Configuration > Drop Shipping > Orders Batch Options > Allow import new vendor/product association with inventory import//''
 +Also if you do import of big files you might consider turn off logs, i.e. set "No" in \\
 +''//Configuration > Drop Shipping > Orders Batch Options > Save inventory import data in batch//''
 +
 +==== Import Products ====
 +This corresponds to //**vendor edit > preferences > Batch Products Import**// section.\\
 +All settings here are similar to //**Import Orders**// and //**Import Inventory**// except that it misses ''Import Template'' configuration.\\
 +The expected import file format depends on your setup in //**Configuration > Vendor Products Edit > Vendor Product Edit Form > Fieldsets**//. To get the template or the example file visit vendor portal ''Product Bulk Upload Single'' menu item where you can download them.\\
 +In case you import products from shopify using our ''Unirgy_Shopify'' module use ''<nowiki>shopify://*</nowiki>'' as value for //**Import Products Source Location**// setting.
 +
 +
 +===== Source/Destination Locations =====
 +
 +==== Local File ====
 +
 +At this time, for security purposes, file writing is allowed only into Magento's media/ or var/ folders and subfolders.
 +
 +=== Examples ===
 +
 +<code>
 +var/export/orders.txt
 +</code>
 +
 +==== Remote FTP ====
 +
 +=== Examples ===
 +
 +<code>
 +ftp://username:password@vendor.server.com/path/to/orders.txt
 +</code>
 +
 +==== Remote HTTP ====
 +
 +**Only for importing**
 +
 +=== Examples ===
 +
 +<code>
 +http://username:password@vendor.server.com/path/to/orders.txt
 +</code>
 +
 +==== Email attachment ====
 +
 +**Only for exporting**
 +
 +=== Examples ===
 +
 +<code>
 +mailto:autoprocess@vendor.server.com?from=admin@sample.store.com&subject=Orders export from sample store&body=Please find orders attached&filename=orders.txt
 +</code>
 +
 +If filename is "-" or empty, the exported orders will be set as email body.
 +<code>
 +mailto:autoprocess@vendor.server.com?from=admin@sample.store.com&subject=Orders export from sample store&filename=-
 +</code>
 +
 +Add single or multiple CC or BCC:
 +<code>
 +mailto:autoprocess@vendor.server.com?from=admin@sample.store.com&subject=Orders export from sample store&cc=track@sample.store.com&bcc[]=bcc1@store.com&bcc[]=bcc2@store.com&filename=-
 +</code>
 +
 +
 +===== Schedule cron format =====
 +
 +this use general crontab format http://en.wikipedia.org/wiki/Cron
 +
 +=== Examples ===
 +
 +Daily at 7am UTC \\
 +0 7 * * *
 +
 +Bi-Weekly monday/thursday 7am UTC\\
 +0 7 * * 1,4
 +
 +Monthly 1 day of month 7am UTC\\
 +0 7 1 * *
udropship/batch/reference.1280984928.txt.bz2 · by unirgy