Convictional Developers

Welcome to the Convictional API. This API provides access to our B2B and EDI services.

Versioning

The API uses semantic versioning. Any backwards incompatible changes that are made in the future will represent a major version bump. The current version is: v0.3.1.

Authentication

The API requires authentication against each request. Provide your provided JWT access token in the “Authentication” header of the request to authenticate access to this API.

Response Status

The API uses a variety of status codes to indicates success or failure of a particular request. The 200 series means success, the 400 series means something is wrong on your side, and the 500 series means something is wrong on our side.

Custom Data

The API supports custom data through use of the “metas” resource. Custom attributes can be attached to any other resource, for storing anything not supported. All data is strored as a string so convert it during use according to the type.

Data Types

The API deals in a variety of data types, always encoded in JSON. We support strings, dates, integers and booleans. A JSON schema is provided for each resource and we will reject any incorrectly typed objects to ensure type safety across resources.

Actions

Welcome to the actions API. This API provides access to various actions.

actions

POST https://admin.convictional.com/actions
Requestsaddress
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "format": "X12",
  "document": "{ X12 document }"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "format": {
      "type": "string"
    },
    "document": {
      "type": "string"
    }
  }
}
Responses200
Headers
Content-Type: application/json
Body
{
  "segment": {
    "field[0]": "value",
    "field[1]": "value",
    "field[2]": "value",
    "subfield": {
      "field[0]": "value",
      "field[1]": "value"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "segment": {
      "type": "object",
      "properties": {
        "field[0]": {
          "type": "string"
        },
        "field[1]": {
          "type": "string"
        },
        "field[2]": {
          "type": "string"
        },
        "subfield": {
          "type": "object",
          "properties": {
            "field[0]": {
              "type": "string"
            },
            "field[1]": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Translate Document
POST/actions

Translate an EDI document.


Orders

Welcome to the orders API. This API provides access to the orders service.

orders

POST https://admin.convictional.com/orders
Requestsorder
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Body
{
  "deleted_at": "2000-01-01 00:00:00",
  "status": "STATUS",
  "partner": 1,
  "invoice": 1,
  "items": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "state": true,
      "name": "Hello, world!",
      "amount": 1,
      "quantity": 1,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "transfers": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "orderId": 1,
      "items": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "type": "Hello, world!",
          "state": true,
          "name": "Hello, world!",
          "amount": 1,
          "quantity": 1,
          "custom": [
            {
              "id": 1,
              "created_at": "*2000-01-01 00:00:00*",
              "updated_at": "*2000-01-01 00:00:00*",
              "deleted_at": "*2000-01-01 00:00:00*",
              "key": "Hello, world!",
              "value": "Hello, world!",
              "type": "Hello, world!",
              "ownerId": 1,
              "ownerType": "Hello, world!",
              "state": true,
              "logs": "Hello, world!"
            }
          ],
          "logs": [
            {
              "id": 1,
              "created_at": "*2000-01-01 00:00:00*",
              "updated_at": "*2000-01-01 00:00:00*",
              "deleted_at": "*2000-01-01 00:00:00*",
              "ownerId": 1,
              "ownerType": "Hello, world!",
              "status": 1,
              "method": "Hello, world!",
              "description": "Hello, world!",
              "url": "Hello, world!",
              "company": 1,
              "state": true,
              "custom": "Hello, world!"
            }
          ]
        }
      ],
      "type": "Hello, world!",
      "state": true,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "addresses": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "name": "Hello, world!",
      "company": "Hello, world!",
      "city": "Hello, world!",
      "postal": "Hello, world!",
      "province": "Hello, world!",
      "country": "Hello, world!",
      "addressOne": "Hello, world!",
      "addressTwo": "Hello, world!",
      "state": true,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "company": 1,
  "state": false,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "deleted_at": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "partner": {
      "type": "number"
    },
    "invoice": {
      "type": "number"
    },
    "items": {
      "type": "array"
    },
    "transfers": {
      "type": "array"
    },
    "addresses": {
      "type": "array"
    },
    "company": {
      "type": "number"
    },
    "state": {
      "type": "boolean"
    },
    "custom": {
      "type": "array"
    },
    "logs": {
      "type": "array"
    }
  }
}
Responses201
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "created_at": "*2000-01-01 00:00:00*",
  "updated_at": "*2000-01-01 00:00:00*",
  "deleted_at": "*2000-01-01 00:00:00*",
  "status": "Hello, world!",
  "partner": 1,
  "invoice": 1,
  "items": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "state": true,
      "name": "Hello, world!",
      "amount": 1,
      "quantity": 1,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "transfers": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "orderId": 1,
      "items": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "type": "Hello, world!",
          "state": true,
          "name": "Hello, world!",
          "amount": 1,
          "quantity": 1,
          "custom": [
            {
              "id": 1,
              "created_at": "*2000-01-01 00:00:00*",
              "updated_at": "*2000-01-01 00:00:00*",
              "deleted_at": "*2000-01-01 00:00:00*",
              "key": "Hello, world!",
              "value": "Hello, world!",
              "type": "Hello, world!",
              "ownerId": 1,
              "ownerType": "Hello, world!",
              "state": true,
              "logs": "Hello, world!"
            }
          ],
          "logs": [
            {
              "id": 1,
              "created_at": "*2000-01-01 00:00:00*",
              "updated_at": "*2000-01-01 00:00:00*",
              "deleted_at": "*2000-01-01 00:00:00*",
              "ownerId": 1,
              "ownerType": "Hello, world!",
              "status": 1,
              "method": "Hello, world!",
              "description": "Hello, world!",
              "url": "Hello, world!",
              "company": 1,
              "state": true,
              "custom": "Hello, world!"
            }
          ]
        }
      ],
      "type": "Hello, world!",
      "state": true,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "addresses": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "name": "Hello, world!",
      "company": "Hello, world!",
      "city": "Hello, world!",
      "postal": "Hello, world!",
      "province": "Hello, world!",
      "country": "Hello, world!",
      "addressOne": "Hello, world!",
      "addressTwo": "Hello, world!",
      "state": true,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "company": 1,
  "state": true,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "created_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "updated_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "deleted_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "STATUS"
      ]
    },
    "partner": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "invoice": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "name": {
            "type": "string",
            "enum": [
              "NAME"
            ]
          },
          "amount": {
            "type": "number",
            "enum": [
              1995
            ]
          },
          "quantity": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "custom": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "key": {
                  "type": "string",
                  "enum": [
                    "KEY"
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "VALUE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "logs": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "key",
                "value",
                "type",
                "ownerId",
                "ownerType",
                "state",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "logs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "status": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "method": {
                  "type": "string",
                  "enum": [
                    "METHOD"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "DESCRIPTION"
                  ]
                },
                "url": {
                  "type": "string",
                  "enum": [
                    "URL"
                  ]
                },
                "company": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "custom": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "status",
                "method",
                "description",
                "url",
                "company",
                "state",
                "custom"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "type",
          "state",
          "name",
          "amount",
          "quantity",
          "custom",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "transfers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "orderId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "name": {
                  "type": "string",
                  "enum": [
                    "NAME"
                  ]
                },
                "amount": {
                  "type": "number",
                  "enum": [
                    1995
                  ]
                },
                "quantity": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "custom": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "created_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "updated_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "deleted_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "key": {
                        "type": "string",
                        "enum": [
                          "KEY"
                        ]
                      },
                      "value": {
                        "type": "string",
                        "enum": [
                          "VALUE"
                        ]
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "TYPE"
                        ]
                      },
                      "ownerId": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "ownerType": {
                        "type": "string",
                        "enum": [
                          "OWNERTYPE"
                        ]
                      },
                      "state": {
                        "type": "boolean",
                        "enum": [
                          false
                        ]
                      },
                      "logs": {
                        "type": "string",
                        "enum": [
                          ""
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "created_at",
                      "updated_at",
                      "deleted_at",
                      "key",
                      "value",
                      "type",
                      "ownerId",
                      "ownerType",
                      "state",
                      "logs"
                    ],
                    "additionalProperties": false
                  }
                },
                "logs": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "created_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "updated_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "deleted_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "ownerId": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "ownerType": {
                        "type": "string",
                        "enum": [
                          "OWNERTYPE"
                        ]
                      },
                      "status": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "method": {
                        "type": "string",
                        "enum": [
                          "METHOD"
                        ]
                      },
                      "description": {
                        "type": "string",
                        "enum": [
                          "DESCRIPTION"
                        ]
                      },
                      "url": {
                        "type": "string",
                        "enum": [
                          "URL"
                        ]
                      },
                      "company": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "state": {
                        "type": "boolean",
                        "enum": [
                          false
                        ]
                      },
                      "custom": {
                        "type": "string",
                        "enum": [
                          ""
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "created_at",
                      "updated_at",
                      "deleted_at",
                      "ownerId",
                      "ownerType",
                      "status",
                      "method",
                      "description",
                      "url",
                      "company",
                      "state",
                      "custom"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "type",
                "state",
                "name",
                "amount",
                "quantity",
                "custom",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "key": {
                  "type": "string",
                  "enum": [
                    "KEY"
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "VALUE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "logs": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "key",
                "value",
                "type",
                "ownerId",
                "ownerType",
                "state",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "logs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "status": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "method": {
                  "type": "string",
                  "enum": [
                    "METHOD"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "DESCRIPTION"
                  ]
                },
                "url": {
                  "type": "string",
                  "enum": [
                    "URL"
                  ]
                },
                "company": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "custom": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "status",
                "method",
                "description",
                "url",
                "company",
                "state",
                "custom"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "orderId",
          "items",
          "type",
          "state",
          "custom",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "name": {
            "type": "string",
            "enum": [
              "NAME"
            ]
          },
          "company": {
            "type": "string",
            "enum": [
              "COMPANY"
            ]
          },
          "city": {
            "type": "string",
            "enum": [
              "CITY"
            ]
          },
          "postal": {
            "type": "string",
            "enum": [
              "POSTAL"
            ]
          },
          "province": {
            "type": "string",
            "enum": [
              "PROVINCE"
            ]
          },
          "country": {
            "type": "string",
            "enum": [
              "COUNTRY"
            ]
          },
          "addressOne": {
            "type": "string",
            "enum": [
              "ADDRESSONE"
            ]
          },
          "addressTwo": {
            "type": "string",
            "enum": [
              "ADDRESSTWO"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "key": {
                  "type": "string",
                  "enum": [
                    "KEY"
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "VALUE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "logs": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "key",
                "value",
                "type",
                "ownerId",
                "ownerType",
                "state",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "logs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "status": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "method": {
                  "type": "string",
                  "enum": [
                    "METHOD"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "DESCRIPTION"
                  ]
                },
                "url": {
                  "type": "string",
                  "enum": [
                    "URL"
                  ]
                },
                "company": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "custom": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "status",
                "method",
                "description",
                "url",
                "company",
                "state",
                "custom"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "type",
          "name",
          "company",
          "city",
          "postal",
          "province",
          "country",
          "addressOne",
          "addressTwo",
          "state",
          "custom",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "company": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "state": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "custom": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "key": {
            "type": "string",
            "enum": [
              "KEY"
            ]
          },
          "value": {
            "type": "string",
            "enum": [
              "VALUE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "logs": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "key",
          "value",
          "type",
          "ownerId",
          "ownerType",
          "state",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "status": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "method": {
            "type": "string",
            "enum": [
              "METHOD"
            ]
          },
          "description": {
            "type": "string",
            "enum": [
              "DESCRIPTION"
            ]
          },
          "url": {
            "type": "string",
            "enum": [
              "URL"
            ]
          },
          "company": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "status",
          "method",
          "description",
          "url",
          "company",
          "state",
          "custom"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "created_at",
    "updated_at",
    "deleted_at",
    "status",
    "partner",
    "invoice",
    "items",
    "transfers",
    "addresses",
    "company",
    "state",
    "custom",
    "logs"
  ],
  "additionalProperties": false
}

Create order
POST/orders

Create a new order


GET https://admin.convictional.com/orders
Requestsexample 1
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Responses200
Headers
Content-Type: application/json; charset=utf-8
Body
[
  {
    "id": 1,
    "created_at": "*2000-01-01 00:00:00*",
    "updated_at": "*2000-01-01 00:00:00*",
    "deleted_at": "*2000-01-01 00:00:00*",
    "status": "Hello, world!",
    "partner": 1,
    "invoice": 1,
    "items": [
      {
        "id": 1,
        "created_at": "*2000-01-01 00:00:00*",
        "updated_at": "*2000-01-01 00:00:00*",
        "deleted_at": "*2000-01-01 00:00:00*",
        "ownerId": 1,
        "ownerType": "Hello, world!",
        "type": "Hello, world!",
        "state": true,
        "name": "Hello, world!",
        "amount": 1,
        "quantity": 1,
        "custom": [
          {
            "id": 1,
            "created_at": "*2000-01-01 00:00:00*",
            "updated_at": "*2000-01-01 00:00:00*",
            "deleted_at": "*2000-01-01 00:00:00*",
            "key": "Hello, world!",
            "value": "Hello, world!",
            "type": "Hello, world!",
            "ownerId": 1,
            "ownerType": "Hello, world!",
            "state": true,
            "logs": "Hello, world!"
          }
        ],
        "logs": [
          {
            "id": 1,
            "created_at": "*2000-01-01 00:00:00*",
            "updated_at": "*2000-01-01 00:00:00*",
            "deleted_at": "*2000-01-01 00:00:00*",
            "ownerId": 1,
            "ownerType": "Hello, world!",
            "status": 1,
            "method": "Hello, world!",
            "description": "Hello, world!",
            "url": "Hello, world!",
            "company": 1,
            "state": true,
            "custom": "Hello, world!"
          }
        ]
      }
    ],
    "transfers": [
      {
        "id": 1,
        "created_at": "*2000-01-01 00:00:00*",
        "updated_at": "*2000-01-01 00:00:00*",
        "deleted_at": "*2000-01-01 00:00:00*",
        "orderId": 1,
        "items": [
          {
            "id": 1,
            "created_at": "*2000-01-01 00:00:00*",
            "updated_at": "*2000-01-01 00:00:00*",
            "deleted_at": "*2000-01-01 00:00:00*",
            "ownerId": 1,
            "ownerType": "Hello, world!",
            "type": "Hello, world!",
            "state": true,
            "name": "Hello, world!",
            "amount": 1,
            "quantity": 1,
            "custom": [
              {
                "id": 1,
                "created_at": "*2000-01-01 00:00:00*",
                "updated_at": "*2000-01-01 00:00:00*",
                "deleted_at": "*2000-01-01 00:00:00*",
                "key": "Hello, world!",
                "value": "Hello, world!",
                "type": "Hello, world!",
                "ownerId": 1,
                "ownerType": "Hello, world!",
                "state": true,
                "logs": "Hello, world!"
              }
            ],
            "logs": [
              {
                "id": 1,
                "created_at": "*2000-01-01 00:00:00*",
                "updated_at": "*2000-01-01 00:00:00*",
                "deleted_at": "*2000-01-01 00:00:00*",
                "ownerId": 1,
                "ownerType": "Hello, world!",
                "status": 1,
                "method": "Hello, world!",
                "description": "Hello, world!",
                "url": "Hello, world!",
                "company": 1,
                "state": true,
                "custom": "Hello, world!"
              }
            ]
          }
        ],
        "type": "Hello, world!",
        "state": true,
        "custom": [
          {
            "id": 1,
            "created_at": "*2000-01-01 00:00:00*",
            "updated_at": "*2000-01-01 00:00:00*",
            "deleted_at": "*2000-01-01 00:00:00*",
            "key": "Hello, world!",
            "value": "Hello, world!",
            "type": "Hello, world!",
            "ownerId": 1,
            "ownerType": "Hello, world!",
            "state": true,
            "logs": "Hello, world!"
          }
        ],
        "logs": [
          {
            "id": 1,
            "created_at": "*2000-01-01 00:00:00*",
            "updated_at": "*2000-01-01 00:00:00*",
            "deleted_at": "*2000-01-01 00:00:00*",
            "ownerId": 1,
            "ownerType": "Hello, world!",
            "status": 1,
            "method": "Hello, world!",
            "description": "Hello, world!",
            "url": "Hello, world!",
            "company": 1,
            "state": true,
            "custom": "Hello, world!"
          }
        ]
      }
    ],
    "addresses": [
      {
        "id": 1,
        "created_at": "*2000-01-01 00:00:00*",
        "updated_at": "*2000-01-01 00:00:00*",
        "deleted_at": "*2000-01-01 00:00:00*",
        "ownerId": 1,
        "ownerType": "Hello, world!",
        "type": "Hello, world!",
        "name": "Hello, world!",
        "company": "Hello, world!",
        "city": "Hello, world!",
        "postal": "Hello, world!",
        "province": "Hello, world!",
        "country": "Hello, world!",
        "addressOne": "Hello, world!",
        "addressTwo": "Hello, world!",
        "state": true,
        "custom": [
          {
            "id": 1,
            "created_at": "*2000-01-01 00:00:00*",
            "updated_at": "*2000-01-01 00:00:00*",
            "deleted_at": "*2000-01-01 00:00:00*",
            "key": "Hello, world!",
            "value": "Hello, world!",
            "type": "Hello, world!",
            "ownerId": 1,
            "ownerType": "Hello, world!",
            "state": true,
            "logs": "Hello, world!"
          }
        ],
        "logs": [
          {
            "id": 1,
            "created_at": "*2000-01-01 00:00:00*",
            "updated_at": "*2000-01-01 00:00:00*",
            "deleted_at": "*2000-01-01 00:00:00*",
            "ownerId": 1,
            "ownerType": "Hello, world!",
            "status": 1,
            "method": "Hello, world!",
            "description": "Hello, world!",
            "url": "Hello, world!",
            "company": 1,
            "state": true,
            "custom": "Hello, world!"
          }
        ]
      }
    ],
    "company": 1,
    "state": true,
    "custom": [
      {
        "id": 1,
        "created_at": "*2000-01-01 00:00:00*",
        "updated_at": "*2000-01-01 00:00:00*",
        "deleted_at": "*2000-01-01 00:00:00*",
        "key": "Hello, world!",
        "value": "Hello, world!",
        "type": "Hello, world!",
        "ownerId": 1,
        "ownerType": "Hello, world!",
        "state": true,
        "logs": "Hello, world!"
      }
    ],
    "logs": [
      {
        "id": 1,
        "created_at": "*2000-01-01 00:00:00*",
        "updated_at": "*2000-01-01 00:00:00*",
        "deleted_at": "*2000-01-01 00:00:00*",
        "ownerId": 1,
        "ownerType": "Hello, world!",
        "status": 1,
        "method": "Hello, world!",
        "description": "Hello, world!",
        "url": "Hello, world!",
        "company": 1,
        "state": true,
        "custom": "Hello, world!"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number",
        "enum": [
          1
        ]
      },
      "created_at": {
        "type": "string",
        "enum": [
          "*2000-01-01 00:00:00*"
        ]
      },
      "updated_at": {
        "type": "string",
        "enum": [
          "*2000-01-01 00:00:00*"
        ]
      },
      "deleted_at": {
        "type": "string",
        "enum": [
          "*2000-01-01 00:00:00*"
        ]
      },
      "status": {
        "type": "string",
        "enum": [
          "STATUS"
        ]
      },
      "partner": {
        "type": "number",
        "enum": [
          1
        ]
      },
      "invoice": {
        "type": "number",
        "enum": [
          1
        ]
      },
      "items": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "created_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "updated_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "deleted_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "ownerId": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "ownerType": {
              "type": "string",
              "enum": [
                "OWNERTYPE"
              ]
            },
            "type": {
              "type": "string",
              "enum": [
                "TYPE"
              ]
            },
            "state": {
              "type": "boolean",
              "enum": [
                false
              ]
            },
            "name": {
              "type": "string",
              "enum": [
                "NAME"
              ]
            },
            "amount": {
              "type": "number",
              "enum": [
                1995
              ]
            },
            "quantity": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "custom": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "created_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "updated_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "deleted_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "key": {
                    "type": "string",
                    "enum": [
                      "KEY"
                    ]
                  },
                  "value": {
                    "type": "string",
                    "enum": [
                      "VALUE"
                    ]
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "TYPE"
                    ]
                  },
                  "ownerId": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "ownerType": {
                    "type": "string",
                    "enum": [
                      "OWNERTYPE"
                    ]
                  },
                  "state": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "logs": {
                    "type": "string",
                    "enum": [
                      ""
                    ]
                  }
                },
                "required": [
                  "id",
                  "created_at",
                  "updated_at",
                  "deleted_at",
                  "key",
                  "value",
                  "type",
                  "ownerId",
                  "ownerType",
                  "state",
                  "logs"
                ],
                "additionalProperties": false
              }
            },
            "logs": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "created_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "updated_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "deleted_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "ownerId": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "ownerType": {
                    "type": "string",
                    "enum": [
                      "OWNERTYPE"
                    ]
                  },
                  "status": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "method": {
                    "type": "string",
                    "enum": [
                      "METHOD"
                    ]
                  },
                  "description": {
                    "type": "string",
                    "enum": [
                      "DESCRIPTION"
                    ]
                  },
                  "url": {
                    "type": "string",
                    "enum": [
                      "URL"
                    ]
                  },
                  "company": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "state": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "custom": {
                    "type": "string",
                    "enum": [
                      ""
                    ]
                  }
                },
                "required": [
                  "id",
                  "created_at",
                  "updated_at",
                  "deleted_at",
                  "ownerId",
                  "ownerType",
                  "status",
                  "method",
                  "description",
                  "url",
                  "company",
                  "state",
                  "custom"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "id",
            "created_at",
            "updated_at",
            "deleted_at",
            "ownerId",
            "ownerType",
            "type",
            "state",
            "name",
            "amount",
            "quantity",
            "custom",
            "logs"
          ],
          "additionalProperties": false
        }
      },
      "transfers": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "created_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "updated_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "deleted_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "orderId": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "items": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "created_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "updated_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "deleted_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "ownerId": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "ownerType": {
                    "type": "string",
                    "enum": [
                      "OWNERTYPE"
                    ]
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "TYPE"
                    ]
                  },
                  "state": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "name": {
                    "type": "string",
                    "enum": [
                      "NAME"
                    ]
                  },
                  "amount": {
                    "type": "number",
                    "enum": [
                      1995
                    ]
                  },
                  "quantity": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "custom": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number",
                          "enum": [
                            1
                          ]
                        },
                        "created_at": {
                          "type": "string",
                          "enum": [
                            "*2000-01-01 00:00:00*"
                          ]
                        },
                        "updated_at": {
                          "type": "string",
                          "enum": [
                            "*2000-01-01 00:00:00*"
                          ]
                        },
                        "deleted_at": {
                          "type": "string",
                          "enum": [
                            "*2000-01-01 00:00:00*"
                          ]
                        },
                        "key": {
                          "type": "string",
                          "enum": [
                            "KEY"
                          ]
                        },
                        "value": {
                          "type": "string",
                          "enum": [
                            "VALUE"
                          ]
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "TYPE"
                          ]
                        },
                        "ownerId": {
                          "type": "number",
                          "enum": [
                            1
                          ]
                        },
                        "ownerType": {
                          "type": "string",
                          "enum": [
                            "OWNERTYPE"
                          ]
                        },
                        "state": {
                          "type": "boolean",
                          "enum": [
                            false
                          ]
                        },
                        "logs": {
                          "type": "string",
                          "enum": [
                            ""
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "created_at",
                        "updated_at",
                        "deleted_at",
                        "key",
                        "value",
                        "type",
                        "ownerId",
                        "ownerType",
                        "state",
                        "logs"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "logs": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number",
                          "enum": [
                            1
                          ]
                        },
                        "created_at": {
                          "type": "string",
                          "enum": [
                            "*2000-01-01 00:00:00*"
                          ]
                        },
                        "updated_at": {
                          "type": "string",
                          "enum": [
                            "*2000-01-01 00:00:00*"
                          ]
                        },
                        "deleted_at": {
                          "type": "string",
                          "enum": [
                            "*2000-01-01 00:00:00*"
                          ]
                        },
                        "ownerId": {
                          "type": "number",
                          "enum": [
                            1
                          ]
                        },
                        "ownerType": {
                          "type": "string",
                          "enum": [
                            "OWNERTYPE"
                          ]
                        },
                        "status": {
                          "type": "number",
                          "enum": [
                            1
                          ]
                        },
                        "method": {
                          "type": "string",
                          "enum": [
                            "METHOD"
                          ]
                        },
                        "description": {
                          "type": "string",
                          "enum": [
                            "DESCRIPTION"
                          ]
                        },
                        "url": {
                          "type": "string",
                          "enum": [
                            "URL"
                          ]
                        },
                        "company": {
                          "type": "number",
                          "enum": [
                            1
                          ]
                        },
                        "state": {
                          "type": "boolean",
                          "enum": [
                            false
                          ]
                        },
                        "custom": {
                          "type": "string",
                          "enum": [
                            ""
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "created_at",
                        "updated_at",
                        "deleted_at",
                        "ownerId",
                        "ownerType",
                        "status",
                        "method",
                        "description",
                        "url",
                        "company",
                        "state",
                        "custom"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "required": [
                  "id",
                  "created_at",
                  "updated_at",
                  "deleted_at",
                  "ownerId",
                  "ownerType",
                  "type",
                  "state",
                  "name",
                  "amount",
                  "quantity",
                  "custom",
                  "logs"
                ],
                "additionalProperties": false
              }
            },
            "type": {
              "type": "string",
              "enum": [
                "TYPE"
              ]
            },
            "state": {
              "type": "boolean",
              "enum": [
                false
              ]
            },
            "custom": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "created_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "updated_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "deleted_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "key": {
                    "type": "string",
                    "enum": [
                      "KEY"
                    ]
                  },
                  "value": {
                    "type": "string",
                    "enum": [
                      "VALUE"
                    ]
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "TYPE"
                    ]
                  },
                  "ownerId": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "ownerType": {
                    "type": "string",
                    "enum": [
                      "OWNERTYPE"
                    ]
                  },
                  "state": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "logs": {
                    "type": "string",
                    "enum": [
                      ""
                    ]
                  }
                },
                "required": [
                  "id",
                  "created_at",
                  "updated_at",
                  "deleted_at",
                  "key",
                  "value",
                  "type",
                  "ownerId",
                  "ownerType",
                  "state",
                  "logs"
                ],
                "additionalProperties": false
              }
            },
            "logs": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "created_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "updated_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "deleted_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "ownerId": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "ownerType": {
                    "type": "string",
                    "enum": [
                      "OWNERTYPE"
                    ]
                  },
                  "status": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "method": {
                    "type": "string",
                    "enum": [
                      "METHOD"
                    ]
                  },
                  "description": {
                    "type": "string",
                    "enum": [
                      "DESCRIPTION"
                    ]
                  },
                  "url": {
                    "type": "string",
                    "enum": [
                      "URL"
                    ]
                  },
                  "company": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "state": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "custom": {
                    "type": "string",
                    "enum": [
                      ""
                    ]
                  }
                },
                "required": [
                  "id",
                  "created_at",
                  "updated_at",
                  "deleted_at",
                  "ownerId",
                  "ownerType",
                  "status",
                  "method",
                  "description",
                  "url",
                  "company",
                  "state",
                  "custom"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "id",
            "created_at",
            "updated_at",
            "deleted_at",
            "orderId",
            "items",
            "type",
            "state",
            "custom",
            "logs"
          ],
          "additionalProperties": false
        }
      },
      "addresses": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "created_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "updated_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "deleted_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "ownerId": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "ownerType": {
              "type": "string",
              "enum": [
                "OWNERTYPE"
              ]
            },
            "type": {
              "type": "string",
              "enum": [
                "TYPE"
              ]
            },
            "name": {
              "type": "string",
              "enum": [
                "NAME"
              ]
            },
            "company": {
              "type": "string",
              "enum": [
                "COMPANY"
              ]
            },
            "city": {
              "type": "string",
              "enum": [
                "CITY"
              ]
            },
            "postal": {
              "type": "string",
              "enum": [
                "POSTAL"
              ]
            },
            "province": {
              "type": "string",
              "enum": [
                "PROVINCE"
              ]
            },
            "country": {
              "type": "string",
              "enum": [
                "COUNTRY"
              ]
            },
            "addressOne": {
              "type": "string",
              "enum": [
                "ADDRESSONE"
              ]
            },
            "addressTwo": {
              "type": "string",
              "enum": [
                "ADDRESSTWO"
              ]
            },
            "state": {
              "type": "boolean",
              "enum": [
                false
              ]
            },
            "custom": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "created_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "updated_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "deleted_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "key": {
                    "type": "string",
                    "enum": [
                      "KEY"
                    ]
                  },
                  "value": {
                    "type": "string",
                    "enum": [
                      "VALUE"
                    ]
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "TYPE"
                    ]
                  },
                  "ownerId": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "ownerType": {
                    "type": "string",
                    "enum": [
                      "OWNERTYPE"
                    ]
                  },
                  "state": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "logs": {
                    "type": "string",
                    "enum": [
                      ""
                    ]
                  }
                },
                "required": [
                  "id",
                  "created_at",
                  "updated_at",
                  "deleted_at",
                  "key",
                  "value",
                  "type",
                  "ownerId",
                  "ownerType",
                  "state",
                  "logs"
                ],
                "additionalProperties": false
              }
            },
            "logs": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "created_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "updated_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "deleted_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "ownerId": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "ownerType": {
                    "type": "string",
                    "enum": [
                      "OWNERTYPE"
                    ]
                  },
                  "status": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "method": {
                    "type": "string",
                    "enum": [
                      "METHOD"
                    ]
                  },
                  "description": {
                    "type": "string",
                    "enum": [
                      "DESCRIPTION"
                    ]
                  },
                  "url": {
                    "type": "string",
                    "enum": [
                      "URL"
                    ]
                  },
                  "company": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "state": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "custom": {
                    "type": "string",
                    "enum": [
                      ""
                    ]
                  }
                },
                "required": [
                  "id",
                  "created_at",
                  "updated_at",
                  "deleted_at",
                  "ownerId",
                  "ownerType",
                  "status",
                  "method",
                  "description",
                  "url",
                  "company",
                  "state",
                  "custom"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "id",
            "created_at",
            "updated_at",
            "deleted_at",
            "ownerId",
            "ownerType",
            "type",
            "name",
            "company",
            "city",
            "postal",
            "province",
            "country",
            "addressOne",
            "addressTwo",
            "state",
            "custom",
            "logs"
          ],
          "additionalProperties": false
        }
      },
      "company": {
        "type": "number",
        "enum": [
          1
        ]
      },
      "state": {
        "type": "boolean",
        "enum": [
          false
        ]
      },
      "custom": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "created_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "updated_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "deleted_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "key": {
              "type": "string",
              "enum": [
                "KEY"
              ]
            },
            "value": {
              "type": "string",
              "enum": [
                "VALUE"
              ]
            },
            "type": {
              "type": "string",
              "enum": [
                "TYPE"
              ]
            },
            "ownerId": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "ownerType": {
              "type": "string",
              "enum": [
                "OWNERTYPE"
              ]
            },
            "state": {
              "type": "boolean",
              "enum": [
                false
              ]
            },
            "logs": {
              "type": "string",
              "enum": [
                ""
              ]
            }
          },
          "required": [
            "id",
            "created_at",
            "updated_at",
            "deleted_at",
            "key",
            "value",
            "type",
            "ownerId",
            "ownerType",
            "state",
            "logs"
          ],
          "additionalProperties": false
        }
      },
      "logs": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "created_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "updated_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "deleted_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "ownerId": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "ownerType": {
              "type": "string",
              "enum": [
                "OWNERTYPE"
              ]
            },
            "status": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "method": {
              "type": "string",
              "enum": [
                "METHOD"
              ]
            },
            "description": {
              "type": "string",
              "enum": [
                "DESCRIPTION"
              ]
            },
            "url": {
              "type": "string",
              "enum": [
                "URL"
              ]
            },
            "company": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "state": {
              "type": "boolean",
              "enum": [
                false
              ]
            },
            "custom": {
              "type": "string",
              "enum": [
                ""
              ]
            }
          },
          "required": [
            "id",
            "created_at",
            "updated_at",
            "deleted_at",
            "ownerId",
            "ownerType",
            "status",
            "method",
            "description",
            "url",
            "company",
            "state",
            "custom"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "id",
      "created_at",
      "updated_at",
      "deleted_at",
      "status",
      "partner",
      "invoice",
      "items",
      "transfers",
      "addresses",
      "company",
      "state",
      "custom",
      "logs"
    ],
    "additionalProperties": false
  }
}

