Customer Reference
Label messages can serve more than their primary use for reference numbers or internal tracking messages. You can add separate, custom label messages to each package in a shipment, too!
Giga Logistics allows you to add up to three custom label messages denoted by keys ref1
, ref2
,ref3
,ref4
,
and ref5
(with supporting carriers).
IMPORTANT
Not all carriers support label messages. The following carriers currently support label messages via Giga Logistics:
- FedEx
- GEL
- DPD
- EVRI
- GLS
- WHISTL
- UPS
FedEx
Fedex custom label messages have the following mappings:
Key | FedEx Label Field | Example | Character Limit |
---|---|---|---|
ref1 | Purchase Order Number Reference | reference1 | 40 |
ref2 | Invoice Number Reference | reference2 | 40 |
ref3 | Customer Reference | reference3 | 40 |
ref4 | Depot Reference | reference4 | 40 |
ref5 | RMA Number Reference | reference5 | 20 |
An example label message appears in the region boxed in red in the image below.
Example JSON Request
POST /gw/cloud-ship-service/v1/shipment HTTP/1.1
Host: sit.gateway.orsd.tech
ACCESS TOKEN: __YOUR_ACCESS_TOKEN_HERE__
Content-Type: application/json
{
"transactionId": "TX28cdfa6e-4924-4dd7-b5ea-1cc25d6b6ba5",
"carrierId": "CIC-3333333",
"serviceType": "FEDEX_GROUND",
"shipper": {
"address": {
"zipCode": "91746",
"streetLine1": "515 S 6th Ave.",
"city": "La Puente",
"stateOrProvinceCode": "CA",
"countryCode": "US"
},
"contact": {
"phoneExtension": "19456",
"companyName": "shipCompany",
"personName": "Shipper002",
"phoneNumber": "1234561234"
}
},
"recipient": {
"address": {
"streetLine2": "Suite 302",
"zipCode": "90210",
"streetLine1": "10 FedEx Parkway",
"city": "Beverly Hills",
"stateOrProvinceCode": "CA",
"countryCode": "US"
},
"contact": {
"phoneExtension": "19364",
"companyName": "shipToComp",
"personName": "name1",
"emailAddress": "[email protected]",
"phoneNumber": "1234561234"
}
},
"itemLines": [
{
"itemCode": "itemCode01",
"weight": {
"units": "lb",
"value": 2.2365
},
"customerReference": {
"ref2": "reference2",
"ref1": "reference1",
"ref4": "reference4",
"ref3": "reference3",
"ref5": "reference5"
},
"itemTransactionId": "ITEM91f55857-fe8e-4308-bf16-be5d6a9d4e43",
"dimensions": {
"length": 6.5,
"units": "in",
"width": 7.6,
"height": 2.3
}
}
],
"labelSpecification": {
"labelStockType": "STOCK_4X6",
"imageType": "PDF"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
GEL
GEL custom label messages have the following mappings:
Key | GEL Label Field | Example | Character Limit |
---|---|---|---|
ref1 | Special Delivery Requirements | reference1 | 100 |
ref2 | Invoice Information | reference2 | 100 |
An example label message appears in the region boxed in red in the image below.
Example JSON Request
POST /gw/cloud-ship-service/v1/shipment HTTP/1.1
Host: sit.gateway.orsd.tech
ACCESS TOKEN: __YOUR_ACCESS_TOKEN_HERE__
Content-Type: application/json
{
"transactionId": "Test-00001",
"carrierId": "CID-1111111",
"serviceType": "2",
"shipper": {
"address": {
"zipCode": "07745",
"streetLine1": "sender street 1",
"city": "Jena",
"stateOrProvinceCode": "",
"countryCode": "DE"
},
"contact": {
"companyName": "sender company",
"personName": "sender name",
"phoneNumber": "+493641602668"
}
},
"recipient": {
"address": {
"zipCode": "47877",
"streetLine1": "receipt street 1",
"city": "Willich",
"stateOrProvinceCode": "",
"countryCode": "DE"
},
"contact": {
"companyName": "receipt company",
"personName": "receipt person",
"phoneNumber": "+493641602622"
}
},
"itemLines": [
{
"weight": {
"units": "kg",
"value": 12
},
"customerReference": {
"ref1": "reference1",
"ref2": "reference2"
},
"itemTransactionId": "Test-00001-1",
"itemCode": "itemCode",
"itemSpecialService": {
"declaredInfo": {
"amount": 9.55,
"currency": "EUR"
}
},
"dimensions": {
"length": 10,
"units": "cm",
"width": 12,
"height": 15
}
}
],
"labelSpecification": {
"imageType": "PDF"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
DPD_DE
DPD custom label messages have the following mappings:
Key | Dpd Label Field | Example | Character Limit |
---|---|---|---|
ref1 | Customer Reference | reference1 | 35 |
ref2 | Customer Reference | reference2 | 35 |
An example label message appears in the region boxed in red in the image below.
Example JSON Request
POST /gw/cloud-ship-service/v1/shipment HTTP/1.1
Host: sit.gateway.orsd.tech
ACCESS TOKEN: __YOUR_ACCESS_TOKEN_HERE__
Content-Type: application/json
{
"transactionId": "Test-00001",
"carrierId": "CID-6cfc53c6bc85",
"serviceType": "CL",
"shipper": {
"address": {
"stateOrProvinceCode":"",
"streetLine2": "sender street 2",
"zipCode": "07745",
"streetLine1": "sender street 1",
"city": "Jena",
"streetLine3": "sender street 3",
"countryCode": "DE"
},
"contact": {
"companyName": "sender company",
"personName": "sender name",
"phoneNumber": "+493641602668"
}
},
"recipient": {
"address": {
"stateOrProvinceCode":"",
"streetLine2": "receipt street 2",
"zipCode": "47877",
"streetLine1": "receipt street 1",
"city": "Willich",
"streetLine3": "receipt street 3",
"countryCode": "DE"
},
"contact": {
"companyName": "receipt company",
"personName": "receipt person",
"phoneNumber": "+493641602622"
}
},
"itemLines": [
{
"weight": {
"units": "kg",
"value": 12
},
"declaredInfo": {
"amount": 9.55,
"currency": "EUR"
},
"customerReference": {
"ref2": "reference2",
"ref1": "reference1",
"ref4": "reference4",
"ref3": "reference3"
},
"itemTransactionId": "Test-00001-1",
"dimensions": {
"length": 10,
"units": "cm",
"width": 12,
"height": 15
}
}
],
"labelSpecification": {
"imageType": "PDF"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
DPD_UK
DPD UK custom label messages have the following mappings:
Key | Dpd Label Field | Example | Character Limit |
---|---|---|---|
ref1 | Customer Reference | reference1 | 25 |
ref2 | Customer Reference | reference2 | 25 |
ref3 | Customer Reference | reference3 | 25 |
An example label message appears in the region boxed in red in the image below.
Example JSON Request
POST /gw/cloud-ship-service/v1/shipment HTTP/1.1
Host: sit.gateway.orsd.tech
ACCESS TOKEN: __YOUR_ACCESS_TOKEN_HERE__
Content-Type: application/json
{
"transactionId": "Test-00001",
"carrierId": "GCL-*********",
"serviceType": "1^19",
"shipper": {
"address": {
"city": "sender town",
"stateOrProvinceCode":"",
"countryCode": "GB",
"streetLine1": "sender Locality",
"streetLine2": "sender street",
"zipCode": "B66 1BY"
},
"contact": {
"companyName": "sender Organisation",
"emailAddress": "[email protected]",
"personName": "sender person",
"phoneNumber": "0121 123 4567"
}
},
"recipient": {
"address": {
"city": "receipt town",
"stateOrProvinceCode":"",
"countryCode": "FR",
"streetLine1": "receipt locality",
"streetLine2": "receipt street",
"zipCode": "32800"
},
"contact": {
"companyName": "receipt organisation",
"emailAddress": "[email protected]",
"personName": "receipt person",
"phoneNumber": "+493641602622"
}
},
"itemLines": [
{
"customerReference": {
"ref1": "reference1",
"ref2": "reference2",
"ref3": "reference3"
},
"declaredInfo": {
"amount": 9.55,
"currency": "GBP"
},
"dimensions": null,
"itemCode": "itemCode-00001-1",
"itemTransactionId": "Test-00001-1",
"packageCode": null,
"specialService": null,
"weight": {
"units": "KG",
"value": 20.0
}
}
],
"customs": {
"customsItems": [
{
"countryOfOrigin": "GB",
"description": "description",
"fabricContent": "FabricContent",
"harmonizedTariffCode": "94035000",
"quantity": 1,
"referToItemTransactionId": "Test-00001-1",
"sku": "productCode-00001-1-A",
"skuDescription": "skuDescription",
"value": {
"amount": 10.0,
"currency": "EUR"
},
"weight": {
"units": "KG",
"value": 10.0
}
}
]
},
"taxIndentifiers": [
{
"identifierType": "VAT",
"taxableEntityType": "SHIPPER",
"value": "GB284263489"
},
{
"identifierType": "EORI",
"taxableEntityType": "SHIPPER",
"value": "GB284263489000"
},
{
"identifierType": "IOSS",
"taxableEntityType": "SHIPPER",
"value": "IM4420001201"
}
],
"signatureOption": null,
"labelSpecification": {
"imageType": "EPL"
},
"paymentOption": null,
"additionInfo": null,
"warehouseId": null
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
EVRI
EVRI custom label messages have the following mappings:
Key | Evri Label Field | Example | Character Limit |
---|---|---|---|
ref1 | Delivery Reference | customer reference n | 32 |
An example label message appears in the region boxed in red in the image below.
Example JSON Request
POST /gw/cloud-ship-service/v1/shipment HTTP/1.1
Host: sit.gateway.orsd.tech
ACCESS TOKEN: __YOUR_ACCESS_TOKEN_HERE__
Content-Type: application/json
{
"carrierId": "GCL-xxxxxxxxxx",
"serviceType": "EVRI_STANDARD",
"recipient": {
"address": {
"city": "receipt town",
"countryCode": "GB",
"zipCode": "TW165NL",
"stateOrProvinceCode": "",
"streetLine1": "streetLine1",
"streetLine2": "streetLine2"
},
"contact": {
"personName": "Mitskya Vichu",
"emailAddress": "[email protected]",
"phoneNumber": "009999999999"
}
},
"itemLines": [
{
"itemTransactionId": "ITEMb7835bbf-2fb2-4217-81ad-8179d8786934",
"itemCode": "SKU--1",
"weight": {
"units": "KG",
"value": 15
},
"customerReference": {
"ref1": "customer reference n"
}
}
]
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
GLS
GLS custom label messages have the following mappings:
Key | GLS Label Field | Example | Character Limit |
---|---|---|---|
ref1 | Customer Reference | customer reference number1 | 50 |
ref2 | Customer Reference | customer reference number2 | 50 |
ref3 | shipmentReference | 113-9606853-7221234 | 40 |
itemTransactionId | ShipmentUnitReference | HBGO-DPD-20230424-0037 | 40 |
An example label message appears in the region boxed in red in the image below.
Example JSON Request
POST /gw/cloud-ship-service/v1/shipment HTTP/1.1
Host: sit.gateway.orsd.tech
ACCESS TOKEN: __YOUR_ACCESS_TOKEN_HERE__
Content-Type: application/json
{
"transactionId": "6ba63ab09c0e4bcfb435a4822a82afdf",
"carrierId": "GCL-b3a5069cc63f",
"serviceType": "GLS_STANDARD",
"shipper": {
"contact": {
"personName": "Shipper Person Name",
"phoneNumber": "+49(0)4186-12 34 567"
},
"address": {
"countryCode": "DE",
"city": "ShipperCity",
"zipCode": "21244",
"streetLine1": "ShipperStreetLine1",
"streetLine2": "ShipperStreetLine2"
}
},
"recipient": {
"contact": {
"personName": "Recipient PersonName",
"phoneNumber": "01771234567",
"emailAddress": "[email protected]"
},
"address": {
"countryCode": "DE",
"city": "RecipientCity",
"zipCode": "56154",
"streetLine1": "Recipient StreetLine1",
"streetLine2": "Recipient StreetLine2"
}
},
"labelSpecification": {
"imageType": "PDF",
"labelStockType": "NONE"
},
"itemLines": [
{
"itemTransactionId": "HBGO-DPD-20230424-0037",
"itemCode": "SKU--1",
"weight": {
"value": 15,
"units": "kg"
},
"customerReference": {
"ref1": "customer reference number1",
"ref2": "customer reference number2",
"ref3": "113-9606853-7221234"
}
}
]
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
WHISTL
WHISTL custom label messages have the following mappings:
Key | Whistl Label Field | Example | Character Limit |
---|---|---|---|
ref1 | Customer Reference | customer reference number1 | 35 |
ref2 | Customer Reference | customer reference number2 | 35 |
An example label message appears in the region boxed in red in the image below.
Example JSON Request
POST /gw/cloud-ship-service/v1/shipment HTTP/1.1
Host: sit.gateway.orsd.tech
ACCESS TOKEN: __YOUR_ACCESS_TOKEN_HERE__
Content-Type: application/json
{
"carrierId": "GCL-*********",
"serviceType": "657",
"shipper": {
"address": {
"zipCode": "B3X 7HQ",
"streetLine1": "44 Hurst St",
"city": "Birmingham",
"stateOrProvinceCode": "England",
"countryCode": "GB"
},
"contact": {
"phoneExtension": "124541",
"companyName": "",
"personName": "Alan Lawson test",
"emailAddress": "[email protected]",
"phoneNumber": "+44 1525 288468"
}
},
"recipient": {
"address": {
"zipCode": "MK43 0UH",
"streetLine1": "hillside barn,56a station road",
"streetLine2": "test address",
"streetLine3": "test",
"city": "ridgmont",
"stateOrProvinceCode": "ridgmont",
"countryCode": "GB"
},
"contact": {
"personName": "Ms Nakhleh"
}
},
"itemLines": [
{
"itemTransactionId": "ITEM8f069317-98ef-4c65-9097-22f453084119",
"itemCode": "itemCode01",
"weight": {
"value": 2.2365,
"units": "kg"
},
"dimensions": {
"length": 6.5,
"units": "cm",
"width": 7.6,
"height": 2.3
},
"customerReference": {
"ref1": "customer reference number1",
"ref2": "customer reference number2"
}
}
],
"labelSpecification": {
"labelStockType": "6",
"imageType": "PDF"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
UPS
UPS custom label messages have the following mappings:
Key | UPS Label Field | Example | Character Limit |
---|---|---|---|
reference1 | Customer Reference | customer reference number1 | 35 |
reference2 | Customer Reference | customer reference number2 | 35 |
An example label message appears in the region boxed in red in the image below.
Example JSON Request
POST /gw/cloud-ship-service/v1/shipment HTTP/1.1
Host: sit.gateway.orsd.tech
ACCESS TOKEN: __YOUR_ACCESS_TOKEN_HERE__
Content-Type: application/json
{
"transactionId": "Test-00001",
"carrierId": "GCL-xxxxxxxxxx",
"serviceType": "03",
"shipper": {
"address": {
"countryCode": "US",
"stateOrProvinceCode": "CA",
"city": "Fontana",
"zipCode": "92337",
"streetLine1": "sender street 1",
"streetLine2": "sender street 2",
"streetLine3": "sender street 3"
},
"contact": {
"companyName": "sender company",
"personName": "sender person",
"phoneNumber": "1548788481"
}
},
"recipient": {
"address": {
"countryCode": "US",
"stateOrProvinceCode": "NC",
"city": "CHARLOTTE",
"zipCode": "282136963",
"streetLine1": "receipt street 1",
"streetLine2": "receipt street 2",
"streetLine3": "receipt street 3"
},
"contact": {
"companyName": "receipt company",
"personName": "receipt person",
"phoneNumber": "1347448319"
}
},
"returnAddress": {
"address": {
"countryCode": "US",
"stateOrProvinceCode": "CA",
"city": "Fontana",
"zipCode": "92337",
"streetLine1": "return street 1",
"streetLine2": "return street 2",
"streetLine3": "return street 3"
},
"contact": {
"companyName": "return company",
"personName": "return person",
"phoneNumber": "6269128886"
}
},
"itemLines": [
{
"itemTransactionId": "Test-00001-1",
"customerReference": {
"ref2": "reference2",
"ref1": "reference1"
},
"dimensions": {
"length": 10,
"units": "IN",
"width": 12,
"height": 15
},
"weight": {
"units": "LB",
"value": 31
},
"declaredInfo": {
"amount": 92,
"currency": "USD"
}
}
],
"labelSpecification": {
"imageType": "GIF"
},
"signatureOption": {
"signatureOptionType": "NO_SIGNATURE_REQUIRED"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90