HTTP status code 200

Success; Returns an ASO async status entity for the specified encoded async process ID.

When the process reaches a status of completed the response will also contain a resultUrl -- a pre-signed URL used to download the file.

Working With the Result URL (Pre-Signed URL)

The resultUrl that is returned in the response of a completed async process status is used to download the file. The resultUrl will expire when resultUrlExpiresInSeconds reaches 0. Once expired the value returned for resultUrlExpiresInSeconds will be -1.

Pre-Signed URL -- 200 OK

The file streams to the client.

Pre-Signed URL -- 403 Forbidden

If the pre-signed URL has expired, the pre-signed URL will return 403 Forbidden with the following entity-body response:

<Error>
  <Code>AccessDenied</Code>
  <Message>Request has expired</Message>
  <X-Amz-Expires>300</X-Amz-Expires>
  <Expires>2020-09-08T20:05:05Z</Expires>
  <ServerTime>2020-09-09T17:06:17Z</ServerTime>
  <RequestId>XXXXXXXXXXXXXXXX</RequestId>
  <HostId>
    1HRM4RGKorg/xr1zG3f4tE3RyYU23ElyCc9Ih5YwxYcilUcElHWFXtY9OoIeUYiaggboFvRze1k=
  </HostId>
</Error>

Body

Media type: application/vnd.sciquest.com.ees+json

Type: object

• status: required(one of processing, cancelled, failed, completed)

  Example:

  processing

• resultUrl: (string)

  URL used to download file once async process is in completed state. (Max length: 65k)

  NOTE: This field is only visible when status is completed

• resultUrlExpiresInSeconds: (integer)

  Number of seconds before resultUrl expires.

  NOTE: This field is only visible when status is completed

  Example:

  165

Examples:

{
  "status": "completed",
  "resultUrl": "https://s3.us-east-2.amazonaws.com/us-east-2.aso.qa.api.async-downloads/258_22534_50a0a503-a029-4316-894f-3a7fdcf07ab2?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210716T154359Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Credential=AKIA5HYMQXHER7KSSZTN%2F20210716%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=7cdbc913ef900e2eef7b5f6bed6a592d056e52d611053976a11e3175d92eb674",
  "resultUrlExpiresInSeconds": 289
}

{
  "status": "processing"
}

{
  "status": "failed"
}

{
  "status": "cancelled"
}

HTTP status code 400

Invalid encoded async process ID.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "INVALID_URL_PARAM": [
      {
        "asyncStatus": "MTYyNjQ3MTAxODQwNzoyMjg1MDoxOmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng=="
      }
    ]
  }
}

HTTP status code 403

Request expired; Invalid or unauthorized encoded async process ID.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "REQUEST_EXPIRED": [
      {
        "expiresSeconds": "1800",
        "elapsedSeconds": "1863"
      }
    ]
  }
}

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "msg": "Invalid or missing event-id"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 200

Success; Returns a single event attribute matching the specified attribute ID.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: object

• attributeId: (integer)

  Attribute ID.

  Example:

  1

• name: required(string)

  Attribute name. (Max length: 80)

  Example:

  Test Attribute

• description: (union of string or nil)

  Attribute description. (Max length: 65,535)

  Example:

  Test attribute

• attributeType: required(one of bid, item, supplier, supplier_contact, rate)

  Attribute type.

  Example:

  item

• type: required(one of string, memo, currency, integer, number, money, percent, date, time, date-time, yes-no, select-one)

  Attribute value-type.

  Type	Description
  string	String data.
  memo	Extended string data.
  currency	Three character currency code. E.g. 'USD'
  integer	Whole number.
  number	Floating point number.
  money	Floating point number; displayed in ASO with a currency symbol.
  percent	Multiplied by 100 when displayed in ASO.
  date	Day, month and year; represented by UNIX Epoch time in milliseconds.
  time	Hour, minute, second; represented by UNIX Epoch time in milliseconds.
  date-time	Complete timestamp; represented by UNIX Epoch time in milliseconds.
  yes-no	True/false flag.
  select-one	Values can only be chosen from a predefined list.

  Example:

  string

• apiField: (union of string or nil)

  Name of static API entity field to which this attribute maps. For dynamic API entity fields this value would by null.

  Example:

  itemId

• isNormalized: required(boolean)

  Denotes whether an attribute is normalized; requires an attribute type of string or select-one.

  Example:

  true

• selectOneValues: (array of string)

  List of valid select-one values. Included only when type is select-one.

  Example:

  [
    "value 1",
    "value 2",
    "value 3",
    "another select-one value"
  ]

• normalizedValues: (array of string)

  List of normalized-string values. Included only when type is string and isNormalized is true.

  Example:

  [
    "value 1",
    "value 2",
    "value 3",
    "another normalized-string value"
  ]

• fractionalPrecision: (union of integer or nil)

  Number of decimal places for value.

  Example:

  2

• isRequired: required(boolean)

  Is attribute required.

  Example:

  false

• lowValue: (union of number or nil)

  Used for validating value's lower limit. Applied only to numeric types-- integer, number, money.

  Example:

  2.5

• highValue: (union of number or nil)

  Used for validating value's upper limit. Applied only to numeric types-- integer, number, money.

  Example:

  100

• visibleToBidder: required(boolean)

  Is attribute visible to bidder.

  Example:

  true

• visibleInManagement: required(boolean)

  Is attribute visible in management.

  Example:

  true

• namePlural: (union of string or nil)

  Plural form of attribute name. (Max length: 80)

  Example:

  Test Attributes

• nameMix: (union of string or nil)

  Mixed form of attribute name.

  Example:

  Test Attribute(s)

• isHistoric: required(boolean)

  Is historic attribute.

  Example:

  false

• isLocked: required(boolean)

  Is attribute locked.

  Example:

  false

Example:

{
  "attributeId": 1,
  "name": "Test Item Attr",
  "description": "Test item attr description.",
  "attributeType": "item",
  "type": "select-one",
  "apiField": null,
  "isNormalized": true,
  "selectOneValues": [
    "value 1",
    "value 2",
    "value 3",
    "another select-one value"
  ],
  "fractionalPrecision": 2,
  "isRequired": false,
  "lowValue": 1,
  "highValue": 100,
  "visibleToBidder": true,
  "visibleInManagement": true,
  "namePlural": "Test Item Attrs",
  "nameMix": "Test Item Attr(s)",
  "isHistoric": false,
  "isLocked": false
}

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID or Attribute ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "attributeId": "99"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 200

