Jasmin Developers - Web API Reference

Logistics | Delivery Term

Service to manage entities of type 'DeliveryTerm'.

Overview


URL api/{tenantKey}/{orgKey}/logisticsCore/deliveryTerms
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 DeliveryTerms (odata)

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

The following elements are optional:

opts (ODataQueryOptions) OData query option.

Response:

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

Response status codes:

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

Resource URL:

GET /logisticsCore/deliveryTerms/odata

GET DeliveryTerm 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 DeliveryTermResource.

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/deliveryTerms/{id}

GET DeliveryTerm by key

Returns the entity record that matches the specified key.

The following elements are required:

deliveryTermKey (string) The key for the delivery term.

Response:

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

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/deliveryTerms/{deliveryTermKey}

POST Operations

POST DeliveryTerms

Creates a new entity record.

The following elements are required:

deliveryTermResource (ApiDeliveryTermResource) The request body should contain the entity record that should be created.
See ApiDeliveryTermResource.

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 ApiDeliveryTermResource.

Response status codes:

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

Resource URL:

POST /logisticsCore/deliveryTerms

PUT Operations

PUT Set DeliveryTermKey DeliveryTerm

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

The following elements are required:

deliveryTermKey (string) The key for the delivery term.
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/deliveryTerms/{deliveryTermKey}/deliveryTermKey

PUT Set Description DeliveryTerm

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

The following elements are required:

deliveryTermKey (string) The key for the delivery term.
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/deliveryTerms/{deliveryTermKey}/description

PUT Set IsActive DeliveryTerm

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

The following elements are required:

deliveryTermKey (string) The key for the delivery term.
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/deliveryTerms/{deliveryTermKey}/isActive

DELETE Operations

DELETE DeliveryTerm 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/deliveryTerms/{id}

DELETE DeliveryTerm by key

Deletes the entity record that matches the specified key.

The following elements are required:

deliveryTermKey (string) The key for the delivery term.

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/deliveryTerms/{deliveryTermKey}

Resources


ApiDeliveryTermResource

The following elements are required:

deliveryTermKey (string) The key for the delivery term.

The following elements are optional:

description (string) The description for the delivery term.


DeliveryTermResource

The following elements are required:

deliveryTermKey (string) The key for the delivery term.

The following elements are optional:

description (string) The description for the delivery term.