Wherefour API (1.0.18)

Download OpenAPI specification:Download

E-mail: noreply@wherefour.com License: Apache 2.0 Terms of Service

API documentation for the Wherefour ERP/traceability platform. More information at: wherefour.com.

List categories

Returns a list of inventory categories, ordered by name.

Authorizations:

BasicAuth

query Parameters

page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	number
name	string

Response samples

Content type

application/json

[{"id": 1,
"name": "Ingredients"
},
{"id": 5,
"name": "Labor"
},
{"id": 2,
"name": "Packaging"
},
{"id": 8,
"name": "Parts"
},
{"id": 3,
"name": "Products"
}
]

Inventory

List Inventory Items

Returns a paginated list of all inventory items.

Authorizations:

BasicAuth

query Parameters

updated_at	string Oldest date/time for the records to return
page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	number
name	string non-empty
category_name	string non-empty
on_hand	number
unit_of_use	string non-empty
unit_of_purchase	string non-empty
unit_of_order	string non-empty
unit_of_invoice	string non-empty
unit_of_pick_and_ship	string non-empty
unit_of_weight	string non-empty
unit_of_dimension	string non-empty
purchase_conversion	number
property	string non-empty
sku	string non-empty
pull_strategy	string non-empty
reorder_point	number
lead_time	number
retired	boolean
waste_percentage	number
quantity_not_tracked	boolean
	Array of objects >= 0 items unique
weight	number
height	number
width	number
length	number
created_at	string non-empty
updated_at	string non-empty
	Array of objects >= 0 items unique

Response samples

Content type

application/json

{"id": 56,
"name": "New inventory item",
"category_name": "Ingredients",
"on_hand": 0,
"unit_of_use": "each",
"unit_of_purchase": "each",
"unit_of_order": "each",
"unit_of_invoice": "each",
"unit_of_pick_and_ship": "each",
"unit_of_weight": "pound",
"unit_of_dimension": "inch",
"purchase_conversion": 1,
"property": "finished_good",
"sku": "1234",
"upc": "5678",
"pull_strategy": "FIFO",
"reorder_point": 0,
"lead_time": 0,
"retired": false,
"waste_percentage": 0,
"quantity_not_tracked": false,
"standard_cost": "0.0",
"conversions": [ ],
"weight": 100,
"height": 10,
"width": 10,
"length": 20,
"internal_photo_is_public": true,
"internal_description": "This is an internal description",
"internal_description_is_public": true,
"public_name": "New inventory item",
"public_description": "This is an internal description",
"show_hold_amounts": true,
"internal_name_is_public": true,
"receive_default_delivery_method_id": 1,
"receive_default_location_id": 1,
"receive_default_accept_rows": 1,
"receive_default_to_total_cost": true,
"receive_default_stock_status": "active",
"receive_require_barcode": false,
"receive_require_serial_number": false,
"receive_require_location": false,
"receive_require_expiration_date": false,
"receive_prefill_expiration_date": false,
"receive_expiration_date_days": 30,
"receive_allow_unit_of_receiving_change": true,
"receive_keep_quantity": true,
"receive_keep_unit_of_receiving": true,
"receive_keep_cost": true,
"receive_keep_vendor_item_number": true,
"receive_keep_location": true,
"receive_keep_expiration_date": true,
"receive_keep_stock_description": true,
"receive_allow_custom_field_entry": true,
"created_at": "2024-06-15T02:54:11.546Z",
"updated_at": "2024-06-15T02:54:11.546Z",
"custom_field_values": [{"id": 1,
"custom_field_id": 1,
"inventory_id": 1,
"active_stock_id": 1,
"value": "1",
"value_type": "number",
"created_at": "2021-08-23T14:25:37.200Z",
"updated_at": "2021-08-23T14:25:37.200Z",
"custom_field": {"id": 1,
"name": "Test",
"value_type": "number",
"created_at": "2021-08-23T14:25:21.663Z",
"updated_at": "2021-08-23T14:25:21.663Z"
}
}
]
}

Create inventory item

Creates a new inventory item with the provided parameters.

Authorizations:

BasicAuth

Request Body schema: application/json

name	string
category_id	number
unit_of_use	string
unit_of_purchase	string
unit_of_order	string
unit_of_invoice	string
unit_of_pick_and_ship	string
unit_of_weight	string
unit_of_dimension	string
purchase_conversion	number
property	string Enum: "raw_material" "overhead" "work_in_progress" "finished_good"
sku	string
upc	string
pull_strategy	string Enum: "FIFO" "Hand Pick" "FEFO" "LIFO"
reorder_point	number
rate	number
lead_time	number
retired	boolean
waste_percentage	number
quantity_not_tracked	boolean
standard_cost	number
weight	number
height	number
width	number
length	number

Responses

Response Schema:
application/json

id	number
name	string non-empty
category_name	string non-empty
on_hand	number
unit_of_use	string non-empty
unit_of_purchase	string non-empty
unit_of_order	string non-empty
unit_of_invoice	string non-empty
unit_of_pick_and_ship	string non-empty
unit_of_weight	string non-empty
unit_of_dimension	string non-empty
purchase_conversion	number
property	string non-empty
sku	string non-empty
pull_strategy	string non-empty
reorder_point	number
lead_time	number
retired	boolean
waste_percentage	number
quantity_not_tracked	boolean
	Array of objects >= 0 items unique
weight	number
height	number
width	number
length	number
created_at	string non-empty
updated_at	string non-empty
	Array of objects >= 0 items unique

Request samples

Payload

Content type

application/json

{"name": "Whole milk",
"category_id": 1,
"unit_of_use": "gallon",
"unit_of_purchase": "gallon",
"unit_of_order": "gallon",
"unit_of_invoice": "gallon",
"unit_of_pick_and_ship": "gallon",
"unit_of_weight": null,
"unit_of_dimension": null,
"purchase_conversion": 1,
"property": "raw_material",
"sku": null,
"pull_strategy": "FIFO",
"reorder_point": 50,
"lead_time": 1,
"retired": false,
"waste_percentage": 0,
"quantity_not_tracked": false,
"standard_cost": "0.0",
"weight": null,
"height": null,
"width": null,
"length": null
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"category_name": "string",
"on_hand": 0,
"unit_of_use": "string",
"unit_of_purchase": "string",
"unit_of_order": "string",
"unit_of_invoice": "string",
"unit_of_pick_and_ship": "string",
"unit_of_weight": "string",
"unit_of_dimension": "string",
"purchase_conversion": 0,
"property": "string",
"sku": "string",
"pull_strategy": "string",
"reorder_point": 0,
"lead_time": 0,
"retired": true,
"waste_percentage": 0,
"quantity_not_tracked": true,
"conversions": [{"to_count": 0,
"from_count": 0,
"catch_weight": true,
"maximum_weight": 0,
"minimum_weight": 0,
"unit_of_measurement": "string"
}
],
"weight": 0,
"height": 0,
"width": 0,
"length": 0,
"created_at": "string",
"updated_at": "string",
"custom_field_values": [{"id": 0,
"custom_field_id": 0,
"inventory_id": 0,
"active_stock_id": 0,
"value": "string",
"value_type": "string",
"created_at": "string",
"updated_at": "string",
"custom_field": {"id": 0,
"name": "string",
"value_type": "string",
"created_at": "string",
"updated_at": "string"
}
}
]
}

Add stock lot

Adds a new stock lot to the specified inventory item.

Authorizations:

BasicAuth

path Parameters

inventory_id

required

integer

inventory item record ID

Request Body schema: application/json

delivery_method_id required	number
location_id	number
vendor_id	number
vendor_reference	string
count required	number
lot_code required	string required if automatic sequencing is not enabled or generate_lot_code is false
barcode	string
serial_number	string
expiration_date	string must be in the preferred date format of the API user
received_date required	string must be in the preferred date time format of the API user
generate_lot_code	boolean
generate_barcode	boolean
generate_serial_number	string
cost required	number
cost_entered_is_total_code	boolean if cost_entered_is_total_code is false, the cost will be treated as a per unit cost
stock_description	string
vendor_item_number	string
status	string Enum: "active" "inactive" "on_hold" "quarantined"

Responses

Response Schema: application/json

id	number
user_id	number
inventory_id	number
location_id	number
lot_code	string
status	string
barcode	string
details	string
note	string
count	number
cost	number
vendor_id	number
expiration_date	string
created_at	string
updated_at	string
base_count	number
rate	number
purchase_id	number
global_identifier	string
organization_id	number
expiration_notified_at	string
weight	number
height	number
width	number
length	number
serial_number	string
generate_barcode	boolean
generate_lot_code	boolean
generate_serial_number	boolean
	Array of objects >= 0 items unique

Request samples

Payload

Content type

application/json

{"delivery_method_id": 1,
"location_id": 1,
"vendor_id": 1,
"lot_code": "1234",
"stock_description": "New stock",
"count": 100,
"cost": 100,
"cost_entered_is_total_cost": true,
"status": "active",
"expiration_date": "11/05/25",
"received_date": "11/05/2024 02:39 PM"
}

Response samples

Content type

application/json

{"id": 35,
"user_id": 6,
"inventory_id": 4,
"location_id": 1,
"lot_code": "1234",
"status": "active",
"barcode": null,
"details": "New stock",
"note": "",
"count": "100.0",
"cost": "100.0",
"vendor_id": 1,
"expiration_date": "2025-11-05",
"created_at": "2024-11-05T17:42:31.000Z",
"updated_at": "2024-11-05T17:42:31.000Z",
"base_count": "100.0",
"rate": null,
"purchase_id": null,
"global_identifier": "18c63c87-fcac-40d3-b334-22ef41c85cf5",
"organization_id": 1,
"expiration_notified_at": null,
"weight": null,
"height": null,
"width": null,
"length": null,
"serial_number": null,
"generate_barcode": false,
"generate_lot_code": false,
"generate_serial_number": false,
"custom_field_values": [ ]
}

Get last stock lot change

Gets the last stock lot change for the specified inventory item.

Authorizations:

BasicAuth

Responses

Response Schema: application/json

object

Response samples

Content type

application/json

