Order
GetCurrentOrder
Gets the customers current order.
Arguments
| Name | Type | Default | Description |
|---|
| storeId | long | _storeId | Id of the store. |
| autoCreate | boolean | true | Indicate if a new order should be created if the customer doesn't have one. |
| async | boolean | false | Specifies if a request should be asynchronously. |
| successfn | function(json[, jQForm]) | | A function to be called if the request succeeds. |
| errorfn | function(json) | | A function to be called if the request fails. |
Return values
| Type | Description |
|---|
| order | An order object - without server secure information. |
Example
Arguments
| Name | Type | Description |
|---|
| storeId | long | Id of the store. |
| autoCreate | bool | Indicate if a new order should be created if the customer doesn't have one. |
Return values
| Type | Description |
|---|
| Order | An order object. |
Example
SetCurrentOrder
Sets the customers current order.
Arguments
| Name | Type | Description |
|---|
| storeId | long | Id of the store. |
| orderId | Guid | Unique id of the order. |
Return values
| Type | Description |
|---|
| Order | The new current order object. |
Example
RemoveCurrentOrder
Removes the customers current order from session. The order will not be deleted.
Arguments
| Name | Type | Description |
|---|
| storeId | long | Id of the store. |
Example
Arguments
| Name | Type | Default | Description |
|---|
| storeId | long | _storeId | Id of the store. |
| async | boolean | true | Specifies if a request should be asynchronously. |
| successfn | function(json[, jQForm]) | | A function to be called if the request succeeds. |
| errorfn | function(json) | | A function to be called if the request fails. |
Return values
| Type | Description |
|---|
| methodsCalled | An object containing information about the methods called, related data to the methods and the order object if present.
Will only be returned if you use async = false |
Example
Arguments
| Name | Type | Description |
|---|
| storeId | long | Id of the store. |
Return values
| Type | Description |
|---|
| Order | The removed order object. |
Example
GetCurrentFinalizedOrder
Gets the customers current finalized order.
Arguments
| Name | Type | Default | Description |
|---|
| storeId | long | _storeId | Id of the store. |
| async | boolean | false | Specifies if a request should be asynchronously. |
| successfn | function(json[, jQForm]) | | A function to be called if the request succeeds. |
| errorfn | function(json) | | A function to be called if the request fails. |
Return values
| Type | Description |
|---|
| order | An order object - without server secure information. |
Example
Arguments
| Name | Type | Description |
|---|
| storeId | long | Id of the store. |
Return values
| Type | Description |
|---|
| Order | An order object. |
Example
GetOrder
Gets a specific order.
Arguments
| Name | Type | Default | Description |
|---|
| orderId | Guid | | The unique identifier of the order. |
| storeId | long | _storeId | Id of the store. |
| async | boolean | false | Specifies if a request should be asynchronously. |
| successfn | function(json[, jQForm]) | | A function to be called if the request succeeds. |
| errorfn | function(json) | | A function to be called if the request fails. |
Return values
| Type | Description |
|---|
| order | An order object - without server secure information. |
Example
Arguments
| Name | Type | Description |
|---|
| storeId | long | Id of the store. |
| orderId | Guid | Unique id of the order. |
Return values
| Type | Description |
|---|
| Order | An order object. |
Example
GetOrders
Gets a collection of orders.
Arguments
| Name | Type | Default | Description |
|---|
| orderIds | Guid[] | | List of unique id's of the orders. |
| storeId | long | _storeId | Id of the store. |
| async | boolean | false | Specifies if a request should be asynchronously. |
| successfn | function(json[, jQForm]) | | A function to be called if the request succeeds. |
| errorfn | function(json) | | A function to be called if the request fails. |
Return values
| Type | Description |
|---|
| order[] | An order object - without server secure information. |
Example
Arguments
| Name | Type | Description |
|---|
| storeId | long | Id of the store. |
| orderIds | IEnumerable<Guid> | List of unique id's of the orders. |
Return values
| Type | Description |
|---|
| IEnumerable<Order> | A collection of orders. |
Example
GetFinalizedOrdersForCustomer
Gets all finalized orders for a specific customer.
Arguments
| Name | Type | Default | Description |
|---|
| customerId | string | | The id of the customer. |
| storeId | long | _storeId | Id of the store. |
| async | boolean | false | Specifies if a request should be asynchronously. |
| successfn | function(json[, jQForm]) | | A function to be called if the request succeeds. |
| errorfn | function(json) | | A function to be called if the request fails. |
Return values
| Type | Description |
|---|
| order[] | An order object - without server secure information. |
Example
Arguments
| Name | Type | Description |
|---|
| storeId | long | Id of the store. |
| customerId | string | Id of the customer. |
Return values
| Type | Description |
|---|
| IEnumerable<Order> | A collection of orders. |
Example
Last Updated: 9/2/2019, 10:22:34 AM
