Id int32 — OPTIONAL |
ExternalId string — OPTIONALThe external id of the order. |
PersonalId string — OPTIONALThe personal id or organisation number of the customer. |
CustomerId int32 — OPTIONALThe id of the customer that placed the order. |
CustomerTypeId int32 — OPTIONALCustomer type. Usually 1 for private customers and 2 for companies. |
CustomerGroupId int32 — OPTIONALThe id of the customer group that the customer belongs to, if any. |
CustomerGroupName string — OPTIONALThe name of the customer group that the customer belongs to, if any. |
CreatedAt date-time — OPTIONALDate and time when the order was created. |
UpdatedAt date-time — OPTIONALDate and time when the order was last updated. |
CompletedAt date-time — OPTIONALThe date nd time when the order was completed (eg delivered and paid). |
Status string — OPTIONALThe order status.
Possbile values:
cancelled
on-hold
inactive
refunded
partial
pending-payment
backorder
completed
pending |
Currency string — OPTIONAL |
CurrencyRate double — OPTIONALThe currency rate to SEK. |
MarketId int32 — OPTIONALThe id of the market that this order originates from. |
MarketName string — OPTIONALThe market name. This is usually equal to the site or channel name. |
Language string — OPTIONALTwo-letter language code. |
OrderTotal double — OPTIONAL |
ExpectedSum double — OPTIONALExpected total sum to be paid after discount and balance.
The value is usually taken directly from the payment provider and represents the actual reserved amount.
If this differs from OrderTotal, actions should be taken to ensure they match. This usually happens due to rounding. |
VATTotal double — OPTIONAL |
OrderValueIncVat double — OPTIONALOrder value inc vat after discount but before balance. |
OrderValueExVat double — OPTIONALOrder value ex vat after discount but before balance. |
ItemValueIncVat double — OPTIONALItem value inc vat excluding fees and discount. |
ItemValueExVat double — OPTIONALItem value ex vat excluding fees and discount. |
Discount double — OPTIONAL |
DiscountExVat double — OPTIONAL |
FromBalance double — OPTIONALThe amount which was withdrawn from the customers balance inc vat. |
ShippingFee double — OPTIONAL |
ShippingFeeExVat double — OPTIONAL |
PaymentFee double — OPTIONAL |
PaymentFeeExVat double — OPTIONAL |
Message string — OPTIONALOrder message. Can contain instructions from customer or added details about the order. |
OrderMessages string[] — OPTIONALInternal order messages. Can contain internal details about the order. |
PaymentDetails object[] — OPTIONALId int32 — OPTIONALUnique identifier for this payment detail.
Exception: For some payment options this field can be 0. These orders only have one payment detail. | PaymentId int32 — OPTIONAL | Name string — OPTIONALThe name of the payment method. | DisplayName string — OPTIONALThe display name of the payment method. | TransactionId string — OPTIONALThe transaction id (external reference). | SecondaryTransactionId string — OPTIONALThe secondary transaction id, if any (external reference). | ReservationNumber string — OPTIONALThe reservation number. This field is not available for all payment methods. | ReservationDate date-time — OPTIONAL | PaymentDate date-time — OPTIONALThe date all captures have been processed. | Total double — OPTIONAL | Payed boolean — OPTIONALTrue if all captures have been processed. | PaymentFee double — OPTIONAL | ShippingFee double — OPTIONAL | PaymentOption string — OPTIONALThe name of the payment option, if any.
This doesn't have to be the same as the payment name. Eg "Direct bank payment", "Card", "Invoice" etc. |
|
ShippingDetails object[] — OPTIONALList of shipping details. Id int32 — OPTIONALThe id of the shipping detail. | ShippingId int32 — OPTIONALId of the shipping method. | Name string — OPTIONALName of the shipping method. | ParcelNumber string — OPTIONALParcel number (tracking number). | ShippingDate date-time — OPTIONAL | TrackingUrl string — OPTIONAL | ExternalDeliveryOptionId string — OPTIONALDelivery option id of the external shipping provider. | ExternalServiceId string — OPTIONALService id of the external shipping provider. | ExternalCarrierId string — OPTIONALCarrier id of the external shipping provider. | ExternalDeliveryId string — OPTIONALDelivery id of the external shipping provider. | PickupPoint string — OPTIONAL | ExternalDeliveryData string — OPTIONALExternal delivery data. Usually a JSON string.
Example for nShift: {"agent":{"quickId":"GV004","name":"Gävle ICA Söder","address1":"Södra Kungsgatan 32","address2":null,"zipcode":"80252","city":"Gävle","country":"SE"},"service":{"id":"BUDBEEBOX","name":"Budbee Box","title":"Budbee Box","sourceSystem":"UNIFAUNONLINE"},"senderPartner":{"id":"BUDBEE","agentNo":null,"custNo":"000000","bookingId":"000000"},"prepareId":"00000000000000000000000000000000"} |
|
ShippingAddress object — OPTIONALCompany string — OPTIONAL | CareOf string — OPTIONAL | State string — OPTIONALISO code or name of the state, province or district. | Country string — OPTIONAL | FirstName string — OPTIONALThe first part(s) of the customer name. | LastName string — OPTIONALThe last part(s), or family name of the customer. | Email string — OPTIONALThe email of the customer. | AddressLine1 string — OPTIONALThe first line of the address, usually street and house number. | AddressLine2 string — OPTIONALThe second line of the address. | AddressLine3 string — OPTIONALThe third line of the address. | Zip string — OPTIONAL | City string — OPTIONAL | Phone string — OPTIONALThe (land-line) phone number of the customer. | Mobile string — OPTIONALThe SMS-capable number of the customer. | EntryCode string — OPTIONALThe delivery address entry code, if needed for successful delivery. |
|
BillingAddress object — OPTIONALCompany string — OPTIONAL | CareOf string — OPTIONAL | State string — OPTIONALISO code or name of the state, province or district. | Country string — OPTIONAL | FirstName string — OPTIONALThe first part(s) of the customer name. | LastName string — OPTIONALThe last part(s), or family name of the customer. | Email string — OPTIONALThe email of the customer. | AddressLine1 string — OPTIONALThe first line of the address, usually street and house number. | AddressLine2 string — OPTIONALThe second line of the address. | AddressLine3 string — OPTIONALThe third line of the address. | Zip string — OPTIONAL | City string — OPTIONAL | Phone string — OPTIONALThe (land-line) phone number of the customer. | Mobile string — OPTIONALThe SMS-capable number of the customer. | EntryCode string — OPTIONALThe delivery address entry code, if needed for successful delivery. |
|
Rows object[] — OPTIONALId int32 — OPTIONALThe id of this order row. | ProductId int32 — OPTIONAL | Name string — OPTIONAL | ProductName string — OPTIONAL | ItemId int32 — OPTIONAL | ItemName string — OPTIONAL | ArticleNumber string — OPTIONAL | Total double — OPTIONALOrder row total (affected by quantity). | ExpectedTotalPriceIncVat double — OPTIONALExpected total price inc vat, inc row discount.
The value is usually taken directly from the payment provider and represents the actual paid amount. | DiscountRate double — OPTIONALOrder row discount rate.
E.g. 10% = 10.0 | Discount double — OPTIONALOrder row discount sum inc VAT. | ExpectedTotalDiscountIncVat double — OPTIONALExpected total discount inc vat.
The value is usually taken directly from the payment provider and represents the actual applied discount amount. | VATTotal double — OPTIONALOrder row total VAT (affected by quantity). | VATRate double — OPTIONALVAT rate.
E.g. 25% = 0.25. | Quantity int32 — OPTIONAL | PurchasePrice double — OPTIONALPurchase price of the product. | PaymentDetailId int32 — OPTIONALA reference to the payment detail that this row belongs to. | ShippingDetailId int32 — OPTIONALA reference to the shipping detail that this row belongs to. | Market string — OPTIONALThe market that the order row belongs to. | UnitPrice double — OPTIONALOrder row unit price inc vat, inc row discount. | ProductContainerBuildId int32 — OPTIONALA reference to the product container build the row belongs to. | Message string — OPTIONALA system message for this row. | CartRowId int32 — OPTIONALThe unique identifier for the cart row from which this order row originates. | ExternalId string — OPTIONALThe identifier for the external row from which this order row originates. | ProductContainerSelectionId int32 — OPTIONALThe identifier for a Product container selection id that is part of the product configurator module | ProductContainerName string — OPTIONALThe name of the product container. | ExternalProductId string — OPTIONALExternal Id of the product. | ExternalProductItemId string — OPTIONALExternal Id of the product item. | ParcelGroupId int32 — OPTIONALParcel group id for a shipped order row. | BrandName string — OPTIONALBrand name of the product. | Gtin string — OPTIONAL | Weight int32 — OPTIONALThe weight of the product item in grams (g). | Length int32 — OPTIONALThe length of the product item in millimeters (mm). | Width int32 — OPTIONALThe width of the product item in millimeters (mm). | Height int32 — OPTIONALThe height of the product item in millimeters (mm). | Color string — OPTIONALProduct color.
E.g. Black. | Variant string — OPTIONALProduct variant.
E.g. Black XL. | CampaignIds string[] — OPTIONALThe ids for the campaigns applied to this row. | CampaignGroupData string — OPTIONALContains json data describing the different campaign groups belonging to this row.
Fields:
i -> Campaign Number (int), n -> Number of items belonging to this group. | CampaignGroupId int32 — OPTIONALContains the the ID of the campaign group this row belongs to. | CampaignNames string[] — OPTIONALThe names for the campaigns applied to this row. | CategoryId int32 — OPTIONALThe product category for the product on this order row. | RelatedProductsBuildId string — OPTIONALGUID that connects orderrows that are part of a build. | PackingLocationId int32 — OPTIONALThe packing location of this order row. | ProductPriceCampaignId int32 — OPTIONALThe id of the applied product price campaign. | ProductPriceListId int32 — OPTIONALThe id of the applied product price list. | ProductPackageId int32 — OPTIONALId of the product package used for this row. | ProductPackageName string — OPTIONALName of the product package used for this row. | ProductPackageGroupId uuid — OPTIONALThe unique group id for the product package used for this row.
This separates purchases of multiple packages with the same id. | Status string — OPTIONALStatus of the order row. Possible values are: ready, returned, shipped, cancelled, backorder |
|
Refunds object[] — OPTIONALId int32 — OPTIONAL | OrderRowId int32 — OPTIONALReference to the order row that has been refunded. | PaymentDetailId int32 — OPTIONALReference to the payment detail that has been refunded. | ReturnId int32 — OPTIONALId number of the return. Can be used to group refunds. | ArticleNumber string — OPTIONALArticle number. If the refund is not bound to an order row this field contains an optional refund article number. | CreatedAt date-time — OPTIONALDatetime when the refund was created. | Total double — OPTIONAL | ReasonCode int32 — OPTIONALReason code for the refund. | Reason string — OPTIONAL | ToBalance boolean — OPTIONALShows if the refund was deposited to the customers balance. | Vat double — OPTIONALVat percent in decimals for the refunded amount. | ItemId int32 — OPTIONAL | RefundType string — OPTIONAL |
|
Ip string — OPTIONAL |
UserAgent string — OPTIONAL |
ServiceLocation string — OPTIONAL |
CampaignCode string — OPTIONALCampaign code applied to the order. |
CampaignCodeId int32 — OPTIONALThe internal id of the applied campaign code. |
Percent int32 — OPTIONALGeneral percent discount applied to the order. |
DesiredDeliveryDate date-time — OPTIONALThe desired delivery date of the order. |
Gender boolean — OPTIONALThe gender of the customer.
True = male, False = female, null = unknown. |
CartId int32 — OPTIONALThe id of the cart from which this order originates. |
SessionId string — OPTIONALThe session id for the from which this order originates. |
ExternalOrderStatus int32 — OPTIONALPossible values: [0 , 10 , 20 , 30 , 40 ] 0 = None
10 = New
20 = Processing
30 = Failed
40 = Done |
CampaignIds string[] — OPTIONALThe ids for the campaigns applied to this order (not rows). |
CampaignNames string[] — OPTIONALThe names of the campaigns applied to this order (not rows). |
MetaData object — OPTIONALThe order meta data to store additional information about the order. |
PublicId uuid — OPTIONALThe public id of this order. |