{"info":{"_postman_id":"36cb529e-7d2f-4927-b17a-ab466f85920d","name":"NM Trace 2.0 API","description":"

Authentication

Sending the required valid payload to POST Login API endpoint provides a sessionid, which will be used as the x-api-key header for all future calls for that login session.

URL

https://api.nm.trace.biotrackthc.net

Datetime stamp formatting

Must use ISO8601 format, as shown below.

YYYY-MM-DDTHH:mm:SS**+/-**TZ

2021-06-02T12:30:00-07

June 2nd, 2021, 12:30:00 PM, Pacific Standard Time

Training Databases

If the training parameter is omitted in any call, the action will be ran against the production database by default.

Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Error	Description
400	MISSING_CARD_KEY	card_key is required for any action that dispenses
400	MISSING_PICKUP_DATE
400	INVALID_EPHEMERAL_KEY
400	PATIENT_NOT_FOUND
400	NO_BARCODE_POSSESSION	barcode is valid but not for the given location
400	INVALID_BARCODE_LOCATION	barcode is valid but not for the given location
400	NO_BARCODES_PROVIDED
400	DUPLICATE_BARCODE
400	BARCODE_NOT_FOUND
400	NOT_ENOUGH_INVENTORY
400	DATA_PAYLOAD_NOT_ARRAY
400	QUANTITY_LESS_THAN_EQUAL_ZERO
400	MISSING_DATA	a required field is missing from the data payload
400	INVALID_REQUEST_BODY
400	INVALID_PUT_PARAMS
400	INVALID_PARAMS
400	PUT_RESOURCE_ALREADY_VOIDED
400	DB_INSERT_ERROR
400	RESOURCE_ALREADY_DELETED
400	RESOURCE_NOT_FOUND
400	NO_RESOURCE_POSSESSION
400	RESOURCE_ALREADY_VOIDED
400	PUT_RESOURCE_ALREADY_DELETED
400	PUT_RESOURCE_ALREADY_RESCHEDULED
400	PUT_ITEM_QUANTITY_LIMIT_OVERAGE
400	PRICE_LESS_THAN_EQUAL_ZERO
400	ACTION_NOT_ALLOWED
400	LIMIT_OVERAGE
400	INVALID_LICENSE_TYPE
400	INVALID_CREDENTIALS
400	INVALID_LICENSE_NUMBER
400	EXPIRED_CREDENTIALS
400	NO_SESSION_PROVIDED
400	INVALID_SESSION
400	INVALID_SUPER_USER
400	INVALID_SESSION_NOT_FOUND
400	EXPIRED_SESSION
400	INVALID_LICENSE
400	PUT_ORDER_ALREADY_TENDERED
400	UNIQUE_ID_GENERATION_FAILURE
400	GENERAL_DATABASE_ERROR
400	MANIFEST_ACCEPT_INVALID_DRIVERS_COUNT
400	PARAM_MUST_BE_A_NUMBER
400	INVALID_PAYLOAD

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"URL","slug":"url"},{"content":"Datetime stamp formatting","slug":"datetime-stamp-formatting"},{"content":"Training Databases","slug":"training-databases"},{"content":"Error Codes","slug":"error-codes"}],"owner":"15930632","collectionId":"36cb529e-7d2f-4927-b17a-ab466f85920d","publishedId":"TzXxjyBF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4a8aa9"},"publishDate":"2021-05-28T20:29:02.000Z"},"item":[{"name":"Authorization","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"5c3ca0c7-c127-4286-b58a-9a89f18eb9fc","exec":["var sessionID = pm.response.json()[\"sessionid\"];\r","pm.environment.set(\"sessionid\", sessionID);"],"type":"text/javascript"}}],"id":"2c424844-fb01-46f9-890f-8d2d4f6bf3fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"{{username}}\",\r\n \"password\": \"{{password}}\",\r\n \"license\": \"{{license}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/login","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Note
username	text	yes
password	text	yes
license	text	yes	location UBI for client

Response Example

