Note, this API is used to update orders and is reserved for our shipping partners.
643 matches
12 actions
Fulfillment.com APIv2
12 actions
E-commerce/Fulfillment.com APIv2
Ship an Order
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"trackingNumber": {
"type": "string",
"description": "Tracking number of package"
},
"weightOverride": {
"type": "number",
"format": "float",
"description": "Override predicted weight of package"
}
},
"required": [
"id",
"trackingNumber"
],
"additionalProperties": false
}Output
- 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
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
- 365
- 366
- 367
- 368
- 369
- 370
- 371
- 372
- 373
- 374
- 375
- 376
- 377
- 378
- 379
- 380
- 381
- 382
- 383
- 384
{
"type": "object",
"required": [
"currentStatus",
"id",
"merchant",
"merchantOrderId",
"merchantShippingMethod",
"originalConsignee",
"recordedOn",
"validatedConsignee"
],
"properties": {
"currentStatus": {
"type": "object",
"required": [
"id"
],
"properties": {
"createdBy": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
}
}
},
"date": {
"type": "string",
"format": "date-time",
"description": "DateTime of Status Event"
},
"id": {
"type": "integer"
},
"reason": {
"type": "string",
"description": "Explanation for status"
},
"status": {
"type": "object",
"required": [
"code",
"detailCode",
"stage",
"state"
],
"properties": {
"actionRequiredBy": {
"type": "object",
"description": "Responsibility for resolving this issue",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string",
"description": "Human readable description of responsible party to resolve the issue"
}
}
},
"code": {
"type": "string",
"description": "Code, see [status codes](#section/Getting-Started/Status-Codes)"
},
"detail": {
"type": "string"
},
"detailCode": {
"type": "string"
},
"id": {
"type": "integer",
"description": "Depricated, use code instead"
},
"isClosed": {
"type": "boolean",
"description": "Depricated, does this status event close the order"
},
"name": {
"type": "string",
"description": "Depricated, use stage/state instead"
},
"reason": {
"type": "string",
"description": "Depricated"
},
"stage": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"state": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
},
"departDate": {
"type": "string",
"format": "date-time",
"description": "DateTime order departed an FDC warehouse"
},
"dispatchDate": {
"type": "string",
"format": "date-time",
"description": "DateTime order was dispatched for fulfillment by FDC"
},
"id": {
"type": "integer",
"description": "FDC ID for this order"
},
"merchant": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string",
"description": "Merchant Company Name"
}
}
},
"merchantOrderId": {
"type": "string",
"description": "Merchant provided ID"
},
"merchantShippingMethod": {
"type": "string",
"description": "Requested ship method"
},
"originalConsignee": {
"type": "object",
"required": [
"address1",
"addressLocality",
"addressRegion",
"country",
"firstName",
"id",
"lastName",
"postalCode"
],
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"addressLocality": {
"type": "string",
"description": "City"
},
"addressRegion": {
"type": "string",
"description": "Province / State"
},
"companyName": {
"type": "string"
},
"country": {
"type": "string",
"description": "Ideally provide the two character ISO code"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"id": {
"type": "integer"
},
"iso": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"iso2": {
"type": "string",
"description": "Two character ISO code"
},
"name": {
"type": "string",
"description": "Country Name"
}
}
},
"lastName": {
"type": "string"
},
"phone": {
"type": "string"
},
"postalCode": {
"type": "string",
"description": "Postal Code / Zip"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"updatedBy": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
}
}
}
}
},
"parentOrder": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Reference to parent `id` if order was grouped"
}
}
},
"purchaseOrderNum": {
"type": "string",
"description": "Merchant provided PO#"
},
"recordedOn": {
"type": "string",
"format": "date-time",
"description": "DateTime order was recorded by FDC"
},
"trackingNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"barcodeScanValue": {
"type": "string",
"description": "The computer readable alternative to the human readable"
},
"carrier": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
}
}
},
"value": {
"type": "string",
"description": "The human readable tracking number recipients (consignee) expect"
}
}
}
},
"validatedConsignee": {
"type": "object",
"required": [
"address1",
"addressLocality",
"addressRegion",
"country",
"firstName",
"id",
"lastName",
"postalCode"
],
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"addressLocality": {
"type": "string",
"description": "City"
},
"addressRegion": {
"type": "string",
"description": "Province / State"
},
"companyName": {
"type": "string"
},
"country": {
"type": "string",
"description": "Ideally provide the two character ISO code"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"id": {
"type": "integer"
},
"iso": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"iso2": {
"type": "string",
"description": "Two character ISO code"
},
"name": {
"type": "string",
"description": "Country Name"
}
}
},
"lastName": {
"type": "string"
},
"phone": {
"type": "string"
},
"postalCode": {
"type": "string",
"description": "Postal Code / Zip"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"updatedBy": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
}
}
}
}
},
"warehouse": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer"
}
}
}
}
}