Get orders
GET/orders

Returns an order list.

URI Parameters
HideShow
fields
string (optional) Default: all Example: type,state

Fields to receive.

preloads
string (optional) Default: (empty) Example: custom

Nested resources to preload.

pretty
boolean (optional) Default: false Example: false

Prettify JSON response.

stream
boolean (optional) Default: false Example: false

Return JSON in streaming format.

q[field_name]
string (optional) Default: (empty) Example: q[id]=1,2,5

A parameter for each field.

limit
number (optional) Default: 25 Example: 50

Maximum number of items.

page
number (optional) Default: 1 Example: 3

Page to receive.


order details

GET https://admin.convictional.com/orders/1
Requestsexample 1
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Responses200
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "created_at": "*2000-01-01 00:00:00*",
  "updated_at": "*2000-01-01 00:00:00*",
  "deleted_at": "*2000-01-01 00:00:00*",
  "status": "Hello, world!",
  "partner": 1,
  "invoice": 1,
  "items": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "state": true,
      "name": "Hello, world!",
      "amount": 1,
      "quantity": 1,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "transfers": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "orderId": 1,
      "items": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "type": "Hello, world!",
          "state": true,
          "name": "Hello, world!",
          "amount": 1,
          "quantity": 1,
          "custom": [
            {
              "id": 1,
              "created_at": "*2000-01-01 00:00:00*",
              "updated_at": "*2000-01-01 00:00:00*",
              "deleted_at": "*2000-01-01 00:00:00*",
              "key": "Hello, world!",
              "value": "Hello, world!",
              "type": "Hello, world!",
              "ownerId": 1,
              "ownerType": "Hello, world!",
              "state": true,
              "logs": "Hello, world!"
            }
          ],
          "logs": [
            {
              "id": 1,
              "created_at": "*2000-01-01 00:00:00*",
              "updated_at": "*2000-01-01 00:00:00*",
              "deleted_at": "*2000-01-01 00:00:00*",
              "ownerId": 1,
              "ownerType": "Hello, world!",
              "status": 1,
              "method": "Hello, world!",
              "description": "Hello, world!",
              "url": "Hello, world!",
              "company": 1,
              "state": true,
              "custom": "Hello, world!"
            }
          ]
        }
      ],
      "type": "Hello, world!",
      "state": true,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "addresses": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "name": "Hello, world!",
      "company": "Hello, world!",
      "city": "Hello, world!",
      "postal": "Hello, world!",
      "province": "Hello, world!",
      "country": "Hello, world!",
      "addressOne": "Hello, world!",
      "addressTwo": "Hello, world!",
      "state": true,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "company": 1,
  "state": true,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "created_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "updated_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "deleted_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "STATUS"
      ]
    },
    "partner": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "invoice": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "name": {
            "type": "string",
            "enum": [
              "NAME"
            ]
          },
          "amount": {
            "type": "number",
            "enum": [
              1995
            ]
          },
          "quantity": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "custom": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "key": {
                  "type": "string",
                  "enum": [
                    "KEY"
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "VALUE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "logs": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "key",
                "value",
                "type",
                "ownerId",
                "ownerType",
                "state",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "logs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "status": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "method": {
                  "type": "string",
                  "enum": [
                    "METHOD"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "DESCRIPTION"
                  ]
                },
                "url": {
                  "type": "string",
                  "enum": [
                    "URL"
                  ]
                },
                "company": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "custom": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "status",
                "method",
                "description",
                "url",
                "company",
                "state",
                "custom"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "type",
          "state",
          "name",
          "amount",
          "quantity",
          "custom",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "transfers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "orderId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "name": {
                  "type": "string",
                  "enum": [
                    "NAME"
                  ]
                },
                "amount": {
                  "type": "number",
                  "enum": [
                    1995
                  ]
                },
                "quantity": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "custom": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "created_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "updated_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "deleted_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "key": {
                        "type": "string",
                        "enum": [
                          "KEY"
                        ]
                      },
                      "value": {
                        "type": "string",
                        "enum": [
                          "VALUE"
                        ]
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "TYPE"
                        ]
                      },
                      "ownerId": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "ownerType": {
                        "type": "string",
                        "enum": [
                          "OWNERTYPE"
                        ]
                      },
                      "state": {
                        "type": "boolean",
                        "enum": [
                          false
                        ]
                      },
                      "logs": {
                        "type": "string",
                        "enum": [
                          ""
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "created_at",
                      "updated_at",
                      "deleted_at",
                      "key",
                      "value",
                      "type",
                      "ownerId",
                      "ownerType",
                      "state",
                      "logs"
                    ],
                    "additionalProperties": false
                  }
                },
                "logs": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "created_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "updated_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "deleted_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "ownerId": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "ownerType": {
                        "type": "string",
                        "enum": [
                          "OWNERTYPE"
                        ]
                      },
                      "status": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "method": {
                        "type": "string",
                        "enum": [
                          "METHOD"
                        ]
                      },
                      "description": {
                        "type": "string",
                        "enum": [
                          "DESCRIPTION"
                        ]
                      },
                      "url": {
                        "type": "string",
                        "enum": [
                          "URL"
                        ]
                      },
                      "company": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "state": {
                        "type": "boolean",
                        "enum": [
                          false
                        ]
                      },
                      "custom": {
                        "type": "string",
                        "enum": [
                          ""
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "created_at",
                      "updated_at",
                      "deleted_at",
                      "ownerId",
                      "ownerType",
                      "status",
                      "method",
                      "description",
                      "url",
                      "company",
                      "state",
                      "custom"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "type",
                "state",
                "name",
                "amount",
                "quantity",
                "custom",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "key": {
                  "type": "string",
                  "enum": [
                    "KEY"
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "VALUE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "logs": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "key",
                "value",
                "type",
                "ownerId",
                "ownerType",
                "state",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "logs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "status": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "method": {
                  "type": "string",
                  "enum": [
                    "METHOD"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "DESCRIPTION"
                  ]
                },
                "url": {
                  "type": "string",
                  "enum": [
                    "URL"
                  ]
                },
                "company": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "custom": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "status",
                "method",
                "description",
                "url",
                "company",
                "state",
                "custom"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "orderId",
          "items",
          "type",
          "state",
          "custom",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "name": {
            "type": "string",
            "enum": [
              "NAME"
            ]
          },
          "company": {
            "type": "string",
            "enum": [
              "COMPANY"
            ]
          },
          "city": {
            "type": "string",
            "enum": [
              "CITY"
            ]
          },
          "postal": {
            "type": "string",
            "enum": [
              "POSTAL"
            ]
          },
          "province": {
            "type": "string",
            "enum": [
              "PROVINCE"
            ]
          },
          "country": {
            "type": "string",
            "enum": [
              "COUNTRY"
            ]
          },
          "addressOne": {
            "type": "string",
            "enum": [
              "ADDRESSONE"
            ]
          },
          "addressTwo": {
            "type": "string",
            "enum": [
              "ADDRESSTWO"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "key": {
                  "type": "string",
                  "enum": [
                    "KEY"
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "VALUE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "logs": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "key",
                "value",
                "type",
                "ownerId",
                "ownerType",
                "state",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "logs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "status": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "method": {
                  "type": "string",
                  "enum": [
                    "METHOD"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "DESCRIPTION"
                  ]
                },
                "url": {
                  "type": "string",
                  "enum": [
                    "URL"
                  ]
                },
                "company": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "custom": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "status",
                "method",
                "description",
                "url",
                "company",
                "state",
                "custom"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "type",
          "name",
          "company",
          "city",
          "postal",
          "province",
          "country",
          "addressOne",
          "addressTwo",
          "state",
          "custom",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "company": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "state": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "custom": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "key": {
            "type": "string",
            "enum": [
              "KEY"
            ]
          },
          "value": {
            "type": "string",
            "enum": [
              "VALUE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "logs": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "key",
          "value",
          "type",
          "ownerId",
          "ownerType",
          "state",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "status": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "method": {
            "type": "string",
            "enum": [
              "METHOD"
            ]
          },
          "description": {
            "type": "string",
            "enum": [
              "DESCRIPTION"
            ]
          },
          "url": {
            "type": "string",
            "enum": [
              "URL"
            ]
          },
          "company": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "status",
          "method",
          "description",
          "url",
          "company",
          "state",
          "custom"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "created_at",
    "updated_at",
    "deleted_at",
    "status",
    "partner",
    "invoice",
    "items",
    "transfers",
    "addresses",
    "company",
    "state",
    "custom",
    "logs"
  ],
  "additionalProperties": false
}

Get order
GET/orders/{id}

Returns an order.

URI Parameters
HideShow
id
string (required) Example: 1

The ID of the desired order.

Choices: 1 2 3

fields
string (optional) Default: all Example: type,state

Fields to receive.

preloads
string (optional) Default: (empty) Example: custom

Nested resources to preload.

pretty
boolean (optional) Default: false Example: false

Prettify JSON response.


PUT https://admin.convictional.com/orders/1
Requestsorder
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Body
{
  "id": 1,
  "created_at": "2000-01-01 00:00:00",
  "updated_at": "2000-01-01 00:00:00",
  "deleted_at": "2000-01-01 00:00:00",
  "status": "STATUS",
  "partner": 1,
  "invoice": 1,
  "items": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "state": true,
      "name": "Hello, world!",
      "amount": 1,
      "quantity": 1,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "transfers": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "orderId": 1,
      "items": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "type": "Hello, world!",
          "state": true,
          "name": "Hello, world!",
          "amount": 1,
          "quantity": 1,
          "custom": [
            {
              "id": 1,
              "created_at": "*2000-01-01 00:00:00*",
              "updated_at": "*2000-01-01 00:00:00*",
              "deleted_at": "*2000-01-01 00:00:00*",
              "key": "Hello, world!",
              "value": "Hello, world!",
              "type": "Hello, world!",
              "ownerId": 1,
              "ownerType": "Hello, world!",
              "state": true,
              "logs": "Hello, world!"
            }
          ],
          "logs": [
            {
              "id": 1,
              "created_at": "*2000-01-01 00:00:00*",
              "updated_at": "*2000-01-01 00:00:00*",
              "deleted_at": "*2000-01-01 00:00:00*",
              "ownerId": 1,
              "ownerType": "Hello, world!",
              "status": 1,
              "method": "Hello, world!",
              "description": "Hello, world!",
              "url": "Hello, world!",
              "company": 1,
              "state": true,
              "custom": "Hello, world!"
            }
          ]
        }
      ],
      "type": "Hello, world!",
      "state": true,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "addresses": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "name": "Hello, world!",
      "company": "Hello, world!",
      "city": "Hello, world!",
      "postal": "Hello, world!",
      "province": "Hello, world!",
      "country": "Hello, world!",
      "addressOne": "Hello, world!",
      "addressTwo": "Hello, world!",
      "state": true,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "company": 1,
  "state": false,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "deleted_at": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "partner": {
      "type": "number"
    },
    "invoice": {
      "type": "number"
    },
    "items": {
      "type": "array"
    },
    "transfers": {
      "type": "array"
    },
    "addresses": {
      "type": "array"
    },
    "company": {
      "type": "number"
    },
    "state": {
      "type": "boolean"
    },
    "custom": {
      "type": "array"
    },
    "logs": {
      "type": "array"
    }
  }
}
Responses200
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "created_at": "*2000-01-01 00:00:00*",
  "updated_at": "*2000-01-01 00:00:00*",
  "deleted_at": "*2000-01-01 00:00:00*",
  "status": "Hello, world!",
  "partner": 1,
  "invoice": 1,
  "items": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "state": true,
      "name": "Hello, world!",
      "amount": 1,
      "quantity": 1,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "transfers": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "orderId": 1,
      "items": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "type": "Hello, world!",
          "state": true,
          "name": "Hello, world!",
          "amount": 1,
          "quantity": 1,
          "custom": [
            {
              "id": 1,
              "created_at": "*2000-01-01 00:00:00*",
              "updated_at": "*2000-01-01 00:00:00*",
              "deleted_at": "*2000-01-01 00:00:00*",
              "key": "Hello, world!",
              "value": "Hello, world!",
              "type": "Hello, world!",
              "ownerId": 1,
              "ownerType": "Hello, world!",
              "state": true,
              "logs": "Hello, world!"
            }
          ],
          "logs": [
            {
              "id": 1,
              "created_at": "*2000-01-01 00:00:00*",
              "updated_at": "*2000-01-01 00:00:00*",
              "deleted_at": "*2000-01-01 00:00:00*",
              "ownerId": 1,
              "ownerType": "Hello, world!",
              "status": 1,
              "method": "Hello, world!",
              "description": "Hello, world!",
              "url": "Hello, world!",
              "company": 1,
              "state": true,
              "custom": "Hello, world!"
            }
          ]
        }
      ],
      "type": "Hello, world!",
      "state": true,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "addresses": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "name": "Hello, world!",
      "company": "Hello, world!",
      "city": "Hello, world!",
      "postal": "Hello, world!",
      "province": "Hello, world!",
      "country": "Hello, world!",
      "addressOne": "Hello, world!",
      "addressTwo": "Hello, world!",
      "state": true,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "company": 1,
  "state": true,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "created_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "updated_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "deleted_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "STATUS"
      ]
    },
    "partner": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "invoice": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "name": {
            "type": "string",
            "enum": [
              "NAME"
            ]
          },
          "amount": {
            "type": "number",
            "enum": [
              1995
            ]
          },
          "quantity": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "custom": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "key": {
                  "type": "string",
                  "enum": [
                    "KEY"
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "VALUE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "logs": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "key",
                "value",
                "type",
                "ownerId",
                "ownerType",
                "state",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "logs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "status": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "method": {
                  "type": "string",
                  "enum": [
                    "METHOD"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "DESCRIPTION"
                  ]
                },
                "url": {
                  "type": "string",
                  "enum": [
                    "URL"
                  ]
                },
                "company": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "custom": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "status",
                "method",
                "description",
                "url",
                "company",
                "state",
                "custom"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "type",
          "state",
          "name",
          "amount",
          "quantity",
          "custom",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "transfers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "orderId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "name": {
                  "type": "string",
                  "enum": [
                    "NAME"
                  ]
                },
                "amount": {
                  "type": "number",
                  "enum": [
                    1995
                  ]
                },
                "quantity": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "custom": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "created_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "updated_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "deleted_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "key": {
                        "type": "string",
                        "enum": [
                          "KEY"
                        ]
                      },
                      "value": {
                        "type": "string",
                        "enum": [
                          "VALUE"
                        ]
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "TYPE"
                        ]
                      },
                      "ownerId": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "ownerType": {
                        "type": "string",
                        "enum": [
                          "OWNERTYPE"
                        ]
                      },
                      "state": {
                        "type": "boolean",
                        "enum": [
                          false
                        ]
                      },
                      "logs": {
                        "type": "string",
                        "enum": [
                          ""
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "created_at",
                      "updated_at",
                      "deleted_at",
                      "key",
                      "value",
                      "type",
                      "ownerId",
                      "ownerType",
                      "state",
                      "logs"
                    ],
                    "additionalProperties": false
                  }
                },
                "logs": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "created_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "updated_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "deleted_at": {
                        "type": "string",
                        "enum": [
                          "*2000-01-01 00:00:00*"
                        ]
                      },
                      "ownerId": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "ownerType": {
                        "type": "string",
                        "enum": [
                          "OWNERTYPE"
                        ]
                      },
                      "status": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "method": {
                        "type": "string",
                        "enum": [
                          "METHOD"
                        ]
                      },
                      "description": {
                        "type": "string",
                        "enum": [
                          "DESCRIPTION"
                        ]
                      },
                      "url": {
                        "type": "string",
                        "enum": [
                          "URL"
                        ]
                      },
                      "company": {
                        "type": "number",
                        "enum": [
                          1
                        ]
                      },
                      "state": {
                        "type": "boolean",
                        "enum": [
                          false
                        ]
                      },
                      "custom": {
                        "type": "string",
                        "enum": [
                          ""
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "created_at",
                      "updated_at",
                      "deleted_at",
                      "ownerId",
                      "ownerType",
                      "status",
                      "method",
                      "description",
                      "url",
                      "company",
                      "state",
                      "custom"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "type",
                "state",
                "name",
                "amount",
                "quantity",
                "custom",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "key": {
                  "type": "string",
                  "enum": [
                    "KEY"
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "VALUE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "logs": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "key",
                "value",
                "type",
                "ownerId",
                "ownerType",
                "state",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "logs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "status": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "method": {
                  "type": "string",
                  "enum": [
                    "METHOD"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "DESCRIPTION"
                  ]
                },
                "url": {
                  "type": "string",
                  "enum": [
                    "URL"
                  ]
                },
                "company": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "custom": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "status",
                "method",
                "description",
                "url",
                "company",
                "state",
                "custom"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "orderId",
          "items",
          "type",
          "state",
          "custom",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "name": {
            "type": "string",
            "enum": [
              "NAME"
            ]
          },
          "company": {
            "type": "string",
            "enum": [
              "COMPANY"
            ]
          },
          "city": {
            "type": "string",
            "enum": [
              "CITY"
            ]
          },
          "postal": {
            "type": "string",
            "enum": [
              "POSTAL"
            ]
          },
          "province": {
            "type": "string",
            "enum": [
              "PROVINCE"
            ]
          },
          "country": {
            "type": "string",
            "enum": [
              "COUNTRY"
            ]
          },
          "addressOne": {
            "type": "string",
            "enum": [
              "ADDRESSONE"
            ]
          },
          "addressTwo": {
            "type": "string",
            "enum": [
              "ADDRESSTWO"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "key": {
                  "type": "string",
                  "enum": [
                    "KEY"
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "VALUE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "logs": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "key",
                "value",
                "type",
                "ownerId",
                "ownerType",
                "state",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "logs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "status": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "method": {
                  "type": "string",
                  "enum": [
                    "METHOD"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "DESCRIPTION"
                  ]
                },
                "url": {
                  "type": "string",
                  "enum": [
                    "URL"
                  ]
                },
                "company": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "custom": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "status",
                "method",
                "description",
                "url",
                "company",
                "state",
                "custom"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "type",
          "name",
          "company",
          "city",
          "postal",
          "province",
          "country",
          "addressOne",
          "addressTwo",
          "state",
          "custom",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "company": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "state": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "custom": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "key": {
            "type": "string",
            "enum": [
              "KEY"
            ]
          },
          "value": {
            "type": "string",
            "enum": [
              "VALUE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "logs": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "key",
          "value",
          "type",
          "ownerId",
          "ownerType",
          "state",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "status": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "method": {
            "type": "string",
            "enum": [
              "METHOD"
            ]
          },
          "description": {
            "type": "string",
            "enum": [
              "DESCRIPTION"
            ]
          },
          "url": {
            "type": "string",
            "enum": [
              "URL"
            ]
          },
          "company": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "status",
          "method",
          "description",
          "url",
          "company",
          "state",
          "custom"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "created_at",
    "updated_at",
    "deleted_at",
    "status",
    "partner",
    "invoice",
    "items",
    "transfers",
    "addresses",
    "company",
    "state",
    "custom",
    "logs"
  ],
  "additionalProperties": false
}

Update order
PUT/orders/{id}

Update an order.

URI Parameters
HideShow
id
string (required) Example: 1

The ID of the desired order.

Choices: 1 2 3


DELETE https://admin.convictional.com/orders/1
Requestsexample 1
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Responses204
This response has no content.

Delete order
DELETE/orders/{id}

Delete an order.

URI Parameters
HideShow
id
string (required) Example: 1

The ID of the desired order.

Choices: 1 2 3


Items

Welcome to the items API. This API provides access to the items service.

items

POST https://admin.convictional.com/items
Requestsitem
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Body
{
  "id": 1,
  "created_at": "2000-01-01 00:00:00",
  "updated_at": "2000-01-01 00:00:00",
  "deleted_at": "2000-01-01 00:00:00",
  "ownerId": 1,
  "ownerType": "OWNERTYPE",
  "type": "TYPE",
  "state": false,
  "name": "NAME",
  "amount": 1995,
  "quantity": 1,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "deleted_at": {
      "type": "string"
    },
    "ownerId": {
      "type": "number"
    },
    "ownerType": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "state": {
      "type": "boolean"
    },
    "name": {
      "type": "string"
    },
    "amount": {
      "type": "number"
    },
    "quantity": {
      "type": "number"
    },
    "custom": {
      "type": "array"
    },
    "logs": {
      "type": "array"
    }
  }
}
Responses201
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "created_at": "*2000-01-01 00:00:00*",
  "updated_at": "*2000-01-01 00:00:00*",
  "deleted_at": "*2000-01-01 00:00:00*",
  "ownerId": 1,
  "ownerType": "Hello, world!",
  "type": "Hello, world!",
  "state": true,
  "name": "Hello, world!",
  "amount": 1,
  "quantity": 1,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "created_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "updated_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "deleted_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "ownerId": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "ownerType": {
      "type": "string",
      "enum": [
        "OWNERTYPE"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "TYPE"
      ]
    },
    "state": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "name": {
      "type": "string",
      "enum": [
        "NAME"
      ]
    },
    "amount": {
      "type": "number",
      "enum": [
        1995
      ]
    },
    "quantity": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "custom": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "key": {
            "type": "string",
            "enum": [
              "KEY"
            ]
          },
          "value": {
            "type": "string",
            "enum": [
              "VALUE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "logs": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "key",
          "value",
          "type",
          "ownerId",
          "ownerType",
          "state",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "status": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "method": {
            "type": "string",
            "enum": [
              "METHOD"
            ]
          },
          "description": {
            "type": "string",
            "enum": [
              "DESCRIPTION"
            ]
          },
          "url": {
            "type": "string",
            "enum": [
              "URL"
            ]
          },
          "company": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "status",
          "method",
          "description",
          "url",
          "company",
          "state",
          "custom"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "created_at",
    "updated_at",
    "deleted_at",
    "ownerId",
    "ownerType",
    "type",
    "state",
    "name",
    "amount",
    "quantity",
    "custom",
    "logs"
  ],
  "additionalProperties": false
}

Create item
POST/items

Create a new item


GET https://admin.convictional.com/items
Requestsexample 1
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Responses200
Headers
Content-Type: application/json; charset=utf-8
Body
[
  {
    "id": 1,
    "created_at": "*2000-01-01 00:00:00*",
    "updated_at": "*2000-01-01 00:00:00*",
    "deleted_at": "*2000-01-01 00:00:00*",
    "ownerId": 1,
    "ownerType": "Hello, world!",
    "type": "Hello, world!",
    "state": true,
    "name": "Hello, world!",
    "amount": 1,
    "quantity": 1,
    "custom": [
      {
        "id": 1,
        "created_at": "*2000-01-01 00:00:00*",
        "updated_at": "*2000-01-01 00:00:00*",
        "deleted_at": "*2000-01-01 00:00:00*",
        "key": "Hello, world!",
        "value": "Hello, world!",
        "type": "Hello, world!",
        "ownerId": 1,
        "ownerType": "Hello, world!",
        "state": true,
        "logs": "Hello, world!"
      }
    ],
    "logs": [
      {
        "id": 1,
        "created_at": "*2000-01-01 00:00:00*",
        "updated_at": "*2000-01-01 00:00:00*",
        "deleted_at": "*2000-01-01 00:00:00*",
        "ownerId": 1,
        "ownerType": "Hello, world!",
        "status": 1,
        "method": "Hello, world!",
        "description": "Hello, world!",
        "url": "Hello, world!",
        "company": 1,
        "state": true,
        "custom": "Hello, world!"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number",
        "enum": [
          1
        ]
      },
      "created_at": {
        "type": "string",
        "enum": [
          "*2000-01-01 00:00:00*"
        ]
      },
      "updated_at": {
        "type": "string",
        "enum": [
          "*2000-01-01 00:00:00*"
        ]
      },
      "deleted_at": {
        "type": "string",
        "enum": [
          "*2000-01-01 00:00:00*"
        ]
      },
      "ownerId": {
        "type": "number",
        "enum": [
          1
        ]
      },
      "ownerType": {
        "type": "string",
        "enum": [
          "OWNERTYPE"
        ]
      },
      "type": {
        "type": "string",
        "enum": [
          "TYPE"
        ]
      },
      "state": {
        "type": "boolean",
        "enum": [
          false
        ]
      },
      "name": {
        "type": "string",
        "enum": [
          "NAME"
        ]
      },
      "amount": {
        "type": "number",
        "enum": [
          1995
        ]
      },
      "quantity": {
        "type": "number",
        "enum": [
          1
        ]
      },
      "custom": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "created_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "updated_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "deleted_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "key": {
              "type": "string",
              "enum": [
                "KEY"
              ]
            },
            "value": {
              "type": "string",
              "enum": [
                "VALUE"
              ]
            },
            "type": {
              "type": "string",
              "enum": [
                "TYPE"
              ]
            },
            "ownerId": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "ownerType": {
              "type": "string",
              "enum": [
                "OWNERTYPE"
              ]
            },
            "state": {
              "type": "boolean",
              "enum": [
                false
              ]
            },
            "logs": {
              "type": "string",
              "enum": [
                ""
              ]
            }
          },
          "required": [
            "id",
            "created_at",
            "updated_at",
            "deleted_at",
            "key",
            "value",
            "type",
            "ownerId",
            "ownerType",
            "state",
            "logs"
          ],
          "additionalProperties": false
        }
      },
      "logs": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "created_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "updated_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "deleted_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "ownerId": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "ownerType": {
              "type": "string",
              "enum": [
                "OWNERTYPE"
              ]
            },
            "status": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "method": {
              "type": "string",
              "enum": [
                "METHOD"
              ]
            },
            "description": {
              "type": "string",
              "enum": [
                "DESCRIPTION"
              ]
            },
            "url": {
              "type": "string",
              "enum": [
                "URL"
              ]
            },
            "company": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "state": {
              "type": "boolean",
              "enum": [
                false
              ]
            },
            "custom": {
              "type": "string",
              "enum": [
                ""
              ]
            }
          },
          "required": [
            "id",
            "created_at",
            "updated_at",
            "deleted_at",
            "ownerId",
            "ownerType",
            "status",
            "method",
            "description",
            "url",
            "company",
            "state",
            "custom"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "id",
      "created_at",
      "updated_at",
      "deleted_at",
      "ownerId",
      "ownerType",
      "type",
      "state",
      "name",
      "amount",
      "quantity",
      "custom",
      "logs"
    ],
    "additionalProperties": false
  }
}

