Save Order

post

https://neon-loyalty-qa.spika.com/loyalty/v1/{space}/ordersets/{ordersetLookupId}/orders

Add or Update an Order and all order lines

Path Params

space

string

required

The name of the space (database) assigned to you.

ordersetLookupId

string

required

One of:

The Entity's internal Entity Id
The Entity's name
The Entity's business Id, prefixed with $

Query Params

dim

string

The Dimensions under which the calling application operates.
Format: {dim1}:{value1}[;{dim2}:{value2}[;...]]

includeUnpublished

boolean

If true, also exposes Installed but Unpublished entity resources. Default is false.

response

boolean

Defaults to false

If true, returns the saved content/resource. If false, the response content tag is not populated. Only set to true when the response payload is needed.

Body Params

orderId

string

length ≤ 15

Internal generated order id. Unique within the order set. Leave blank when creating new Orders.

bizOrderId

string

length ≤ 50

Optional business order id or order number, usually coming from an order system. Case sensitive.
Must be unique within the Order Set

orderSetId

string

length ≤ 15

The Order Set Entity Id.

memberId

string

required

length ≤ 15

When querying, returns Member Id. When saving also accepts member Lookup Id (email etc).

state

string

enum

required

length ≤ 20

NEON's Order state. Used for calculating LTV.

Allowed:

bizState

string

length ≤ 20

An optional free-text business-specific state. Ignored by NEON

orderDate

date-time

Date/time when the order was created. If left blank it gets set automatically on creation.

shippingDate

date-time

Optional date/time when the order was shipped.

billingAddress

object

Optional billing address, as Json fields.

shippingAddress

object

Optional shipping address, as Json fields.

currency

string

length ≤ 3

Optional currency information.

dimensions

object

The Dimensions for which the order was first created. Cannot be updated.

data

json

Optional additional data in Json format

lines

array of objects

List of all order lines

lines

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK