{ "openapi": "3.0.3", "info": { "title": "Splash Php Client Module 2.3.0", "description": "Splash Open-Source \u0026 Universal Synchronisation WebService.", "version": "2.1.1", "x-splash-server": { "shortdesc": "Splash Php Client Module 2.3.0", "longdesc": "Splash Open-Source \u0026 Universal Synchronisation WebService.", "logourl": "", "scopes": [], "servertype": "Wordpress", "serverurl": "http:\/\/wp7-0.wordpress.local", "moduleauthor": "Splash Official \u003Cwww.splashsync.com\u003E", "moduleversion": "2.1.1" } }, "tags": [ { "name": "ThirdParty", "description": "- **Type:** `ThirdParty`\n- **Icon:** `fa fa-user`\n\nWoocommerce Customer Object\n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \u2705 | \ud83d\udeab | \u2705 |\n| Update | \u2705 | \u2705 | \u2705 |\n| Delete | \u2705 | \u2705 | \u2705 |\n\n\u003CSchemaDefinition schemaRef=\u0022#\/components\/schemas\/ThirdParty\u0022 \/\u003E" }, { "name": "Product", "description": "- **Type:** `Product`\n- **Icon:** `fa fa-product-hunt`\n\nWooCommerce Product Object\n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \u2705 | \ud83d\udeab | \u2705 |\n| Update | \u2705 | \u2705 | \u2705 |\n| Delete | \u2705 | \u2705 | \u2705 |\n\n\u003CSchemaDefinition schemaRef=\u0022#\/components\/schemas\/Product\u0022 \/\u003E" }, { "name": "Post", "description": "- **Type:** `Post`\n- **Icon:** `fa fa-rss-square`\n\nWordpress Post Object\n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \u2705 | \u2705 | \u2705 |\n| Update | \u2705 | \u2705 | \u2705 |\n| Delete | \u2705 | \u2705 | \u2705 |\n\n\u003CSchemaDefinition schemaRef=\u0022#\/components\/schemas\/Post\u0022 \/\u003E" }, { "name": "Page", "description": "- **Type:** `Page`\n- **Icon:** `fa fa-file`\n\nWordpress Page Object\n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \u2705 | \u2705 | \u2705 |\n| Update | \u2705 | \u2705 | \u2705 |\n| Delete | \u2705 | \u2705 | \u2705 |\n\n\u003CSchemaDefinition schemaRef=\u0022#\/components\/schemas\/Page\u0022 \/\u003E" }, { "name": "Order", "description": "- **Type:** `Order`\n- **Icon:** `fa fa-shopping-cart`\n\nWooCommerce Order Object\n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \u2705 | \ud83d\udeab | \u2705 |\n| Update | \u2705 | \ud83d\udeab | \u2705 |\n| Delete | \u2705 | \ud83d\udeab | \u2705 |\n\n\u003CSchemaDefinition schemaRef=\u0022#\/components\/schemas\/Order\u0022 \/\u003E" }, { "name": "Invoice", "description": "- **Type:** `Invoice`\n- **Icon:** `fa fa-money`\n\nWooCommerce Virtual Invoice\n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \ud83d\udeab | \ud83d\udeab | \u2705 |\n| Update | \ud83d\udeab | \ud83d\udeab | \u2705 |\n| Delete | \ud83d\udeab | \ud83d\udeab | \u2705 |\n\n\u003CSchemaDefinition schemaRef=\u0022#\/components\/schemas\/Invoice\u0022 \/\u003E" }, { "name": "Customer Address", "description": "- **Type:** `Address`\n- **Icon:** `fa fa-envelope-o`\n\nWordpress Customer Address Object\n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \ud83d\udeab | \ud83d\udeab | \u2705 |\n| Update | \u2705 | \u2705 | \u2705 |\n| Delete | \ud83d\udeab | \ud83d\udeab | \u2705 |\n\n\u003CSchemaDefinition schemaRef=\u0022#\/components\/schemas\/Address\u0022 \/\u003E" } ], "paths": { "\/thirdparty\/list": { "post": { "tags": [ "ThirdParty" ], "summary": "List ThirdParty", "operationId": "listThirdParty", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ThirdPartyListItem" } } } } } } } }, "\/thirdparty\/get": { "post": { "tags": [ "ThirdParty" ], "summary": "Read ThirdParty", "operationId": "getThirdParty", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ThirdParty" } } } } } } }, "\/thirdparty\/set": { "post": { "tags": [ "ThirdParty" ], "summary": "Write ThirdParty", "operationId": "setThirdParty", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#\/components\/schemas\/ThirdParty" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application\/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "\/thirdparty\/delete": { "post": { "tags": [ "ThirdParty" ], "summary": "Delete ThirdParty", "operationId": "deleteThirdParty", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } }, "\/product\/list": { "post": { "tags": [ "Product" ], "summary": "List Product", "operationId": "listProduct", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ProductListItem" } } } } } } } }, "\/product\/get": { "post": { "tags": [ "Product" ], "summary": "Read Product", "operationId": "getProduct", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Product" } } } } } } }, "\/product\/set": { "post": { "tags": [ "Product" ], "summary": "Write Product", "operationId": "setProduct", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#\/components\/schemas\/Product" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application\/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "\/product\/delete": { "post": { "tags": [ "Product" ], "summary": "Delete Product", "operationId": "deleteProduct", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } }, "\/post\/list": { "post": { "tags": [ "Post" ], "summary": "List Post", "operationId": "listPost", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PostListItem" } } } } } } } }, "\/post\/get": { "post": { "tags": [ "Post" ], "summary": "Read Post", "operationId": "getPost", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Post" } } } } } } }, "\/post\/set": { "post": { "tags": [ "Post" ], "summary": "Write Post", "operationId": "setPost", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#\/components\/schemas\/Post" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application\/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "\/post\/delete": { "post": { "tags": [ "Post" ], "summary": "Delete Post", "operationId": "deletePost", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } }, "\/page\/list": { "post": { "tags": [ "Page" ], "summary": "List Page", "operationId": "listPage", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PageListItem" } } } } } } } }, "\/page\/get": { "post": { "tags": [ "Page" ], "summary": "Read Page", "operationId": "getPage", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Page" } } } } } } }, "\/page\/set": { "post": { "tags": [ "Page" ], "summary": "Write Page", "operationId": "setPage", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#\/components\/schemas\/Page" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application\/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "\/page\/delete": { "post": { "tags": [ "Page" ], "summary": "Delete Page", "operationId": "deletePage", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } }, "\/order\/list": { "post": { "tags": [ "Order" ], "summary": "List Order", "operationId": "listOrder", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OrderListItem" } } } } } } } }, "\/order\/get": { "post": { "tags": [ "Order" ], "summary": "Read Order", "operationId": "getOrder", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Order" } } } } } } }, "\/order\/set": { "post": { "tags": [ "Order" ], "summary": "Write Order", "operationId": "setOrder", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#\/components\/schemas\/Order" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application\/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "\/order\/delete": { "post": { "tags": [ "Order" ], "summary": "Delete Order", "operationId": "deleteOrder", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } }, "\/invoice\/list": { "post": { "tags": [ "Invoice" ], "summary": "List Invoice", "operationId": "listInvoice", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InvoiceListItem" } } } } } } } }, "\/invoice\/get": { "post": { "tags": [ "Invoice" ], "summary": "Read Invoice", "operationId": "getInvoice", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice" } } } } } } }, "\/invoice\/set": { "post": { "tags": [ "Invoice" ], "summary": "Write Invoice", "operationId": "setInvoice", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#\/components\/schemas\/Invoice" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application\/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "\/invoice\/delete": { "post": { "tags": [ "Invoice" ], "summary": "Delete Invoice", "operationId": "deleteInvoice", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } }, "\/address\/list": { "post": { "tags": [ "Customer Address" ], "summary": "List Customer Address", "operationId": "listAddress", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AddressListItem" } } } } } } } }, "\/address\/get": { "post": { "tags": [ "Customer Address" ], "summary": "Read Customer Address", "operationId": "getAddress", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Address" } } } } } } }, "\/address\/set": { "post": { "tags": [ "Customer Address" ], "summary": "Write Customer Address", "operationId": "setAddress", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#\/components\/schemas\/Address" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application\/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "\/address\/delete": { "post": { "tags": [ "Customer Address" ], "summary": "Delete Customer Address", "operationId": "deleteAddress", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application\/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } } }, "components": { "schemas": { "SplashPrice": { "type": "object", "title": "Splash Price", "description": "Price structure with tax details and currency", "properties": { "ht": { "type": "number", "description": "Tax excluded amount" }, "ttc": { "type": "number", "description": "Tax included amount" }, "tax": { "type": "number", "description": "Tax amount" }, "vat": { "type": "number", "description": "VAT rate (percent)" }, "base": { "type": "integer", "enum": [ 0, 1 ], "description": "Price base: 0 = tax excluded, 1 = tax included" }, "code": { "type": "string", "description": "Currency ISO code" }, "symbol": { "type": "string", "description": "Currency symbol" }, "name": { "type": "string", "description": "Currency name" } } }, "SplashFile": { "type": "object", "title": "Splash File", "description": "File structure with checksum for synchronization", "properties": { "name": { "type": "string", "description": "Human readable file name" }, "filename": { "type": "string", "description": "File name with extension" }, "path": { "type": "string", "description": "File path or identifier on server" }, "url": { "type": "string", "format": "uri", "description": "Public url, if available" }, "md5": { "type": "string", "description": "File contents checksum" }, "size": { "type": "integer", "description": "File size in bytes" } } }, "SplashImage": { "title": "Splash Image", "description": "Image structure: a Splash File with dimensions", "allOf": [ { "$ref": "#\/components\/schemas\/SplashFile" }, { "type": "object", "properties": { "width": { "type": "integer", "description": "Image width in pixels" }, "height": { "type": "integer", "description": "Image height in pixels" } } } ] }, "ThirdParty": { "type": "object", "title": "ThirdParty", "description": "Woocommerce Customer Object", "x-splash-type": "ThirdParty", "properties": { "splash_presence": { "type": "boolean", "title": "Presence", "description": "Presence Decision Field\n\n- **Prefer Write** \u2014 field should only be written \u0026 imported from other servers\n- **Microdata:** `http:\/\/splashync.com\/schemas` \u2192 `Presence`\n- `\ud83e\uddea No Tests`", "x-splash-type": "bool", "format": "bool", "writeOnly": true, "x-schema-org-itemtype": "http:\/\/splashync.com\/schemas", "x-schema-org-itemprop": "Presence" }, "user_email": { "type": "string", "format": "email", "title": "Email", "description": "Email\n\n- **Microdata:** `http:\/\/schema.org\/ContactPoint` \u2192 `email`\n- `\ud83d\udd11 Primary` `\ud83d\udccb In List`", "x-splash-type": "email", "x-schema-org-itemtype": "http:\/\/schema.org\/ContactPoint", "x-schema-org-itemprop": "email" }, "roles": { "type": "string", "title": "Role", "description": "Role\n\n- **Microdata:** `http:\/\/schema.org\/Person` \u2192 `jobTitle`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Person", "x-schema-org-itemprop": "jobTitle", "enum": [ "administrator", "editor", "author", "contributor", "subscriber", "customer", "shop_manager", "translator" ] }, "user_login": { "type": "string", "title": "Username", "description": "Username\n\n- **Microdata:** `http:\/\/schema.org\/Organization` \u2192 `legalName`\n- `\ud83d\udd0e Indexed` `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Organization", "x-schema-org-itemprop": "legalName" }, "first_name": { "type": "string", "title": "First Name", "description": "First Name\n\n- **Microdata:** `http:\/\/schema.org\/Person` \u2192 `familyName`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Person", "x-schema-org-itemprop": "familyName" }, "last_name": { "type": "string", "title": "Last Name", "description": "Last Name\n\n- **Microdata:** `http:\/\/schema.org\/Person` \u2192 `givenName`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Person", "x-schema-org-itemprop": "givenName" }, "full_name": { "type": "string", "title": "[C] Full Name", "description": "Company | Firstname + Lastname\n\n- **Microdata:** `http:\/\/schema.org\/Organization` \u2192 `alternateName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Organization", "x-schema-org-itemprop": "alternateName" }, "user_url": { "type": "string", "format": "url", "title": "Website", "description": "Website\n\n- **Microdata:** `http:\/\/schema.org\/Organization` \u2192 `url`", "x-splash-type": "url", "x-schema-org-itemtype": "http:\/\/schema.org\/Organization", "x-schema-org-itemprop": "url" }, "user_registered": { "type": "string", "format": "datetime", "title": "Created", "description": "Created\n\n- **Microdata:** `http:\/\/schema.org\/DataFeedItem` \u2192 `dateCreated`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "example": "2026-09-24 14:36:15" }, "splash_id": { "type": "string", "title": "Splash Id", "description": "Splash Id\n\n- **Microdata:** `http:\/\/splashync.com\/schemas` \u2192 `ObjectId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/splashync.com\/schemas", "x-schema-org-itemprop": "ObjectId" }, "splash_origin": { "type": "string", "title": "Splash Origin Node", "description": "Splash Origin Node\n\n- **Microdata:** `http:\/\/splashync.com\/schemas` \u2192 `SourceNodeId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/splashync.com\/schemas", "x-schema-org-itemprop": "SourceNodeId" }, "company_safe": { "type": "string", "title": "Customer Fullname", "description": "Customer Fullname", "x-splash-type": "varchar", "format": "varchar", "readOnly": true }, "company": { "type": "string", "title": "Company", "description": "Company", "x-splash-type": "varchar", "format": "varchar", "readOnly": true }, "address_1": { "type": "string", "title": "Address line 1", "description": "Address line 1\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "streetAddress" }, "address_2": { "type": "string", "title": "Address line 2", "description": "Address line 2\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "postOfficeBoxNumber" }, "address_full": { "type": "string", "title": "Address line 1 \u0026 2", "description": "Address line 1 \u0026 2\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `alternateName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "alternateName" }, "postcode": { "type": "string", "title": "Postcode \/ ZIP", "description": "Postcode \/ ZIP\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `postalCode`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "postalCode" }, "city": { "type": "string", "title": "City", "description": "City\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "addressLocality" }, "country": { "type": "string", "format": "country", "title": "Country", "description": "Country\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `addressCountry`", "x-splash-type": "country", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "addressCountry" }, "state": { "type": "string", "format": "state", "title": "State \/ County", "description": "State \/ County\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `addressRegion`", "x-splash-type": "state", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "addressRegion" }, "phone": { "type": "string", "format": "phone", "title": "Phone", "description": "Phone\n\n- **Microdata:** `http:\/\/schema.org\/Person` \u2192 `telephone`\n- `\ud83d\udd0e Indexed`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Person", "x-schema-org-itemprop": "telephone", "example": "+33612345678" }, "billing_company": { "type": "string", "title": "[B] Company", "description": "[B] Company\n\n- **Microdata:** `https:\/\/schema.org\/billingAddress` \u2192 `legalName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/billingAddress", "x-schema-org-itemprop": "legalName" }, "billing_first_name": { "type": "string", "title": "[B] First Name", "description": "[B] First Name\n\n- **Microdata:** `https:\/\/schema.org\/billingAddress` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/billingAddress", "x-schema-org-itemprop": "familyName" }, "billing_last_name": { "type": "string", "title": "[B] Last Name", "description": "[B] Last Name\n\n- **Microdata:** `https:\/\/schema.org\/billingAddress` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/billingAddress", "x-schema-org-itemprop": "givenName" }, "billing_address_1": { "type": "string", "title": "[B] Address 1", "description": "[B] Address 1\n\n- **Microdata:** `https:\/\/schema.org\/billingAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/billingAddress", "x-schema-org-itemprop": "streetAddress" }, "billing_address_2": { "type": "string", "title": "[B] Address 2", "description": "[B] Address 2\n\n- **Microdata:** `https:\/\/schema.org\/billingAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/billingAddress", "x-schema-org-itemprop": "postOfficeBoxNumber" }, "billing_postcode": { "type": "string", "title": "[B] Postcode", "description": "[B] Postcode\n\n- **Microdata:** `https:\/\/schema.org\/billingAddress` \u2192 `postalCode`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/billingAddress", "x-schema-org-itemprop": "postalCode" }, "billing_city": { "type": "string", "title": "[B] City", "description": "[B] City\n\n- **Microdata:** `https:\/\/schema.org\/billingAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/billingAddress", "x-schema-org-itemprop": "addressLocality" }, "billing_state": { "type": "string", "format": "state", "title": "[B] State", "description": "[B] State\n\n- **Microdata:** `https:\/\/schema.org\/billingAddress` \u2192 `addressRegion`", "x-splash-type": "state", "x-schema-org-itemtype": "https:\/\/schema.org\/billingAddress", "x-schema-org-itemprop": "addressRegion" }, "billing_country": { "type": "string", "format": "country", "title": "[B] Country", "description": "[B] Country\n\n- **Microdata:** `https:\/\/schema.org\/billingAddress` \u2192 `addressCountry`", "x-splash-type": "country", "x-schema-org-itemtype": "https:\/\/schema.org\/billingAddress", "x-schema-org-itemprop": "addressCountry" }, "billing_phone": { "type": "string", "format": "phone", "title": "[B] Phone", "description": "[B] Phone\n\n- **Microdata:** `https:\/\/schema.org\/billingAddress` \u2192 `telephone`", "x-splash-type": "phone", "x-schema-org-itemtype": "https:\/\/schema.org\/billingAddress", "x-schema-org-itemprop": "telephone", "example": "+33612345678" }, "billing_email": { "type": "string", "format": "email", "title": "[B] Email", "description": "[B] Email\n\n- **Microdata:** `https:\/\/schema.org\/billingAddress` \u2192 `email`", "x-splash-type": "email", "x-schema-org-itemtype": "https:\/\/schema.org\/billingAddress", "x-schema-org-itemprop": "email" }, "shipping_company": { "type": "string", "title": "[S] Company", "description": "[S] Company\n\n- **Microdata:** `https:\/\/schema.org\/deliveryAddress` \u2192 `legalName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/deliveryAddress", "x-schema-org-itemprop": "legalName" }, "shipping_first_name": { "type": "string", "title": "[S] First Name", "description": "[S] First Name\n\n- **Microdata:** `https:\/\/schema.org\/deliveryAddress` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/deliveryAddress", "x-schema-org-itemprop": "familyName" }, "shipping_last_name": { "type": "string", "title": "[S] Last Name", "description": "[S] Last Name\n\n- **Microdata:** `https:\/\/schema.org\/deliveryAddress` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/deliveryAddress", "x-schema-org-itemprop": "givenName" }, "shipping_address_1": { "type": "string", "title": "[S] Address 1", "description": "[S] Address 1\n\n- **Microdata:** `https:\/\/schema.org\/deliveryAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/deliveryAddress", "x-schema-org-itemprop": "streetAddress" }, "shipping_address_2": { "type": "string", "title": "[S] Address 2", "description": "[S] Address 2\n\n- **Microdata:** `https:\/\/schema.org\/deliveryAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/deliveryAddress", "x-schema-org-itemprop": "postOfficeBoxNumber" }, "shipping_postcode": { "type": "string", "title": "[S] Postcode", "description": "[S] Postcode\n\n- **Microdata:** `https:\/\/schema.org\/deliveryAddress` \u2192 `postalCode`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/deliveryAddress", "x-schema-org-itemprop": "postalCode" }, "shipping_city": { "type": "string", "title": "[S] City", "description": "[S] City\n\n- **Microdata:** `https:\/\/schema.org\/deliveryAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https:\/\/schema.org\/deliveryAddress", "x-schema-org-itemprop": "addressLocality" }, "shipping_state": { "type": "string", "format": "state", "title": "[S] State", "description": "[S] State\n\n- **Microdata:** `https:\/\/schema.org\/deliveryAddress` \u2192 `addressRegion`", "x-splash-type": "state", "x-schema-org-itemtype": "https:\/\/schema.org\/deliveryAddress", "x-schema-org-itemprop": "addressRegion" }, "shipping_country": { "type": "string", "format": "country", "title": "[S] Country", "description": "[S] Country\n\n- **Microdata:** `https:\/\/schema.org\/deliveryAddress` \u2192 `addressCountry`", "x-splash-type": "country", "x-schema-org-itemtype": "https:\/\/schema.org\/deliveryAddress", "x-schema-org-itemprop": "addressCountry" }, "shipping_phone": { "type": "string", "format": "phone", "title": "[S] Phone", "description": "[S] Phone\n\n- **Microdata:** `https:\/\/schema.org\/deliveryAddress` \u2192 `telephone`", "x-splash-type": "phone", "x-schema-org-itemtype": "https:\/\/schema.org\/deliveryAddress", "x-schema-org-itemprop": "telephone", "example": "+33612345678" }, "user_custom_nickname": { "type": "string", "title": "Nickname", "description": "Nickname\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `nickname`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "nickname" }, "user_custom_description": { "type": "string", "title": "Description", "description": "Description\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `description`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "description" }, "user_custom_rich_editing": { "type": "string", "title": "Rich_editing", "description": "Rich_editing\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `rich_editing`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "rich_editing" }, "user_custom_syntax_highlighting": { "type": "string", "title": "Syntax_highlighting", "description": "Syntax_highlighting\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `syntax_highlighting`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "syntax_highlighting" }, "user_custom_comment_shortcuts": { "type": "string", "title": "Comment_shortcuts", "description": "Comment_shortcuts\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `comment_shortcuts`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "comment_shortcuts" }, "user_custom_admin_color": { "type": "string", "title": "Admin_color", "description": "Admin_color\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `admin_color`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "admin_color" }, "user_custom_use_ssl": { "type": "string", "title": "Use_ssl", "description": "Use_ssl\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `use_ssl`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "use_ssl" }, "user_custom_show_admin_bar_front": { "type": "string", "title": "Show_admin_bar_front", "description": "Show_admin_bar_front\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `show_admin_bar_front`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "show_admin_bar_front" }, "user_custom_locale": { "type": "string", "title": "Locale", "description": "Locale\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `locale`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "locale" }, "user_custom_wp_7_0_capabilities": { "type": "string", "title": "Wp_7_0_capabilities", "description": "Wp_7_0_capabilities\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `wp_7_0_capabilities`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "wp_7_0_capabilities" }, "user_custom_wp_7_0_user_level": { "type": "string", "title": "Wp_7_0_user_level", "description": "Wp_7_0_user_level\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `wp_7_0_user_level`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "wp_7_0_user_level" }, "user_custom_dismissed_wp_pointers": { "type": "string", "title": "Dismissed_wp_pointers", "description": "Dismissed_wp_pointers\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `dismissed_wp_pointers`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "dismissed_wp_pointers" }, "user_custom_show_welcome_panel": { "type": "string", "title": "Show_welcome_panel", "description": "Show_welcome_panel\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `show_welcome_panel`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "show_welcome_panel" }, "user_custom_last_update": { "type": "string", "title": "Last_update", "description": "Last_update\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `last_update`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "last_update" }, "user_custom_session_tokens": { "type": "string", "title": "Session_tokens", "description": "Session_tokens\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `session_tokens`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "session_tokens" }, "user_custom_wc_last_active": { "type": "string", "title": "Wc_last_active", "description": "Wc_last_active\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `wc_last_active`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "wc_last_active" }, "user_custom_user_lang": { "type": "string", "title": "User_lang", "description": "User_lang\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `user_lang`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "user_lang" }, "user_custom_edit_lang": { "type": "string", "title": "Edit_lang", "description": "Edit_lang\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `edit_lang`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "edit_lang" }, "user_custom_wp_7_0_dashboard_quick_press_last_post_id": { "type": "string", "title": "Wp_7_0_dashboard_quick_press_last_post_id", "description": "Wp_7_0_dashboard_quick_press_last_post_id\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `wp_7_0_dashboard_quick_press_last_post_id`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "wp_7_0_dashboard_quick_press_last_post_id" }, "user_custom_community-events-location": { "type": "string", "title": "Community-events-location", "description": "Community-events-location\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `community-events-location`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "community-events-location" }, "user_custom_meta-box-order_product": { "type": "string", "title": "Meta-box-order_product", "description": "Meta-box-order_product\n\n- **Microdata:** `http:\/\/meta.schema.org\/additionalType` \u2192 `meta-box-order_product`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/meta.schema.org\/additionalType", "x-schema-org-itemprop": "meta-box-order_product" } }, "required": [ "user_email" ] }, "ThirdPartyListItem": { "type": "object", "title": "ThirdParty (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "user_email": { "type": "string", "format": "email", "title": "Email" }, "roles": { "type": "string", "title": "Role" }, "first_name": { "type": "string", "title": "First Name" }, "last_name": { "type": "string", "title": "Last Name" } } }, "Product": { "type": "object", "title": "Product", "description": "WooCommerce Product Object", "x-splash-type": "Product", "properties": { "splash_presence": { "type": "boolean", "title": "Presence", "description": "Presence Decision Field\n\n- **Prefer Write** \u2014 field should only be written \u0026 imported from other servers\n- **Microdata:** `http:\/\/splashync.com\/schemas` \u2192 `Presence`\n- `\ud83e\uddea No Tests`", "x-splash-type": "bool", "format": "bool", "writeOnly": true, "x-schema-org-itemtype": "http:\/\/splashync.com\/schemas", "x-schema-org-itemprop": "Presence" }, "post_author": { "type": "string", "title": "Author", "description": "Author\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `author`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "author" }, "post_modified": { "type": "string", "format": "datetime", "title": "Last Modified", "description": "Last Modified\n\n- **Microdata:** `http:\/\/schema.org\/DataFeedItem` \u2192 `dateModified`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/DataFeedItem", "x-schema-org-itemprop": "dateModified", "example": "2026-09-24 14:36:15" }, "post_date": { "type": "string", "format": "datetime", "title": "Created", "description": "Created\n\n- **Microdata:** `http:\/\/schema.org\/DataFeedItem` \u2192 `dateCreated`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "example": "2026-09-24 14:36:15" }, "splash_id": { "type": "string", "title": "Splash Id", "description": "Splash Id\n\n- **Microdata:** `http:\/\/splashync.com\/schemas` \u2192 `ObjectId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/splashync.com\/schemas", "x-schema-org-itemprop": "ObjectId" }, "splash_origin": { "type": "string", "title": "Splash Origin Node", "description": "Splash Origin Node\n\n- **Microdata:** `http:\/\/splashync.com\/schemas` \u2192 `SourceNodeId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/splashync.com\/schemas", "x-schema-org-itemprop": "SourceNodeId" }, "_thumbnail_id": { "type": "string", "title": "Featured Image", "description": "Featured Image\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `image`", "x-splash-type": "image", "format": "image", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "image" }, "post_title": { "type": "string", "title": "Title", "description": "Products : Title\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `name`\n- **Options:**\n - **language** =\u003E en_US\n- `\ud83d\udccb In List` `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "name" }, "post_title_fr_FR": { "type": "string", "title": "Title", "description": "Products : Title\n\n- **Microdata:** `http:\/\/schema.org\/Product\/fr_FR` \u2192 `name`\n- **Options:**\n - **language** =\u003E fr_FR\n- `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Product\/fr_FR", "x-schema-org-itemprop": "name" }, "base_title": { "type": "string", "title": "Base Title", "description": "Products : Title without Options\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `alternateName`\n- **Options:**\n - **language** =\u003E en_US", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "alternateName" }, "base_title_fr_FR": { "type": "string", "title": "Base Title", "description": "Products : Title without Options\n\n- **Microdata:** `http:\/\/schema.org\/Product\/fr_FR` \u2192 `alternateName`\n- **Options:**\n - **language** =\u003E fr_FR", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Product\/fr_FR", "x-schema-org-itemprop": "alternateName" }, "post_excerpt": { "type": "string", "title": "Product short description", "description": "Products : Product short description\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `description`\n- **Options:**\n - **language** =\u003E en_US", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "description" }, "post_excerpt_fr_FR": { "type": "string", "title": "Product short description", "description": "Products : Product short description\n\n- **Microdata:** `http:\/\/schema.org\/Product\/fr_FR` \u2192 `description`\n- **Options:**\n - **language** =\u003E fr_FR", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Product\/fr_FR", "x-schema-org-itemprop": "description" }, "post_content": { "type": "string", "title": "Contents", "description": "Products : Contents\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `articleBody`\n- **Options:**\n - **language** =\u003E en_US\n- `\ud83d\udcdc Logged`", "x-splash-type": "text", "format": "text", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "articleBody" }, "post_content_fr_FR": { "type": "string", "title": "Contents", "description": "Products : Contents\n\n- **Microdata:** `http:\/\/schema.org\/Article\/fr_FR` \u2192 `articleBody`\n- **Options:**\n - **language** =\u003E fr_FR\n- `\ud83d\udcdc Logged`", "x-splash-type": "text", "format": "text", "x-schema-org-itemtype": "http:\/\/schema.org\/Article\/fr_FR", "x-schema-org-itemprop": "articleBody" }, "post_name": { "type": "string", "title": "Slug", "description": "Products : Permalink\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `urlRewrite`\n- **Options:**\n - **isLowerCase** =\u003E 1\n- `\ud83d\udcdc Logged` `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "urlRewrite" }, "post_status": { "type": "string", "title": "Status", "description": "Products : Status\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `status`\n- `\ud83d\udccb In List` `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "status", "enum": [ "draft", "pending", "private", "publish" ] }, "_sku": { "type": "string", "title": "SKU", "description": "Product : SKU\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `model`\n- `\ud83d\udd11 Primary` `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "model" }, "_global_unique_id": { "type": "string", "title": "EAN", "description": "Product : GTIN, UPC, EAN, or ISBN\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `gtin13`\n- `\ud83d\udd0e Indexed`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "gtin13" }, "is_visible": { "type": "boolean", "title": "Enabled", "description": "Product : Enabled\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `offered`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "offered" }, "_weight": { "type": "number", "title": "Weight", "description": "Product Weight\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `weight`", "x-splash-type": "double", "format": "double", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "weight" }, "_height": { "type": "number", "title": "Height", "description": "Product Height\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `height`", "x-splash-type": "double", "format": "double", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "height" }, "_length": { "type": "number", "title": "Length", "description": "Product Length\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `depth`", "x-splash-type": "double", "format": "double", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "depth" }, "_width": { "type": "number", "title": "Width", "description": "Product Width\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `width`", "x-splash-type": "double", "format": "double", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "width" }, "_stock": { "type": "integer", "title": "Stock quantity", "description": "Product Stock quantity\n\n- **Microdata:** `http:\/\/schema.org\/Offer` \u2192 `inventoryLevel`\n- `\ud83d\udccb In List`", "x-splash-type": "int", "format": "int", "x-schema-org-itemtype": "http:\/\/schema.org\/Offer", "x-schema-org-itemprop": "inventoryLevel" }, "stock_managed": { "type": "boolean", "title": "Stock Managed", "description": "Product Manage stock?\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `stockIsManaged`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "stockIsManaged" }, "stock_from_parent": { "type": "boolean", "title": "Stock from Parent", "description": "Product Enable stock management at product level\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `stockFromParent`\n- `\ud83e\uddea No Tests`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "stockFromParent" }, "outofstock": { "type": "boolean", "title": "Out of stock", "description": "Product Out of stock\n\n- **Microdata:** `http:\/\/schema.org\/ItemAvailability` \u2192 `OutOfStock`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/ItemAvailability", "x-schema-org-itemprop": "OutOfStock" }, "_regular_price": { "allOf": [ { "$ref": "#\/components\/schemas\/SplashPrice" } ], "title": "Regular price", "description": "Product Regular price\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `price`", "x-splash-type": "price", "format": "price", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "price", "example": { "base": 0, "ht": 60.48, "vat": 20, "tax": 12.1, "ttc": 72.58, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } }, "_cogs_total_value": { "allOf": [ { "$ref": "#\/components\/schemas\/SplashPrice" } ], "title": "Cost of goods", "description": "Product : Cost of goods\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `wholesalePrice`", "x-splash-type": "price", "format": "price", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "wholesalePrice", "example": { "base": 0, "ht": 66.67, "vat": 20, "tax": 13.33, "ttc": 80, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } }, "type": { "type": "string", "title": "Product Type", "description": "Product Type\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `type`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "type", "enum": [ "simple", "variant" ] }, "default_on": { "type": "boolean", "title": "Is default variant", "description": "Is default variant\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `isDefaultVariation`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "isDefaultVariation" }, "default_id": { "type": "string", "format": "objectid::Product", "title": "Default Variant", "description": "Default Variant\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `DefaultVariation`\n- `\ud83e\uddea No Tests`", "x-splash-type": "objectid::Product", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "DefaultVariation", "example": "245::Product" }, "parent_id": { "type": "string", "title": "Parent", "description": "Parent\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `isVariationOf`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "isVariationOf" }, "parent_sku": { "type": "string", "title": "Parent SKU", "description": "Parent SKU\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `isVariationOfName`\n- `\ud83d\udd0e Indexed` `\ud83e\uddea No Tests`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "isVariationOfName" }, "md5": { "type": "string", "title": "Md5", "description": "Unique Md5 Object Checksum\n\n- **Microdata:** `http:\/\/schema.org\/Thing` \u2192 `identifier`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Thing", "x-schema-org-itemprop": "identifier" }, "md5-debug": { "type": "string", "title": "Md5 Debug", "description": "Unique Checksum String fro Debug", "x-splash-type": "varchar", "format": "varchar", "readOnly": true }, "categories": { "type": "string", "title": "Category", "description": "Product categories Slugs\n\n- **No Sync** \u2014 field prefers being left unchanged, without any synchronization\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `category`", "x-splash-type": "inline", "format": "inline", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "category", "enum": [ "uncategorized", "category-a", "category-b", "category-c", "category-d", "category-a-2", "category-b-2", "category-c-2", "category-d-2" ] }, "categories_names": { "type": "string", "title": "Category Name", "description": "Product categories Names\n\n- **No Sync** \u2014 field prefers being left unchanged, without any synchronization\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `categoryName`\n- `\ud83e\uddea No Tests`", "x-splash-type": "inline", "format": "inline", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "categoryName", "enum": [ "Uncategorized", "Category A", "Category B", "Category C", "Category D" ] }, "variants": { "type": "array", "title": "Variants", "x-splash-list": "variants", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "objectid::Product@list", "title": "Children", "description": "Children\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `Variants`\n- `\ud83e\uddea No Tests`", "x-splash-type": "objectid::Product@list", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "Variants", "example": "202::Product" }, "sku": { "type": "string", "title": "Variant SKU", "description": "Variant SKU\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `VariationName`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "VariationName" }, "attribute": { "type": "string", "title": "Attribute", "description": "Attribute\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `VariationAttribute`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "VariationAttribute" } } } }, "attributes": { "type": "array", "title": "Attributes", "x-splash-list": "attributes", "items": { "type": "object", "properties": { "code": { "type": "string", "title": "Code", "description": "Code\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `VariantAttributeCode`\n- **Options:**\n - **isLowerCase** =\u003E 1\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "VariantAttributeCode" }, "name": { "type": "string", "title": "Name", "description": "Name\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `VariantAttributeName`\n- **Options:**\n - **language** =\u003E en_US\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "VariantAttributeName" }, "name_fr_FR": { "type": "string", "title": "Name", "description": "Name\n\n- **Microdata:** `http:\/\/schema.org\/Product\/fr_FR` \u2192 `VariantAttributeName`\n- **Options:**\n - **language** =\u003E fr_FR\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http:\/\/schema.org\/Product\/fr_FR", "x-schema-org-itemprop": "VariantAttributeName" }, "value": { "type": "string", "title": "Value", "description": "Value\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `VariantAttributeValue`\n- **Options:**\n - **language** =\u003E en_US\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "VariantAttributeValue" }, "value_fr_FR": { "type": "string", "title": "Value", "description": "Value\n\n- **Microdata:** `http:\/\/schema.org\/Product\/fr_FR` \u2192 `VariantAttributeValue`\n- **Options:**\n - **language** =\u003E fr_FR\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http:\/\/schema.org\/Product\/fr_FR", "x-schema-org-itemprop": "VariantAttributeValue" } } } }, "images": { "type": "array", "title": "Images", "x-splash-list": "images", "items": { "type": "object", "properties": { "image": { "type": "string", "title": "Images", "description": "Product Images\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `image`", "x-splash-type": "image@list", "format": "image@list", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "image" }, "position": { "type": "integer", "title": "Position", "description": "Image Order for this Product Variant\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `positionImage`\n- `\ud83e\uddea No Tests`", "x-splash-type": "int@list", "format": "int@list", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "positionImage" }, "visible": { "type": "boolean", "title": "Enable", "description": "Image is visible for this Product Variant\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `isVisibleImage`\n- `\ud83e\uddea No Tests`", "x-splash-type": "bool@list", "format": "bool@list", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "isVisibleImage" }, "cover": { "type": "boolean", "title": "Featured Image", "description": "Image is Main Product Cover Image\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `isCover`\n- `\ud83e\uddea No Tests`", "x-splash-type": "bool@list", "format": "bool@list", "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "isCover" } } } } }, "required": [ "base_title", "_sku" ] }, "ProductListItem": { "type": "object", "title": "Product (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "post_title": { "type": "string", "title": "Title" }, "post_status": { "type": "string", "title": "Status" }, "_sku": { "type": "string", "title": "SKU" }, "_stock": { "type": "integer", "title": "Stock quantity" }, "md5": { "type": "string", "title": "Md5" } } }, "Post": { "type": "object", "title": "Post", "description": "Wordpress Post Object", "x-splash-type": "Post", "properties": { "post_title": { "type": "string", "title": "Title", "description": "Post : Title\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `name`\n- `\ud83d\udccb In List` `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "name" }, "post_name": { "type": "string", "title": "Slug", "description": "Post : Permalink\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `identifier`\n- **Options:**\n - **isLowerCase** =\u003E 1\n- `\ud83d\udccb In List` `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "identifier" }, "post_content": { "type": "string", "title": "Contents", "description": "Post : Contents\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `articleBody`\n- `\ud83d\udcdc Logged`", "x-splash-type": "text", "format": "text", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "articleBody" }, "post_status": { "type": "string", "title": "Status", "description": "Post : Status\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `status`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "status", "enum": [ "draft", "pending", "private", "publish" ] }, "post_author": { "type": "string", "title": "Author", "description": "Author\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `author`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "author" }, "post_modified": { "type": "string", "format": "datetime", "title": "Last Modified", "description": "Last Modified\n\n- **Microdata:** `http:\/\/schema.org\/DataFeedItem` \u2192 `dateModified`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/DataFeedItem", "x-schema-org-itemprop": "dateModified", "example": "2026-09-24 14:36:16" }, "post_date": { "type": "string", "format": "datetime", "title": "Created", "description": "Created\n\n- **Microdata:** `http:\/\/schema.org\/DataFeedItem` \u2192 `dateCreated`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "example": "2026-09-24 14:36:16" }, "splash_id": { "type": "string", "title": "Splash Id", "description": "Splash Id\n\n- **Microdata:** `http:\/\/splashync.com\/schemas` \u2192 `ObjectId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/splashync.com\/schemas", "x-schema-org-itemprop": "ObjectId" }, "splash_origin": { "type": "string", "title": "Splash Origin Node", "description": "Splash Origin Node\n\n- **Microdata:** `http:\/\/splashync.com\/schemas` \u2192 `SourceNodeId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/splashync.com\/schemas", "x-schema-org-itemprop": "SourceNodeId" }, "_thumbnail_id": { "type": "string", "title": "Featured Image", "description": "Featured Image\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `image`", "x-splash-type": "image", "format": "image", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "image" }, "post_parent": { "type": "string", "format": "objectid::Page", "title": "Parent", "description": "Parent\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `mainEntity`", "x-splash-type": "objectid::Page", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "mainEntity", "example": "113::Page" } }, "required": [ "post_title" ] }, "PostListItem": { "type": "object", "title": "Post (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "post_title": { "type": "string", "title": "Title" }, "post_name": { "type": "string", "title": "Slug" }, "post_status": { "type": "string", "title": "Status" } } }, "Page": { "type": "object", "title": "Page", "description": "Wordpress Page Object", "x-splash-type": "Page", "properties": { "post_title": { "type": "string", "title": "Title", "description": "Post : Title\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `name`\n- `\ud83d\udccb In List` `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "name" }, "post_name": { "type": "string", "title": "Slug", "description": "Post : Permalink\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `identifier`\n- **Options:**\n - **isLowerCase** =\u003E 1\n- `\ud83d\udccb In List` `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "identifier" }, "post_content": { "type": "string", "title": "Contents", "description": "Post : Contents\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `articleBody`\n- `\ud83d\udcdc Logged`", "x-splash-type": "text", "format": "text", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "articleBody" }, "post_status": { "type": "string", "title": "Status", "description": "Post : Status\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `status`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "status", "enum": [ "draft", "pending", "private", "publish" ] }, "post_author": { "type": "string", "title": "Author", "description": "Author\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `author`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "author" }, "post_modified": { "type": "string", "format": "datetime", "title": "Last Modified", "description": "Last Modified\n\n- **Microdata:** `http:\/\/schema.org\/DataFeedItem` \u2192 `dateModified`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/DataFeedItem", "x-schema-org-itemprop": "dateModified", "example": "2026-09-24 14:36:16" }, "post_date": { "type": "string", "format": "datetime", "title": "Created", "description": "Created\n\n- **Microdata:** `http:\/\/schema.org\/DataFeedItem` \u2192 `dateCreated`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "example": "2026-09-24 14:36:16" }, "splash_id": { "type": "string", "title": "Splash Id", "description": "Splash Id\n\n- **Microdata:** `http:\/\/splashync.com\/schemas` \u2192 `ObjectId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/splashync.com\/schemas", "x-schema-org-itemprop": "ObjectId" }, "splash_origin": { "type": "string", "title": "Splash Origin Node", "description": "Splash Origin Node\n\n- **Microdata:** `http:\/\/splashync.com\/schemas` \u2192 `SourceNodeId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/splashync.com\/schemas", "x-schema-org-itemprop": "SourceNodeId" }, "_thumbnail_id": { "type": "string", "title": "Featured Image", "description": "Featured Image\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `image`", "x-splash-type": "image", "format": "image", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "image" }, "post_parent": { "type": "string", "format": "objectid::Page", "title": "Parent", "description": "Parent\n\n- **Microdata:** `http:\/\/schema.org\/Article` \u2192 `mainEntity`", "x-splash-type": "objectid::Page", "x-schema-org-itemtype": "http:\/\/schema.org\/Article", "x-schema-org-itemprop": "mainEntity", "example": "812::Page" } }, "required": [ "post_title" ] }, "PageListItem": { "type": "object", "title": "Page (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "post_title": { "type": "string", "title": "Title" }, "post_name": { "type": "string", "title": "Slug" }, "post_status": { "type": "string", "title": "Status" } } }, "Order": { "type": "object", "title": "Order", "description": "WooCommerce Order Object", "x-splash-type": "Order", "properties": { "_customer_id": { "type": "string", "format": "objectid::ThirdParty", "title": "Customer", "description": "Customer\n\n- **Microdata:** `http:\/\/schema.org\/Organization` \u2192 `ID`", "x-splash-type": "objectid::ThirdParty", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Organization", "x-schema-org-itemprop": "ID", "example": "697::ThirdParty" }, "reference": { "type": "string", "title": "Reference", "description": "Reference\n\n- **Microdata:** `http:\/\/schema.org\/Order` \u2192 `orderNumber`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Order", "x-schema-org-itemprop": "orderNumber" }, "_date_created": { "type": "string", "format": "date", "title": "Order date", "description": "Order date\n\n- **Microdata:** `http:\/\/schema.org\/Order` \u2192 `orderDate`", "x-splash-type": "date", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Order", "x-schema-org-itemprop": "orderDate", "example": "2026-09-24" }, "_datetime_created": { "type": "string", "format": "datetime", "title": "Creation DateTime", "description": "Creation DateTime\n\n- **Microdata:** `http:\/\/schema.org\/DataFeedItem` \u2192 `dateCreated`\n- `\ud83d\udccb In List`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "example": "2026-09-24 14:36:16" }, "_date_paid": { "type": "string", "format": "date", "title": "Date Paid", "description": "Date Paid\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `confirmationDate`\n- `\ud83d\udccb In List`", "x-splash-type": "date", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "confirmationDate", "example": "2026-09-24" }, "blogname": { "type": "string", "title": "Blog Name", "description": "Blog Name\n\n- **Microdata:** `http:\/\/schema.org\/Author` \u2192 `alternateName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Author", "x-schema-org-itemprop": "alternateName" }, "total_ht": { "type": "number", "title": "Order total (Tax Excl.)", "description": "Order total (Tax Excl.)\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `totalPaymentDue`", "x-splash-type": "double", "format": "double", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "totalPaymentDue" }, "total": { "type": "number", "title": "Order total", "description": "Order total\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `totalPaymentDueTaxIncluded`\n- `\ud83d\udccb In List`", "x-splash-type": "double", "format": "double", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "totalPaymentDueTaxIncluded" }, "price_total": { "allOf": [ { "$ref": "#\/components\/schemas\/SplashPrice" } ], "title": "Order Total", "description": "Order Total\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `total`", "x-splash-type": "price", "format": "price", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "total", "example": { "base": 0, "ht": 131.6, "vat": 20, "tax": 26.32, "ttc": 157.92, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } }, "price_shipping": { "allOf": [ { "$ref": "#\/components\/schemas\/SplashPrice" } ], "title": "Order Shipping", "description": "Order Shipping\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `totalShipping`", "x-splash-type": "price", "format": "price", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "totalShipping", "example": { "base": 0, "ht": 33.33, "vat": 20, "tax": 6.67, "ttc": 40, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } }, "price_discount": { "allOf": [ { "$ref": "#\/components\/schemas\/SplashPrice" } ], "title": "Order Discounts", "description": "Order Discounts\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `totalDiscount`", "x-splash-type": "price", "format": "price", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "totalDiscount", "example": { "base": 0, "ht": 72.11, "vat": 20, "tax": 14.42, "ttc": 86.53, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } }, "status": { "type": "string", "title": "Status", "description": "Status\n\n- **Prefer Read** \u2014 field should only be read \u0026 exported to other servers\n- **Microdata:** `http:\/\/schema.org\/Order` \u2192 `orderStatus`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Order", "x-schema-org-itemprop": "orderStatus", "enum": [ "OrderDraft", "OrderPaymentDue", "OrderProcessing", "OrderDelivered", "OrderCanceled" ] }, "status_raw": { "type": "string", "title": "Raw Status", "description": "Raw Status", "x-splash-type": "varchar", "format": "varchar", "readOnly": true }, "isdraft": { "type": "boolean", "title": "Pending payment", "description": "Pending payment\n\n- **Microdata:** `http:\/\/schema.org\/OrderStatus` \u2192 `OrderDraft`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/OrderStatus", "x-schema-org-itemprop": "OrderDraft" }, "iscanceled": { "type": "boolean", "title": "Cancelled", "description": "Cancelled\n\n- **Microdata:** `http:\/\/schema.org\/OrderStatus` \u2192 `OrderCancelled`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/OrderStatus", "x-schema-org-itemprop": "OrderCancelled" }, "isvalidated": { "type": "boolean", "title": "Validated", "description": "Validated\n\n- **Microdata:** `http:\/\/schema.org\/OrderStatus` \u2192 `OrderValidated`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/OrderStatus", "x-schema-org-itemprop": "OrderValidated" }, "isProcessing": { "type": "boolean", "title": "Processing", "description": "Processing\n\n- **Microdata:** `http:\/\/schema.org\/OrderStatus` \u2192 `OrderProcessing`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/OrderStatus", "x-schema-org-itemprop": "OrderProcessing" }, "isclosed": { "type": "boolean", "title": "Completed", "description": "Completed\n\n- **Microdata:** `http:\/\/schema.org\/OrderStatus` \u2192 `OrderDelivered`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/OrderStatus", "x-schema-org-itemprop": "OrderDelivered" }, "ispaid": { "type": "boolean", "title": "Paid", "description": "Paid\n\n- **Microdata:** `http:\/\/schema.org\/OrderStatus` \u2192 `OrderPaid`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/OrderStatus", "x-schema-org-itemprop": "OrderPaid" }, "logistic_address_id": { "type": "string", "format": "objectid::Address", "title": "Logistic address", "description": "Logistic address\n\n- **Microdata:** `http:\/\/schema.org\/Order` \u2192 `deliveryAddress`", "x-splash-type": "objectid::Address", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Order", "x-schema-org-itemprop": "deliveryAddress", "example": "908::Address" }, "invoicing_address_id": { "type": "string", "format": "objectid::Address", "title": "Invoicing address", "description": "Invoicing address\n\n- **Microdata:** `http:\/\/schema.org\/Order` \u2192 `invoicingAddress`", "x-splash-type": "objectid::Address", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Order", "x-schema-org-itemprop": "invoicingAddress", "example": "956::Address" }, "billing": { "type": "string", "title": "Billing Address", "description": "Billing Address", "x-splash-type": "varchar", "format": "varchar", "readOnly": true }, "shipping": { "type": "string", "title": "Shipping Address", "description": "Shipping Address", "x-splash-type": "varchar", "format": "varchar", "readOnly": true }, "shipping_company": { "type": "string", "title": "Company", "description": "Company\n\n- **Microdata:** `http:\/\/schema.org\/Organization` \u2192 `legalName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Organization", "x-schema-org-itemprop": "legalName" }, "formatted_shipping_full_name": { "type": "string", "title": "Contact Name", "description": "Contact Name\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `alternateName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "alternateName" }, "shipping_address_1": { "type": "string", "title": "Delivery", "description": "Delivery\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "streetAddress" }, "shipping_address_2": { "type": "string", "title": "Delivery (2)", "description": "Delivery (2)\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "postOfficeBoxNumber" }, "shipping_postcode": { "type": "string", "title": "Zip\/Postal Code", "description": "Zip\/Postal Code\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `postalCode`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "postalCode" }, "shipping_city": { "type": "string", "title": "City", "description": "City\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "addressLocality" }, "shipping_state": { "type": "string", "title": "State", "description": "State", "x-splash-type": "varchar", "format": "varchar", "readOnly": true }, "customer_note": { "type": "string", "title": "Other", "description": "Other: Remarks, Relay Point Code, more...\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `description`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "description" }, "shipping_country": { "type": "string", "format": "country", "title": "Country", "description": "Country\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `addressCountry`", "x-splash-type": "country", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "addressCountry" }, "shipping_phone": { "type": "string", "format": "phone", "title": "Home phone", "description": "Home phone\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `telephone`\n- `\ud83d\udd0e Indexed`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "telephone", "example": "+33612345678" }, "shipping_method_title": { "type": "string", "title": "Shipping Method", "description": "Shipping Method\n\n- **Microdata:** `http:\/\/schema.org\/ParcelDelivery` \u2192 `provider`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/ParcelDelivery", "x-schema-org-itemprop": "provider" }, "shipping_method_id": { "type": "string", "title": "Carrier Code", "description": "Carrier Code\n\n- **Microdata:** `http:\/\/schema.org\/ParcelDelivery` \u2192 `identifier`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/ParcelDelivery", "x-schema-org-itemprop": "identifier" }, "items": { "type": "array", "title": "Items", "x-splash-list": "items", "items": { "type": "object", "properties": { "name": { "type": "string", "title": "Item", "description": "Item\n\n- **Microdata:** `http:\/\/schema.org\/partOfInvoice` \u2192 `description`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/partOfInvoice", "x-schema-org-itemprop": "description" }, "product": { "type": "string", "format": "objectid::Product@list", "title": "Product", "description": "Product\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `productID`\n- `\ud83e\uddea No Tests`", "x-splash-type": "objectid::Product@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "productID", "example": "347::Product" }, "sku": { "type": "string", "title": "SKU", "description": "SKU\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `sku`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "sku" }, "quantity": { "type": "integer", "title": "Quantity", "description": "Quantity\n\n- **Microdata:** `http:\/\/schema.org\/QuantitativeValue` \u2192 `value`", "x-splash-type": "int@list", "format": "int@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/QuantitativeValue", "x-schema-org-itemprop": "value" }, "discount": { "type": "number", "title": "Percentage discount", "description": "Percentage discount\n\n- **Microdata:** `http:\/\/schema.org\/Order` \u2192 `discount`", "x-splash-type": "double@list", "format": "double@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Order", "x-schema-org-itemprop": "discount" }, "subtotal": { "allOf": [ { "$ref": "#\/components\/schemas\/SplashPrice" } ], "title": "Price", "description": "Price\n\n- **Microdata:** `http:\/\/schema.org\/PriceSpecification` \u2192 `price`", "x-splash-type": "price@list", "format": "price@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PriceSpecification", "x-schema-org-itemprop": "price", "example": { "base": 0, "ht": 176.77, "vat": 20, "tax": 35.35, "ttc": 212.12, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } }, "tax_name": { "type": "string", "title": "Tax name", "description": "Tax name\n\n- **Microdata:** `http:\/\/schema.org\/PriceSpecification` \u2192 `valueAddedTaxName`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PriceSpecification", "x-schema-org-itemprop": "valueAddedTaxName" }, "type": { "type": "string", "title": "Type", "description": "Line Item Type: product, shipping, fee, ...\n\n- **Microdata:** `https:\/\/schema.org\/OrderItem` \u2192 `additionalType`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "https:\/\/schema.org\/OrderItem", "x-schema-org-itemprop": "additionalType", "enum": [ "product", "shipping", "fee", "option", "comment" ] }, "options": { "type": "string", "title": "Options", "description": "Line details, from WooCommerce order item meta data\n\n- **Microdata:** `http:\/\/schema.org\/partOfInvoice` \u2192 `options`", "x-splash-type": "inline@list", "format": "inline@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/partOfInvoice", "x-schema-org-itemprop": "options" } } } }, "payments": { "type": "array", "title": "Payments", "x-splash-list": "payments", "items": { "type": "object", "properties": { "_payment_method": { "type": "string", "title": "Method", "description": "Method\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `PaymentMethod`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "PaymentMethod" }, "_date_paid": { "type": "string", "format": "date@list", "title": "Date", "description": "Date\n\n- **Microdata:** `http:\/\/schema.org\/PaymentChargeSpecification` \u2192 `validFrom`", "x-splash-type": "date@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PaymentChargeSpecification", "x-schema-org-itemprop": "validFrom", "example": "2026-09-24" }, "_transaction_id": { "type": "string", "title": "Transaction ID", "description": "Transaction ID\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `paymentMethodId`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "paymentMethodId" }, "_total_tax": { "type": "number", "title": "Total", "description": "Total\n\n- **Microdata:** `http:\/\/schema.org\/PaymentChargeSpecification` \u2192 `price`", "x-splash-type": "double@list", "format": "double@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PaymentChargeSpecification", "x-schema-org-itemprop": "price" } } } } }, "required": [ "_customer_id", "_date_created" ] }, "OrderListItem": { "type": "object", "title": "Order (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "reference": { "type": "string", "title": "Reference" }, "_datetime_created": { "type": "string", "format": "date-time", "title": "Creation DateTime" }, "_date_paid": { "type": "string", "format": "date", "title": "Date Paid" }, "total": { "type": "number", "title": "Order total" }, "status": { "type": "string", "title": "Status" } } }, "Invoice": { "type": "object", "title": "Invoice", "description": "WooCommerce Virtual Invoice", "x-splash-type": "Invoice", "properties": { "_customer_id": { "type": "string", "format": "objectid::ThirdParty", "title": "Customer", "description": "Customer\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `customer`", "x-splash-type": "objectid::ThirdParty", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "customer", "example": "291::ThirdParty" }, "reference": { "type": "string", "title": "Reference", "description": "Reference\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `confirmationNumber`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "confirmationNumber" }, "_date_created": { "type": "string", "format": "date", "title": "Order date", "description": "Order date\n\n- **Microdata:** `http:\/\/schema.org\/Order` \u2192 `orderDate`", "x-splash-type": "date", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Order", "x-schema-org-itemprop": "orderDate", "example": "2026-09-24" }, "_datetime_created": { "type": "string", "format": "datetime", "title": "Creation DateTime", "description": "Creation DateTime\n\n- **Microdata:** `http:\/\/schema.org\/DataFeedItem` \u2192 `dateCreated`\n- `\ud83d\udccb In List`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "example": "2026-09-24 14:36:16" }, "_date_paid": { "type": "string", "format": "date", "title": "Date Paid", "description": "Date Paid\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `confirmationDate`\n- `\ud83d\udccb In List`", "x-splash-type": "date", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "confirmationDate", "example": "2026-09-24" }, "blogname": { "type": "string", "title": "Blog Name", "description": "Blog Name\n\n- **Microdata:** `http:\/\/schema.org\/Author` \u2192 `alternateName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Author", "x-schema-org-itemprop": "alternateName" }, "total_ht": { "type": "number", "title": "Order total (Tax Excl.)", "description": "Order total (Tax Excl.)\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `totalPaymentDue`", "x-splash-type": "double", "format": "double", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "totalPaymentDue" }, "total": { "type": "number", "title": "Order total", "description": "Order total\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `totalPaymentDueTaxIncluded`\n- `\ud83d\udccb In List`", "x-splash-type": "double", "format": "double", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "totalPaymentDueTaxIncluded" }, "price_total": { "allOf": [ { "$ref": "#\/components\/schemas\/SplashPrice" } ], "title": "Order Total", "description": "Order Total\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `total`", "x-splash-type": "price", "format": "price", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "total", "example": { "base": 0, "ht": 9.81, "vat": 20, "tax": 1.96, "ttc": 11.77, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } }, "price_shipping": { "allOf": [ { "$ref": "#\/components\/schemas\/SplashPrice" } ], "title": "Order Shipping", "description": "Order Shipping\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `totalShipping`", "x-splash-type": "price", "format": "price", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "totalShipping", "example": { "base": 0, "ht": 45.17, "vat": 20, "tax": 9.03, "ttc": 54.2, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } }, "price_discount": { "allOf": [ { "$ref": "#\/components\/schemas\/SplashPrice" } ], "title": "Order Discounts", "description": "Order Discounts\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `totalDiscount`", "x-splash-type": "price", "format": "price", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "totalDiscount", "example": { "base": 0, "ht": 72.69, "vat": 20, "tax": 14.54, "ttc": 87.23, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } }, "status": { "type": "string", "title": "Order Status", "description": "Order Status\n\n- **Prefer Read** \u2014 field should only be read \u0026 exported to other servers\n- **Microdata:** `http:\/\/schema.org\/Order` \u2192 `orderStatus`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Order", "x-schema-org-itemprop": "orderStatus", "enum": [ "OrderDraft", "OrderPaymentDue", "OrderProcessing", "OrderDelivered", "OrderCanceled" ] }, "status_raw": { "type": "string", "title": "Raw Status", "description": "Raw Status", "x-splash-type": "varchar", "format": "varchar", "readOnly": true }, "invoice_status": { "type": "string", "title": "Status", "description": "Status\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `paymentStatus`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "paymentStatus" }, "isdraft": { "type": "boolean", "title": "Pending payment", "description": "Pending payment\n\n- **Microdata:** `http:\/\/schema.org\/OrderStatus` \u2192 `OrderDraft`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/OrderStatus", "x-schema-org-itemprop": "OrderDraft" }, "iscanceled": { "type": "boolean", "title": "Cancelled", "description": "Cancelled\n\n- **Microdata:** `http:\/\/schema.org\/OrderStatus` \u2192 `OrderCancelled`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/OrderStatus", "x-schema-org-itemprop": "OrderCancelled" }, "isvalidated": { "type": "boolean", "title": "Validated", "description": "Validated\n\n- **Microdata:** `http:\/\/schema.org\/OrderStatus` \u2192 `OrderValidated`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/OrderStatus", "x-schema-org-itemprop": "OrderValidated" }, "isProcessing": { "type": "boolean", "title": "Processing", "description": "Processing\n\n- **Microdata:** `http:\/\/schema.org\/OrderStatus` \u2192 `OrderProcessing`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/OrderStatus", "x-schema-org-itemprop": "OrderProcessing" }, "isclosed": { "type": "boolean", "title": "Completed", "description": "Completed\n\n- **Microdata:** `http:\/\/schema.org\/OrderStatus` \u2192 `OrderDelivered`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/OrderStatus", "x-schema-org-itemprop": "OrderDelivered" }, "ispaid": { "type": "boolean", "title": "Paid", "description": "Paid\n\n- **Microdata:** `http:\/\/schema.org\/PaymentStatusType` \u2192 `PaymentComplete`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PaymentStatusType", "x-schema-org-itemprop": "PaymentComplete" }, "logistic_address_id": { "type": "string", "format": "objectid::Address", "title": "Logistic address", "description": "Logistic address\n\n- **Microdata:** `http:\/\/schema.org\/Order` \u2192 `deliveryAddress`", "x-splash-type": "objectid::Address", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Order", "x-schema-org-itemprop": "deliveryAddress", "example": "889::Address" }, "invoicing_address_id": { "type": "string", "format": "objectid::Address", "title": "Invoicing address", "description": "Invoicing address\n\n- **Microdata:** `http:\/\/schema.org\/Order` \u2192 `invoicingAddress`", "x-splash-type": "objectid::Address", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Order", "x-schema-org-itemprop": "invoicingAddress", "example": "361::Address" }, "billing": { "type": "string", "title": "Billing Address", "description": "Billing Address", "x-splash-type": "varchar", "format": "varchar", "readOnly": true }, "shipping": { "type": "string", "title": "Shipping Address", "description": "Shipping Address", "x-splash-type": "varchar", "format": "varchar", "readOnly": true }, "shipping_company": { "type": "string", "title": "Company", "description": "Company\n\n- **Microdata:** `http:\/\/schema.org\/Organization` \u2192 `legalName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Organization", "x-schema-org-itemprop": "legalName" }, "formatted_shipping_full_name": { "type": "string", "title": "Contact Name", "description": "Contact Name\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `alternateName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "alternateName" }, "shipping_address_1": { "type": "string", "title": "Delivery", "description": "Delivery\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "streetAddress" }, "shipping_address_2": { "type": "string", "title": "Delivery (2)", "description": "Delivery (2)\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "postOfficeBoxNumber" }, "shipping_postcode": { "type": "string", "title": "Zip\/Postal Code", "description": "Zip\/Postal Code\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `postalCode`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "postalCode" }, "shipping_city": { "type": "string", "title": "City", "description": "City\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "addressLocality" }, "shipping_state": { "type": "string", "title": "State", "description": "State", "x-splash-type": "varchar", "format": "varchar", "readOnly": true }, "customer_note": { "type": "string", "title": "Other", "description": "Other: Remarks, Relay Point Code, more...\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `description`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "description" }, "shipping_country": { "type": "string", "format": "country", "title": "Country", "description": "Country\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `addressCountry`", "x-splash-type": "country", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "addressCountry" }, "shipping_phone": { "type": "string", "format": "phone", "title": "Home phone", "description": "Home phone\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `telephone`\n- `\ud83d\udd0e Indexed`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "telephone", "example": "+33612345678" }, "shipping_method_title": { "type": "string", "title": "Shipping Method", "description": "Shipping Method\n\n- **Microdata:** `http:\/\/schema.org\/ParcelDelivery` \u2192 `provider`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/ParcelDelivery", "x-schema-org-itemprop": "provider" }, "shipping_method_id": { "type": "string", "title": "Carrier Code", "description": "Carrier Code\n\n- **Microdata:** `http:\/\/schema.org\/ParcelDelivery` \u2192 `identifier`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/ParcelDelivery", "x-schema-org-itemprop": "identifier" }, "items": { "type": "array", "title": "Items", "x-splash-list": "items", "items": { "type": "object", "properties": { "name": { "type": "string", "title": "Item", "description": "Item\n\n- **Microdata:** `http:\/\/schema.org\/partOfInvoice` \u2192 `description`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/partOfInvoice", "x-schema-org-itemprop": "description" }, "product": { "type": "string", "format": "objectid::Product@list", "title": "Product", "description": "Product\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `productID`\n- `\ud83e\uddea No Tests`", "x-splash-type": "objectid::Product@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "productID", "example": "614::Product" }, "sku": { "type": "string", "title": "SKU", "description": "SKU\n\n- **Microdata:** `http:\/\/schema.org\/Product` \u2192 `sku`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Product", "x-schema-org-itemprop": "sku" }, "quantity": { "type": "integer", "title": "Quantity", "description": "Quantity\n\n- **Microdata:** `http:\/\/schema.org\/QuantitativeValue` \u2192 `value`", "x-splash-type": "int@list", "format": "int@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/QuantitativeValue", "x-schema-org-itemprop": "value" }, "discount": { "type": "number", "title": "Percentage discount", "description": "Percentage discount\n\n- **Microdata:** `http:\/\/schema.org\/Order` \u2192 `discount`", "x-splash-type": "double@list", "format": "double@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Order", "x-schema-org-itemprop": "discount" }, "subtotal": { "allOf": [ { "$ref": "#\/components\/schemas\/SplashPrice" } ], "title": "Price", "description": "Price\n\n- **Microdata:** `http:\/\/schema.org\/PriceSpecification` \u2192 `price`", "x-splash-type": "price@list", "format": "price@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PriceSpecification", "x-schema-org-itemprop": "price", "example": { "base": 0, "ht": 73.66, "vat": 20, "tax": 14.73, "ttc": 88.39, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } }, "tax_name": { "type": "string", "title": "Tax name", "description": "Tax name\n\n- **Microdata:** `http:\/\/schema.org\/PriceSpecification` \u2192 `valueAddedTaxName`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PriceSpecification", "x-schema-org-itemprop": "valueAddedTaxName" }, "type": { "type": "string", "title": "Type", "description": "Line Item Type: product, shipping, fee, ...\n\n- **Microdata:** `https:\/\/schema.org\/OrderItem` \u2192 `additionalType`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "https:\/\/schema.org\/OrderItem", "x-schema-org-itemprop": "additionalType", "enum": [ "product", "shipping", "fee", "option", "comment" ] }, "options": { "type": "string", "title": "Options", "description": "Line details, from WooCommerce order item meta data\n\n- **Microdata:** `http:\/\/schema.org\/partOfInvoice` \u2192 `options`", "x-splash-type": "inline@list", "format": "inline@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/partOfInvoice", "x-schema-org-itemprop": "options" } } } }, "payments": { "type": "array", "title": "Payments", "x-splash-list": "payments", "items": { "type": "object", "properties": { "_payment_method": { "type": "string", "title": "Method", "description": "Method\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `PaymentMethod`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "PaymentMethod" }, "_date_paid": { "type": "string", "format": "date@list", "title": "Date", "description": "Date\n\n- **Microdata:** `http:\/\/schema.org\/PaymentChargeSpecification` \u2192 `validFrom`", "x-splash-type": "date@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PaymentChargeSpecification", "x-schema-org-itemprop": "validFrom", "example": "2026-09-24" }, "_transaction_id": { "type": "string", "title": "Transaction ID", "description": "Transaction ID\n\n- **Microdata:** `http:\/\/schema.org\/Invoice` \u2192 `paymentMethodId`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Invoice", "x-schema-org-itemprop": "paymentMethodId" }, "_total_tax": { "type": "number", "title": "Total", "description": "Total\n\n- **Microdata:** `http:\/\/schema.org\/PaymentChargeSpecification` \u2192 `price`", "x-splash-type": "double@list", "format": "double@list", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PaymentChargeSpecification", "x-schema-org-itemprop": "price" } } } } }, "required": [ "_customer_id", "_date_created" ] }, "InvoiceListItem": { "type": "object", "title": "Invoice (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "reference": { "type": "string", "title": "Reference" }, "_datetime_created": { "type": "string", "format": "date-time", "title": "Creation DateTime" }, "_date_paid": { "type": "string", "format": "date", "title": "Date Paid" }, "total": { "type": "number", "title": "Order total" }, "status": { "type": "string", "title": "Order Status" }, "invoice_status": { "type": "string", "title": "Status" } } }, "Address": { "type": "object", "title": "Customer Address", "description": "Wordpress Customer Address Object", "x-splash-type": "Address", "properties": { "user": { "type": "string", "format": "objectid::ThirdParty", "title": "Customer", "description": "Customer\n\n- **Microdata:** `http:\/\/schema.org\/Organization` \u2192 `ID`", "x-splash-type": "objectid::ThirdParty", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/Organization", "x-schema-org-itemprop": "ID", "example": "496::ThirdParty" }, "alias": { "type": "string", "title": "Alias", "description": "Alias\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `name`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "name" }, "fullname": { "type": "string", "title": "Contact Name", "description": "First Name + Last Name\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `alternateName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "alternateName" }, "address_full": { "type": "string", "title": "Address line 1 \u0026 2", "description": "Address line 1 \u0026 2", "x-splash-type": "varchar", "format": "varchar", "readOnly": true }, "company": { "type": "string", "title": "Company", "description": "Company\n\n- **Microdata:** `http:\/\/schema.org\/Organization` \u2192 `legalName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Organization", "x-schema-org-itemprop": "legalName" }, "first_name": { "type": "string", "title": "First Name", "description": "First Name\n\n- **Microdata:** `http:\/\/schema.org\/Person` \u2192 `familyName`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Person", "x-schema-org-itemprop": "familyName" }, "last_name": { "type": "string", "title": "Last Name", "description": "Last Name\n\n- **Microdata:** `http:\/\/schema.org\/Person` \u2192 `givenName`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/Person", "x-schema-org-itemprop": "givenName" }, "address_1": { "type": "string", "title": "Address line 1", "description": "Address line 1\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `streetAddress`\n- `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "streetAddress" }, "address_2": { "type": "string", "title": "Address line 2", "description": "Address line 2\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `postOfficeBoxNumber`\n- `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "postOfficeBoxNumber" }, "postcode": { "type": "string", "title": "Postcode \/ ZIP", "description": "Postcode \/ ZIP\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `postalCode`\n- `\ud83d\udccb In List` `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "postalCode" }, "city": { "type": "string", "title": "City", "description": "City\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `addressLocality`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "addressLocality" }, "country": { "type": "string", "format": "country", "title": "Country", "description": "Country\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `addressCountry`\n- `\ud83d\udcdc Logged`", "x-splash-type": "country", "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "addressCountry" }, "country_name": { "type": "string", "title": "Country Name", "description": "Country Name\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `addressCountryName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "addressCountryName" }, "state": { "type": "string", "format": "state", "title": "State \/ County", "description": "State \/ County\n\n- **Microdata:** `http:\/\/schema.org\/PostalAddress` \u2192 `addressRegion`\n- `\ud83e\uddea No Tests`", "x-splash-type": "state", "x-schema-org-itemtype": "http:\/\/schema.org\/PostalAddress", "x-schema-org-itemprop": "addressRegion" }, "phone": { "type": "string", "format": "phone", "title": "Phone", "description": "Phone\n\n- **Microdata:** `http:\/\/schema.org\/Person` \u2192 `telephone`\n- `\ud83d\udccb In List` `\ud83d\udcdc Logged`", "x-splash-type": "phone", "x-schema-org-itemtype": "http:\/\/schema.org\/Person", "x-schema-org-itemprop": "telephone", "example": "+33612345678" }, "email": { "type": "string", "format": "email", "title": "Email address", "description": "Email address\n\n- **Microdata:** `http:\/\/schema.org\/ContactPoint` \u2192 `email`\n- `\ud83d\udccb In List` `\ud83d\udcdc Logged`", "x-splash-type": "email", "x-schema-org-itemtype": "http:\/\/schema.org\/ContactPoint", "x-schema-org-itemprop": "email" } } }, "AddressListItem": { "type": "object", "title": "Customer Address (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "first_name": { "type": "string", "title": "First Name" }, "last_name": { "type": "string", "title": "Last Name" }, "postcode": { "type": "string", "title": "Postcode \/ ZIP" }, "city": { "type": "string", "title": "City" }, "phone": { "type": "string", "format": "phone", "title": "Phone" }, "email": { "type": "string", "format": "email", "title": "Email address" } } } } } }