In depth look at payload schemas
Order
| name | type | description |
|---|---|---|
| stage | str | stage of order, currently will always be documents_signed |
| id | uuid str | salesbricks ID of the order |
| documents_generated_at | ISO8601 datetime str | datetime documents were generated at |
| created_at | ISO8601 datetime str | datetime order was created |
| updated_at | ISO8601 datetime str | datetime order was last updated |
| starts_at | ISO8601 datetime str | datetime order starts at |
| buyer | Buyer info | entity which made this order |
Buyer
| name | type | description |
|---|---|---|
| first_name | str | Buyer user's first name |
| last_name | str | Buyer user's last name |
| str | Buyer user's email | |
| company | Buyer user's Company |
Company
| name | type | description |
|---|---|---|
| name | str | company name |
| address | Address | company's address |
Address
| name | type | description |
|---|---|---|
| line_1 | str | Street address (ex: 123 Easy Street) |
| line_2 | str | Additional address details (ex: suite 123) |
| city | str | City |
| region | str | Region (if applicable) |
| zip | str | zip code |
| country | str | country name |
Current Order SKUs
| name | type | description |
|---|---|---|
| sku | SKU | The Plan or Addon set up in salesbricks |
| quantity | Integer | How many units of the sku are included in the order |
SKU
| name | type | description |
|---|---|---|
| name | str | The name of the SKU |
| code | str | The internal code set for this SKU - this field is a set aside for your use - salesbricks doesn’t store any data in it |