Get items
GET/items

Returns an item list.

URI Parameters
HideShow
fields
string (optional) Default: all Example: type,state

Fields to receive.

preloads
string (optional) Default: (empty) Example: custom

Nested resources to preload.

pretty
boolean (optional) Default: false Example: false

Prettify JSON response.

stream
boolean (optional) Default: false Example: false

Return JSON in streaming format.

q[field_name]
string (optional) Default: (empty) Example: q[id]=1,2,5

A parameter for each field.

limit
number (optional) Default: 25 Example: 50

Maximum number of items.

page
number (optional) Default: 1 Example: 3

Page to receive.


item details

GET https://admin.convictional.com/items/1
Requestsexample 1
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Responses200
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "created_at": "*2000-01-01 00:00:00*",
  "updated_at": "*2000-01-01 00:00:00*",
  "deleted_at": "*2000-01-01 00:00:00*",
  "ownerId": 1,
  "ownerType": "Hello, world!",
  "type": "Hello, world!",
  "state": true,
  "name": "Hello, world!",
  "amount": 1,
  "quantity": 1,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "created_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "updated_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "deleted_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "ownerId": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "ownerType": {
      "type": "string",
      "enum": [
        "OWNERTYPE"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "TYPE"
      ]
    },
    "state": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "name": {
      "type": "string",
      "enum": [
        "NAME"
      ]
    },
    "amount": {
      "type": "number",
      "enum": [
        1995
      ]
    },
    "quantity": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "custom": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "key": {
            "type": "string",
            "enum": [
              "KEY"
            ]
          },
          "value": {
            "type": "string",
            "enum": [
              "VALUE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "logs": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "key",
          "value",
          "type",
          "ownerId",
          "ownerType",
          "state",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "status": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "method": {
            "type": "string",
            "enum": [
              "METHOD"
            ]
          },
          "description": {
            "type": "string",
            "enum": [
              "DESCRIPTION"
            ]
          },
          "url": {
            "type": "string",
            "enum": [
              "URL"
            ]
          },
          "company": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "status",
          "method",
          "description",
          "url",
          "company",
          "state",
          "custom"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "created_at",
    "updated_at",
    "deleted_at",
    "ownerId",
    "ownerType",
    "type",
    "state",
    "name",
    "amount",
    "quantity",
    "custom",
    "logs"
  ],
  "additionalProperties": false
}

