Edit

Share via

Create shipmentMethods

  • Article

Create a shipment method object in Business Central.

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

POST businesscentralPrefix/companies({id})/shipmentMethods

Optional query parameters

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json
If-Match Required. When this request header is included and the eTag provided does not match the current tag on the shipmentMethod, the shipmentMethod will not be updated.

Request body

In the request body, supply a JSON representation of a shipmentMethods object.

Response

If successful, this method returns 201 Created response code and a shipmentMethods object in the response body.

Example

Request

Here is an example of a request.

POST https://{businesscentralPrefix}/api/v2.0/companies({id})/shipmentMethods
Content-type: application/json

{
    "id": "87a5738a-44e3-ea11-bb43-000d3a2feca1",
    "code": "CFR",
    "displayName": "Cost and Freight",
    "lastModifiedDateTime": "2020-08-21T00:24:14.287Z"
}

Response

Here is an example of the response.

Note

The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-type: application/json

{
    "id": "87a5738a-44e3-ea11-bb43-000d3a2feca1",
    "code": "CFR",
    "displayName": "Cost and Freight",
    "lastModifiedDateTime": "2020-08-21T00:24:14.287Z"
}

Tips for working with the APIs
shipmentmethod
Get shipmentmethod
Delete shipmentmethod
Update shipmentmethod