API

Logistics APIs

GET logistics/departing-waybills/{departingWaybillId}

Departing waybill details for provided identifier

HTTP method GET
URI https://api.rambase.net/logistics/departing-waybills/{departingWaybillId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {departingWaybillId} Departing waybill identifier
Integer, minimum 10000
Successful HTTP status code 200
API resource identifier 548, version 13

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.

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
<DepartingWaybill>
2
     <DepartingWaybillId
DepartingWaybillId

Departing waybill identifier

>{Integer}</DepartingWaybillId>
3
     <Status
Status

Status of departing waybill

Possible domain values can be found here

>{Integer}</Status>
4
     <Note
Note

Note or remark for this departing waybill

>{String}</Note>
5
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
     <RegistrationDate
RegistrationDate

The date when the departing way bill was registered

>{Date}</RegistrationDate>
7
     <RegistrationTime
RegistrationTime

The time of the day the departing way bill is scheduled to be automatically registed, or the real registration time if it was done manually at another time than the scheduled one.

>{Time}</RegistrationTime>
8
     <ShipToCountryCode
ShipToCountryCode

Two-character code (ISO 3166) identifying the country this consignment is shipped to.

>{String}</ShipToCountryCode>
9
     <WeightUnit
WeightUnit

Unit used for measuring weight on the consignment in this departing waybill.

Possible domain values can be found here

>{String}</WeightUnit>
10
     <AccountingPeriod>
11
          <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
12
          <Period
Period

Accounting period

>{Integer}</Period>
13
          <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
14
     </AccountingPeriod>
15
     <CreatedBy
CreatedBy

The user that created this object

>
16
          <UserId
UserId

User identifier

>{Integer}</UserId>
17
          <Name
Name

Name of the user

>{String}</Name>
18
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
19
          <UserLink
UserLink

User reference

>{String}</UserLink>
20
     </CreatedBy>
21
     <Carrier>
22
          <CarrierId
CarrierId

Carrier identifier

>{Integer}</CarrierId>
23
          <Name
Name

Name of carrier

>{String}</Name>
24
          <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
25
     </Carrier>
26
     <Location>
27
          <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
28
          <Name
Name

Name of location

>{String}</Name>
29
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
30
          <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
31
     </Location>
32
     <Totals>
33
          <Packages
Packages

Accumulated number of packages from the shipments that are assigned to this departing waybill.

>{Integer}</Packages>
34
          <Weight
Weight

Accumulated gross weight from the shipments that are assigned to this departing waybill

>{Decimal}</Weight>
35
     </Totals>
36
</DepartingWaybill>
1
{
2
     "departingWaybill": {
3
          "departingWaybillId
DepartingWaybillId

Departing waybill identifier

": "{Integer}",
4
          "status
Status

Status of departing waybill

Possible domain values can be found here

": "{Integer}",
5
          "note
Note

Note or remark for this departing waybill

": "{String}",
6
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
          "registrationDate
RegistrationDate

The date when the departing way bill was registered

": "{Date}",
8
          "registrationTime
RegistrationTime

The time of the day the departing way bill is scheduled to be automatically registed, or the real registration time if it was done manually at another time than the scheduled one.

": "{Time}",
9
          "shipToCountryCode
ShipToCountryCode

Two-character code (ISO 3166) identifying the country this consignment is shipped to.

": "{String}",
10
          "weightUnit
WeightUnit

Unit used for measuring weight on the consignment in this departing waybill.

Possible domain values can be found here

": "{String}",
11
          "accountingPeriod": {
12
               "accountingPeriodId
AccountingPeriodId

Accounting period identifier

": "{Integer}",
13
               "period
Period

Accounting period

": "{Integer}",
14
               "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
15
          },
16
          "createdBy
CreatedBy

The user that created this object

": {
17
               "userId
UserId

User identifier

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

Name of the user

": "{String}",
19
               "firstName
FirstName

First name of the user

": "{String}",
20
               "userLink
UserLink

User reference

": "{String}"
21
          },
22
          "carrier": {
23
               "carrierId
CarrierId

Carrier identifier

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

Name of carrier

": "{String}",
25
               "carrierLink
CarrierLink

Carrier reference

": "{String}"
26
          },
27
          "location": {
28
               "locationId
LocationId

Location identifier

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

Name of location

": "{String}",
30
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
31
               "locationLink
LocationLink

Location reference

": "{String}"
32
          },
33
          "totals": {
34
               "packages
Packages

Accumulated number of packages from the shipments that are assigned to this departing waybill.

": "{Integer}",
35
               "weight
Weight

Accumulated gross weight from the shipments that are assigned to this departing waybill

": "{Decimal}"
36
          }
37
     }
38
}

Possible error codes the response might return:

Error 101814 HTTP 404 Employee not found