Get item
GET/items/{id}

Returns an item.

URI Parameters
HideShow
id
string (required) Example: 1

The ID of the desired item.

Choices: 1 2 3

fields
string (optional) Default: all Example: type,state

Fields to receive.

preloads
string (optional) Default: (empty) Example: custom

Nested resources to preload.

pretty
boolean (optional) Default: false Example: false

Prettify JSON response.


PUT https://admin.convictional.com/items/1
Requestsitem
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Body
{
  "id": 1,
  "created_at": "2000-01-01 00:00:00",
  "updated_at": "2000-01-01 00:00:00",
  "deleted_at": "2000-01-01 00:00:00",
  "ownerId": 1,
  "ownerType": "OWNERTYPE",
  "type": "TYPE",
  "state": false,
  "name": "NAME",
  "amount": 1995,
  "quantity": 1,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "deleted_at": {
      "type": "string"
    },
    "ownerId": {
      "type": "number"
    },
    "ownerType": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "state": {
      "type": "boolean"
    },
    "name": {
      "type": "string"
    },
    "amount": {
      "type": "number"
    },
    "quantity": {
      "type": "number"
    },
    "custom": {
      "type": "array"
    },
    "logs": {
      "type": "array"
    }
  }
}
Responses200
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "created_at": "*2000-01-01 00:00:00*",
  "updated_at": "*2000-01-01 00:00:00*",
  "deleted_at": "*2000-01-01 00:00:00*",
  "ownerId": 1,
  "ownerType": "Hello, world!",
  "type": "Hello, world!",
  "state": true,
  "name": "Hello, world!",
  "amount": 1,
  "quantity": 1,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "created_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "updated_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "deleted_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "ownerId": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "ownerType": {
      "type": "string",
      "enum": [
        "OWNERTYPE"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "TYPE"
      ]
    },
    "state": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "name": {
      "type": "string",
      "enum": [
        "NAME"
      ]
    },
    "amount": {
      "type": "number",
      "enum": [
        1995
      ]
    },
    "quantity": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "custom": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "key": {
            "type": "string",
            "enum": [
              "KEY"
            ]
          },
          "value": {
            "type": "string",
            "enum": [
              "VALUE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "logs": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "key",
          "value",
          "type",
          "ownerId",
          "ownerType",
          "state",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "status": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "method": {
            "type": "string",
            "enum": [
              "METHOD"
            ]
          },
          "description": {
            "type": "string",
            "enum": [
              "DESCRIPTION"
            ]
          },
          "url": {
            "type": "string",
            "enum": [
              "URL"
            ]
          },
          "company": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "status",
          "method",
          "description",
          "url",
          "company",
          "state",
          "custom"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "created_at",
    "updated_at",
    "deleted_at",
    "ownerId",
    "ownerType",
    "type",
    "state",
    "name",
    "amount",
    "quantity",
    "custom",
    "logs"
  ],
  "additionalProperties": false
}

