Create Organization

POST 
/api/v1/organizations

Create Organization

Request

application/json

Body

address stringrequired

Possible values: non-empty

Address of the Organization

authorizedCapabilities string[]nullable

Possible values: non-empty

Authorized capabilities of an Organization

businessPartnerTypes string[]nullable

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'

businessUnit stringnullable

The strategic business unit that the organization belongs to

businessUnitCategories string[]nullable

The strategic business unit category that the organization belongs to

city stringnullable

City of the Organization

contacts

object[]

nullable

List of contacts of the Organization

Array [

email stringrequired

Possible values: non-empty

Email of the organization contact

firstName stringrequired

Possible values: non-empty

First name of the organization contact

id stringnullable

Unique identifier of the organization contact

lastName stringnullable

Last name of the organization contact

phone stringrequired

Possible values: non-empty

Phone number of the organization contact

phoneCountryCode stringnullable

Country code of the phone number of a Contact

]

country stringnullable

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

factoryType stringnullable

Possible values: [primary, secondary]

Factory Type

id stringrequired

Possible values: non-empty

Unique identifier of an Organization, e.g. F123

isFoodFacility boolean

Indicates by true or false whether the Organization has the ability to produce food

leadBusinessUnitCategory stringnullable

The lead strategic business unit category that the organization belongs to

leadManager stringnullable

Lead Manager

location

object

Location of the Organization

latitude numberrequired

Latitude location of the Organization

longitude numberrequired

Longitude location of the Organization

name stringrequired

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'

Array [

authorizedCapabilities string[]nullable

Possible values: non-empty

Authorized capabilities of an Organization

id stringrequired

Possible values: non-empty

Unique identifier of the Partner Organization

isLeadSupplier booleannullable

Indicates by true or false whether the Partner can be marked as a Lead Supplier for the Factory

locationStatus stringnullable

Status of the Partner Organization between Available, In Progress, Non-Compliant, Pending Transfer, or Pending Duplicate Check

manufacturingTypes integer[]nullable

Types of manufacturing of the Organization represented by an integer from 1 to 5
1 = FACTORY
2 = MILL
3 = LAUNDRY
4 = PACKING
5 = TRIM

name stringrequired

Possible values: non-empty

Name of the Partner Organization

registrationDate datenullable

Date of registration of the Partner Organization

registrationStatus integernullable

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 integernullable

Scope of the Organization represented by an integer from 1 to 3
1 = OWNED_BRAND
2 = NATIONAL_BRAND
3 = BOTH

]

postal stringnullable

Zip / Postal code of the Organization

province stringnullable

Province of the Organization

registrationDate datenullable

Date of registration of the Organization

registrationStatus integernullable

Status of the registration of the Organization represented by an integer from 1 to 4
1 = REGISTERED
2 = UNREGISTERED
3 = PENDING
4 = DECLINED

requiresMaintenanceAudit booleannullable

Indicates by true or false whether the Factory requires Maintenance Audit

status stringnullable

Possible values: [active, inactive, awaiting approval, awaiting registration, de-listed, unapproved]

Organization Status

type stringrequired

Possible values: [factory, partner]

The type of the Organization, e.g. 'factory' or 'partner'

Responses

201

Created

application/json

Schema

Schema

data

object

address stringrequired

Possible values: non-empty

Address of the Organization

businessPartnerTypes string[]nullable

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'

businessUnit stringnullable

The strategic business unit that the organization belongs to

businessUnitCategories string[]nullable

The strategic business unit category that the organization belongs to

city stringnullable

City of the Organization

contacts

object[]

nullable

List of contacts of the Organization

Array [

email stringrequired

Possible values: non-empty

Email of the organization contact

firstName stringrequired

Possible values: non-empty

First name of the organization contact

id stringnullable

Unique identifier of the organization contact

lastName stringnullable

Last name of the organization contact

phone stringrequired

Possible values: non-empty

Phone number of the organization contact

phoneCountryCode stringnullable

Country code of the phone number of a Contact

]

country stringnullable

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

createdDate date-timenullable

The date the organization has been created

factoryType stringnullable

Possible values: [primary, secondary]

Factory Type

id stringrequired

Possible values: non-empty

Unique identifier of an Organization

isFoodFacility boolean

Indicates by true or false whether the Organization has the ability to produce food

leadBusinessUnitCategory stringnullable

The lead strategic business unit category that the organization belongs to

leadManager stringnullable

Lead Manager

location

object

Location of the Organization

latitude numberrequired

Latitude location of the Organization

longitude numberrequired

Longitude location of the Organization

name stringrequired

Possible values: non-empty

Name of the Organization

partners

object[]

nullable

List of partner IDs of the Organization

Array [

authorizedCapabilities string[]nullable

Authorized capabilities of an Organization

id stringrequired

Possible values: non-empty

Unique identifier of the Partner Organization

isLeadSupplier booleannullable

Indicates by true or false whether the Partner can be marked as a Lead Supplier for the Factory

locationStatus stringnullable

Status of the Partner Organization between Available, In Progress, Non-Compliant, Pending Transfer, or Pending Duplicate Check

manufacturingTypes string[]nullable

Types of manufacturing of the Organization represented by an integer from 1 to 5
1 = FACTORY
2 = MILL
3 = LAUNDRY
4 = PACKING
5 = TRIM

name stringrequired

Possible values: non-empty

Name of the Partner Organization

registrationDate datenullable

Date of registration of the Partner Organization

registrationStatus stringnullable

Status of the registration of the Organization represented by an integer from 1 to 4
1 = REGISTERED
2 = UNREGISTERED
3 = PENDING
4 = DECLINED

scope stringnullable

Scope of the Organization represented by an integer from 1 to 3
1 = OWNED_BRAND
2 = NATIONAL_BRAND
3 = BOTH

]

postal stringnullable

Zip / Postal code of the Organization

province stringnullable

Province of the Organization

requiresMaintenanceAudit booleannullable

Indicates by true or false whether the Factory requires Maintenance Audit

status stringnullable

Possible values: [active, inactive, awaiting approval, awaiting registration, de-listed, unapproved]

Organization Status

type stringrequired

Possible values: non-empty

The type of the Organization, e.g. 'factory' or 'partner'

updatedDate date-timenullable

The date the organization has been updated

Example (from schema)

{
  "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"
  }
}

400

Bad request

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

422

Validation Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "type": [
      "Input type is not valid"
    ]
  },
  "message": "Validation error"
}

500

Internal Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Loading...