Logistics | Shipping Method

Service to manage entities of type 'ShippingMethod'.

Overview

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods

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

All Operations

This service includes the following operations:

GET:
POST:
- POST ShippingMethods
- POST Shipping Method Detail
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiShippingMethodResource
ApiShippingMethodShippingMethodDetailsResource
MoneyResource
ShippingMethodResource

GET Operations

GET ShippingMethods (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 ShippingMethodResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/odata

GET /logisticsCore/shippingMethods/odata

GET ShippingMethod 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 ShippingMethodResource.

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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{id}

GET /logisticsCore/shippingMethods/{id}

GET ShippingMethod by key

Returns the entity record that matches the specified key.

The following elements are required:

shippingMethodKey

(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.

Response:

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

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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}

GET /logisticsCore/shippingMethods/{shippingMethodKey}

POST Operations

POST ShippingMethods

Creates a new entity record.

The following elements are required:

shippingMethodResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods

POST /logisticsCore/shippingMethods

POST Shipping Method Detail

Inserts a new 'Shipping Method Detail' in the 'Shipping Method'.

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
value	(ApiShippingMethodShippingMethodDetailsResource) The ApiShippingMethodShippingMethodDetailsResource instance. See ApiShippingMethodShippingMethodDetailsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodDetails

POST /logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodDetails

PUT Operations

PUT Set AdditionalWeight ShippingMethod

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
value	(decimal) 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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/additionalWeight

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/additionalWeight

PUT Set AdditionalWeightPrice ShippingMethod

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
value	(decimal) 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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/additionalWeightPrice

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/additionalWeightPrice

PUT Set Currency ShippingMethod

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/currency

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/currency

PUT Set Currency ShippingMethodDetail

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
lineId	(string) The detail identifier.
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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodDetails/{lineId}/currency

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodDetails/{lineId}/currency

PUT Set DeliverySpeed ShippingMethod

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
value	(int) 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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/deliverySpeed

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/deliverySpeed

PUT Set DeliveryTerm ShippingMethod

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/deliveryTerm

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/deliveryTerm

PUT Set Description ShippingMethod

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/description

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/description

PUT Set FreeShipping ShippingMethod

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
value	(decimal) 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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/freeShipping

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/freeShipping

PUT Set From ShippingMethodDetail

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
lineId	(string) The detail identifier.
value	(decimal) 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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodDetails/{lineId}/from

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodDetails/{lineId}/from

PUT Set IsActive ShippingMethod

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/isActive

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/isActive

PUT Set ShippingMethodKey ShippingMethod

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodKey

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodKey

PUT Set ShippingValue ShippingMethodDetail

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
lineId	(string) The detail identifier.
value	(decimal) 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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodDetails/{lineId}/shippingValue

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodDetails/{lineId}/shippingValue

PUT Set To ShippingMethodDetail

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
lineId	(string) The detail identifier.
value	(decimal) 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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodDetails/{lineId}/to

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodDetails/{lineId}/to

PUT Set Unit ShippingMethod

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

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/unit

PUT /logisticsCore/shippingMethods/{shippingMethodKey}/unit

DELETE Operations

DELETE Shipping Method Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodDetails/{lineId}

DELETE /logisticsCore/shippingMethods/{shippingMethodKey}/shippingMethodDetails/{lineId}

DELETE ShippingMethod 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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{id}

DELETE /logisticsCore/shippingMethods/{id}

DELETE ShippingMethod by key

Deletes the entity record that matches the specified key.

The following elements are required:

shippingMethodKey

(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.

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:

api/{tenantKey}/{orgKey}/logisticsCore/shippingMethods/{shippingMethodKey}

DELETE /logisticsCore/shippingMethods/{shippingMethodKey}

Resources

ApiShippingMethodResource

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
additionalWeight	(decimal) The shipping method's additional weight.
additionalWeightPrice	(MoneyResource) The shipping method's additional weight price. See MoneyResource .
freeShipping	(MoneyResource) The shipping method's free shipping amount. See MoneyResource .
deliveryTerm	(string) The delivery term for the shipping method.
unit	(string) The unit for the shipping method.
currency	(string) The currency for the shipping method.

The following elements are optional:

description	(string) The description for the shipping method.
deliverySpeed	(int) The shipping method delivery speed in work days.
shippingMethodDetails	(List of ApiShippingMethodShippingMethodDetailsResource) The details of the shipping method. See ApiShippingMethodShippingMethodDetailsResource.

ApiShippingMethodShippingMethodDetailsResource

The following elements are required:

from	(decimal) The min weigth for the item for the shipping value.
to	(decimal) The max weigth for the item for the shipping value.
shippingValue	(MoneyResource) The shipping value for the shipping method detail. See MoneyResource .
currency	(string) The currency for the shipping method detail.

MoneyResource

The following elements are required:

amount

(decimal) The amount.

The following elements are optional:

baseAmount	(decimal) The base amount.
reportingAmount	(decimal) The reporting amount.
fractionDigits	(int) The fraction digits.
symbol	(string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.

ShippingMethodResource

The following elements are required:

shippingMethodKey	(string) The key of the shipping method. The shipping method that the user can select before finalize the purchase.
additionalWeight	(decimal) The shipping method's additional weight.
additionalWeightPrice	(MoneyResource) The shipping method's additional weight price. See MoneyResource .
freeShipping	(MoneyResource) The shipping method's free shipping amount. See MoneyResource .
deliveryTerm	(string) The delivery term for the shipping method. (fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service.
unit	(string) The unit for the shipping method. (fk) Allowed value: the natural key of a record of type Unit. These records are accessibly through the Units service.
currency	(string) The currency for the shipping method. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.

The following elements are optional:

description	(string) The description for the shipping method.
deliverySpeed	(int) The shipping method delivery speed in work days.
shippingMethodDetails	(List of ShippingMethodDetailResource) The details of the shipping method. See ShippingMethodDetailResource.