API

Logistics APIs

PUT logistics/carriers/{carrierId}

Update carrier

HTTP method PUT
URI https://api.rambase.net/logistics/carriers/{carrierId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {carrierId} Carrier identifier
Integer, minimum 1000
Successful HTTP status code 200
API resource identifier 4037, version 3

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Carrier
Carrier

This field is optional.

>
2
     <Name
Name

Name of carrier

This field is optional.

>{String}</Name>
3
     <AutomatedConfirmationOfWaybillHandover
AutomatedConfirmationOfWaybillHandover

Departing way bills with reference to this carrier will automatically be handed over to carrier (changed to status 9) by a batch that runs regularly

This field is optional.

>{Boolean}</AutomatedConfirmationOfWaybillHandover>
4
     <TransportManagementSystem
TransportManagementSystem

This field is optional.

>
5
          <CarrierId
CarrierId

Carrier id in the external Transport Management System

This field is optional.

>{String}</CarrierId>
6
     </TransportManagementSystem>
7
     <AssociatedSupplier
AssociatedSupplier

Reference to supplier if the carrier is also a supplier to the company.

This field is optional.

>
8
          <SupplierId
SupplierId

RamBase supplier identifier

Minimum value: 100

This field is optional.

>{Integer}</SupplierId>
9
     </AssociatedSupplier>
10
</Carrier>
1
{
2
     "carrier
Carrier

This field is optional.

": {
3
          "name
Name

Name of carrier

This field is optional.

": "{String}",
4
          "automatedConfirmationOfWaybillHandover
AutomatedConfirmationOfWaybillHandover

Departing way bills with reference to this carrier will automatically be handed over to carrier (changed to status 9) by a batch that runs regularly

This field is optional.

": "{Boolean}",
5
          "transportManagementSystem
TransportManagementSystem

This field is optional.

": {
6
               "carrierId
CarrierId

Carrier id in the external Transport Management System

This field is optional.

": "{String}"
7
          },
8
          "associatedSupplier
AssociatedSupplier

Reference to supplier if the carrier is also a supplier to the company.

This field is optional.

": {
9
               "supplierId
SupplierId

RamBase supplier identifier

Minimum value: 100

This field is optional.

": "{Integer}"
10
          }
11
     }
12
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101079 HTTP 400 Mismatch in size of revision parameters