status

This topic applies to

Applies to

Commerce Web Stores

 

Each JSON object returned by a shopping function has an embedded status object that provides business logic validation of the web store order. The caller of a shopping function, in addition to checking the request status, should also check the status object to determine whether the object can be submitted to the backend and whether there are messages to display.

Field Name

Field Type

Description

In Get Functions?

In Set Functions?

code

string

Code of the status

Following values are supported:

  • error = object contains error

  • incomplete = object is not complete, so cannot be handled by backend

  • ready = object is complete and ready to be submitted to backend

  • success = object successfully processed by backend

fieldstatuses

array of status objects

Status for object fields

messages

array of message objects

Status messages

reasoncode

string

Code of possible reason for the current status