Edge API - Orders (v2)

https://github.com/folio-org/edge-orders

Table of contents

Edge API - Orders

Edge API to interface with FOLIO for 3rd party purchasing systems for placing orders

Validate

GET /orders/validate

Validate that the API Key provided can be used to place an order.

GET /orders/validate
Query Parameters
  • type: required (string)

    purchasing system type

  • apikey: required (string)

    API Key

Response 200

Success. The response body depends on the "type" query argument in the request (GOBI or other).

Response 400

Bad Request.

Body

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

Response 401

Access Denied.

Body

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

Response 408

Request Timeout.

Body

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

Response 500

Internal Server Error.

Body

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

POST /orders/validate

Validate that the API Key provided can be used to place an order.

POST /orders/validate
Query Parameters
  • type: required (string)

    purchasing system type

  • apikey: required (string)

    API Key

Response 200

Success. The response body depends on the "type" query argument in the request (GOBI or other).

Response 400

Bad Request

Body

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

Response 401

Access Denied

Body

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

Response 408

Request Timeout

Body

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

Response 500

Internal Server Error

Body

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 Order

POST /orders

Place an order.

POST /orders
Headers
  • Accept: (string)

    Any valid accept header for third party Vendor

Query Parameters
  • type: required (string)

    purchasing system type

  • apikey: required (string)

    API Key

Response 201

Success. The response body depends on the "type" query argument in the request (GOBI or other).

Response 400

Bad Request

Body

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"
  }
}

Response 401

Access Denied

Body

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

Response 408

Request Timeout

Body

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

Response 500

Internal Server Error

Body

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 /orders/order-lines/{id}

Get order line by id

GET /orders/order-lines/{id}
URI Parameters
  • id: required (string)

    poLine number for orders

Query Parameters
  • type: required (string)

    purchasing system type

  • apikey: required (string)

    API Key

Response 200

Success. The response body depends on the "type" query argument in the request

Response 400

Bad Request

Body

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"
  }
}

Response 401

Access Denied

Body

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

Response 408

Request Timeout

Body

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

Response 500

Internal Server Error

Body

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

PUT /orders/order-lines/{id}

Update order line

PUT /orders/order-lines/{id}
URI Parameters
  • id: required (string)

    poLine number for orders

Query Parameters
  • type: required (string)

    purchasing system type

  • apikey: required (string)

    API Key

Response 204

Success update

Response 400

Bad Request

Body

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"
  }
}

Response 401

Access Denied

Body

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

Response 408

Request Timeout

Body

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

Response 500

Internal Server Error

Body

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

Health Check

GET /admin/health

Response 200

Success

Body

Media type: text/plain

Type: any