Shipment API

Organization Management

Endpoint

Download schema

List all organizations

GET

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

/organizations

Returns a list of all organizations in the hierarchy

List all organizations › Responses

200

List of organizations

A shipping organization that can have sub-organizations (e.g. regional offices)

id

string · pattern: ^[a-zA-Z0-9-]+$ · required

Unique identifier for the organization

name

string · minLength: 1 · maxLength: 200 · required

Name of the organization

parent

circular

sub

array · maxItems: 100 · sub (circular)

Child organizations (array circular reference)

GET/organizations

const options = {method: 'GET'};

fetch('https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io//organizations', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

View External Example

application/json

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

A shipping organization that can have sub-organizations (e.g. regional offices)

id

string · pattern: ^[a-zA-Z0-9-]+$ · required

Unique identifier for the organization

name

string · minLength: 1 · maxLength: 200 · required

Name of the organization

parent

circular

sub

array · maxItems: 100 · sub (circular)

Child organizations (array circular reference)

Create a new organization › Responses

Organization created

A shipping organization that can have sub-organizations (e.g. regional offices)

id

string · pattern: ^[a-zA-Z0-9-]+$ · required

Unique identifier for the organization

name

string · minLength: 1 · maxLength: 200 · required

Name of the organization

parent

circular

sub

array · maxItems: 100 · sub (circular)

Child organizations (array circular reference)

POST/organizations

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({id: 'id', name: 'name', sub: [null]})
};

fetch('https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io//organizations', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Request Body

{
  "id": "id",
  "name": "name",
  "sub": [
    null
  ]
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "sub": [
    null
  ]
}

json

application/json

Schemas Route Planning

List all organizations

GET

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

/organizations

Returns a list of all organizations in the hierarchy

List all organizations › Responses

200

List of organizations

A shipping organization that can have sub-organizations (e.g. regional offices)

id

string · pattern: ^[a-zA-Z0-9-]+$ · required

Unique identifier for the organization

name

string · minLength: 1 · maxLength: 200 · required

Name of the organization

parent

circular

sub

array · 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

A shipping organization that can have sub-organizations (e.g. regional offices)

id

string · pattern: ^[a-zA-Z0-9-]+$ · required

Unique identifier for the organization

name

string · minLength: 1 · maxLength: 200 · required

Name of the organization

parent

circular

sub

array · maxItems: 100 · sub (circular)

Child organizations (array circular reference)

Create a new organization › Responses

Organization created

A shipping organization that can have sub-organizations (e.g. regional offices)

id

string · pattern: ^[a-zA-Z0-9-]+$ · required

Unique identifier for the organization

name

string · minLength: 1 · maxLength: 200 · required

Name of the organization

parent

circular

sub

array · maxItems: 100 · sub (circular)

Child organizations (array circular reference)