Update item
PUT/items/{id}

Update an item.

URI Parameters
HideShow
id
string (required) Example: 1

The ID of the desired item.

Choices: 1 2 3


DELETE https://admin.convictional.com/items/1
Requestsexample 1
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Responses204
This response has no content.

Delete item
DELETE/items/{id}

Delete an item.

URI Parameters
HideShow
id
string (required) Example: 1

The ID of the desired item.

Choices: 1 2 3


Transfers

Welcome to the transfers API. This API provides access to the transfers service.

transfers

POST https://admin.convictional.com/transfers
Requeststransfer
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Body
{
  "id": 1,
  "created_at": "2000-01-01 00:00:00",
  "updated_at": "2000-01-01 00:00:00",
  "deleted_at": "2000-01-01 00:00:00",
  "orderId": 1,
  "items": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "state": true,
      "name": "Hello, world!",
      "amount": 1,
      "quantity": 1,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "type": "TYPE",
  "state": false,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "deleted_at": {
      "type": "string"
    },
    "orderId": {
      "type": "number"
    },
    "items": {
      "type": "array"
    },
    "type": {
      "type": "string"
    },
    "state": {
      "type": "boolean"
    },
    "custom": {
      "type": "array"
    },
    "logs": {
      "type": "array"
    }
  }
}
Responses201
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "created_at": "*2000-01-01 00:00:00*",
  "updated_at": "*2000-01-01 00:00:00*",
  "deleted_at": "*2000-01-01 00:00:00*",
  "orderId": 1,
  "items": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "state": true,
      "name": "Hello, world!",
      "amount": 1,
      "quantity": 1,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "type": "Hello, world!",
  "state": true,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "created_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "updated_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "deleted_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "orderId": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "name": {
            "type": "string",
            "enum": [
              "NAME"
            ]
          },
          "amount": {
            "type": "number",
            "enum": [
              1995
            ]
          },
          "quantity": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "custom": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "key": {
                  "type": "string",
                  "enum": [
                    "KEY"
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "VALUE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "logs": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "key",
                "value",
                "type",
                "ownerId",
                "ownerType",
                "state",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "logs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "status": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "method": {
                  "type": "string",
                  "enum": [
                    "METHOD"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "DESCRIPTION"
                  ]
                },
                "url": {
                  "type": "string",
                  "enum": [
                    "URL"
                  ]
                },
                "company": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "custom": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "status",
                "method",
                "description",
                "url",
                "company",
                "state",
                "custom"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "type",
          "state",
          "name",
          "amount",
          "quantity",
          "custom",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "type": {
      "type": "string",
      "enum": [
        "TYPE"
      ]
    },
    "state": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "custom": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "key": {
            "type": "string",
            "enum": [
              "KEY"
            ]
          },
          "value": {
            "type": "string",
            "enum": [
              "VALUE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "logs": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "key",
          "value",
          "type",
          "ownerId",
          "ownerType",
          "state",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "status": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "method": {
            "type": "string",
            "enum": [
              "METHOD"
            ]
          },
          "description": {
            "type": "string",
            "enum": [
              "DESCRIPTION"
            ]
          },
          "url": {
            "type": "string",
            "enum": [
              "URL"
            ]
          },
          "company": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "status",
          "method",
          "description",
          "url",
          "company",
          "state",
          "custom"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "created_at",
    "updated_at",
    "deleted_at",
    "orderId",
    "items",
    "type",
    "state",
    "custom",
    "logs"
  ],
  "additionalProperties": false
}

Create transfer
POST/transfers

Create a new transfer


GET https://admin.convictional.com/transfers
Requestsexample 1
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Responses200
Headers
Content-Type: application/json; charset=utf-8
Body
[
  {
    "id": 1,
    "created_at": "*2000-01-01 00:00:00*",
    "updated_at": "*2000-01-01 00:00:00*",
    "deleted_at": "*2000-01-01 00:00:00*",
    "orderId": 1,
    "items": [
      {
        "id": 1,
        "created_at": "*2000-01-01 00:00:00*",
        "updated_at": "*2000-01-01 00:00:00*",
        "deleted_at": "*2000-01-01 00:00:00*",
        "ownerId": 1,
        "ownerType": "Hello, world!",
        "type": "Hello, world!",
        "state": true,
        "name": "Hello, world!",
        "amount": 1,
        "quantity": 1,
        "custom": [
          {
            "id": 1,
            "created_at": "*2000-01-01 00:00:00*",
            "updated_at": "*2000-01-01 00:00:00*",
            "deleted_at": "*2000-01-01 00:00:00*",
            "key": "Hello, world!",
            "value": "Hello, world!",
            "type": "Hello, world!",
            "ownerId": 1,
            "ownerType": "Hello, world!",
            "state": true,
            "logs": "Hello, world!"
          }
        ],
        "logs": [
          {
            "id": 1,
            "created_at": "*2000-01-01 00:00:00*",
            "updated_at": "*2000-01-01 00:00:00*",
            "deleted_at": "*2000-01-01 00:00:00*",
            "ownerId": 1,
            "ownerType": "Hello, world!",
            "status": 1,
            "method": "Hello, world!",
            "description": "Hello, world!",
            "url": "Hello, world!",
            "company": 1,
            "state": true,
            "custom": "Hello, world!"
          }
        ]
      }
    ],
    "type": "Hello, world!",
    "state": true,
    "custom": [
      {
        "id": 1,
        "created_at": "*2000-01-01 00:00:00*",
        "updated_at": "*2000-01-01 00:00:00*",
        "deleted_at": "*2000-01-01 00:00:00*",
        "key": "Hello, world!",
        "value": "Hello, world!",
        "type": "Hello, world!",
        "ownerId": 1,
        "ownerType": "Hello, world!",
        "state": true,
        "logs": "Hello, world!"
      }
    ],
    "logs": [
      {
        "id": 1,
        "created_at": "*2000-01-01 00:00:00*",
        "updated_at": "*2000-01-01 00:00:00*",
        "deleted_at": "*2000-01-01 00:00:00*",
        "ownerId": 1,
        "ownerType": "Hello, world!",
        "status": 1,
        "method": "Hello, world!",
        "description": "Hello, world!",
        "url": "Hello, world!",
        "company": 1,
        "state": true,
        "custom": "Hello, world!"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number",
        "enum": [
          1
        ]
      },
      "created_at": {
        "type": "string",
        "enum": [
          "*2000-01-01 00:00:00*"
        ]
      },
      "updated_at": {
        "type": "string",
        "enum": [
          "*2000-01-01 00:00:00*"
        ]
      },
      "deleted_at": {
        "type": "string",
        "enum": [
          "*2000-01-01 00:00:00*"
        ]
      },
      "orderId": {
        "type": "number",
        "enum": [
          1
        ]
      },
      "items": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "created_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "updated_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "deleted_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "ownerId": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "ownerType": {
              "type": "string",
              "enum": [
                "OWNERTYPE"
              ]
            },
            "type": {
              "type": "string",
              "enum": [
                "TYPE"
              ]
            },
            "state": {
              "type": "boolean",
              "enum": [
                false
              ]
            },
            "name": {
              "type": "string",
              "enum": [
                "NAME"
              ]
            },
            "amount": {
              "type": "number",
              "enum": [
                1995
              ]
            },
            "quantity": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "custom": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "created_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "updated_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "deleted_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "key": {
                    "type": "string",
                    "enum": [
                      "KEY"
                    ]
                  },
                  "value": {
                    "type": "string",
                    "enum": [
                      "VALUE"
                    ]
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "TYPE"
                    ]
                  },
                  "ownerId": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "ownerType": {
                    "type": "string",
                    "enum": [
                      "OWNERTYPE"
                    ]
                  },
                  "state": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "logs": {
                    "type": "string",
                    "enum": [
                      ""
                    ]
                  }
                },
                "required": [
                  "id",
                  "created_at",
                  "updated_at",
                  "deleted_at",
                  "key",
                  "value",
                  "type",
                  "ownerId",
                  "ownerType",
                  "state",
                  "logs"
                ],
                "additionalProperties": false
              }
            },
            "logs": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "created_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "updated_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "deleted_at": {
                    "type": "string",
                    "enum": [
                      "*2000-01-01 00:00:00*"
                    ]
                  },
                  "ownerId": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "ownerType": {
                    "type": "string",
                    "enum": [
                      "OWNERTYPE"
                    ]
                  },
                  "status": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "method": {
                    "type": "string",
                    "enum": [
                      "METHOD"
                    ]
                  },
                  "description": {
                    "type": "string",
                    "enum": [
                      "DESCRIPTION"
                    ]
                  },
                  "url": {
                    "type": "string",
                    "enum": [
                      "URL"
                    ]
                  },
                  "company": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "state": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "custom": {
                    "type": "string",
                    "enum": [
                      ""
                    ]
                  }
                },
                "required": [
                  "id",
                  "created_at",
                  "updated_at",
                  "deleted_at",
                  "ownerId",
                  "ownerType",
                  "status",
                  "method",
                  "description",
                  "url",
                  "company",
                  "state",
                  "custom"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "id",
            "created_at",
            "updated_at",
            "deleted_at",
            "ownerId",
            "ownerType",
            "type",
            "state",
            "name",
            "amount",
            "quantity",
            "custom",
            "logs"
          ],
          "additionalProperties": false
        }
      },
      "type": {
        "type": "string",
        "enum": [
          "TYPE"
        ]
      },
      "state": {
        "type": "boolean",
        "enum": [
          false
        ]
      },
      "custom": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "created_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "updated_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "deleted_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "key": {
              "type": "string",
              "enum": [
                "KEY"
              ]
            },
            "value": {
              "type": "string",
              "enum": [
                "VALUE"
              ]
            },
            "type": {
              "type": "string",
              "enum": [
                "TYPE"
              ]
            },
            "ownerId": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "ownerType": {
              "type": "string",
              "enum": [
                "OWNERTYPE"
              ]
            },
            "state": {
              "type": "boolean",
              "enum": [
                false
              ]
            },
            "logs": {
              "type": "string",
              "enum": [
                ""
              ]
            }
          },
          "required": [
            "id",
            "created_at",
            "updated_at",
            "deleted_at",
            "key",
            "value",
            "type",
            "ownerId",
            "ownerType",
            "state",
            "logs"
          ],
          "additionalProperties": false
        }
      },
      "logs": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "created_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "updated_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "deleted_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "ownerId": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "ownerType": {
              "type": "string",
              "enum": [
                "OWNERTYPE"
              ]
            },
            "status": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "method": {
              "type": "string",
              "enum": [
                "METHOD"
              ]
            },
            "description": {
              "type": "string",
              "enum": [
                "DESCRIPTION"
              ]
            },
            "url": {
              "type": "string",
              "enum": [
                "URL"
              ]
            },
            "company": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "state": {
              "type": "boolean",
              "enum": [
                false
              ]
            },
            "custom": {
              "type": "string",
              "enum": [
                ""
              ]
            }
          },
          "required": [
            "id",
            "created_at",
            "updated_at",
            "deleted_at",
            "ownerId",
            "ownerType",
            "status",
            "method",
            "description",
            "url",
            "company",
            "state",
            "custom"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "id",
      "created_at",
      "updated_at",
      "deleted_at",
      "orderId",
      "items",
      "type",
      "state",
      "custom",
      "logs"
    ],
    "additionalProperties": false
  }
}

