action billbee_order_api_post_new_order { label: "Creates a new order in the Billbee account" description: "To create an order POST an JSON object to the orders endpoint with the shown properties. \nNot all properties are required." provider: billbee method: POST path: "/api/v1/orders" encoding: form input: { type: "object" 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 \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: "integer" format: "int32" } value: { type: "string" } } } } } } } 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] } shopId: { type: "integer" format: "int64" } } additionalProperties: false } output: { 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 \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: "integer" format: "int32" } value: { type: "string" } } } } } } } 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" } } } }