Success; A 200 Success response indicates that the request was processed and that the entity was successfully updated.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "SUCCESS": [
      {
        "attributeId": "1"
      }
    ]
  }
}

HTTP status code 400

Badly formed or missing entity-body in request.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "NULL_PAYLOAD": [
      {
        "payload": null
      }
    ]
  }
}

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID or Attribute ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "attributeId": "99"
      }
    ]
  }
}

HTTP status code 409

A 409 Conflict response indicates that there was a problem updating the entity. The reasons for the failure will be detailed in the response and are defined in the table below.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "ID_MISMATCH": [
      {
        "pathParamId": "1",
        "entityBodyId": "2"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 204

Success; No content is returned.

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID or Attribute ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "attributeId": "99"
      }
    ]
  }
}

HTTP status code 409

A 409 Conflict response indicates that there was a problem deleting the entity. The reasons for the failure will be detailed in the response and are defined in the table below.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "UNABLE_TO_DELETE_ENTITY": [
      {
        "attributeId": "1",
        "reason": "ATTRIBUTE_IS_PURPOSED"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 200

Success; Returns zero or more event attributes.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: array of object

Items: ApiAttribute

Example:

[
  {
    "attributeId": 1,
    "name": "Test Item Attr",
    "description": "Test item attr description.",
    "attributeType": "item",
    "type": "select-one",
    "apiField": null,
    "isNormalized": true,
    "selectOneValues": [
      "value 1",
      "value 2",
      "value 3",
      "another select-one value"
    ],
    "fractionalPrecision": 2,
    "isRequired": false,
    "lowValue": 1,
    "highValue": 100,
    "visibleToBidder": true,
    "visibleInManagement": true,
    "namePlural": "Test Item Attrs",
    "nameMix": "Test Item Attr(s)",
    "isHistoric": false,
    "isLocked": false
  },
  {
    "attributeId": 2,
    "name": "Test Item Attr 2",
    "description": "Test item attr description 2.",
    "attributeType": "item",
    "type": "string",
    "apiField": null,
    "isNormalized": false,
    "fractionalPrecision": null,
    "isRequired": false,
    "lowValue": null,
    "highValue": null,
    "visibleToBidder": true,
    "visibleInManagement": true,
    "namePlural": "Test Item Attr 2's",
    "nameMix": "Test Item Attr 2(s)",
    "isHistoric": false,
    "isLocked": false
  }
]

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 207

Multi-Status; A 207 Multi-Status response indicates that the request was processed and that the response should be parsed to determine the status of each Attribute contained within the entity-body. An Attribute will have been created successfully or failed to create for any number of error conditions which will be detailed in the response and are defined in the table below.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "SUCCESS": [
      {
        "attributeId": "1",
        "attributeCode": "attr1"
      },
      {
        "attributeId": "2",
        "attributeCode": "attr2"
      }
    ]
  }
}

{
  "statuses": {
    "SUCCESS": [
      {
        "attributeId": "1",
        "attributeCode": "attr1"
      }
    ],
    "MISSING_REQUIRED_FIELD": [
      {
        "attributeCode": "attr3",
        "field": "isHistoric"
      },
      {
        "attributeCode": "attr3",
        "field": "isLocked"
      },
      {
        "attributeCode": "attr3",
        "field": "name"
      }
    ],
    "MISSING_SELECT_ONE_VALUES": [
      {
        "attributeCode": "attr4",
        "field": "selectOneValues"
      }
    ],
    "INVALID_ENUM_VALUE": [
      {
        "attributeCode": "attr2",
        "field": "type",
        "value": "select-none"
      }
    ]
  }
}

HTTP status code 400

Badly formed or missing entity-body in request.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "NULL_PAYLOAD": [
      {
        "payload": null
      }
    ]
  }
}

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 207

Multi-Status; A 207 Multi-Status response indicates that the request was processed and that the response should be parsed to determine the status of each Attribute contained within the entity-body. An Attribute will have been updated successfully or failed to update for any number of error conditions which will be detailed in the response and are defined in the table below.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "SUCCESS": [
      {
        "attributeId": "1"
      },
      {
        "attributeId": "2"
      }
    ]
  }
}

{
  "statuses": {
    "CANNOT_UPDATE_READONLY_FIELD": [
      {
        "attributeId": "39",
        "field": "fractionalPrecision",
        "readonlyValue": "2"
      },
      {
        "attributeId": "39",
        "field": "type",
        "readonlyValue": "select-one"
      }
    ],
    "UNABLE_TO_UPDATE_ENTITY": [
      {
        "attributeId": "4",
        "reason": "ATTRIBUTE_IS_PURPOSED"
      }
    ]
  }
}

HTTP status code 400

Badly formed or missing entity-body in request.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "NULL_PAYLOAD": [
      {
        "payload": null
      }
    ]
  }
}

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 200

Success; Returns zero or more event attributes of the specified attribute type.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: array of object

Items: ApiAttribute

Example:

[
  {
    "attributeId": 1,
    "name": "Test Item Attr",
    "description": "Test item attr description.",
    "attributeType": "item",
    "type": "select-one",
    "apiField": null,
    "isNormalized": true,
    "selectOneValues": [
      "value 1",
      "value 2",
      "value 3",
      "another select-one value"
    ],
    "fractionalPrecision": 2,
    "isRequired": false,
    "lowValue": 1,
    "highValue": 100,
    "visibleToBidder": true,
    "visibleInManagement": true,
    "namePlural": "Test Item Attrs",
    "nameMix": "Test Item Attr(s)",
    "isHistoric": false,
    "isLocked": false
  },
  {
    "attributeId": 2,
    "name": "Test Item Attr 2",
    "description": "Test item attr description 2.",
    "attributeType": "item",
    "type": "string",
    "apiField": null,
    "isNormalized": false,
    "fractionalPrecision": null,
    "isRequired": false,
    "lowValue": null,
    "highValue": null,
    "visibleToBidder": true,
    "visibleInManagement": true,
    "namePlural": "Test Item Attr 2's",
    "nameMix": "Test Item Attr 2(s)",
    "isHistoric": false,
    "isLocked": false
  }
]

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID cannot not found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "attributeType": "itemss"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 202