Get transfers
GET/transfers

Returns a transfer list.

URI Parameters
HideShow
fields
string (optional) Default: all Example: type,state

Fields to receive.

preloads
string (optional) Default: (empty) Example: custom

Nested resources to preload.

pretty
boolean (optional) Default: false Example: false

Prettify JSON response.

stream
boolean (optional) Default: false Example: false

Return JSON in streaming format.

q[field_name]
string (optional) Default: (empty) Example: q[id]=1,2,5

A parameter for each field.

limit
number (optional) Default: 25 Example: 50

Maximum number of items.

page
number (optional) Default: 1 Example: 3

Page to receive.


transfer details

GET https://admin.convictional.com/transfers/1
Requestsexample 1
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Responses200
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "created_at": "*2000-01-01 00:00:00*",
  "updated_at": "*2000-01-01 00:00:00*",
  "deleted_at": "*2000-01-01 00:00:00*",
  "orderId": 1,
  "items": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "state": true,
      "name": "Hello, world!",
      "amount": 1,
      "quantity": 1,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "type": "Hello, world!",
  "state": true,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "created_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "updated_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "deleted_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "orderId": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "name": {
            "type": "string",
            "enum": [
              "NAME"
            ]
          },
          "amount": {
            "type": "number",
            "enum": [
              1995
            ]
          },
          "quantity": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "custom": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "key": {
                  "type": "string",
                  "enum": [
                    "KEY"
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "VALUE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "logs": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "key",
                "value",
                "type",
                "ownerId",
                "ownerType",
                "state",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "logs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "status": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "method": {
                  "type": "string",
                  "enum": [
                    "METHOD"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "DESCRIPTION"
                  ]
                },
                "url": {
                  "type": "string",
                  "enum": [
                    "URL"
                  ]
                },
                "company": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "custom": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "status",
                "method",
                "description",
                "url",
                "company",
                "state",
                "custom"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "type",
          "state",
          "name",
          "amount",
          "quantity",
          "custom",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "type": {
      "type": "string",
      "enum": [
        "TYPE"
      ]
    },
    "state": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "custom": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "key": {
            "type": "string",
            "enum": [
              "KEY"
            ]
          },
          "value": {
            "type": "string",
            "enum": [
              "VALUE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "logs": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "key",
          "value",
          "type",
          "ownerId",
          "ownerType",
          "state",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "status": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "method": {
            "type": "string",
            "enum": [
              "METHOD"
            ]
          },
          "description": {
            "type": "string",
            "enum": [
              "DESCRIPTION"
            ]
          },
          "url": {
            "type": "string",
            "enum": [
              "URL"
            ]
          },
          "company": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "status",
          "method",
          "description",
          "url",
          "company",
          "state",
          "custom"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "created_at",
    "updated_at",
    "deleted_at",
    "orderId",
    "items",
    "type",
    "state",
    "custom",
    "logs"
  ],
  "additionalProperties": false
}

Get transfer
GET/transfers/{id}

Returns a transfer.

URI Parameters
HideShow
id
string (required) Example: 1

The ID of the desired transfer.

Choices: 1 2 3

fields
string (optional) Default: all Example: type,state

Fields to receive.

preloads
string (optional) Default: (empty) Example: custom

Nested resources to preload.

pretty
boolean (optional) Default: false Example: false

Prettify JSON response.


PUT https://admin.convictional.com/transfers/1
Requeststransfer
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Body
{
  "id": 1,
  "created_at": "2000-01-01 00:00:00",
  "updated_at": "2000-01-01 00:00:00",
  "deleted_at": "2000-01-01 00:00:00",
  "orderId": 1,
  "items": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "state": true,
      "name": "Hello, world!",
      "amount": 1,
      "quantity": 1,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "type": "TYPE",
  "state": false,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "deleted_at": {
      "type": "string"
    },
    "orderId": {
      "type": "number"
    },
    "items": {
      "type": "array"
    },
    "type": {
      "type": "string"
    },
    "state": {
      "type": "boolean"
    },
    "custom": {
      "type": "array"
    },
    "logs": {
      "type": "array"
    }
  }
}
Responses200
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "created_at": "*2000-01-01 00:00:00*",
  "updated_at": "*2000-01-01 00:00:00*",
  "deleted_at": "*2000-01-01 00:00:00*",
  "orderId": 1,
  "items": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "type": "Hello, world!",
      "state": true,
      "name": "Hello, world!",
      "amount": 1,
      "quantity": 1,
      "custom": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "key": "Hello, world!",
          "value": "Hello, world!",
          "type": "Hello, world!",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "state": true,
          "logs": "Hello, world!"
        }
      ],
      "logs": [
        {
          "id": 1,
          "created_at": "*2000-01-01 00:00:00*",
          "updated_at": "*2000-01-01 00:00:00*",
          "deleted_at": "*2000-01-01 00:00:00*",
          "ownerId": 1,
          "ownerType": "Hello, world!",
          "status": 1,
          "method": "Hello, world!",
          "description": "Hello, world!",
          "url": "Hello, world!",
          "company": 1,
          "state": true,
          "custom": "Hello, world!"
        }
      ]
    }
  ],
  "type": "Hello, world!",
  "state": true,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "created_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "updated_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "deleted_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "orderId": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "name": {
            "type": "string",
            "enum": [
              "NAME"
            ]
          },
          "amount": {
            "type": "number",
            "enum": [
              1995
            ]
          },
          "quantity": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "custom": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "key": {
                  "type": "string",
                  "enum": [
                    "KEY"
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "VALUE"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "TYPE"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "logs": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "key",
                "value",
                "type",
                "ownerId",
                "ownerType",
                "state",
                "logs"
              ],
              "additionalProperties": false
            }
          },
          "logs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "updated_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "deleted_at": {
                  "type": "string",
                  "enum": [
                    "*2000-01-01 00:00:00*"
                  ]
                },
                "ownerId": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "ownerType": {
                  "type": "string",
                  "enum": [
                    "OWNERTYPE"
                  ]
                },
                "status": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "method": {
                  "type": "string",
                  "enum": [
                    "METHOD"
                  ]
                },
                "description": {
                  "type": "string",
                  "enum": [
                    "DESCRIPTION"
                  ]
                },
                "url": {
                  "type": "string",
                  "enum": [
                    "URL"
                  ]
                },
                "company": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "state": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "custom": {
                  "type": "string",
                  "enum": [
                    ""
                  ]
                }
              },
              "required": [
                "id",
                "created_at",
                "updated_at",
                "deleted_at",
                "ownerId",
                "ownerType",
                "status",
                "method",
                "description",
                "url",
                "company",
                "state",
                "custom"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "type",
          "state",
          "name",
          "amount",
          "quantity",
          "custom",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "type": {
      "type": "string",
      "enum": [
        "TYPE"
      ]
    },
    "state": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "custom": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "key": {
            "type": "string",
            "enum": [
              "KEY"
            ]
          },
          "value": {
            "type": "string",
            "enum": [
              "VALUE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "logs": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "key",
          "value",
          "type",
          "ownerId",
          "ownerType",
          "state",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "status": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "method": {
            "type": "string",
            "enum": [
              "METHOD"
            ]
          },
          "description": {
            "type": "string",
            "enum": [
              "DESCRIPTION"
            ]
          },
          "url": {
            "type": "string",
            "enum": [
              "URL"
            ]
          },
          "company": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "status",
          "method",
          "description",
          "url",
          "company",
          "state",
          "custom"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "created_at",
    "updated_at",
    "deleted_at",
    "orderId",
    "items",
    "type",
    "state",
    "custom",
    "logs"
  ],
  "additionalProperties": false
}

Update transfer
PUT/transfers/{id}

Update a transfer.

URI Parameters
HideShow
id
string (required) Example: 1

The ID of the desired transfer.

Choices: 1 2 3


DELETE https://admin.convictional.com/transfers/1
Requestsexample 1
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Responses204
This response has no content.

Delete transfer
DELETE/transfers/{id}

Delete a transfer.

URI Parameters
HideShow
id
string (required) Example: 1

The ID of the desired transfer.

Choices: 1 2 3


Addresses

Welcome to the addresses API. This API provides access to the addresses service.

addresses

POST https://admin.convictional.com/addresses
Requestsaddress
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Body
{
  "id": 1,
  "created_at": "2000-01-01 00:00:00",
  "updated_at": "2000-01-01 00:00:00",
  "deleted_at": "2000-01-01 00:00:00",
  "ownerId": 1,
  "ownerType": "OWNERTYPE",
  "type": "TYPE",
  "name": "NAME",
  "company": "COMPANY",
  "city": "CITY",
  "postal": "POSTAL",
  "province": "PROVINCE",
  "country": "COUNTRY",
  "addressOne": "ADDRESSONE",
  "addressTwo": "ADDRESSTWO",
  "state": false,
  "custom": "Hello, world!",
  "logs": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "deleted_at": {
      "type": "string"
    },
    "ownerId": {
      "type": "number"
    },
    "ownerType": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "postal": {
      "type": "string"
    },
    "province": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "addressOne": {
      "type": "string"
    },
    "addressTwo": {
      "type": "string"
    },
    "state": {
      "type": "boolean"
    },
    "custom": {
      "type": "string"
    },
    "logs": {
      "type": "string"
    }
  }
}
Responses201
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "created_at": "*2000-01-01 00:00:00*",
  "updated_at": "*2000-01-01 00:00:00*",
  "deleted_at": "*2000-01-01 00:00:00*",
  "ownerId": 1,
  "ownerType": "Hello, world!",
  "type": "Hello, world!",
  "name": "Hello, world!",
  "company": "Hello, world!",
  "city": "Hello, world!",
  "postal": "Hello, world!",
  "province": "Hello, world!",
  "country": "Hello, world!",
  "addressOne": "Hello, world!",
  "addressTwo": "Hello, world!",
  "state": true,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "created_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "updated_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "deleted_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "ownerId": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "ownerType": {
      "type": "string",
      "enum": [
        "OWNERTYPE"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "TYPE"
      ]
    },
    "name": {
      "type": "string",
      "enum": [
        "NAME"
      ]
    },
    "company": {
      "type": "string",
      "enum": [
        "COMPANY"
      ]
    },
    "city": {
      "type": "string",
      "enum": [
        "CITY"
      ]
    },
    "postal": {
      "type": "string",
      "enum": [
        "POSTAL"
      ]
    },
    "province": {
      "type": "string",
      "enum": [
        "PROVINCE"
      ]
    },
    "country": {
      "type": "string",
      "enum": [
        "COUNTRY"
      ]
    },
    "addressOne": {
      "type": "string",
      "enum": [
        "ADDRESSONE"
      ]
    },
    "addressTwo": {
      "type": "string",
      "enum": [
        "ADDRESSTWO"
      ]
    },
    "state": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "custom": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "key": {
            "type": "string",
            "enum": [
              "KEY"
            ]
          },
          "value": {
            "type": "string",
            "enum": [
              "VALUE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "logs": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "key",
          "value",
          "type",
          "ownerId",
          "ownerType",
          "state",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "status": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "method": {
            "type": "string",
            "enum": [
              "METHOD"
            ]
          },
          "description": {
            "type": "string",
            "enum": [
              "DESCRIPTION"
            ]
          },
          "url": {
            "type": "string",
            "enum": [
              "URL"
            ]
          },
          "company": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "status",
          "method",
          "description",
          "url",
          "company",
          "state",
          "custom"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "created_at",
    "updated_at",
    "deleted_at",
    "ownerId",
    "ownerType",
    "type",
    "name",
    "company",
    "city",
    "postal",
    "province",
    "country",
    "addressOne",
    "addressTwo",
    "state",
    "custom",
    "logs"
  ],
  "additionalProperties": false
}

