### Example Filter Query Source: https://docs.zenventory.com/ This example demonstrates how to construct a query string for filtering customer orders by order number and item quantity with specific conditional logic. ```url "?orderNumber=101156&orderNumberConditional=matches&itemQuantity=5&itemQuantityConditional=greater_or_equal" ``` -------------------------------- ### Get Purchase Order Response Sample Source: https://docs.zenventory.com/ This is a sample JSON response when successfully retrieving a single purchase order. ```json { "id": 333, "orderNumber": "PO#375", "supplier": { "id": 35, "name": "Gift" }, "warehouse": { "id": 1, "name": "Main Warehouse" }, "client": null, "user": { "id": 1, "name": "Mr Sparks" }, "draft": true, "completed": false, "deleted": false, "createdDate": "2020-12-02T10:24:26-07:00", "preparedDate": "", "requiredByDate": "2020-12-02", "projectNumber": "", "notes": "", "shipMethod": "", "terms": "", "userField1": "", "userField2": "", "userField3": "", "items": [ { "id": 456, "itemId": 2306, "sku": "FumoFumo-002", "description": "Marisa Kirisame", "quantity": 10, "uom": "Each", "unitCost": 20 }, { "id": 457, "itemId": 2330, "sku": "FumoFumo-006", "description": "Alice Margatroid", "quantity": 10, "uom": "Each", "unitCost": 20 } ] } ``` -------------------------------- ### Example Pagination Metadata Source: https://docs.zenventory.com/ Shows the structure of pagination metadata, providing information about the total count, current page, items per page, and total pages for a result set. ```json { "count": 70, "page": 1, "perPage": 20, "totalPages": 4 } ``` -------------------------------- ### Example Error Response Source: https://docs.zenventory.com/ Illustrates a typical error response structure, including the error code, a descriptive message, and the specific parameter that caused the issue. ```json { "code": "invalid_parameter", "message": "Invalid value for parameter.", "parameter": "orderNumber" } ``` -------------------------------- ### Purchase Order Item Model Example Source: https://docs.zenventory.com/ Represents a single item within a purchase order, including details like SKU, description, quantity, and unit cost. This model is used to track individual products being ordered. ```json { "id": 123, "itemId": 2306, "sku": "FumoFumo-006", "description": "Alice Margatroid", "quantity": 10, "uom": "Each", "unitCost": 20 } ``` -------------------------------- ### Cycle Count Location Model Example Source: https://docs.zenventory.com/ An example JSON object representing a cycle count location entry. This includes details about the location, completion status, and approval information. ```json { "id": 150, "location": { "id": 1800, "name": "Isle A" }, "accuracy": 100, "completed": true, "completedDate": "2021-02-01T12:50:30-07:00", "completedBy": { "id": 1, "name": "Mr Sparks" }, "approved": true, "approvedDate": "2021-02-02T10:50:30-07:00", "approvedBy": { "id": 1, "name": "Mr Sparks" } } ``` -------------------------------- ### List Kit Inventory Response Sample Source: https://docs.zenventory.com/ This JSON sample shows the structure of a successful response when listing kit inventory. It includes details about each kit item and its buildable quantity. ```json { "inventory": [ { "item": { "id": 1932, "sku": "KITM1", "upc": "", "description": "Kit Master 1", "category": "Kits" }, "client": null, "buildable": 6 }, { "item": { "id": 2316, "sku": "KML-01", "upc": "", "description": "Kit Master Level One", "category": "Kits" }, "client": null, "buildable": 0 } ] } ``` -------------------------------- ### Reports - Get Source: https://docs.zenventory.com/ Retrieves a report. ```APIDOC ## GET /reports ### Description Retrieves a report. ### Method GET ### Endpoint /reports ``` -------------------------------- ### List Assembly Inventory Response Sample Source: https://docs.zenventory.com/ This JSON response shows the structure for a successful retrieval of assembly inventory. It includes details on item IDs, SKUs, descriptions, stock levels, and buildable quantities. ```json { "inventory": [ { "item": { "id": 2733, "sku": "AS-01", "upc": "", "description": "Assembly Main", "category": "Assembly" }, "client": null, "inStock": 10, "allocated": 0, "sellable": 10, "underPar": 0, "buildable": 20 }, { "item": { "id": 2409, "sku": "LEG-00", "upc": "", "description": "The Legacy", "category": "Assembly" }, "client": null, "inStock": 0, "allocated": 0, "sellable": 0, "underPar": 0, "buildable": 0 } ] } ``` -------------------------------- ### Items - Get Source: https://docs.zenventory.com/ Retrieves a specific item by its ID. ```APIDOC ## GET /items/{id} ### Description Retrieves a specific item by its ID. ### Method GET ### Endpoint /items/{id} ``` -------------------------------- ### Create Item Response Sample Source: https://docs.zenventory.com/ This is a sample JSON response received after successfully creating an item. It includes the assigned ID and all the details of the created item. ```json { "id": 2330, "sku": "FumoFumo-006", "upc": "", "description": "Alice Margatroid", "category": "Fumo", "client": null, "baseUom": "Each", "unitCost": 10, "leadTime": 0, "defaultEconOrder": 0, "rrp": 0, "price": 50, "active": true, "kit": false, "assembly": false, "perishable": false, "trackLot": false, "serialized": false, "nonInventory": false, "weight": 0, "storageLength": 0, "storageWidth": 0, "storageHeight": 0, "storageVolume": 0, "safetyStock": 0, "userField1": "", "userField2": "", "userField3": "", "userField4": "", "userField5": "", "userField6": "", "createdDate": "2017-08-07T10:45:53-07:00", "modifiedDate": "2017-08-07T10:45:53-07:00", "notes": "" } ``` -------------------------------- ### Get Purchase Order Source: https://docs.zenventory.com/ Retrieves a single purchase order by its ID. ```APIDOC ## Get Purchase Order ### Description Get a single purchase order. ### Method GET ### Endpoint /purchase-orders/{id} #### Path Parameters - **id** (integer) - Required - Id of the purchase order. ### Response #### Success Response (200) - **id** (integer) - - **orderNumber** (string) - - **supplier** (object) - - **warehouse** (object) - - **client** (null) - - **user** (object) - - **draft** (boolean) - - **completed** (boolean) - - **deleted** (boolean) - - **createdDate** (string) - - **preparedDate** (string) - - **requiredByDate** (string) - - **projectNumber** (string) - - **notes** (string) - - **shipMethod** (string) - - **terms** (string) - - **userField1** (string) - - **userField2** (string) - - **userField3** (string) - - **items** (array) - ### Response Example ```json { "id": 333, "orderNumber": "PO#375", "supplier": { "id": 35, "name": "Gift" }, "warehouse": { "id": 1, "name": "Main Warehouse" }, "client": null, "user": { "id": 1, "name": "Mr Sparks" }, "draft": true, "completed": false, "deleted": false, "createdDate": "2020-12-02T10:24:26-07:00", "preparedDate": "", "requiredByDate": "2020-12-02", "projectNumber": "", "notes": "", "shipMethod": "", "terms": "", "userField1": "", "userField2": "", "userField3": "", "items": [ { "id": 456, "itemId": 2306, "sku": "FumoFumo-002", "description": "Marisa Kirisame", "quantity": 10, "uom": "Each", "unitCost": 20 }, { "id": 457, "itemId": 2330, "sku": "FumoFumo-006", "description": "Alice Margatroid", "quantity": 10, "uom": "Each", "unitCost": 20 } ] } ``` ``` -------------------------------- ### Transfer Orders - Get Source: https://docs.zenventory.com/ Retrieves a specific transfer order by its ID. ```APIDOC ## GET /transfer-orders/{id} ### Description Retrieves a specific transfer order by its ID. ### Method GET ### Endpoint /transfer-orders/{id} ``` -------------------------------- ### List Items Response Sample Source: https://docs.zenventory.com/ This is a sample JSON response for the 'get/items' endpoint. It includes a list of items with their details and metadata about the pagination. ```json { "items": [ { "id": 2306, "sku": "FumoFumo-002", "upc": "", "description": "Marisa Kirisame", "category": "Fumo", "client": null, "baseUom": "Each", "unitCost": 10, "leadTime": 0, "defaultEconOrder": 0, "rrp": 0, "price": 50, "active": true, "kit": false, "assembly": false, "perishable": false, "trackLot": false, "serialized": false, "nonInventory": false, "weight": 0, "storageLength": 0, "storageWidth": 0, "storageHeight": 0, "storageVolume": 0, "safetyStock": 0, "userField1": "", "userField2": "", "userField3": "", "userField4": "", "userField5": "", "userField6": "", "createdDate": "2017-08-06T10:45:53-07:00", "modifiedDate": "2017-08-06T10:45:53-07:00", "notes": "", "additionalFields": { "units": [ { "name": "Each", "quantity": 1 } ] } }, { "id": 2330, "sku": "FumoFumo-006", "upc": "", "description": "Alice Margatroid", "category": "Fumo", "client": null, "baseUom": "Each", "unitCost": 10, "leadTime": 0, "defaultEconOrder": 0, "rrp": 0, "price": 50, "active": true, "kit": false, "assembly": false, "perishable": false, "trackLot": false, "serialized": false, "nonInventory": false, "weight": 0, "storageLength": 0, "storageWidth": 0, "storageHeight": 0, "storageVolume": 0, "safetyStock": 0, "userField1": "", "userField2": "", "userField3": "", "userField4": "", "userField5": "", "userField6": "", "createdDate": "2017-08-07T10:45:53-07:00", "modifiedDate": "2017-08-07T10:45:53-07:00", "notes": "", "additionalFields": { "units": [ { "name": "Each", "quantity": 1 }, { "name": "Case", "quantity": 6 } ] } } ], "meta": { "count": 2, "page": 1, "perPage": 20, "totalPages": 1 } } ``` -------------------------------- ### List Purchase Orders Response Sample Source: https://docs.zenventory.com/ This is a sample JSON response for a successful request to list purchase orders. It includes details about the purchase orders and metadata about the pagination. ```json { "purchaseOrders": [ { "id": 333, "orderNumber": "PO#375", "supplier": { "id": 35, "name": "Gift" }, "warehouse": { "id": 1, "name": "Main Warehouse" }, "client": "name", "user": { "id": 1, "name": "Mr Sparks" }, "draft": true, "completed": false, "deleted": false, "createdDate": "20220-12-02T10:24:26-07:00", "preparedDate": "", "requiredByDate": "2020-12-02", "projectNumber": "", "notes": "", "shipMethod": "", "terms": "", "userField1": "", "userField2": "", "userField3": "", "items": [ { "id": 456, "itemId": 2306, "sku": "FumoFumo-002", "description": "Marisa Kirisame", "quantity": 10, "uom": "Each", "unitCost": 20 }, { "id": 457, "itemId": 2330, "sku": "FumoFumo-006", "description": "Alice Margatroid", "quantity": 10, "uom": "Each", "unitCost": 20 } ] }, { "id": 334, "orderNumber": "PO#376", "supplier": { "id": 35, "name": "Gift" }, "warehouse": { "id": 1, "name": "Main Warehouse" }, "client": "name", "user": { "id": 1, "name": "Mr Sparks" }, "draft": true, "completed": false, "deleted": false, "createdDate": "20220-12-04T12:09:37-07:00", "preparedDate": "", "requiredByDate": "2020-12-05", "projectNumber": "", "notes": "", "shipMethod": "", "terms": "", "userField1": "", "userField2": "", "userField3": "", "items": [ { "id": 458, "itemId": 2305, "sku": "FumoFumo-001", "description": "Reimu Hakurei", "quantity": 10, "uom": "Each", "unitCost": 20 }, { "id": 459, "itemId": 2308, "sku": "FumoFumo-004", "description": "Remilia Scarlet", "quantity": 5, "uom": "Each", "unitCost": 20 } ] }, "..." ], "meta": { "count": 70, "page": 1, "perPage": 20, "totalPages": 4 } } ``` -------------------------------- ### Purchase Orders - Get Source: https://docs.zenventory.com/ Retrieves a specific purchase order by its ID. ```APIDOC ## GET /purchase-orders/{id} ### Description Retrieves a specific purchase order by its ID. ### Method GET ### Endpoint /purchase-orders/{id} ``` -------------------------------- ### Customer Orders - Create Source: https://docs.zenventory.com/ Creates a new customer order. ```APIDOC ## POST /customer-orders ### Description Creates a new customer order. ### Method POST ### Endpoint /customer-orders ``` -------------------------------- ### Cycle Counts - Get Source: https://docs.zenventory.com/ Retrieves a specific cycle count by its ID. ```APIDOC ## GET /cycle-counts/{id} ### Description Retrieves a specific cycle count by its ID. ### Method GET ### Endpoint /cycle-counts/{id} ``` -------------------------------- ### Customer Orders - Get Source: https://docs.zenventory.com/ Retrieves a specific customer order by its ID. ```APIDOC ## GET /customer-orders/{id} ### Description Retrieves a specific customer order by its ID. ### Method GET ### Endpoint /customer-orders/{id} ``` -------------------------------- ### Customer Order Response Sample Source: https://docs.zenventory.com/ A sample JSON response for a successful retrieval of customer orders. It includes order details, customer information, addresses, and line items. The meta object provides pagination information. ```json { "customerOrders": [ { "id": 10376, "orderNumber": "101156", "orderReference": "", "customer": { "id": 6382, "title": "", "name": "Anna", "surname": "Fuugo", "email": "email@address.com", "company": "Aconite", "accountNumber": "S01E07" }, "client": null, "orderedDate": "2022-09-20T18:31:01.000Z", "createdDate": "2022-09-20T18:31:01.000Z", "modifiedDate": "2022-09-20T18:31:01.000Z", "orderPlaced": true, "createdBy": { "id": 1, "name": "Mr Sparks" }, "completed": false, "completedDate": "", "cancelled": false, "canclledDate": "", "cancelledBy": null, "onHold": false, "onHoldUntil": "", "postageAccount": "sender", "buyerPaidShipping": 0, "shippingAddress": { "id": 666, "company": "Aconite", "name": "Anna Fuugo", "line1": "123 Home Street", "line2": "", "line3": "", "city": "Phoenix", "state": "AZ", "zip": "85013", "country": "United States", "countryCode": "US", "phone": "555-555-5555", "code": "anna-test", "verifiedStatus": "awaiting", "verifiedDate": "", "verifiedMessage": "" }, "billingAddress": { "id": 666, "company": "Aconite", "name": "Anna Fuugo", "line1": "123 Home Street", "line2": "", "line3": "", "city": "Phoenix", "state": "AZ", "zip": "85013", "country": "United States", "countryCode": "US", "phone": "555-555-5555", "code": "anna-test", "verifiedStatus": "awaiting", "verifiedDate": "", "verifiedMessage": "" }, "shipVia": "fedex_ground", "shipViaPackaging": "", "shipViaConfirmation": "direct_signature", "dryIceWeight": 0, "packageSku": "", "shipFromWarehouse": { "id": 1, "name": "Main Warehouse" }, "projectNumber": "", "discountPercentage": 0, "orderSource": "REST API", "internalNote": "", "noteFromCustomer": "", "noteToCustomer": "", "notificationEmail": "", "userField1": "", "userField2": "", "userField3": "", "myList1": "", "myList2": "", "tags": [ { "id": 1, "tag": "Expedite", "note": "Expedite this order." }], "items": [ { "id": 13664, "itemId": 2306, "sku": "FumoFumo-002", "description": "Marisa Kirisame", "orderQuantity": 5, "uom": "Each", "quantity": 5, "allocatedQuantity": 0, "pickedQuantity": 0, "price": 50, "discountPercentage": 0, "partOfKit": false, "componentOf": 0, "additionalFields": null }, { "id": 13665, "itemId": 2330, "sku": "FumoFumo-006", "description": "Alice Margatroid", "orderQuantity": 1, "uom": "Case", "quantity": 6, "allocatedQuantity": 0, "pickedQuantity": 0, "price": 50, "discountPercentage": 0, "partOfKit": false, "componentOf": 0, "additionalFields": null } ] }, "..." ], "meta": { "count": 70, "page": 1, "perPage": 20, "totalPages": 4 } } ``` -------------------------------- ### Cycle Counts - Get Adjustment Source: https://docs.zenventory.com/ Retrieves a specific adjustment for a cycle count. ```APIDOC ## GET /cycle-counts/adjustments/{id} ### Description Retrieves a specific adjustment for a cycle count. ### Method GET ### Endpoint /cycle-counts/adjustments/{id} ``` -------------------------------- ### Create Adjustment Response (201 Success) Source: https://docs.zenventory.com/ This is a sample successful response (HTTP 201) when creating an inventory adjustment. It includes details about the adjustment, its progress, accuracy, associated warehouse, creation and completion timestamps, and approval information. ```json { "id": 120, "adjustment": true, "progress": 100, "accuracy": 95, "warehouse": { "id": 1, "name": "Main Warehouse" }, "createdDate": "2021-02-01T11:00:30-07:00", "createdBy": { "id": 1, "name": "Mr Sparks" }, "claimedBy": null, "completed": true, "completedDate": "2021-02-01T11:00:30-07:00", "completedBy": { "id": 1, "name": "Mr Sparks" }, "approved": true, "approvedDate": "2021-02-01T11:00:30-07:00", "approvedBy": { "id": 1, "name": "Mr Sparks" }, "locations": [ { "id": 151, "location": { "id": 1502, "name": "Shelf A" }, "accuracy": 95, "completed": true, "completedDate": "2021-02-01T11:00:30-07:00", "completedBy": { "id": 1, "name": "Mr Sparks" }, "approved": true, "approvedDate": "2021-02-01T11:00:30-07:00", "approvedBy": { "id": 1, "name": "Mr Sparks" } }, { "id": 152, "location": { "id": 1498, "name": "Shelf B" }, "accuracy": 100, "completed": true, "completedDate": "2021-02-01T11:00:30-07:00", "completedBy": { "id": 1, "name": "Mr Sparks" }, "approved": true, "approvedDate": "2021-02-01T11:00:30-07:00", "approvedBy": { "id": 1, "name": "Mr Sparks" } } ] } ``` -------------------------------- ### Get Report Source: https://docs.zenventory.com/ Access reports via API rather than the UI. Parameters and output will vary by report. ```APIDOC ## Get Report ### Description Access reports via API rather than the UI. Parameters and output will vary by report. ### Category | Report Keys --- **inbound** | ibn_sup, ibn_date, ibn_date_export, ibn_received_serials **purchasing** | pur_supsum, pur_supdet, pur_cat, pur_item, pur_supcat **inventory** | inv_cc, inv_vvperitem, inv_instock, inv_inwarehouse, inv_exp, inv_usagesummary, inv_unallocated, inv_delivered, inv_received, inv_serials, inv_lots, inv_acc, inv_ccdetails, inv_stockinout, inv_stockinoutsummary, inv_kit, inv_assembly, inv_assemble, inv_export, inv_forecast, inv_missingdamaged, inv_traceitem **fulfillment** | ful_inc, ful_order, ful_daily, ful_order_detail, ful_order_performance, ful_order_picker_perf, ful_readyship, ful_order_returns, ful_order_returns_detail, ful_date, ful_warehouse_transfer,ful_quickissue, ful_quickissue_detail, inv_move **shipment** | ship_car, ship_summary, ship_detail, ship_item_range, ship_totals, ship_item_value, ship_costs, ship_client_sum, ship_client, ship_methods, ship_daily_activities ### Inbound Report Details Key | Title | Format | Parameters --- ibn_sup | Inbound by Supplier | Both | csv, clientId/Name, warehouseId/Name, warehouses, warehousesAll, supplierId/Name, endDate, showComplete ibn_date | Inbound by Date | Both | csv, clientId/Name, warehouseId/Name, warehouses, warehousesAll, startDate, endDate, showComplete ibn_date_export | Purchase Orders Export By Date | CSV | clientId/Name, warehouseId/Name, warehouses, warehousesAll, startDate, endDate, showComplete ibn_received_serials | Received Serial Numbers | CSV | clientId/Name, warehouseId/Name, warehouses, warehousesAll, startDate, endDate, orderNumber ### Purchasing Report Details Key | Title | Format | Parameters --- pur_supsum | Purchasing By Supplier Summary | PDF | clientId/Name, supplierId/Name startDate, endDate pur_supdet | Purchasing By Supplier Detail | PDF | clientId/Name, supplierId/Name, startDate, endDate pur_cat | Purchasing By Category | PDF | clientId/Name, category, startDate, endDate pur_item | Purchasing By Item | PDF | clientId/Name, itemId/Sku, startDate, endDate pur_supcat | Supplier Catalog By Client | CSV | clientId/Name, supplierId/Name ### Inventory Report Details Key | Title | Format | Parameters --- inv_cc | Current Cost of Inventory By Category | Both | csv, clientId/Name, warehouseId/Name (All), warehouses, warehousesAll inv_vvperitem | Current Cost of Inventory By SKU | Both | csv, clientId/Name, warehouseId/Name (All), warehouses, warehousesAll inv_instock | Inventory In Stock | PDF | clientId/Name, warehouseId/Namewarehouses, warehousesAll, warehouses, warehousesAll inv_inwarehouse | Inventory In Warehouses | PDF | clientId/Name, warehouseId/Name, warehouses, warehousesAll, itemId/Sku, category inv_exp | Expiring Inventory | PDF | clientId/Name, warehouseId/Name, warehouses, warehousesAll, startDate, endDate inv_usagesummary | Inventory Usage Summary | PDF | clientId/Name, warehouseId/Name, itemId/Sku, category inv_unallocated | Unallocated Order Items | Both | csv, clientId/Name inv_delivered | Delivered Inventory | Both | csv, clientId/Name, warehouseId/Name, warehouses, warehousesAll, startDate, endDate inv_received | Received Inventory | Both | csv, clientId/Name, warehouseId/Name, warehouses, warehousesAll, itemId/Sku, startDate, endDate inv_serials | Serial Numbers By Locations | PDF | clientId/Name, warehouseId/Name, warehouses, warehousesAll ``` -------------------------------- ### List Inventory Response Sample Source: https://docs.zenventory.com/ This is a sample JSON response for the 'List Inventory' endpoint. It shows the structure of inventory data, including item details, stock levels, and allocated quantities. ```json { "inventory": [ { "item": { "id": 2306, "sku": "FumoFumo-002", "upc": "", "description": "Marisa Kirisame", "category": "Fumo" }, "client": null, "inStock": 8226, "allocated": 43, "sellable": 8176, "underPar": 0, "inbound": 65 }, { "item": { "id": 2330, "sku": "FumoFumo-006", "upc": "", "description": "Alice Margatroid", "category": "Fumo" }, "client": null, "inStock": 9974, "allocated": 72, "sellable": 9895, "underPar": 0, "inbound": 10 } ] } ``` -------------------------------- ### Items - Create Source: https://docs.zenventory.com/ Creates a new item. ```APIDOC ## POST /items ### Description Creates a new item. ### Method POST ### Endpoint /items ``` -------------------------------- ### Get Item Source: https://docs.zenventory.com/ Retrieves a single item by its ID, with options to include related units of measurement and bill of materials. ```APIDOC ## Get Item ### Description Get a single item by its ID. You can optionally include the item's units of measurement and bill of materials in the response. ### Method GET ### Endpoint /rest/items/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - Id of the item. #### Query Parameters - **includeUnits** (boolean) - Optional - Default: false. True to include the items' units of measurements in the additional fields. - **includeBom** (boolean) - Optional - Default: false. True to include the items' bill of materials in the additional fields. ### Response #### Success Response (200) - **id** (integer) - **sku** (string) - **upc** (string) - **description** (string) - **category** (string) - **client** (null) - **baseUom** (string) - **unitCost** (number) - **leadTime** (number) - **defaultEconOrder** (number) - **rrp** (number) - **price** (number) - **active** (boolean) - **kit** (boolean) - **assembly** (boolean) - **perishable** (boolean) - **trackLot** (boolean) - **serialized** (boolean) - **nonInventory** (boolean) - **weight** (number) - **storageLength** (number) - **storageWidth** (number) - **storageHeight** (number) - **storageVolume** (number) - **safetyStock** (number) - **userField1** (string) - **userField2** (string) - **userField3** (string) - **userField4** (string) - **userField5** (string) - **userField6** (string) - **createdDate** (string) - **modifiedDate** (string) - **notes** (string) - **additionalFields** (object) - **units** (array) - **name** (string) - **quantity** (number) ### Request Example ```json { "example": "request body" } ``` ### Response Example #### Success Response (200) ```json { "id": 2330, "sku": "FumoFumo-006", "upc": "", "description": "Alice Margatroid", "category": "Fumo", "client": null, "baseUom": "Each", "unitCost": 10, "leadTime": 0, "defaultEconOrder": 0, "rrp": 0, "price": 50, "active": true, "kit": false, "assembly": false, "perishable": false, "trackLot": false, "serialized": false, "nonInventory": false, "weight": 0, "storageLength": 0, "storageWidth": 0, "storageHeight": 0, "storageVolume": 0, "safetyStock": 0, "userField1": "", "userField2": "", "userField3": "", "userField4": "", "userField5": "", "userField6": "", "createdDate": "2017-08-07T10:45:53-07:00", "modifiedDate": "2017-08-07T10:45:53-07:00", "notes": "", "additionalFields": { "units": [ { "name": "Each", "quantity": 1 }, { "name": "Case", "quantity": 6 } ] } } ``` ``` -------------------------------- ### Get Customer Order Source: https://docs.zenventory.com/ Retrieves a single customer order by its ID. Optionally includes metadata about picked items. ```APIDOC ## Get Customer Order ### Description Get a single customer order. ### Method GET ### Endpoint /rest/customer-orders/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - Id of the customer order. #### Query Parameters - **includePickedItemMetadata** (boolean) - Optional - Default: false - True to include the lot numbers, expiration dates, and serial numbers picked for the line items in the additional fields. ### Responses #### Success Response (200) - **id** (integer) - **orderNumber** (integer) - **orderReference** (string) - **customer** (object) - **client** (null) - **orderedDate** (string) - **createdDate** (string) - **modifiedDate** (string) - **orderPlaced** (boolean) - **createdBy** (object) - **completed** (boolean) - **completedDate** (string) - **cancelled** (boolean) - **cancelledDate** (string) - **cancelledReason** (string) - **cancelledBy** (null) - **onHold** (boolean) - **onHoldUntil** (string) - **postageAccount** (string) - **buyerPaidShipping** (number) - **shippingAddress** (object) - **billingAddress** (object) - **shipVia** (string) - **shipViaPackaging** (string) - **shipViaConfirmation** (string) - **dryIceWeight** (number) - **packageSku** (string) - **shipFromWarehouse** (object) - **projectNumber** (string) - **discountPercentage** (number) - **orderSource** (string) - **internalNote** (string) - **noteFromCustomer** (string) - **noteToCustomer** (string) - **notificationEmail** (string) - **userField1** (string) - **userField2** (string) - **userField3** (string) - **myList1** (string) - **myList2** (string) - **tags** (array of objects) - **items** (array of objects) ### Response Example (200) ```json { "id": 10376, "orderNumber": 101156, "orderReference": "", "customer": { "id": 6382, "title": "", "name": "Anna", "surname": "Fuugo", "email": "email@address.com", "company": "Aconite", "accountNumber": "S01E07" }, "client": null, "orderedDate": "2022-09-20T11:31:01-07:00", "createdDate": "2022-09-20T11:31:01-07:00", "modifiedDate": "2022-09-20T11:31:01-07:00", "orderPlaced": true, "createdBy": { "id": 1, "name": "Mr Sparks" }, "completed": false, "completedDate": "", "cancelled": false, "cancelledDate": "", "cancelledReason": "", "cancelledBy": null, "onHold": false, "onHoldUntil": "", "postageAccount": "sender", "buyerPaidShipping": 0, "shippingAddress": { "id": 666, "company": "Aconite", "name": "Anna Fuugo", "line1": "123 Home Street", "line2": "", "line3": "", "city": "Phoenix", "state": "AZ", "zip": 85013, "country": "United States", "countryCode": "US", "phone": "555-555-5555", "code": "", "verifiedStatus": "awaiting", "verifiedDate": "", "verifiedMessage": "" }, "billingAddress": { "id": 666, "company": "Aconite", "name": "Anna Fuugo", "line1": "123 Home Street", "line2": "", "line3": "", "city": "Phoenix", "state": "AZ", "zip": 85013, "country": "United States", "countryCode": "US", "phone": "555-555-5555", "code": "", "verifiedStatus": "awaiting", "verifiedDate": "", "verifiedMessage": "" }, "shipVia": "fedex_ground", "shipViaPackaging": "", "shipViaConfirmation": "direct_signature", "dryIceWeight": 0, "packageSku": "", "shipFromWarehouse": { "id": 1, "name": "Main Warehouse" }, "projectNumber": "", "discountPercentage": 0, "orderSource": "REST API", "internalNote": "", "noteFromCustomer": "", "noteToCustomer": "", "notificationEmail": "", "userField1": "", "userField2": "", "userField3": "", "myList1": "", "myList2": "", "tags": [ { "id": 1, "tag": "Expedite", "note": "Expedite this order." } ], "items": [ { "id": 13664, "itemId": 2306, "sku": "FumoFumo-002", "description": "Marisa Kirisame", "orderQuantity": 5, "uom": "Each", "quantity": 5, "allocatedQuantity": 0, "pickedQuantity": 0, "price": 50, "discountPercentage": 0, "partOfKit": false, "componentOf": 0, "additionalFields": null }, { "id": 13665, "itemId": 2330, "sku": "FumoFumo-006", "description": "Alice Margatroid", "orderQuantity": 1, "uom": "Case", "quantity": 6, "allocatedQuantity": 0, "pickedQuantity": 0, "price": 50, "discountPercentage": 0, "partOfKit": false, "componentOf": 0, "additionalFields": null } ] } ```