Pricing Templates
Log in Sign up
Integrations / Billbee / ...

POST /api/v1/orders

To create an order POST an JSON object to the orders endpoint with the shown properties. Not all properties are required.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
shopId Integer No

Deprecated, if orderData.ApiAccountId is set, it will be used instead of 'shopId'

Request body fields

Name Type Required Description
Currency String No

The three letter currency code.
PaymentMethod Integer No

The payment method

Valid values:

  • 88
  • 89
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 90
  • 117
  • 91
  • 118
  • 92
  • 119
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 19
  • 120
  • 121
  • 1
  • 122
  • 2
  • 123
  • 3
  • 124
  • 4
  • 125
  • 126
  • 6
  • 127
  • 128
  • 129
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 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
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 80
  • 107
  • 81
  • 108
  • 82
  • 109
  • 83
  • 84
  • 85
  • 86
  • 87
ShippingProviderId Integer No

Internal Id for the used shipping provider
InvoiceNumber Integer No

The invoice number
Payments[] Array No
Payments[].PayValue Number No
Payments[].Name String No
Payments[].SourceTechnology String No
Payments[].Purpose String No
Payments[].TransactionId String No
Payments[].PayDate String No
Payments[].BillbeeId Integer No
Payments[].PaymentType Integer No
Payments[].SourceText String No
ShippingProviderName String No

The Name for of used shipping provider
TotalCost Number No

The total cost excluding shipping cost
Customer Object No
Customer.RestoredAt String No

If set, the customer was restored from the archive at the given date.
Customer.Number Integer No
Customer.Name String No
Customer.LanguageId Integer No
Customer.Type Integer No

Customer Type
Customer.Tel2 String No
Customer.Tel1 String No
Customer.Email String No
Customer.Id Integer No

The Billbee Id of the customer
Customer.VatId String No

The vat-id, that should be saved at the customer. Only used if CustomerVatId is not set on the order.
Customer.DefaultFax Object No
Customer.DefaultFax.Id Integer No
Customer.DefaultFax.SubType String No
Customer.DefaultFax.TypeName String No
Customer.DefaultFax.TypeId Integer No
Customer.DefaultFax.Value String No
Customer.DefaultStatusUpdatesMailAddress Object No
Customer.DefaultStatusUpdatesMailAddress.Id Integer No
Customer.DefaultStatusUpdatesMailAddress.SubType String No
Customer.DefaultStatusUpdatesMailAddress.TypeName String No
Customer.DefaultStatusUpdatesMailAddress.TypeId Integer No
Customer.DefaultStatusUpdatesMailAddress.Value String No
Customer.DefaultMailAddress Object No
Customer.DefaultMailAddress.Id Integer No
Customer.DefaultMailAddress.SubType String No
Customer.DefaultMailAddress.TypeName String No
Customer.DefaultMailAddress.TypeId Integer No
Customer.DefaultMailAddress.Value String No
Customer.DefaultCommercialMailAddress Object No
Customer.DefaultCommercialMailAddress.Id Integer No
Customer.DefaultCommercialMailAddress.SubType String No
Customer.DefaultCommercialMailAddress.TypeName String No
Customer.DefaultCommercialMailAddress.TypeId Integer No
Customer.DefaultCommercialMailAddress.Value String No
Customer.PriceGroupId Integer No
Customer.DefaultPhone1 Object No
Customer.DefaultPhone1.Id Integer No
Customer.DefaultPhone1.SubType String No
Customer.DefaultPhone1.TypeName String No
Customer.DefaultPhone1.TypeId Integer No
Customer.DefaultPhone1.Value String No
Customer.DefaultPhone2 Object No
Customer.DefaultPhone2.Id Integer No
Customer.DefaultPhone2.SubType String No
Customer.DefaultPhone2.TypeName String No
Customer.DefaultPhone2.TypeId Integer No
Customer.DefaultPhone2.Value String No
Customer.ArchivedAt String No

If set, the customer was already archived at the given date. Further modification is disabled.
Customer.MetaData[] Array No
Customer.MetaData[].Id Integer No
Customer.MetaData[].SubType String No
Customer.MetaData[].TypeName String No
Customer.MetaData[].TypeId Integer No
Customer.MetaData[].Value String No
Tags[] Array No