Create address
POST/addresses

Create a new address


GET https://admin.convictional.com/addresses
Requestsexample 1
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Responses200
Headers
Content-Type: application/json; charset=utf-8
Body
[
  {
    "id": 1,
    "created_at": "*2000-01-01 00:00:00*",
    "updated_at": "*2000-01-01 00:00:00*",
    "deleted_at": "*2000-01-01 00:00:00*",
    "ownerId": 1,
    "ownerType": "Hello, world!",
    "type": "Hello, world!",
    "name": "Hello, world!",
    "company": "Hello, world!",
    "city": "Hello, world!",
    "postal": "Hello, world!",
    "province": "Hello, world!",
    "country": "Hello, world!",
    "addressOne": "Hello, world!",
    "addressTwo": "Hello, world!",
    "state": true,
    "custom": [
      {
        "id": 1,
        "created_at": "*2000-01-01 00:00:00*",
        "updated_at": "*2000-01-01 00:00:00*",
        "deleted_at": "*2000-01-01 00:00:00*",
        "key": "Hello, world!",
        "value": "Hello, world!",
        "type": "Hello, world!",
        "ownerId": 1,
        "ownerType": "Hello, world!",
        "state": true,
        "logs": "Hello, world!"
      }
    ],
    "logs": [
      {
        "id": 1,
        "created_at": "*2000-01-01 00:00:00*",
        "updated_at": "*2000-01-01 00:00:00*",
        "deleted_at": "*2000-01-01 00:00:00*",
        "ownerId": 1,
        "ownerType": "Hello, world!",
        "status": 1,
        "method": "Hello, world!",
        "description": "Hello, world!",
        "url": "Hello, world!",
        "company": 1,
        "state": true,
        "custom": "Hello, world!"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number",
        "enum": [
          1
        ]
      },
      "created_at": {
        "type": "string",
        "enum": [
          "*2000-01-01 00:00:00*"
        ]
      },
      "updated_at": {
        "type": "string",
        "enum": [
          "*2000-01-01 00:00:00*"
        ]
      },
      "deleted_at": {
        "type": "string",
        "enum": [
          "*2000-01-01 00:00:00*"
        ]
      },
      "ownerId": {
        "type": "number",
        "enum": [
          1
        ]
      },
      "ownerType": {
        "type": "string",
        "enum": [
          "OWNERTYPE"
        ]
      },
      "type": {
        "type": "string",
        "enum": [
          "TYPE"
        ]
      },
      "name": {
        "type": "string",
        "enum": [
          "NAME"
        ]
      },
      "company": {
        "type": "string",
        "enum": [
          "COMPANY"
        ]
      },
      "city": {
        "type": "string",
        "enum": [
          "CITY"
        ]
      },
      "postal": {
        "type": "string",
        "enum": [
          "POSTAL"
        ]
      },
      "province": {
        "type": "string",
        "enum": [
          "PROVINCE"
        ]
      },
      "country": {
        "type": "string",
        "enum": [
          "COUNTRY"
        ]
      },
      "addressOne": {
        "type": "string",
        "enum": [
          "ADDRESSONE"
        ]
      },
      "addressTwo": {
        "type": "string",
        "enum": [
          "ADDRESSTWO"
        ]
      },
      "state": {
        "type": "boolean",
        "enum": [
          false
        ]
      },
      "custom": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "created_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "updated_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "deleted_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "key": {
              "type": "string",
              "enum": [
                "KEY"
              ]
            },
            "value": {
              "type": "string",
              "enum": [
                "VALUE"
              ]
            },
            "type": {
              "type": "string",
              "enum": [
                "TYPE"
              ]
            },
            "ownerId": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "ownerType": {
              "type": "string",
              "enum": [
                "OWNERTYPE"
              ]
            },
            "state": {
              "type": "boolean",
              "enum": [
                false
              ]
            },
            "logs": {
              "type": "string",
              "enum": [
                ""
              ]
            }
          },
          "required": [
            "id",
            "created_at",
            "updated_at",
            "deleted_at",
            "key",
            "value",
            "type",
            "ownerId",
            "ownerType",
            "state",
            "logs"
          ],
          "additionalProperties": false
        }
      },
      "logs": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "created_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "updated_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "deleted_at": {
              "type": "string",
              "enum": [
                "*2000-01-01 00:00:00*"
              ]
            },
            "ownerId": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "ownerType": {
              "type": "string",
              "enum": [
                "OWNERTYPE"
              ]
            },
            "status": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "method": {
              "type": "string",
              "enum": [
                "METHOD"
              ]
            },
            "description": {
              "type": "string",
              "enum": [
                "DESCRIPTION"
              ]
            },
            "url": {
              "type": "string",
              "enum": [
                "URL"
              ]
            },
            "company": {
              "type": "number",
              "enum": [
                1
              ]
            },
            "state": {
              "type": "boolean",
              "enum": [
                false
              ]
            },
            "custom": {
              "type": "string",
              "enum": [
                ""
              ]
            }
          },
          "required": [
            "id",
            "created_at",
            "updated_at",
            "deleted_at",
            "ownerId",
            "ownerType",
            "status",
            "method",
            "description",
            "url",
            "company",
            "state",
            "custom"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "id",
      "created_at",
      "updated_at",
      "deleted_at",
      "ownerId",
      "ownerType",
      "type",
      "name",
      "company",
      "city",
      "postal",
      "province",
      "country",
      "addressOne",
      "addressTwo",
      "state",
      "custom",
      "logs"
    ],
    "additionalProperties": false
  }
}