{"id": 1,
"user_id": 1,
"user_first_name": "Tony",
"user_last_name": "Fiorello",
"reason": "purchase",
"lot_code": "WM001",
"old_lot_code": "WM001",
"barcode": "WM-000001-18",
"old_barcode": "WM-000001-18",
"details": "Whole milk",
"rate": null,
"cost": "200.0",
"count": "100.0",
"change": "100.0",
"absolute_change": "100.0",
"note": "buy lot 1",
"work_order": null,
"expiration_date": "2020-05-31",
"created_at": "2020-09-11T13:57:47.026Z",
"updated_at": "2020-09-11T13:57:47.026Z",
"stock": {"id": 1,
"name": "Whole milk",
"lot_code": "WM001",
"status": "active",
"barcode": "WM-000001-18",
"details": "Whole milk",
"note": "buy lot WM001",
"count": "100.0",
"cost": "200.0",
"expiration_date": "2020-10-11",
"created_at": "2020-09-11T13:57:47.058Z",
"updated_at": "2020-09-11T13:57:47.058Z",
"inventory": {"id": 1,
"name": "Whole milk",
"category_name": "Ingredients",
"on_hand": "1410.0",
"unit_of_use": "gallon",
"unit_of_purchase": "gallon",
"property": "raw_material",
"sku": null,
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
},
"location": {"id": 1,
"name": "North Warehouse"
},
"vendor": {"id": 1,
"first_name": "Joe",
"last_name": "Sample",
"display_name": "Pacific Foods Co.",
"email": "jsample@pacificfoods.com",
"phone": "415-555-6758",
"mobile": null,
"fax": null,
"website": "https://wherefour.com",
"note": null,
"kind": "distributor",
"created_at": "2020-09-11T13:57:47.005Z",
"updated_at": "2020-09-11T13:57:47.005Z",
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"business_license_number": null
},
"purchase": null
}
}

Search for inventory item

Returns inventory items that match the given name or SKU. Multiple matches may be returned.

Authorizations:

BasicAuth

query Parameters

page	integer Results page to view

Request Body schema: application/json

Search can be performed based on EITHER the inventory item name, OR a single SKU or an array of SKUs. The inventory item name will take precedence over the SKU parameter. Multiple matches may be returned.

object

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	number
name	string non-empty
category_name	string non-empty
on_hand	number
unit_of_use	string non-empty
unit_of_purchase	string non-empty
unit_of_order	string non-empty
unit_of_invoice	string non-empty
unit_of_pick_and_ship	string non-empty
unit_of_weight	string non-empty
unit_of_dimension	string non-empty
purchase_conversion	number
property	string non-empty
sku	string non-empty
pull_strategy	string non-empty
reorder_point	number
lead_time	number
retired	boolean
waste_percentage	number
quantity_not_tracked	boolean
	Array of objects >= 0 items unique
weight	number
height	number
width	number
length	number
created_at	string non-empty
updated_at	string non-empty
	Array of objects >= 0 items unique

Request samples

Payload

Content type

application/json

Example

Name

{"name": "Product Name Here"
}

Response samples

Content type

application/json

{"id": 3,
"name": "Bulk chocolate",
"category_name": "Ingredients",
"on_hand": 0,
"unit_of_use": "pound",
"unit_of_purchase": "pound",
"purchase_conversion": 1,
"property": "work_in_progress",
"sku": "123456",
"pull_strategy": "Hand Pick",
"reorder_point": 10,
"lead_time": 0,
"retired": false,
"waste_percentage": 0,
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}

Invoices

List customer invoices

Lists invoices for a customer

Authorizations:

BasicAuth

path Parameters

customer_id

required

integer

customer record ID

Responses

Response Schema: application/json

id	integer
invoice_date	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
invoice_number	string
created_at	string
updated_at	string
	object
	object
salesperson	string
payment_term	string

Response samples

Content type

application/json

{"id": 2,
"invoice_date": "2024-02-22",
"status": "draft",
"instructions": "",
"subtotal": "300.0",
"discount": "10.0",
"tax": "",
"shipping": "25.0",
"total": "315.0",
"invoice_number": "INV2",
"created_at": "2024-02-22T18:29:42.330Z",
"updated_at": "2024-02-22T18:29:42.330Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Distribution",
"email": "buyer@embarcado.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"sales_channel_id": null,
"created_at": "2024-02-22T18:29:42.249Z",
"updated_at": "2024-02-22T18:29:42.249Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "404-X0001",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North",
"delivery_method_id": 6,
"default_special_instructions": "Deliver to back dock 12"
},
"sales_channel": null,
"invoice_items": [{"id": 3,
"name": "Finished good B",
"inventory_id": 4,
"category_name": "Products",
"count": "20.0",
"cost": "2.5",
"sku": "SK0001",
"created_at": "2024-02-22T18:29:42.323Z",
"updated_at": "2024-02-22T18:29:42.323Z"
},
{"id": 4,
"name": "Case of finished good B",
"inventory_id": 6,
"category_name": "Products",
"count": "10.0",
"cost": "25.0",
"sku": "SK0002",
"created_at": "2024-02-22T18:29:42.323Z",
"updated_at": "2024-02-22T18:29:42.323Z"
}
]
}

Create Invoice

Creates a new invoice for the customer.

Authorizations:

BasicAuth

path Parameters

customer_id

required

integer

customer record ID

Request Body schema: application/json

object

Responses

Response Schema: application/json

id	integer
invoice_date	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
invoice_number	string
created_at	string
updated_at	string
	object
	object
salesperson	string
payment_term	string

Request samples

Payload

Content type

application/json

{"invoice_number": "INV100",
"invoice_date": "2020-09-04",
"payment_term_id": null,
"status": "open",
"salesperson_id": null,
"payment_terms": null,
"delivery_method_id": 1,
"instructions": null,
"subtotal": 100,
"discount": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"invoice_items_attributes": [{"inventory_id": 4,
"count": 10,
"unit_price": 100,
"override_unit_price": 0
},
{"inventory_id": 6,
"count": 5,
"unit_price": 0,
"override_unit_price": 0
}
]
}

Response samples

Content type

application/json

{"id": 14,
"invoice_date": "2020-09-04",
"po_number": "12345",
"status": "open",
"order_id": 1,
"instructions": "",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"invoice_number": "INV100",
"created_at": "2020-09-12T18:25:54.054Z",
"updated_at": "2020-09-12T18:25:54.054Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North",
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"line3": "",
"line4": "",
"line5": "",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"line4": "",
"line5": "",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
},
"delivery_method": {"id": 1,
"name": "UPS Ground",
"kind": "shipping",
"instructions": ""
},
"salesperson": "",
"payment_term": "",
"invoice_items": [{"id": 28,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "10.0",
"cost": "0.0",
"sku": "SK0001",
"created_at": "2020-09-12T18:25:54.062Z",
"updated_at": "2020-09-12T18:25:54.062Z",
"inventory": {"id": 4,
"name": "Chocolate bar",
"category_name": "Products",
"on_hand": "1165.0",
"unit_of_use": "each",
"unit_of_purchase": "each",
"purchase_conversion": "1.0",
"property": "finished_good",
"sku": "SK0001",
"pull_strategy": "FEFO",
"reorder_point": "0.0",
"lead_time": 0,
"retired": false,
"waste_percentage": "0.0",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
},
{"id": 29,
"name": "Chocolate bar, finished case",
"inventory_id": 6,
"category_name": "Products",
"count": "5.0",
"cost": "0.0",
"sku": "SK0002",
"created_at": "2020-09-12T18:25:54.066Z",
"updated_at": "2020-09-12T18:25:54.066Z",
"inventory": {"id": 6,
"name": "Chocolate bar, finished case",
"category_name": "Products",
"on_hand": "0.0",
"unit_of_use": "case",
"unit_of_purchase": "case",
"purchase_conversion": "1.0",
"property": "finished_good",
"sku": "SK0002",
"pull_strategy": "FIFO",
"reorder_point": "0.0",
"lead_time": 0,
"retired": false,
"waste_percentage": "0.0",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
}
]
}

Update invoice

Updates an existing invoice

Authorizations:

BasicAuth

path Parameters

invoice_id required	integer invoice record ID
customer_id required	integer customer record ID

Responses

Response Schema: application/json

id	integer
invoice_date	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
invoice_number	string
created_at	string
updated_at	string
	object
	object
salesperson	string
payment_term	string

Response samples

Content type

application/json

{"id": 6,
"invoice_date": "2020-09-04",
"status": "draft",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"invoice_number": "INV100",
"created_at": "2020-09-12T16:13:45.549Z",
"updated_at": "2020-09-12T16:13:45.549Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"payment_terms": "Net 30",
"delivery_method": "Route: Embarcadero North",
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
},
"delivery_method": {"id": 1,
"name": "UPS Ground",
"kind": "shipping"
},
"invoice_items": [{"id": 10,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0001",
"created_at": "2020-09-12T16:13:45.568Z",
"updated_at": "2020-09-12T16:13:45.568Z",
"inventory": {"id": 4,
"name": "Chocolate bar",
"category_name": "Products",
"on_hand": "75.0",
"unit_of_use": "each",
"unit_of_purchase": "each",
"property": "finished_good",
"sku": "SK0001",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
}
]
}

List Invoices

Returns a paginated list of all invoices.

Authorizations:

BasicAuth

query Parameters

updated_at	string Oldest date/time for the records returned
page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	integer
invoice_date	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
invoice_number	string
created_at	string
updated_at	string
	object
	object
salesperson	string
payment_term	string

Response samples

Content type

application/json

{"id": 6,
"invoice_date": "2020-09-04",
"status": "open",
"salesperson_id": null,
"salesperson_name": "",
"delivery_method_id": 1,
"instructions": "",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"invoice_number": "INV100",
"payment_term_id": null,
"created_at": "2020-09-12T16:13:45.549Z",
"updated_at": "2020-09-12T16:13:45.549Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North",
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"line3": "",
"line4": "",
"line5": "",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"line4": "",
"line5": "",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
},
"invoice_items": [{"id": 10,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0001",
"created_at": "2020-09-12T16:13:45.568Z",
"updated_at": "2020-09-12T16:13:45.568Z",
"inventory": {"id": 4,
"name": "Chocolate bar",
"category_name": "Products",
"on_hand": "75.0",
"unit_of_use": "each",
"unit_of_purchase": "each",
"property": "finished_good",
"sku": "SK0001",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
},
{"id": 11,
"name": "Chocolate bar, finished case",
"inventory_id": 6,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0002",
"created_at": "2020-09-12T16:13:45.574Z",
"updated_at": "2020-09-12T16:13:45.574Z",
"inventory": {"id": 6,
"name": "Chocolate bar, finished case",
"category_name": "Products",
"on_hand": "40.0",
"unit_of_use": "case",
"unit_of_purchase": "case",
"property": "finished_good",
"sku": "SK0002",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
}
]
}

Get Invoice

Retrieves a invoice record by ID

Authorizations:

BasicAuth

path Parameters

invoice_id

required

integer

Example: 1

ID for the invoice record

Responses

Response Schema: application/json

id	integer
invoice_date	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
invoice_number	string
created_at	string
updated_at	string
	object
	object
salesperson	string
payment_term	string

Response samples

Content type

application/json

{"id": 1,
"invoice_date": "2020-09-04",
"status": "complete",
"salesperson_id": null,
"salesperson_name": null,
"delivery_method_id": 1,
"instructions": "",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"invoice_number": "INV1",
"payment_term_id": null,
"created_at": "2020-09-11T13:57:46.842Z",
"updated_at": "2020-09-12T16:22:26.851Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North"
},
"delivery_method": {"id": 1,
"name": "UPS Ground",
"kind": "shipping",
"instructions": ""
},
"salesperson": "",
"payment_term": "",
"invoice_items": [{"id": 1,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "20.0",
"cost": "2.5",
"sku": "SK0001",
"created_at": "2020-09-11T13:57:47.050Z",
"updated_at": "2020-09-11T13:57:47.050Z"
},
{"id": 2,
"name": "Chocolate bar, finished case",
"inventory_id": 6,
"category_name": "Products",
"count": "10.0",
"cost": "25.0",
"sku": "SK0002",
"created_at": "2020-09-11T13:57:47.050Z",
"updated_at": "2020-09-11T13:57:47.050Z"
},
{"id": 12,
"name": "Bulk chocolate",
"inventory_id": 3,
"category_name": "Ingredients",
"count": "0.0",
"cost": "0.0",
"sku": null,
"created_at": "2020-09-12T16:22:26.858Z",
"updated_at": "2020-09-12T16:22:26.858Z"
},
{"id": 13,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0001",
"created_at": "2020-09-12T16:22:26.863Z",
"updated_at": "2020-09-12T16:22:26.863Z"
}
]
}

Search for invoice

Locates a invoice by the invoice_number

Authorizations:

BasicAuth

query Parameters

invoice_number	string non-empty Example: invoice_number={ "invoice_number": "INV1" } The invoice number in Wherefour to locate. All invoices with matching results will be returned.
page	integer Results page to view

Request Body schema: application/json

object

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	integer
invoice_date	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
invoice_number	string
created_at	string
updated_at	string
	object
	object
salesperson	string
payment_term	string

Request samples

Payload

Content type

application/json

{"invoice_number": "INV1"
}

Response samples

Content type

application/json

{"id": 1,
"invoice_date": "2020-09-04",
"status": "invoiced",
"salesperson_id": null,
"delivery_method_id": 1,
"instructions": "",
"subtotal": "300.0",
"discount": "10.0",
"tax": "0.00",
"shipping": "25.0",
"total": "315.0",
"invoice_number": "INV1",
"payment_term_id": 1,
"created_at": "2020-07-16T19:49:19.481Z",
"updated_at": "2020-07-16T19:49:19.481Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"created_at": "2020-07-16T19:49:19.394Z",
"updated_at": "2020-07-16T19:49:19.394Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North"
},
"invoice_items": [{"id": 1,
"name": "Chocolate bar",
"category_name": "Products",
"count": "20.0",
"cost": "2.5",
"sku": "SK0001",
"created_at": "2020-07-16T19:49:19.640Z",
"updated_at": "2020-07-16T19:49:19.640Z"
},
{"id": 2,
"name": "Chocolate bar, finished case",
"category_name": "Products",
"count": "10.0",
"cost": "25.0",
"sku": "SK0002",
"created_at": "2020-07-16T19:49:19.640Z",
"updated_at": "2020-07-16T19:49:19.640Z"
}
]
}

