Order

The Order API allows the user to order inventory from their vendors. It pulls and shares data with our other cloud services such as Data Management and the Portal.

Security

jwt-bearer-token

apiKey	API Key
Name	Authorization
In	header

Endpoints

GET /order/schema

Summary

Get the schema of the order.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company to manage data for

Responses

Code	Description	Schema
200	Success	order_get_response_1
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

GET /order/{id}

Summary

Get the order detail.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company to manage data for
path	`id`	string	Yes	`objectId`, the order's ID
query	`get_updated_items`	boolean	No	Get updated items

Responses

Code	Description	Schema
200	Success	order_get_response_2
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

PATCH /order/{id}

Summary

Update the order.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company to manage data for
path	`id`	string	Yes	`objectId`, the order's ID
body	`body`	order_patch_body_5	Yes	The JSON formatted request

Responses

Code	Description	Schema
204	No content
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

GET /order

Summary

Get the order list.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company who owns the document.
query	`$filter`	string	No
query	`$top`	number	No	The maximum documents to return. For example, if `top` is 100, and `skip` is 0, the system returns documents 1 to 100.
query	`$skip`	number	No	The documents to skip before returning. For example, if `top` is 100, and `skip` is 100, the system returns documents 101 to 200.
query	`$select`	string	No
query	`$orderby`	string	No

Responses

Code	Description	Schema
200	Success	order_get_response_3
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

POST /order

Summary

Create the order.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company to manage data for
body	`body`	order_post_body_6	Yes	The JSON formatted request

Responses

Code	Description	Schema
201	Success	order_post_response_6
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

PATCH /order/{id}/acknowledge

Summary

Acknowledgement to remove the Data Management sync result reminder info in the Order module.

Requirements

Remove fields updated_items/unavailable_items in the order document.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company to manage data for
path	`id`	string	Yes	`objectID`, the order's ID

Responses

Code	Description	Schema
204	No content
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

Data Models

order_get_response_1

Field Name	Type	Description
order_get_response_1	object	The definition of the order schema

order_get_response_2

Field Name	Type	Required	Description
`_id`	string	Yes
`transaction_id`	string	Yes
`type`	string	Yes	The type of transaction
`status`	string	Yes	The status of transaction
`inventory_items`	[ order_get_response_2_inventory_items ]	Yes	The reference schema
`transaction_date`	date/time	Yes
`delivery_date`	date/time	Yes
`vendor_entity_id`	string	Yes
`site_id`	string	Yes	The warehouse's site identifier (ID)
`site_name`	string	Yes	The warehouse's site name
`store_number`	string	Yes	The warehouse's store number
`vendor_name`	string	Yes
`total_cost`	number	Yes
`delivery_fee`	number	No	The delivery fee
`tax_fee`	number	No	The sales tax fee
`external_order_number`	string	No	The external order number entered manually
`internal_number`	string	Yes	The internal number
`updated_items`	object	No	The updated items' keys and values
`unavailable_items`	object	No	The removed items' keys and names
`created_at`	date/time	No	The date of creation
`created_by`	string	Yes	The `created_by` user ID
`updated_at`	date/time	Yes	The data of the updated record
`updated_by`	string	Yes	The `updated_by` user ID

order_get_response_2_inventory_items

Field Name	Type	Required
`_id`	string	No
`item_entity_id`	string	No
`item_name`	string	No
`major_category_entity_id`	string	No
`major_category_external_id`	string	No
`major_category_name`	string	No
`minor_category_entity_id`	string	No
`minor_category_external_id`	string	No
`minor_category_name`	string	No
`measure_id`	string	No
`measure_description`	string	No
`measure_entity_id`	string	No
`measure_code`	string	No
`gl_account_name`	string	No
`gl_account_entity_id`	string	No
`count`	number	Yes
`item_cost`	number	Yes
`measure_factor_value`	number	Yes
`total_cost`	number	No
`base_measure_count`	number	No
`initial_count`	number	No
`initial_item_cost`	number	No
`initial_total_cost`	number	No
`initial_base_measure_count`	number	No

order_get_response_3

Field Name	Type	Description
`items`	[ order_get_response_3_items ]
`total`	number
`page_count`	number
`current_page`	number
`page_size`	number

order_get_response_3_items