{\n    \"read_only\": 0,\n    \"sessionid\": \"98f1435c5f463d0be7a81124b6cc171c80378a04a7c147fbc4c16cc155ea96bc32947809aac50fc8060e4ff760b4a41bf75580f74b4bab1ae6292a35eea6f5dc\",\n    \"success\": 1,\n    \"time\": 1622581029\n}\n

","urlObject":{"path":["v1","login"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c424844-fb01-46f9-890f-8d2d4f6bf3fe"},{"name":"Card Lookup","event":[{"listen":"test","script":{"id":"a82532aa-f28d-4942-9b58-14dc7cb64d0b","exec":["var cardKey = pm.response.json()[\"card_key\"];\r","pm.environment.set(\"cardKey\", cardKey);"],"type":"text/javascript"}}],"id":"95ad2cef-531b-45c0-a464-6aa37ceb13bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"sessionid\": \"{{sessionid}}\",\r\n \"action\": \"card_lookup\",\r\n \"card_id\": \"S3S3457GUK\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://mcp-tracking.nmhealth.org/serverjson.asp","description":"

This is a v1 call that can be referenced here https://server.biotrackthc.net/API_documentation/New_Mexico/?json#sales-card_lookup
Please follow the instructions for the v1 base URL for this call.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Note
sessionid	text	yes
action	text	yes	must be 'card_lookup'
card_id	text	yes	patient license number

Response Example

{\"sessiontime\":1622581064,\"card_active\":1,\"card_limit\":\"136.27\",\"success\":1,\"card_key\":\"903f47d8e40cd5cdbec6c6775485150a68f1ebe4a46ce6651b7341bf69080c51e06ebece923d338d92fb21b8e63ad6e071bd5ef977f34abf28515698ca17c6fd\",\"card_expiration\":\"20230902\",\"privileges\":\"Qualified Patient (QP)\",\"card_id\":\"S3S3457GUK\"}\n\n

","urlObject":{"protocol":"https","path":["serverjson.asp"],"host":["mcp-tracking","nmhealth","org"],"query":[],"variable":[]}},"response":[],"_postman_id":"95ad2cef-531b-45c0-a464-6aa37ceb13bf"}],"id":"0f1e259d-3518-4a66-b5ac-e9751c68f221","description":"

Here's a description.

\n","_postman_id":"0f1e259d-3518-4a66-b5ac-e9751c68f221"},{"name":"Delivery","item":[{"name":"Delivery","id":"e887165d-4239-4c6d-8b1b-8cfbe0ec54b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/delivery?training=0&start=2021-05-27T00:00:00-07&end=2021-05-27T23:59:59-07&page=1&search_by=arrival","description":"

Omitting start will respond with all records up to the end. \nOmitting end will respond with all records from start.\nOmitting both start and end will respond will all records.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Note
training	bool	no
start	datetime ISO8601	no
end	datetime ISO8601	no
page	int	no
search_by	text	yes	created or arrival

Response Example

[\n    {\n        \"address_1\": \"123 Any St\",\n        \"address_2\": null,\n        \"city\": \"Anytown\",\n        \"created_on\": \"2021-05-24 15:43:46-06\",\n        \"deleted\": 0,\n        \"delivery_arrival_est\": \"2021-05-27 13:00:00-06\",\n        \"external_id\": null,\n        \"id\": 62,\n        \"location\": 788,\n        \"manifest_stop_id\": null,\n        \"manifestid\": null,\n        \"notes\": null,\n        \"order\": {\n            \"completed\": 0,\n            \"created_on\": \"2021-05-24 15:43:38.679017-06\",\n            \"customer_id\": \"5601af47f2\",\n            \"deleted\": 0,\n            \"external_id\": null,\n            \"id\": 11922,\n            \"items\": [\n                {\n                    \"created_on\": \"2021-05-24 15:43:38.679017-06\",\n                    \"deleted\": 0,\n                    \"external_id\": null,\n                    \"id\": 12282,\n                    \"inventoryid\": \"4128252287923983\",\n                    \"location\": 788,\n                    \"order_id\": 11922,\n                    \"orgid\": 1842,\n                    \"price\": \"10.5\",\n                    \"quantity\": \"1\",\n                    \"saleid\": 31370316,\n                    \"transactionid\": 35362534,\n                    \"transactionid_original\": 35362534,\n                    \"updated_on\": \"2021-05-24 15:43:38.679017-06\",\n                    \"voided\": 0\n                }\n            ],\n            \"location\": \"12121212\",\n            \"notes\": null,\n            \"orgid\": 1842,\n            \"originating_system\": null,\n            \"tendered\": 1,\n            \"ticketid\": 39232920,\n            \"transactionid\": 35362534,\n            \"transactionid_original\": 35362534,\n            \"updated_on\": \"2021-05-24 15:43:38.679017-06\",\n            \"voided\": 0\n        }\n    }\n]\n

","urlObject":{"path":["v1","delivery"],"host":["{{localaddress}}"],"query":[{"key":"training","value":"0"},{"key":"start","value":"2021-05-27T00:00:00-07"},{"key":"end","value":"2021-05-27T23:59:59-07"},{"key":"page","value":"1"},{"key":"search_by","value":"arrival"}],"variable":[]}},"response":[],"_postman_id":"e887165d-4239-4c6d-8b1b-8cfbe0ec54b6"},{"name":"Create","event":[{"listen":"test","script":{"id":"29f041a5-2f6d-4659-b0a5-ac0f3d75320a","exec":["var delivery_id = pm.response.json()[\"delivery_id\"];\r","pm.environment.set(\"last_delivery_id\", delivery_id);\r","\r","var item_id = pm.response.json()[\"items\"][0][\"id\"];\r","pm.environment.set(\"last_delivery_item_id\", item_id);"],"type":"text/javascript"}}],"id":"8fafb08c-24f5-45ce-86f4-c110d731d82e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text","description":"

3b3bd0e9fbc337a79d3bbeb8d07cc9b6377b8bea7aa8d38a592fa6546d5f989a873dab7cf16c7b70e166787b8fb2b0b11b6360353ea6884a1cdadd5035ba4487

\n"}],"body":{"mode":"raw","raw":"{\r\n \"location\": \"21\",\r\n \"training\": 0,\r\n \"stops\": [\r\n {\r\n \"travel_route\":\"Head south on Main St NW toward Rio Grande Blvd NW. Turn right onto Rio Grande Blvd NW. Turn right onto Dora Ave NW. Turn right onto Panmunjon Rd NW. Turn right onto Mountain Rd NW. Turn left before Little Anita\\'s New Mexican Food. Turn right to merge onto I-40 E. Take exit 165 for Eubank Blvd. Turn right onto Eubank Blvd NE. Slight right onto G Ave SE. Turn left onto 20th St SE. 20th St SE turns slightly right and becomes Hardin Dr SE. Turn left onto 9th St. 9th St turns left and becomes St\",\r\n \"stopnumber\": 1,\r\n \"delivery_id\": 218,\r\n \"depart_time\": \"2022-03-10T13:17:56EST\",\r\n \"arrive_time\": \"2022-03-10T13:47:56EST\"\r\n }\r\n ],\r\n \"transporter_vehicle_id\": 860,\r\n \"transporter_id\": \"19\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v2/delivery","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no
card_key	text	yes	obtained via card_lookup
location	int	yes
delivery_arrival_est	text	yes
address_1	text	yes
address_2	text	no
city	text	yes
state	text	yes	2 letter code
zip	text	yes
notes	text	no
barcode	text	yes
quantity	numeric	yes
price	numeric	yes
items	array	yes

Items Array Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Note
barcode	text
quantity	numeric
price	numeric

Response Example

{\n    \"delivery_id\": 65,\n    \"items\": [\n        {\n            \"barcode\": \"4128252287923983\",\n            \"dispense_id\": 31370319,\n            \"id\": 12285,\n            \"price\": 10.5,\n            \"quantity\": 1,\n            \"transactionid\": 35363268\n        }\n    ],\n    \"order_id\": 11925,\n    \"ticket_id\": 39232923,\n    \"transactionid\": 35363268\n}\n

","urlObject":{"path":["v2","delivery"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8fafb08c-24f5-45ce-86f4-c110d731d82e"},{"name":"Create V2","event":[{"listen":"test","script":{"id":"979ce8c3-c947-4bf8-b72f-5f3c595f122f","exec":["var delivery_id = pm.response.json()[\"delivery_id\"];\r","pm.environment.set(\"last_delivery_id\", delivery_id);\r","\r","var item_id = pm.response.json()[\"items\"][0][\"id\"];\r","pm.environment.set(\"last_delivery_item_id\", item_id);"],"type":"text/javascript"}}],"id":"8fa93b2c-c794-44d1-a6f4-f84ba4abbf65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"card_key\": \"{{cardKey}}\",\r\n \"location\": 12121212,\r\n \"delivery_arrival_est\": \"2021-07-08T12:00:00-07\",\r\n \"address_1\": \"123 Any St\",\r\n \"address_2\": \"Apt 2\",\r\n \"city\": \"Anytown\",\r\n \"state\": \"NM\",\r\n \"zip\": \"01234\",\r\n \"notes\": \"ring bell\",\r\n \"txn_type\": \"RECREATIONAL\",\r\n \"items\": [\r\n {\r\n \"barcode\": \"4128252287923983\",\r\n \"quantity\": 1,\r\n \"price\": 10.50,\r\n \"tax\": {\r\n \"excise\": 2.34,\r\n \"other\": 1.64\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v2/delivery","description":"

Request

Parameter	Type	Required?	Note
training	bool	no
card_key	text	yes, when 'txn_type' is 'MEDICAL'	obtained via card_lookup, only required when txn_type is 'MEDICAL'
location	int	yes
delivery_arrival_est	text	yes
address_1	text	yes
address_2	text	no
city	text	yes
state	text	yes	2 letter code
zip	text	yes
notes	text	no
barcode	text	yes
quantity	numeric	yes
price	numeric	yes
items	array	yes
txn_type	text	yes	'MEDICAL','RECREATIONAL'

Items Array Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Note
barcode	text
quantity	numeric
price	numeric
tax	object	Only accepted when 'txn_type' is 'RECREATIONAL'

Tax Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Note
other	numeric	Other taxes collected by the POS
excise	numeric	Excise taxes collected by the POS

Response Example

{\n    \"delivery_id\": 65,\n    \"items\": [\n        {\n            \"barcode\": \"4128252287923983\",\n            \"dispense_id\": 31370319,\n            \"id\": 12285,\n            \"price\": 10.5,\n            \"quantity\": 1,\n            \"transactionid\": 35363268\n        }\n    ],\n    \"order_id\": 11925,\n    \"ticket_id\": 39232923,\n    \"transactionid\": 35363268\n}\n

","urlObject":{"path":["v2","delivery"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[{"id":"998dc2cf-ad94-4322-9208-4032d2363371","name":"Recreational","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"location\": 12121212,\r\n \"delivery_arrival_est\": \"2021-07-08T12:00:00-07\",\r\n \"address_1\": \"123 Any St\",\r\n \"address_2\": \"Apt 2\",\r\n \"city\": \"Anytown\",\r\n \"state\": \"NM\",\r\n \"zip\": \"01234\",\r\n \"notes\": \"ring bell\",\r\n \"txn_type\": \"RECREATIONAL\",\r\n \"items\": [\r\n {\r\n \"barcode\": \"4128252287923983\",\r\n \"quantity\": 1,\r\n \"price\": 10.50,\r\n \"tax\": {\r\n \"excise\": 2.34,\r\n \"other\": 1.64\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v2/delivery"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"4f45a924-87aa-4684-b4f3-a90a8dcb321c","name":"Medical","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"card_key\": \"{{cardKey}}\",\r\n \"location\": 12121212,\r\n \"delivery_arrival_est\": \"2021-07-08T12:00:00-07\",\r\n \"address_1\": \"123 Any St\",\r\n \"address_2\": \"Apt 2\",\r\n \"city\": \"Anytown\",\r\n \"state\": \"NM\",\r\n \"zip\": \"01234\",\r\n \"notes\": \"ring bell\",\r\n \"txn_type\": \"MEDICAL\",\r\n \"items\": [\r\n {\r\n \"barcode\": \"4128252287923983\",\r\n \"quantity\": 1,\r\n \"price\": 10.50\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v2/delivery"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8fa93b2c-c794-44d1-a6f4-f84ba4abbf65"},{"name":"Void","event":[{"listen":"test","script":{"id":"7736fa76-beb1-4452-afd1-e263ebd76a4a","exec":[""],"type":"text/javascript"}}],"id":"ebeff50f-c603-4335-81ce-0362b2295705","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/delivery/{{last_delivery_id}}/void","description":"

Deliveries that are currently on a manifest cannot be voided. If you wish to void a delivery that is currently on a manifest, you would have to first void the manifest and then you can void the delivery. When voiding the record, it will still show when using the GET endpoint for deliveries.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no

Response Example

{\n    \"transactionid\": 35363280\n}\n\n

","urlObject":{"path":["v1","delivery","{{last_delivery_id}}","void"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ebeff50f-c603-4335-81ce-0362b2295705"},{"name":"Void Item","id":"c9ebb778-ce50-427c-ace6-67cc658c03eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/delivery/{{last_delivery_id}}/item/{{last_delivery_item_id}}/void","description":"

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no

Response Example

{\n    \"transactionid\": 35363280\n}\n

","urlObject":{"path":["v1","delivery","{{last_delivery_id}}","item","{{last_delivery_item_id}}","void"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c9ebb778-ce50-427c-ace6-67cc658c03eb"},{"name":"Complete","id":"ef79e5e4-03a7-4924-b920-38465cc69d32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/delivery/{{last_delivery_id}}/complete","description":"

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no

Response Example

{\n    \"transactionid\": 35363303\n}\n

","urlObject":{"path":["v1","delivery","{{last_delivery_id}}","complete"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef79e5e4-03a7-4924-b920-38465cc69d32"},{"name":"Update","id":"83dc26d3-4ec8-4ad5-9e3a-8508465a38a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false,\r\n \"address_1\": \"345 Super Street\",\r\n \"address_2\": \"Suite 2\",\r\n \"city\": \"Supertown\",\r\n \"state\": \"NM\",\r\n \"zip\": \"01234\",\r\n \"delivery_arrival_est\": \"2021-06-23T12:32:00-07\",\r\n \"notes\": \"I added some notes\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/delivery/{{last_delivery_id}}","description":"

Request - Not on started manifest

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?
training	bool	no
address_1	text	no
address_2	text	no
city	text	no
state	text	no
zip	text	no
delivery_arrival_est	datetime ISO8601	no
notes	text	no

Request - On started manifest

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no
notes	text	no

Response Example

{\n    \"transactionid\": 35363307\n}\n

","urlObject":{"path":["v1","delivery","{{last_delivery_id}}"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"83dc26d3-4ec8-4ad5-9e3a-8508465a38a4"},{"name":"Update Item","id":"a62e559e-327c-4c46-b1ab-bc1aa1f7fcf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false,\r\n \"quantity\": 2,\r\n \"price\": 21.50\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/delivery/{{last_delivery_id}}/item/{{last_delivery_item_id}}","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?
training	bool	no
quantity	numeric	no
price	numeric	no

Response Example

{\n    \"transactionid\": 35363309\n}\n

","urlObject":{"path":["v1","delivery","{{last_delivery_id}}","item","{{last_delivery_item_id}}"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a62e559e-327c-4c46-b1ab-bc1aa1f7fcf8"},{"name":"Delete","id":"11c4a488-94f8-4b28-868e-5e7443b15f7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","type":"text","value":"{{sessionid}}"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/delivery/{{last_delivery_id}}","description":"

Deliveries that are currently on a manifest cannot be deleted. If you wish to delete a delivery that is currently on a manifest, you would have to first void the manifest and then you can delete the delivery. When deleting the record, it will NOT show when using the GET endpoint for deliveries. A delivery that has been voided CANNOT be deleted.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no

Response Example

{\n    \"transactionid\": 35363311\n}\n\n

","urlObject":{"path":["v1","delivery","{{last_delivery_id}}"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"11c4a488-94f8-4b28-868e-5e7443b15f7d"}],"id":"4b71049a-b3a0-4337-ba07-65d03996a58c","_postman_id":"4b71049a-b3a0-4337-ba07-65d03996a58c","description":""},{"name":"Pickup","item":[{"name":"Get","id":"7329c0df-a570-49c4-90d4-77010e4f7256","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","type":"text","value":"{{sessionid}}"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false,\r\n \"start\": \"2021-05-12T00:00:00-07\",\r\n \"end\": \"2021-05-15T23:59:59-07\",\r\n \"page\": 1,\r\n \"search_by\": \"created\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/pickups","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Note
training	bool	no
start	datetime ISO8601	no
end	datetime ISO8601	no
page	int	yes
search_by	text	yes	'pickup_time' or 'created_on'

Response Example

[\n    {\n        \"created_on\": \"2021-05-12 17:11:12.459821-06\",\n        \"deleted\": 0,\n        \"id\": 2087,\n        \"location\": 788,\n        \"notes\": null,\n        \"order\": {\n            \"completed\": 0,\n            \"created_on\": \"2021-05-12 17:11:12.459821-06\",\n            \"customer_id\": \"5601af47f2\",\n            \"deleted\": 0,\n            \"external_id\": null,\n            \"id\": 11904,\n            \"location\": null,\n            \"notes\": null,\n            \"orgid\": 1842,\n            \"originating_system\": null,\n            \"tendered\": 1,\n            \"ticketid\": 39232902,\n            \"transactionid\": 35362375,\n            \"transactionid_original\": 35362375,\n            \"updated_on\": \"2021-05-12 17:11:12.459821-06\",\n            \"voided\": 0\n        },\n        \"order_id\": 11904,\n        \"orgid\": 1842,\n        \"pickup_time\": \"2021-05-13 13:00:00-06\",\n        \"transactionid\": 35362375,\n        \"transactionid_original\": 35362375,\n        \"updated_on\": \"2021-05-12 17:11:12.459821-06\"\n    }\n]\n

","urlObject":{"path":["v1","pickups"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7329c0df-a570-49c4-90d4-77010e4f7256"},{"name":"Create","event":[{"listen":"test","script":{"id":"44996995-7443-4d3b-96c7-95f5822883e8","exec":["var pickup_id = pm.response.json()[\"id\"];\r","pm.environment.set(\"last_pickup_id\", pickup_id);\r","\r","var item_id = pm.response.json()[\"items\"][0][\"id\"];\r","pm.environment.set(\"last_pickup_item_id\", item_id);"],"type":"text/javascript"}}],"id":"0112cb9f-d049-401f-a721-34f59b3af48c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"location\": \"12121212\",\r\n \"card_key\": \"{{cardKey}}\",\r\n \"training\": false,\r\n \"pickup_time\": \"2021-06-13T12:00:00-07\",\r\n \"external_id\": \"X01234\",\r\n \"items\": [\r\n {\r\n \"barcode\": \"4128252287923983\",\r\n \"quantity\": 1,\r\n \"price\": 24,\r\n \"external_id\": \"A-X01234\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/pickups/","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?
training	bool	no
location	int	yes
card_key	text	yes
pickup_time	datetime ISO8601	yes
external_id	text	no
items	array	yes

Items Array Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Note
barcode	text
quantity	numeric
price	numeric

Response Example

{\n    \"id\": 2090,\n    \"items\": [\n        {\n            \"barcode\": \"4128252287923983\",\n            \"dispense_id\": 31370329,\n            \"id\": 12295,\n            \"price\": 24,\n            \"quantity\": 1,\n            \"transactionid\": 35363313\n        }\n    ],\n    \"ticket_id\": 39232933,\n    \"transactionid\": 35363313\n}\n

","urlObject":{"path":["v1","pickups",""],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0112cb9f-d049-401f-a721-34f59b3af48c"},{"name":"Create V2","event":[{"listen":"test","script":{"id":"ddd8828f-9d8a-45ad-9149-170fde44e10a","exec":["var pickup_id = pm.response.json()[\"id\"];\r","pm.environment.set(\"last_pickup_id\", pickup_id);\r","\r","var item_id = pm.response.json()[\"items\"][0][\"id\"];\r","pm.environment.set(\"last_pickup_item_id\", item_id);"],"type":"text/javascript"}}],"id":"7dc1516b-fb41-4ddf-bdd2-039fd6bb7a11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"location\": \"12121212\",\r\n \"card_key\": \"{{cardKey}}\",\r\n \"training\": false,\r\n \"pickup_time\": \"2021-06-13T12:00:00-07\",\r\n \"external_id\": \"X01234\",\r\n \"items\": [\r\n {\r\n \"barcode\": \"4128252287923983\",\r\n \"quantity\": 1,\r\n \"price\": 24,\r\n \"external_id\": \"A-X01234\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v2/pickups/","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no
location	int	yes
txn_type	text	yes	'MEDICAL','RECREATIONAL'
card_key	text	yes, only when 'txn_type' is 'MEDICAL'	Only required when 'txn_type' is 'MEDICAL'
pickup_time	datetime ISO8601	yes
external_id	text	no
items	array	yes

Items Array Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Note
barcode	text
quantity	numeric
price	numeric
tax	object	Only accepted when 'txn_type' is 'RECREATIONAL'

Tax Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Note
other	numeric	Other taxes collected by the POS
excise	numeric	Excise taxes collected by the POS

Response Example

{\n    \"id\": 2090,\n    \"items\": [\n        {\n            \"barcode\": \"4128252287923983\",\n            \"dispense_id\": 31370329,\n            \"id\": 12295,\n            \"price\": 24,\n            \"quantity\": 1,\n            \"transactionid\": 35363313\n        }\n    ],\n    \"ticket_id\": 39232933,\n    \"transactionid\": 35363313\n}\n

","urlObject":{"path":["v2","pickups",""],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[{"id":"7a52917f-d986-459a-8de7-3a45c3f6c475","name":"Recreational","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"location\": \"12121212\",\r\n \"txn_type\": \"RECREATIONAL\",\r\n \"training\": false,\r\n \"pickup_time\": \"2021-06-13T12:00:00-07\",\r\n \"external_id\": \"X01234\",\r\n \"items\": [\r\n {\r\n \"barcode\": \"4128252287923983\",\r\n \"quantity\": 1,\r\n \"price\": 24,\r\n \"external_id\": \"A-X01234\",\r\n \"tax\": {\r\n \"other\": 2.46,\r\n \"excise\": 1.33\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/pickups/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"46178a18-5cd7-4d06-870f-725c1d5a4bf0","name":"Medical","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"location\": \"12121212\",\r\n \"card_key\": \"{{cardKey}}\",\r\n \"training\": false,\r\n \"pickup_time\": \"2021-06-13T12:00:00-07\",\r\n \"external_id\": \"X01234\",\r\n \"items\": [\r\n {\r\n \"barcode\": \"4128252287923983\",\r\n \"quantity\": 1,\r\n \"price\": 24,\r\n \"external_id\": \"A-X01234\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/pickups/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7dc1516b-fb41-4ddf-bdd2-039fd6bb7a11"},{"name":"Void","id":"faf9efa6-5c8e-44ea-9634-5c52c0a74fe8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/pickups/{{last_pickup_id}}/void","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no

Response Example

{\n    \"transactionid\": 35363311\n}\n

","urlObject":{"path":["v1","pickups","{{last_pickup_id}}","void"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"faf9efa6-5c8e-44ea-9634-5c52c0a74fe8"},{"name":"Void Item","id":"42af182e-f789-4643-863d-e81bd696492e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/pickups/{{last_pickup_id}}/item/{{last_pickup_item_id}}/void","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no

Response Example

{\n    \"transactionid\": 35363311\n}\n

","urlObject":{"path":["v1","pickups","{{last_pickup_id}}","item","{{last_pickup_item_id}}","void"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"42af182e-f789-4643-863d-e81bd696492e"},{"name":"Complete","event":[{"listen":"test","script":{"id":"c181bec4-7078-4899-8ca6-30a27c5b9c6c","exec":[""],"type":"text/javascript"}}],"id":"e3fa5c97-37e3-448a-969e-cfea5c7092ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/pickups/{{last_pickup_id}}/complete","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no

{\n    \"transactionid\": 35363332\n}\n

","urlObject":{"path":["v1","pickups","{{last_pickup_id}}","complete"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e3fa5c97-37e3-448a-969e-cfea5c7092ba"},{"name":"Update","id":"5ba3621e-288c-4c47-8468-6f4d2f1d2119","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false,\r\n \"notes\": \"I added some notes.\",\r\n \"pickup_time\": \"2026-05-19T06:52:25.718Z\",\r\n \"external_id\": \"X99999\"\r\n}"},"url":"{{localaddress}}/v1/pickups/{{last_pickup_id}}","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?
training	bool	no
notes	text	no
pickup_time	datetime ISO8601	no
external_id	text	no

Response Example

{\n    \"transactionid\": 35363334\n}\n

","urlObject":{"path":["v1","pickups","{{last_pickup_id}}"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ba3621e-288c-4c47-8468-6f4d2f1d2119"},{"name":"Update Item","id":"d3e139ae-9877-4054-99cf-a5323e480908","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false,\r\n \"price\": 14,\r\n \"quantity\": 1,\r\n \"external_id\": \"B-X01234\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/pickups/{{last_pickup_id}}/item/{{last_pickup_item_id}}","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?
training	bool	no
price	numeric	no
quantity	numeric	no
external_id	text	no

Response Example

{\n    \"transactionid\": 35363334\n}\n

","urlObject":{"path":["v1","pickups","{{last_pickup_id}}","item","{{last_pickup_item_id}}"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3e139ae-9877-4054-99cf-a5323e480908"},{"name":"Delete","id":"d4a62869-ba79-4b40-bfcc-82cdd0e6600a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/pickups/{{last_pickup_id}}","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no

{\n    \"transactionid\": 35363332\n}\n

","urlObject":{"path":["v1","pickups","{{last_pickup_id}}"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d4a62869-ba79-4b40-bfcc-82cdd0e6600a"}],"id":"53ecd354-4d99-4178-97b7-7651e0e9ce6d","_postman_id":"53ecd354-4d99-4178-97b7-7651e0e9ce6d","description":""},{"name":"Manifest","item":[{"name":"Manifest","id":"42df71c9-ee1d-4b7c-b844-94b52a2e4413","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/manifest?training=0&start=2021-06-01T15:03:00-07&end=2021-06-03T15:05:59-07&page=1","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
training	bool	no
start	datetime ISO8601	no
end	datetime ISO8601	no
page	int	no

Response Example

[\n    {\n        \"completion_date\": null,\n        \"created_on\": \"2021-06-03 16:04:23.562223-06\",\n        \"deleted\": 0,\n        \"first_stop_time\": 1624478400,\n        \"fulfilled\": 0,\n        \"id\": 145850,\n        \"is_accepted\": 0,\n        \"is_parked\": 0,\n        \"location\": 788,\n        \"manifest_fully_completed\": 1,\n        \"manifest_type\": 4,\n        \"manifestid\": \"5704461908899249\",\n        \"orgid\": 1842,\n        \"origination_city\": \"Anytown\",\n        \"origination_license_number\": \"12121212\",\n        \"origination_name\": \"JoeLeonardo\",\n        \"origination_phone\": \"30385494953\",\n        \"origination_state\": \"NM\",\n        \"origination_street\": \"123 Any Street\",\n        \"origination_zip\": \"01234\",\n        \"received\": 0,\n        \"sessiontime\": 1622757862,\n        \"stopcount\": 1,\n        \"stopcount_original\": 1,\n        \"stops\": [\n            {\n                \"arrive_time\": \"1624478400\",\n                \"city\": \"Anytown\",\n                \"deleted\": 0,\n                \"depart_time\": \"1624388400\",\n                \"id\": 146539,\n                \"item_count\": 1,\n                \"item_count_original\": 1,\n                \"items\": [\n                    [\n                        {\n                            \"deleted\": 0,\n                            \"description\": \"AAA\",\n                            \"id\": 1194107,\n                            \"inventoryid\": \"4128252287923983\",\n                            \"location\": 788,\n                            \"manifestid\": \"5704461908899249\",\n                            \"orgid\": 1842,\n                            \"quantity\": \"1\",\n                            \"quantity_received\": \"0\",\n                            \"requiresweighing\": 1,\n                            \"sessiontime\": 1622757862,\n                            \"stopnumber\": 1,\n                            \"stopnumber_original\": 1,\n                            \"transactionid\": 35363412,\n                            \"transactionid_original\": 35363412\n                        }\n                    ]\n                ],\n                \"license_number\": null,\n                \"location\": 788,\n                \"manifestid\": \"5704461908899249\",\n                \"name\": \"Tiffanyann Gurule\",\n                \"orgid\": 1842,\n                \"parked_ts\": null,\n                \"phone\": \"(505) 364-9647\",\n                \"resumed_directions\": null,\n                \"resumed_est_arrival_ts\": null,\n                \"resumed_est_departure_ts\": null,\n                \"resumed_ts\": null,\n                \"sessiontime\": 1622757862,\n                \"state\": \"NM\",\n                \"stopnumber\": 1,\n                \"stopnumber_original\": 1,\n                \"transactionid\": 35363412,\n                \"transactionid_original\": 35363412,\n                \"transporter_parked\": null,\n                \"transporter_resumed\": null,\n                \"travel_route\": null,\n                \"zip\": \"01234\"\n            }\n        ],\n        \"third_party_license_name\": null,\n        \"third_party_license_number\": \"TRNSP1\",\n        \"total_item_count\": 1,\n        \"total_item_count_original\": 1,\n        \"transactionid\": 35363412,\n        \"transactionid_original\": 35363412,\n        \"transporter_dob\": null,\n        \"transporter_dob_2\": null,\n        \"transporter_name\": null,\n        \"transporter_name_2\": null,\n        \"transporter_vehicle_details\": null,\n        \"transporter_vehicle_identification\": null,\n        \"updated_on\": \"2021-06-03 16:04:23.562223-06\"\n    }\n]\n

","urlObject":{"path":["v1","manifest"],"host":["{{localaddress}}"],"query":[{"key":"training","value":"0"},{"key":"start","value":"2021-06-01T15:03:00-07"},{"key":"end","value":"2021-06-03T15:05:59-07"},{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"42df71c9-ee1d-4b7c-b844-94b52a2e4413"},{"name":"Start","id":"63541673-96dc-4b52-814c-6f25e3d8b71c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/manifest/{{last_manifest_id}}/start","description":"

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no

Response Example

{\n    \"transactionid\": 35363303\n}\n

","urlObject":{"path":["v1","manifest","{{last_manifest_id}}","start"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"63541673-96dc-4b52-814c-6f25e3d8b71c"},{"name":"Start Undo","id":"b339ce33-5151-4b36-9ad1-ba2bb99ce1ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/manifest/{{last_manifest_id}}/start/undo","description":"

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no

Response Example

{\n    \"transactionid\": 35363303\n}\n

","urlObject":{"path":["v1","manifest","{{last_manifest_id}}","start","undo"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b339ce33-5151-4b36-9ad1-ba2bb99ce1ac"},{"name":"Manifest - Delivery","event":[{"listen":"test","script":{"id":"5dca8e79-4473-4213-9114-8666ade7ebb5","exec":["var manifest_id = pm.response.json()[\"manifestid\"];\r","pm.environment.set(\"last_manifest_id\", manifest_id);"],"type":"text/javascript"}}],"id":"312d9412-3ea4-4159-a6d4-4469c5aee3ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text","description":"

3b3bd0e9fbc337a79d3bbeb8d07cc9b6377b8bea7aa8d38a592fa6546d5f989a873dab7cf16c7b70e166787b8fb2b0b11b6360353ea6884a1cdadd5035ba4487

\n"}],"body":{"mode":"raw","raw":"{\r\n \"location\": \"21\",\r\n \"training\": 0,\r\n \"stops\": [\r\n {\r\n \"travel_route\":\"Head south on Main St NW toward Rio Grande Blvd NW. Turn right onto Rio Grande Blvd NW. Turn right onto Dora Ave NW. Turn right onto Panmunjon Rd NW. Turn right onto Mountain Rd NW. Turn left before Little Anita\\'s New Mexican Food. Turn right to merge onto I-40 E. Take exit 165 for Eubank Blvd. Turn right onto Eubank Blvd NE. Slight right onto G Ave SE. Turn left onto 20th St SE. 20th St SE turns slightly right and becomes Hardin Dr SE. Turn left onto 9th St. 9th St turns left and becomes St\",\r\n \"stopnumber\": 1,\r\n \"delivery_id\": 218,\r\n \"depart_time\": \"2022-03-10T13:17:56-0500\",\r\n \"arrive_time\": \"2022-03-10T13:47:56-0500\"\r\n }\r\n ],\r\n \"transporter_vehicle_id\": 860,\r\n \"transporter_id\": \"19\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/manifest/delivery","description":"

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?
training	bool	no
location	int	yes
transporter_vehicle_id	int	yes
transporter_id	int	yes
stops	array	yes

Stops Array

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?
delivery_id	int	yes
stopnumber	int	yes
travel_route	text	yes
depart_time	datetime ISO8601	yes
arrive_time	datetime ISO8601	yes

Response Example

{\n    \"manifestid\": \"8659354550763966\",\n    \"stops\": [\n        {\n            \"delivery_id\": 77,\n            \"stop_number\": 1\n        }\n    ],\n    \"transactionid\": 35363407\n}\n

","urlObject":{"path":["v1","manifest","delivery"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"312d9412-3ea4-4159-a6d4-4469c5aee3ef"},{"name":"Manifest - Delivery - Third Party","id":"ec3442b3-38e6-48e7-a7c7-be9c132eeca4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"location\": 12121212,\r\n \"third_party_license_number\": \"TRNSP1\",\r\n \"stops\": [\r\n {\r\n \"delivery_id\": {{last_delivery_id}},\r\n \"stopnumber\": 1,\r\n \"depart_time\": \"2021-06-22T12:00:00-07\",\r\n \"arrive_time\": \"2021-06-23T13:00:00-07\" \r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/manifest/delivery/thirdparty","description":"

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?
training	bool	no
location	int	yes
third_party_license_number	text	yes
stops	array	yes

Stops Array

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?
delivery_id	int	yes
stopnumber	int	yes
depart_time	datetime ISO8601	yes
arrive_time	datetime ISO8601	yes

Response Example

{\n    \"manifestid\": \"5704461908899249\",\n    \"stops\": [\n        {\n            \"delivery_id\": 79,\n            \"stop_number\": 1\n        }\n    ],\n    \"transactionid\": 35363412\n}\n

","urlObject":{"path":["v1","manifest","delivery","thirdparty"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec3442b3-38e6-48e7-a7c7-be9c132eeca4"},{"name":"Manifest - Delivery - Reschedule","id":"29c9c953-76b8-4ec4-9e59-496958ca4b70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false,\r\n \"delivery_arrival_est\": \"2021-07-23T12:00:00-07\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/manifest/{{last_manifest_id}}/delivery/{{last_delivery_id}}/reschedule","description":"

Rescheduling a delivery will assign a new ID to the delivery. Ensure you update your local data with this new ID.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no
delivery_arrival_est	datetime ISO8601	yes

Response Example

{\n    \"delivery_id\": 78,\n    \"transactionid\": 35363408\n}\n

","urlObject":{"path":["v1","manifest","{{last_manifest_id}}","delivery","{{last_delivery_id}}","reschedule"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"29c9c953-76b8-4ec4-9e59-496958ca4b70"},{"name":"Void","id":"ebe11944-4995-4c61-8034-a9722ffce842","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"training\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{localaddress}}/v1/manifest/{{last_manifest_id}}/void","description":"

This request will void a manifest that is not started and place the deliveries associated to the manifest back in the pool of active deliveries.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required?	Note
training	bool	no

Response Example

{\n    \"transactionid\": 35363303\n}\n

","urlObject":{"path":["v1","manifest","{{last_manifest_id}}","void"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ebe11944-4995-4c61-8034-a9722ffce842"}],"id":"f98c4606-c2bc-4a6f-84a2-e65b7b724fce","_postman_id":"f98c4606-c2bc-4a6f-84a2-e65b7b724fce","description":""},{"name":"Employee","item":[{"name":"Get","id":"63a7a583-db8f-498d-90ba-6fb67076195b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"url":"{{localaddress}}/v1/employees","urlObject":{"path":["v1","employees"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"63a7a583-db8f-498d-90ba-6fb67076195b"}],"id":"7631f026-ae1d-45ac-b304-99e184d0964c","_postman_id":"7631f026-ae1d-45ac-b304-99e184d0964c","description":""},{"name":"Vehicle","item":[{"name":"Get","id":"efd21cf7-bf38-4ed9-96a1-1295d2511cdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{sessionid}}","type":"text"}],"url":"{{localaddress}}/v1/vehicles","urlObject":{"path":["v1","vehicles"],"host":["{{localaddress}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"efd21cf7-bf38-4ed9-96a1-1295d2511cdd"}],"id":"8ca9fdea-1ca1-44b7-8ea3-a1398d95a8eb","_postman_id":"8ca9fdea-1ca1-44b7-8ea3-a1398d95a8eb","description":""}]}