The Tags of the order
ShippingAddress Object No
ShippingAddress.City String No
ShippingAddress.State String No
ShippingAddress.Street String No
ShippingAddress.Country String No
ShippingAddress.BillbeeId Integer No
ShippingAddress.LastName String No
ShippingAddress.Company String No
ShippingAddress.FirstName String No
ShippingAddress.Email String No
ShippingAddress.Line2 String No
ShippingAddress.HouseNumber String No
ShippingAddress.NameAddition String No
ShippingAddress.Zip String No
ShippingAddress.CountryISO2 String No
ShippingAddress.Phone String No
ShippingProfileId String No

Internal Id for the shipping profile for that order
CreatedAt String No

The date on which the order was created
IsFromBillbeeApi Boolean No

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

The customers vat id
History[] Array No
History[].EventTypeName String No
History[].Text String No
History[].Created String No
History[].EmployeeName String No
History[].TypeId Integer No
OrderNumber String No

Order number of the order in the external system (marketplace)
PaidAmount Number No
ShipWeightKg Number No

The total weight of the shipment(s)
OrderItems[] Array No

The list of items purchased like shirt, pant, toys etc
OrderItems[].TaxIndex Integer No

The tax index.
OrderItems[].Product Object No
OrderItems[].Product.TARICCode String No

The TARIC code
OrderItems[].Product.SkuOrId String No

The SKU of this product or the id if the SKU is empty
OrderItems[].Product.EAN String No

The EAN / GTIN of this product
OrderItems[].Product.Type Integer No

Indicates whether the article is 1 = normal or 2 = BOM
OrderItems[].Product.BillbeeId Integer No

The Billbee internal id of the linked product
OrderItems[].Product.Id String No

The id of this product in the external system
OrderItems[].Product.Images[] Array No

The images of this product
OrderItems[].Product.Images[].Position Integer No

The order of this image
OrderItems[].Product.Images[].IsDefaultImage Boolean No

True if the image is / should be the default image
OrderItems[].Product.Images[].Url String No

The url to the image
OrderItems[].Product.Images[].ExternalId String No

The id of this image from the original system
OrderItems[].Product.CountryOfOrigin String No

The country where this article was made
OrderItems[].Product.SKU String No

The SKU of this product
OrderItems[].Product.PlatformData String No

Optional platform specific Data as serialized JSON Object for the product
OrderItems[].Product.Weight Integer No

Weight of one item in gram
OrderItems[].Product.OldId String No

This is for migration scenarios when the internal id of a product changes I.E. Etsy when switching to the new inventory management, the ids for variants will change.
OrderItems[].Product.Title String No

The name of this product
OrderItems[].Product.IsDigital Boolean No

True if the product is a digital good (download etc.), false if not
OrderItems[].Quantity Number No

The sold quantity
OrderItems[].InvoiceSKU String No

Contains the SKU from OrderDetail (if available) or from Product
OrderItems[].TotalPrice Number No

The total price (unit price * quantity)
OrderItems[].GetPriceFromArticleIfAny Boolean No

If true, the price will be overwritten by the known article price in billbee if available
OrderItems[].TaxAmount Number No

The tax amount in the total price
OrderItems[].ShippingProfileId String No

Determines if it is a coupon, which is interpreted as tax-free payment
OrderItems[].BillbeeId Integer No

The billbee id of this item
OrderItems[].DontAdjustStock Boolean No

If true, the import of this order won't adjust the stock level at billbee.
OrderItems[].IsCoupon Boolean No

Determines if it is a coupon, which is interpreted as tax-free payment
OrderItems[].Attributes[] Array No

A list of product attributes for this position
OrderItems[].Attributes[].Id String No

The internal id of this attribute
OrderItems[].Attributes[].Price Number No
OrderItems[].Attributes[].Name String No

The attribute name. E.g. color
OrderItems[].Attributes[].Value String No

The attribute value. E.g. red
OrderItems[].Discount Number No

Sets the discount in percent
OrderItems[].TransactionId String No

Id of the individual transaction. Only required by Ebay to detect aggregated orders
OrderItems[].UnrebatedTotalPrice Number No

Is just used for the billbee api
OrderItems[].SerialNumber String No

Contains the used serial number
ApiAccountId Integer No

Id of the account, this order belongs to
SellerComment String No

An internal seller comment
BillBeeParentOrderId Integer No

The Id of the parent order in the Billbee database
AcceptLossOfReturnRight Boolean No

Customer accepts loss due to withdrawal
RestoredAt String No

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

The current state of the order

Valid values:

  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
ShippingProfileName String No

Display Name of Shipping profile, if available
ShippingServices[] Array No

