Shipment API

Organization Management

Endpoint

List all organizations

GET

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/organizations

Returns a list of all organizations in the hierarchy

List all organizations › Responses

List of organizations

idstring · pattern: ^[a-zA-Z0-9-]+$ · required
Unique identifier for the organization
namestring · minLength: 1 · maxLength: 200 · required
Name of the organization

parentcircular
subarray · maxItems: 100 · sub (circular)
Child organizations (array circular reference)

Create a new organization

POST

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/organizations

Creates a new organization, optionally as part of an existing hierarchy

Create a new organization › Request Body

idstring · pattern: ^[a-zA-Z0-9-]+$ · required
Unique identifier for the organization
namestring · minLength: 1 · maxLength: 200 · required
Name of the organization

parentcircular
subarray · maxItems: 100 · sub (circular)
Child organizations (array circular reference)

Create a new organization › Responses

Organization created

idstring · pattern: ^[a-zA-Z0-9-]+$ · required
Unique identifier for the organization
namestring · minLength: 1 · maxLength: 200 · required
Name of the organization

parentcircular
subarray · maxItems: 100 · sub (circular)
Child organizations (array circular reference)

Schemas Route Planning

Shipment API

Organization Management

Endpoint

List all organizations

GET

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/organizations

Returns a list of all organizations in the hierarchy

List all organizations › Responses

List of organizations

idstring · pattern: ^[a-zA-Z0-9-]+$ · required
Unique identifier for the organization
namestring · minLength: 1 · maxLength: 200 · required
Name of the organization

parentcircular
subarray · maxItems: 100 · sub (circular)
Child organizations (array circular reference)

Create a new organization

POST

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/organizations

Creates a new organization, optionally as part of an existing hierarchy

Create a new organization › Request Body

idstring · pattern: ^[a-zA-Z0-9-]+$ · required
Unique identifier for the organization
namestring · minLength: 1 · maxLength: 200 · required
Name of the organization

parentcircular
subarray · maxItems: 100 · sub (circular)
Child organizations (array circular reference)

Create a new organization › Responses

Organization created

idstring · pattern: ^[a-zA-Z0-9-]+$ · required
Unique identifier for the organization
namestring · minLength: 1 · maxLength: 200 · required
Name of the organization

parentcircular
subarray · maxItems: 100 · sub (circular)
Child organizations (array circular reference)

Schemas Route Planning