{"docs":{"name":"Stocky API","info":"","copyright":null,"doc_url":"/api/docs/v2","api_url":"/api","resources":{"purchase_orders":{"doc_url":"/api/docs/v2/purchase_orders","id":"purchase_orders","api_url":"/api","name":"Purchase Order","short_description":null,"full_description":"","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/api/docs/v2/purchase_orders/index","name":"index","apis":[{"api_url":"/api/v2/purchase_orders.json","http_method":"GET","short_description":"Retrieves a list of purchase orders","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"confirmed_since","full_name":"confirmed_since","description":"\n\u003cp\u003eReturn purchase orders ordered on or after a specified date (Using ISO 8601 format; e.g. 2014-04-25T16:15:47-04:00)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"updated_since","full_name":"updated_since","description":"\n\u003cp\u003eReturn only purchase orders that have been updated on or after a specified date (Using ISO 8601 format; e.g. 2014-04-25T16:15:47-04:00)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003eReturn only purchase orders specified in the status (i.e. ‘draft’, ‘draft-archived’, ‘draft-unarchived’, ‘confirmed’, ‘confirmed-archived’, ‘confirmed-unarchived’, ‘archived’, ‘unarchived’)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eReturn up to this many purchase orders per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offset","full_name":"offset","description":"\n\u003cp\u003eSpecifies the number of matching records to skip over. \u003cstrong\u003eNOTE:\u003c/strong\u003e This \u003cstrong\u003e\u003cem\u003eshould not\u003c/em\u003e\u003c/strong\u003e be used for pagination. Use the \u003ccode\u003esince_id\u003c/code\u003e param instead. If both \u003ccode\u003eoffset\u003c/code\u003e and \u003ccode\u003esince_id\u003c/code\u003e are provided, only \u003ccode\u003esince_id\u003c/code\u003e will be used.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"since_id","full_name":"since_id","description":"\n\u003cp\u003eReturn only purchase orders with ID values less than the provided ID. Use in combination with the \u003ccode\u003elimit\u003c/code\u003e param for pagination. Can not be used in combination with the \u003ccode\u003eoffset\u003c/code\u003e param. If both \u003ccode\u003eoffset\u003c/code\u003e and \u003ccode\u003esince_id\u003c/code\u003e are provided, only \u003ccode\u003esince_id\u003c/code\u003e will be used.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"The requested purchase order data","is_array":false,"returns_object":[{"name":"archived","full_name":"archived","description":"\n\u003cp\u003e“archived”: false\u003c/p\u003e\n\n\u003cpre\u003eAn indicator whether the purchase order has been archived.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003e“created_at”: “2021-02-05T17:55:46.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the purchase order was created.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003e“updated_at”: “2021-02-05T17:55:46.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the purchase order was last updated.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"currency","full_name":"currency","description":"\n\u003cp\u003e“currency”: “CAD”\u003c/p\u003e\n\n\u003cpre\u003eThe purchase order\u0026#39;s currency.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"expected_on","full_name":"expected_on","description":"\n\u003cp\u003e“expected_on”: “2021-02-23”\u003c/p\u003e\n\n\u003cpre\u003eThe date when the purchase order is expected.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"generated_at","full_name":"generated_at","description":"\n\u003cp\u003e“generated_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the purchase order was generated.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003e“id”: 808950810\u003c/p\u003e\n\n\u003cpre\u003eA unique numeric identifier for the purchase order.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"invoice_number","full_name":"invoice_number","description":"\n\u003cp\u003e“invoice_number”: “123123”\u003c/p\u003e\n\n\u003cpre\u003eA number issued by the vendor or supplier to keep track of the purchase order payment.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"number","full_name":"number","description":"\n\u003cp\u003e“number”: “1000A”\u003c/p\u003e\n\n\u003cpre\u003eA number assigned to a purchase order that merchants can override.\nIt returns sequential_id if the merchant has not overridden the number.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"ordered_at","full_name":"ordered_at","description":"\n\u003cp\u003e“ordered_at”: “2021-02-11T03:13:00.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when purchase order number was confirmed. \nIf this property is null, then the purchase order has not been confirmed yet.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"payment_due_on","full_name":"payment_due_on","description":"\n\u003cp\u003e“payment_due_on”: “2021-02-23”\u003c/p\u003e\n\n\u003cpre\u003eThe date when the purchase order payment is due.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"sequential_id","full_name":"sequential_id","description":"\n\u003cp\u003e“sequential_id”: 23133\u003c/p\u003e\n\n\u003cpre\u003eA sequential number assigned to a purchase order.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"ship_on","full_name":"ship_on","description":"\n\u003cp\u003e“ship_on”: “2021-02-24”\u003c/p\u003e\n\n\u003cpre\u003eThe date when items in the purchase order were shipped.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"shopify_receive_location_id","full_name":"shopify_receive_location_id","description":"\n\u003cp\u003e“shopify_receive_location_id”: 34915680278\u003c/p\u003e\n\n\u003cpre\u003eThe identifier for the Shopify Location that will receive the purchased items.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"supplier_name","full_name":"supplier_name","description":"\n\u003cp\u003e“supplier_name”: “Acme”\u003c/p\u003e\n\n\u003cpre\u003eThe name of the vendor or supplier associated with the purchase order.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"supplier_id","full_name":"supplier_id","description":"\n\u003cp\u003e“supplier_id”: “1”\u003c/p\u003e\n\n\u003cpre\u003eThe identifier of the supplier associated with the purchase order. If there is no supplier, it must instead be associated with a vendor (see \u0026#39;supplier_name\u0026#39;).\u003c/pre\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"paid","full_name":"paid","description":"\n\u003cp\u003e“paid”: false\u003c/p\u003e\n\n\u003cpre\u003eIndicates whether the purchase order has been paid or not.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false},{"name":"adjustments","full_name":"adjustments","description":"\n\u003cp\u003e“adjustments”: 199.00\u003c/p\u003e\n\n\u003cpre\u003eAdjustments to the purchase order in supplier\u0026#39;s currency.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"adjustments_local","full_name":"adjustments_local","description":"\n\u003cp\u003e“adjustments_local”: 229.00\u003c/p\u003e\n\n\u003cpre\u003eAdjustments to the purchase order in the merchant\u0026#39;s currency.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"shipping","full_name":"shipping","description":"\n\u003cp\u003e“shipping”: 19.00\u003c/p\u003e\n\n\u003cpre\u003eShipping cost in supplier\u0026#39;s currency.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"shipping_local","full_name":"shipping_local","description":"\n\u003cp\u003e“shipping_local”: 29.00\u003c/p\u003e\n\n\u003cpre\u003eShipping cost in the merchant\u0026#39;s currency.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"shipping_tax_type","full_name":"shipping_tax_type","description":"\n\u003cp\u003e“shipping_tax_type”: 32122\u003c/p\u003e\n\n\u003cpre\u003eThe tax type applied to the shipping cost. To calculate shipping tax use the tax type endpoint to look up tax rate.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"invoice_date","full_name":"invoice_date","description":"\n\u003cp\u003e“invoice_date”: “2021-02-24”\u003c/p\u003e\n\n\u003cpre\u003eThe invoice date associated with the purchase order.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"purchase_items","full_name":"purchase_items","description":"\n\u003cp\u003eA list of purchase items in the purchase order.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"asin","full_name":"purchase_items[asin]","description":"\n\u003cp\u003e“asin”: “B015UKRNGS”\u003c/p\u003e\n\n\u003cpre\u003eA 10-character alphanumeric unique identifier assigned by Amazon and its partners for product identification.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cost_price","full_name":"purchase_items[cost_price]","description":"\n\u003cp\u003e“cost_price”: “100.00”\u003c/p\u003e\n\n\u003cpre\u003eThe amount paid to purchase this item from the vendor or supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"purchase_items[id]","description":"\n\u003cp\u003e“id”: 1\u003c/p\u003e\n\n\u003cpre\u003eA unique numeric identifier for the purchase item.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inventory_item_id","full_name":"purchase_items[inventory_item_id]","description":"\n\u003cp\u003e“id”: 450789469\u003c/p\u003e\n\n\u003cpre\u003eThe identifier for the Shopify InventoryItem associated with the purchase item.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_title","full_name":"purchase_items[product_title]","description":"\n\u003cp\u003e“product_title”: “Example T-Shirt”\u003c/p\u003e\n\n\u003cpre\u003eThe name of the product.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"purchase_items[quantity]","description":"\n\u003cp\u003e“quantity”: 2\u003c/p\u003e\n\n\u003cpre\u003eThe number of items purchased.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"received_at","full_name":"purchase_items[received_at]","description":"\n\u003cp\u003e“received_at”: “2021-02-23”\u003c/p\u003e\n\n\u003cpre\u003eThe date when the item was received. The date will use the format selected by the merchant in Stocky under Preferences \u0026gt; General. \nIf this property is null, then the item has not been received yet.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retail_price","full_name":"purchase_items[retail_price]","description":"\n\u003cp\u003e“retail_price”: “399.00”\u003c/p\u003e\n\n\u003cpre\u003eThe price that customer will pay when purchasing this item.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sku","full_name":"purchase_items[sku]","description":"\n\u003cp\u003e“sku”: “Int00154 . PEPERULO”\u003c/p\u003e\n\n\u003cpre\u003eA Stock Keeping Unit (SKU) is a unique alphanumeric code used to identify characteristics of a product.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"purchase_items[status]","description":"\n\u003cp\u003e“status”: “not delivered”\u003c/p\u003e\n\n\u003cpre\u003eThe status of the purchased item.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"supplier_cost_price","full_name":"purchase_items[supplier_cost_price]","description":"\n\u003cp\u003e“supplier_cost_price”: “100.00”\u003c/p\u003e\n\n\u003cpre\u003eThe amount paid to purchase this item from a supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"updated_at","full_name":"purchase_items[updated_at]","description":"\n\u003cp\u003e“updated_at”: “11/02/2021 04:39”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time when the purchase item in the purchase order was last modified. The date will use the format selected by the merchant in Stocky under Preferences \u0026gt; General.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"variant_title","full_name":"purchase_items[variant_title]","description":"\n\u003cp\u003e“variant_title”: “Pink”\u003c/p\u003e\n\n\u003cpre\u003eThe title of the product variant.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_type_id","full_name":"purchase_items[tax_type_id]","description":"\n\u003cp\u003e“tax_type_id”: 7223\u003c/p\u003e\n\n\u003cpre\u003eThe ID of the tax type that\u0026#39;s associated with this purchase item. You can look up more details\nsuch as the tax rate throught the tax type endpoint.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":["Response Example:\n\nHTTP/1.1 200 OK\n{\n  \"purchase_orders\": [\n    {\n      \"id\": 2,\n      \"number\": 1001,\n      \"sequential_id\": 1001,\n      \"invoice_number\": null,\n      \"created_at\": \"2021-02-09T00:23:25.000Z\",\n      \"updated_at\": \"2021-02-09T00:24:13.000Z\",\n      \"generated_at\": \"2021-02-09T00:23:25.000Z\",\n      \"ordered_at\": \"2021-02-09T00:24:13.000Z\",\n      \"expected_on\": \"2021-02-22\",\n      \"ship_on\": \"2021-02-24\",\n      \"payment_due_on\": null,\n      \"archived\": false,\n      \"supplier_name\": \"Brothers\",\n      \"supplier_id\": \"1\",\n      \"currency\": \"CAD\",\n      \"shopify_receive_location_id\": 34915680278,\n      \"paid\": false,\n      \"adjustments\": 199.00,\n      \"adjustments_local\": 299.00,\n      \"shipping\": 19.00,\n      \"shipping_local\": 29.00,\n      \"shipping_tax_type\": 27,\n      \"invoice_date\": \"2021-02-10\",\n      \"purchase_items\": [\n        {\n          \"id\": 4,\n          \"sku\": \"BrothersCatapreses01\",\n          \"inventory_item_id\": 37791323160598,\n          \"product_title\": \"Catapreses Harlemites Constructivist Gothicks\",\n          \"variant_title\": \"nonparalysis\",\n          \"asin\": \"\",\n          \"quantity\": 10,\n          \"status\": \"not delivered\",\n          \"retail_price\": \"49.61\",\n          \"cost_price\": null,\n          \"supplier_cost_price\": null,\n          \"account_code\": \"300\",\n          \"tax_type_id\": 427,\n          \"accounting_tax_type\": \"HST\",\n          \"received_at\": null,\n          \"updated_at\": \"09/02/2021 00:23\"\n        },\n        {\n          \"id\": 5,\n          \"sku\": \"BrothersEcstasies01\",\n          \"inventory_item_id\": 37791200739350,\n          \"product_title\": \"Ecstasies Sufis Cunas Hunky\",\n          \"variant_title\": \"Default\",\n          \"asin\": \"\",\n          \"quantity\": 6,\n          \"status\": \"not delivered\",\n          \"retail_price\": \"290.63\",\n          \"cost_price\": null,\n          \"supplier_cost_price\": null,\n          \"account_code\": \"300\",\n          \"tax_type_id\": null,\n          \"accounting_tax_type\": null,\n          \"received_at\": null,\n          \"updated_at\": \"09/02/2021 00:23\"\n        }\n      ]\n    },\n    {\n      \"id\": 1,\n      \"number\": 1000,\n      \"sequential_id\": 1000,\n      \"invoice_number\": null,\n      \"created_at\": \"2021-02-05T17:55:46.000Z\",\n      \"updated_at\": \"2021-02-05T17:56:28.000Z\",\n      \"generated_at\": \"2021-02-05T17:55:46.000Z\",\n      \"ordered_at\": \"2021-02-05T17:56:28.000Z\",\n      \"expected_on\": \"2021-02-19\",\n      \"ship_on\": \"2021-02-23\",\n      \"payment_due_on\": null,\n      \"archived\": false,\n      \"supplier_name\": \"Acme\",\n      \"supplier_id\": \"2\",\n      \"currency\": \"CAD\",\n      \"shopify_receive_location_id\": 34915680278,\n      \"paid\": false,\n      \"adjustments\": 199.00,\n      \"adjustments_local\": 299.00,\n      \"shipping\": 19.00,\n      \"shipping_local\": 29.00,\n      \"shipping_tax_type\": 27,\n      \"invoice_date\": \"2021-02-10\",\n      \"purchase_items\": [\n        {\n          \"id\": 1,\n          \"sku\": \"\",\n          \"inventory_item_id\": 37791177900054,\n          \"product_title\": \"Example T-Shirt\",\n          \"variant_title\": \"Lithograph - Height: 9\\\" x Width: 12\\\"\",\n          \"asin\": \"\",\n          \"quantity\": 2,\n          \"status\": \"not delivered\",\n          \"retail_price\": \"25.0\",\n          \"cost_price\": null,\n          \"supplier_cost_price\": null,\n          \"account_code\": \"300\",\n          \"tax_type_id\": 427,\n          \"accounting_tax_type\": \"HST\",\n          \"received_at\": null,\n          \"updated_at\": \"05/02/2021 17:55\"\n        }\n      ]\n    }\n  ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v2/purchase_orders/show","name":"show","apis":[{"api_url":"/api/v2/purchase_orders/{purchase_order_id}.json","http_method":"GET","short_description":"Retrieves a single purchase order by ID","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"No purchase orders found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe ID of the purchase order.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"The requested purchase order data","is_array":false,"returns_object":[{"name":"archived","full_name":"archived","description":"\n\u003cp\u003e“archived”: false\u003c/p\u003e\n\n\u003cpre\u003eAn indicator whether the purchase order has been archived.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003e“created_at”: “2021-02-05T17:55:46.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the purchase order was created.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003e“updated_at”: “2021-02-05T17:55:46.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the purchase order was last updated.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"currency","full_name":"currency","description":"\n\u003cp\u003e“currency”: “CAD”\u003c/p\u003e\n\n\u003cpre\u003eThe purchase order\u0026#39;s currency.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"expected_on","full_name":"expected_on","description":"\n\u003cp\u003e“expected_on”: “2021-02-23”\u003c/p\u003e\n\n\u003cpre\u003eThe date when the purchase order is expected.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"generated_at","full_name":"generated_at","description":"\n\u003cp\u003e“generated_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the purchase order was generated.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003e“id”: 808950810\u003c/p\u003e\n\n\u003cpre\u003eA unique numeric identifier for the purchase order.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"invoice_number","full_name":"invoice_number","description":"\n\u003cp\u003e“invoice_number”: “123123”\u003c/p\u003e\n\n\u003cpre\u003eA number issued by the vendor or supplier to keep track of the purchase order payment.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"number","full_name":"number","description":"\n\u003cp\u003e“number”: “1000A”\u003c/p\u003e\n\n\u003cpre\u003eA number assigned to a purchase order that merchants can override.\nIt returns sequential_id if the merchant has not overridden the number.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"ordered_at","full_name":"ordered_at","description":"\n\u003cp\u003e“ordered_at”: “2021-02-11T03:13:00.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when purchase order number was confirmed. \nIf this property is null, then the purchase order has not been confirmed yet.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"payment_due_on","full_name":"payment_due_on","description":"\n\u003cp\u003e“payment_due_on”: “2021-02-23”\u003c/p\u003e\n\n\u003cpre\u003eThe date when the purchase order payment is due.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"sequential_id","full_name":"sequential_id","description":"\n\u003cp\u003e“sequential_id”: 23133\u003c/p\u003e\n\n\u003cpre\u003eA sequential number assigned to a purchase order.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"ship_on","full_name":"ship_on","description":"\n\u003cp\u003e“ship_on”: “2021-02-24”\u003c/p\u003e\n\n\u003cpre\u003eThe date when items in the purchase order were shipped.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"shopify_receive_location_id","full_name":"shopify_receive_location_id","description":"\n\u003cp\u003e“shopify_receive_location_id”: 34915680278\u003c/p\u003e\n\n\u003cpre\u003eThe identifier for the Shopify Location that will receive the purchased items.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"supplier_name","full_name":"supplier_name","description":"\n\u003cp\u003e“supplier_name”: “Acme”\u003c/p\u003e\n\n\u003cpre\u003eThe name of the vendor or supplier associated with the purchase order.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"supplier_id","full_name":"supplier_id","description":"\n\u003cp\u003e“supplier_id”: “1”\u003c/p\u003e\n\n\u003cpre\u003eThe identifier of the supplier associated with the purchase order. If there is no supplier, it must instead be associated with a vendor (see \u0026#39;supplier_name\u0026#39;).\u003c/pre\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"paid","full_name":"paid","description":"\n\u003cp\u003e“paid”: false\u003c/p\u003e\n\n\u003cpre\u003eIndicates whether the purchase order has been paid or not.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false},{"name":"adjustments","full_name":"adjustments","description":"\n\u003cp\u003e“adjustments”: 199.00\u003c/p\u003e\n\n\u003cpre\u003eAdjustments to the purchase order in supplier\u0026#39;s currency.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"adjustments_local","full_name":"adjustments_local","description":"\n\u003cp\u003e“adjustments_local”: 229.00\u003c/p\u003e\n\n\u003cpre\u003eAdjustments to the purchase order in the merchant\u0026#39;s currency.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"shipping","full_name":"shipping","description":"\n\u003cp\u003e“shipping”: 19.00\u003c/p\u003e\n\n\u003cpre\u003eShipping cost in supplier\u0026#39;s currency.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"shipping_local","full_name":"shipping_local","description":"\n\u003cp\u003e“shipping_local”: 29.00\u003c/p\u003e\n\n\u003cpre\u003eShipping cost in the merchant\u0026#39;s currency.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"shipping_tax_type","full_name":"shipping_tax_type","description":"\n\u003cp\u003e“shipping_tax_type”: 32122\u003c/p\u003e\n\n\u003cpre\u003eThe tax type applied to the shipping cost. To calculate shipping tax use the tax type endpoint to look up tax rate.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"invoice_date","full_name":"invoice_date","description":"\n\u003cp\u003e“invoice_date”: “2021-02-24”\u003c/p\u003e\n\n\u003cpre\u003eThe invoice date associated with the purchase order.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"purchase_items","full_name":"purchase_items","description":"\n\u003cp\u003eA list of purchase items in the purchase order.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"asin","full_name":"purchase_items[asin]","description":"\n\u003cp\u003e“asin”: “B015UKRNGS”\u003c/p\u003e\n\n\u003cpre\u003eA 10-character alphanumeric unique identifier assigned by Amazon and its partners for product identification.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"cost_price","full_name":"purchase_items[cost_price]","description":"\n\u003cp\u003e“cost_price”: “100.00”\u003c/p\u003e\n\n\u003cpre\u003eThe amount paid to purchase this item from the vendor or supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"purchase_items[id]","description":"\n\u003cp\u003e“id”: 1\u003c/p\u003e\n\n\u003cpre\u003eA unique numeric identifier for the purchase item.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inventory_item_id","full_name":"purchase_items[inventory_item_id]","description":"\n\u003cp\u003e“id”: 450789469\u003c/p\u003e\n\n\u003cpre\u003eThe identifier for the Shopify InventoryItem associated with the purchase item.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_title","full_name":"purchase_items[product_title]","description":"\n\u003cp\u003e“product_title”: “Example T-Shirt”\u003c/p\u003e\n\n\u003cpre\u003eThe name of the product.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"purchase_items[quantity]","description":"\n\u003cp\u003e“quantity”: 2\u003c/p\u003e\n\n\u003cpre\u003eThe number of items purchased.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"received_at","full_name":"purchase_items[received_at]","description":"\n\u003cp\u003e“received_at”: “2021-02-23”\u003c/p\u003e\n\n\u003cpre\u003eThe date when the item was received. The date will use the format selected by the merchant in Stocky under Preferences \u0026gt; General. \nIf this property is null, then the item has not been received yet.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retail_price","full_name":"purchase_items[retail_price]","description":"\n\u003cp\u003e“retail_price”: “399.00”\u003c/p\u003e\n\n\u003cpre\u003eThe price that customer will pay when purchasing this item.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sku","full_name":"purchase_items[sku]","description":"\n\u003cp\u003e“sku”: “Int00154 . PEPERULO”\u003c/p\u003e\n\n\u003cpre\u003eA Stock Keeping Unit (SKU) is a unique alphanumeric code used to identify characteristics of a product.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"purchase_items[status]","description":"\n\u003cp\u003e“status”: “not delivered”\u003c/p\u003e\n\n\u003cpre\u003eThe status of the purchased item.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"supplier_cost_price","full_name":"purchase_items[supplier_cost_price]","description":"\n\u003cp\u003e“supplier_cost_price”: “100.00”\u003c/p\u003e\n\n\u003cpre\u003eThe amount paid to purchase this item from a supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"updated_at","full_name":"purchase_items[updated_at]","description":"\n\u003cp\u003e“updated_at”: “11/02/2021 04:39”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time when the purchase item in the purchase order was last modified. The date will use the format selected by the merchant in Stocky under Preferences \u0026gt; General.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"variant_title","full_name":"purchase_items[variant_title]","description":"\n\u003cp\u003e“variant_title”: “Pink”\u003c/p\u003e\n\n\u003cpre\u003eThe title of the product variant.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tax_type_id","full_name":"purchase_items[tax_type_id]","description":"\n\u003cp\u003e“tax_type_id”: 7223\u003c/p\u003e\n\n\u003cpre\u003eThe ID of the tax type that\u0026#39;s associated with this purchase item. You can look up more details\nsuch as the tax rate throught the tax type endpoint.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":["Response Example:\n\nHTTP/1.1 200 OK\n{\n  \"id\": 1,\n  \"number\": 1000,\n  \"sequential_id\": 1000,\n  \"invoice_number\": null,\n  \"created_at\": \"2021-02-05T17:55:46.000Z\",\n  \"updated_at\": \"2021-02-05T17:56:28.000Z\",\n  \"generated_at\": \"2021-02-05T17:55:46.000Z\",\n  \"ordered_at\": \"2021-02-05T17:56:28.000Z\",\n  \"expected_on\": \"2021-02-19\",\n  \"ship_on\": \"2021-02-23\",\n  \"payment_due_on\": null,\n  \"archived\": false,\n  \"supplier_name\": \"Acme\",\n  \"supplier_id\": \"1\",\n  \"currency\": \"CAD\",\n  \"shopify_receive_location_id\": 34915680278,\n  \"paid\" false,\n  \"adjustments\": 199.00,\n  \"adjustments_local\": 299.00,\n  \"shipping\": 19.00,\n  \"shipping_local\": 29.00,\n  \"shipping_tax_type\": 27,\n  \"invoice_date\": \"2021-02-10\",\n  \"purchase_items\": [\n    {\n      \"id\": 1,\n      \"sku\": \"\",\n      \"inventory_item_id\": 37791177900054,\n      \"product_title\": \"Example T-Shirt\",\n      \"variant_title\": \"Lithograph - Height: 9\\\" x Width: 12\\\"\",\n      \"asin\": \"\",\n      \"quantity\": 2,\n      \"status\": \"not delivered\",\n      \"retail_price\": \"25.0\",\n      \"cost_price\": null,\n      \"supplier_cost_price\": null,\n      \"account_code\": \"300\",\n      \"tax_type_id\": 427,\n      \"accounting_tax_type\": \"HST\",\n      \"received_at\": null,\n      \"updated_at\": \"05/02/2021 17:55\"\n    },\n    {\n      \"id\": 2,\n      \"sku\": \"example-shirt-s\",\n      \"inventory_item_id\": 37791177932822,\n      \"product_title\": \"Example T-Shirt\",\n      \"variant_title\": \"Small\",\n      \"asin\": \"\",\n      \"quantity\": 8,\n      \"status\": \"not delivered\",\n      \"retail_price\": \"19.99\",\n      \"cost_price\": null,\n      \"supplier_cost_price\": null,\n      \"account_code\": \"300\",\n      \"tax_type_id\": 427,\n      \"accounting_tax_type\": \"HST\",\n      \"received_at\": null,\n      \"updated_at\": \"05/02/2021 17:56\"\n    },\n    {\n      \"id\": 3,\n      \"sku\": \"example-shirt-m\",\n      \"inventory_item_id\": 37791177965590,\n      \"product_title\": \"Example T-Shirt\",\n      \"variant_title\": \"Medium\",\n      \"asin\": \"\",\n      \"quantity\": 2,\n      \"status\": \"not delivered\",\n      \"retail_price\": \"19.99\",\n      \"cost_price\": null,\n      \"supplier_cost_price\": null,\n      \"account_code\": \"300\",\n      \"tax_type_id\": null,\n      \"accounting_tax_type\": null,\n      \"received_at\": null,\n      \"updated_at\": \"05/02/2021 17:56\"\n    }\n  ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"stock_adjustment_items":{"doc_url":"/api/docs/v2/stock_adjustment_items","id":"stock_adjustment_items","api_url":"/api","name":"Stock Adjustment Item","short_description":null,"full_description":"","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/api/docs/v2/stock_adjustment_items/index","name":"index","apis":[{"api_url":"/api/v2/stock_adjustment_items.json","http_method":"GET","short_description":"Retrieves a list of stock adjustment items","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"status","full_name":"status","description":"\n\u003cp\u003eReturn only stock adjustment items that have been adjusted when status passed is \u003ccode\u003eadjusted\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"adjusted_since","full_name":"adjusted_since","description":"\n\u003cp\u003eReturn only stock adjustment items that have been adjusted on or after a specified date (Using ISO 8601 format; e.g. 2014-04-25T16:15:47-04:00)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eReturn up to this many stock adjustment items per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offset","full_name":"offset","description":"\n\u003cp\u003eSpecifies the number of matching records to skip over. \u003cstrong\u003eNOTE:\u003c/strong\u003e This \u003cstrong\u003e\u003cem\u003eshould not\u003c/em\u003e\u003c/strong\u003e be used for pagination. Use the \u003ccode\u003esince_id\u003c/code\u003e param instead. If both \u003ccode\u003eoffset\u003c/code\u003e and \u003ccode\u003esince_id\u003c/code\u003e are provided, only \u003ccode\u003esince_id\u003c/code\u003e will be used.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"updated_since","full_name":"updated_since","description":"\n\u003cp\u003eReturn only stock adjustment items that have been updated on or after a specified date (Using ISO 8601 format; e.g. 2014-04-25T16:15:47-04:00)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"since_id","full_name":"since_id","description":"\n\u003cp\u003eReturn only stock adjustment items with ID values greater than the provided ID. Use in combination with the \u003ccode\u003elimit\u003c/code\u003e param for pagination. Can not be used in combination with the \u003ccode\u003eoffset\u003c/code\u003e param. If both \u003ccode\u003eoffset\u003c/code\u003e and \u003ccode\u003esince_id\u003c/code\u003e are provided, only \u003ccode\u003esince_id\u003c/code\u003e will be used.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"The requested stock adjustment items data","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eA unique numeric identifier for the Stock Adjustment Item.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003e“quantity”: 10\u003c/p\u003e\n\n\u003cpre\u003eThe amount to adjust a Shopify InventoryLevel. \nA negative value subtracts from the InventoryLevel’s available quantity.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003e“updated_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the stock adjustment item was last updated.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003e“status”: “adjusted”\u003c/p\u003e\n\n\u003cpre\u003eThe status of the item\u0026#39;s adjustment (e.g. \u0026quot;not adjusted\u0026quot; or \u0026quot;adjusted\u0026quot;).\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"previous_quantity","full_name":"previous_quantity","description":"\n\u003cp\u003e“previous_quantity”: 4\u003c/p\u003e\n\n\u003cpre\u003eThe available quantity at the Shopify InventoryLevel before the adjustment was performed. \nIf this property is null, then the adjustment has not been performed yet.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"new_quantity","full_name":"new_quantity","description":"\n\u003cp\u003e“new_quantity”: 10\u003c/p\u003e\n\n\u003cpre\u003eThe available quantity at the Shopify InventoryLevel after the adjustment was performed. \nIf this property is null, then the adjustment has not been performed yet.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"stock_adjustment_id","full_name":"stock_adjustment_id","description":"\n\u003cp\u003e“stock_adjustment_id”: 15\u003c/p\u003e\n\n\u003cpre\u003eThe unique numeric identifier for the stock adjustment.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"adjusted_at","full_name":"adjusted_at","description":"\n\u003cp\u003e“adjusted_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when item\u0026#39;s adjustment is performed.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"variant","full_name":"variant","description":"\n\u003cp\u003eInformation about the product variant associated with the stock adjustment item.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"variant[id]","description":"\n\u003cp\u003e“id”: 3824\u003c/p\u003e\n\n\u003cpre\u003eThe unique numeric identifier for the product variant.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shopify_id","full_name":"variant[shopify_id]","description":"\n\u003cp\u003e“shopify_id”: 35616076169238\u003c/p\u003e\n\n\u003cpre\u003eThe identifier for the associated Shopify Product Variant.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"variant[title]","description":"\n\u003cp\u003e“title”: “250ml”\u003c/p\u003e\n\n\u003cpre\u003eThe name of the product variant.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sku","full_name":"variant[sku]","description":"\n\u003cp\u003e“sku”: “Int00154 . PEPERULO”\u003c/p\u003e\n\n\u003cpre\u003eThe Stock Keeping Unit (SKU) which is a unique alphanumeric code used to identify a product.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"barcode","full_name":"variant[barcode]","description":"\n\u003cp\u003e“barcode”: “1234_pink”\u003c/p\u003e\n\n\u003cpre\u003eThe barcode, UPC, or ISBN number for the product.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":["Response Example:\n\nHTTP/1.1 200 OK\n{\n  \"stock_adjustment_items\": [\n    {\n      \"id\": 1,\n      \"quantity\": 2,\n      \"updated_at\": \"2021-02-09T19:12:01.000Z\",\n      \"status\": \"adjusted\",\n      \"previous_quantity\": 3,\n      \"new_quantity\": 5,\n      \"stock_adjustment_id\": 2,\n      \"adjusted_at\": \"2021-02-08T19:12:01.000Z\",\n      \"variant\": {\n        \"id\": 278,\n        \"shopify_id\": 35671873093654,\n        \"title\": \"quadriporticus\",\n        \"sku\": \"RisorgimentosBavarians01\",\n        \"barcode\": null\n      }\n    },\n    {\n      \"id\": 2,\n      \"quantity\": 5,\n      \"updated_at\": \"2021-02-09T19:12:01.000Z\",\n      \"status\": \"adjusted\",\n      \"previous_quantity\": 3,\n      \"new_quantity\": 8,\n      \"stock_adjustment_id\": 2,\n      \"adjusted_at\": \"2021-02-08T19:12:01.000Z\",\n      \"variant\": {\n        \"id\": 16,\n        \"shopify_id\": 35671796252694,\n        \"title\": \"Default Title\",\n        \"sku\": \"\",\n        \"barcode\": \"01000009\"\n      }\n    }\n  ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v2/stock_adjustment_items/show","name":"show","apis":[{"api_url":"/api/v2/stock_adjustment_items/{stock_adjustment_item_id}.json","http_method":"GET","short_description":"Retrieves a single stock adjustment item by ID","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"No stock adjustment items found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe ID of the stock adjustment item.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"The requested stock adjustment item data","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eA unique numeric identifier for the Stock Adjustment Item.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003e“quantity”: 10\u003c/p\u003e\n\n\u003cpre\u003eThe amount to adjust a Shopify InventoryLevel. \nA negative value subtracts from the InventoryLevel’s available quantity.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003e“updated_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the stock adjustment item was last updated.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"status","full_name":"status","description":"\n\u003cp\u003e“status”: “adjusted”\u003c/p\u003e\n\n\u003cpre\u003eThe status of the item\u0026#39;s adjustment (e.g. \u0026quot;not adjusted\u0026quot; or \u0026quot;adjusted\u0026quot;).\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"previous_quantity","full_name":"previous_quantity","description":"\n\u003cp\u003e“previous_quantity”: 4\u003c/p\u003e\n\n\u003cpre\u003eThe available quantity at the Shopify InventoryLevel before the adjustment was performed. \nIf this property is null, then the adjustment has not been performed yet.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"new_quantity","full_name":"new_quantity","description":"\n\u003cp\u003e“new_quantity”: 10\u003c/p\u003e\n\n\u003cpre\u003eThe available quantity at the Shopify InventoryLevel after the adjustment was performed. \nIf this property is null, then the adjustment has not been performed yet.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"stock_adjustment_id","full_name":"stock_adjustment_id","description":"\n\u003cp\u003e“stock_adjustment_id”: 15\u003c/p\u003e\n\n\u003cpre\u003eThe unique numeric identifier for the stock adjustment.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"adjusted_at","full_name":"adjusted_at","description":"\n\u003cp\u003e“adjusted_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when item\u0026#39;s adjustment is performed.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"variant","full_name":"variant","description":"\n\u003cp\u003eInformation about the product variant associated with the stock adjustment item.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"variant[id]","description":"\n\u003cp\u003e“id”: 3824\u003c/p\u003e\n\n\u003cpre\u003eThe unique numeric identifier for the product variant.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shopify_id","full_name":"variant[shopify_id]","description":"\n\u003cp\u003e“shopify_id”: 35616076169238\u003c/p\u003e\n\n\u003cpre\u003eThe identifier for the associated Shopify Product Variant.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"variant[title]","description":"\n\u003cp\u003e“title”: “250ml”\u003c/p\u003e\n\n\u003cpre\u003eThe name of the product variant.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sku","full_name":"variant[sku]","description":"\n\u003cp\u003e“sku”: “Int00154 . PEPERULO”\u003c/p\u003e\n\n\u003cpre\u003eThe Stock Keeping Unit (SKU) which is a unique alphanumeric code used to identify a product.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"barcode","full_name":"variant[barcode]","description":"\n\u003cp\u003e“barcode”: “1234_pink”\u003c/p\u003e\n\n\u003cpre\u003eThe barcode, UPC, or ISBN number for the product.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":["Response Example:\n\nHTTP/1.1 200 OK\n{\n  \"id\": 1,\n  \"quantity\": 2,\n  \"updated_at\": \"2021-02-09T19:12:01.000Z\",\n  \"status\": \"adjusted\",\n  \"previous_quantity\": 3,\n  \"new_quantity\": 5,\n  \"stock_adjustment_id\": 2,\n  \"adjusted_at\": \"2021-02-08T19:12:01.000Z\",\n  \"variant\": {\n    \"id\": 278,\n    \"shopify_id\": 35671873093654,\n    \"title\": \"quadriporticus\",\n    \"sku\": \"RisorgimentosBavarians01\",\n    \"barcode\": null\n  }\n}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"stock_adjustments":{"doc_url":"/api/docs/v2/stock_adjustments","id":"stock_adjustments","api_url":"/api","name":"Stock Adjustment","short_description":null,"full_description":"","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/api/docs/v2/stock_adjustments/index","name":"index","apis":[{"api_url":"/api/v2/stock_adjustments.json","http_method":"GET","short_description":"Retrieves a list of stock adjustments","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"adjusted_since","full_name":"adjusted_since","description":"\n\u003cp\u003eReturn only stock adjustments that have been adjusted on or after a specified date (Using ISO 8601 format; e.g. 2014-04-25T16:15:47-04:00)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eReturn up to this many stock adjustments per page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"offset","full_name":"offset","description":"\n\u003cp\u003eSpecifies the number of matching records to skip over. \u003cstrong\u003eNOTE:\u003c/strong\u003e This \u003cstrong\u003e\u003cem\u003eshould not\u003c/em\u003e\u003c/strong\u003e be used for pagination. Use the \u003ccode\u003esince_id\u003c/code\u003e param instead. If both \u003ccode\u003eoffset\u003c/code\u003e and \u003ccode\u003esince_id\u003c/code\u003e are provided, only \u003ccode\u003esince_id\u003c/code\u003e will be used.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"updated_since","full_name":"updated_since","description":"\n\u003cp\u003eReturn only stock adjustments that have been updated on or after a specified date (Using ISO 8601 format; e.g. 2014-04-25T16:15:47-04:00)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"since_id","full_name":"since_id","description":"\n\u003cp\u003eReturn only stock adjustments with ID values greater than the provided ID. Use in combination with the \u003ccode\u003elimit\u003c/code\u003e param for pagination. Can not be used in combination with the \u003ccode\u003eoffset\u003c/code\u003e param. If both \u003ccode\u003eoffset\u003c/code\u003e and \u003ccode\u003esince_id\u003c/code\u003e are provided, only \u003ccode\u003esince_id\u003c/code\u003e will be used.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"The requested stock adjustment data","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003e“id”: 808950810\u003c/p\u003e\n\n\u003cpre\u003eA unique numeric identifier for the stock adjustment.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"sequential_id","full_name":"sequential_id","description":"\n\u003cp\u003e“sequential_id”: 23133\u003c/p\u003e\n\n\u003cpre\u003eA sequential number assigned to a stock adjustment.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"adjusted_at","full_name":"adjusted_at","description":"\n\u003cp\u003e“adjusted_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the stock adjustment was performed.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003e“created_at”: “2021-02-05T17:55:46.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the stock adjustment was created.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003e“updated_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the stock adjustment was last updated.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"archived","full_name":"archived","description":"\n\u003cp\u003e“archived”: false\u003c/p\u003e\n\n\u003cpre\u003eIndicates whether the stock adjustment has been archived or not.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false},{"name":"location","full_name":"location","description":"\n\u003cp\u003eInformation about the location at which the stock adjustment was made.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"location[id]","description":"\n\u003cp\u003e“id”: 3824\u003c/p\u003e\n\n\u003cpre\u003eThe unique numeric identifier for the location.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shopify_id","full_name":"location[shopify_id]","description":"\n\u003cp\u003e“shopify_id”: 35616076169238\u003c/p\u003e\n\n\u003cpre\u003eThe identifier for the associated Shopify Location.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"stock_adjustment_reason","full_name":"stock_adjustment_reason","description":"\n\u003cp\u003eInformation about the reason for the stock adjustment.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"stock_adjustment_reason[id]","description":"\n\u003cp\u003e“id”: 3824\u003c/p\u003e\n\n\u003cpre\u003eThe unique numeric identifier for the stock adjustment reason.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reason","full_name":"stock_adjustment_reason[reason]","description":"\n\u003cp\u003e“reason”: “Damaged Products”\u003c/p\u003e\n\n\u003cpre\u003eThe description of the stock adjustment reason.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":["Response Example:\n\nHTTP/1.1 200 OK\n{\n  \"stock_adjustments\": [\n    {\n      \"id\": 1,\n      \"sequential_id\": 1000,\n      \"adjusted_at\": \"2022-08-23T21:55:46.000Z\",\n      \"created_at\": \"2022-08-22T19:35:04.000Z\",\n      \"updated_at\": \"2022-08-23T21:55:46.000Z\",\n      \"archived\": false,\n      \"stock_adjustment_reason\": {\n        \"id\": 1,\n        \"reason\": \"Damaged Products\"\n      },\n      \"location\": {\n        \"id\": 1,\n        \"shopify_id\": 34915680278,\n      }\n    },\n    {\n      \"id\": 2,\n      \"sequential_id\": 1001,\n      \"adjusted_at\": null,\n      \"created_at\": \"2022-08-23T21:55:59.000Z\",\n      \"updated_at\": \"2022-08-23T21:55:59.000Z\",\n      \"archived\": false,\n      \"stock_adjustment_reason\": null,\n      \"location\": {\n        \"id\": 1,\n        \"shopify_id\": 34915680278,\n      }\n    }\n  ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v2/stock_adjustments/show","name":"show","apis":[{"api_url":"/api/v2/stock_adjustments/{stock_adjustment_id}.json","http_method":"GET","short_description":"Retrieves a single stock adjustment by ID","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"No stock adjustments found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe ID of the stock adjustment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"The requested stock adjustment data","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003e“id”: 808950810\u003c/p\u003e\n\n\u003cpre\u003eA unique numeric identifier for the stock adjustment.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"sequential_id","full_name":"sequential_id","description":"\n\u003cp\u003e“sequential_id”: 23133\u003c/p\u003e\n\n\u003cpre\u003eA sequential number assigned to a stock adjustment.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"adjusted_at","full_name":"adjusted_at","description":"\n\u003cp\u003e“adjusted_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the stock adjustment was performed.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003e“created_at”: “2021-02-05T17:55:46.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the stock adjustment was created.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003e“updated_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the stock adjustment was last updated.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"archived","full_name":"archived","description":"\n\u003cp\u003e“archived”: false\u003c/p\u003e\n\n\u003cpre\u003eIndicates whether the stock adjustment has been archived or not.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false},{"name":"location","full_name":"location","description":"\n\u003cp\u003eInformation about the location at which the stock adjustment was made.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"location[id]","description":"\n\u003cp\u003e“id”: 3824\u003c/p\u003e\n\n\u003cpre\u003eThe unique numeric identifier for the location.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shopify_id","full_name":"location[shopify_id]","description":"\n\u003cp\u003e“shopify_id”: 35616076169238\u003c/p\u003e\n\n\u003cpre\u003eThe identifier for the associated Shopify Location.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"stock_adjustment_reason","full_name":"stock_adjustment_reason","description":"\n\u003cp\u003eInformation about the reason for the stock adjustment.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"stock_adjustment_reason[id]","description":"\n\u003cp\u003e“id”: 3824\u003c/p\u003e\n\n\u003cpre\u003eThe unique numeric identifier for the stock adjustment reason.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reason","full_name":"stock_adjustment_reason[reason]","description":"\n\u003cp\u003e“reason”: “Damaged Products”\u003c/p\u003e\n\n\u003cpre\u003eThe description of the stock adjustment reason.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"additional_properties":false,"headers":[]}],"examples":["Response Example:\n\nHTTP/1.1 200 OK\n{\n  \"id\": 1,\n  \"sequential_id\": 1000,\n  \"adjusted_at\": \"2022-08-23T21:55:46.000Z\",\n  \"created_at\": \"2022-08-22T19:35:04.000Z\",\n  \"updated_at\": \"2022-08-23T21:55:46.000Z\",\n  \"archived\": false,\n  \"stock_adjustment_reason\": {\n    \"id\": 1,\n    \"reason\": \"Damaged Products\"\n  },\n  \"location\": {\n    \"id\": 1,\n    \"shopify_id\": 34915680278,\n  }\n}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"suppliers":{"doc_url":"/api/docs/v2/suppliers","id":"suppliers","api_url":"/api","name":"Suppliers","short_description":null,"full_description":"","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/api/docs/v2/suppliers/index","name":"index","apis":[{"api_url":"/api/v2/suppliers.json","http_method":"GET","short_description":"Retrieves a list of suppliers","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eThe maximum number of records to return.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eDefault Value:\u003c/strong\u003e \u003ccode\u003e50\u003c/code\u003e\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eMaximum Value:\u003c/strong\u003e \u003ccode\u003e250\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"since_id","full_name":"since_id","description":"\n\u003cp\u003eReturn only suppliers with ID values greater than the provided ID. Use in combination with the \u003ccode\u003elimit\u003c/code\u003e parameter for pagination.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"updated_since","full_name":"updated_since","description":"\n\u003cp\u003eReturn only suppliers that have been updated on or after a specified date (Using ISO 8601 format; e.g. 2014-04-25T16:15:47-04:00)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"The requested supplier data","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003e“id”: 808950810\u003c/p\u003e\n\n\u003cpre\u003eA unique numeric identifier for the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003e“name”: “Paper Supplier”\u003c/p\u003e\n\n\u003cpre\u003eThe name of the Supplier in Stocky.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003e“created_at”: “2021-02-05T17:55:46.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the supplier was created.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003e“updated_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the supplier was last updated.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"company_name","full_name":"company_name","description":"\n\u003cp\u003e“company_name”: “Reams R Us”\u003c/p\u003e\n\n\u003cpre\u003eThe company name of the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"account_number","full_name":"account_number","description":"\n\u003cp\u003e“account_number”: “12345”\u003c/p\u003e\n\n\u003cpre\u003eThe account number associated with the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"contact_name","full_name":"contact_name","description":"\n\u003cp\u003e“contact_name”: “John Doe”\u003c/p\u003e\n\n\u003cpre\u003eThe name of the point of contact for the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"contact_email","full_name":"contact_email","description":"\n\u003cp\u003e“contact_email”: “john@example.com”\u003c/p\u003e\n\n\u003cpre\u003eThe email address of the point of contact for the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"address1","full_name":"address1","description":"\n\u003cp\u003e“address1”: “123 Fake St”\u003c/p\u003e\n\n\u003cpre\u003eThe first address line for the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"address2","full_name":"address2","description":"\n\u003cp\u003e“address2”: “Unit 100”\u003c/p\u003e\n\n\u003cpre\u003eThe second address line for the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"city","full_name":"city","description":"\n\u003cp\u003e“city”: “New York”\u003c/p\u003e\n\n\u003cpre\u003eThe city associated with the suppliers address.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"province_code","full_name":"province_code","description":"\n\u003cp\u003e“province_code”: “NY”\u003c/p\u003e\n\n\u003cpre\u003eThe province, state or territory associated with the suppliers address.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"country_name","full_name":"country_name","description":"\n\u003cp\u003e“country_name”: “United States”\u003c/p\u003e\n\n\u003cpre\u003eThe country associated with the suppliers address.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"zip","full_name":"zip","description":"\n\u003cp\u003e“zip”: “12345”\u003c/p\u003e\n\n\u003cpre\u003eThe zip or postal code associated with the suppliers address.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"phone","full_name":"phone","description":"\n\u003cp\u003e“phone”: “123-456-7890”\u003c/p\u003e\n\n\u003cpre\u003eThe phone number of the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"phone_toll_free","full_name":"phone_toll_free","description":"\n\u003cp\u003e“phone_toll_free”: “1-800-123-4567”\u003c/p\u003e\n\n\u003cp\u003eThe toll free phone number of the supplier.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"fax","full_name":"fax","description":"\n\u003cp\u003e“fax”: “1-234-567-8901”\u003c/p\u003e\n\n\u003cpre\u003eThe fax number of the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"is_hidden","full_name":"is_hidden","description":"\n\u003cp\u003e“is_hidden”: false\u003c/p\u003e\n\n\u003cpre\u003eWhether or not the supplier is hidden within the Stocky app.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":["Response Example:\n\nHTTP/1.1 200 OK\n{\n  \"suppliers\": [\n    {\n      \"id\": 1,\n      \"name\": \"Paper Supplier\",\n      \"created_at\": \"2022-01-01T01:20:30.000Z\",\n      \"updated_at\": \"2022-01-02T02:30:40.000Z\",\n      \"company_name\": \"Reams R Us\",\n      \"account_number\": \"456942\",\n      \"contact_name\": \"John Doe\",\n      \"contact_email\": \"john@example.com\",\n      \"address1\": \"456 Fake Rd\",\n      \"address2\": \"Unit 2000\",\n      \"city\": \"New York\",\n      \"province_code\": \"NY\",\n      \"country_name\": \"United States\",\n      \"zip\": \"12345\",\n      \"phone\": \"456-789-1234\",\n      \"phone_toll_free\": \"1-800-456-7890\",\n      \"fax\": \"1-465-789-1234\",\n      \"is_hidden\": false\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Metal Supplier\",\n      \"created_at\": \"2022-01-01T01:20:30.000Z\",\n      \"updated_at\": \"2022-01-02T02:30:40.000Z\",\n      \"company_name\": \"Sheet Metal Inc\",\n      \"account_number\": \"564234\",\n      \"contact_name\": \"Jane Smith\",\n      \"contact_email\": \"jane@example.com\",\n      \"address1\": \"123 Fake St\",\n      \"address2\": \"Unit 101\",\n      \"city\": \"Scranton\",\n      \"province_code\": \"PA\",\n      \"country_name\": \"United States\",\n      \"zip\": \"67890\",\n      \"phone\": \"123-456-7890\",\n      \"phone_toll_free\": \"1-800-789-4567\",\n      \"fax\": \"1-123-456-7890\",\n      \"is_hidden\": true\n    }\n  ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v2/suppliers/show","name":"show","apis":[{"api_url":"/api/v2/suppliers/{supplier_id}.json","http_method":"GET","short_description":"Retrieves a single supplier by ID","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"No supplier found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe ID of the supplier.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"The requested supplier data","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003e“id”: 808950810\u003c/p\u003e\n\n\u003cpre\u003eA unique numeric identifier for the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003e“name”: “Paper Supplier”\u003c/p\u003e\n\n\u003cpre\u003eThe name of the Supplier in Stocky.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003e“created_at”: “2021-02-05T17:55:46.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the supplier was created.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003e“updated_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the supplier was last updated.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"company_name","full_name":"company_name","description":"\n\u003cp\u003e“company_name”: “Reams R Us”\u003c/p\u003e\n\n\u003cpre\u003eThe company name of the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"account_number","full_name":"account_number","description":"\n\u003cp\u003e“account_number”: “12345”\u003c/p\u003e\n\n\u003cpre\u003eThe account number associated with the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"contact_name","full_name":"contact_name","description":"\n\u003cp\u003e“contact_name”: “John Doe”\u003c/p\u003e\n\n\u003cpre\u003eThe name of the point of contact for the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"contact_email","full_name":"contact_email","description":"\n\u003cp\u003e“contact_email”: “john@example.com”\u003c/p\u003e\n\n\u003cpre\u003eThe email address of the point of contact for the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"address1","full_name":"address1","description":"\n\u003cp\u003e“address1”: “123 Fake St”\u003c/p\u003e\n\n\u003cpre\u003eThe first address line for the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"address2","full_name":"address2","description":"\n\u003cp\u003e“address2”: “Unit 100”\u003c/p\u003e\n\n\u003cpre\u003eThe second address line for the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"city","full_name":"city","description":"\n\u003cp\u003e“city”: “New York”\u003c/p\u003e\n\n\u003cpre\u003eThe city associated with the suppliers address.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"province_code","full_name":"province_code","description":"\n\u003cp\u003e“province_code”: “NY”\u003c/p\u003e\n\n\u003cpre\u003eThe province, state or territory associated with the suppliers address.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"country_name","full_name":"country_name","description":"\n\u003cp\u003e“country_name”: “United States”\u003c/p\u003e\n\n\u003cpre\u003eThe country associated with the suppliers address.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"zip","full_name":"zip","description":"\n\u003cp\u003e“zip”: “12345”\u003c/p\u003e\n\n\u003cpre\u003eThe zip or postal code associated with the suppliers address.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"phone","full_name":"phone","description":"\n\u003cp\u003e“phone”: “123-456-7890”\u003c/p\u003e\n\n\u003cpre\u003eThe phone number of the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"phone_toll_free","full_name":"phone_toll_free","description":"\n\u003cp\u003e“phone_toll_free”: “1-800-123-4567”\u003c/p\u003e\n\n\u003cp\u003eThe toll free phone number of the supplier.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"fax","full_name":"fax","description":"\n\u003cp\u003e“fax”: “1-234-567-8901”\u003c/p\u003e\n\n\u003cpre\u003eThe fax number of the supplier.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"is_hidden","full_name":"is_hidden","description":"\n\u003cp\u003e“is_hidden”: false\u003c/p\u003e\n\n\u003cpre\u003eWhether or not the supplier is hidden within the Stocky app.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":["Response Example:\n\nHTTP/1.1 200 OK\n{\n  \"id\": 1,\n  \"name\": \"Paper Supplier\",\n  \"created_at\": \"2022-01-01T01:20:30.000Z\",\n  \"updated_at\": \"2022-01-02T02:30:40.000Z\",\n  \"company_name\": \"Reams R Us\",\n  \"account_number\": \"456942\",\n  \"contact_name\": \"John Doe\",\n  \"contact_email\": \"john@example.com\",\n  \"address1\": \"456 Fake Rd\",\n  \"address2\": \"Unit 2000\",\n  \"city\": \"New York\",\n  \"province_code\": \"NY\",\n  \"country_name\": \"United States\",\n  \"zip\": \"12345\",\n  \"phone\": \"456-789-1234\",\n  \"phone_toll_free\": \"1-800-456-7890\",\n  \"fax\": \"1-465-789-1234\",\n  \"is_hidden\": false\n}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"tax_types":{"doc_url":"/api/docs/v2/tax_types","id":"tax_types","api_url":"/api","name":"Tax Type","short_description":null,"full_description":"","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/api/docs/v2/tax_types/index","name":"index","apis":[{"api_url":"/api/v2/tax_types.json","http_method":"GET","short_description":"Retrieves a list of tax types","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"limit","full_name":"limit","description":"\n\u003cp\u003eThe maximum number of records to return.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eDefault Value:\u003c/strong\u003e \u003ccode\u003e50\u003c/code\u003e\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eMaximum Value:\u003c/strong\u003e \u003ccode\u003e250\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"since_id","full_name":"since_id","description":"\n\u003cp\u003eReturn only tax types with an ID greater than the specified ID.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"The requested tax type data","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003e“id”: 808950810\u003c/p\u003e\n\n\u003cpre\u003eA unique numeric identifier for the tax type.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003e“name”: “Value-Added Tax”\u003c/p\u003e\n\n\u003cpre\u003eThe tax type\u0026#39;s name.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"code","full_name":"code","description":"\n\u003cp\u003e“code”: “VAT”\u003c/p\u003e\n\n\u003cpre\u003eThe tax type\u0026#39;s code.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"tax_rate","full_name":"tax_rate","description":"\n\u003cp\u003e“tax_rate”: “12.0”\u003c/p\u003e\n\n\u003cpre\u003eThe tax type\u0026#39;s rate.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"purpose","full_name":"purpose","description":"\n\u003cp\u003e“purpose”: “purchase”\u003c/p\u003e\n\n\u003cpre\u003eThe tax type\u0026#39;s purpose.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"accounting_tax_type","full_name":"accounting_tax_type","description":"\n\u003cp\u003e“accounting_tax_type”: “VAT”\u003c/p\u003e\n\n\u003cpre\u003eThe tax type\u0026#39;s accounting tax type.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003e“created_at”: “2021-02-05T17:55:46.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the tax type was created.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003e“updated_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the tax type was last updated.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":["Response Example:\n\nHTTP/1.1 200 OK\n{\n  \"tax_types\": [\n    {\n      \"id\": 1,\n      \"name\": \"Value-added tax\",\n      \"code\": \"VAT\",\n      \"tax_rate\": \"10.0\",\n      \"purpose\": \"purchase\",\n      \"accounting_tax_type\": null,\n      \"created_at\": \"2022-08-22T19:35:04.000Z\",\n      \"updated_at\": \"2022-08-23T21:55:46.000Z\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Goods and services tax\",\n      \"code\": \"GST\",\n      \"tax_rate\": \"10.0\",\n      \"purpose\": \"purchase\",\n      \"accounting_tax_type\": null,\n      \"created_at\": \"2022-08-22T19:35:04.000Z\",\n      \"updated_at\": \"2022-08-23T21:55:46.000Z\"\n    }\n  ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v2/tax_types/show","name":"show","apis":[{"api_url":"/api/v2/tax_types/{tax_type_id}.json","http_method":"GET","short_description":"Retrieves a single tax type by ID","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"No tax types found","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe ID of the tax type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"The requested tax type data","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003e“id”: 808950810\u003c/p\u003e\n\n\u003cpre\u003eA unique numeric identifier for the tax type.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003e“name”: “Value-Added Tax”\u003c/p\u003e\n\n\u003cpre\u003eThe tax type\u0026#39;s name.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"code","full_name":"code","description":"\n\u003cp\u003e“code”: “VAT”\u003c/p\u003e\n\n\u003cpre\u003eThe tax type\u0026#39;s code.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"tax_rate","full_name":"tax_rate","description":"\n\u003cp\u003e“tax_rate”: “12.0”\u003c/p\u003e\n\n\u003cpre\u003eThe tax type\u0026#39;s rate.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"purpose","full_name":"purpose","description":"\n\u003cp\u003e“purpose”: “purchase”\u003c/p\u003e\n\n\u003cpre\u003eThe tax type\u0026#39;s purpose.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"accounting_tax_type","full_name":"accounting_tax_type","description":"\n\u003cp\u003e“accounting_tax_type”: “VAT”\u003c/p\u003e\n\n\u003cpre\u003eThe tax type\u0026#39;s accounting tax type.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003e“created_at”: “2021-02-05T17:55:46.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the tax type was created.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003e“updated_at”: “2021-02-09T19:47:30.000Z”\u003c/p\u003e\n\n\u003cpre\u003eThe date and time (ISO 8601 format) when the tax type was last updated.\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":["Response Example:\n\nHTTP/1.1 200 OK\n{\n  \"id\": 1,\n  \"name\": \"Value-added tax\",\n  \"code\": \"VAT\",\n  \"tax_rate\": \"10.0\",\n  \"purpose\": \"purchase\",\n  \"accounting_tax_type\": null,\n  \"created_at\": \"2022-08-22T19:35:04.000Z\",\n  \"updated_at\": \"2022-08-23T21:55:46.000Z\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}