Orders

List orders for a customer

Returns all the orders for the customer ID provided.

Authorizations:

BasicAuth

path Parameters

customer_id

required

integer

customer record ID

query Parameters

updated_at	string Oldest date/time for the records to return
page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	integer
order_date	string
produce_date	string
deliver_date	string
po_number	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
order_number	string
created_at	string
updated_at	string
invoiced_at	string
	object
	object
salesperson	string
payment_term	string

Response samples

Content type

application/json

{"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Distribution",
"email": "buyer@embarcado.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": null,
"kind": "retailer",
"sales_channel_id": null,
"origin": "wherefour",
"created_at": "2024-02-22T18:29:42.249Z",
"updated_at": "2024-02-22T18:29:42.249Z",
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"business_license_number": "404-X0001",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": { },
"delivery_method_id": 6,
"default_special_instructions": "Deliver to back dock 12",
"sales_channel": null,
"billing_address": {"id": 1,
"type": "BillingAddress",
"descriptive_name": "Default Billing",
"line1": "1142 Main Street",
"line2": "Suite 100",
"line3": null,
"line4": null,
"line5": null,
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"country": "USA",
"created_at": "2024-02-22T18:29:42.099Z",
"updated_at": "2024-02-22T18:29:42.099Z"
},
"shipping_address": {"id": 2,
"type": "ShippingAddress",
"descriptive_name": "Default Shipping",
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"line4": null,
"line5": null,
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"country": "USA",
"created_at": "2024-02-22T18:29:42.099Z",
"updated_at": "2024-02-22T18:29:42.099Z"
},
"delivery_driver": null,
"delivery_vehicle": null,
"addresses": [{"id": 1,
"type": "BillingAddress",
"descriptive_name": "Default Billing",
"line1": "1142 Main Street",
"line2": "Suite 100",
"line3": null,
"line4": null,
"line5": null,
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"country": "USA",
"created_at": "2024-02-22T18:29:42.099Z",
"updated_at": "2024-02-22T18:29:42.099Z"
},
{"id": 2,
"type": "ShippingAddress",
"descriptive_name": "Default Shipping",
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"line4": null,
"line5": null,
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"country": "USA",
"created_at": "2024-02-22T18:29:42.099Z",
"updated_at": "2024-02-22T18:29:42.099Z"
}
]
}

Create Order

Creates a new order for the customer.

Authorizations:

BasicAuth

path Parameters

customer_id

required

integer

customer record ID

Request Body schema: application/json

object

Responses

Response Schema: application/json

id	integer
order_date	string
produce_date	string
deliver_date	string
po_number	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
order_number	string
created_at	string
updated_at	string
invoiced_at	string
	object
	object
salesperson	string
payment_term	string

Request samples

Payload

Content type

application/json

{"order_number": "SO100",
"order_date": "2020-09-04",
"deliver_date": "2020-09-04",
"produce_date": "2020-09-04",
"po_number": "12345",
"payment_term_id": null,
"status": "open",
"origin": "wherefour",
"salesperson_id": null,
"payment_terms": null,
"delivery_method_id": 1,
"instructions": null,
"subtotal": 100,
"discount": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"order_items_attributes": [{"inventory_id": 4,
"count": 10,
"unit_price": 100,
"override_unit_price": 0
},
{"inventory_id": 6,
"count": 5,
"unit_price": 0,
"override_unit_price": 0
}
]
}

Response samples

Content type

application/json

