Skip to content

Latest commit

 

History

History
889 lines (566 loc) · 25.1 KB

LogisticsApi.md

File metadata and controls

889 lines (566 loc) · 25.1 KB

MissionControl.LogisticsApi

All URIs are relative to https://mc.zaikio.com/api/v1/

Method HTTP request Description
commissioningsCommissioningIdDelete DELETE /commissionings/{commissioning_id}
commissioningsCommissioningIdGet GET /commissionings/{commissioning_id}
commissioningsCommissioningIdPatch PATCH /commissionings/{commissioning_id}
commissioningsCommissioningIdPickupsGet GET /commissionings/{commissioning_id}/pickups
commissioningsCommissioningIdPickupsPost POST /commissionings/{commissioning_id}/pickups
commissioningsCommissioningIdShipmentsGet GET /commissionings/{commissioning_id}/shipments
commissioningsCommissioningIdShipmentsPost POST /commissionings/{commissioning_id}/shipments
commissioningsGet GET /commissionings
commissioningsPost POST /commissionings
pickupsPickupIdDelete DELETE /pickups/{pickup_id}
pickupsPickupIdGet GET /pickups/{pickup_id}
pickupsPickupIdPatch PATCH /pickups/{pickup_id}
shipmentsShipmentIdAddressDelete DELETE /shipments/{shipment_id}/address
shipmentsShipmentIdAddressGet GET /shipments/{shipment_id}/address
shipmentsShipmentIdAddressPatch PATCH /shipments/{shipment_id}/address
shipmentsShipmentIdAddressPost POST /shipments/{shipment_id}/address
shipmentsShipmentIdDelete DELETE /shipments/{shipment_id}
shipmentsShipmentIdGet GET /shipments/{shipment_id}
shipmentsShipmentIdPatch PATCH /shipments/{shipment_id}

commissioningsCommissioningIdDelete

commissioningsCommissioningIdDelete(commissioningId)

Removes a commissioning. - needed bearer: `Organization` or `Person` - needed scopes: `mission-control.commissionings.w`

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let commissioningId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.commissioningsCommissioningIdDelete(commissioningId).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
commissioningId String

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

commissioningsCommissioningIdGet

Commissioning commissioningsCommissioningIdGet(commissioningId)

Returns a specific commissioning. - needed bearer: `Organization` or `Person` - needed scopes: `mission-control.commissionings.r`

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let commissioningId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.commissioningsCommissioningIdGet(commissioningId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
commissioningId String

Return type

Commissioning

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

commissioningsCommissioningIdPatch

Commissioning commissioningsCommissioningIdPatch(body, commissioningId)

Modifies a commissioning. - needed bearer: `Organization` or `Person` - needed scopes: `mission-control.commissionings.w`

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let body = new MissionControl.CommissioningsCommissioningIdBody(); // CommissioningsCommissioningIdBody | 
let commissioningId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.commissioningsCommissioningIdPatch(body, commissioningId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body CommissioningsCommissioningIdBody
commissioningId String

Return type

Commissioning

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

commissioningsCommissioningIdPickupsGet

[Pickup] commissioningsCommissioningIdPickupsGet(commissioningId, opts)

Get all pickups of a commissioning. - needed bearer: `Organization` or `Person` - needed scopes: `mission-control.commissionings.r`

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let commissioningId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 
let opts = { 
  'page': 56, // Number | The page of the current collection that shall be returned
  'perPage': 100 // Number | The maximum number of items included in the response, ie., the page size
};
apiInstance.commissioningsCommissioningIdPickupsGet(commissioningId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
commissioningId String
page Number The page of the current collection that shall be returned [optional]
perPage Number The maximum number of items included in the response, ie., the page size [optional] [default to 100]

Return type

[Pickup]

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

commissioningsCommissioningIdPickupsPost

Pickup commissioningsCommissioningIdPickupsPost(body, commissioningId)

Creates a pickup. - needed bearer: `Organization` or `Person` - needed scopes:

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let body = new MissionControl.CommissioningIdPickupsBody(); // CommissioningIdPickupsBody | 
let commissioningId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.commissioningsCommissioningIdPickupsPost(body, commissioningId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body CommissioningIdPickupsBody
commissioningId String

Return type

Pickup

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

commissioningsCommissioningIdShipmentsGet

[Shipment] commissioningsCommissioningIdShipmentsGet(commissioningId, opts)

Get all shipments of a commissioning. - needed bearer: `Organization` - needed scopes: `mission-control.commissionings.r`

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let commissioningId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 
let opts = { 
  'page': 56, // Number | The page of the current collection that shall be returned
  'perPage': 100 // Number | The maximum number of items included in the response, ie., the page size
};
apiInstance.commissioningsCommissioningIdShipmentsGet(commissioningId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
commissioningId String
page Number The page of the current collection that shall be returned [optional]
perPage Number The maximum number of items included in the response, ie., the page size [optional] [default to 100]

Return type

[Shipment]

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

commissioningsCommissioningIdShipmentsPost

InlineResponse2013 commissioningsCommissioningIdShipmentsPost(body, commissioningId)

Creates a shipment. - needed bearer: `Organization` - needed scopes:

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let body = new MissionControl.CommissioningIdShipmentsBody(); // CommissioningIdShipmentsBody | 
let commissioningId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.commissioningsCommissioningIdShipmentsPost(body, commissioningId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body CommissioningIdShipmentsBody
commissioningId String

Return type

InlineResponse2013

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

commissioningsGet

[Commissioning] commissioningsGet(opts)

Get all commissionings. - needed bearer: `Organization` or `Person` - needed scopes: `mission-control.commissionings.r`

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let opts = { 
  'page': 56, // Number | The page of the current collection that shall be returned
  'perPage': 100 // Number | The maximum number of items included in the response, ie., the page size
};
apiInstance.commissioningsGet(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
page Number The page of the current collection that shall be returned [optional]
perPage Number The maximum number of items included in the response, ie., the page size [optional] [default to 100]

Return type

[Commissioning]

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

commissioningsPost

Commissioning commissioningsPost(body)

Creates a commissioning. - needed bearer: `Organization` or `Person` - needed scopes: `mission-control.commissionings.w`

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let body = new MissionControl.CommissioningsBody(); // CommissioningsBody | 

apiInstance.commissioningsPost(body).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body CommissioningsBody

Return type

Commissioning

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

pickupsPickupIdDelete

pickupsPickupIdDelete(pickupId)

Removes a pickup. - needed bearer: `Organization` or `Person` - needed scopes:

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let pickupId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.pickupsPickupIdDelete(pickupId).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
pickupId String

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

pickupsPickupIdGet

Pickup pickupsPickupIdGet(pickupId)

Returns a specific pickup. - needed bearer: `Organization` or `Person` - needed scopes: `mission-control.commissionings.r`

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let pickupId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.pickupsPickupIdGet(pickupId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
pickupId String

Return type

Pickup

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

pickupsPickupIdPatch

Pickup pickupsPickupIdPatch(body, pickupId)

Modifies pickup. - needed bearer: `Organization` or `Person` - needed scopes:

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let body = new MissionControl.PickupsPickupIdBody(); // PickupsPickupIdBody | 
let pickupId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.pickupsPickupIdPatch(body, pickupId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body PickupsPickupIdBody
pickupId String

Return type

Pickup

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

shipmentsShipmentIdAddressDelete

shipmentsShipmentIdAddressDelete(shipmentId)

Removes the address from a specific shipment as long as the shipment is in a `waiting_for_commission` state. - needed bearer: `Organization` or `Person` - needed scopes:

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let shipmentId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.shipmentsShipmentIdAddressDelete(shipmentId).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
shipmentId String

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

shipmentsShipmentIdAddressGet

Address shipmentsShipmentIdAddressGet(shipmentId)

Returns the address for this shipment. - needed bearer: `Organization` or `Person` - needed scopes: `mission-control.commissionings.r`

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let shipmentId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.shipmentsShipmentIdAddressGet(shipmentId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
shipmentId String

Return type

Address

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

shipmentsShipmentIdAddressPatch

Address shipmentsShipmentIdAddressPatch(body, shipmentId)

Modifies the address from a specific shipment as long as the shipment is still in a `waiting_for_commission` state. - needed bearer: `Organization` or `Person` - needed scopes:

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let body = new MissionControl.ShipmentIdAddressBody1(); // ShipmentIdAddressBody1 | 
let shipmentId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.shipmentsShipmentIdAddressPatch(body, shipmentId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body ShipmentIdAddressBody1
shipmentId String

Return type

Address

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

shipmentsShipmentIdAddressPost

Address shipmentsShipmentIdAddressPost(body, shipmentId)

Creates new address. If an address is already present, it will be overwritten. Creating an address is only possible as long as the shipment is in a `waiting_for_commission` state. - needed bearer: `Organization` or `Person` - needed scopes:

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let body = new MissionControl.ShipmentIdAddressBody(); // ShipmentIdAddressBody | 
let shipmentId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.shipmentsShipmentIdAddressPost(body, shipmentId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body ShipmentIdAddressBody
shipmentId String

Return type

Address

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

shipmentsShipmentIdDelete

shipmentsShipmentIdDelete(shipmentId)

Removes a shipment. - needed bearer: `Organization` - needed scopes:

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let shipmentId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.shipmentsShipmentIdDelete(shipmentId).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
shipmentId String

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

shipmentsShipmentIdGet

InlineResponse2013 shipmentsShipmentIdGet(shipmentId)

Returns a specific shipment. - needed bearer: `Organization` - needed scopes: `mission-control.commissionings.r`

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let shipmentId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.shipmentsShipmentIdGet(shipmentId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
shipmentId String

Return type

InlineResponse2013

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

shipmentsShipmentIdPatch

InlineResponse2013 shipmentsShipmentIdPatch(body, shipmentId)

Modifies a shipment. - needed bearer: `Organization` - needed scopes:

Example

import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;


let apiInstance = new MissionControl.LogisticsApi();
let body = new MissionControl.ShipmentsShipmentIdBody(); // ShipmentsShipmentIdBody | 
let shipmentId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String | 

apiInstance.shipmentsShipmentIdPatch(body, shipmentId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body ShipmentsShipmentIdBody
shipmentId String

Return type

InlineResponse2013

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json