An Order that is not a basket anymoreis a Basket that has gone through the checkout process to become a placed order. The orders are only visible to the users who created them, and can only contain projects that the user created (this is enforced by the Session)cannot be modified.
Requires:
...
Actions
URL | Verb | Information |
|---|---|---|
| /orders | GET | Returns a list of all existing orders for the currently logged in user |
Attributes
The following attributes are for creating or updating a order. (Currently nothing is required to create orders)
| Field | Data Type | Required | Information |
|---|
| /order/{Guid} | GET | Returns a order for the specified {Guid} and the currently logged in user |
| /orders?ProjectGuid= | GET | Returns a list of all existing orders for the currently logged in user and the projectGuid specified in the query string. |
Attributes
The following details are returned about a order.
Field | Data Type | Required | Information | ||||
|---|---|---|---|---|---|---|---|
| GuidOrderGuid | Guid | Y | Used to uniquely identify a basketorder | ||||
| OrderNumber | Integer | Y | A customer friendly order number, unique to the order, assigned when the order is placed | ||||
| Currency | String | Y | The 3 letter ISO code of the currency the order was processed in, for example, "USD" | ||||
| CreatedDateUtc | DateTime | Y | The date time the basket order was created as a basket, in UTC | ||||
| LastSavedDateUtc | DateTime | Y | The date time the basket order was last saved, in UTC | ||||
| CompletedDateUtc | DateTime | Y | The date time the order was completed, in UTC | ||||
| Lines | Array Of Basket Lines | NY | Items in the basket. | ||||
| SubTotal | Decimal | Y | Total amount of the order before shipping and discounts are applied | ||||
| DiscountTotal | Decimal | Y | The total amount the order was discounted by | ||||
| ShippingTotal | Decimal | Y | The total amount paid for shipping on the order | ||||
| OrderTotal | Decimal | Y | Total amount payable for the order. | CompletedDateUTC | DateTime | ||
| Status | OrderStatus | Y | The current status of the order | ||||
| ShippingMethod | String | Y | The date time the basket was completed, in UTC | Status | OrderStatus | Y | Enum status based on status Idname of the shipping method the order was shipped by |
| ShippingAddress | OrderAddress | Y | The address the order was shipped to |