v2

latestSwagger 2.02026-08-0187117271.9 KB
Orders

post/api/v1/orders

Query parameters

shopIdinteger

Request body

RebateDifferencenumber double
AcceptLossOfReturnRightboolean

Customer accepts loss due to withdrawal

Idstring

Id of the order in the external system (marketplace)

OrderNumberstring

Order number of the order in the external system (marketplace)

State1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17

The current state of the order

VatMode0 | 1 | 2 | 3 | 4 | 5

The vat mode of the order

CreatedAtstring date-time required

The date on which the order was created

ShippedAtstring date-time

The date on which the order was shipped

ConfirmedAtstring date-time

The date on which the order was confirmed

PayedAtstring date-time

The date on which the order was paid

SellerCommentstring

An internal seller comment

InvoiceNumberPrefixstring

The prefix of the invoice number

InvoiceNumberPostfixstring

The postfix of the invoice number

InvoiceNumberinteger

The invoice number

InvoiceDatestring date-time

The date on which the invoice was created

PaymentMethod1 | 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 | 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

The payment method

ShippingCostnumber double

The shipping cost

TotalCostnumber double

The total cost excluding shipping cost

AdjustmentCostnumber double
AdjustmentReasonstring
Currencystring

The three letter currency code.

UpdatedAtstring date-time

The date on which the order was last updated

TaxRate1number double

The regular tax rate

TaxRate2number double

The reduced tax rate

BillBeeOrderIdinteger

The Order.Id from the Billbee database

BillBeeParentOrderIdinteger

The Id of the parent order in the Billbee database

VatIdstring

The customers vat id

Tagsstring[]

The Tags of the order

ShipWeightKgnumber double

The total weight of the shipment(s)

LanguageCodestring

The two-letter language code of the customer

PaidAmountnumber double
ShippingProfileIdstring

Internal Id for the shipping profile for that order

ShippingProviderIdinteger

Internal Id for the used shipping provider

ShippingProviderProductIdinteger

Internal Id for the used shipping product

ShippingProviderNamestring

The Name for of used shipping provider

ShippingProviderProductNamestring

The Name of the used shipping product

ShippingProfileNamestring

Display Name of Shipping profile, if available

PaymentInstructionstring

A textfield optionaly filled with a payment instruction text for printout on the invoice (z.B. Ebay Kauf auf Rechnung)

IsCancelationForstring

An optional Order Id (externalid) for an order if this is a cancel order (shopify only at the moment)

PaymentTransactionIdstring

The id of the payment transaction. For example the transaction id of PayPal payment. Should not be used any more. Please use 'Payments' instead.

DistributionCenterstring

An optional code for the distribution center delivering this order

DeliverySourceCountryCodestring

An optional Country ISO2 Code of the country where order is shipped from (FBA)

CustomInvoiceNotestring

An optional multiline text which is printed on the invoice

CustomerNumberstring

The customer number (not to be confused with the id of the customer)

PaymentReferencestring

A payment reference

LastModifiedAtstring date-time

Date of the last update, the order got

ArchivedAtstring date-time

If set, the order was already archived at the given date. Further modification is disabled.

RestoredAtstring date-time

If set, the order was restored from the archive at the given date.

ApiAccountIdinteger

Id of the account, this order belongs to

ApiAccountNamestring

The name of the account, this order belongs to. Will be ignored on order creation.

MerchantVatIdstring

The vat-id, that should be displayed on the invoice and other order documents

CustomerVatIdstring

The vat-id, that was given by the customer to fulfill this order

IsFromBillbeeApiboolean

Indicates whether the order was created through the Billbee-Api or not.

WebUrlstring

Returns the url to open the order in Billbee.

Response

OK

ErrorMessagestring
ErrorCode0 | 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
ErrorDescription0 | 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