643 matches
63 actions
Billbee
63 actions
- Add a shipment to a given orderPOSTv1.0.0
- Add multiple images to a product or replace the product images by the given imagesPUTv1.0.0
- Adds a new address to a customerPOSTv1.0.0
- Attach one or more tags to an orderPOSTv1.0.0
- Changes the main state of a single orderPUTv1.0.0
- Create an delivery note for an existing order. This request is extra throttled by order and api key to a maximum of 1 per 5 minutes.POSTv1.0.0
- Create an invoice for an existing order. This request is extra throttled by order and api key to a maximum of 1 per 5 minutes.POSTv1.0.0
- Creates a new Billbee user account with the data passedPOSTv1.0.0
- Creates a new customerPOSTv1.0.0
- Creates a new customer addressPOSTv1.0.0
- Creates a new order in the Billbee accountPOSTv1.0.0
- Creates a new productPOSTv1.0.0
- Creates a shipment for an order in billbeePOSTv1.0.0
- Delete multiple images by idPOSTv1.0.0
- Deletes a productDELETEv1.0.0
- Deletes a single image by idDELETEv1.0.0
- Deletes a single image from a productDELETEv1.0.0
- Find a single order by its external id (order number)GETv1.0.0
- Get a list of all customer addressesGETv1.0.0
- Get a list of all customersGETv1.0.0
- Get a list of all events optionally filtered by date. This request is extra throttled to 2 calls per page per hour.GETv1.0.0
- Get a list of all invoices optionally filtered by date. This request ist throttled to 1 per 1 minute for same page and minInvoiceDateGETv1.0.0
- Get a list of all orders optionally filtered by dateGETv1.0.0
- Get a list of all productsGETv1.0.0
- Get a list of all shipments optionally filtered by date. All parameters are optional.GETv1.0.0
- Get a single order by its external order numberGETv1.0.0
- Get a single order by its internal billbee id. This request is throttled to 6 calls per order in one minuteGETv1.0.0
- Gets a list of all connected cloud storage devicesGETv1.0.0
- GEts a list of all defined categoriesGETv1.0.0
- LayoutApi_GetListGETv1.0.0
- Parses a text and replaces all placeholdersPOSTv1.0.0
- Queries a list of addresses from a customerGETv1.0.0
- Queries a list of all custom fieldsGETv1.0.0
- Queries a list of orders from a customerGETv1.0.0
- Queries a single address from a customerGETv1.0.0
- Queries a single article by id or by skuGETv1.0.0
- Queries a single custom fieldGETv1.0.0
- Queries a single customer address by idGETv1.0.0
- Queries a single customer by idGETv1.0.0
- Queries the reserved amount for a single article by id or by skuGETv1.0.0
- Query all defined stock locationsGETv1.0.0
- Returns a list of all images of the productGETv1.0.0
- Returns a list of fields which can be updated with the orders/{id} patch callGETv1.0.0
- Returns a list of fields which can be updated with the patch callGETv1.0.0
- Returns a list with all defined orderstatesGETv1.0.0
- Returns a list with all defined paymenttypesGETv1.0.0
- Returns a list with all defined shipmenttypesGETv1.0.0
- Returns a single image by idGETv1.0.0
- Returns a single image by idGETv1.0.0
- Returns infos about Billbee terms and conditionsGETv1.0.0
- Search for products, customers and orders. Type can be "order", "product" and / or "customer" Term can contains lucene query syntaxPOSTv1.0.0
- Sends a message to the buyerPOSTv1.0.0
- Sets the tags attached to an orderPUTv1.0.0
- Triggers a rule eventPOSTv1.0.0
- Update the stock code of an articlePOSTv1.0.0
- Update the stock qty for multiple articles at oncePOSTv1.0.0
- Update the stock qty of an articlePOSTv1.0.0
- Updates a customer address by idPUTv1.0.0
- Updates a customer by idPUTv1.0.0
- Updates all fields of an addressPUTv1.0.0
- Updates one or more fields of a productPATCHv1.0.0
- Updates one or more fields of an addressPATCHv1.0.0
- Updates one or more fields of an orderPATCHv1.0.0
E-commerce/Billbee
Get a single order by its external order number
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
{
"type": "object",
"properties": {
"extRef": {
"type": "string"
}
},
"required": [
"extRef"
],
"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
- 385
- 386
- 387
- 388
- 389
- 390
- 391
- 392
- 393
- 394
- 395
- 396
- 397
- 398
- 399
- 400
- 401
- 402
- 403
- 404
- 405
- 406
- 407
- 408
- 409
- 410
- 411
- 412
- 413
- 414
- 415
- 416
- 417
- 418
- 419
- 420
- 421
- 422
- 423
- 424
- 425
- 426
- 427
- 428
- 429
- 430
- 431
- 432
- 433
- 434
- 435
- 436
- 437
- 438
- 439
- 440
- 441
- 442
- 443
- 444
- 445
- 446
- 447
- 448
- 449
- 450
- 451
- 452
- 453
- 454
- 455
- 456
- 457
- 458
- 459
- 460
- 461
- 462
- 463
- 464
- 465
- 466
- 467
- 468
- 469
- 470
- 471
- 472
- 473
- 474
- 475
- 476
- 477
- 478
- 479
- 480
- 481
- 482
- 483
- 484
- 485
- 486
- 487
- 488
- 489
- 490
- 491
- 492
- 493
- 494
- 495
- 496
- 497
- 498
- 499
- 500
- 501
- 502
- 503
- 504
- 505
- 506
- 507
- 508
- 509
- 510
- 511
- 512
- 513
- 514
- 515
- 516
- 517
- 518
- 519
- 520
- 521
- 522
- 523
- 524
- 525
- 526
- 527
- 528
- 529
- 530
- 531
- 532
- 533
- 534
- 535
- 536
- 537
- 538
- 539
- 540
- 541
- 542
- 543
- 544
- 545
- 546
- 547
- 548
- 549
- 550
- 551
- 552
- 553
- 554
- 555
- 556
- 557
- 558
- 559
- 560
- 561
- 562
- 563
- 564
- 565
- 566
- 567
- 568
- 569
- 570
- 571
- 572
- 573
- 574
- 575
- 576
- 577
- 578
- 579
- 580
- 581
- 582
- 583
- 584
- 585
- 586
- 587
- 588
- 589
- 590
- 591
- 592
- 593
- 594
- 595
- 596
- 597
- 598
- 599
- 600
- 601
- 602
- 603
- 604
- 605
- 606
- 607
- 608
- 609
- 610
- 611
- 612
- 613
- 614
- 615
- 616
- 617
- 618
- 619
- 620
- 621
- 622
- 623
- 624
- 625
- 626
- 627
- 628
- 629
- 630
- 631
- 632
- 633
- 634
- 635
- 636
- 637
- 638
- 639
- 640
- 641
- 642
- 643
- 644
- 645
- 646
- 647
- 648
- 649
- 650
- 651
- 652
- 653
- 654
- 655
- 656
- 657
- 658
- 659
- 660
- 661
- 662
- 663
- 664
- 665
- 666
- 667
- 668
- 669
- 670
- 671
- 672
- 673
- 674
- 675
- 676
- 677
- 678
- 679
- 680
- 681
- 682
- 683
- 684
- 685
- 686
- 687
- 688
- 689
- 690
- 691
- 692
- 693
- 694
- 695
- 696
- 697
- 698
- 699
- 700
- 701
- 702
- 703
- 704
- 705
- 706
- 707
- 708
- 709
- 710
- 711
- 712
- 713
- 714
- 715
- 716
- 717
- 718
- 719
- 720
- 721
- 722
- 723
- 724
- 725
- 726
- 727
- 728
- 729
- 730
- 731
- 732
- 733
- 734
- 735
- 736
- 737
- 738
- 739
- 740
- 741
- 742
- 743
- 744
- 745
- 746
- 747
- 748
- 749
- 750
- 751
- 752
- 753
- 754
- 755
- 756
- 757
- 758
- 759
- 760
- 761
- 762
- 763
- 764
- 765
- 766
- 767
- 768
- 769
- 770
- 771
- 772
- 773
- 774
- 775
- 776
- 777
- 778
- 779
- 780
- 781
- 782
- 783
- 784
- 785
- 786
- 787
- 788
- 789
- 790
- 791
- 792
- 793
- 794
- 795
- 796
- 797
- 798
- 799
- 800
- 801
- 802
- 803
- 804
- 805
- 806
- 807
- 808
- 809
- 810
- 811
- 812
- 813
- 814
- 815
- 816
- 817
- 818
- 819
- 820
- 821
- 822
- 823
- 824
- 825
- 826
- 827
- 828
- 829
- 830
- 831
- 832
- 833
- 834
- 835
- 836
- 837
- 838
- 839
- 840
- 841
- 842
- 843
- 844
- 845
- 846
- 847
- 848
- 849
- 850
- 851
- 852
- 853
- 854
- 855
- 856
- 857
- 858
- 859
- 860
- 861
- 862
- 863
- 864
- 865
- 866
- 867
- 868
- 869
- 870
- 871
- 872
- 873
- 874
- 875
- 876
- 877
- 878
- 879
- 880
- 881
- 882
- 883
- 884
- 885
- 886
- 887
- 888
- 889
- 890
- 891
- 892
- 893
- 894
- 895
- 896
- 897
- 898
- 899
- 900
- 901
- 902
- 903
- 904
- 905
- 906
- 907
- 908
- 909
- 910
- 911
- 912
- 913
- 914
- 915
- 916
- 917
- 918
- 919
- 920
- 921
- 922
- 923
- 924
- 925
- 926
- 927
- 928
- 929
- 930
- 931
- 932
- 933
- 934
- 935
- 936
- 937
- 938
- 939
- 940
- 941
- 942
- 943
- 944
- 945
- 946
- 947
- 948
- 949
- 950
- 951
- 952
- 953
- 954
- 955
- 956
- 957
- 958
- 959
- 960
- 961
- 962
- 963
- 964
- 965
- 966
- 967
- 968
- 969
- 970
- 971
- 972
- 973
- 974
- 975
- 976
- 977
- 978
- 979
- 980
- 981
- 982
- 983
- 984
- 985
- 986
- 987
- 988
- 989
- 990
- 991
- 992
- 993
- 994
- 995
- 996
- 997
- 998
- 999
- 1000
- 1001
- 1002
- 1003
- 1004
- 1005
- 1006
- 1007
- 1008
- 1009
- 1010
- 1011
- 1012
- 1013
- 1014
- 1015
- 1016
- 1017
- 1018
- 1019
- 1020
- 1021
- 1022
- 1023
- 1024
- 1025
- 1026
- 1027
- 1028
- 1029
- 1030
- 1031
- 1032
- 1033
- 1034
- 1035
- 1036
- 1037
- 1038
- 1039
- 1040
- 1041
- 1042
- 1043
- 1044
- 1045
- 1046
- 1047
- 1048
- 1049
- 1050
- 1051
- 1052
- 1053
- 1054
- 1055
- 1056
- 1057
- 1058
- 1059
- 1060
- 1061
- 1062
- 1063
- 1064
- 1065
- 1066
- 1067
- 1068
- 1069
- 1070
- 1071
- 1072
- 1073
- 1074
- 1075
- 1076
- 1077
- 1078
- 1079
- 1080
- 1081
- 1082
- 1083
- 1084
- 1085
- 1086
- 1087
- 1088
- 1089
- 1090
- 1091
- 1092
- 1093
- 1094
- 1095
- 1096
- 1097
- 1098
- 1099
- 1100
- 1101
- 1102
- 1103
- 1104
- 1105
- 1106
- 1107
- 1108
- 1109
- 1110
- 1111
- 1112
- 1113
- 1114
- 1115
- 1116
- 1117
- 1118
- 1119
- 1120
- 1121
- 1122
- 1123
- 1124
- 1125
- 1126
- 1127
- 1128
- 1129
- 1130
- 1131
- 1132
- 1133
- 1134
- 1135
- 1136
- 1137
- 1138
- 1139
- 1140
- 1141
- 1142
- 1143
- 1144
- 1145
- 1146
- 1147
- 1148
- 1149
- 1150
- 1151
- 1152
- 1153
- 1154
- 1155
- 1156
- 1157
- 1158
- 1159
- 1160
- 1161
- 1162
- 1163
- 1164
- 1165
- 1166
- 1167
- 1168
- 1169
- 1170
- 1171
- 1172
- 1173
- 1174
- 1175
- 1176
- 1177
- 1178
- 1179
- 1180
- 1181
- 1182
- 1183
- 1184
- 1185
- 1186
- 1187
- 1188
- 1189
- 1190
- 1191
- 1192
- 1193
- 1194
- 1195
- 1196
- 1197
- 1198
- 1199
- 1200
- 1201
- 1202
- 1203
- 1204
- 1205
- 1206
- 1207
- 1208
- 1209
- 1210
- 1211
- 1212
- 1213
- 1214
- 1215
- 1216
- 1217
- 1218
- 1219
- 1220
- 1221
- 1222
- 1223
- 1224
- 1225
- 1226
- 1227
- 1228
- 1229
- 1230
- 1231
- 1232
- 1233
- 1234
- 1235
- 1236
- 1237
- 1238
- 1239
- 1240
- 1241
- 1242
- 1243
- 1244
- 1245
- 1246
- 1247
{
"type": "object",
"properties": {
"Data": {
"type": "object",
"description": "A class that represents the Billbee data model of a single order",
"properties": {
"AcceptLossOfReturnRight": {
"type": "boolean",
"description": "Customer accepts loss due to withdrawal"
},
"AdjustmentCost": {
"type": "number",
"format": "double"
},
"AdjustmentReason": {
"type": "string"
},
"ApiAccountId": {
"type": "integer",
"format": "int64",
"description": "Id of the account, this order belongs to"
},
"ApiAccountName": {
"type": "string",
"description": "The name of the account, this order belongs to. Will be ignored on order creation."
},
"ArchivedAt": {
"type": "string",
"format": "date-time",
"description": "If set, the order was already archived at the given date. Further modification is disabled."
},
"BillBeeOrderId": {
"type": "integer",
"format": "int64",
"description": "The Order.Id from the Billbee database"
},
"BillBeeParentOrderId": {
"type": "integer",
"format": "int64",
"description": "The Id of the parent order in the Billbee database"
},
"Buyer": {
"type": "object",
"properties": {
"BillbeeShopId": {
"type": "integer",
"format": "int64",
"description": "The Billbee internal id of the shop connection"
},
"BillbeeShopName": {
"type": "string",
"description": "The name of shop connection in Billbee"
},
"Email": {
"type": "string",
"description": "The email address of this customer"
},
"FirstName": {
"type": "string",
"description": "The first name of this customer"
},
"FullName": {
"type": "string",
"description": "The full name (\"firstname lastname\") of this customer"
},
"Id": {
"type": "string",
"description": "The Billbee internal id of this customer"
},
"LastName": {
"type": "string",
"description": "The last name of this customer"
},
"Nick": {
"type": "string",
"description": "The nick name (if available) from the original system"
},
"Platform": {
"type": "string",
"description": "The name of the platform from which this customer originated"
}
}
},
"Comments": {
"type": "array",
"description": "All messages / comments of the order",
"items": {
"type": "object",
"properties": {
"Created": {
"type": "string",
"format": "date-time"
},
"FromCustomer": {
"type": "boolean"
},
"Id": {
"type": "integer",
"format": "int64"
},
"Name": {
"type": "string"
},
"Text": {
"type": "string"
}
}
}
},
"ConfirmedAt": {
"type": "string",
"format": "date-time",
"description": "The date on which the order was confirmed"
},
"CreatedAt": {
"type": "string",
"format": "date-time",
"description": "The date on which the order was created"
},
"Currency": {
"type": "string",
"description": "The three letter currency code."
},
"CustomInvoiceNote": {
"type": "string",
"description": "An optional multiline text which is printed on the invoice"
},
"Customer": {
"type": "object",
"properties": {
"ArchivedAt": {
"type": "string",
"format": "date-time",
"description": "If set, the customer was already archived at the given date. Further modification is disabled."
},
"DefaultCommercialMailAddress": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int64"
},
"SubType": {
"type": "string"
},
"TypeId": {
"type": "integer",
"format": "int64"
},
"TypeName": {
"type": "string"
},
"Value": {
"type": "string"
}
}
},
"DefaultFax": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int64"
},
"SubType": {
"type": "string"
},
"TypeId": {
"type": "integer",
"format": "int64"
},
"TypeName": {
"type": "string"
},
"Value": {
"type": "string"
}
}
},
"DefaultMailAddress": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int64"
},
"SubType": {
"type": "string"
},
"TypeId": {
"type": "integer",
"format": "int64"
},
"TypeName": {
"type": "string"
},
"Value": {
"type": "string"
}
}
},
"DefaultPhone1": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int64"
},
"SubType": {
"type": "string"
},
"TypeId": {
"type": "integer",
"format": "int64"
},
"TypeName": {
"type": "string"
},
"Value": {
"type": "string"
}
}
},
"DefaultPhone2": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int64"
},
"SubType": {
"type": "string"
},
"TypeId": {
"type": "integer",
"format": "int64"
},
"TypeName": {
"type": "string"
},
"Value": {
"type": "string"
}
}
},
"DefaultStatusUpdatesMailAddress": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int64"
},
"SubType": {
"type": "string"
},
"TypeId": {
"type": "integer",
"format": "int64"
},
"TypeName": {
"type": "string"
},
"Value": {
"type": "string"
}
}
},
"Email": {
"type": "string"
},
"Id": {
"type": "integer",
"format": "int64",
"description": "The Billbee Id of the customer"
},
"LanguageId": {
"type": "integer",
"format": "int32"
},
"MetaData": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int64"
},
"SubType": {
"type": "string"
},
"TypeId": {
"type": "integer",
"format": "int64"
},
"TypeName": {
"type": "string"
},
"Value": {
"type": "string"
}
}
}
},
"Name": {
"type": "string"
},
"Number": {
"type": "integer",
"format": "int32"
},
"PriceGroupId": {
"type": "integer",
"format": "int64"
},
"RestoredAt": {
"type": "string",
"format": "date-time",
"description": "If set, the customer was restored from the archive at the given date."
},
"Tel1": {
"type": "string"
},
"Tel2": {
"type": "string"
},
"Type": {
"type": "integer",
"format": "int32",
"description": "Customer Type"
},
"VatId": {
"type": "string",
"description": "The vat-id, that should be saved at the customer. Only used if CustomerVatId is not set on the order."
}
}
},
"CustomerNumber": {
"type": "string",
"description": "The customer number (not to be confused with the id of the customer)"
},
"CustomerVatId": {
"type": "string",
"description": "The vat-id, that was given by the customer to fulfill this order"
},
"DeliverySourceCountryCode": {
"type": "string",
"description": "An optional Country ISO2 Code of the country where order is shipped from (FBA)"
},
"DistributionCenter": {
"type": "string",
"description": "An optional code for the distribution center delivering this order"
},
"History": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Created": {
"type": "string",
"format": "date-time"
},
"EmployeeName": {
"type": "string"
},
"EventTypeName": {
"type": "string"
},
"Text": {
"type": "string"
},
"TypeId": {
"type": "integer",
"format": "int32"
}
}
}
},
"Id": {
"type": "string",
"description": "Id of the order in the external system (marketplace)"
},
"InvoiceAddress": {
"type": "object",
"properties": {
"BillbeeId": {
"type": "integer",
"format": "int64"
},
"City": {
"type": "string"
},
"Company": {
"type": "string"
},
"Country": {
"type": "string"
},
"CountryISO2": {
"type": "string"
},
"Email": {
"type": "string"
},
"FirstName": {
"type": "string"
},
"HouseNumber": {
"type": "string"
},
"LastName": {
"type": "string"
},
"Line2": {
"type": "string"
},
"NameAddition": {
"type": "string"
},
"Phone": {
"type": "string"
},
"State": {
"type": "string"
},
"Street": {
"type": "string"
},
"Zip": {
"type": "string"
}
}
},
"InvoiceDate": {
"type": "string",
"format": "date-time",
"description": "The date on which the invoice was created"
},
"InvoiceNumber": {
"type": "integer",
"format": "int32",
"description": "The invoice number"
},
"InvoiceNumberPostfix": {
"type": "string",
"description": "The postfix of the invoice number"
},
"InvoiceNumberPrefix": {
"type": "string",
"description": "The prefix of the invoice number"
},
"IsCancelationFor": {
"type": "string",
"description": "An optional Order Id (externalid) for an order if this is a cancel order (shopify only at the moment)"
},
"IsFromBillbeeApi": {
"type": "boolean",
"description": "Indicates whether the order was created through the Billbee-Api or not."
},
"LanguageCode": {
"type": "string",
"description": "The two-letter language code of the customer"
},
"LastModifiedAt": {
"type": "string",
"format": "date-time",
"description": "Date of the last update, the order got"
},
"MerchantVatId": {
"type": "string",
"description": "The vat-id, that should be displayed on the invoice and other order documents"
},
"OrderItems": {
"type": "array",
"description": "The list of items purchased like shirt, pant, toys etc",
"items": {
"type": "object",
"properties": {
"Attributes": {
"type": "array",
"description": "A list of product attributes for this position",
"items": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "The internal id of this attribute"
},
"Name": {
"type": "string",
"description": "The attribute name. E.g. color"
},
"Price": {
"type": "number",
"format": "double"
},
"Value": {
"type": "string",
"description": "The attribute value. E.g. red"
}
}
}
},
"BillbeeId": {
"type": "integer",
"format": "int64",
"description": "The billbee id of this item"
},
"Discount": {
"type": "number",
"format": "double",
"description": "Sets the discount in percent"
},
"DontAdjustStock": {
"type": "boolean",
"description": "If true, the import of this order won't adjust the stock level at billbee."
},
"GetPriceFromArticleIfAny": {
"type": "boolean",
"description": "If true, the price will be overwritten by the known article price in billbee if available"
},
"InvoiceSKU": {
"type": "string",
"description": "Contains the SKU from OrderDetail (if available) or from Product"
},
"IsCoupon": {
"type": "boolean",
"description": "Determines if it is a coupon, which is interpreted as tax-free payment"
},
"Product": {
"type": "object",
"properties": {
"BillbeeId": {
"type": "integer",
"format": "int64",
"description": "The Billbee internal id of the linked product"
},
"CountryOfOrigin": {
"type": "string",
"description": "The country where this article was made"
},
"EAN": {
"type": "string",
"description": "The EAN / GTIN of this product"
},
"Id": {
"type": "string",
"description": "The id of this product in the external system"
},
"Images": {
"type": "array",
"description": "The images of this product",
"items": {
"type": "object",
"properties": {
"ExternalId": {
"type": "string",
"description": "The id of this image from the original system"
},
"IsDefaultImage": {
"type": "boolean",
"description": "True if the image is / should be the default image"
},
"Position": {
"type": "integer",
"format": "int32",
"description": "The order of this image"
},
"Url": {
"type": "string",
"description": "The url to the image"
}
}
}
},
"IsDigital": {
"type": "boolean",
"description": "True if the product is a digital good (download etc.), false if not"
},
"OldId": {
"type": "string",
"description": "This is for migration scenarios when the internal id of a product changes\r\nI.E. Etsy when switching to the new inventory management, the ids for variants will change."
},
"PlatformData": {
"type": "string",
"description": "Optional platform specific Data as serialized JSON Object for the product"
},
"SKU": {
"type": "string",
"description": "The SKU of this product"
},
"SkuOrId": {
"type": "string",
"description": "The SKU of this product or the id if the SKU is empty"
},
"TARICCode": {
"type": "string",
"description": "The TARIC code"
},
"Title": {
"type": "string",
"description": "The name of this product"
},
"Type": {
"type": "integer",
"format": "int32",
"description": "Indicates whether the article is 1 = normal or 2 = BOM"
},
"Weight": {
"type": "integer",
"format": "int32",
"description": "Weight of one item in gram"
}
}
},
"Quantity": {
"type": "number",
"format": "double",
"description": "The sold quantity"
},
"SerialNumber": {
"type": "string",
"description": "Contains the used serial number"
},
"ShippingProfileId": {
"type": "string",
"description": "Determines if it is a coupon, which is interpreted as tax-free payment"
},
"TaxAmount": {
"type": "number",
"format": "double",
"description": "The tax amount in the total price"
},
"TaxIndex": {
"type": "integer",
"format": "int32",
"description": "The tax index."
},
"TotalPrice": {
"type": "number",
"format": "double",
"description": "The total price (unit price * quantity)"
},
"TransactionId": {
"type": "string",
"description": "Id of the individual transaction. Only required by Ebay to detect aggregated orders"
},
"UnrebatedTotalPrice": {
"type": "number",
"format": "double",
"description": "Is just used for the billbee api"
}
}
}
},
"OrderNumber": {
"type": "string",
"description": "Order number of the order in the external system (marketplace)"
},
"PaidAmount": {
"type": "number",
"format": "double"
},
"PayedAt": {
"type": "string",
"format": "date-time",
"description": "The date on which the order was paid"
},
"PaymentInstruction": {
"type": "string",
"description": "A textfield optionaly filled with a payment instruction text for printout on the invoice (z.B. Ebay Kauf auf Rechnung)"
},
"PaymentMethod": {
"type": "integer",
"format": "int32",
"description": "The payment method",
"enum": [
1,
2,
3,
4,
6,
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
]
},
"PaymentReference": {
"type": "string",
"description": "A payment reference. Should not be used any more. Please use 'Payments' instead."
},
"PaymentTransactionId": {
"type": "string",
"description": "The id of the payment transaction. For example the transaction id of PayPal payment. Should not be used any more. Please use 'Payments' instead."
},
"Payments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"BillbeeId": {
"type": "integer",
"format": "int64"
},
"Name": {
"type": "string"
},
"PayDate": {
"type": "string",
"format": "date-time"
},
"PayValue": {
"type": "number",
"format": "double"
},
"PaymentType": {
"type": "integer",
"format": "int32"
},
"Purpose": {
"type": "string"
},
"SourceTechnology": {
"type": "string"
},
"SourceText": {
"type": "string"
},
"TransactionId": {
"type": "string"
}
}
}
},
"RebateDifference": {
"type": "number",
"format": "double"
},
"RestoredAt": {
"type": "string",
"format": "date-time",
"description": "If set, the order was restored from the archive at the given date."
},
"Seller": {
"type": "object",
"properties": {
"BillbeeShopId": {
"type": "integer",
"format": "int64",
"description": "The Billbee internal id of the shop connection"
},
"BillbeeShopName": {
"type": "string",
"description": "The name of shop connection in Billbee"
},
"Email": {
"type": "string",
"description": "The email address of this customer"
},
"FirstName": {
"type": "string",
"description": "The first name of this customer"
},
"FullName": {
"type": "string",
"description": "The full name (\"firstname lastname\") of this customer"
},
"Id": {
"type": "string",
"description": "The Billbee internal id of this customer"
},
"LastName": {
"type": "string",
"description": "The last name of this customer"
},
"Nick": {
"type": "string",
"description": "The nick name (if available) from the original system"
},
"Platform": {
"type": "string",
"description": "The name of the platform from which this customer originated"
}
}
},
"SellerComment": {
"type": "string",
"description": "An internal seller comment"
},
"ShipWeightKg": {
"type": "number",
"format": "double",
"description": "The total weight of the shipment(s)"
},
"ShippedAt": {
"type": "string",
"format": "date-time",
"description": "The date on which the order was shipped"
},
"ShippingAddress": {
"type": "object",
"properties": {
"BillbeeId": {
"type": "integer",
"format": "int64"
},
"City": {
"type": "string"
},
"Company": {
"type": "string"
},
"Country": {
"type": "string"
},
"CountryISO2": {
"type": "string"
},
"Email": {
"type": "string"
},
"FirstName": {
"type": "string"
},
"HouseNumber": {
"type": "string"
},
"LastName": {
"type": "string"
},
"Line2": {
"type": "string"
},
"NameAddition": {
"type": "string"
},
"Phone": {
"type": "string"
},
"State": {
"type": "string"
},
"Street": {
"type": "string"
},
"Zip": {
"type": "string"
}
}
},
"ShippingCost": {
"type": "number",
"format": "double",
"description": "The shipping cost"
},
"ShippingIds": {
"type": "array",
"description": "The shipments of the order",
"items": {
"type": "object",
"description": "Represents a single shipment.",
"properties": {
"BillbeeId": {
"type": "integer",
"format": "int64",
"description": "The billbee internal id of the shipment"
},
"Created": {
"type": "string",
"format": "date-time",
"description": "The creation date"
},
"ShipmentType": {
"type": "integer",
"format": "int32",
"description": "Shipment Type, 0 if Shipment, 1 if Retoure"
},
"Shipper": {
"type": "string",
"description": "The name of the shipping provider"
},
"ShippingCarrier": {
"type": "integer",
"format": "int32",
"description": "The carrier used to ship the parcel with"
},
"ShippingId": {
"type": "string",
"description": "The id of this shipment"
},
"ShippingProviderId": {
"type": "integer",
"format": "int64",
"description": "The id of the used shipping provider"
},
"ShippingProviderProductId": {
"type": "integer",
"format": "int64",
"description": "The id of the used shipping provider product"
},
"TrackingUrl": {
"type": "string",
"description": "The url to track this shipment"
}
}
}
},
"ShippingProfileId": {
"type": "string",
"description": "Internal Id for the shipping profile for that order"
},
"ShippingProfileName": {
"type": "string",
"description": "Display Name of Shipping profile, if available"
},
"ShippingProviderId": {
"type": "integer",
"format": "int64",
"description": "Internal Id for the used shipping provider"
},
"ShippingProviderName": {
"type": "string",
"description": "The Name for of used shipping provider"
},
"ShippingProviderProductId": {
"type": "integer",
"format": "int64",
"description": "Internal Id for the used shipping product"
},
"ShippingProviderProductName": {
"type": "string",
"description": "The Name of the used shipping product"
},
"ShippingServices": {
"type": "array",
"description": "Additional services for the shipment",
"items": {
"type": "object",
"properties": {
"CanBeConfigured": {
"type": "boolean"
},
"DisplayName": {
"type": "string"
},
"DisplayValue": {
"type": "string"
},
"PossibleValueLists": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "object",
"additionalProperties": true
},
"value": {
"type": "object",
"additionalProperties": true
}
}
}
}
}
}
},
"RequiresUserInput": {
"type": "boolean"
},
"ServiceName": {
"type": "string"
},
"typeName": {
"type": "string"
}
}
}
},
"State": {
"type": "integer",
"format": "int32",
"description": "The current state of the order",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16
]
},
"Tags": {
"type": "array",
"description": "The Tags of the order",
"items": {
"type": "string"
}
},
"TaxRate1": {
"type": "number",
"format": "double",
"description": "The regular tax rate"
},
"TaxRate2": {
"type": "number",
"format": "double",
"description": "The reduced tax rate"
},
"TotalCost": {
"type": "number",
"format": "double",
"description": "The total cost excluding shipping cost"
},
"UpdatedAt": {
"type": "string",
"format": "date-time",
"description": "The date on which the order was last updated"
},
"VatId": {
"type": "string",
"description": "The customers vat id"
},
"VatMode": {
"type": "integer",
"format": "int32",
"description": "The vat mode of the order",
"enum": [
0,
1,
2,
3,
4,
5
]
}
}
},
"ErrorCode": {
"type": "integer",
"format": "int32",
"enum": [
0,
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
]
},
"ErrorDescription": {
"type": "integer",
"format": "int32",
"enum": [
0,
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
]
},
"ErrorMessage": {
"type": "string"
}
}
}