https://github.com/folio-org/edge-orders
Edge API to interface with FOLIO for 3rd party purchasing systems for placing orders
Validate that the API Key provided can be used to place an order.
GET /orders/validate
purchasing system type
API Key
Success. The response body depends on the "type" query argument in the request (GOBI or other).
Bad Request.
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Access Denied.
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Request Timeout.
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Internal Server Error.
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Example:
Internal server error
Validate that the API Key provided can be used to place an order.
POST /orders/validate
purchasing system type
API Key
Success. The response body depends on the "type" query argument in the request (GOBI or other).
Bad Request
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Access Denied
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Request Timeout
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Internal Server Error
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Example:
Internal server error
Place an order.
POST /orders
Any valid accept header for third party Vendor
purchasing system type
API Key
Success. The response body depends on the "type" query argument in the request (GOBI or other).
Bad Request
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Access Denied
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Request Timeout
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Internal Server Error
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Example:
Internal server error
Get order line by id
GET /orders/order-lines/{id}
poLine number for orders
purchasing system type
API Key
Success. The response body depends on the "type" query argument in the request
Bad Request
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Access Denied
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Request Timeout
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Internal Server Error
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Example:
Internal server error
Update order line
PUT /orders/order-lines/{id}
poLine number for orders
purchasing system type
API Key
Success update
Bad Request
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Access Denied
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Request Timeout
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Internal Server Error
Media type: application/xml
Type: any
Example:
<?xml version='1.0' encoding='UTF-8'?>
<Response>
<Error>
<Code>API_KEY_INVALID</Code>
<Message>Invalid API Key: eyJzIjoiQ0ROMDdmRzRJbiIsInQiOiJkaWt1IiwidSI6ImRpa3UifQ==0000</Message>
</Error>
</Response>
Media type: application/json
Type: any
Example:
{
"Error": {
"Code": "BAD_REQUEST",
"Message": "Fix request"
}
}
Media type: text/plain
Type: any
Example:
Internal server error
Health Check
GET /admin/health