Edge API - Orders version v2

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

Edge API - Orders

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

Validate

get post

get

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

post

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

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

Query Parameters

  • type: required(string)

    purchasing system type

  • apikey: required(string)

    API Key

HTTP status code 200

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

HTTP status code 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

HTTP status code 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

HTTP status code 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

HTTP status code 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

post

Place an order.

Place an order.

Headers

  • Accept: (string)

    Any valid accept header for third party Vendor

Query Parameters

  • type: required(string)

    purchasing system type

  • apikey: required(string)

    API Key

HTTP status code 201

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

HTTP status code 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"
  }
}

HTTP status code 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

HTTP status code 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

HTTP status code 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 put

get

Get order line by id

put

Update order line

Get order line by id

URI Parameters

  • id: required(string)

    poLine number for orders

Query Parameters

  • type: required(string)

    purchasing system type

  • apikey: required(string)

    API Key

HTTP status code 200

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

HTTP status code 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"
  }
}

HTTP status code 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

HTTP status code 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

HTTP status code 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

Update order line

URI Parameters

  • id: required(string)

    poLine number for orders

Query Parameters

  • type: required(string)

    purchasing system type

  • apikey: required(string)

    API Key

HTTP status code 204

Success update

HTTP status code 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"
  }
}

HTTP status code 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

HTTP status code 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

HTTP status code 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

get

Health Check