Success; Returns a URL to poll the asynchronous process status and retrieve file.

Working With Status URL

The statusUrl that is returned in the response allows the client to both poll for the availability of the generated file, and once available, allows the client access to download the file. For complete details see GET Async Status.

The generated file will contain the requested ApiAwards model data in JSON format.

ApiAward Model:

Attribute Model:

ApiContact Model:

ApiAwards Data Example:

[
  {
    "allocationId":1,
    "scenarioId":2,
    "bid":{
      "bidId":1,
      "supplierId":2,
      "itemId":1,
      "bidRound":1,
      "bidRoundName":"Bid Round 1",
      "bidCurrency":"USD",
      "capacity":1,
      "alternate":0,
      "packageId":0,
      "valid":true,
      "approval":"not reviewed",
      "createdDate":1549996351000,
      "attributes":[
        {
          "id":"1",
          "name":"Item Price",
          "value":"12.10"
        }
      ]
    },
    "item":{
      "itemId":1,
      "itemCode":"1",
      "name":"Item 1",
      "description":"Item 1 description",
      "itemClassNameId":1,
      "avgHistoricPrice":1000,
      "quantity":100,
      "valid":true,
      "uomName":"unit",
      "itemCurrency":"USD",
      "attributes":[
        {
          "id":"1",
          "name":"Reserve Price",
          "value":"10000.00"
        }
      ]
    },
    "supplier":{
      "supplierId":2,
      "supplierCode":"scode3333",
      "name":"Test Supplier",
      "description":"Test supplier description.",
      "street1":"100 Washington Rd.",
      "street2":"Building 1",
      "city":"Pittsburgh",
      "state":"PA",
      "postalCode":"15212",
      "countryCode":"US",
      "valid":true,
      "attributes":[
        {
          "id":"1",
          "name":"Test Supplier Attr",
          "value":"10.00"
        }
      ],
      "contacts":null
    },
    "packageId":0,
    "bidRound":1,
    "quantity":50,
    "basePrice":2200,
    "scenarioPrice":2203.5,
    "discount":0,
    "price":2203.5,
    "historicPrice":2274.94,
    "isTailored":false,
    "isAssignedAward":false
  },
  {
    "allocationId":2,
    "scenarioId":2,
    "bid":{
      "bidId":2,
      "supplierId":3,
      "itemId":2,
      "bidRound":1,
      "bidRoundName":"Bid Round 1",
      "bidCurrency":"USD",
      "capacity":1,
      "alternate":0,
      "packageId":0,
      "valid":true,
      "approval":"not reviewed",
      "createdDate":1549996351000,
      "attributes":[
        {
          "id":"1",
          "name":"Item Price",
          "value":"94.50"
        }
      ]
    },
    "item":{
      "itemId":2,
      "itemCode":"2",
      "name":"Item 2",
      "description":"Item 2 description",
      "itemClassNameId":1,
      "avgHistoricPrice":2000,
      "quantity":10,
      "valid":true,
      "uomName":"unit",
      "itemCurrency":"USD",
      "attributes":[
        {
          "id":"1",
          "name":"Reserve Price",
          "value":"1000.00"
        }
      ]
    },
    "supplier":{
      "supplierId":3,
      "supplierCode":"scode3333",
      "name":"Test Supplier",
      "description":"Test supplier description.",
      "street1":"100 Liberty Ave.",
      "street2":"Building 2",
      "city":"Pittsburgh",
      "state":"PA",
      "postalCode":"15212",
      "countryCode":"US",
      "valid":true,
      "attributes":[
        {
          "id":"1",
          "name":"Test Supplier Attr",
          "value":"1000"
        }
      ],
      "contacts":null
    },
    "packageId":0,
    "bidRound":1,
    "quantity":35,
    "basePrice":1200,
    "scenarioPrice":3403.5,
    "discount":0,
    "price":3400.5,
    "historicPrice":3374.94,
    "isTailored":false,
    "isAssignedAward":false
  }
]

Body

Media type: application/vnd.sciquest.com.ees+json

Type: object

• statusUrl: required(string)

  Status URL that can be used to check the status of an asynchronous process and if the process has completed download the resulting file.

  Example:

  https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==

• statusUrlExpiresInSeconds: required(integer)

  Time in seconds before URL expires.

  Example:

  1800

Example:

{
  "statusUrl": "https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==",
  "statusUrlExpiresInSeconds": 1800
}

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID cannot be found or preferred scenario does not currently exist in the event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "reason": "MISSING_PREFERRED_SCENARIO"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 202

Success; Returns a URL to poll the asynchronous process status and retrieve file.

Working With Status URL

The status that is returned in the response allows the client to both poll for the availability of the generated file, and once available, allows the client access to download the file. For complete details see GET Async Status.

The generated file will contain the requested ApiAwards model data in JSON format.

ApiAward Model:

Attribute Model:

ApiContact Model:

ApiAwards Data Example:

[
  {
    "allocationId":1,
    "scenarioId":2,
    "bid":{
      "bidId":1,
      "supplierId":2,
      "itemId":1,
      "bidRound":1,
      "bidRoundName":"Bid Round 1",
      "bidCurrency":"USD",
      "capacity":1,
      "alternate":0,
      "packageId":0,
      "valid":true,
      "approval":"not reviewed",
      "createdDate":1549996351000,
      "attributes":[
        {
          "id":"1",
          "name":"Item Price",
          "value":"12.10"
        }
      ]
    },
    "item":{
      "itemId":1,
      "itemCode":"1",
      "name":"Item 1",
      "description":"Item 1 description",
      "itemClassNameId":1,
      "avgHistoricPrice":1000,
      "quantity":100,
      "valid":true,
      "uomName":"unit",
      "itemCurrency":"USD",
      "attributes":[
        {
          "id":"1",
          "name":"Reserve Price",
          "value":"10000.00"
        }
      ]
    },
    "supplier":{
      "supplierId":2,
      "supplierCode":"scode3333",
      "name":"Test Supplier",
      "description":"Test supplier description.",
      "street1":"100 Washington Rd.",
      "street2":"Building 1",
      "city":"Pittsburgh",
      "state":"PA",
      "postalCode":"15212",
      "countryCode":"US",
      "valid":true,
      "attributes":[
        {
          "id":"1",
          "name":"Test Supplier Attr",
          "value":"10.00"
        }
      ],
      "contacts":null
    },
    "packageId":0,
    "bidRound":1,
    "quantity":50,
    "basePrice":2200,
    "scenarioPrice":2203.5,
    "discount":0,
    "price":2203.5,
    "historicPrice":2274.94,
    "isTailored":false,
    "isAssignedAward":false
  },
  {
    "allocationId":2,
    "scenarioId":2,
    "bid":{
      "bidId":2,
      "supplierId":3,
      "itemId":2,
      "bidRound":1,
      "bidRoundName":"Bid Round 1",
      "bidCurrency":"USD",
      "capacity":1,
      "alternate":0,
      "packageId":0,
      "valid":true,
      "approval":"not reviewed",
      "createdDate":1549996351000,
      "attributes":[
        {
          "id":"1",
          "name":"Item Price",
          "value":"94.50"
        }
      ]
    },
    "item":{
      "itemId":2,
      "itemCode":"2",
      "name":"Item 2",
      "description":"Item 2 description",
      "itemClassNameId":1,
      "avgHistoricPrice":2000,
      "quantity":10,
      "valid":true,
      "uomName":"unit",
      "itemCurrency":"USD",
      "attributes":[
        {
          "id":"1",
          "name":"Reserve Price",
          "value":"1000.00"
        }
      ]
    },
    "supplier":{
      "supplierId":3,
      "supplierCode":"scode3333",
      "name":"Test Supplier",
      "description":"Test supplier description.",
      "street1":"100 Liberty Ave.",
      "street2":"Building 2",
      "city":"Pittsburgh",
      "state":"PA",
      "postalCode":"15212",
      "countryCode":"US",
      "valid":true,
      "attributes":[
        {
          "id":"1",
          "name":"Test Supplier Attr",
          "value":"1000"
        }
      ],
      "contacts":null
    },
    "packageId":0,
    "bidRound":1,
    "quantity":35,
    "basePrice":1200,
    "scenarioPrice":3403.5,
    "discount":0,
    "price":3400.5,
    "historicPrice":3374.94,
    "isTailored":false,
    "isAssignedAward":false
  }
]

Body

Media type: application/vnd.sciquest.com.ees+json

Type: object

• statusUrl: required(string)

  Status URL that can be used to check the status of an asynchronous process and if the process has completed download the resulting file.

  Example:

  https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==

• statusUrlExpiresInSeconds: required(integer)

  Time in seconds before URL expires.

  Example:

  1800

Example:

{
  "statusUrl": "https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==",
  "statusUrlExpiresInSeconds": 1800
}

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID or Scenario ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "scenarioId": "99"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 202

Success; Returns a URL to poll the asynchronous process status and retrieve file.

Working With Status URL

The statusUrl that is returned in the response allows the client to both poll for the availability of the generated file, and once available, allows the client access to download the file. For complete details see GET Async Status.

The generated file will contain the requested ApiBids model data in JSON format.

ApiBid Model:

Attribute Model:

ApiBids Data Example:

[
  {
    "bidId": 101,
    "supplierId": 1,
    "itemId": 1,
    "bidRound": 1,
    "bidRoundName": "Round 1",
    "bidCurrency": "USD",
    "capacity": null,
    "alternate": 0,
    "packageId": 0,
    "valid": true,
    "approval": "not reviewed",
    "createdDate": 1565730063000,
    "lastModifiedDate":1683665883000,
    "lastModifiedUserId":155375,
    "attributes": [
      {
        "id": "17",
        "name": "Item Price",
        "value": "99.09"
      },
      {
        "id": "19",
        "name": "Test Bid Attr",
        "value": "Under"
      }
    ]
  },
  {
    "bidId": 102,
    "supplierId": 1,
    "itemId": 2,
    "bidRound": 1,
    "bidRoundName": "Round 1",
    "bidCurrency": "USD",
    "capacity": null,
    "alternate": 0,
    "packageId": 0,
    "valid": true,
    "approval": "not reviewed",
    "createdDate": 1565730063000,
    "lastModifiedDate":1683665883000,
    "lastModifiedUserId":155375,
    "attributes": [
      {
        "id": "17",
        "name": "Item Price",
        "value": "11.01"
      },
      {
        "id": "19",
        "name": "Test Bid Attr",
        "value": "Under"
      }
    ]
  }
]

Body

Media type: application/vnd.sciquest.com.ees+json

Type: object

• statusUrl: required(string)

  Status URL that can be used to check the status of an asynchronous process and if the process has completed download the resulting file.

  Example:

  https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==

• statusUrlExpiresInSeconds: required(integer)

  Time in seconds before URL expires.

  Example:

  1800

Example:

{
  "statusUrl": "https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==",
  "statusUrlExpiresInSeconds": 1800
}

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 202

Success; Returns a URL to poll the asynchronous process status and retrieve file.

Working With Status URL

The statusUrl that is returned in the response allows the client to both poll for the availability of the generated file, and once available, allows the client access to download the file. For complete details see GET Async Status.

The generated file will contain the requested ApiBids model data in JSON format.

ApiBid Model:

Attribute Model:

ApiBids Data Example:

[
  {
    "bidId": 101,
    "supplierId": 1,
    "itemId": 1,
    "bidRound": 1,
    "bidRoundName": "Round 1",
    "bidCurrency": "USD",
    "capacity": null,
    "alternate": 0,
    "packageId": 0,
    "valid": true,
    "approval": "not reviewed",
    "createdDate": 1565730063000,
    "lastModifiedDate":1683665883000,
    "lastModifiedUserId":155375,
    "attributes": [
      {
        "id": "17",
        "name": "Item Price",
        "value": "99.09"
      },
      {
        "id": "19",
        "name": "Test Bid Attr",
        "value": "Under"
      }
    ]
  },
  {
    "bidId": 102,
    "supplierId": 1,
    "itemId": 2,
    "bidRound": 1,
    "bidRoundName": "Round 1",
    "bidCurrency": "USD",
    "capacity": null,
    "alternate": 0,
    "packageId": 0,
    "valid": true,
    "approval": "not reviewed",
    "createdDate": 1565730063000,
    "lastModifiedDate":1683665883000,
    "lastModifiedUserId":155375,
    "attributes": [
      {
        "id": "17",
        "name": "Item Price",
        "value": "11.01"
      },
      {
        "id": "19",
        "name": "Test Bid Attr",
        "value": "Under"
      }
    ]
  }
]

Body

Media type: application/vnd.sciquest.com.ees+json

Type: object

• statusUrl: required(string)

  Status URL that can be used to check the status of an asynchronous process and if the process has completed download the resulting file.

  Example:

  https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==

• statusUrlExpiresInSeconds: required(integer)

  Time in seconds before URL expires.

  Example:

  1800

Example:

{
  "statusUrl": "https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==",
  "statusUrlExpiresInSeconds": 1800
}

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID or Bid Round cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "bidRound": "99"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 200

Success; Returns a single item matching the specified item ID.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: object

• itemId: required(integer)

  Item ID.

  Example:

  1

• itemCode: required(string)

  Item code. Unique identifier. (Max length: 255)

  Example:

  itemcode-1

• name: required(union of string or nil)

  Item name. (Max length: 65,535)

  Example:

  Test Item

• description: required(union of string or nil)

  Item description. (Max length: 65,535)

  Example:

  Test item description.

• itemClassNameId: required(union of integer or nil)

  Item-class name ID.

  Example:

  1

• avgHistoricPrice: (union of number or nil)

  Item average historic price.

  Example:

  100

• quantity: required(union of number or nil)

  Item quantity.

  Example:

  2

• valid: required(boolean)

  Is item valid.

  Example:

  true

• uomName: required(union of string or nil)

  UOM name (singular).

  Example:

  unit

• itemCurrency: required(union of string or nil)

  Currency code for this item. (Max length: 3)

  Example:

  USD

• attributes: (union of array or nil)

  List of attribute key, name, and values.

  Example:

  [
    {
      "id": "1",
      "name": "Test Item Attr",
      "value": "10.00"
    },
    {
      "id": "2",
      "name": "Test Item Attr 2",
      "value": "Below"
    }
  ]

Example:

{
  "itemId": 1,
  "itemCode": "1",
  "name": "Item 1",
  "description": "Item 1 description",
  "itemClassNameId": 1,
  "avgHistoricPrice": 1000,
  "quantity": 100,
  "valid": true,
  "uomName": "unit",
  "itemCurrency": "USD",
  "attributes": [
    {
      "id": "1",
      "name": "Reserve Price",
      "value": "10000.00"
    },
    {
      "id": "2",
      "name": "Bid Increment",
      "value": "1000.00"
    },
    {
      "id": "3",
      "name": "Bid Increment Policy Range",
      "value": "Below"
    }
  ]
}

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID or Item ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "itemId": "999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 202

Success; Returns a URL to poll the asynchronous process status and retrieve file.

Working With Status URL

The statusUrl that is returned in the response allows the client to both poll for the availability of the generated file, and once available, allows the client access to download the file. For complete details see GET Async Status.

The generated file will contain the requested ApiItems model data in JSON format.

ApiItem Model:

Attribute Model:

ApiItems Data Example:

[
  {
    "itemId": 101,
    "itemCode": "BPX101",
    "name": "10 Count Blister Pack Extra Strength",
    "description": null,
    "itemClassNameId": 1,
    "avgHistoricPrice": 800,
    "quantity": null,
    "valid": true,
    "uomName": null,
    "itemCurrency": true,
    "attributes": [
      {
          "id": "74",
          "name": "Unit",
          "value": "EA"
      }
    ]
  },
  {
    "itemId": 102,
    "itemCode": "BPR102",
    "name": "10 Count Blister Pack Reg Strength",
    "description": null,
    "itemClassNameId": 1,
    "avgHistoricPrice": null,
    "quantity": null,
    "valid": true,
    "uomName": null,
    "itemCurrency": true,
    "attributes": [
      {
          "id": "74",
          "name": "Unit",
          "value": "EA"
      }
    ]
  }
]

Body

Media type: application/vnd.sciquest.com.ees+json

Type: object

• statusUrl: required(string)

  Status URL that can be used to check the status of an asynchronous process and if the process has completed download the resulting file.

  Example:

  https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==

• statusUrlExpiresInSeconds: required(integer)

  Time in seconds before URL expires.

  Example:

  1800

Example:

{
  "statusUrl": "https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==",
  "statusUrlExpiresInSeconds": 1800
}

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 207

Success; A 207 Multi-Status response indicates that the request was processed and that the response should be parsed to determine the status of each Item contained within the entity-body. An Item will have been created successfully or failed to create for any number of error conditions which will be detailed in the response and are defined in the table below.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "SUCCESS": [
      {
        "itemId": "1",
        "itemCode": "I-code1"
      },
      {
        "itemId": "2",
        "itemCode": "I-code2"
      }
    ]
  }
}

{
  "statuses": {
    "ATTR_ERR_SELECT_ONE_NOT_FOUND": [
      {
        "itemCode": "I-code3",
        "id": "28",
        "value": "Under"
      }
    ],
    "ALREADY_EXISTS": [
      {
        "itemCode": "I-code2"
      }
    ],
    "ATTR_ERR_REQUIRED_MISSING": [
      {
        "itemCode": "I-code3",
        "id": "26"
      },
      {
        "itemCode": "I-code3",
        "id": "27"
      }
    ]
  }
}

HTTP status code 400

Badly formed request.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "NULL_PAYLOAD": [
      {
        "payload": null
      }
    ]
  }
}

{
  "statuses": {
    "INSUFFICIENT_PERMISSIONS": [
      {
        "userId": "999999"
      }
    ]
  }
}

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID or User ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "userId": "999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 200

Success; Returns the rate for the specified rate ID.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: object