{"id": 14,
"order_date": "2020-09-04",
"produce_date": "2020-09-04",
"deliver_date": "2020-09-04",
"po_number": "12345",
"status": "open",
"instructions": "",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"origin": "wherefour",
"order_number": "SO100",
"created_at": "2020-09-12T18:25:54.054Z",
"updated_at": "2020-09-12T18:25:54.054Z",
"invoiced_at": "2020-09-12T18:25:54.054Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North",
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"line3": "",
"line4": "",
"line5": "",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"line4": "",
"line5": "",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
},
"delivery_method": {"id": 1,
"name": "UPS Ground",
"kind": "shipping",
"instructions": ""
},
"salesperson": "",
"payment_term": "",
"order_items": [{"id": 28,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "10.0",
"cost": "0.0",
"sku": "SK0001",
"created_at": "2020-09-12T18:25:54.062Z",
"updated_at": "2020-09-12T18:25:54.062Z",
"inventory": {"id": 4,
"name": "Chocolate bar",
"category_name": "Products",
"on_hand": "1165.0",
"unit_of_use": "each",
"unit_of_purchase": "each",
"purchase_conversion": "1.0",
"property": "finished_good",
"sku": "SK0001",
"pull_strategy": "FEFO",
"reorder_point": "0.0",
"lead_time": 0,
"retired": false,
"waste_percentage": "0.0",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
},
{"id": 29,
"name": "Chocolate bar, finished case",
"inventory_id": 6,
"category_name": "Products",
"count": "5.0",
"cost": "0.0",
"sku": "SK0002",
"created_at": "2020-09-12T18:25:54.066Z",
"updated_at": "2020-09-12T18:25:54.066Z",
"inventory": {"id": 6,
"name": "Chocolate bar, finished case",
"category_name": "Products",
"on_hand": "0.0",
"unit_of_use": "case",
"unit_of_purchase": "case",
"purchase_conversion": "1.0",
"property": "finished_good",
"sku": "SK0002",
"pull_strategy": "FIFO",
"reorder_point": "0.0",
"lead_time": 0,
"retired": false,
"waste_percentage": "0.0",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
}
]
}

Update Order

Updates an existing order

Authorizations:

BasicAuth

path Parameters

order_id required	integer order record ID
customer_id required	integer customer record ID

Responses

Response Schema: application/json

id	integer
order_date	string
produce_date	string
deliver_date	string
po_number	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
order_number	string
created_at	string
updated_at	string
invoiced_at	string
	object
	object
salesperson	string
payment_term	string

Response samples

Content type

application/json

{"id": 6,
"order_date": "2020-09-04",
"produce_date": "2020-09-04",
"deliver_date": "2020-09-04",
"po_number": "12345",
"status": "open",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"order_number": "SO100",
"created_at": "2020-09-12T16:13:45.549Z",
"updated_at": "2020-09-12T16:13:45.549Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"payment_terms": "Net 30",
"delivery_method": "Route: Embarcadero North",
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
},
"delivery_method": {"id": 1,
"name": "UPS Ground",
"kind": "shipping"
},
"order_items": [{"id": 10,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0001",
"created_at": "2020-09-12T16:13:45.568Z",
"updated_at": "2020-09-12T16:13:45.568Z",
"inventory": {"id": 4,
"name": "Chocolate bar",
"category_name": "Products",
"on_hand": "75.0",
"unit_of_use": "each",
"unit_of_purchase": "each",
"property": "finished_good",
"sku": "SK0001",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
},
{"id": 11,
"name": "Chocolate bar, finished case",
"inventory_id": 6,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0002",
"created_at": "2020-09-12T16:13:45.574Z",
"updated_at": "2020-09-12T16:13:45.574Z",
"inventory": {"id": 6,
"name": "Chocolate bar, finished case",
"category_name": "Products",
"on_hand": "40.0",
"unit_of_use": "case",
"unit_of_purchase": "case",
"property": "finished_good",
"sku": "SK0002",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
}
]
}

Get Last Shipment

Returns the most recent shipment information for the order ID provided.

Authorizations:

BasicAuth

path Parameters

customer_id required	integer Example: 1 customer record ID
order_id required	integer order record ID

Responses

Response Schema: application/json

id	integer
order_date	string
produce_date	string
deliver_date	string
po_number	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
order_number	string
created_at	string
updated_at	string
invoiced_at	string
	object
	object
salesperson	string
payment_term	string

Response samples

Content type

application/json

{"id": 1,
"order_id": 2,
"user_name": "Tony Fiorello",
"ship_date": "2020-09-12T16:48:00.000Z",
"shipment_number": 1,
"tracking_number": null,
"note": null,
"created_at": "2020-09-12T16:48:13.512Z",
"updated_at": "2020-09-12T16:48:13.512Z",
"delivery_method": {"id": 1,
"name": "UPS Ground",
"kind": "shipping",
"instructions": ""
},
"order": {"id": 2,
"order_date": "2020-09-10",
"produce_date": "2020-09-11",
"deliver_date": "2020-09-11",
"po_number": "123456-55",
"status": "invoiced",
"salesperson_id": null,
"salesperson_name": null,
"delivery_method_id": 1,
"instructions": "\nShipment #1: 09/12/20\n10.0 Each - Chocolate bar (lot code: SC-00000)\n40.0 Cases - Chocolate bar, finished case (lot code: SCC-0000)\n",
"subtotal": "1400.0",
"discount": "0.00",
"tax": "0.00",
"shipping": "0.00",
"total": "1400.0",
"order_number": "SO2",
"payment_term_id": 1,
"created_at": "2020-09-11T13:57:46.842Z",
"updated_at": "2020-09-12T16:48:13.688Z",
"invoiced_at": "2020-09-11T00:00:00.000Z"
},
"shipment_items": [{"id": 1,
"count": "10.0",
"inventory_name": "Chocolate bar",
"inventory_sku": "SK0001",
"auto_ship": [{"adjustment_id": 25,
"stock_id": 13,
"lot_code": "SC-00000",
"barcode": "CH-000001-18",
"count": "10.0",
"change": "-10.0",
"reason": "shipment"
}
]
},
{"id": 2,
"count": "40.0",
"inventory_name": "Chocolate bar, finished case",
"inventory_sku": "SK0002",
"auto_ship": [{"adjustment_id": 26,
"stock_id": 14,
"lot_code": "SCC-0000",
"barcode": "CHCA-000001-18",
"count": "40.0",
"change": "-40.0",
"reason": "shipment"
}
]
}
]
}

List shipments for order

Returns the most recent shipment information for the order ID provided.

Authorizations:

BasicAuth

path Parameters

customer_id required	integer Example: 1 customer record ID
order_id required	integer Example: 2 order record ID

query Parameters

page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	integer
order_date	string
produce_date	string
deliver_date	string
po_number	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
order_number	string
created_at	string
updated_at	string
invoiced_at	string
	object
	object
salesperson	string
payment_term	string

Response samples

Content type

application/json

{"id": 1,
"order_id": 2,
"user_name": "Tony Fiorello",
"ship_date": "2020-09-12T16:48:00.000Z",
"shipment_number": 1,
"tracking_number": null,
"note": null,
"created_at": "2020-09-12T16:48:13.512Z",
"updated_at": "2020-09-12T16:48:13.512Z",
"delivery_method": {"id": 1,
"name": "UPS Ground",
"kind": "shipping",
"instructions": ""
},
"order": {"id": 2,
"order_date": "2020-09-10",
"produce_date": "2020-09-11",
"deliver_date": "2020-09-11",
"po_number": "123456-55",
"status": "invoiced",
"salesperson_id": "",
"salesperson_name": "",
"delivery_method_id": 1,
"instructions": "\nShipment #1: 09/12/20\n10.0 Each - Chocolate bar (lot code: SC-00000)\n40.0 Cases - Chocolate bar, finished case (lot code: SCC-0000)\n",
"subtotal": "1400.0",
"discount": "",
"tax": "",
"shipping": "",
"total": "1400.0",
"order_number": "SO2",
"payment_term_id": 1,
"created_at": "2020-09-11T13:57:46.842Z",
"updated_at": "2020-09-12T16:48:13.688Z",
"invoiced_at": "2020-09-11T00:00:00.000Z"
},
"shipment_items": [{"id": 1,
"count": "10.0",
"inventory_name": "Chocolate bar",
"inventory_sku": "SK0001",
"auto_ship": [{"adjustment_id": 25,
"stock_id": 13,
"lot_code": "SC-00000",
"barcode": "CH-000001-18",
"count": "10.0",
"change": "-10.0",
"reason": "shipment"
}
]
},
{"id": 2,
"count": "40.0",
"inventory_name": "Chocolate bar, finished case",
"inventory_sku": "SK0002",
"auto_ship": [{"adjustment_id": 26,
"stock_id": 14,
"lot_code": "SCC-0000",
"barcode": "CHCA-000001-18",
"count": "40.0",
"change": "-40.0",
"reason": "shipment"
}
]
}
]
}

Auto Pick and Ship

Performs a "pick and ship" for the specified order. Wherefour will auto-select available lot coded inventory, based on each inventory item's pull strategy, to fulfill the order. If the location is specified, only inventory at that location will be considered. If not enough inventory is available, a partial shipment will be created. Results of the shipment, with the selected stock lots, will be returned.

The optional ship_date param can be used to specify the timestamp of the shipment. Date/time should be in the format "2021-02-02 12:00 AM" and in the same time zone as the user's Wherefour settings.

Authorizations:

BasicAuth

path Parameters

customer_id

required

integer

customer record ID

Request Body schema:
application/json

delivery_method required	string
location_name	string Name of the Wherefour location to pull stock from. If not provided, auto ship will pull available stock lots from any location. Name lookup will use the closest found match for the name provided or "null" for no match.
tracking_number	string Tracking number to record for the shipment.
ship_date	string

Responses

Response Schema: application/json

id	integer
order_date	string
produce_date	string
deliver_date	string
po_number	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
order_number	string
created_at	string
updated_at	string
invoiced_at	string
	object
	object
salesperson	string
payment_term	string

Request samples

Payload

Content type

application/json

{"tracking_number": "123456",
"delivery_method": "UPS Ground",
"location_name": "North Warehouse"
}

Response samples

Content type

application/json

{"id": 2,
"order_id": 14,
"user_name": "Tony Fiorello",
"ship_date": "2020-09-12T18:26:00.000Z",
"shipment_number": 1,
"tracking_number": null,
"note": null,
"created_at": "2020-09-12T18:26:02.037Z",
"updated_at": "2020-09-12T18:26:02.037Z",
"delivery_method": {"id": 1,
"name": "UPS Ground",
"kind": "shipping",
"instructions": ""
},
"order": {"id": 14,
"order_date": "2020-09-04",
"produce_date": "2020-09-04",
"deliver_date": "2020-09-04",
"po_number": "12345",
"status": "open",
"salesperson_id": null,
"salesperson_name": null,
"delivery_method_id": 1,
"instructions": "\nShipment #1: 09/12/20\n10.0 Each - Chocolate bar (lot code: 1234)\n",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"order_number": "SO100",
"payment_term_id": null,
"created_at": "2020-09-12T18:25:54.054Z",
"updated_at": "2020-09-12T18:26:02.139Z",
"invoiced_at": null
},
"shipment_items": [{"id": 3,
"count": "10.0",
"inventory_name": "Chocolate bar",
"inventory_sku": "SK0001",
"auto_ship": [{"adjustment_id": 43,
"stock_id": 39,
"lot_code": "1234",
"barcode": null,
"count": "10.0",
"change": "-10.0",
"reason": "shipment"
}
]
}
]
}

List Orders

Returns a paginated list of all orders.

Authorizations:

BasicAuth

query Parameters

updated_at	string Oldest date/time for the records returned
status	string Order status
search_start_date	string Oldest order date, produce on date, deliver on date, or ship on date to return
search_end_date	string Newest order date, produce on date, deliver on date, or ship on date to return
page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	integer
order_date	string
produce_date	string
deliver_date	string
po_number	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
order_number	string
created_at	string
updated_at	string
invoiced_at	string
	object
	object
salesperson	string
payment_term	string

Response samples

Content type

application/json

{"id": 6,
"order_date": "2020-09-04",
"produce_date": "2020-09-04",
"deliver_date": "2020-09-04",
"po_number": "12345",
"status": "open",
"salesperson_id": null,
"salesperson_name": "",
"delivery_method_id": 1,
"instructions": "",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"order_number": "SO100",
"payment_term_id": null,
"created_at": "2020-09-12T16:13:45.549Z",
"updated_at": "2020-09-12T16:13:45.549Z",
"invoiced_at": "2020-09-12T16:13:45.549Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North",
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"line3": "",
"line4": "",
"line5": "",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"line4": "",
"line5": "",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
},
"order_items": [{"id": 10,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0001",
"created_at": "2020-09-12T16:13:45.568Z",
"updated_at": "2020-09-12T16:13:45.568Z",
"inventory": {"id": 4,
"name": "Chocolate bar",
"category_name": "Products",
"on_hand": "75.0",
"unit_of_use": "each",
"unit_of_purchase": "each",
"property": "finished_good",
"sku": "SK0001",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
},
{"id": 11,
"name": "Chocolate bar, finished case",
"inventory_id": 6,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0002",
"created_at": "2020-09-12T16:13:45.574Z",
"updated_at": "2020-09-12T16:13:45.574Z",
"inventory": {"id": 6,
"name": "Chocolate bar, finished case",
"category_name": "Products",
"on_hand": "40.0",
"unit_of_use": "case",
"unit_of_purchase": "case",
"property": "finished_good",
"sku": "SK0002",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
}
]
}

Get Order

Retrieves an order record by ID

Authorizations:

BasicAuth

path Parameters

order_id

required

integer

Example: 1

ID for the order record

Responses

Response Schema: application/json

id	integer
order_date	string
produce_date	string
deliver_date	string
po_number	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
order_number	string
created_at	string
updated_at	string
invoiced_at	string
	object
	object
salesperson	string
payment_term	string

Response samples

Content type

application/json

{"id": 1,
"order_date": "3/1/20",
"produce_date": "3/1/20",
"deliver_date": "3/1/20",
"po_number": "123456-11",
"status": "complete",
"salesperson_id": null,
"salesperson_name": null,
"delivery_method_id": 1,
"instructions": "",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"order_number": "SO1",
"payment_term_id": null,
"created_at": "2020-09-11T13:57:46.842Z",
"updated_at": "2020-09-12T16:22:26.851Z",
"invoiced_at": "2020-09-11T00:00:00.000Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North"
},
"delivery_method": {"id": 1,
"name": "UPS Ground",
"kind": "shipping",
"instructions": ""
},
"salesperson": "",
"payment_term": "",
"order_items": [{"id": 1,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "20.0",
"cost": "2.5",
"sku": "SK0001",
"created_at": "2020-09-11T13:57:47.050Z",
"updated_at": "2020-09-11T13:57:47.050Z"
},
{"id": 2,
"name": "Chocolate bar, finished case",
"inventory_id": 6,
"category_name": "Products",
"count": "10.0",
"cost": "25.0",
"sku": "SK0002",
"created_at": "2020-09-11T13:57:47.050Z",
"updated_at": "2020-09-11T13:57:47.050Z"
},
{"id": 12,
"name": "Bulk chocolate",
"inventory_id": 3,
"category_name": "Ingredients",
"count": "0.0",
"cost": "0.0",
"sku": null,
"created_at": "2020-09-12T16:22:26.858Z",
"updated_at": "2020-09-12T16:22:26.858Z"
},
{"id": 13,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0001",
"created_at": "2020-09-12T16:22:26.863Z",
"updated_at": "2020-09-12T16:22:26.863Z"
}
]
}

Search for Order

Locates an order by the order_number

Authorizations:

BasicAuth

query Parameters

order_number	string non-empty Example: order_number={ "order_number": "SO1" } The sales order number in Wherefour to locate. All orders with matching results will be returned.
page	integer Results page to view

Request Body schema: application/json

object

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	integer
order_date	string
produce_date	string
deliver_date	string
po_number	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
order_number	string
created_at	string
updated_at	string
invoiced_at	string
	object
	object
salesperson	string
payment_term	string

Request samples

Payload

Content type

application/json

{"order_number": "SO1"
}

Response samples

Content type

application/json

{"id": 1,
"order_date": "2020-07-14",
"produce_date": "2020-07-16",
"deliver_date": "2020-07-16",
"status": "invoiced",
"salesperson_id": null,
"delivery_method_id": 1,
"instructions": "",
"subtotal": "300.0",
"discount": "10.0",
"tax": "0.00",
"shipping": "25.0",
"total": "315.0",
"order_number": "SO1",
"payment_term_id": 1,
"created_at": "2020-07-16T19:49:19.481Z",
"updated_at": "2020-07-16T19:49:19.481Z",
"invoiced_at": "2020-07-16T00:00:00.000Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"created_at": "2020-07-16T19:49:19.394Z",
"updated_at": "2020-07-16T19:49:19.394Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North"
},
"order_items": [{"id": 1,
"name": "Chocolate bar",
"category_name": "Products",
"count": "20.0",
"cost": "2.5",
"sku": "SK0001",
"created_at": "2020-07-16T19:49:19.640Z",
"updated_at": "2020-07-16T19:49:19.640Z"
},
{"id": 2,
"name": "Chocolate bar, finished case",
"category_name": "Products",
"count": "10.0",
"cost": "25.0",
"sku": "SK0002",
"created_at": "2020-07-16T19:49:19.640Z",
"updated_at": "2020-07-16T19:49:19.640Z"
}
]
}

Quotes

List quotes for a customer

Lists the quotes for a the customer.

Authorizations:

BasicAuth

path Parameters

customer_id

required

integer

customer record ID

Request Body schema: application/json

object

Responses

Response Schema: application/json

id	integer
quote_date	string
expiration_date	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
quote_number	string
created_at	string
updated_at	string
	object
	object
salesperson	string
payment_term	string

Request samples

Payload

Content type

application/json

{"id": 1,
"quote_date": "2024-02-22",
"expiration_date": "2024-03-23",
"status": "draft",
"instructions": null,
"subtotal": "300.0",
"discount": "10.0",
"tax": "0.0",
"shipping": "25.0",
"total": "340.0",
"quote_number": "QO1",
"created_at": "2024-02-22T18:29:42.552Z",
"updated_at": "2024-02-22T18:29:42.552Z",
"billing_address": {"id": 1,
"type": "BillingAddress",
"descriptive_name": "Default Billing",
"line1": "1142 Main Street",
"line2": "Suite 100",
"line3": null,
"line4": null,
"line5": null,
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"country": "USA",
"created_at": "2024-02-22T18:29:42.099Z",
"updated_at": "2024-02-22T18:29:42.099Z"
},
"shipping_address": {"id": 2,
"type": "ShippingAddress",
"descriptive_name": "Default Shipping",
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"line4": null,
"line5": null,
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"country": "USA",
"created_at": "2024-02-22T18:29:42.099Z",
"updated_at": "2024-02-22T18:29:42.099Z"
},
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Distribution",
"email": "buyer@embarcado.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": null,
"kind": "retailer",
"sales_channel_id": null,
"created_at": "2024-02-22T18:29:42.249Z",
"updated_at": "2024-02-22T18:29:42.249Z",
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"business_license_number": "404-X0001",
"payment_terms": "Net 30",
"salesperson": null,
"delivery_method": "Route: Embarcadero North",
"delivery_method_id": 6,
"default_special_instructions": "Deliver to back dock 12"
},
"sales_channel": null,
"quote_items": [{"id": 1,
"name": "Finished good B",
"inventory_id": 4,
"category_name": "Products",
"count": "20.0",
"cost": "2.5",
"sku": "SK0001",
"created_at": "2024-02-22T18:29:42.541Z",
"updated_at": "2024-02-22T18:29:42.541Z"
},
{"id": 2,
"name": "Case of finished good B",
"inventory_id": 6,
"category_name": "Products",
"count": "10.0",
"cost": "25.0",
"sku": "SK0002",
"created_at": "2024-02-22T18:29:42.541Z",
"updated_at": "2024-02-22T18:29:42.541Z"
}
]
}

