Error
A valid request URL is required to generate request examples{
"attributes": [
{
"attributeDefinition": {
"attributeCode": "<string>",
"displayGroup": "<string>",
"valueType": "<string>",
"adminName": "<string>",
"attributeFQN": "<string>",
"attributeMetadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableForDiscounts": true,
"availableForOrderRouting": true,
"availableInRules": true,
"content": {
"localeCode": "<string>",
"value": "<string>"
},
"dataType": "<string>",
"entityConfigs": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"editable": true,
"entityType": "<string>",
"id": 123
}
],
"id": 123,
"inheritanceRules": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"id": 123,
"inheritanceMode": "<string>",
"sourceEntityType": "<string>",
"targetEntityType": "<string>"
}
],
"inputType": "<string>",
"isActive": true,
"isMultiValued": true,
"isReadOnly": true,
"isRequired": true,
"isVisible": true,
"namespace": "<string>",
"order": 123,
"validation": {
"maxDateTime": "2023-11-07T05:31:56Z",
"maxNumericValue": 123,
"maxStringLength": 123,
"minDateTime": "2023-11-07T05:31:56Z",
"minNumericValue": 123,
"minStringLength": 123,
"regularExpression": "<string>"
},
"vocabularyValues": [
{
"value": "<string>",
"content": {
"localeCode": "<string>",
"value": "<string>"
},
"isHidden": true,
"sequence": 123
}
]
},
"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"
},
"contactInfo": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"billingEmail": "<string>",
"email": "<string>",
"phone": "<string>",
"primaryContactName": "<string>",
"supportEmail": "<string>"
},
"corporateDetails": {
"businessType": "<string>",
"companyDescription": "<string>",
"foundedYear": 123,
"legalBusinessName": "<string>",
"numberOfEmployees": 123,
"taxId": "<string>",
"website": "<string>"
},
"data": null,
"inventoryRefresh": "<string>",
"locations": [
{
"data": null,
"locationCode": "<string>"
}
],
"metrics": {
"itemAcceptanceRate": 123,
"itemReturnRate": 123,
"onTimeShipmentRate": 123,
"performanceCategory": "<string>",
"performanceScore": 123
},
"name": "<string>",
"onboardingChecklist": {
"businessVerificationCompleted": true,
"companyInfoSubmitted": true,
"integrationProfile": {
"api": {
"catalogListing": true,
"inventory": true,
"locations": true,
"orders": true
},
"ediKibo": {
"ackOn856": true,
"receiverId": "<string>"
},
"integrationConfigured": true,
"portal": {
"catalogListingAndInventory": true,
"locations": true
},
"type": "<string>"
},
"userAccountsAdded": true
},
"status": "<string>",
"tenantId": 123,
"vendorCode": "<string>",
"vendorType": "<string>"
}Change vendor status with validation based on target status.
Transitions to Active status require full validation (address, SKU mappings, ReceiverId for EDIKibo). Transitions to Inactive or OnboardingInProcess have no validation requirements.
POST
/
commerce
/
vendors
/
{vendorCode}
/
status
Error
A valid request URL is required to generate request examples{
"attributes": [
{
"attributeDefinition": {
"attributeCode": "<string>",
"displayGroup": "<string>",
"valueType": "<string>",
"adminName": "<string>",
"attributeFQN": "<string>",
"attributeMetadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableForDiscounts": true,
"availableForOrderRouting": true,
"availableInRules": true,
"content": {
"localeCode": "<string>",
"value": "<string>"
},
"dataType": "<string>",
"entityConfigs": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"editable": true,
"entityType": "<string>",
"id": 123
}
],
"id": 123,
"inheritanceRules": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"id": 123,
"inheritanceMode": "<string>",
"sourceEntityType": "<string>",
"targetEntityType": "<string>"
}
],
"inputType": "<string>",
"isActive": true,
"isMultiValued": true,
"isReadOnly": true,
"isRequired": true,
"isVisible": true,
"namespace": "<string>",
"order": 123,
"validation": {
"maxDateTime": "2023-11-07T05:31:56Z",
"maxNumericValue": 123,
"maxStringLength": 123,
"minDateTime": "2023-11-07T05:31:56Z",
"minNumericValue": 123,
"minStringLength": 123,
"regularExpression": "<string>"
},
"vocabularyValues": [
{
"value": "<string>",
"content": {
"localeCode": "<string>",
"value": "<string>"
},
"isHidden": true,
"sequence": 123
}
]
},
"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"
},
"contactInfo": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"billingEmail": "<string>",
"email": "<string>",
"phone": "<string>",
"primaryContactName": "<string>",
"supportEmail": "<string>"
},
"corporateDetails": {
"businessType": "<string>",
"companyDescription": "<string>",
"foundedYear": 123,
"legalBusinessName": "<string>",
"numberOfEmployees": 123,
"taxId": "<string>",
"website": "<string>"
},
"data": null,
"inventoryRefresh": "<string>",
"locations": [
{
"data": null,
"locationCode": "<string>"
}
],
"metrics": {
"itemAcceptanceRate": 123,
"itemReturnRate": 123,
"onTimeShipmentRate": 123,
"performanceCategory": "<string>",
"performanceScore": 123
},
"name": "<string>",
"onboardingChecklist": {
"businessVerificationCompleted": true,
"companyInfoSubmitted": true,
"integrationProfile": {
"api": {
"catalogListing": true,
"inventory": true,
"locations": true,
"orders": true
},
"ediKibo": {
"ackOn856": true,
"receiverId": "<string>"
},
"integrationConfigured": true,
"portal": {
"catalogListingAndInventory": true,
"locations": true
},
"type": "<string>"
},
"userAccountsAdded": true
},
"status": "<string>",
"tenantId": 123,
"vendorCode": "<string>",
"vendorType": "<string>"
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Unique vendor code
Query Parameters
limits which fields are returned in the response body
Body
application/json
Request containing new status
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I

