{ "info": { "author": "rajeshkris", "author_email": "rajeshkrish@sayonetech.com", "bugtrack_url": null, "classifiers": [], "description": "Fosdick python client\n=====================\n\n.. image:: https://img.shields.io/pypi/v/fosdick.svg\n :target: https://pypi.python.org/pypi/fosdick/2.0.0\n.. image:: https://img.shields.io/pypi/l/fosdick.svg\n :target: https://pypi.python.org/pypi/fosdick/2.0.0\n\nThe Fosdick API Client for Python is a client library for accessing Fosdick APIs.\n\n********\nFeatures\n********\n* Get a list of inventory levels for products\n* Get a list of returned orders/items\n* Get a list of shipped orders\n* Get a list of shipped line item\n* Get a list of receipts\n* Post order\n\n************\nInstallation\n************\nInstall with pip:\n\n.. code:: python\n\n pip install fosdick\n\n*************\nExample Usage\n*************\n\n.. code:: python\n\n from fosdick.api import FosDickAPI\n \n api = FosDickAPI(, )\n \n \n* Get shipments\n\nParameters\n\n================== ================ =================== =====================================================\nParameter Name Required Type(max length) Description\n================== ================ =================== =====================================================\npage No numeric Page number of items to display.\nper_page No numeric The number of items to return per page (default:\n all returns returned)\nupdated_at_min No datetime Only retrieve shipments updated since\nupdated_at_max No datetime Only retrieve shipments updated before\nshipped_on_min No datetime Only retrieve shipments shipped since\nshipped_on_max No datetime Only retrieve shipments shipped before\nfosdick_order_num No varchar(17) Search by Fosdick order number\nexternal_order_num No varchar(50) Search by External order number\n================== ================ =================== =====================================================\n\n.. code:: python\n \n shipments = api.get_shipments()\n \n # sample example response\n [\n {\n \"fosdick_order_num\": \"00101201506460001\",\n \"external_order_num\": \"0011001\",\n \"ship_date\": \"2015-02-06\",\n \"trackings\": [\n {\n \"tracking_num\": \"9274899998944522337\",\n \"carrier_code\": \"92\",\n \"carrier_name\": \"FEDEX SMART POST\"\n },\n {\n \"tracking_num\": \"9274899998944599999\",\n \"carrier_code\": \"92\",\n \"carrier_name\": \"FEDEX SMART POST\"\n }\n ]\n },\n {\n \"fosdick_order_num\": \"00101201506460002\",\n \"external_order_num\": \"0011002\",\n \"ship_date\": \"2015-02-06\",\n \"trackings\": [\n {\n \"tracking_num\": \"1Z44526832337\",\n \"carrier_code\": \"3E\",\n \"carrier_name\": \"UPS GROUND\"\n }\n ]\n }\n ]\n\t\n\n* Get inventory\n\nParameters\n\n================ ================ =================== ===================================================\nParameter Name Required Type(max length) Description\n================ ================ =================== ===================================================\n page No numeric Page number of products to display. 0 based index.\n per_page No numeric The number of products to return per page\n (default: all products returned)\n updated_at_min No datetime Only retrieve inventory updated since\n updated_at_max No datetime Only retrieve inventory updated before\n================ ================ =================== ===================================================\n\n.. code:: python\n\n inventory = api.get_inventory()\n \n # example response for inventory\n [\n\t {\n\t\t\"sku\" : \"EXAMPSKU\",\n\t\t\"available\" : true,\n\t\t\"ct_quantity\" : 200,\n\t\t\"nv_quantity\" : 0,\n\t\t\"other_quantity\" : 15,\n\t\t\"committed\" : 10,\n\t\t\"available_quantity\": 205,\n\t\t\"updated_at\":\"2014-03-12T13:17:30-04:00\"\n\t },\n\t {\n\t\t\"sku\" : \"EXAMPSKU2\",\n\t\t\"available\" : false,\n\t\t\"ct_quantity\" : 20,\n\t\t\"nv_quantity\" : 0,\n\t\t\"other_quantity\" : 0,\n\t\t\"committed\" : 20,\n\t\t\"available_quantity\": 0,\n\t\t\"updated_at\":\"2014-03-12T13:17:30-04:00\"\n\n\t }\n ]\n\n* Get returned orders/items\n\nParameters\n\n================= ================ =================== ===================================================\nParameter Name Required Type(max length) Description\n================= ================ =================== ===================================================\n page No numeric Page number of items to display.\n per_page No numeric The number of items to return per page (default:\n all returns returned)\n updated_at_min No datetime Only retrieve returns updated since\n updated_at_max No datetime Only retrieve returns updated before\n returned_at_min No datetime Only retrieve returns since\n returned_at_max No datetime Only retrieve returns before\n================= ================ =================== ===================================================\n\n.. code:: python\n\n returned_items = api.get_all_returns()\n \n # example response for returned_items\n [\n\t{\n\t\t\"fosdick_order_num\" : \"00101201456768765\",\n\t\t\"external_order_num\" : \"9912A\",\n\t\t\"sku\" : \"EXAMPSKU\",\n\t\t\"line_item\" : 1,\n\t\t\"external_line_item\" : \"9912A-1\",\n\t\t\"return_date\" : \"2014-03-12T9:00:30-04:00\",\n\t\t\"quantity_returned\" : 1,\n\t\t\"quality\" : 0,\n\t\t\"reason_code\" : 2,\n\t\t\"reason_description\" : \"Defective\",\n\t\t\"action_requested\" : \"Refund\",\n\t\t\"updated_at\" : \"2014-03-12T13:17:30-04:00\"\n\t},\n\t{\n\t\t\"fosdick_order_num\" : \"00101201456769988\",\n\t\t\"external_order_num\" : \"10012R\",\n\t\t\"sku\" : \"EXAMPSKU\",\n\t\t\"line_item\" : 1,\n\t\t\"external_line_item\" : \"10012R-3\",\n\t\t\"return_date\" : \"2014-03-12T9:00:30-04:00\",\n\t\t\"quantity_returned\" : 2,\n\t\t\"quality\" : 1,\n\t\t\"reason_code\" : 5,\n\t\t\"reason_description\" : \"Never Ordered\",\n\t\t\"action_requested\" : \"Refund\",\n\t\t\"updated_at\" : \"2014-03-12T13:17:30-04:00\"\n\t}\n ]\n\n* Get shipped line item\n\nParameters\n\n================== ================ =================== ===================================================\nParameter Name Required Type(max length) Description\n================== ================ =================== ===================================================\npage No numeric Page number of items to display.\nper_page No numeric The number of items to return per page (default:\n all returns returned)\nupdated_at_min No datetime Only retrieve shipments updated since\nupdated_at_max No datetime Only retrieve shipments updated before\nshipped_on_min No datetime Only retrieve shipments shipped since\nshipped_on_max No datetime Only retrieve shipments shipped before\nfosdick_order_num No varchar(17) Search by Fosdick order number\nexternal_order_num No varchar(50) Search by External order number\n================== ================ =================== ===================================================\n\n.. code:: python\n\n shipped_detail = api.get_shipment_details()\n \n # sample response\n [\n {\n \"fosdick_order_num\": \"00101201506460001\",\n \"fosdick_line_num\": \"1\",\n \"sku\": \"PROD001\",\n \"quantity\": 1,\n \"external_order_num\": \"10011001\",\n \"external_line_num\": null,\n \"external_sku\": \"PROD001\",\n \"ship_date\": \"2015-02-06\",\n \"trackings\": [\n {\n \"tracking_num\": \"9274899998944522337\",\n \"carrier_code\": \"92\",\n \"carrier_name\": \"FEDEX SMART POST\"\n },\n {\n \"tracking_num\": \"9274899998944599999\",\n \"carrier_code\": \"92\",\n \"carrier_name\": \"FEDEX SMART POST\"\n }\n ]\n },\n {\n \"fosdick_order_num\": \"00101201506460001\",\n \"fosdick_line_num\": \"2\",\n \"sku\": \"PROD002\",\n \"quantity\": 1,\n \"external_order_num\": \"10011001\",\n \"external_line_num\": null,\n \"external_sku\": \"PROD002\",\n \"ship_date\": \"2015-02-06\",\n \"trackings\": [\n {\n \"tracking_num\": \"1Z44526832337\",\n \"carrier_code\": \"3E\",\n \"carrier_name\": \"UPS GROUND\"\n }\n ]\n }\n ]\n \n* Get receipts\n\nParameters\n\n================== ================ =================== ===================================================\npage No numeric Page number of items to display.\nper_page No numeric The number of items to return per page (default:\n all returns returned)\ntransaction_at_min No datetime Only retrieve receipts with transaction time\n since\ntransaction_at_max No datetime Only retrieve receipts with transaction time\n before\nupdated_at_min No datetime Only retrieve receipts updated since\nupdated_at_max No datetime Only retrieve receipts updated before\nsku No varchar(50) Search by SKU\nwarehouse No char(2) Search by warehouse (CT or NV)\n================== ================ =================== ===================================================\n\n.. code:: python\n\n receipts = api.get_receipts()\n \n # sample response\n [\n {\n \"date_time\": \"2015-10-14T10:46:21-04:00\",\n \"warehouse\": \"NV\",\n \"receiver_num\": 101263,\n \"container_num\": \"CONTAINER-t\",\n \"po_num\": \"2101\",\n \"carrier_name\": \"UPS GROUND\",\n \"sku\": \"778888\",\n \"description_product\": null,\n \"qty\": 4800,\n \"num_of_floor_loaded\": 60,\n \"num_of_skids\": 3,\n \"num_of_cartons\": 60,\n \"updated_at\": \"2015-10-14T10:48:00.75-04:00\"\n },\n {\n \"date_time\": \"2015-10-13T13:24:16-04:00\",\n \"warehouse\": \"NV\",\n \"receiver_num\": 101262,\n \"container_num\": null,\n \"po_num\": \"2101\",\n \"carrier_name\": null,\n \"sku\": \"#B0X8\",\n \"description_product\": null,\n \"qty\": 1200,\n \"num_of_floor_loaded\": 0,\n \"num_of_skids\": 2,\n \"num_of_cartons\": 0,\n \"updated_at\": \"2015-10-13T13:28:07.63-04:00\"\n }\n ]\n\n* Post order\n\n.. code:: python\n\n from fosdick.api import PlaceOrder\n\n # sample order\n order_item = {\n \"UnitycartOrderPost\":{\n \"ClientName\":\"TEST\",\n \"ClientCode\":\"ad54LIADFJ2754\",\n \"Test\":\"y\",\n \"Order\":[\n {\n \"Subtotal\":\"0.00\",\n \"Total\":\"0.00\",\n \"ExternalID\":\"LMTB-100466\",\n \"AdCode\":\"DTC\",\n \"ShipFirstname\":\"tes1\",\n \"ShipLastname\":\"test2\",\n \"ShipAddress1\":\"test_address\",\n \"ShipCity\":\"agat\",\n \"ShipState\":\"ID\",\n \"ShipPhone\":\"\",\n \"ShipZip\":\"96915\",\n \"Email\":\"test@gmail.com\",\n \"UseAsBilling\":\"y\",\n \"PaymentType\":\"5\",\n \"Items\":{\n \"Item\":[\n {\n \"NumOfPayments\":\"1\",\n \"Inv\":\"811934020015\",\n \"Qty\":1,\n \"PricePer\":\"0.00\"\n }\n ]\n }\n }\n ]\n }\n }\n\n # y to denote test order.\n test_flag = 'y'\n\n order = PlaceOrder(order_item, , , test_flag)\n\n # to place the order\n item = order.create_order()\n\n # sample response\n {\n \"UnitycartOrderResponse\":{\n \"@xml:lang\":\"en-US\",\n \"OrderResponse\":{\n \"@ExternalID\":\"ABCD-100467\",\n \"SuccessCode\":\"True\",\n \"OrderNumber\":\"603326202469\"\n }\n }\n }\n\n\n*******\nSupport\n*******\n\nPython 2.6 and 2.7, 3.3, 3.4 & 3.5 are supported.\n\n************\nContributors\n************\n\n- `Rajesh Krishnan P L `_\n\n*******\nLicense\n*******\nMIT", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/sayonetech/fosdick-api-python-client", "keywords": "", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "fosdick", "package_url": "https://pypi.org/project/fosdick/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/fosdick/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/sayonetech/fosdick-api-python-client" }, "release_url": "https://pypi.org/project/fosdick/2.0.0/", "requires_dist": null, "requires_python": null, "summary": "The Fosdick API Client for Python", "version": "2.0.0" }, "last_serial": 2611381, "releases": { "2.0.0": [ { "comment_text": "", "digests": { "md5": "2d57f9e6e2c1e75f1a9dd06c39e9bd6e", "sha256": "6a76efaf7041c8724edfa028625486704c5e1dcebd6c30ee667900edc1565825" }, "downloads": -1, "filename": "fosdick-2.0.0.tar.gz", "has_sig": false, "md5_digest": "2d57f9e6e2c1e75f1a9dd06c39e9bd6e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6807, "upload_time": "2017-02-01T11:57:34", "url": "https://files.pythonhosted.org/packages/b2/b6/c1846968f7fa7a3af23f534379859caab9bcf7fc1e0b32be0c38fdb401ef/fosdick-2.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2d57f9e6e2c1e75f1a9dd06c39e9bd6e", "sha256": "6a76efaf7041c8724edfa028625486704c5e1dcebd6c30ee667900edc1565825" }, "downloads": -1, "filename": "fosdick-2.0.0.tar.gz", "has_sig": false, "md5_digest": "2d57f9e6e2c1e75f1a9dd06c39e9bd6e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6807, "upload_time": "2017-02-01T11:57:34", "url": "https://files.pythonhosted.org/packages/b2/b6/c1846968f7fa7a3af23f534379859caab9bcf7fc1e0b32be0c38fdb401ef/fosdick-2.0.0.tar.gz" } ] }