List Proposal Item Suppliers

curl --request GET \
  --url https://sandbox.api.portal.io/public/proposals/{ProposalId}/items/{ProposalItemId}/suppliers \
  --header 'Accept: <accept>' \
  --header 'X-MSS-API-APPID: <api-key>' \
  --header 'X-MSS-API-USERKEY: <api-key>' \
  --header 'X-MSS-CUSTOM-DATE: <api-key>' \
  --header 'X-MSS-SIGNATURE: <api-key>'

import requests

url = "https://sandbox.api.portal.io/public/proposals/{ProposalId}/items/{ProposalItemId}/suppliers"

headers = {
    "Accept": "<accept>",
    "X-MSS-API-APPID": "<api-key>",
    "X-MSS-API-USERKEY": "<api-key>",
    "X-MSS-CUSTOM-DATE": "<api-key>",
    "X-MSS-SIGNATURE": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    Accept: '<accept>',
    'X-MSS-API-APPID': '<api-key>',
    'X-MSS-API-USERKEY': '<api-key>',
    'X-MSS-CUSTOM-DATE': '<api-key>',
    'X-MSS-SIGNATURE': '<api-key>'
  }
};

fetch('https://sandbox.api.portal.io/public/proposals/{ProposalId}/items/{ProposalItemId}/suppliers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": 81376,
    "name": "Sonos Inc.",
    "cost": {
      "isPromo": false,
      "lastVerifiedDate": "2030-09-04T00:22:19Z",
      "unitOfMeasure": "Each",
      "discountPercentage": 21.42,
      "regularValue": 19.64,
      "isCustom": false,
      "futurePrice": {
        "value": 550.5,
        "effectiveDate": "2031-03-19T00:22:19Z",
        "lastModifiedDate": "2031-02-06T00:22:19Z",
        "isInUse": false
      },
      "value": 550.5,
      "lastModifiedDate": "2031-02-06T00:22:19Z",
      "modifiedBy": "Jane Smith",
      "currency": {
        "code": "USD",
        "symbol": "$"
      }
    },
    "isDefault": false,
    "sku": "SON-AMP-BLK",
    "isInStock": false,
    "isDiscontinued": false,
    "status": "Activated",
    "createdDate": "2030-08-21T00:22:19Z",
    "accountNumber": "104582"
  }
]

{
  "responseStatus": {
    "errorCode": "Unauthorized",
    "message": "Not Authorized. Ensure a valid session cookie or HMAC authentication headers are provided."
  }
}

{
  "responseStatus": {
    "errorCode": "PaymentRequired",
    "message": "The dealer's subscription is inactive or expired. An active subscription is required to use this endpoint."
  }
}

{
  "responseStatus": {
    "errorCode": "Forbidden",
    "message": "You do not have permission for this action."
  }
}

{
  "responseStatus": {
    "errorCode": "NotFound",
    "message": "Proposal or proposal item not found."
  }
}

GET

public

proposals

{ProposalId}

items

{ProposalItemId}

suppliers

List Proposal Item Suppliers

curl --request GET \
  --url https://sandbox.api.portal.io/public/proposals/{ProposalId}/items/{ProposalItemId}/suppliers \
  --header 'Accept: <accept>' \
  --header 'X-MSS-API-APPID: <api-key>' \
  --header 'X-MSS-API-USERKEY: <api-key>' \
  --header 'X-MSS-CUSTOM-DATE: <api-key>' \
  --header 'X-MSS-SIGNATURE: <api-key>'

import requests

url = "https://sandbox.api.portal.io/public/proposals/{ProposalId}/items/{ProposalItemId}/suppliers"

headers = {
    "Accept": "<accept>",
    "X-MSS-API-APPID": "<api-key>",
    "X-MSS-API-USERKEY": "<api-key>",
    "X-MSS-CUSTOM-DATE": "<api-key>",
    "X-MSS-SIGNATURE": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    Accept: '<accept>',
    'X-MSS-API-APPID': '<api-key>',
    'X-MSS-API-USERKEY': '<api-key>',
    'X-MSS-CUSTOM-DATE': '<api-key>',
    'X-MSS-SIGNATURE': '<api-key>'
  }
};

