Table of Contents | ||||
---|---|---|---|---|
|
...
Before the Barcode API calls can be sent, the Barcode module must be activated.
Insert excerpt SQL API Calls SQL API Calls nopanel true
Write Call
Available Fields
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Results
...
Code Block |
---|
{
"message": "Barcode transaction added successfully."
} |
Warehouse Bulk Add
Notes
- transaction_type must be whs_bulk_add.
- When setting up the Barcode API in Admin, the Authentication Required box must be true. Barcode requires authentication to work.
Available Fields
...
Parameter
...
Required
...
Data Type
...
Notes
...
eqp_catalog
...
Yes
...
Integer
...
This represents both Units and Quantity. If the Equipment Catalog Has Units - it is Units - if it is marked as "not units" then it is recorded as Quantity in the application currently.
...
The reason why the Equipment is being added.
...
Notes
- It must be an active Equipment Catalog.
- Positive (none-zero) count, cannot be null.
- Status' that are allowed
- Unassigned
- Broken
- Lost
- Retired
- Any custom status for the EQP_STATUS in the List Values table.
- If the Status is not one of the valid List Values, the API will error.
- The Warehouse must be an active Warehouse.
- Asset Array
- Optional for Asset or Cabling Equipment (flags on Equipment Catalog).
- Should be ignored (not put in db) if a non-asset or non-cabling equipment is used.
- The number of entries in the asset array must exactly match the count when provided.
- If provided, the price must be a positive number or zero, If not provided, the value can be null.
- Any valid date, past, present, or future, is allowed.
Request Example
Call
Code Block | ||
---|---|---|
| ||
http://DOMAIN/api/API_KEY/barcode.OUTPUT |
Headers
...
Content-Type
...
application/json
...
PCR-AUTH-TOKEN
...
example: e036a785-4d7a-40ed-a04a-c8e339327f55
Body
...
whs_bulk_add
...
2020/11/06
...
Code Block | ||||
---|---|---|---|---|
| ||||
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
},
{
"key": "Cookie",
"value": "{{DebugCookie}}",
"type": "text"
},
{
"key": "PCR-AUTH-TOKEN",
"value": "YOUR-AUTH-TOKEN-VALUE-HERE",
"type": "text"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "transaction_type",
"value": "whs_bulk_add",
"type": "text"
},
{
"key": "recid",
"value": "53054",
"type": "text"
},
{
"key": "quantity",
"value": "1",
"type": "text"
},
{
"key": "units",
"value": "11",
"type": "text"
},
{
"key": "purchase_price",
"value": "$1.74",
"type": "text"
},
{
"key": "comments",
"value": "Johnny Test",
"type": "text"
}
{
"key": "received_date",
"value": "2020/11/06",
"type": "text"
},
{
"key": "location",
"value": "86201",
"type": "text"
},
{
"key": "eqp_catalog",
"value": "533",
"type": "text"
},
{
"key": "eqp_status",
"value": "94",
"type": "text"
},
{
"key": "assets[0][ASSET_TAG]",
"value": "assettag145",
"type": "text",
"disabled": true
},
{
"key": "assets[0][EQUIPMENT_ID]",
"value": "equipmentid145",
"type": "text",
"disabled": true
},
"key": "assets[0][SERIAL_NUM]",
"value": "serialnum145",
"type": "text",
"disabled": true
}
]
} |
Results
...
Code Block |
---|
{
"message": "Barcode transaction added successfully."
} |
Warehouse Bulk Transfer
Notes
- transaction_type must be whs_bulk_transfer.
- When setting up the Barcode API in Admin, the Authentication Required box must be true . Barcode requires authentication to work.
Available Fields
...
Parameter
...
Required
...
Data Type
...
Notes
...
eqp_catalog
...
Yes
...
Integer
...
Notes
- It must be an active Equipment Catalog.
- Positive (none-zero) count, cannot be null.
- Status' that are allowed
- Unassigned
- Broken
- Lost
- Retired
- Any custom status
- If the Status is not one of the valid List Values, the API will error.
- The Warehouse must be an active Warehouse.
- Equipment RecIDs array
- Required for Asset or Cabling Equipment (flags on Equipment Catalog).
- should be ignored (not put in db) if a non-asset or non-cabling equipment is used.
- The number of entries in the Equipment RecIDs array must exactly match the count when provided.
Request Example
Call
Code Block | ||
---|---|---|
| ||
http://DOMAIN/api/API_KEY/barcode.OUTPUT |
Headers
...
Content-Type
...
application/json
...
PCR-AUTH-TOKEN
...
example: e036a785-4d7a-40ed-a04a-c8e339327f55
Body
...
transaction_type
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Results
If the request is successful, then the response will return as:
Toggle cloak |
---|
Cloak | ||
---|---|---|
|
Warehouse Bulk Add
Notes
- transaction_type must be whs_bulk_add.
- When setting up the Barcode API in Admin, the Authentication Required box must be true. Barcode requires authentication to work.
Available Fields
Parameter | Required | Data Type | Options | Notes | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
eqp_catalog | Yes | Integer | RECID of the Equipment's Equipment Catalog. | |||||||||||||
eqp_status | Yes | Integer | Lists
| The RECID of the status of the Equipment. | ||||||||||||
eqp_condition | No | Integer | Lists
| The RECID of the condition of the Equipment. | ||||||||||||
received_date | No | Date | The date the Equipment was Received. Format "YYYY/MM/DD" | |||||||||||||
location | Yes | Integer | RECID of the Warehouse of the Equipment. Must be an active Warehouse. | |||||||||||||
quantity | Yes | Integer | This represents both Units and Quantity. If the Equipment Catalog Has Units - it is Units - if it is marked as "not units" then it is recorded as Quantity in the application currently. | |||||||||||||
purchase_price | No | Float | The purchase price of the Equipment must be greater than or equal to zero. | |||||||||||||
assets | No | Array | Only valid for Asset or Cabling Equipment, else ignored. If provided the number of entries must match the quantity. | |||||||||||||
comments | Yes | String | The reason why the Equipment is being added. | |||||||||||||
units | No* | Integer | Must be a positive number that is greater than 0. Conditionally Required: If the "Has Units" box is checked on the Equipment Catalog. |
Notes
- It must be an active Equipment Catalog.
- Positive (none-zero) count, cannot be null.
- Status' that are allowed
- Unassigned
- Broken
- Lost
- Retired
- Any custom status for the EQP_STATUS in the List Values table.
- If the Status is not one of the valid List Values, the API will error.
- The Warehouse must be an active Warehouse.
- Asset Array
- Optional for Asset or Cabling Equipment (flags on Equipment Catalog).
- Should be ignored (not put in db) if a non-asset or non-cabling equipment is used.
- The number of entries in the asset array must exactly match the count when provided.
- If provided, the price must be a positive number or zero, If not provided, the value can be null.
- Any valid date, past, present, or future, is allowed.
Request Example
Call
Code Block | ||
---|---|---|
| ||
http://DOMAIN/api/API_KEY/barcode.OUTPUT |
Headers
Key | Value |
---|---|
Content-Type | application/json |
PCR-AUTH-TOKEN | example: e036a785-4d7a-40ed-a04a-c8e339327f55 |
Body
Key | Value |
---|---|
transaction_type | whs_bulk_add |
eqp_catalog | 533 |
eqp_status | 94 |
location | 86201 |
quantity | 1 |
purchase_price | $1.74 |
comments | Johnny Test |
received_date | 2020/11/06 |
assets[0][ASSET_TAG] | assettag145 |
assets[0][SERIAL_NUM] | serialnum145 |
assets[0][EQUIPMENT_ID] | equipmentid145 |
units | 11 |
JSON Request:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Results
...
Code Block |
---|
{
"message": "Barcode transaction added successfully."
} |
Receive Purchase Order
Notes
- transaction_type must be po_receive.
- When setting up the Barcode API in Admin, the Authentication Required box must be true . Barcode requires authentication to work.
Available Fields
...
Parameter
...
Required
...
Data Type
...
Notes
...
Request Example
Call
Code Block | ||
---|---|---|
| ||
http://DOMAIN/api/API_KEY/barcode.OUTPUT |
Headers
...
Content-Type
...
application/json
...
PCR-AUTH-TOKEN
...
example: e036a785-4d7a-40ed-a04a-c8e339327f55
Body
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Results
If the request is successful, then the response will return as:
Toggle cloak |
---|
Cloak | ||
---|---|---|
|
Warehouse Bulk Transfer
Notes
- transaction_type must be whs_bulk_transfer.
- When setting up the Barcode API in Admin, the Authentication Required box must be true . Barcode requires authentication to work.
Available Fields
Parameter | Required | Data Type | Options | Notes |
---|---|---|---|---|
eqp_catalog | Yes | Integer | RECID of the Equipment's Equipment Catalog. | |
quantity | No | Integer | This represents both Units and Quantity. If the Equipment Catalog Has Units - it is Units - if it is marked as "not units" then it is recorded as Quantity in the application currently. | |
from_location | Yes | Integer | Location RECID of the Warehouse of the Equipment is from. | |
to_location | Yes | Integer | Location RECID of the Warehouse of the Equipment is going to. | |
recids | No* | Array | Conditionally Required if the Equipment is an Asset. An array of Asset Tags, Serial Numbers and/or Equipment IDs (id # on the equipment record). See the Notes section below. | |
comments | Yes | String | The reason why the Equipment is being transferred. |
Notes
- It must be an active Equipment Catalog.
- Positive (none-zero) count, cannot be null.
- Status' that are allowed
- Unassigned
- Broken
- Lost
- Retired
- Any custom status
- If the Status is not one of the valid List Values, the API will error.
- The Warehouse must be an active Warehouse.
- Equipment RecIDs array
- Required for Asset or Cabling Equipment (flags on Equipment Catalog).
- should be ignored (not put in db) if a non-asset or non-cabling equipment is used.
- The number of entries in the Equipment RecIDs array must exactly match the count when provided.
Request Example
Call
Code Block | ||
---|---|---|
| ||
http://DOMAIN/api/API_KEY/barcode.OUTPUT |
Headers
Key | Value |
---|---|
Content-Type | application/json |
PCR-AUTH-TOKEN | example: e036a785-4d7a-40ed-a04a-c8e339327f55 |
Body
Key | Value |
---|---|
transaction_type | whs_bulk_transfer |
eqp_catalog | 533 |
quantity | 23 |
from_location | 86201 |
to_location | 86200 |
comments | Johnny Test |
JSON Request:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Results
If the request is successful, then the response will return as:
Toggle cloak |
---|
Cloak | ||
---|---|---|
|
Results
...
Code Block |
---|
{
"message": "Barcode transaction added successfully."
} |
Warehouse Physical Inventory
Notes
- transaction_type must be whs_physical_inventory.
- When setting up the Barcode API in Admin, the Authentication Required box must be true . Barcode requires authentication to work.
Available Fields
...
Parameter
...
Required
...
Data Type
...
Notes
...
Request Example
Call
Code Block | ||
---|---|---|
| ||
http://DOMAIN/api/API_KEY/barcode.OUTPUT |
Headers
...
Content-Type
...
application/json
...
PCR-AUTH-TOKEN
...
example: e036a785-4d7a-40ed-a04a-c8e339327f55
Body
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Receive Purchase Order
Notes
- transaction_type must be po_receive.
- When setting up the Barcode API in Admin, the Authentication Required box must be true . Barcode requires authentication to work.
Available Fields
Parameter | Required | Data Type | Options | Notes |
---|---|---|---|---|
recid | Yes | Integer | Purchase Order RECID, Status must be Open | |
eqp_catalog | Yes | Integer | Equipment Catalog RECID | |
price | Yes | Float | Price of Equipment | |
units | No | Integer | Units of Equipment. Only valid for Has Units Equipment, else ignored. The value must match an entry on the Purchase Order Equipment, as PCR-360 uses this to detect which item is being received if there is more than one entry for the Equipment Catalog on the Purchase Order and their units are different. | |
quantity | Yes | Integer | Quantity to Receive | |
location | Yes | Integer | Valid Active Warehouse RECID to receive Equipment | |
received_date | No | Date | Received Date | |
assets | No | Array | Only valid for Asset or Cabling Equipment, else ignored. If provided the number of entries must match the quantity. |
Request Example
Call
Code Block | ||
---|---|---|
| ||
http://DOMAIN/api/API_KEY/barcode.OUTPUT |
Headers
Key | Value |
---|---|
Content-Type | application/json |
PCR-AUTH-TOKEN | example: e036a785-4d7a-40ed-a04a-c8e339327f55 |
Body
Key | Value |
---|---|
recid | 12874 |
eqp_catalog | 346 |
price | 9.99 |
quantity | 4 |
location | 694 |
JSON Request:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Results
If the request is successful, then the response will return as:
Toggle cloak |
---|
Cloak | ||
---|---|---|
|
Warehouse Physical Inventory
Notes
- transaction_type must be whs_physical_inventory.
- When setting up the Barcode API in Admin, the Authentication Required box must be true . Barcode requires authentication to work.
Available Fields
Parameter | Required | Data Type | Options | Notes |
---|---|---|---|---|
scan_date | No | Date | Expected format: YYYY/MM/DD | |
eqp_catalog | Yes | Integer | Equipment Catalog RECID | |
units | No | Integer | Units of Equipment, Note: that this will default to 1 for units catalogs. It is ignored for non-unit catalogs | |
quantity | Yes | Integer | Quantity to Receive | |
location | Yes | Integer | Valid Active Warehouse RECID to receive Equipment | |
assets | No | Array | Only valid for Asset or Cabling Equipment, else ignored. If provided the number of entries must match the quantity. |
Request Example
Call
Code Block | ||
---|---|---|
| ||
http://DOMAIN/api/API_KEY/barcode.OUTPUT |
Headers
Key | Value |
---|---|
Content-Type | application/json |
PCR-AUTH-TOKEN | example: e036a785-4d7a-40ed-a04a-c8e339327f55 |
Body
Key | Value |
---|---|
scan_date | 2000/01/01 |
eqp_catalog | 346 |
quantity | 1 |
location | 694 |
assets | bcasset1sd126 |
JSON Request:
Toggle cloak |
---|
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Results
If the request is successful, then the response will return as:
Toggle cloak |
---|
...