Error
A valid request URL is required to generate request examples{
"items": [
{
"attributes": [
{
"attributeDefinitionId": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableActions": [
"<string>"
],
"blanketOrderId": "<string>",
"cancelledBy": "<string>",
"cancelledDate": "2023-11-07T05:31:56Z",
"cancelledReason": {
"description": "<string>",
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"changeMessages": [
{
"body": "<string>",
"callOffOrderId": "<string>",
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"identifier": "<string>",
"newValue": "<string>",
"oldValue": "<string>",
"siteId": 123,
"subject": "<string>",
"tenantId": 123
}
],
"channelCode": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"creditHold": {
"onHold": true,
"reason": {
"description": "<string>",
"moreInfo": "<string>",
"reasonCode": "<string>"
}
},
"currencyCode": "<string>",
"customerAccountId": 123,
"data": {},
"destinations": [
{
"data": {},
"destinationContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"id": "<string>",
"isDestinationCommercial": true
}
],
"externalId": "<string>",
"id": "<string>",
"items": [
{
"actualDeliveryDate": "2023-11-07T05:31:56Z",
"attributes": [
{
"attributeDefinitionId": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"blanketOrderItemId": "<string>",
"cancelledBy": "<string>",
"cancelledDate": "2023-11-07T05:31:56Z",
"cancelledReason": {
"description": "<string>",
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"destinationId": "<string>",
"eddStatus": "<string>",
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fillRate": 123,
"fulfillmentLocationCode": "<string>",
"fulfillmentType": "<string>",
"id": "<string>",
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"lineId": 123,
"lineTotal": 123,
"product": {
"bundledProducts": [
{
"allocationExpiration": "2023-11-07T05:31:56Z",
"allocationId": 123,
"creditValue": 123,
"deltaPrice": 123,
"description": "<string>",
"fulfillmentStatus": "<string>",
"goodsType": "<string>",
"imageUrl": "<string>",
"isPackagedStandAlone": true,
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"name": "<string>",
"optionAttributeFQN": "<string>",
"optionValue": "<unknown>",
"productCode": "<string>",
"productReservationId": 123,
"quantity": 123,
"stock": {
"aggregateInventory": 123,
"availableDate": "2023-11-07T05:31:56Z",
"availableFutureInventories": 123,
"futureInventories": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123
}
],
"isOnBackOrder": true,
"isSubstitutable": true,
"manageStock": true,
"stockAvailable": 123,
"totalAvailableStock": 123
}
}
],
"combinedProductCode": "<string>",
"fulfillmentTypesSupported": [
"<string>"
],
"goodsType": "<string>",
"name": "<string>",
"options": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": "<unknown>"
}
],
"productCode": "<string>",
"productUsage": "<string>",
"variationProductCode": "<string>"
},
"purchaseLocation": "<string>",
"releasedDate": "2023-11-07T05:31:56Z",
"releasedQty": 123,
"requestedDeliveryDate": "2023-11-07T05:31:56Z",
"requestedQty": 123,
"requestedShipDate": "2023-11-07T05:31:56Z",
"reservedQty": 123,
"salesOrderId": "<string>",
"status": "<string>",
"timeFenceDays": 123,
"unitPrice": 123
}
],
"notes": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"text": "<string>"
}
],
"number": 123,
"payments": [
{
"amount": 123,
"billingInfo": {
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"billingContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"card": {
"bin": "<string>",
"cardNumberPartOrMask": "<string>",
"ccLastFour": "<string>",
"expireMonth": 123,
"expireYear": 123,
"isCardInfoSaved": true,
"isTokenized": true,
"isUsedRecurring": true,
"nameOnCard": "<string>",
"paymentOrCardType": "<string>",
"paymentServiceCardId": "<string>"
},
"check": {
"checkNumber": "<string>"
},
"customCreditType": "<string>",
"data": {},
"externalToken": {
"paymentServiceTokenId": "<string>",
"provider": "<string>",
"type": "<string>"
},
"externalTransactionId": "<string>",
"isRecurring": true,
"isSameBillingShippingAddress": true,
"paymentType": "<string>",
"paymentWorkflow": "<string>",
"purchaseOrder": {
"customFields": [
{
"code": "<string>",
"label": "<string>",
"value": "<string>"
}
],
"paymentTerm": {
"code": "<string>",
"description": "<string>"
},
"purchaseOrderNumber": "<string>"
},
"recurringTransactionId": "<string>",
"storeCreditCode": "<string>",
"storeCreditType": "<string>",
"token": {
"paymentServiceTokenId": "<string>",
"provider": "<string>",
"type": "<string>"
}
},
"data": {},
"paymentTerms": "<string>",
"paymentType": "<string>",
"purchaseOrderNumber": "<string>"
}
],
"priceListCode": "<string>",
"pricingMode": "<string>",
"reservationId": "<string>",
"siteId": 123,
"status": "<string>",
"tenantId": 123,
"totalAmount": 123,
"version": "<string>"
}
],
"pageCount": 123,
"pageSize": 123,
"startIndex": 123,
"totalCount": 123
}Get Call Off Orders
Get Call Off Orders
GET
/
commerce
/
callofforders
Error
A valid request URL is required to generate request examples{
"items": [
{
"attributes": [
{
"attributeDefinitionId": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableActions": [
"<string>"
],
"blanketOrderId": "<string>",
"cancelledBy": "<string>",
"cancelledDate": "2023-11-07T05:31:56Z",
"cancelledReason": {
"description": "<string>",
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"changeMessages": [
{
"body": "<string>",
"callOffOrderId": "<string>",
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"identifier": "<string>",
"newValue": "<string>",
"oldValue": "<string>",
"siteId": 123,
"subject": "<string>",
"tenantId": 123
}
],
"channelCode": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"creditHold": {
"onHold": true,
"reason": {
"description": "<string>",
"moreInfo": "<string>",
"reasonCode": "<string>"
}
},
"currencyCode": "<string>",
"customerAccountId": 123,
"data": {},
"destinations": [
{
"data": {},
"destinationContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"id": "<string>",
"isDestinationCommercial": true
}
],
"externalId": "<string>",
"id": "<string>",
"items": [
{
"actualDeliveryDate": "2023-11-07T05:31:56Z",
"attributes": [
{
"attributeDefinitionId": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"blanketOrderItemId": "<string>",
"cancelledBy": "<string>",
"cancelledDate": "2023-11-07T05:31:56Z",
"cancelledReason": {
"description": "<string>",
"moreInfo": "<string>",
"reasonCode": "<string>"
},
"destinationId": "<string>",
"eddStatus": "<string>",
"expectedDeliveryDate": "2023-11-07T05:31:56Z",
"fillRate": 123,
"fulfillmentLocationCode": "<string>",
"fulfillmentType": "<string>",
"id": "<string>",
"inventoryTags": [
{
"name": "<string>",
"value": "<string>"
}
],
"lineId": 123,
"lineTotal": 123,
"product": {
"bundledProducts": [
{
"allocationExpiration": "2023-11-07T05:31:56Z",
"allocationId": 123,
"creditValue": 123,
"deltaPrice": 123,
"description": "<string>",
"fulfillmentStatus": "<string>",
"goodsType": "<string>",
"imageUrl": "<string>",
"isPackagedStandAlone": true,
"measurements": {
"height": {
"unit": "<string>",
"value": 123
},
"length": {
"unit": "<string>",
"value": 123
},
"weight": {
"unit": "<string>",
"value": 123
},
"width": {
"unit": "<string>",
"value": 123
}
},
"name": "<string>",
"optionAttributeFQN": "<string>",
"optionValue": "<unknown>",
"productCode": "<string>",
"productReservationId": 123,
"quantity": 123,
"stock": {
"aggregateInventory": 123,
"availableDate": "2023-11-07T05:31:56Z",
"availableFutureInventories": 123,
"futureInventories": [
{
"allocated": 123,
"available": 123,
"createDate": "2023-11-07T05:31:56Z",
"deliveryDate": "2023-11-07T05:31:56Z",
"futureInventoryID": 123,
"onhand": 123,
"pending": 123
}
],
"isOnBackOrder": true,
"isSubstitutable": true,
"manageStock": true,
"stockAvailable": 123,
"totalAvailableStock": 123
}
}
],
"combinedProductCode": "<string>",
"fulfillmentTypesSupported": [
"<string>"
],
"goodsType": "<string>",
"name": "<string>",
"options": [
{
"attributeFQN": "<string>",
"dataType": "<string>",
"name": "<string>",
"shopperEnteredValue": "<unknown>",
"stringValue": "<string>",
"value": "<unknown>"
}
],
"productCode": "<string>",
"productUsage": "<string>",
"variationProductCode": "<string>"
},
"purchaseLocation": "<string>",
"releasedDate": "2023-11-07T05:31:56Z",
"releasedQty": 123,
"requestedDeliveryDate": "2023-11-07T05:31:56Z",
"requestedQty": 123,
"requestedShipDate": "2023-11-07T05:31:56Z",
"reservedQty": 123,
"salesOrderId": "<string>",
"status": "<string>",
"timeFenceDays": 123,
"unitPrice": 123
}
],
"notes": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"text": "<string>"
}
],
"number": 123,
"payments": [
{
"amount": 123,
"billingInfo": {
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"billingContact": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"firstName": "<string>",
"id": 123,
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
}
},
"card": {
"bin": "<string>",
"cardNumberPartOrMask": "<string>",
"ccLastFour": "<string>",
"expireMonth": 123,
"expireYear": 123,
"isCardInfoSaved": true,
"isTokenized": true,
"isUsedRecurring": true,
"nameOnCard": "<string>",
"paymentOrCardType": "<string>",
"paymentServiceCardId": "<string>"
},
"check": {
"checkNumber": "<string>"
},
"customCreditType": "<string>",
"data": {},
"externalToken": {
"paymentServiceTokenId": "<string>",
"provider": "<string>",
"type": "<string>"
},
"externalTransactionId": "<string>",
"isRecurring": true,
"isSameBillingShippingAddress": true,
"paymentType": "<string>",
"paymentWorkflow": "<string>",
"purchaseOrder": {
"customFields": [
{
"code": "<string>",
"label": "<string>",
"value": "<string>"
}
],
"paymentTerm": {
"code": "<string>",
"description": "<string>"
},
"purchaseOrderNumber": "<string>"
},
"recurringTransactionId": "<string>",
"storeCreditCode": "<string>",
"storeCreditType": "<string>",
"token": {
"paymentServiceTokenId": "<string>",
"provider": "<string>",
"type": "<string>"
}
},
"data": {},
"paymentTerms": "<string>",
"paymentType": "<string>",
"purchaseOrderNumber": "<string>"
}
],
"priceListCode": "<string>",
"pricingMode": "<string>",
"reservationId": "<string>",
"siteId": 123,
"status": "<string>",
"tenantId": 123,
"totalAmount": 123,
"version": "<string>"
}
],
"pageCount": 123,
"pageSize": 123,
"startIndex": 123,
"totalCount": 123
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Response
OK
Paged result for Call-Off Order list queries.
Page of call-off orders matching the query.
Show child attributes
Show child attributes
Total number of pages.
Maximum number of records per page.
Zero-based index of the first record in this page.
Total number of matching records across all pages.
⌘I

