This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26

GET /deliveries/{deliveryId}

Get delivery

Description

Returns delivery resource

Parameters (path)

Name Required Description Values
deliveryId required Target delivery.  

Parameters (query)

Name Required Description Values
include optional The resources that can be included in this request, delimited by a comma: forwarder_partner, forwarder_location, pickup_partner, pickup_location, delivery_partner, delivery_location, weight_gross, remarks, lots, traces, tags, lines_extract  

Responses

200

successful operation

Response content JSON schema 
1
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

{
  "properties": {
    "required": [
      "order_id",
      "delivery_partner_id",
      "delivery_location_id"
    ],
    "properties": {
      "id": {
        "description": "Id of the record",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "created_by_id": {
        "description": "Id of the user that created the delivery",
        "type": "integer",
        "format": "int32",
        "readOnly": true,
        "example": 1234
      },
      "delivery_contact_id": {
        "description": "Contact on the delivery",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "delivery_date": {
        "description": "Delivery date of the delivery",
        "type": "string",
        "format": "date",
        "readOnly": true,
        "example": "2019-01-01"
      },
      "delivery_location_id": {
        "description": "Location id of the location where the delivery should be delivered to",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "ext_ref": {
        "description": "Reference to put on documents",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "forwarder_contact_id": {
        "description": "No description is available",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "forwarder_id": {
        "description": "Partner id of forwarder",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "forwarder_location_id": {
        "description": "Location id of forwarder",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "number": {
        "description": "Delivery number",
        "type": "integer",
        "format": "int32",
        "readOnly": true,
        "example": 1234
      },
      "order_id": {
        "description": "Order id of delivery",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "order_section": {
        "description": "The section of the order",
        "type": "string",
        "format": "string",
        "enum": [
          "inbound",
          "outbound"
        ],
        "readOnly": true,
        "example": "A string"
      },
      "pallets": {
        "description": "Number of pallets for this delivery",
        "type": "number",
        "format": "double",
        "example": 1234.123
      },
      "picking_date": {
        "description": "The date the delivery was picked",
        "type": "string",
        "format": "date",
        "example": "2019-01-01"
      },
      "pickup_contact_id": {
        "description": "Contact id of contact at pickup location",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "pickup_date": {
        "description": "Date of pickup at pickup location",
        "type": "string",
        "format": "date",
        "example": "2019-01-01"
      },
      "pickup_location_id": {
        "description": "Location id of pickup location",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "status": {
        "description": "Status of delivery",
        "type": "string",
        "format": "string",
        "enum": [
          "pending",
          "picked",
          "dispatched",
          "delivered"
        ],
        "example": "pending"
      },
      "created_at": {
        "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "updated_at": {
        "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2020-01-01T13:25:32.312Z"
      }
    },
    "type": "object"
  },
  "type": "object"
}

406

not acceptable

500

internal server error

PUT /deliveries/{deliveryId}

Update existing delivery

Parameters (path)

Name Required Description Values
deliveryId required Target delivery.  

Request body

Description

Target order.

Required

This parameter is required.

Request body JSON schema 
1
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

{
  "required": [
    "order_id",
    "delivery_partner_id",
    "delivery_location_id"
  ],
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "created_by_id": {
      "description": "Id of the user that created the delivery",
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "example": 1234
    },
    "delivery_contact_id": {
      "description": "Contact on the delivery",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "delivery_date": {
      "description": "Delivery date of the delivery",
      "type": "string",
      "format": "date",
      "readOnly": true,
      "example": "2019-01-01"
    },
    "delivery_location_id": {
      "description": "Location id of the location where the delivery should be delivered to",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "ext_ref": {
      "description": "Reference to put on documents",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "forwarder_contact_id": {
      "description": "No description is available",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "forwarder_id": {
      "description": "Partner id of forwarder",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "forwarder_location_id": {
      "description": "Location id of forwarder",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "number": {
      "description": "Delivery number",
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "example": 1234
    },
    "order_id": {
      "description": "Order id of delivery",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "order_section": {
      "description": "The section of the order",
      "type": "string",
      "format": "string",
      "enum": [
        "inbound",
        "outbound"
      ],
      "readOnly": true,
      "example": "A string"
    },
    "pallets": {
      "description": "Number of pallets for this delivery",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "picking_date": {
      "description": "The date the delivery was picked",
      "type": "string",
      "format": "date",
      "example": "2019-01-01"
    },
    "pickup_contact_id": {
      "description": "Contact id of contact at pickup location",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "pickup_date": {
      "description": "Date of pickup at pickup location",
      "type": "string",
      "format": "date",
      "example": "2019-01-01"
    },
    "pickup_location_id": {
      "description": "Location id of pickup location",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "status": {
      "description": "Status of delivery",
      "type": "string",
      "format": "string",
      "enum": [
        "pending",
        "picked",
        "dispatched",
        "delivered"
      ],
      "example": "pending"
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "updated_at": {
      "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2020-01-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

403

Unauthorized request

406

not acceptable

500

Internal server error