Create an Object

post/add/{TypeCode}

Creates an object. Only one object can be added per request (unless batched).

Information: Some object types may be blocked from being added by the update command as special processing is done by a dedicated manager command.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
TypeCode
required
string

The object's type code. See the list of Type Codes.

Request Body schema: application/json
data
required
object

The initial values of the object. The request needs to contain all fields that are part of the business key for that object and all non-nullable fields.

operation
required
string non-empty

Must be add, null, or omitted.

Responses
200

OK

Request samples
application/json
{
  • "data": {
    • "sku": "product001",
    • "label": "The Label 99",
    • "currency": "USD",
    • "formulaName": "PriceList",
    • "attribute1": "123",
    • "attribute2": "2"
    },
  • "operation": "add"
}