---
title: "Updates one or more fields of an order"
method: PATCH
path: "/api/v1/orders/{id}"
tags: ["Orders"]
---

# Updates one or more fields of an order

`PATCH /api/v1/orders/{id}`

## Path parameters

- `id` integer, required

## Request body

- object

## Response `200`

OK

- RechnungsdruckWebAppControllersApiApiResultOfBillbeeInterfacesBillbeeAPIModelOrder
  - `ErrorMessage` string
  - `ErrorCode` 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 | 29 | 30 | 31
  - `ErrorDescription` 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 | 29 | 30 | 31
  - `Data` BillbeeInterfacesBillbeeAPIModelOrder — A class that represents the Billbee data model of a single order
    - `RebateDifference` number, double
    - `ShippingIds` BillbeeInterfacesBillbeeAPIModelShipment[] — The shipments of the order
      - `BillbeeId` integer — The billbee internal id of the shipment
      - `ShippingId` string — The id of this shipment
      - `Shipper` string — The name of the shipping provider
      - `Created` string, date-time — The creation date
      - `TrackingUrl` string — The url to track this shipment
      - `ShippingProviderId` integer — The id of the used shipping provider
      - `ShippingProviderProductId` integer — The id of the used shipping provider product
      - `ShippingCarrier` integer — The carrier used to ship the parcel with
      - `ShipmentType` integer — Shipment Type, 0 if Shipment, 1 if Retoure
    - `AcceptLossOfReturnRight` boolean — Customer accepts loss due to withdrawal
    - `Id` string — Id of the order in the external system (marketplace)
    - `OrderNumber` string — Order number of the order in the external system (marketplace)
    - `State` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 — The current state of the order
    - `VatMode` 0 | 1 | 2 | 3 | 4 | 5 — The vat mode of the order
    - `CreatedAt` string, date-time, required — The date on which the order was created
    - `ShippedAt` string, date-time — The date on which the order was shipped
    - `ConfirmedAt` string, date-time — The date on which the order was confirmed
    - `PayedAt` string, date-time — The date on which the order was paid
    - `SellerComment` string — An internal seller comment
    - `Comments` BillbeeInterfacesBillbeeAPIModelCommentApiModel[] — All messages / comments of the order
      - `Id` integer
      - `FromCustomer` boolean
      - `Text` string
      - `Name` string
      - `Created` string, date-time
    - `InvoiceNumberPrefix` string — The prefix of the invoice number
    - `InvoiceNumberPostfix` string — The postfix of the invoice number
    - `InvoiceNumber` integer — The invoice number
    - `InvoiceDate` string, date-time — The date on which the invoice was created
    - `InvoiceAddress` BillbeeInterfacesBillbeeAPIModelOrderAddressApiModel
      - `BillbeeId` integer
      - `FirstName` string
      - `LastName` string
      - `Company` string
      - `NameAddition` string
      - `Street` string
      - `HouseNumber` string
      - `Zip` string
      - `City` string
      - `CountryISO2` string
      - `Country` string
      - `Line2` string
      - `Email` string
      - `State` string
      - `Phone` string
    - `ShippingAddress` BillbeeInterfacesBillbeeAPIModelOrderAddressApiModel
      - `BillbeeId` integer
      - `FirstName` string
      - `LastName` string
      - `Company` string
      - `NameAddition` string
      - `Street` string
      - `HouseNumber` string
      - `Zip` string
      - `City` string
      - `CountryISO2` string
      - `Country` string
      - `Line2` string
      - `Email` string
      - `State` string
      - `Phone` string
    - `PaymentMethod` 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 | 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
    - `ShippingCost` number, double — The shipping cost
    - `TotalCost` number, double — The total cost excluding shipping cost
    - `AdjustmentCost` number, double
    - `AdjustmentReason` string
    - `OrderItems` BillbeeInterfacesBillbeeAPIModelOrderItem[] — The list of items purchased like shirt, pant, toys etc
      - `BillbeeId` integer — The billbee id of this item
      - `TransactionId` string — Id of the individual transaction. Only required by Ebay to detect aggregated orders
      - `Product` BillbeeInterfacesBillbeeAPIModelSoldProduct
        - `OldId` string — 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.
        - `Id` string — The id of this product in the external system
        - `Title` string — The name of this product
        - `Weight` integer — Weight of one item in gram
        - `SKU` string — The SKU of this product
        - `SkuOrId` string — The SKU of this product or the id if the SKU is empty
        - `IsDigital` boolean — True if the product is a digital good (download etc.), false if not
        - `Images` BillbeeInterfacesBillbeeAPIModelProductImage[] — The images of this product
          - `Url` string — The url to the image
          - `IsDefaultImage` boolean — True if the image is / should be the default image
          - `Position` integer — The order of this image
          - `ExternalId` string — The id of this image from the original system
        - `PrimaryImageUrl` string
        - `ArticleType` string
        - `EAN` string — The EAN / GTIN of this product
        - `PlatformData` string — Optional platform specific Data as serialized JSON Object for the product
        - `TARICCode` string — The TARIC code
        - `HTSUSCode` string — The HTSUS-Code
        - `CountryOfOrigin` string — The country where this article was made
        - `BillbeeId` integer — The Billbee internal id of the linked product
        - `Type` integer — Indicates whether the article is 1 = normal or 2 = BOM
      - `Quantity` number, double — The sold quantity
      - `TotalPrice` number, double — The total price (unit price * quantity)
      - `TaxAmount` number, double — The tax amount in the total price
      - `TaxIndex` integer — The tax index.
      - `Discount` number, double — Sets the discount in percent
      - `Attributes` BillbeeInterfacesBillbeeAPIModelOrderItemAttribute[] — A list of product attributes for this position
        - `Id` string — The internal id of this attribute
        - `Name` string — The attribute name. E.g. color
        - `Value` string — The attribute value. E.g. red
        - `Price` number, double
      - `GetPriceFromArticleIfAny` boolean — If true, the price will be overwritten by the known article price in billbee if available
      - `IsCoupon` boolean — Determines if it is a coupon, which is interpreted as tax-free payment
      - `ShippingProfileId` string — Determines if it is a coupon, which is interpreted as tax-free payment
      - `DontAdjustStock` boolean — If true, the import of this order won't adjust the stock level at billbee.
      - `UnrebatedTotalPrice` number, double — Is just used for the billbee api
      - `SerialNumber` string — Contains the used serial number
      - `InvoiceSKU` string — Contains the SKU from OrderDetail (if available) or from Product
      - `StockId` integer — Contains the stock id that is assigned to the item
    - `Currency` string — The three letter currency code.
    - `Seller` BillbeeInterfacesBillbeeAPIModelOrderUser
      - `Platform` string — The name of the platform from which this customer originated
      - `BillbeeShopName` string — The name of shop connection in Billbee
      - `BillbeeShopId` integer — The Billbee internal id of the shop connection
      - `Id` string — The Billbee internal id of this customer
      - `Nick` string — The nick name (if available) from the original system
      - `FirstName` string — The first name of this customer
      - `LastName` string — The last name of this customer
      - `FullName` string — The full name ("firstname lastname") of this customer
      - `Email` string — The email address of this customer
    - `Buyer` BillbeeInterfacesBillbeeAPIModelOrderUser
      - `Platform` string — The name of the platform from which this customer originated
      - `BillbeeShopName` string — The name of shop connection in Billbee
      - `BillbeeShopId` integer — The Billbee internal id of the shop connection
      - `Id` string — The Billbee internal id of this customer
      - `Nick` string — The nick name (if available) from the original system
      - `FirstName` string — The first name of this customer
      - `LastName` string — The last name of this customer
      - `FullName` string — The full name ("firstname lastname") of this customer
      - `Email` string — The email address of this customer
    - `UpdatedAt` string, date-time — The date on which the order was last updated
    - `TaxRate1` number, double — The regular tax rate
    - `TaxRate2` number, double — The reduced tax rate
    - `BillBeeOrderId` integer — The Order.Id from the Billbee database
    - `BillBeeParentOrderId` integer — The Id of the parent order in the Billbee database
    - `VatId` string — The customers vat id
    - `Tags` string[] — The Tags of the order
    - `ShipWeightKg` number, double — The total weight of the shipment(s)
    - `LanguageCode` string — The two-letter language code of the customer
    - `PaidAmount` number, double
    - `ShippingProfileId` string — Internal Id for the shipping profile for that order
    - `ShippingProviderId` integer — Internal Id for the used shipping provider
    - `ShippingProviderProductId` integer — Internal Id for the used shipping product
    - `ShippingProviderName` string — The Name for of used shipping provider
    - `ShippingProviderProductName` string — The Name of the used shipping product
    - `ShippingProfileName` string — Display Name of Shipping profile, if available
    - `PaymentInstruction` string — A textfield optionaly filled with a payment instruction text for printout on the invoice (z.B. Ebay Kauf auf Rechnung)
    - `IsCancelationFor` string — An optional Order Id (externalid) for an order if this is a cancel order (shopify only at the moment)
    - `PaymentTransactionId` string — The id of the payment transaction. For example the transaction id of PayPal payment. Should not be used any more. Please use 'Payments' instead.
    - `DistributionCenter` string — An optional code for the distribution center delivering this order
    - `DeliverySourceCountryCode` string — An optional Country ISO2 Code of the country where order is shipped from (FBA)
    - `CustomInvoiceNote` string — An optional multiline text which is printed on the invoice
    - `CustomerNumber` string — The customer number (not to be confused with the id of the customer)
    - `PaymentReference` string — A payment reference
    - `ShippingServices` BillbeeIntegrationChannelModelApiShippingProductService[] — Additional services for the shipment
      - `DisplayName` string
      - `DisplayValue` string
      - `RequiresUserInput` boolean
      - `ShowInput` boolean
      - `ServiceName` string
      - `typeName` string
      - `PossibleValueLists` SystemCollectionsGenericKeyValuePairOfSystemStringAndSystemCollectionsGenericListOfSystemCollectionsGenericKeyValuePairOfSystemInt32AndSystemString[]
        - `key` string
        - `value` SystemCollectionsGenericKeyValuePairOfSystemInt32AndSystemString[]
          - `key` integer
          - `value` string
      - `CanBeConfigured` boolean
      - `HasDynamicValues` boolean
      - `IsRequired` boolean
    - `Customer` BillbeeInterfacesBillbeeAPIModelCustomerApiModel
      - `Id` integer — The Billbee Id of the customer
      - `Name` string
      - `Email` string
      - `Tel1` string
      - `Tel2` string
      - `Number` integer
      - `PriceGroupId` integer
      - `LanguageId` integer
      - `DefaultMailAddress` BillbeeInterfacesBillbeeAPIModelsCustomerMetaDataApiModel
        - `Id` integer
        - `TypeId` integer
        - `TypeName` string
        - `SubType` string
        - `Value` string
      - `DefaultCommercialMailAddress` BillbeeInterfacesBillbeeAPIModelsCustomerMetaDataApiModel
        - `Id` integer
        - `TypeId` integer
        - `TypeName` string
        - `SubType` string
        - `Value` string
      - `DefaultStatusUpdatesMailAddress` BillbeeInterfacesBillbeeAPIModelsCustomerMetaDataApiModel
        - `Id` integer
        - `TypeId` integer
        - `TypeName` string
        - `SubType` string
        - `Value` string
      - `DefaultPhone1` BillbeeInterfacesBillbeeAPIModelsCustomerMetaDataApiModel
        - `Id` integer
        - `TypeId` integer
        - `TypeName` string
        - `SubType` string
        - `Value` string
      - `DefaultPhone2` BillbeeInterfacesBillbeeAPIModelsCustomerMetaDataApiModel
        - `Id` integer
        - `TypeId` integer
        - `TypeName` string
        - `SubType` string
        - `Value` string
      - `DefaultFax` BillbeeInterfacesBillbeeAPIModelsCustomerMetaDataApiModel
        - `Id` integer
        - `TypeId` integer
        - `TypeName` string
        - `SubType` string
        - `Value` string
      - `VatId` string — The vat-id, that should be saved at the customer. Only used if CustomerVatId is not set on the order.
      - `Type` integer — Customer Type
      - `MetaData` BillbeeInterfacesBillbeeAPIModelsCustomerMetaDataApiModel[]
        - `Id` integer
        - `TypeId` integer
        - `TypeName` string
        - `SubType` string
        - `Value` string
      - `ArchivedAt` string, date-time — If set, the customer was already archived at the given date. Further modification is disabled.
      - `RestoredAt` string, date-time — If set, the customer was restored from the archive at the given date.
    - `History` BillbeeInterfacesOrderHistoryEntry[]
      - `Created` string, date-time
      - `EventTypeName` string
      - `Text` string
      - `EmployeeName` string
      - `TypeId` integer
    - `Payments` BillbeeInterfacesBillbeeAPIModelsOrderPayment[]
      - `BillbeeId` integer
      - `TransactionId` string
      - `PayDate` string, date-time
      - `PaymentType` integer
      - `SourceTechnology` string
      - `SourceText` string
      - `PayValue` number, double
      - `Purpose` string
      - `Name` string
    - `LastModifiedAt` string, date-time — Date of the last update, the order got
    - `ArchivedAt` string, date-time — If set, the order was already archived at the given date. Further modification is disabled.
    - `RestoredAt` string, date-time — If set, the order was restored from the archive at the given date.
    - `ApiAccountId` integer — Id of the account, this order belongs to
    - `ApiAccountName` string — The name of the account, this order belongs to. Will be ignored on order creation.
    - `MerchantVatId` string — The vat-id, that should be displayed on the invoice and other order documents
    - `CustomerVatId` string — The vat-id, that was given by the customer to fulfill this order
    - `IsFromBillbeeApi` boolean — Indicates whether the order was created through the Billbee-Api or not.
    - `WebUrl` string — Returns the url to open the order in Billbee.

---

[API](https://skmtc.dev/billbee/apis/billbee-api.md) · [All operations](https://skmtc.dev/billbee/apis/billbee-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/billbee/billbee-api/revisions/e64f07f4f526/schema)