Field Name	Type	Description
`_id`	string
`vendor_name`	string
`transaction_date`	date/time
`delivery_date`	date/time
`total_cost`	number	The total cost of `inventory_items`
`external_order_number`	string
`invoice_number`	string	The invoice number
`status`	string	The status of the transaction

order_patch_body_5

Field Name	Type	Description
`transaction_id`	string	The transaction identifier (ID)
`type`	string	The order type is delivery. Enum: `delivery`
`status`	string	The order status
`vendor_entity_id`	string	The `entity_id` of the vendor
`site_id`	string	The warehouse's site ID
`vendor_name`	string	The name of the vendor
`inventory_items`	[ order_patch_body_5_inventory_items ]	The inventory items to be purchased
`transaction_date`	date/time	The date of the order
`delivery_date`	date/time	The date of delivery
`external_order_number`	string	The external order number entered manually
`delivery_fee`	number	The delivery fee
`tax_fee`	number	The sales tax fee
`invoice_number`	string	The invoice number

order_patch_body_5_inventory_items

Field Name	Type	Required
`_id`	string	Yes
`item_entity_id`	string	Yes
`measure_entity_id`	string	Yes
`count`	number	Yes
`item_cost`	number	No

order_post_body_6

Field Name	Type	Required	Description
`transaction_id`	string	Yes	The transaction identifier (ID)
`site_id`	string	Yes	The warehouse's site ID
`type`	string	Yes	The order type is delivery. Enum: `delivery`
`status`	string	Yes	The order status
`vendor_entity_id`	string	Yes	The `entity_id` of the vendor
`inventory_items`	order_post_body_6_inventory_items	No	The inventory items to be purchased
`delivery_date`	date/time	Yes	The date of delivery
`transaction_date`	date/time	Yes	The date of the order
`external_order_number`	string	No	The external order number entered manually
`invoice_number`	string	No	The invoice number

order_post_body_6_inventory_items

Field Name	Type	Required
`_id`	string	Yes
`item_entity_id`	string	Yes
`measure_entity_id`	string	Yes
`count`	number	Yes

order_post_response_6

Field Name	Type	Required	Description
`_id`	string	Yes
`transaction_id`	string	Yes
`type`	string	Yes
`status`	string	Yes
`inventory_items`	[ order_post_response_6_inventory_items ]	Yes
`transaction_date`	date/time	Yes
`delivery_date`	date/time	Yes
`vendor_entity_id`	string	Yes
`site_id`	string	Yes	The warehouse's site identifier (ID)
`site_name`	string	Yes	The warehouse's site name
`store_number`	string	No	The warehouse's store number
`vendor_name`	string	Yes
`total_cost`	number	Yes
`external_order_number`	string	No	The external order number entered manually
`internal_number`	string	Yes	The internal number
`invoice_number`	string	No	The invoice number
`company_id`	string	Yes	The company ID of the user
`created_at`	date/time	No	The date of creation
`created_by`	string	Yes	The `created_by` user ID
`updated_at`	date/time	Yes	The data of the updated record
`updated_by`	string	Yes	The `updated_by` user ID

order_post_response_6_inventory_items

Field Name	Type	Required
`_id`	string	No
`item_entity_id`	string	No
`item_name`	string	No
`major_category_entity_id`	string	No
`major_category_external_id`	string	No
`major_category_name`	string	No
`minor_category_entity_id`	string	No
`minor_category_external_id`	string	No
`minor_category_name`	string	No
`measure_id`	string	No
`measure_description`	string	No
`measure_entity_id`	string	No
`measure_code`	string	No
`gl_account_name`	string	No
`gl_account_entity_id`	string	No
`count`	number	Yes
`item_cost`	number	Yes
`measure_factor_value`	number	Yes
`total_cost`	number	No
`base_measure_count`	number	No
`initial_count`	number	No
`initial_item_cost`	number	No
`initial_total_cost`	number	No
`initial_base_measure_count`	number	No

Order

Security

Endpoints

GET /order/schema

GET /order/{id}

PATCH /order/{id}

GET /order

POST /order

PATCH /order/{id}/acknowledge

Data Models

order_get_response_1

order_get_response_2

order_get_response_2_inventory_items

order_get_response_3

order_get_response_3_items

order_patch_body_5

order_patch_body_5_inventory_items

order_post_body_6

order_post_body_6_inventory_items

order_post_response_6

order_post_response_6_inventory_items

Search results