• rate: required(object)

  Rate

  • rateId: required(integer)

    Rate ID.

    Example:

    1

  • supplierId: required(integer)

    Supplier ID.

    Example:

    1

  • itemId: required(integer)

    Item ID.

    Example:

    1

  • alternate: required(integer)

    Rate alternate.

    Example:

    0

  • rateCurrency: required(union of string or nil)

    Currency code for rate. (Max length: 3)

    Example:

    USD

  • createdDate: required(union of integer or nil)

    Rate creation date. 13-digit unix/epoch time.

    Example:

    1549996351000

  • contractId: required(string)

    Contract ID.

    Example:

    c123

  • contractName: required(string)

    Contract name.

    Example:

    Test Contract

  • rateEffectiveDate: required(union of integer or nil)

    Date rate takes effect. 13-digit unix/epoch time.

    Example:

    1549996351000

  • rateExpirationDate: required(union of integer or nil)

    Date rate expires. 13-digit unix/epoch time.

    Example:

    1549996351000

  • rateDesignation: required(union of string or nil)

    Identifies a rate's intended use. Allowed values are specific to each event.

    Example:

    Primary

  • lastModifiedDate: required(integer)

    Date when this rate was last modified. 13-digit unix/epoch time.

    Example:

    1549996351000

  • lastModifiedUserId: required(union of integer or nil)

    ASO user ID of user who last modified this rate.

    Example:

    1

  • attributes: (union of array or nil)

    List of attribute key, name, and values.

    Example:

    [
      {
        "id": "1",
        "name": "Test Rate Attr",
        "value": "10.00"
      },
      {
        "id": "2",
        "name": "Test Rate Attr 2",
        "value": "Below"
      }
    ]

  Example:

  {
    "rateId": 5,
    "supplierId": 6,
    "itemId": 4,
    "alternate": 0,
    "rateCurrency": "USD",
    "createdDate": 1683664445000,
    "contractId": "c630",
    "contractName": "Rate-C630",
    "rateEffectiveDate": 1663992000000,
    "rateExpirationDate": 1695528000000,
    "rateDesignation": "Primary",
    "lastModifiedDate": 1683665883000,
    "lastModifiedUserId": 155375,
    "attributes": [
      {
        "id": "17",
        "name": "Item Price",
        "value": "630.00"
      },
      {
        "id": "42",
        "name": "Origin Zip",
        "value": "Pittsburgh"
      },
      {
        "id": "43",
        "name": "Destination Zip",
        "value": "Finland"
      }
    ]
  }

• item: required(object)

  Item

  • itemId: required(integer)

    Item ID.

    Example:

    1

  • itemCode: required(string)

    Item code. Unique identifier. (Max length: 255)

    Example:

    itemcode-1

  • name: required(union of string or nil)

    Item name. (Max length: 65,535)

    Example:

    Test Item

  • description: required(union of string or nil)

    Item description. (Max length: 65,535)

    Example:

    Test item description.

  • itemClassNameId: required(union of integer or nil)

    Item-class name ID.

    Example:

    1

  • avgHistoricPrice: (union of number or nil)

    Item average historic price.

    Example:

    100

  • quantity: required(union of number or nil)

    Item quantity.

    Example:

    2

  • valid: required(boolean)

    Is item valid.

    Example:

    true

  • uomName: required(union of string or nil)

    UOM name (singular).

    Example:

    unit

  • itemCurrency: required(union of string or nil)

    Currency code for this item. (Max length: 3)

    Example:

    USD

  • attributes: (union of array or nil)

    List of attribute key, name, and values.

    Example:

    [
      {
        "id": "1",
        "name": "Test Item Attr",
        "value": "10.00"
      },
      {
        "id": "2",
        "name": "Test Item Attr 2",
        "value": "Below"
      }
    ]

  Example:

  {
    "itemId": 4,
    "itemCode": "3-300",
    "name": "MN/MO",
    "description": null,
    "itemClassNameId": null,
    "avgHistoricPrice": null,
    "quantity": 1379,
    "valid": true,
    "uomName": null,
    "itemCurrency": null,
    "attributes": [
      {
        "id": "40",
        "name": "Origin State",
        "value": "MN"
      },
      {
        "id": "41",
        "name": "Destination State",
        "value": "MO"
      },
      {
        "id": "44",
        "name": "Document",
        "value": null
      }
    ]
  }

• supplier: required(object)

  Supplier

  • supplierId: required(integer)

    Supplier ID.

    Example:

    1

  • supplierCode: required(string)

    Supplier code. Unique identifier. (Max length: 255)

    Example:

    suppcode-1

  • name: required(string)

    Supplier name. (Max length: 65,535)

    Example:

    Test Supplier

  • description: (union of string or nil)

    Supplier description. (Max length: 65,535)

    Example:

    Test supplier description.

  • street1: (union of string or nil)

    Supplier street1 address. (Max length: 250)

    Example:

    100 Washington Rd.

  • street2: (union of string or nil)

    Supplier street2 address. (Max length: 250)

    Example:

    Building 1

  • city: (union of string or nil)

    Supplier city. (Max length: 250)

    Example:

    Pittsburgh

  • state: (union of string or nil)

    Supplier state. (Max length: 2)

    Example:

    PA

  • postalCode: (union of string or nil)

    Supplier postal code. (Max length: 10)

    Example:

    15212

  • countryCode: (union of string or nil)

    Supplier country code. (Max length: 10)

    Example:

    US

  • valid: required(boolean)

    Is supplier valid.

    Example:

    true

  • contacts: (union of array or nil)

    List of supplier contacts.

    Example:

    [
      {
        "contactId": 1,
        "contactCode": "concode555",
        "email": "mnauman@jaggaer.com",
        "name": "Matthew Nauman",
        "firstName": "Matthew",
        "lastName": "Nauman",
        "isPrimary": true,
        "prefix": "Dr.",
        "suffix": "III",
        "jobTitle": "salesman",
        "phone": "412-555-1111",
        "mobile": "412-555-1111",
        "fax": "412-555-1111",
        "pager": "412-555-1111",
        "web": "www.jaggaer.com",
        "attributes": [
          {
            "id": "1",
            "name": "Test Contact Attribute",
            "value": "2"
          },
          {
            "id": "2",
            "name": "Another Contact Attr",
            "value": "some value"
          }
        ]
      },
      {
        "contactId": 2,
        "contactCode": "concode6",
        "email": "rnauman@jaggaer.com",
        "name": "Ronald Nauman",
        "firstName": "Ronald",
        "lastName": "Nauman",
        "isPrimary": false,
        "prefix": "Mr.",
        "suffix": "Jr.",
        "jobTitle": "Engineer",
        "phone": "412-555-1111",
        "mobile": "412-555-1111",
        "fax": "412-555-1111",
        "pager": "412-555-1111",
        "web": "www.jaggaer.com",
        "attributes": [
          {
            "id": "1",
            "name": "Test Contact Attribute",
            "value": "4"
          },
          {
            "id": "2",
            "name": "Another Contact Attr",
            "value": "some other value"
          }
        ]
      }
    ]

  • attributes: (union of array or nil)

    List of attribute key, name, and values.

    Example:

    [
      {
        "id": "1",
        "name": "Test Supplier Attr",
        "value": "10.00"
      },
      {
        "id": "2",
        "name": "Test Supplier Attr 2",
        "value": "Below"
      }
    ]

  Example:

  {
    "supplierId": 6,
    "supplierCode": "C01",
    "name": "Carrier 01",
    "description": "",
    "street1": null,
    "street2": null,
    "city": null,
    "state": null,
    "postalCode": null,
    "countryCode": null,
    "valid": true,
    "attributes": [],
    "contacts": null
  }

Example:

{
  "rate": {
    "rateId": 5,
    "supplierId": 6,
    "itemId": 4,
    "alternate": 0,
    "rateCurrency": "USD",
    "createdDate": 1683664445000,
    "contractId": "c630",
    "contractName": "Rate-C630",
    "rateEffectiveDate": 1663992000000,
    "rateExpirationDate": 1695528000000,
    "rateDesignation": "Primary",
    "lastModifiedDate": 1683665883000,
    "lastModifiedUserId": 155375,
    "attributes": [
      {
        "id": "17",
        "name": "Item Price",
        "value": "630.00"
      },
      {
        "id": "42",
        "name": "Origin Zip",
        "value": "Pittsburgh"
      },
      {
        "id": "43",
        "name": "Destination Zip",
        "value": "Finland"
      }
    ]
  },
  "item": {
    "itemId": 4,
    "itemCode": "3-300",
    "name": "MN/MO",
    "description": null,
    "itemClassNameId": null,
    "avgHistoricPrice": null,
    "quantity": 1379,
    "valid": true,
    "uomName": null,
    "itemCurrency": null,
    "attributes": [
      {
        "id": "40",
        "name": "Origin State",
        "value": "MN"
      },
      {
        "id": "41",
        "name": "Destination State",
        "value": "MO"
      },
      {
        "id": "44",
        "name": "Document",
        "value": null
      }
    ]
  },
  "supplier": {
    "supplierId": 6,
    "supplierCode": "C01",
    "name": "Carrier 01",
    "description": "",
    "street1": null,
    "street2": null,
    "city": null,
    "state": null,
    "postalCode": null,
    "countryCode": null,
    "valid": true,
    "attributes": [],
    "contacts": null
  }
}

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID or Attribute ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Examples:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "rateId": "999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 202

Success; Returns a URL to poll the asynchronous process status and retrieve file.

Working With Status URL

The statusUrl that is returned in the response allows the client to both poll for the availability of the generated file, and once available, allows the client access to download the file. For complete details see GET Async Status.

The generated file will contain the requested ApiRates model data in JSON format.

ApiRate Model:

Attribute Model:

ApiRates Data Example:

[
{
  "rate": {
    "rateId": 2,
    "supplierId": 6,
    "itemId": 1,
    "alternate": 0,
    "rateCurrency": "USD",
    "createdDate": 1683034761000,
    "contractId": "C100",
    "contractName": "C100",
    "rateEffectiveDate": 1672549200000,
    "rateExpirationDate": 1704085200000,
    "rateDesignation": "Primary",
    "lastModifiedDate": 1683035098000,
    "lastModifiedUserId": 155429,
    "attributes": [
      {
        "id": "17",
        "name": "Item Price",
        "value": "350.00"
      },
      {
        "id": "42",
        "name": "Origin Zip",
        "value": "300"
      },
      {
        "id": "43",
        "name": "Destination Zip",
        "value": "383"
      }
    ]
  },
  "item": {
    "itemId": 1,
    "itemCode": "1-100",
    "name": "GA/TN",
    "description": null,
    "itemClassNameId": null,
    "avgHistoricPrice": null,
    "quantity": 825,
    "valid": true,
    "uomName": null,
    "itemCurrency": null,
    "attributes": [
      {
        "id": "40",
        "name": "Origin State",
        "value": "GA"
      },
      {
        "id": "41",
        "name": "Destination State",
        "value": "TN"
      },
      {
        "id": "44",
        "name": "Document",
        "value": null
      }
    ]  
  },
  "supplier": {
    "supplierId": 6,
    "supplierCode": "C01",
    "name": "Carrier 01",
    "description": "",
    "street1": null,
    "street2": null,
    "city": null,
    "state": null,
    "postalCode": null,
    "countryCode": null,
    "valid": true,
    "attributes": [],
    "contacts": null
  }
},
{
  "rate": {
    "rateId": 3,
    "supplierId": 6,
    "itemId": 2,
    "alternate": 0,
    "rateCurrency": "USD",
    "createdDate": 1683035098000,
    "contractId": "C200",
    "contractName": "C200",
    "rateEffectiveDate": 1672549200000,
    "rateExpirationDate": 1672549200000,
    "rateDesignation": "Primary",
    "lastModifiedDate": 1683035098000,
    "lastModifiedUserId": 155429,
    "attributes": [
      {
        "id": "17",
        "name": "Item Price",
        "value": "550.00"
      },
      {
        "id": "42",
        "name": "Origin Zip",
        "value": "244"
      },
      {
        "id": "43",
        "name": "Destination Zip",
        "value": null
      }
    ]   
  },
  "item": {
    "itemId": 2,
    "itemCode": "2-200",
    "name": "VA/NC",
    "description": null,
    "itemClassNameId": null,
    "avgHistoricPrice": null,
    "quantity": 1191,
    "valid": true,
    "uomName": null,
    "itemCurrency": null,
    "attributes": [
      {
        "id": "40",
        "name": "Origin State",
        "value": "VA"
      },
      {
        "id": "41",
        "name": "Destination State",
        "value": "NC"
      },
      {
        "id": "44",
        "name": "Document",
        "value": null
      }
    ]
  },
  "supplier": {
    "supplierId": 6,
    "supplierCode": "C01",
    "name": "Carrier 01",
    "description": "",
    "street1": null,
    "street2": null,
    "city": null,
    "state": null,
    "postalCode": null,
    "countryCode": null,
    "valid": true,
    "attributes": [],
    "contacts": null
  }
}
]

