The Market Basket API lets you request and download Market Basket exports for your agency without using the Market Basket application. An export is a set of personal lines rate-quote data for one state, rate source, and line of business over a date range, delivered as a zip file of CSV files.
Exports are generated in the background. Creating an export returns its ID right away; the file is ready once its status is COMPLETE.
Request at least one of them when you register your app. Use api.marketBasket:read if your app only needs to read and download exports.
curl --request POST \
--url https://api.zywave.com/v3/quoting/personalLines/v1/org/{orgId}/agency/{agencyId}/marketBasket/exports \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data '{
"export_type": "MARKETBASKET",
"date_range": { "type": "CUSTOM", "start_date": "2026-10-06", "end_date": "2026-10-12" },
"rate_sources": ["TR"],
"export_rates_for": "CHOSEN_TIME_PERIOD",
"include_zero_premium": false,
"states": ["TX"],
"lob": ["AUTO"],
"file_format": "CSV",
"delivery_method": "DOWNLOAD",
"notify_email": false,
"frequency": "ONCE",
"export_date": "2026-10-13"
}'
Copy
{
"requestId": "edc72f6a-4904-4b14-b9e1-e2bfb452b9a4",
"requested_at": "2026-10-13T14:05:12Z",
"exports": [
{
"exportId": "c6ef488b-e12f-4d00-8d3b-979b91c06606",
"state": "TX",
"rate_source": "TR",
"lob": "AUTO",
"date_range": {
"start_date": "2026-10-06",
"end_date": "2026-10-12"
},
"export_date": "2026-10-13",
"status": "PENDING"
}
]
}Copy
using System.Net.Http;
using System.Net.Http.Headers;
HttpClient client = new HttpClient();
HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Post, "https://api.zywave.com/v3/quoting/personalLines/v1/org/{orgId}/agency/{agencyId}/marketBasket/exports");
request.Headers.Add("Authorization", "Bearer {access_token}");
request.Content = new StringContent("{\n \"export_type\": \"MARKETBASKET\",\n \"date_range\": { \"type\": \"CUSTOM\", \"start_date\": \"2026-10-06\", \"end_date\": \"2026-10-12\" },\n \"rate_sources\": [\"TR\"],\n \"export_rates_for\": \"CHOSEN_TIME_PERIOD\",\n \"include_zero_premium\": false,\n \"states\": [\"TX\"],\n \"lob\": [\"AUTO\"],\n \"file_format\": \"CSV\",\n \"delivery_method\": \"DOWNLOAD\",\n \"notify_email\": false,\n \"frequency\": \"ONCE\",\n \"export_date\": \"2026-10-13\"\n }");
request.Content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
HttpResponseMessage response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
string responseBody = await response.Content.ReadAsStringAsync();
Copy import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.zywave.com/v3/quoting/personalLines/v1/org/{orgId}/agency/{agencyId}/marketBasket/exports"))
.POST(BodyPublishers.ofString("{\n \"export_type\": \"MARKETBASKET\",\n \"date_range\": { \"type\": \"CUSTOM\", \"start_date\": \"2026-10-06\", \"end_date\": \"2026-10-12\" },\n \"rate_sources\": [\"TR\"],\n \"export_rates_for\": \"CHOSEN_TIME_PERIOD\",\n \"include_zero_premium\": false,\n \"states\": [\"TX\"],\n \"lob\": [\"AUTO\"],\n \"file_format\": \"CSV\",\n \"delivery_method\": \"DOWNLOAD\",\n \"notify_email\": false,\n \"frequency\": \"ONCE\",\n \"export_date\": \"2026-10-13\"\n }"))
.setHeader("Authorization", "Bearer {access_token}")
.setHeader("Content-Type", "application/json")
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Copy fetch('https://api.zywave.com/v3/quoting/personalLines/v1/org/{orgId}/agency/{agencyId}/marketBasket/exports', {
method: 'POST',
headers: {
'Authorization': 'Bearer {access_token}',
'Content-Type': 'application/json'
},
// body: '{\n "export_type": "MARKETBASKET",\n "date_range": { "type": "CUSTOM", "start_date": "2026-10-06", "end_date": "2026-10-12" },\n "rate_sources": ["TR"],\n "export_rates_for": "CHOSEN_TIME_PERIOD",\n "include_zero_premium": false,\n "states": ["TX"],\n "lob": ["AUTO"],\n "file_format": "CSV",\n "delivery_method": "DOWNLOAD",\n "notify_email": false,\n "frequency": "ONCE",\n "export_date": "2026-10-13"\n }',
body: JSON.stringify({
'export_type': 'MARKETBASKET',
'date_range': {
'type': 'CUSTOM',
'start_date': '2026-10-06',
'end_date': '2026-10-12'
},
'rate_sources': [
'TR'
],
'export_rates_for': 'CHOSEN_TIME_PERIOD',
'include_zero_premium': false,
'states': [
'TX'
],
'lob': [
'AUTO'
],
'file_format': 'CSV',
'delivery_method': 'DOWNLOAD',
'notify_email': false,
'frequency': 'ONCE',
'export_date': '2026-10-13'
})
});
Copy import requests
headers = {
'Authorization': 'Bearer {access_token}',
'Content-Type': 'application/json',
}
json_data = {
'export_type': 'MARKETBASKET',
'date_range': {
'type': 'CUSTOM',
'start_date': '2026-10-06',
'end_date': '2026-10-12',
},
'rate_sources': [
'TR',
],
'export_rates_for': 'CHOSEN_TIME_PERIOD',
'include_zero_premium': False,
'states': [
'TX',
],
'lob': [
'AUTO',
],
'file_format': 'CSV',
'delivery_method': 'DOWNLOAD',
'notify_email': False,
'frequency': 'ONCE',
'export_date': '2026-10-13',
}
response = requests.post(
'https://api.zywave.com/v3/quoting/personalLines/v1/org/{orgId}/agency/{agencyId}/marketBasket/exports',
headers=headers,
json=json_data,
)
# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{\n "export_type": "MARKETBASKET",\n "date_range": { "type": "CUSTOM", "start_date": "2026-10-06", "end_date": "2026-10-12" },\n "rate_sources": ["TR"],\n "export_rates_for": "CHOSEN_TIME_PERIOD",\n "include_zero_premium": false,\n "states": ["TX"],\n "lob": ["AUTO"],\n "file_format": "CSV",\n "delivery_method": "DOWNLOAD",\n "notify_email": false,\n "frequency": "ONCE",\n "export_date": "2026-10-13"\n }'
#response = requests.post(
# 'https://api.zywave.com/v3/quoting/personalLines/v1/org/{orgId}/agency/{agencyId}/marketBasket/exports',
# headers=headers,
# data=data,
#)
Copy
title: Market Basket API
language_tabs:
shell: Shell
http: HTTP
javascript: JavaScript
javascript--nodejs: Node.JS
ruby: Ruby
python: Python
java: Java
go: Go
toc_footers: []
includes: []
search: false
highlight_theme: darkula
headingLevel: 2
Market Basket API v1.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Requests, tracks and downloads PL CPQ Market Basket rate exports. All paths are tenanted by organization and agency; the caller must hold a profile for the agency in the path.
Base URLs:
Authentication
Scope
Scope Description
api.marketBasket
View and manage your Market Basket export data
api.marketBasket:read
View your Market Basket export data
Exports
post__v3_quoting_personalLines_v1_org_{orgId}agency {agencyId}_marketBasket_exports
POST /v3/quoting/personalLines/v1/org/{orgId}/agency/{agencyId}/marketBasket/exports
Exports — create an export request for the agency (one export per state x rate source x line of business).
Body parameter
{
"type": "object",
"required": [
"export_type",
"date_range",
"rate_sources",
"states",
"lob",
"file_format",
"frequency",
"export_date"
],
"properties": {
"export_type": {
"type": "string",
"enum": [
"MARKETBASKET",
"CARRIER",
"BENEFITS_CARRIERS"
]
},
"date_range": {
"type": "object",
"required": [
"type",
"start_date",
"end_date"
],
"properties": {
"type": {
"type": "string",
"enum": [
"CUSTOM"
]
},
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date",
"description": "On or after start_date, and no more than 31 days after it."
}
}
},
"rate_sources": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"description": "RATEAPI = Rate API, TR = TurboRater, TFW = TurboRater for Websites.",
"enum": [
"RATEAPI",
"TR",
"TFW"
]
}
},
"export_rates_for": {
"type": "string",
"enum": [
"CHOSEN_TIME_PERIOD",
"LATEST_ITERATION"
]
},
"include_zero_premium": {
"type": "boolean",
"default": false
},
"states": {
"type": "array",
"minItems": 1,
"description": "2-letter state codes.",
"items": {
"type": "string",
"minLength": 2,
"maxLength": 2
}
},
"lob": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"description": "AUTO = Personal Auto, HOME = Homeowners.",
"enum": [
"AUTO",
"HOME"
]
}
},
"file_format": {
"type": "string",
"enum": [
"CSV_WITH_QUOTES",
"CSV",
"PARQUET"
]
},
"delivery_method": {
"type": "string",
"enum": [
"DOWNLOAD",
"SFTP"
]
},
"notify_email": {
"type": "boolean",
"default": false,
"description": "Email the requester when the export is ready."
},
"frequency": {
"type": "string",
"enum": [
"ONCE",
"RECURRING"
]
},
"export_date": {
"type": "string",
"format": "date",
"description": "Must be today's date (UTC)."
}
}
}
Parameters
Name
In
Type
Required
Description
orgId
path
string(uuid)
true
Organization id. Must match the caller's organization.
agencyId
path
integer(int32)
true
Agency id. The caller must hold a profile for this agency.
body
body
ExportRequest
true
none
Example responses
202 Response
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"requested_at": {
"type": "string",
"format": "date-time"
},
"exports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"state": {
"type": "string"
},
"rate_source": {
"type": "string"
},
"lob": {
"type": "string"
},
"date_range": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
}
},
"export_date": {
"type": "string",
"format": "date"
},
"status": {
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"COMPLETE",
"FAILED",
"EXPIRED",
"CANCELLED"
]
}
}
}
}
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
oauth2 ( Scopes: api.marketBasket )
get__v3_quoting_personalLines_v1_org_{orgId}agency {agencyId}_marketBasket_exports_search
GET /v3/quoting/personalLines/v1/org/{orgId}/agency/{agencyId}/marketBasket/exports/search
Exports — search and list the agency's exports, with paging, sorting and filters (status included per export).
Parameters
Name
In
Type
Required
Description
orgId
path
string(uuid)
true
Organization id. Must match the caller's organization.
agencyId
path
integer(int32)
true
Agency id. The caller must hold a profile for this agency.
terms
query
string
false
Free-text search.
show_expired
query
boolean
false
Include expired exports. Defaults to false.
export_type
query
array[string]
false
Filter by export type. Comma-separated or repeated.
status
query
array[string]
false
Filter by status. Comma-separated or repeated.
requested_by
query
string
false
Filter by requester (user principal id).
rate_source
query
array[string]
false
Filter by rate source. Comma-separated or repeated.
state
query
array[string]
false
Filter by 2-letter state code. Comma-separated or repeated.
lob
query
array[string]
false
Filter by line of business. Comma-separated or repeated.
export_date_range_start
query
string(date)
false
Earliest export date (inclusive).
export_date_range_end
query
string(date)
false
Latest export date (inclusive).
sort_by
query
string
false
Sort column. Defaults to requested_at.
sort_direction
query
string
false
Sort direction. Defaults to desc.
page
query
integer(int32)
false
One-based page number. Defaults to 1.
page_size
query
integer(int32)
false
Page size. Defaults to 25.
Enumerated Values
Parameter
Value
export_type
MARKETBASKET
export_type
CARRIER
export_type
BENEFITS_CARRIERS
status
PENDING
status
PROCESSING
status
COMPLETE
status
FAILED
status
EXPIRED
status
CANCELLED
rate_source
RATEAPI
rate_source
TR
rate_source
TFW
lob
AUTO
lob
HOME
sort_by
requested_at
sort_by
export_type
sort_by
status
sort_by
export_date_range
sort_by
requested_by
sort_by
rate_source
sort_by
state
sort_by
lob
sort_direction
asc
sort_direction
desc
Example responses
200 Response
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"source": {
"type": "string"
},
"requested_by": {
"type": "string",
"description": "User principal id of the requester."
},
"profile_id": {
"type": "string"
},
"profile_type": {
"type": "string"
},
"requested_at": {
"type": "string",
"format": "date-time"
},
"exports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"export_type": {
"type": "string",
"enum": [
"MARKETBASKET",
"CARRIER",
"BENEFITS_CARRIERS"
]
},
"state": {
"type": "string"
},
"rate_source": {
"type": "string"
},
"lob": {
"type": "string"
},
"date_range": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
}
},
"export_date": {
"type": "string",
"format": "date"
},
"delivery_method": {
"type": "string",
"enum": [
"DOWNLOAD",
"SFTP"
]
},
"status": {
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"COMPLETE",
"FAILED",
"EXPIRED",
"CANCELLED"
]
},
"completed_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
}
}
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"page_size": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
}
}
}
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
oauth2 ( Scopes: api.marketBasket ), oauth2 ( Scopes: api.marketBasket:read )
get__v3_quoting_personalLines_v1_org_{orgId}agency {agencyId}marketBasket_exports {exportId}_status
GET /v3/quoting/personalLines/v1/org/{orgId}/agency/{agencyId}/marketBasket/exports/{exportId}/status
Exports — status of a single export (PENDING, PROCESSING, COMPLETE, FAILED).
Parameters
Name
In
Type
Required
Description
orgId
path
string(uuid)
true
Organization id. Must match the caller's organization.
agencyId
path
integer(int32)
true
Agency id. The caller must hold a profile for this agency.
exportId
path
string(uuid)
true
none
Example responses
200 Response
{
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"COMPLETE",
"FAILED",
"EXPIRED",
"CANCELLED"
]
},
"submittedAt": {
"type": "string",
"format": "date-time"
}
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
oauth2 ( Scopes: api.marketBasket ), oauth2 ( Scopes: api.marketBasket:read )
get__v3_quoting_personalLines_v1_org_{orgId}agency {agencyId}marketBasket_exports {exportId}_download-url
GET /v3/quoting/personalLines/v1/org/{orgId}/agency/{agencyId}/marketBasket/exports/{exportId}/download-url
Exports — presigned download link for a completed export.
Parameters
Name
In
Type
Required
Description
orgId
path
string(uuid)
true
Organization id. Must match the caller's organization.
agencyId
path
integer(int32)
true
Agency id. The caller must hold a profile for this agency.
exportId
path
string(uuid)
true
none
Example responses
200 Response
{
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"presigned_url": {
"type": "string",
"format": "uri"
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "When the link stops working."
}
}
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
oauth2 ( Scopes: api.marketBasket ), oauth2 ( Scopes: api.marketBasket:read )
Schemas
ExportType
{
"type": "string",
"enum": [
"MARKETBASKET",
"CARRIER",
"BENEFITS_CARRIERS"
]
}
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
none
Enumerated Values
Property
Value
anonymous
MARKETBASKET
anonymous
CARRIER
anonymous
BENEFITS_CARRIERS
ExportStatus
{
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"COMPLETE",
"FAILED",
"EXPIRED",
"CANCELLED"
]
}
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
none
Enumerated Values
Property
Value
anonymous
PENDING
anonymous
PROCESSING
anonymous
COMPLETE
anonymous
FAILED
anonymous
EXPIRED
anonymous
CANCELLED
RateSource
{
"type": "string",
"description": "RATEAPI = Rate API, TR = TurboRater, TFW = TurboRater for Websites.",
"enum": [
"RATEAPI",
"TR",
"TFW"
]
}
RATEAPI = Rate API, TR = TurboRater, TFW = TurboRater for Websites.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
RATEAPI = Rate API, TR = TurboRater, TFW = TurboRater for Websites.
Enumerated Values
Property
Value
anonymous
RATEAPI
anonymous
TR
anonymous
TFW
LineOfBusiness
{
"type": "string",
"description": "AUTO = Personal Auto, HOME = Homeowners.",
"enum": [
"AUTO",
"HOME"
]
}
AUTO = Personal Auto, HOME = Homeowners.
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
AUTO = Personal Auto, HOME = Homeowners.
Enumerated Values
Property
Value
anonymous
AUTO
anonymous
HOME
{
"type": "string",
"enum": [
"CSV_WITH_QUOTES",
"CSV",
"PARQUET"
]
}
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
none
Enumerated Values
Property
Value
anonymous
CSV_WITH_QUOTES
anonymous
CSV
anonymous
PARQUET
DeliveryMethod
{
"type": "string",
"enum": [
"DOWNLOAD",
"SFTP"
]
}
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
none
Enumerated Values
Property
Value
anonymous
DOWNLOAD
anonymous
SFTP
ExportFrequency
{
"type": "string",
"enum": [
"ONCE",
"RECURRING"
]
}
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
none
Enumerated Values
Property
Value
anonymous
ONCE
anonymous
RECURRING
ExportRatesFor
{
"type": "string",
"enum": [
"CHOSEN_TIME_PERIOD",
"LATEST_ITERATION"
]
}
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
none
Enumerated Values
Property
Value
anonymous
CHOSEN_TIME_PERIOD
anonymous
LATEST_ITERATION
DateRange
{
"type": "object",
"required": [
"type",
"start_date",
"end_date"
],
"properties": {
"type": {
"type": "string",
"enum": [
"CUSTOM"
]
},
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date",
"description": "On or after start_date, and no more than 31 days after it."
}
}
}
Properties
Name
Type
Required
Restrictions
Description
type
string
true
none
none
start_date
string(date)
true
none
none
end_date
string(date)
true
none
On or after start_date, and no more than 31 days after it.
Enumerated Values
Property
Value
type
CUSTOM
ExportDateRange
{
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
}
}
Properties
Name
Type
Required
Restrictions
Description
start_date
string(date)
false
none
none
end_date
string(date)
false
none
none
ExportRequest
{
"type": "object",
"required": [
"export_type",
"date_range",
"rate_sources",
"states",
"lob",
"file_format",
"frequency",
"export_date"
],
"properties": {
"export_type": {
"type": "string",
"enum": [
"MARKETBASKET",
"CARRIER",
"BENEFITS_CARRIERS"
]
},
"date_range": {
"type": "object",
"required": [
"type",
"start_date",
"end_date"
],
"properties": {
"type": {
"type": "string",
"enum": [
"CUSTOM"
]
},
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date",
"description": "On or after start_date, and no more than 31 days after it."
}
}
},
"rate_sources": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"description": "RATEAPI = Rate API, TR = TurboRater, TFW = TurboRater for Websites.",
"enum": [
"RATEAPI",
"TR",
"TFW"
]
}
},
"export_rates_for": {
"type": "string",
"enum": [
"CHOSEN_TIME_PERIOD",
"LATEST_ITERATION"
]
},
"include_zero_premium": {
"type": "boolean",
"default": false
},
"states": {
"type": "array",
"minItems": 1,
"description": "2-letter state codes.",
"items": {
"type": "string",
"minLength": 2,
"maxLength": 2
}
},
"lob": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"description": "AUTO = Personal Auto, HOME = Homeowners.",
"enum": [
"AUTO",
"HOME"
]
}
},
"file_format": {
"type": "string",
"enum": [
"CSV_WITH_QUOTES",
"CSV",
"PARQUET"
]
},
"delivery_method": {
"type": "string",
"enum": [
"DOWNLOAD",
"SFTP"
]
},
"notify_email": {
"type": "boolean",
"default": false,
"description": "Email the requester when the export is ready."
},
"frequency": {
"type": "string",
"enum": [
"ONCE",
"RECURRING"
]
},
"export_date": {
"type": "string",
"format": "date",
"description": "Must be today's date (UTC)."
}
}
}
Properties
Name
Type
Required
Restrictions
Description
export_type
ExportType
true
none
none
date_range
DateRange
true
none
none
rate_sources
[RateSource ]
true
none
[RATEAPI = Rate API, TR = TurboRater, TFW = TurboRater for Websites.]
export_rates_for
ExportRatesFor
false
none
none
include_zero_premium
boolean
false
none
none
states
[string]
true
none
2-letter state codes.
lob
[LineOfBusiness ]
true
none
[AUTO = Personal Auto, HOME = Homeowners.]
file_format
FileFormat
true
none
none
delivery_method
DeliveryMethod
false
none
none
notify_email
boolean
false
none
Email the requester when the export is ready.
frequency
ExportFrequency
true
none
none
export_date
string(date)
true
none
Must be today's date (UTC).
ExportItem
{
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"state": {
"type": "string"
},
"rate_source": {
"type": "string"
},
"lob": {
"type": "string"
},
"date_range": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
}
},
"export_date": {
"type": "string",
"format": "date"
},
"status": {
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"COMPLETE",
"FAILED",
"EXPIRED",
"CANCELLED"
]
}
}
}
Properties
Name
Type
Required
Restrictions
Description
exportId
string(uuid)
false
none
none
state
string
false
none
none
rate_source
string
false
none
none
lob
string
false
none
none
date_range
ExportDateRange
false
none
none
export_date
string(date)
false
none
none
status
ExportStatus
false
none
none
ExportResponse
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"requested_at": {
"type": "string",
"format": "date-time"
},
"exports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"state": {
"type": "string"
},
"rate_source": {
"type": "string"
},
"lob": {
"type": "string"
},
"date_range": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
}
},
"export_date": {
"type": "string",
"format": "date"
},
"status": {
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"COMPLETE",
"FAILED",
"EXPIRED",
"CANCELLED"
]
}
}
}
}
}
}
Properties
Name
Type
Required
Restrictions
Description
requestId
string(uuid)
false
none
none
requested_at
string(date-time)
false
none
none
exports
[ExportItem ]
false
none
none
ExportSearchItem
{
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"export_type": {
"type": "string",
"enum": [
"MARKETBASKET",
"CARRIER",
"BENEFITS_CARRIERS"
]
},
"state": {
"type": "string"
},
"rate_source": {
"type": "string"
},
"lob": {
"type": "string"
},
"date_range": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
}
},
"export_date": {
"type": "string",
"format": "date"
},
"delivery_method": {
"type": "string",
"enum": [
"DOWNLOAD",
"SFTP"
]
},
"status": {
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"COMPLETE",
"FAILED",
"EXPIRED",
"CANCELLED"
]
},
"completed_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
Properties
Name
Type
Required
Restrictions
Description
exportId
string(uuid)
false
none
none
export_type
ExportType
false
none
none
state
string
false
none
none
rate_source
string
false
none
none
lob
string
false
none
none
date_range
ExportDateRange
false
none
none
export_date
string(date)
false
none
none
delivery_method
DeliveryMethod
false
none
none
status
ExportStatus
false
none
none
completed_at
string(date-time)|null
false
none
none
ExportGroup
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"source": {
"type": "string"
},
"requested_by": {
"type": "string",
"description": "User principal id of the requester."
},
"profile_id": {
"type": "string"
},
"profile_type": {
"type": "string"
},
"requested_at": {
"type": "string",
"format": "date-time"
},
"exports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"export_type": {
"type": "string",
"enum": [
"MARKETBASKET",
"CARRIER",
"BENEFITS_CARRIERS"
]
},
"state": {
"type": "string"
},
"rate_source": {
"type": "string"
},
"lob": {
"type": "string"
},
"date_range": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
}
},
"export_date": {
"type": "string",
"format": "date"
},
"delivery_method": {
"type": "string",
"enum": [
"DOWNLOAD",
"SFTP"
]
},
"status": {
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"COMPLETE",
"FAILED",
"EXPIRED",
"CANCELLED"
]
},
"completed_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
}
}
}
Properties
Name
Type
Required
Restrictions
Description
requestId
string(uuid)
false
none
none
source
string
false
none
none
requested_by
string
false
none
User principal id of the requester.
profile_id
string
false
none
none
profile_type
string
false
none
none
requested_at
string(date-time)
false
none
none
exports
[ExportSearchItem ]
false
none
none
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"page_size": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
}
}
}
Properties
Name
Type
Required
Restrictions
Description
page
integer(int32)
false
none
none
page_size
integer(int32)
false
none
none
total
integer(int32)
false
none
none
ExportSearchResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"source": {
"type": "string"
},
"requested_by": {
"type": "string",
"description": "User principal id of the requester."
},
"profile_id": {
"type": "string"
},
"profile_type": {
"type": "string"
},
"requested_at": {
"type": "string",
"format": "date-time"
},
"exports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"export_type": {
"type": "string",
"enum": [
"MARKETBASKET",
"CARRIER",
"BENEFITS_CARRIERS"
]
},
"state": {
"type": "string"
},
"rate_source": {
"type": "string"
},
"lob": {
"type": "string"
},
"date_range": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
}
},
"export_date": {
"type": "string",
"format": "date"
},
"delivery_method": {
"type": "string",
"enum": [
"DOWNLOAD",
"SFTP"
]
},
"status": {
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"COMPLETE",
"FAILED",
"EXPIRED",
"CANCELLED"
]
},
"completed_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
}
}
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"page_size": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
}
}
}
}
}
Properties
Name
Type
Required
Restrictions
Description
data
[ExportGroup ]
false
none
none
pagination
Pagination
false
none
none
ExportStatusResponse
{
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"COMPLETE",
"FAILED",
"EXPIRED",
"CANCELLED"
]
},
"submittedAt": {
"type": "string",
"format": "date-time"
}
}
}
Properties
Name
Type
Required
Restrictions
Description
exportId
string(uuid)
false
none
none
status
ExportStatus
false
none
none
submittedAt
string(date-time)
false
none
none
ExportDownloadUrlResponse
{
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"presigned_url": {
"type": "string",
"format": "uri"
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "When the link stops working."
}
}
}
Properties
Name
Type
Required
Restrictions
Description
exportId
string(uuid)
false
none
none
presigned_url
string(uri)
false
none
none
expires_at
string(date-time)
false
none
When the link stops working.
ProblemDetails
{
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
Properties
Name
Type
Required
Restrictions
Description
type
string|null
false
none
none
title
string|null
false
none
none
status
integer(int32)|null
false
none
none
detail
string|null
false
none
none
instance
string|null
false
none
none
ValidationProblemDetails
{
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
Properties
allOf
Name
Type
Required
Restrictions
Description
anonymous
ProblemDetails
false
none
none
and
Name
Type
Required
Restrictions
Description
anonymous
object
false
none
none
» errors
object
false
none
none
»» additionalProperties
[string]
false
none
none
ReportNotReadyProblemDetails
{
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"REPORT_NOT_READY"
]
},
"exportStatus": {
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"COMPLETE",
"FAILED",
"EXPIRED",
"CANCELLED"
]
}
}
}
]
}
Properties
allOf
Name
Type
Required
Restrictions
Description
anonymous
ProblemDetails
false
none
none
and
Name
Type
Required
Restrictions
Description
anonymous
object
false
none
none
» error
string
false
none
none
» exportStatus
ExportStatus
false
none
none
Enumerated Values
Property
Value
error
REPORT_NOT_READY