Get Agreement
Last updated
Was this helpful?
Last updated
Was this helpful?
Get a single Agreement object by ID.
GET /public/v1/commerce/agreements/{id} HTTP/1.1
Host:
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"active": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"provisioning": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"terminated": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"status": "text",
"listing": {
"id": "text"
},
"authorization": {
"id": "text",
"name": "text",
"currency": "text"
},
"vendor": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"client": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1
},
"startDate": "2025-06-01T17:33:56.219Z",
"endDate": "2025-06-01T17:33:56.219Z",
"template": {
"id": "text",
"name": "text"
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"name": "text",
"lines": [
{
"id": "text",
"quantity": 1,
"item": {
"id": "text",
"name": "text",
"externalIds": {
"vendor": "text",
"operations": "text"
}
},
"audit": {
"created": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"terminated": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"deleted": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"price": {
"currency": "text",
"markup": 1,
"margin": 1,
"unitSP": 1,
"unitPP": 1,
"PPx1": 1,
"SPx1": 1
},
"order": {
"id": "text"
},
"status": "text"
}
],
"subscriptions": [
{
"id": "text",
"name": "text"
}
],
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "text",
"phase": "text",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"required": true,
"hidden": true,
"readonly": true
},
"displayValue": "text",
"value": null
}
]
},
"licensee": {
"id": "text",
"icon": "text",
"name": "text",
"externalId": "text"
},
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"id": "text",
"icon": "text",
"externalId": "text",
"name": "text",
"erpLink": {
"id": "text",
"audit": {
"created": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"blocked": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"unblocked": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"icon": "text",
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"seller": {
"0": "[",
"1": "C",
"2": "i",
"3": "r",
"4": "c",
"5": "u",
"6": "l",
"7": "a",
"8": "r",
"9": " ",
"10": "R",
"11": "e",
"12": "f",
"13": "e",
"14": "r",
"15": "e",
"16": "n",
"17": "c",
"18": "e",
"19": "]"
},
"name": "text",
"status": "text",
"note": "text",
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
}
}
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text"
},
"icon": "text",
"status": "text"
},
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
},
"split": {
"id": "text",
"audit": {
"created": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"allocations": [
{
"buyer": {
"id": "text",
"icon": "text",
"name": "text"
},
"percentage": 1,
"price": {
"currency": "text",
"SPxY": 1,
"SPxM": 1,
"PPxY": 1,
"PPxM": 1
},
"audit": {
"created": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"statistics": {
"subscriptions": 1
},
"externalIds": {
"client": "text",
"operations": "text",
"vendor": "text"
}
}
]
},
"termsAndConditions": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-06-01T17:33:56.219Z",
"by": {
"id": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"description": "text",
"displayOrder": 1,
"status": "text",
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text"
},
"icon": "text",
"status": "text"
},
"accepted": "2025-06-01T17:33:56.219Z",
"acceptedBy": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "text",
"icon": "text"
}
}
],
"certificates": [
{
"id": "text",
"name": "text"
}
]
}