Body

Media type: application/vnd.sciquest.com.ees+json

Type: object

• statusUrl: required(string)

  Status URL that can be used to check the status of an asynchronous process and if the process has completed download the resulting file.

  Example:

  https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==

• statusUrlExpiresInSeconds: required(integer)

  Time in seconds before URL expires.

  Example:

  1800

Example:

{
  "statusUrl": "https://ees.api.combinenet.com/asyncStatus/MTYyNjQ2MDY4ODQwNzoyMjg1MDo5OmIyMjI5NmQyLTA3ODYtNDUwZi1iNzg3LTFmYzQ4MjAwOTU4Ng==",
  "statusUrlExpiresInSeconds": 1800
}

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 200

Success; Returns all scenarios matching the specified event ID.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: array of object

Items: ApiScenario

Example:

[
  {
    "scenarioId": 1,
    "name": "Lowest Bid",
    "comments": "Award each item to the supplier with the lowest bid for that item",
    "status": "Reports Available",
    "locked": false,
    "awarded": false,
    "preferred": false,
    "tailored": false,
    "timeSubmitted": 1536245950000,
    "timeCompleted": 1536245970000
  },
  {
    "scenarioId": 2,
    "name": "Single Supplier",
    "comments": "Award all items to one supplier with the lowest total bid price across all items",
    "status": "Optimizing",
    "locked": false,
    "awarded": false,
    "preferred": false,
    "tailored": false,
    "timeSubmitted": 1536245950000,
    "timeCompleted": 1536245970000
  }
]

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 200

Success; Returns all suppliers matching the specified event ID.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: array of object

Items: ApiSupplier

Example:

[
  {
    "supplierId": 1,
    "supplierCode": "supp-code-1",
    "name": "Some Company",
    "description": "Description of a some company.",
    "street1": "2200 Liberty Ave.",
    "street2": "Building 2",
    "city": "Pittsburgh",
    "state": "PA",
    "postalCode": "15212",
    "countryCode": "US",
    "valid": true,
    "attributes": [
      {
        "id": "1",
        "name": "Test Supplier Attr1",
        "value": "10.00"
      },
      {
        "id": "2",
        "name": "Test Supplier Attr2",
        "value": "Below"
      }
    ],
    "contacts": [
      {
        "contactId": 1,
        "contactCode": "con-code-1",
        "email": "bsmith@cure.com",
        "name": "robert smith",
        "firstName": "robert",
        "lastName": "smith",
        "isPrimary": true,
        "prefix": "Mr.",
        "suffix": "III",
        "jobTitle": "Guitarist",
        "phone": "412-555-1111",
        "mobile": "412-555-1111",
        "fax": null,
        "pager": null,
        "web": "www.test.com",
        "attributes": [
          {
            "id": "1",
            "name": "Test Contact Attr1",
            "value": "Never"
          },
          {
            "id": "2",
            "name": "Test Contact Attr2",
            "value": "1000"
          }
        ]
      },
      {
        "contactId": 2,
        "contactCode": "concode2",
        "email": "mnauman@jaggaer.com",
        "name": "matthew nauman",
        "firstName": "matthew",
        "lastName": "nauman",
        "isPrimary": false,
        "prefix": null,
        "suffix": null,
        "jobTitle": "Technical Architect",
        "phone": "412-555-1111",
        "mobile": null,
        "fax": null,
        "pager": null,
        "web": "www.jaggaer.com",
        "attributes": [
          {
            "id": "1",
            "name": "Test Contact Attr1",
            "value": "Sometimes"
          },
          {
            "id": "2",
            "name": "Test Contact Attr2",
            "value": "3500"
          }
        ]
      }
    ]
  },
  {
    "supplierId": 2,
    "supplierCode": "supp-code-2",
    "name": "Another Company",
    "description": "Description of another company.",
    "street1": "218 Smithfield St.",
    "street2": null,
    "city": "Pittsburgh",
    "state": "PA",
    "postalCode": "15212",
    "countryCode": "US",
    "valid": true,
    "attributes": [
      {
        "id": "1",
        "name": "Test Supplier Attr1",
        "value": "1.50"
      },
      {
        "id": "2",
        "name": "Test Supplier Attr2",
        "value": "Above"
      }
    ],
    "contacts": null
  }
]

HTTP status code 403

Customer host does not have access to event.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "AUTHENTICATION_FORBIDDEN": [
      {
        "chost": "275"
      }
    ]
  }
}

HTTP status code 404

Event ID cannot be found.

Body

Media type: application/vnd.sciquest.com.ees+json

Type: json

Content:

{"statuses":{"STATUS_CODE":[{"statusKey":"statusValue"}]}}

Example:

{
  "statuses": {
    "ENTITY_NOT_FOUND": [
      {
        "eventId": "99999"
      }
    ]
  }
}

Secured by oauth_2_0

Headers

• Authorization: required(string)

  Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

• X-API-Key: required(string)

  API key.

HTTP status code 400

Invalid request; invalid client ID; invalid scope; unsupported grant type

HTTP status code 403

Invalid credentials.

Bearer access token not found.

Missing or invalid API key.

HTTP status code 207

Success; A 207 Multi-Status response indicates that the request was processed and that the response should be parsed to determine the status of each Supplier contained within the entity-body. A Supplier will have been created successfully or failed to create for any number of error conditions which will be detailed in the response and are defined in the table below.