Order
We use the same properties from schemaOrg wherever appropriate and it fits the scope.
Order¶
| Property | Type | Description |
|---|---|---|
| orderNumber | string (key) | Readonly. Order Number (identifier): { year }-{ counter } 2-digit-year, counter starts at 100'000 example: 19-100000 |
| orderDate | DateTime | |
| orderDelivery | ParcelDelivery[] | |
| customer | Person | Current copy of the guest placing the order |
| billingAddress | PostalAddress | |
| shippingAddress | PostalAddress | |
| paymentMethodId | string | |
| confirmationNumber | string | A number that confirms the given order or payment has been received. |
| orderStatus | string | Marketplace service Order status |
| priceCurrency | string | CHF |
| totalAmount | double | Total amount in the "priceCurrency" including tax and everything |
| totalAmountCHF | double | Total amount in CHF |
| totalTaxCHF | double | The toal amount of tax included in the totalAmountCHF |
| orderedItem | OrderItem[] | |
| language | string | two-letter-iso-language-code (de, fr, it, en, rm) all text field related to the order are filled in this language. |
| term | TermVersionCheck[] | Readonly. List of accepted terms and conditions |
| mailBodyToken | string | Readonly. Link to the confirmation mail body to show online D365: ambcust_confirmation / Bestätigung |
| expiresAt | DateTime | Readonly. The closest expiration date of one or multiple order items in the order. |
| additionalProperty | PropertyValue[] | List of additional properties related to the order |
Included base profile partner object data¶
| Property | Type | Description |
|---|---|---|
| partnerAcronym | string | Partner acronym |
Included base profile object data¶
| Property | Type | Description |
|---|---|---|
| profileId | string | Readonly. Identifier. Guid generated at the creation of the profile |
| @id | string | json-ld: full url to load the object |
| createdDateTime | DateTime | date and time when the object was created |
| lastModified | DateTime | date and time when the object was last updated |
| lastModifiedBy | string | the person/service which has last updated the object authenticated users: username of Azure B2C guests: profile id |
| createdBySubscription | string | the api subscription name of the creation (→ application) |
| lastModifiedBySubscription | string | the api subscription name on the latest update |
Last update:
January 27, 2023 14:37:03