Class Manager
POST /v1/orders

Create a custom order

application/json

Body Required

Request for creating a custom order

  • payload array[object] Required

    Payload for creating a custom order

    Hide payload attributes Show payload attributes object
    • familyId string Required

      Family ID

    • date string(date) Required

      Date to create order for

    • items array[object] Required

      Items to create order for

      Hide items attributes Show items attributes object
      • description string Required

        Description of the order item

      • amount integer Required

        Amount of the order item

      • discount integer | null

        Discount of the order item

      • taxRateId string | null

        Tax Rate ID of the order item

Responses

  • 204

    Successful operation with no content

  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
POST /v1/orders 
curl \
 --request POST 'https://localhost/v1/orders' \
 --header "Content-Type: application/json" \
 --data '{"payload":[{"familyId":"fml_xxxxxxxxxxxxxxxxxxxxxxxxxx","date":"2023-12-05","items":[{"description":"string","amount":100,"discount":100,"taxRateId":"string"}]}]}'
Request examples 
{
  "payload": [
    {
      "familyId": "fml_xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "date": "2023-12-05",
      "items": [
        {
          "description": "string",
          "amount": 100,
          "discount": 100,
          "taxRateId": "string"
        }
      ]
    }
  ]
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (422) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}