Error
A valid request URL is required to generate request examples{
"referralUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerName": "<string>",
"capabilityName": "<string>",
"sources": [
{
"inventorySourceId": "<string>",
"sourceId": "<string>",
"name": "<string>",
"endpointUrl": "<string>",
"status": "PENDING",
"authConfigured": true
}
],
"connectionContracts": [
{
"id": "<string>",
"version": 1073741823,
"displayName": "<string>",
"endpoints": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"source": "client",
"description": "<string>",
"value": "<string>"
}
],
"configurationFields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"kind": "text",
"description": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
]
}
],
"authenticationMethods": [
{
"type": "none",
"label": "<string>",
"credentials": [
{
"key": "<string>",
"label": "<string>",
"secret": true
}
]
}
]
}
],
"attachment": {
"bindingUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": {
"inventorySourceId": "<string>",
"sourceId": "<string>",
"name": "<string>",
"endpointUrl": "<string>",
"status": "PENDING",
"authConfigured": true
},
"authorizedAt": "2023-11-07T05:31:56Z"
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Storefront
List eligible publisher Sources
Lists Sources owned by the accepting publisher organization and any exact attachment already completed by this referral.
POST
/
provider
/
client-referrals
/
setup
Error
A valid request URL is required to generate request examples{
"referralUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerName": "<string>",
"capabilityName": "<string>",
"sources": [
{
"inventorySourceId": "<string>",
"sourceId": "<string>",
"name": "<string>",
"endpointUrl": "<string>",
"status": "PENDING",
"authConfigured": true
}
],
"connectionContracts": [
{
"id": "<string>",
"version": 1073741823,
"displayName": "<string>",
"endpoints": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"source": "client",
"description": "<string>",
"value": "<string>"
}
],
"configurationFields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"kind": "text",
"description": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>"
}
]
}
],
"authenticationMethods": [
{
"type": "none",
"label": "<string>",
"credentials": [
{
"key": "<string>",
"label": "<string>",
"secret": true
}
]
}
]
}
],
"attachment": {
"bindingUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": {
"inventorySourceId": "<string>",
"sourceId": "<string>",
"name": "<string>",
"endpointUrl": "<string>",
"status": "PENDING",
"authConfigured": true
},
"authorizedAt": "2023-11-07T05:31:56Z"
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Body
application/json
Pattern:
^[A-Za-z0-9_-]{43}$Response
List eligible publisher Sources
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes