ROSE Developers - Web API Reference

Logistics | Delivery Mode

The delivery mode entity represents the transport mode than can be attributed to a delivery.

Overview


URL api/{tenantKey}/{orgKey}/logisticsCore/deliveryModes
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET DeliveryModes

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See DeliveryModeResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /logisticsCore/deliveryModes

GET DeliveryModes (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page (int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See DeliveryModeResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /logisticsCore/deliveryModes?page={page}&pageSize={pageSize}

GET DeliveryMode by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body contains the entity record. See DeliveryModeResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /logisticsCore/deliveryModes/{id}

GET DeliveryMode by key

Returns the entity record that matches the specified key.

The following elements are required:

deliveryModeKey (string) The key for the delivery mode.

Response:

When successful, the response body contains the entity record. See DeliveryModeResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /logisticsCore/deliveryModes/{deliveryModeKey}

GET Print DeliveryMode by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /logisticsCore/deliveryModes/{id}/print?template={template}

GET Print DeliveryMode by key

Prints the specified entity record.

The following elements are required:

deliveryModeKey (string) The key for the delivery mode.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /logisticsCore/deliveryModes/{deliveryModeKey}/print

GET Original Print DeliveryModeOriginal by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /logisticsCore/deliveryModes/{id}/printOriginal?template={template}

GET Original Print DeliveryMode by key

Prints the specified entity record.

The following elements are required:

deliveryModeKey (string) The key for the delivery mode.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /logisticsCore/deliveryModes/{deliveryModeKey}/printOriginal

POST Operations

POST DeliveryModes

Creates a new entity record.

The following elements are required:

deliveryModeResource (ApiDeliveryModeResource) The request body should contain the entity record that should be created.
See ApiDeliveryModeResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiDeliveryModeResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /logisticsCore/deliveryModes

PUT Operations

PUT Set DeliveryModeKey DeliveryMode

Updates the value of attribute 'DeliveryModeKey' in the specified entity record.

The following elements are required:

deliveryModeKey (string) The key for the delivery mode.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /logisticsCore/deliveryModes/{deliveryModeKey}/deliveryModeKey

PUT Set Description DeliveryMode

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

deliveryModeKey (string) The key for the delivery mode.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /logisticsCore/deliveryModes/{deliveryModeKey}/description

PUT Set IsActive DeliveryMode

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

deliveryModeKey (string) The key for the delivery mode.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /logisticsCore/deliveryModes/{deliveryModeKey}/isActive

PUT Set Custom Attribute DeliveryMode

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

deliveryModeKey (string) The key for the delivery mode.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /logisticsCore/deliveryModes/{deliveryModeKey}/{customAttributeName}

DELETE Operations

DELETE DeliveryMode by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /logisticsCore/deliveryModes/{id}

DELETE DeliveryMode by key

Deletes the entity record that matches the specified key.

The following elements are required:

deliveryModeKey (string) The key for the delivery mode.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /logisticsCore/deliveryModes/{deliveryModeKey}

Resources


ApiDeliveryModeResource

The following elements are required:

deliveryModeKey (string) The key for the delivery mode.

The following elements are optional:

description (string) The description of the delivery mode. (ex: mail).


DeliveryModeResource

The following elements are required:

deliveryModeKey (string) The key for the delivery mode.

The following elements are optional:

description (string) The description of the delivery mode. (ex: mail).


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.