Update Organization
PUT/api/v1/organizations/:organization_id
Update Organization
Request​
Path Parameters
- application/json
Body
Array [
]
Array [
]
Possible values: non-empty
Address of the Organization
Possible values: non-empty
Authorized capabilities of an Organization
Possible values: [Fabric Supplier
, Trim Supplier
, Merchandise Vendor
, Packaging Supplier
, Production/Storage Facility Owner
]
List of business partner types of the Organization. This field is only used for an Organization of type 'partner'
The strategic business unit that the organization belongs to
The strategic business unit category that the organization belongs to
City of the Organization
contacts
object[]
nullable
List of contacts of the Organization
Possible values: non-empty
Email of the organization contact
Possible values: non-empty
First name of the organization contact
Unique identifier of the organization contact
Last name of the organization contact
Possible values: non-empty
Phone number of the organization contact
Country code of the phone number of a Contact
Possible values: >= 2 characters
and <= 2 characters
Country of the Organization represented by the standard ISO Alpha-2 code, e.g. US for the United States
Possible values: [primary
, secondary
]
Factory Type
Indicates by true or false whether the Organization has the ability to produce food
The lead strategic business unit category that the organization belongs to
Lead Manager
location
object
Location of the Organization
Latitude location of the Organization
Longitude location of the Organization
Possible values: non-empty
Name of the Organization
partners
object[]
nullable
List of partner IDs of the Organization, this field is only use for an Organization of type 'factory'
Possible values: non-empty
Authorized capabilities of an Organization
Possible values: non-empty
Unique identifier of the Partner Organization
Indicates by true or false whether the Partner can be marked as a Lead Supplier for the Factory
Status of the Partner Organization between Available, In Progress, Non-Compliant, Pending Transfer, or Pending Duplicate Check
Types of manufacturing of the Organization represented by an integer from 1 to 5
1 = FACTORY
2 = MILL
3 = LAUNDRY
4 = PACKING
5 = TRIM
Possible values: non-empty
Name of the Partner Organization
Date of registration of the Partner Organization
Status of the registration of the Partner Organization represented by an integer from 1 to 4
1 = REGISTERED
2 = UNREGISTERED
3 = PENDING
4 = DECLINED
Scope of the Organization represented by an integer from 1 to 3
1 = OWNED_BRAND
2 = NATIONAL_BRAND
3 = BOTH
Zip / Postal code of the Organization
Province of the Organization
Date of registration of the Organization
Status of the registration of the Organization represented by an integer from 1 to 4
1 = REGISTERED
2 = UNREGISTERED
3 = PENDING
4 = DECLINED
Indicates by true or false whether the Factory requires Maintenance Audit
Possible values: [active
, inactive
, awaiting approval
, awaiting registration
, de-listed
, unapproved
]
Organization Status
Responses​
- 200
- 400
- 401
- 422
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
data
object
Possible values: non-empty
Address of the Organization
Possible values: [Fabric Supplier
, Trim Supplier
, Merchandise Vendor
, Packaging Supplier
, Production/Storage Facility Owner
]
List of business partner types of the Organization. This field is only used for an Organization of type 'partner'
The strategic business unit that the organization belongs to
The strategic business unit category that the organization belongs to
City of the Organization
contacts
object[]
nullable
List of contacts of the Organization
Possible values: non-empty
Email of the organization contact
Possible values: non-empty
First name of the organization contact
Unique identifier of the organization contact
Last name of the organization contact
Possible values: non-empty
Phone number of the organization contact
Country code of the phone number of a Contact
Possible values: >= 2 characters
and <= 2 characters
Country of the Organization represented by the standard ISO Alpha-2 code, e.g. US for the United States
The date the organization has been created
Possible values: [primary
, secondary
]
Factory Type
Possible values: non-empty
Unique identifier of an Organization
Indicates by true or false whether the Organization has the ability to produce food
The lead strategic business unit category that the organization belongs to
Lead Manager
location
object
Location of the Organization
Latitude location of the Organization
Longitude location of the Organization
Possible values: non-empty
Name of the Organization
partners
object[]
nullable
List of partner IDs of the Organization
Authorized capabilities of an Organization
Possible values: non-empty
Unique identifier of the Partner Organization
Indicates by true or false whether the Partner can be marked as a Lead Supplier for the Factory
Status of the Partner Organization between Available, In Progress, Non-Compliant, Pending Transfer, or Pending Duplicate Check
Types of manufacturing of the Organization represented by an integer from 1 to 5
1 = FACTORY
2 = MILL
3 = LAUNDRY
4 = PACKING
5 = TRIM
Possible values: non-empty
Name of the Partner Organization
Date of registration of the Partner Organization
Status of the registration of the Organization represented by an integer from 1 to 4
1 = REGISTERED
2 = UNREGISTERED
3 = PENDING
4 = DECLINED
Scope of the Organization represented by an integer from 1 to 3
1 = OWNED_BRAND
2 = NATIONAL_BRAND
3 = BOTH
Zip / Postal code of the Organization
Province of the Organization
Indicates by true or false whether the Factory requires Maintenance Audit
Possible values: [active
, inactive
, awaiting approval
, awaiting registration
, de-listed
, unapproved
]
Organization Status
Possible values: non-empty
The type of the Organization, e.g. 'factory' or 'partner'
The date the organization has been updated
{
"data": {
"address": "5 Park Avenue",
"businessPartnerTypes": [
"Fabric Supplier"
],
"businessUnit": "Central Europe",
"businessUnitCategories": [
"CZ / Bakery",
"HU / Bakery",
"SK / Bakery"
],
"city": "Minneapolis",
"contacts": [
{
"email": "[email protected]",
"firstName": "John",
"id": "U123456",
"lastName": "Doe",
"phone": "1505123456",
"phoneCountryCode": "1"
}
],
"country": "US",
"createdDate": "2020-04-21T12:36:43.693000+00:00",
"factoryType": "primary",
"id": "F123",
"isFoodFacility": true,
"leadBusinessUnitCategory": "CZ / Impulse",
"leadManager": "John Doe",
"location": {
"latitude": 38.8951,
"longitude": -77.0364
},
"name": "Acme Corp",
"partners": [
{
"authorizedCapabilities": [
"PRINTING"
],
"id": "P123",
"isLeadSupplier": true,
"locationStatus": "Available",
"manufacturingTypes": "1",
"name": "Lex Corp",
"registrationDate": "2020-04-21",
"registrationStatus": "1",
"scope": "1"
}
],
"postal": "55402",
"province": "Minnesota",
"requiresMaintenanceAudit": true,
"status": "awaiting approval",
"type": "factory",
"updatedDate": "2020-04-21T12:36:43.693000+00:00"
}
}
Bad request
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"message": "Bad Request"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"message": "Cannot retrieve session data because of expired token"
}
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"errors": {
"type": [
"Input type is not valid"
]
},
"message": "Validation error"
}
Internal Error
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"errors": {
"system": [
"Internal error detail message"
]
},
"message": "Internal server error"
}