API

Logistics APIs

GET logistics/carriers/{carrierId}

Carrier details for provided identifier

HTTP method GET
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 2094, version 14

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
1

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.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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
<Carrier>
2
     <CarrierId
CarrierId

Carrier identifier

>
{Integer}</CarrierId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
4
     <Status
Status

Status of carrier

Possible domain values can be found here

>
{Integer}</Status>
5
     <Name
Name

Name of carrier

>
{String}</Name>
6
     <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

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

This field is greyed out because it is an expandable field. You have to add $expand=TransportManagementSystem in your request URI to get this field

>
8
          <CarrierId
CarrierId

Carrier id in the external Transport Management System

This field is greyed out because it is an expandable field. You have to add $expand=TransportManagementSystem in your request URI to get this field

>
{String}</CarrierId>
9
          <APIKey
APIKey

Customer id in the external Transport Management System.

This field is greyed out because it is an expandable field. You have to add $expand=TransportManagementSystem in your request URI to get this field

>
{String}</APIKey>
10
          <APISecret
APISecret

Api key used in communication with external Transport Management System.

This field is greyed out because it is an expandable field. You have to add $expand=TransportManagementSystem in your request URI to get this field

>
{String}</APISecret>
11
     </TransportManagementSystem>
12
     <AssociatedSupplier
AssociatedSupplier

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

>
13
          <SupplierId
SupplierId

RamBase supplier identifier

>
{Integer}</SupplierId>
14
          <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>
{String}</Name>
15
          <SupplierLink
SupplierLink

RamBase supplier identifier

>
{String}</SupplierLink>
16
     </AssociatedSupplier>
17
</Carrier>
1
{
2
     "carrier": {
3
          "carrierId
CarrierId

Carrier identifier

":
"{Integer}",
4
          "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
5
          "status
Status

Status of carrier

Possible domain values can be found here

":
"{Integer}",
6
          "name
Name

Name of carrier

":
"{String}",
7
          "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

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

This field is greyed out because it is an expandable field. You have to add $expand=TransportManagementSystem in your request URI to get this field

":
{
9
               "carrierId
CarrierId

Carrier id in the external Transport Management System

This field is greyed out because it is an expandable field. You have to add $expand=TransportManagementSystem in your request URI to get this field

":
"{String}",
10
               "aPIKey
APIKey

Customer id in the external Transport Management System.

This field is greyed out because it is an expandable field. You have to add $expand=TransportManagementSystem in your request URI to get this field

":
"{String}",
11
               "aPISecret
APISecret

Api key used in communication with external Transport Management System.

This field is greyed out because it is an expandable field. You have to add $expand=TransportManagementSystem in your request URI to get this field

":
"{String}"
12
          },
13
          "associatedSupplier
AssociatedSupplier

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

":
{
14
               "supplierId
SupplierId

RamBase supplier identifier

":
"{Integer}",
15
               "name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

":
"{String}",
16
               "supplierLink
SupplierLink

RamBase supplier identifier

":
"{String}"
17
          }
18
     }
19
}

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 101119 HTTP 404 Shipping service was not found
Error 100053 HTTP 403 You have only admittance to your own suppliers
Error 101420 HTTP 404 Setting definition not found