fetch('https://sandbox.api.portal.io/public/proposals/{ProposalId}/items/{ProposalItemId}/suppliers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": 81376,
    "name": "Sonos Inc.",
    "cost": {
      "isPromo": false,
      "lastVerifiedDate": "2030-09-04T00:22:19Z",
      "unitOfMeasure": "Each",
      "discountPercentage": 21.42,
      "regularValue": 19.64,
      "isCustom": false,
      "futurePrice": {
        "value": 550.5,
        "effectiveDate": "2031-03-19T00:22:19Z",
        "lastModifiedDate": "2031-02-06T00:22:19Z",
        "isInUse": false
      },
      "value": 550.5,
      "lastModifiedDate": "2031-02-06T00:22:19Z",
      "modifiedBy": "Jane Smith",
      "currency": {
        "code": "USD",
        "symbol": "$"
      }
    },
    "isDefault": false,
    "sku": "SON-AMP-BLK",
    "isInStock": false,
    "isDiscontinued": false,
    "status": "Activated",
    "createdDate": "2030-08-21T00:22:19Z",
    "accountNumber": "104582"
  }
]

{
  "responseStatus": {
    "errorCode": "Unauthorized",
    "message": "Not Authorized. Ensure a valid session cookie or HMAC authentication headers are provided."
  }
}

{
  "responseStatus": {
    "errorCode": "PaymentRequired",
    "message": "The dealer's subscription is inactive or expired. An active subscription is required to use this endpoint."
  }
}

{
  "responseStatus": {
    "errorCode": "Forbidden",
    "message": "You do not have permission for this action."
  }
}

{
  "responseStatus": {
    "errorCode": "NotFound",
    "message": "Proposal or proposal item not found."
  }
}

Lists every supplier the item’s catalog item can be bought from, with each supplier’s cost. Call it before set item supplier to get the id that endpoint needs. The entry with isDefault: true is the supplier the item currently uses — this is also how you confirm a supplier change, since the item itself only carries the supplier’s display name. For that entry, cost.value and cost.lastVerifiedDate carry the proposal item’s own values, including any cost written with update cost; for the others they are the supplier’s catalog values. When the item has no supplier assigned, no entry is marked default. This endpoint always returns costs, even when the cost field on the item itself comes back null for the same credentials. Labor, CustomItem, and Fee items have no catalog item behind them, so the list comes back empty rather than 404.

Authorizations

X-MSS-API-APPID

string

header

required

Portal application identifier used as part of HMAC-authenticated API requests.

X-MSS-API-USERKEY

string

header

required

Portal user API key used together with the HMAC signature headers.

X-MSS-CUSTOM-DATE

string

header

required

Timestamp header included in the signed request to prevent replay attacks.

X-MSS-SIGNATURE

string

header

required

HMAC-SHA256 signature for the request, calculated over the canonical string defined in the authentication docs.

Headers

enum<string>

required

Accept Header

Available options:

application/json

Path Parameters

ProposalId

integer<int32>

required

Unique ID of the proposal (not the proposal number).

ProposalItemId

integer<int32>

required

Unique ID of the proposal item to list available suppliers for. Must belong to the proposal.

Response

Success

integer<int32>

required

Identifier of the supplier

name

string

required

Supplier display name

isDefault

boolean

required

Whether the supplier is the default one

isInStock

boolean

required

Whether the supplier reports the item as in stock

isDiscontinued

boolean

required

Whether the item is marked discontinued for the supplier

createdDate

string<date-time>

required

UTC timestamp when this supplier information was created

cost

PublicCostModel · object

Supplier cost information used by public catalog responses.

Show child attributes

sku

string

SKU the supplier uses for the item

status

enum<string>

Available options:

None,

Pending,

RequireSecondAuthorization,

Activated,

BlockedBrand,

Blocked

accountNumber

string

Account number your company uses with the supplier

⌘I

Authentication

Proposals

Proposal Items

Change Orders

AI Builder

People

Catalog

Users

Webhooks

Zapier Triggers

List Proposal Item Suppliers

Authorizations

Headers

Path Parameters

Response