Get addresses
GET/addresses

Returns an address list.

URI Parameters
HideShow
fields
string (optional) Default: all Example: type,state

Fields to receive.

preloads
string (optional) Default: (empty) Example: custom

Nested resources to preload.

pretty
boolean (optional) Default: false Example: false

Prettify JSON response.

stream
boolean (optional) Default: false Example: false

Return JSON in streaming format.

q[field_name]
string (optional) Default: (empty) Example: q[id]=1,2,5

A parameter for each field.

limit
number (optional) Default: 25 Example: 50

Maximum number of items.

page
number (optional) Default: 1 Example: 3

Page to receive.


address details

GET https://admin.convictional.com/addresses/1
Requestsexample 1
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Responses200
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "created_at": "*2000-01-01 00:00:00*",
  "updated_at": "*2000-01-01 00:00:00*",
  "deleted_at": "*2000-01-01 00:00:00*",
  "ownerId": 1,
  "ownerType": "Hello, world!",
  "type": "Hello, world!",
  "name": "Hello, world!",
  "company": "Hello, world!",
  "city": "Hello, world!",
  "postal": "Hello, world!",
  "province": "Hello, world!",
  "country": "Hello, world!",
  "addressOne": "Hello, world!",
  "addressTwo": "Hello, world!",
  "state": true,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "created_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "updated_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "deleted_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "ownerId": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "ownerType": {
      "type": "string",
      "enum": [
        "OWNERTYPE"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "TYPE"
      ]
    },
    "name": {
      "type": "string",
      "enum": [
        "NAME"
      ]
    },
    "company": {
      "type": "string",
      "enum": [
        "COMPANY"
      ]
    },
    "city": {
      "type": "string",
      "enum": [
        "CITY"
      ]
    },
    "postal": {
      "type": "string",
      "enum": [
        "POSTAL"
      ]
    },
    "province": {
      "type": "string",
      "enum": [
        "PROVINCE"
      ]
    },
    "country": {
      "type": "string",
      "enum": [
        "COUNTRY"
      ]
    },
    "addressOne": {
      "type": "string",
      "enum": [
        "ADDRESSONE"
      ]
    },
    "addressTwo": {
      "type": "string",
      "enum": [
        "ADDRESSTWO"
      ]
    },
    "state": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "custom": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "key": {
            "type": "string",
            "enum": [
              "KEY"
            ]
          },
          "value": {
            "type": "string",
            "enum": [
              "VALUE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "logs": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "key",
          "value",
          "type",
          "ownerId",
          "ownerType",
          "state",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "status": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "method": {
            "type": "string",
            "enum": [
              "METHOD"
            ]
          },
          "description": {
            "type": "string",
            "enum": [
              "DESCRIPTION"
            ]
          },
          "url": {
            "type": "string",
            "enum": [
              "URL"
            ]
          },
          "company": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "custom": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "ownerId",
          "ownerType",
          "status",
          "method",
          "description",
          "url",
          "company",
          "state",
          "custom"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "created_at",
    "updated_at",
    "deleted_at",
    "ownerId",
    "ownerType",
    "type",
    "name",
    "company",
    "city",
    "postal",
    "province",
    "country",
    "addressOne",
    "addressTwo",
    "state",
    "custom",
    "logs"
  ],
  "additionalProperties": false
}

Get address
GET/addresses/{id}

Returns an address.

URI Parameters
HideShow
id
string (required) Example: 1

The ID of the desired address.

Choices: 1 2 3

fields
string (optional) Default: all Example: type,state

Fields to receive.

preloads
string (optional) Default: (empty) Example: custom

Nested resources to preload.

pretty
boolean (optional) Default: false Example: false

Prettify JSON response.


PUT https://admin.convictional.com/addresses/1
Requestsaddress
Headers
Content-Type: application/json; charset=utf-8
Accept: application/json
Body
{
  "id": 1,
  "created_at": "2000-01-01 00:00:00",
  "updated_at": "2000-01-01 00:00:00",
  "deleted_at": "2000-01-01 00:00:00",
  "ownerId": 1,
  "ownerType": "OWNERTYPE",
  "type": "TYPE",
  "name": "NAME",
  "company": "COMPANY",
  "city": "CITY",
  "postal": "POSTAL",
  "province": "PROVINCE",
  "country": "COUNTRY",
  "addressOne": "ADDRESSONE",
  "addressTwo": "ADDRESSTWO",
  "state": false,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "deleted_at": {
      "type": "string"
    },
    "ownerId": {
      "type": "number"
    },
    "ownerType": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "postal": {
      "type": "string"
    },
    "province": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "addressOne": {
      "type": "string"
    },
    "addressTwo": {
      "type": "string"
    },
    "state": {
      "type": "boolean"
    },
    "custom": {
      "type": "array"
    },
    "logs": {
      "type": "array"
    }
  }
}
Responses200
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "created_at": "*2000-01-01 00:00:00*",
  "updated_at": "*2000-01-01 00:00:00*",
  "deleted_at": "*2000-01-01 00:00:00*",
  "ownerId": 1,
  "ownerType": "Hello, world!",
  "type": "Hello, world!",
  "name": "Hello, world!",
  "company": "Hello, world!",
  "city": "Hello, world!",
  "postal": "Hello, world!",
  "province": "Hello, world!",
  "country": "Hello, world!",
  "addressOne": "Hello, world!",
  "addressTwo": "Hello, world!",
  "state": true,
  "custom": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "key": "Hello, world!",
      "value": "Hello, world!",
      "type": "Hello, world!",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "state": true,
      "logs": "Hello, world!"
    }
  ],
  "logs": [
    {
      "id": 1,
      "created_at": "*2000-01-01 00:00:00*",
      "updated_at": "*2000-01-01 00:00:00*",
      "deleted_at": "*2000-01-01 00:00:00*",
      "ownerId": 1,
      "ownerType": "Hello, world!",
      "status": 1,
      "method": "Hello, world!",
      "description": "Hello, world!",
      "url": "Hello, world!",
      "company": 1,
      "state": true,
      "custom": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "created_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "updated_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "deleted_at": {
      "type": "string",
      "enum": [
        "*2000-01-01 00:00:00*"
      ]
    },
    "ownerId": {
      "type": "number",
      "enum": [
        1
      ]
    },
    "ownerType": {
      "type": "string",
      "enum": [
        "OWNERTYPE"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "TYPE"
      ]
    },
    "name": {
      "type": "string",
      "enum": [
        "NAME"
      ]
    },
    "company": {
      "type": "string",
      "enum": [
        "COMPANY"
      ]
    },
    "city": {
      "type": "string",
      "enum": [
        "CITY"
      ]
    },
    "postal": {
      "type": "string",
      "enum": [
        "POSTAL"
      ]
    },
    "province": {
      "type": "string",
      "enum": [
        "PROVINCE"
      ]
    },
    "country": {
      "type": "string",
      "enum": [
        "COUNTRY"
      ]
    },
    "addressOne": {
      "type": "string",
      "enum": [
        "ADDRESSONE"
      ]
    },
    "addressTwo": {
      "type": "string",
      "enum": [
        "ADDRESSTWO"
      ]
    },
    "state": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "custom": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "deleted_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "key": {
            "type": "string",
            "enum": [
              "KEY"
            ]
          },
          "value": {
            "type": "string",
            "enum": [
              "VALUE"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "TYPE"
            ]
          },
          "ownerId": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "ownerType": {
            "type": "string",
            "enum": [
              "OWNERTYPE"
            ]
          },
          "state": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "logs": {
            "type": "string",
            "enum": [
              ""
            ]
          }
        },
        "required": [
          "id",
          "created_at",
          "updated_at",
          "deleted_at",
          "key",
          "value",
          "type",
          "ownerId",
          "ownerType",
          "state",
          "logs"
        ],
        "additionalProperties": false
      }
    },
    "logs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "created_at": {
            "type": "string",
            "enum": [
              "*2000-01-01 00:00:00*"
            ]
          },
          "updated_at": {
            "type": "string",
            "