Response samples

Content type

application/json

{"id": 14,
"quote_date": "2020-09-04",
"expiration_date": "2020-09-04",
"po_number": "12345",
"status": "open",
"instructions": "",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"quote_number": "QO100",
"created_at": "2020-09-12T18:25:54.054Z",
"updated_at": "2020-09-12T18:25:54.054Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North",
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"line3": "",
"line4": "",
"line5": "",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"line4": "",
"line5": "",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
},
"delivery_method": {"id": 1,
"name": "UPS Ground",
"kind": "shipping",
"instructions": ""
},
"salesperson": "",
"payment_term": "",
"quote_items": [{"id": 28,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "10.0",
"cost": "0.0",
"sku": "SK0001",
"created_at": "2020-09-12T18:25:54.062Z",
"updated_at": "2020-09-12T18:25:54.062Z",
"inventory": {"id": 4,
"name": "Chocolate bar",
"category_name": "Products",
"on_hand": "1165.0",
"unit_of_use": "each",
"unit_of_purchase": "each",
"purchase_conversion": "1.0",
"property": "finished_good",
"sku": "SK0001",
"pull_strategy": "FEFO",
"reorder_point": "0.0",
"lead_time": 0,
"retired": false,
"waste_percentage": "0.0",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
},
{"id": 29,
"name": "Chocolate bar, finished case",
"inventory_id": 6,
"category_name": "Products",
"count": "5.0",
"cost": "0.0",
"sku": "SK0002",
"created_at": "2020-09-12T18:25:54.066Z",
"updated_at": "2020-09-12T18:25:54.066Z",
"inventory": {"id": 6,
"name": "Chocolate bar, finished case",
"category_name": "Products",
"on_hand": "0.0",
"unit_of_use": "case",
"unit_of_purchase": "case",
"purchase_conversion": "1.0",
"property": "finished_good",
"sku": "SK0002",
"pull_strategy": "FIFO",
"reorder_point": "0.0",
"lead_time": 0,
"retired": false,
"waste_percentage": "0.0",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
}
]
}

Create Quote

Creates a new quote for the customer.

Authorizations:

BasicAuth

path Parameters

customer_id

required

integer

customer record ID

Request Body schema: application/json

object

Responses

Response Schema: application/json

id	integer
quote_date	string
expiration_date	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
quote_number	string
created_at	string
updated_at	string
	object
	object
salesperson	string
payment_term	string

Request samples

Payload

Content type

application/json

{"quote_number": "QO100",
"quote_date": "2020-09-04",
"expiration_date": "2020-09-04",
"payment_term_id": null,
"status": "open",
"salesperson_id": null,
"payment_terms": null,
"delivery_method_id": 1,
"instructions": null,
"subtotal": 100,
"discount": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"quote_items_attributes": [{"inventory_id": 4,
"count": 10,
"unit_price": 100,
"override_unit_price": 0
},
{"inventory_id": 6,
"count": 5,
"unit_price": 0,
"override_unit_price": 0
}
]
}

Response samples

Content type

application/json

{"id": 14,
"quote_date": "2020-09-04",
"expiration_date": "2020-09-04",
"po_number": "12345",
"status": "open",
"instructions": "",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"quote_number": "QO100",
"created_at": "2020-09-12T18:25:54.054Z",
"updated_at": "2020-09-12T18:25:54.054Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North",
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"line3": "",
"line4": "",
"line5": "",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"line4": "",
"line5": "",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
},
"delivery_method": {"id": 1,
"name": "UPS Ground",
"kind": "shipping",
"instructions": ""
},
"salesperson": "",
"payment_term": "",
"quote_items": [{"id": 28,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "10.0",
"cost": "0.0",
"sku": "SK0001",
"created_at": "2020-09-12T18:25:54.062Z",
"updated_at": "2020-09-12T18:25:54.062Z",
"inventory": {"id": 4,
"name": "Chocolate bar",
"category_name": "Products",
"on_hand": "1165.0",
"unit_of_use": "each",
"unit_of_purchase": "each",
"purchase_conversion": "1.0",
"property": "finished_good",
"sku": "SK0001",
"pull_strategy": "FEFO",
"reorder_point": "0.0",
"lead_time": 0,
"retired": false,
"waste_percentage": "0.0",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
},
{"id": 29,
"name": "Chocolate bar, finished case",
"inventory_id": 6,
"category_name": "Products",
"count": "5.0",
"cost": "0.0",
"sku": "SK0002",
"created_at": "2020-09-12T18:25:54.066Z",
"updated_at": "2020-09-12T18:25:54.066Z",
"inventory": {"id": 6,
"name": "Chocolate bar, finished case",
"category_name": "Products",
"on_hand": "0.0",
"unit_of_use": "case",
"unit_of_purchase": "case",
"purchase_conversion": "1.0",
"property": "finished_good",
"sku": "SK0002",
"pull_strategy": "FIFO",
"reorder_point": "0.0",
"lead_time": 0,
"retired": false,
"waste_percentage": "0.0",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
}
]
}

Update Quote

Updates an existing quote

Authorizations:

BasicAuth

path Parameters

quote_id required	integer quote record ID
customer_id required	integer customer record ID

Responses

Response Schema: application/json

id	integer
quote_date	string
expiration_date	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
quote_number	string
created_at	string
updated_at	string
	object
	object
salesperson	string
payment_term	string

Response samples

Content type

application/json

{"id": 6,
"quote_date": "2020-09-04",
"expiration_date": "2020-09-04",
"status": "draft",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"quote_number": "QO100",
"created_at": "2020-09-12T16:13:45.549Z",
"updated_at": "2020-09-12T16:13:45.549Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"payment_terms": "Net 30",
"delivery_method": "Route: Embarcadero North",
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
},
"delivery_method": {"id": 1,
"name": "UPS Ground",
"kind": "shipping"
},
"quote_items": [{"id": 10,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0001",
"created_at": "2020-09-12T16:13:45.568Z",
"updated_at": "2020-09-12T16:13:45.568Z",
"inventory": {"id": 4,
"name": "Chocolate bar",
"category_name": "Products",
"on_hand": "75.0",
"unit_of_use": "each",
"unit_of_purchase": "each",
"property": "finished_good",
"sku": "SK0001",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
},
{"id": 11,
"name": "Chocolate bar, finished case",
"inventory_id": 6,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0002",
"created_at": "2020-09-12T16:13:45.574Z",
"updated_at": "2020-09-12T16:13:45.574Z",
"inventory": {"id": 6,
"name": "Chocolate bar, finished case",
"category_name": "Products",
"on_hand": "40.0",
"unit_of_use": "case",
"unit_of_purchase": "case",
"property": "finished_good",
"sku": "SK0002",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
}
]
}

Get Quote

Retrieves a quote record by ID

Authorizations:

BasicAuth

path Parameters

quote_id

required

integer

Example: 1

ID for the quote record

Responses

Response Schema: application/json

id	integer
quote_date	string
expiration_date	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
quote_number	string
created_at	string
updated_at	string
	object
	object
salesperson	string
payment_term	string

Response samples

Content type

application/json

{"id": 1,
"quote_date": "2020-09-04",
"expiration_date": "2020-09-04",
"status": "complete",
"salesperson_id": null,
"salesperson_name": null,
"delivery_method_id": 1,
"instructions": "",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"quote_number": "QO1",
"payment_term_id": null,
"created_at": "2020-09-11T13:57:46.842Z",
"updated_at": "2020-09-12T16:22:26.851Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North"
},
"delivery_method": {"id": 1,
"name": "UPS Ground",
"kind": "shipping",
"instructions": ""
},
"salesperson": "",
"payment_term": "",
"quote_items": [{"id": 1,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "20.0",
"cost": "2.5",
"sku": "SK0001",
"created_at": "2020-09-11T13:57:47.050Z",
"updated_at": "2020-09-11T13:57:47.050Z"
},
{"id": 2,
"name": "Chocolate bar, finished case",
"inventory_id": 6,
"category_name": "Products",
"count": "10.0",
"cost": "25.0",
"sku": "SK0002",
"created_at": "2020-09-11T13:57:47.050Z",
"updated_at": "2020-09-11T13:57:47.050Z"
},
{"id": 12,
"name": "Bulk chocolate",
"inventory_id": 3,
"category_name": "Ingredients",
"count": "0.0",
"cost": "0.0",
"sku": null,
"created_at": "2020-09-12T16:22:26.858Z",
"updated_at": "2020-09-12T16:22:26.858Z"
},
{"id": 13,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0001",
"created_at": "2020-09-12T16:22:26.863Z",
"updated_at": "2020-09-12T16:22:26.863Z"
}
]
}

Search for quote

Locates a quote by the quote_number

Authorizations:

BasicAuth

query Parameters

quote_number	string non-empty Example: quote_number={ "quote_number": "QO1" } The quote number in Wherefour to locate. All quotes with matching results will be returned.
page	integer Results page to view

Request Body schema: application/json

object

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	integer
quote_date	string
expiration_date	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
quote_number	string
created_at	string
updated_at	string
	object
	object
salesperson	string
payment_term	string

Request samples

Payload

Content type

application/json

{"quote_number": "QO1"
}

Response samples

Content type

application/json

{"id": 1,
"quote_date": "2020-09-04",
"expiration_date": "2020-09-04",
"status": "invoiced",
"salesperson_id": null,
"delivery_method_id": 1,
"instructions": "",
"subtotal": "300.0",
"discount": "10.0",
"tax": "0.00",
"shipping": "25.0",
"total": "315.0",
"quote_number": "QO1",
"payment_term_id": 1,
"created_at": "2020-07-16T19:49:19.481Z",
"updated_at": "2020-07-16T19:49:19.481Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"created_at": "2020-07-16T19:49:19.394Z",
"updated_at": "2020-07-16T19:49:19.394Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North"
},
"quote_items": [{"id": 1,
"name": "Chocolate bar",
"category_name": "Products",
"count": "20.0",
"cost": "2.5",
"sku": "SK0001",
"created_at": "2020-07-16T19:49:19.640Z",
"updated_at": "2020-07-16T19:49:19.640Z"
},
{"id": 2,
"name": "Chocolate bar, finished case",
"category_name": "Products",
"count": "10.0",
"cost": "25.0",
"sku": "SK0002",
"created_at": "2020-07-16T19:49:19.640Z",
"updated_at": "2020-07-16T19:49:19.640Z"
}
]
}

List Quotes

Returns a paginated list of all quotes.

Authorizations:

BasicAuth

query Parameters

updated_at	string Oldest date/time for the records to return
page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	integer
quote_date	string
expiration_date	string
status	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
quote_number	string
created_at	string
updated_at	string
	object
	object
salesperson	string
payment_term	string

Response samples

Content type

application/json

{"id": 6,
"quote_date": "2020-09-04",
"expiration_date": "2020-09-04",
"status": "open",
"salesperson_id": null,
"salesperson_name": "",
"delivery_method_id": 1,
"instructions": "",
"subtotal": "100.0",
"discount": "0.0",
"tax": "0.0",
"shipping": "0.0",
"total": "0.0",
"quote_number": "QO100",
"payment_term_id": null,
"created_at": "2020-09-12T16:13:45.549Z",
"updated_at": "2020-09-12T16:13:45.549Z",
"customer": {"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": "",
"payment_terms": "Net 30",
"salesperson": "",
"delivery_method": "Route: Embarcadero North",
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"line3": "",
"line4": "",
"line5": "",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"line4": "",
"line5": "",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"country": "",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
},
"quote_items": [{"id": 10,
"name": "Chocolate bar",
"inventory_id": 4,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0001",
"created_at": "2020-09-12T16:13:45.568Z",
"updated_at": "2020-09-12T16:13:45.568Z",
"inventory": {"id": 4,
"name": "Chocolate bar",
"category_name": "Products",
"on_hand": "75.0",
"unit_of_use": "each",
"unit_of_purchase": "each",
"property": "finished_good",
"sku": "SK0001",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
},
{"id": 11,
"name": "Chocolate bar, finished case",
"inventory_id": 6,
"category_name": "Products",
"count": "0.0",
"cost": "0.0",
"sku": "SK0002",
"created_at": "2020-09-12T16:13:45.574Z",
"updated_at": "2020-09-12T16:13:45.574Z",
"inventory": {"id": 6,
"name": "Chocolate bar, finished case",
"category_name": "Products",
"on_hand": "40.0",
"unit_of_use": "case",
"unit_of_purchase": "case",
"property": "finished_good",
"sku": "SK0002",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
}
]
}

Shipments

List shipments

Returns a paginated list of all shipments.

Authorizations:

BasicAuth

query Parameters

page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	number
order_id	number
customer_id	number
user_name	string
ship_date	string
shipment_number	number
tracking_number	string
note	string
created_at	string
updated_at	string
	object
	Array of objects

Response samples

Content type

application/json

{"id": 1,
"order_id": 2,
"customer_id": 1,
"user_name": "Tony Fiorello",
"ship_date": "2020-09-12T16:48:00.000Z",
"shipment_number": 1,
"created_at": "2020-09-12T16:48:13.512Z",
"updated_at": "2020-09-12T16:48:13.512Z",
"shipment_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipment_items": [{"id": 1,
"count": "10.0",
"inventory_name": "Chocolate bar",
"inventory_sku": "SK0001",
"auto_ship": [{"adjustment_id": 25,
"stock_id": 13,
"lot_code": "SC-00000",
"barcode": "CH-000001-18",
"count": "10.0",
"change": "-10.0",
"reason": "shipment"
}
]
},
{"id": 2,
"count": "40.0",
"inventory_name": "Chocolate bar, finished case",
"inventory_sku": "SK0002",
"auto_ship": [{"adjustment_id": 26,
"stock_id": 14,
"lot_code": "SCC-0000",
"barcode": "CHCA-000001-18",
"count": "40.0",
"change": "-40.0",
"reason": "shipment"
}
]
}
]
}

Search for shipment

Returns a paginated list of shipments for the specified order number.

Authorizations:

BasicAuth

query Parameters

page	integer Results page to view

Request Body schema: application/json

object

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	number
order_id	number
customer_id	number
user_name	string
ship_date	string
shipment_number	number
tracking_number	string
note	string
created_at	string
updated_at	string
	object
	Array of objects

Request samples

Payload

Content type

application/json

{"order_number": "SO1"
}

Response samples

Content type

application/json

{"id": 1,
"order_id": 2,
"customer_id": 1,
"user_name": "Tony Fiorello",
"ship_date": "2020-09-12T16:48:00.000Z",
"shipment_number": 1,
"created_at": "2020-09-12T16:48:13.512Z",
"updated_at": "2020-09-12T16:48:13.512Z",
"shipment_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipment_items": [{"id": 1,
"count": "10.0",
"inventory_name": "Chocolate bar",
"inventory_sku": "SK0001",
"auto_ship": [{"adjustment_id": 25,
"stock_id": 13,
"lot_code": "SC-00000",
"barcode": "CH-000001-18",
"count": "10.0",
"change": "-10.0",
"reason": "shipment"
}
]
},
{"id": 2,
"count": "40.0",
"inventory_name": "Chocolate bar, finished case",
"inventory_sku": "SK0002",
"auto_ship": [{"adjustment_id": 26,
"stock_id": 14,
"lot_code": "SCC-0000",
"barcode": "CHCA-000001-18",
"count": "40.0",
"change": "-40.0",
"reason": "shipment"
}
]
}
]
}

Purchases

List purchases

Returns a paginated list of purchase orders.

Authorizations:

BasicAuth

query Parameters

updated_at	string Oldest date/time for the records returned.
page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	number
purchase_date	string
purchase_number	string
status	string
deliver_by_date	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
created_at	string
updated_at	string
	object
	object
	object
	object
	object
	Array of objects

Response samples

Content type

application/json

{"id": 1,
"purchase_date": "2020-09-11",
"purchase_number": "PO1",
"status": "draft",
"subtotal": "424.4875",
"total": "424.49",
"created_at": "2020-09-11T13:57:46.783Z",
"updated_at": "2020-09-11T13:57:46.783Z",
"vendor": {"id": 1,
"first_name": "Joe",
"last_name": "Sample",
"display_name": "Pacific Foods Co.",
"email": "jsample@pacificfoods.com",
"phone": "415-555-6758",
"website": "https://wherefour.com",
"kind": "distributor",
"created_at": "2020-09-11T13:57:47.005Z",
"updated_at": "2020-09-11T13:57:47.005Z",
"billing_address": {"id": 39,
"line1": "144 S. Broadway",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "95440",
"country": "USA",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 40,
"line1": "144 S. Broadway",
"city": "San Francisco",
"country_subdivision_code": "CA",
"country": "USA",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
},
"delivery_method": {"id": 3,
"name": "Pickup",
"kind": "shipping"
},
"payment_term": {"id": 3,
"name": "Net 15",
"net": 15
},
"purchase_items": [{"id": 2,
"name": "Whole milk",
"category_name": "Ingredients",
"count": "58.75",
"cost": "2.97",
"created_at": "2020-09-11T13:57:46.836Z",
"updated_at": "2020-09-11T13:57:46.836Z",
"inventory": {"id": 1,
"name": "Whole milk",
"category_name": "Ingredients",
"on_hand": "1410.0",
"unit_of_use": "gallon",
"unit_of_purchase": "gallon",
"property": "raw_material",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
},
{"id": 1,
"name": "Case box",
"category_name": "Packaging",
"count": "1000.0",
"cost": "0.25",
"created_at": "2020-09-11T13:57:46.836Z",
"updated_at": "2020-09-11T13:57:46.836Z",
"inventory": {"id": 7,
"name": "Case box",
"category_name": "Packaging",
"on_hand": "400.0",
"unit_of_use": "each",
"unit_of_purchase": "each",
"property": "raw_material",
"created_at": "2020-09-11T13:57:46.825Z",
"updated_at": "2020-09-11T13:57:46.825Z"
}
}
]
}

Search Purchases

Searches for a purchase order based on the purchase order number provided. Multiple matches may be returned.

Authorizations:

BasicAuth

query Parameters

purchase_number	string PO number to search for
page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	number
purchase_date	string
purchase_number	string
status	string
deliver_by_date	string
instructions	string
subtotal	string
discount	string
tax	string
shipping	string
total	string
created_at	string
updated_at	string
	object
	object
	object
	object
	object
	Array of objects

Response samples

Content type

application/json

{"id": 1,
"purchase_date": "2024-02-21",
"purchase_number": "PO1",
"status": "draft",
"deliver_by_date": "2024-02-21",
"instructions": "",
"subtotal": "424.4875",
"discount": "",
"tax": "",
"shipping": "",
"total": "455.71",
"created_at": "2024-02-21T18:36:22.516Z",
"updated_at": "2024-02-21T18:36:22.516Z",
"facility_address": null,
"bill_to_address": {"id": 4,
"type": "OrganizationAddress",
"descriptive_name": "Main Address",
"line1": "1390 N. McDowell Blvd.",
"line2": "Suite G133",
"line3": null,
"line4": null,
"line5": null,
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"country": "USA",
"created_at": "2024-02-21T18:36:22.094Z",
"updated_at": "2024-02-21T18:36:22.094Z"
},
"deliver_to_address": {"id": 4,
"type": "OrganizationAddress",
"descriptive_name": "Main Address",
"line1": "1390 N. McDowell Blvd.",
"line2": "Suite G133",
"line3": "",
"line4": "",
"line5": "",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"country": "USA",
"created_at": "2024-02-21T18:36:22.094Z",
"updated_at": "2024-02-21T18:36:22.094Z"
},
"vendor": {"id": 1,
"first_name": "Joe",
"last_name": "Sample",
"display_name": "Pacific Supply Co.",
"email": "jsample@pacificfoods.com",
"phone": "415-555-6758",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"note": "",
"kind": "distributor",
"created_at": "2024-02-21T18:36:22.638Z",
"updated_at": "2024-02-21T18:36:22.638Z",
"custom_field_1": "",
"custom_field_2": "",
"custom_field_3": "",
"custom_field_4": "",
"business_license_number": ""
},
"delivery_method": {"id": 3,
"name": "Pickup",
"kind": "shipping",
"instructions": "These are some delivery instructions"
},
"payment_term": {"id": 3,
"name": "Net 15",
"net": 15
},
"purchase_items": [{"id": 1,
"name": "Case box",
"category_name": "Packaging",
"count": "1000.0",
"cost": "0.25",
"sku": "CSECSECSECSE",
"created_at": "2024-02-21T18:36:22.513Z",
"updated_at": "2024-02-21T18:36:22.513Z"
},
{"id": 2,
"name": "Raw material A",
"category_name": "Ingredients",
"count": "58.75",
"cost": "2.97",
"sku": "AAAAAAAAAAA",
"created_at": "2024-02-21T18:36:22.513Z",
"updated_at": "2024-02-21T18:36:22.513Z"
}
]
}

Customers

List customers

Returns a paginated list of customers.

Authorizations:

BasicAuth

query Parameters

updated_at	string Oldest date/time for the records to return
page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	number
first_name	string
last_name	string
display_name	string
email	string
phone	string
mobile	string
fax	string
website	string
note	string
kind	string
created_at	string
updated_at	string
custom_field_1	string
custom_field_2	string
custom_field_3	string
custom_field_4	string
business_license_number	string
payment_terms	string
salesperson	string
delivery_method	string
	object
	object
delivery_driver	string
delivery_vehicle	string

Response samples

Content type

application/json

{"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"payment_terms": "Net 30",
"delivery_method": "Route: Embarcadero North",
"block_shipments": false,
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
}

Create a customer

Creates a new customer record.

Authorizations:

BasicAuth

Request Body schema: application/json

id	number
first_name	string
last_name	string
display_name	string
email	string
phone	string
mobile	string
fax	string
website	string
note	string
kind	string
created_at	string
updated_at	string
custom_field_1	string
custom_field_2	string
custom_field_3	string
custom_field_4	string
business_license_number	string
payment_terms	string
salesperson	string
delivery_method	string
	object
	object
delivery_driver	string
delivery_vehicle	string

Responses

Response Schema: application/json

id	number
first_name	string
last_name	string
display_name	string
email	string
phone	string
mobile	string
fax	string
website	string
note	string
kind	string
created_at	string
updated_at	string
custom_field_1	string
custom_field_2	string
custom_field_3	string
custom_field_4	string
business_license_number	string
payment_terms	string
salesperson	string
delivery_method	string
	object
	object
delivery_driver	string
delivery_vehicle	string

Request samples

Payload

Content type

application/json

{"customer": {"first_name": "John",
"middle_name": null,
"last_name": "Smith",
"display_name": "John Smith",
"email": "test@example.com",
"phone": "555-1212",
"mobile": "555-2222",
"fax": "555-3333",
"website": "https://website.com",
"note": "This is a customer note.",
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"business_license_number": "123",
"block_shipments": false,
"billing_address_attributes": {"line1": "123 Main",
"line2": null,
"line3": null,
"line4": null,
"line5": null,
"city": null,
"country_subdivision_code": null,
"postal_code": null,
"country": null
},
"shipping_address_attributes": {"line1": "555 Main",
"line2": null,
"line3": null,
"line4": null,
"line5": null,
"city": null,
"country_subdivision_code": null,
"postal_code": null,
"country": null
}
}
}

Response samples

Content type

application/json

{"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"payment_terms": "Net 30",
"delivery_method": "Route: Embarcadero North",
"block_shipments": false,
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
}

Get Customer

Returns the customer record for the specified ID.

Authorizations:

BasicAuth

path Parameters

customer_id

required

integer

customer record ID

Responses

Response Schema: application/json

id	number
first_name	string
last_name	string
display_name	string
email	string
phone	string
mobile	string
fax	string
website	string
note	string
kind	string
created_at	string
updated_at	string
custom_field_1	string
custom_field_2	string
custom_field_3	string
custom_field_4	string
business_license_number	string
payment_terms	string
salesperson	string
delivery_method	string
	object
	object
delivery_driver	string
delivery_vehicle	string

Response samples

Content type

application/json

{"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"payment_terms": "Net 30",
"delivery_method": "Route: Embarcadero North",
"block_shipments": false,
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
}

Update a Customer

Updates the customer record for the specified ID.

Authorizations:

BasicAuth

path Parameters

customer_id

required

integer

customer record ID

Request Body schema: application/json

object

Responses

Response Schema: application/json

id	number
first_name	string
last_name	string
display_name	string
email	string
phone	string
mobile	string
fax	string
website	string
note	string
kind	string
created_at	string
updated_at	string
custom_field_1	string
custom_field_2	string
custom_field_3	string
custom_field_4	string
business_license_number	string
payment_terms	string
salesperson	string
delivery_method	string
	object
	object
delivery_driver	string
delivery_vehicle	string

Request samples

Payload

Content type

application/json

{"customer": {"first_name": "John",
"middle_name": null,
"last_name": "Smith",
"display_name": "John A Smith",
"email": "test@example.com",
"phone": "555-1212",
"mobile": "555-2222",
"fax": "555-3333",
"website": "https://website.com",
"note": "This is a customer note.",
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"business_license_number": "123",
"block_shipments": false,
"billing_address_attributes": {"line1": "123 Main",
"line2": null,
"line3": null,
"line4": null,
"line5": null,
"city": null,
"country_subdivision_code": null,
"postal_code": null,
"country": null
},
"shipping_address_attributes": {"line1": "555 Main",
"line2": null,
"line3": null,
"line4": null,
"line5": null,
"city": null,
"country_subdivision_code": null,
"postal_code": null,
"country": null
}
}
}

Response samples

Content type

application/json

{"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"payment_terms": "Net 30",
"delivery_method": "Route: Embarcadero North",
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
}

List customer kinds

Returns of list of customer types.

Authorizations:

BasicAuth

Responses

Response Schema: application/json

object

Response samples

Content type

application/json

{ }

Search for a customer

Returns customer records with a match on the display name.

Authorizations:

BasicAuth

query Parameters

page	integer Results page to view

Request Body schema: application/json

object

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	number
first_name	string
last_name	string
display_name	string
email	string
phone	string
mobile	string
fax	string
website	string
note	string
kind	string
created_at	string
updated_at	string
custom_field_1	string
custom_field_2	string
custom_field_3	string
custom_field_4	string
business_license_number	string
payment_terms	string
salesperson	string
delivery_method	string
	object
	object
delivery_driver	string
delivery_vehicle	string

Request samples

Payload

Content type

application/json

{"display_name": "A name"
}

Response samples

Content type

application/json

{"id": 1,
"first_name": "",
"last_name": "",
"display_name": "Embarcadero Market & Deli",
"email": "buyer@embarcaderodeli.com",
"phone": "415-555-6687",
"mobile": "",
"fax": "",
"website": "https://wherefour.com",
"kind": "retailer",
"created_at": "2020-09-11T13:57:46.742Z",
"updated_at": "2020-09-11T13:57:46.742Z",
"payment_terms": "Net 30",
"delivery_method": "Route: Embarcadero North",
"block_shipments": false,
"billing_address": {"id": 1,
"line1": "1142 Main Street",
"line2": "Suite 100",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "94455",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 2,
"line1": "415 S. Pine Street",
"line2": "Suite 210",
"line3": "Apt. G",
"city": "Petaluma",
"country_subdivision_code": "CA",
"postal_code": "94954",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
}
}

Vendors

List Vendors

Returns a paginated list of vendors

Authorizations:

BasicAuth

query Parameters

updated_at	string Oldest date/time for the records to return
page	integer Results page to view

Responses

Response Schema: application/json

id	number
first_name	string
last_name	string
display_name	string
email	string
phone	string
mobile	string
fax	string
website	string
note	string
kind	string
created_at	string
updated_at	string
custom_field_1	string
custom_field_2	string
custom_field_3	string
custom_field_4	string
business_license_number	string
	object
	object
	object
	object

Response samples

Content type

application/json

{"id": 1,
"first_name": "Joe",
"last_name": "Sample",
"display_name": "Pacific Foods Co.",
"email": "jsample@pacificfoods.com",
"phone": "415-555-6758",
"website": "https://wherefour.com",
"kind": "distributor",
"created_at": "2020-09-11T13:57:47.005Z",
"updated_at": "2020-09-11T13:57:47.005Z",
"billing_address": {"id": 39,
"line1": "144 S. Broadway",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "95440",
"country": "USA",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 40,
"line1": "144 S. Broadway",
"city": "San Francisco",
"country_subdivision_code": "CA",
"country": "USA",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"payment_term": {"id": 3,
"name": "Net 15",
"net": 15
},
"delivery_method": {"id": 3,
"name": "Pickup",
"kind": "shipping"
}
}

Get Vendor

Returns the vendor record for the specified ID.

Authorizations:

BasicAuth

path Parameters

vendor_id

required

integer

vendor record ID

Responses

Response Schema: application/json

id	number
first_name	string
last_name	string
display_name	string
email	string
phone	string
mobile	string
fax	string
website	string
note	string
kind	string
created_at	string
updated_at	string
custom_field_1	string
custom_field_2	string
custom_field_3	string
custom_field_4	string
business_license_number	string
	object
	object
	object
	object

Response samples

Content type

application/json

{"id": 1,
"first_name": "Joe",
"last_name": "Sample",
"display_name": "Pacific Foods Co.",
"email": "jsample@pacificfoods.com",
"phone": "415-555-6758",
"website": "https://wherefour.com",
"kind": "distributor",
"created_at": "2020-09-11T13:57:47.005Z",
"updated_at": "2020-09-11T13:57:47.005Z",
"billing_address": {"id": 39,
"line1": "144 S. Broadway",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "95440",
"country": "USA",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 40,
"line1": "144 S. Broadway",
"city": "San Francisco",
"country_subdivision_code": "CA",
"country": "USA",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"payment_term": {"id": 3,
"name": "Net 15",
"net": 15
},
"delivery_method": {"id": 3,
"name": "Pickup",
"kind": "shipping"
}
}

Search Vendors

Searches vendor records for matches on the display name provided. Multiple matches may be returned.

Authorizations:

BasicAuth

query Parameters

page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

id	number
first_name	string
last_name	string
display_name	string
email	string
phone	string
mobile	string
fax	string
website	string
note	string
kind	string
created_at	string
updated_at	string
custom_field_1	string
custom_field_2	string
custom_field_3	string
custom_field_4	string
business_license_number	string
	object
	object
	object
	object

Response samples

Content type

application/json

{"id": 1,
"first_name": "Joe",
"last_name": "Sample",
"display_name": "Pacific Foods Co.",
"email": "jsample@pacificfoods.com",
"phone": "415-555-6758",
"website": "https://wherefour.com",
"kind": "distributor",
"created_at": "2020-09-11T13:57:47.005Z",
"updated_at": "2020-09-11T13:57:47.005Z",
"billing_address": {"id": 39,
"line1": "144 S. Broadway",
"city": "San Francisco",
"country_subdivision_code": "CA",
"postal_code": "95440",
"country": "USA",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"shipping_address": {"id": 40,
"line1": "144 S. Broadway",
"city": "San Francisco",
"country_subdivision_code": "CA",
"country": "USA",
"created_at": "2020-09-11T13:57:46.802Z",
"updated_at": "2020-09-11T13:57:46.802Z"
},
"payment_term": {"id": 3,
"name": "Net 15",
"net": 15
},
"delivery_method": {"id": 3,
"name": "Pickup",
"kind": "shipping"
}
}

Reports

Get inventory adjustment activity for a date range

Lists inventory adjustment activity for a date range. The IDs of records returned are for the adjustment record.

Authorizations:

BasicAuth

query Parameters

start_date_time required	string Start date/time for the oldest adjustment record to return, based on the adjustment's effective_at timestamp
end_date_time required	string End date/time for the newest adjustment record to return, based on the adjustment's effective_at timestamp
activity_types	Array of arrays Restrict records to the provided adjustment activity types
category_ids	Array of arrays Restrict records to inventory and stock lot that belong to the provided category IDs
customer_ids	Array of arrays Restrict records to activity associated with specific customer IDs
inventory_ids	Array of arrays Restrict records to the provided inventory IDs
location_ids	Array of arrays Restrict records to the provided location IDs
statuses	Array of arrays Restrict records to stock lots with the provided statuses
user_ids	Array of arrays Restrict records to adjustments made by the provided used IDs
vendor_ids	Array of arrays Restrict records to activity associated with specific vendor IDs
lot_code	Array of arrays Restrict records to adjustments made only to stock lots with the provided lot code
barcode	Array of arrays Restrict records to adjustments made only to stock lots with the provided barcode
serial_number	Array of arrays Restrict records to adjustments made only to stock lots with the provided serial number
page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

object

Response samples

Content type

application/json

{"id": 31,
"organization_id": 1,
"organization_name": "ABC Product Co.",
"created_at": "2024-02-24T22:25:04.623Z",
"effective_at": "2024-02-24T22:25:05.840Z",
"category_name": "Ingredients",
"inventory": "Raw material A",
"inventory_id": 1,
"property": "raw_material",
"sku": "AAAAAAAAAAA",
"unit_of_use": "gallon",
"unit_of_purchase": "gallon",
"purchase_conversion": "1.0",
"lot_code": "BCCD001",
"barcode": "BCCD-000001",
"serial_number": null,
"active_stock_id": 30,
"order_id": null,
"order_number": null,
"customer_id": null,
"customer_display_name": null,
"wo_number": null,
"work_order_id": null,
"vendor": "Pacific Supply Co.",
"purchase_number": null,
"purchase_id": null,
"reason": "purchase",
"change": "100.0",
"purchase_change": "100.0",
"cost_per_unit": "2.0",
"cost_applied": "200.0",
"old_location": "North Warehouse",
"location": "North Warehouse",
"transfer_request_number": null,
"note": "buy lot 1",
"system_note": null,
"backdated": null,
"superseded": null,
"user": "Tony Fiorello",
"global_identifier": "e3d1e35d-7f89-4468-80de-e90469185003",
"custom_fields": [ ]
}

Settings

List delivery methods

Lists the available delivery methods

Authorizations:

BasicAuth

query Parameters

page	integer Results page to view

Responses

Response Headers
Total	integer Total count of results
Per-Page	integer Number of results per page
Link	string URLs for the next or previous pages of the results

Response Schema: application/json

object

Response samples

Content type

application/json

{"id": 1,
"name": "UPS Ground",
"kind": "shipping",
"driver_name": null,
"driver_email": null,
"instructions": null,
"created_at": "2020-09-11T13:57:46.884Z",
"updated_at": "2020-09-11T13:57:46.884Z"
}

Wherefour API (1.0.18)

Categories

List categories

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Inventory

List Inventory Items

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Create inventory item

Authorizations:

Request Body schema: application/json

Responses

Response Schema: application/jsonexamplesapplication/json

Request samples

Response samples

Add stock lot

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Get last stock lot change

Authorizations:

Responses

Response Schema: application/json

Response samples

Search for inventory item

Authorizations:

query Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Invoices

List customer invoices

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Create Invoice

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Update invoice

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

List Invoices

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Get Invoice

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Search for invoice

Authorizations:

query Parameters

Request Body schema: application/json

Response Schema:
application/json

Request Body schema:
application/json