DSSI Logo
API docs by Redocly

Provider Connect API (v1)

Download OpenAPI specification:

API for product search, quotes, orders, and shipping functionality with smart consolidation model.

Menu

/v1/menu/provider/{providerCode}/location/{locationCode}

Authorizations:
Bearer
path Parameters
providerCode
required
string
locationCode
required
string
header Parameters
X-User-Id
required
string

Unique identifier for the user (email or username)

Responses

Response samples

Content type
{
  • "totalCount": 0,
  • "menus": [
    ]
}

/v1/menu/{menuId}/location/{locationCode}/meal

Authorizations:
Bearer
path Parameters
menuId
required
integer <int32>
locationCode
required
string
query Parameters
day
integer <int32>
week
integer <int32>
header Parameters
X-User-Id
required
string

Unique identifier for the user (email or username)

Responses

Response samples

Content type
{
  • "meals": [
    ]
}

/v1/menu/location/provider/{providerCode}

Authorizations:
Bearer
path Parameters
providerCode
required
string
header Parameters
X-User-Id
required
string

Unique identifier for the user (email or username)

Responses

Response samples

Content type
{
  • "locations": [
    ]
}

Orders

/v1/quotes

Authorizations:
Bearer
header Parameters
X-User-Id
required
string

Unique identifier for the user (email or username)

Request Body schema:
locationCode
required
string non-empty

Location code for the order.

supplierCode
required
string non-empty

Identifier of the supplier.

Array of objects or null (QuoteRequestItem)

List of items for the quote.

shippingOption
string or null

Selected shipping option value.

shippingZipCode
string or null

Shipping zip code

Responses

Request samples

Content type
{
  • "locationCode": "string",
  • "supplierCode": "string",
  • "items": [
    ],
  • "shippingOption": "string",
  • "shippingZipCode": "string"
}

Response samples

Content type
{
  • "items": [
    ],
  • "subtotal": 0.1,
  • "estimatedShipping": 0.1,
  • "total": 0.1
}

/v1/orders

Authorizations:
Bearer
header Parameters
X-User-Id
required
string

Unique identifier for the user (email or username)

Request Body schema:
locationCode
required
string or null

Location code for the order.

supplierCode
required
string or null

Supplier code.

shippingOptionValue
string or null

Selected shipping option value for the supplier.

shippingName
string or null
Deprecated

Shipping name (deprecated, use shippingFirstName and shippingLastName instead).

shippingFirstName
string or null

Shipping first name

shippingLastName
string or null

Shipping last name

externalId
required
string or null

External identifier for the order, used for tracking.

required
object (Address)

Schema for an address.

orderNotes
string or null

General notes for the order.

required
Array of objects or null (OrderItemRequest)

List of items in the order.

Responses

Request samples

Content type
{
  • "locationCode": "string",
  • "supplierCode": "string",
  • "shippingOptionValue": "string",
  • "shippingName": "string",
  • "shippingFirstName": "string",
  • "shippingLastName": "string",
  • "externalId": "string",
  • "shipToAddress": {
    },
  • "orderNotes": "string",
  • "items": [
    ]
}

Response samples

Content type
{
  • "orderNumber": "string"
}

/v1/orders/{orderNumber}

Authorizations:
Bearer
path Parameters
orderNumber
required
string
header Parameters
X-User-Id
required
string

Unique identifier for the user (email or username)

Responses

Response samples

Content type
{
  • "orderNumber": "string",
  • "locationCode": "string",
  • "locationName": "string",
  • "supplierCode": "string",
  • "supplierName": "string",
  • "status": "string",
  • "purchaseOrderDate": "2019-08-24T14:15:22Z",
  • "subtotal": 0.1,
  • "shippingTotal": 0.1,
  • "tax": 0.1,
  • "total": 0.1,
  • "shipToAddress": {
    },
  • "items": [
    ],
  • "shipments": [
    ]
}

Products

/v1/products/search

Authorizations:
Bearer
header Parameters
X-User-Id
required
string

Unique identifier for the user (email or username)

Request Body schema:
locationCode
required
string [ 0 .. 10 ] characters
term
string or null
pageSize
integer <int32> [ 1 .. 100 ]
Default: 25
pageIndex
integer <int32> [ 0 .. 2147483647 ]
Default: 0
includeOffOrderGuide
boolean
Default: false
object (SearchFilters)

Responses

Request samples

Content type
{
  • "locationCode": "string",
  • "term": "string",
  • "pageSize": 25,
  • "pageIndex": 0,
  • "includeOffOrderGuide": false,
  • "filters": {
    }
}

Response samples

Content type
{
  • "products": [
    ],
  • "totalCount": 0,
  • "pageSize": 0,
  • "pageIndex": 0,
  • "onOrderGuideTotal": 0,
  • "offOrderGuideTotal": 0
}

Shipping

/v1/supplier/{supplierCode}

Authorizations:
Bearer
path Parameters
supplierCode
required
string
header Parameters
X-User-Id
required
string

Unique identifier for the user (email or username)

Responses

Response samples

Content type
{
  • "supplierCode": "string",
  • "supplierName": "string",
  • "shippingOptions": [
    ]
}