Additional services for the shipment
ShippingServices[].ServiceName String No
ShippingServices[].RequiresUserInput Boolean No
ShippingServices[].DisplayName String No
ShippingServices[].PossibleValueLists[] Array No
ShippingServices[].PossibleValueLists[].key String No
ShippingServices[].PossibleValueLists[].value[] Array No
ShippingServices[].PossibleValueLists[].value[].key Integer No
ShippingServices[].PossibleValueLists[].value[].value String No
ShippingServices[].typeName String No
ShippingServices[].CanBeConfigured Boolean No
ShippingServices[].DisplayValue String No
VatMode Integer No

The vat mode of the order

Valid values:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
ShippedAt String No

The date on which the order was shipped
DeliverySourceCountryCode String No

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

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

Id of the order in the external system (marketplace)
LastModifiedAt String No

Date of the last update, the order got
RebateDifference Number No
ShippingCost Number No

The shipping cost
MerchantVatId String No

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

A payment reference. Should not be used any more. Please use 'Payments' instead.
PaymentInstruction String No

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

The date on which the order was confirmed
BillBeeOrderId Integer No

The Order.Id from the Billbee database
InvoiceAddress Object No
InvoiceAddress.City String No
InvoiceAddress.State String No
InvoiceAddress.Street String No
InvoiceAddress.Country String No
InvoiceAddress.BillbeeId Integer No
InvoiceAddress.LastName String No
InvoiceAddress.Company String No
InvoiceAddress.FirstName String No
InvoiceAddress.Email String No
InvoiceAddress.Line2 String No
InvoiceAddress.HouseNumber String No
InvoiceAddress.NameAddition String No
InvoiceAddress.Zip String No
InvoiceAddress.CountryISO2 String No
InvoiceAddress.Phone String No
ShippingProviderProductName String No

The Name of the used shipping product
ShippingIds[] Array No

The shipments of the order
ShippingIds[].ShippingId String No

The id of this shipment
ShippingIds[].ShippingProviderProductId Integer No

The id of the used shipping provider product
ShippingIds[].ShippingProviderId Integer No

The id of the used shipping provider
ShippingIds[].Created String No

The creation date
ShippingIds[].ShippingCarrier Integer No

The carrier used to ship the parcel with
ShippingIds[].TrackingUrl String No

The url to track this shipment
ShippingIds[].BillbeeId Integer No

The billbee internal id of the shipment
ShippingIds[].ShipmentType Integer No

Shipment Type, 0 if Shipment, 1 if Retoure
ShippingIds[].Shipper String No

The name of the shipping provider
CustomInvoiceNote String No

An optional multiline text which is printed on the invoice
AdjustmentReason String No
InvoiceDate String No

The date on which the invoice was created
Buyer Object No
Buyer.Id String No

The Billbee internal id of this customer
Buyer.FullName String No

The full name ("firstname lastname") of this customer
Buyer.BillbeeShopId Integer No

The Billbee internal id of the shop connection
Buyer.BillbeeShopName String No

The name of shop connection in Billbee
Buyer.LastName String No

The last name of this customer
Buyer.FirstName String No

The first name of this customer
Buyer.Nick String No

The nick name (if available) from the original system
Buyer.Email String No

The email address of this customer
Buyer.Platform String No

The name of the platform from which this customer originated
ShippingProviderProductId Integer No

Internal Id for the used shipping product
PaymentTransactionId String No

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

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

The date on which the order was last updated
InvoiceNumberPostfix String No

The postfix of the invoice number
InvoiceNumberPrefix String No

The prefix of the invoice number
CustomerVatId String No

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

An optional code for the distribution center delivering this order
TaxRate2 Number No

The reduced tax rate
TaxRate1 Number No

The regular tax rate
LanguageCode String No

The two-letter language code of the customer
AdjustmentCost Number No
Seller Object No
Seller.Id String No

The Billbee internal id of this customer
Seller.FullName String No

The full name ("firstname lastname") of this customer
Seller.BillbeeShopId Integer No

The Billbee internal id of the shop connection
Seller.BillbeeShopName String No

The name of shop connection in Billbee
Seller.LastName String No

The last name of this customer
Seller.FirstName String No

The first name of this customer
Seller.Nick String No

The nick name (if available) from the original system
Seller.Email String No

The email address of this customer
Seller.Platform String No

The name of the platform from which this customer originated
ApiAccountName String No

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

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

All messages / comments of the order
Comments[].Id Integer No
Comments[].Name String No
Comments[].Text String No
Comments[].Created String No
Comments[].FromCustomer Boolean No
PayedAt String No

The date on which the order was paid

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2026 SimWorkflow
Terms of Service Privacy Policy