# SureDone API v3 - **OpenAPI Version:** `3.1.0` - **API Version:** `3.0.0` This guide provides list of REST API and sample code in several languages. The API Username and Token may be found at ## Throttling (released 2022-12-09) Every request is throttled with the following basic schema: - `read` 300 requests per minute for `GET`, `TRACE`, `CONNECT` and related calls - `write` 60 requests per minute for `POST`, `PATCH`, `PUT` and `DELETE` calls - `options` 300 requests per minute for `OPTIONS` (for apps and ui integrations) The below headers are returned with every request along with a status code of `429` when throttling has been activated. - `X-Rate-Limit-Limit` (ie `300`) - `X-Rate-Limit-Remaining` (`295`) - `X-Rate-Limit-Reset` (ie `1666020201`) - `X-Rate-Limit-Type` (ie `read`) ## Servers - **URL:** `https://api.suredone.com` - **Description:** Production API ## Operations ### Delete Account - **Method:** `DELETE` - **Path:** `/v3/account` - **Tags:** Account Schedules the authenticated account for permanent deletion. The account is deactivated immediately and all data will be permanently deleted within 30 days. Only the account owner can request account deletion. #### Responses ##### Status: 200 Already scheduled (idempotent). ###### Content-Type: application/json - **`deletionScheduled`** `boolean` - **`estimatedCompletion`** `string` - **`message`** `string` - **`result`** `string` **Example:** ```json { "deletionScheduled": true, "estimatedCompletion": "30 days", "message": "Account deletion has already been scheduled. Your account has been deactivated.", "result": "success" } ``` ##### Status: 403 Sub-user attempted account deletion. ###### Content-Type: application/json - **`message`** `string` - **`result`** `string` **Example:** ```json { "message": "Only the account owner can request account deletion", "result": "error" } ``` ##### Status: 405 Delete Account — 405 error response. (Method not allowed — only DELETE is accepted on this path.) ###### Content-Type: application/json - **`message`** `string` - **`result`** `string` **Example:** ```json { "message": "Method not allowed. Valid methods: DELETE", "result": "error" } ``` ##### Status: 500 Internal error during account disable flow. ###### Content-Type: application/json - **`message`** `string` - **`result`** `string` **Example:** ```json { "message": "An unexpected error occurred. Please try again later.", "result": "error" } ``` ### Delete Sub-User - **Method:** `DELETE` - **Path:** `/v3/account/users/{uaid}` - **Tags:** Account Permanently deletes a sub-user from the account. Removes the user and cleans up all cached auth tokens and sessions. Requires account owner access or a sub-user with the Change Permissions scope (`organization:permissions:write` or `platform:allOrganizations:permissions:write`). For scope-based authorization, the `X-Auth-Jwt` header must contain a valid identity token. #### Parameters ##### `uaid` required - **In:** `path` The sub-user's UAID (from `sd_users_accts`). Must be a positive integer. `number` ##### `X-Auth-Account` - **In:** `header` e.g. 0 `string` ##### `X-Auth-Jwt` - **In:** `header` e.g. {id-token} `string` #### Responses ##### Status: 200 Delete Sub-User — completed. ###### Content-Type: application/json - **`message`** `string` - **`result`** `string` **Example:** ```json { "message": "User deleted successfully", "result": "success" } ``` ##### Status: 400 Targeting the account owner. ###### Content-Type: application/json - **`message`** `string` - **`result`** `string` **Example:** ```json { "message": "The account owner cannot be deleted", "result": "error" } ``` ##### Status: 403 Caller lacks required permissions. ###### Content-Type: application/json - **`message`** `string` - **`result`** `string` **Example:** ```json { "message": "Only the account owner or users with Change Permissions can delete users", "result": "error" } ``` ##### Status: 404 Sub-user not found in this account. ###### Content-Type: application/json - **`message`** `string` - **`result`** `string` **Example:** ```json { "message": "User not found", "result": "error" } ``` ##### Status: 405 Delete Sub-User — 405 error response. (Method not allowed — only DELETE is accepted on this path.) ###### Content-Type: application/json - **`message`** `string` - **`result`** `string` **Example:** ```json { "message": "Method not allowed. Valid methods: DELETE", "result": "error" } ``` ##### Status: 500 Unexpected error during deletion. ###### Content-Type: application/json - **`message`** `string` - **`result`** `string` **Example:** ```json { "message": "An unexpected error occurred during user deletion", "result": "error" } ``` ### List Custom Automations - **Method:** `GET` - **Path:** `/v3/automations/custom` - **Tags:** Automation Requests Returns a paginated list of custom automations for the authenticated user. #### Parameters ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `listCustomAutomations`. `string` #### Responses ##### Status: 200 List Custom Automations — results returned. ###### Content-Type: application/json - **`automations`** `array` **Items:** - **`action`** `string` - **`active`** `boolean` — Whether the automation is enabled and eligible to run on its schedule. - **`config`** `object` - **`connection`** `object` - **`address`** `string` - **`password`** `string` - **`path`** `string` - **`port`** `number` - **`type`** `string` - **`username`** `string` - **`file_configs`** `array` **Items:** - **`field_map`** `object` - **`price`** `string` - **`stock`** `string` - **`title`** `string` - **`upc`** `string` - **`name`** `string` - **`search`** `string` - **`connection`** `string` - **`created`** `string` - **`id`** `string` - **`last_modified`** `string` - **`metadata`** `object | null` - **`name`** `string` - **`schedule`** `string` - **`shared`** `boolean` — Whether the automation is published to the SureDone marketplace and available for other accounts to install. - **`shared_id`** `string | null` - **`slug`** `string` - **`type`** `string` - **`user_id`** `string` - **`vendor`** `string` - **`count`** `string` - **`timestamp`** `string` **Example:** ```json { "automations": [ { "action": "export", "active": false, "config": { "connection": { "address": "sftp.suredone.com", "password": "***", "path": "/ftp/test/", "port": 22, "type": "sftp", "username": "wholesalep" }, "file_configs": [ { "field_map": { "price": "price", "stock": "quantity", "title": "product title", "upc": "upc" }, "name": "stock-upc-export.csv", "search": "upc:-= upc:-Apply" } ] }, "connection": "sftp", "created": "2018-06-19 14:18:07", "id": "148", "last_modified": "2018-06-19 14:56:31", "metadata": null, "name": "Demo Stock UPC Export", "schedule": "0 3,15 * * *", "shared": false, "shared_id": "0", "slug": "demo-demo-stock-upc-export", "type": "products", "user_id": "1019", "vendor": "demo" } ], "count": "1", "timestamp": "2018-06-19T14:59:25Z" } ``` ##### Status: 400 Request rejected by the strict-params middleware (an unknown query parameter was supplied). Returned by every v3 listing endpoint. ###### Content-Type: application/json - **`results` (required)** `object` - **`failed` (required)** `object` — Map of failure index (as a string key, starting at "0") to failure details. At least one entry is present. **Example:** ```json { "results": { "failed": { "additionalProperty": { "message": "Invalid Params: foo | Valid Params: debug, diff, user_id, page, internal, showFilters, sort, sortorder, notify, email, type, disableCache", "code": 1 } } } } ``` ### Create Custom Automation - **Method:** `POST` - **Path:** `/v3/automations/custom` - **Tags:** Automation Requests Create a new custom automation. Requires a full automation configuration including connection and file\_configs. #### Parameters ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `createCustomAutomation`. `string` #### Request Body ##### Content-Type: application/json - **`action`** `string` - **`active`** `number` - **`connection`** `object` - **`address`** `string` - **`password`** `string` - **`path`** `string` - **`port`** `number` - **`type`** `string` - **`username`** `string` - **`file_configs`** `array` **Items:** - **`field_map`** `object` - **`price`** `string` - **`stock`** `string` - **`title`** `string` - **`upc`** `string` - **`name`** `string` - **`search`** `string` - **`name`** `string` - **`schedule`** `string` - **`type`** `string` - **`vendor`** `string` **Example:** ```json { "action": "export", "active": 1, "connection": { "address": "sftp.suredone.com", "password": "PASSWORD", "path": "/ftp/test/", "port": 22, "type": "sftp", "username": "wholesalep" }, "file_configs": [ { "field_map": { "price": "price", "stock": "quantity", "title": "product title", "upc": "upc" }, "name": "stock-upc-export.csv", "search": "upc:-= upc:-Apply" } ], "name": "Demo Stock UPC Export", "schedule": "0 3,15 * * *", "type": "products", "vendor": "demo" } ``` #### Responses ##### Status: 200 Create Custom Automation — completed. ###### Content-Type: application/json - **`id`** `number` - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "id": 148, "results": { "successful": [ { "code": 1, "message": "Automation created successfully!" } ] } } ``` ### Delete Custom Automation - **Method:** `DELETE` - **Path:** `/v3/automations/custom/{id}` - **Tags:** Automation Requests Delete a custom automation. #### Parameters ##### `id` required - **In:** `path` The automation ID — required by `deleteCustomAutomation`. `number` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `deleteCustomAutomation`. `string` #### Responses ##### Status: 200 Delete Custom Automation — completed. ###### Content-Type: application/json - **`id`** `string` - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "id": "148", "results": { "successful": [ { "code": 3, "message": "Automation deleted successfully" } ] } } ``` ### Get Custom Automation - **Method:** `GET` - **Path:** `/v3/automations/custom/{id}` - **Tags:** Automation Requests Returns a single custom automation by ID, including its current run status. #### Parameters ##### `id` required - **In:** `path` The automation ID — required by `getCustomAutomation`. `number` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `getCustomAutomation`. `string` #### Responses ##### Status: 200 Get Custom Automation — results returned. ###### Content-Type: application/json - **`automation`** `object` - **`action`** `string` - **`active`** `boolean` — Whether this single custom automation is currently enabled. - **`connection`** `string` - **`file_configs`** `array` **Items:** - **`field_map`** `object` - **`price`** `string` - **`stock`** `string` - **`title`** `string` - **`upc`** `string` - **`name`** `string` - **`search`** `string` - **`id`** `string` - **`name`** `string` - **`schedule`** `string` - **`slug`** `string` - **`type`** `string` - **`user_id`** `string` - **`vendor`** `string` - **`status`** `object` - **`debug_files`** `array` **Items:** `string` - **`last_run_finish_debug`** `boolean` - **`last_run_finish_prod`** `boolean` - **`last_run_id`** `string | null` - **`last_run_start_debug`** `boolean` - **`last_run_start_prod`** `boolean` - **`last_run_success_debug`** `boolean | null` - **`last_run_success_prod`** `boolean | null` - **`timestamp`** `string` **Example:** ```json { "automation": { "action": "export", "active": false, "connection": "sftp", "file_configs": [ { "field_map": { "price": "price", "stock": "quantity", "title": "product title", "upc": "upc" }, "name": "stock-upc-export.csv", "search": "upc:-= upc:-Apply" } ], "id": "148", "name": "Demo Stock UPC Export", "schedule": "0 3,15 * * *", "slug": "demo-demo-stock-upc-export", "type": "products", "user_id": "1019", "vendor": "demo" }, "status": { "debug_files": [], "last_run_finish_debug": false, "last_run_finish_prod": false, "last_run_id": null, "last_run_start_debug": false, "last_run_start_prod": false, "last_run_success_debug": null, "last_run_success_prod": null }, "timestamp": "2018-06-19T14:59:25Z" } ``` ### Update Custom Automation - **Method:** `PATCH` - **Path:** `/v3/automations/custom/{id}` - **Tags:** Automation Requests Update an existing custom automation. Only the fields provided in the request body will be updated. #### Parameters ##### `id` required - **In:** `path` The automation ID — required by `updateCustomAutomation`. `number` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `updateCustomAutomation`. `string` #### Request Body ##### Content-Type: application/json - **`file_configs`** `array` **Items:** - **`diff_fields`** `array` **Items:** `string` - **`diff_update`** `number` - **`field_map`** `object` - **`stock`** `string` - **`field_run`** `object` - **`upc`** `string` - **`identifier`** `string` - **`name`** `string` - **`update`** `string` **Example:** ```json { "file_configs": [ { "diff_fields": [ "stock" ], "diff_update": 1, "field_map": { "stock": "quantity" }, "field_run": { "upc": "upc" }, "identifier": "upc", "name": "stock-upc-export.csv", "update": "edit" } ] } ``` #### Responses ##### Status: 200 Update Custom Automation — completed. ###### Content-Type: application/json - **`id`** `string` - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "id": "148", "results": { "successful": [ { "code": 2, "message": "Automation updated successfully!" } ] } } ``` ### Update Custom Automation Parameter - **Method:** `PUT` - **Path:** `/v3/automations/custom/{id}/parameters/{name}` - **Tags:** Automation Requests Update a single parameter on a custom automation. The parameter name is specified in the URL path, and the request body contains the parameter properties to update. #### Parameters ##### `id` required - **In:** `path` The automation ID — required by `updateCustomAutomationParameter`. `number` ##### `name` required - **In:** `path` The parameter name (key in the automation parameters map). (Endpoint: `updateCustomAutomationParameter`.) `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `updateCustomAutomationParameter`. `string` #### Request Body ##### Content-Type: application/json - **`encrypted`** `boolean` - **`value`** `string | null` **Example:** ```json { "encrypted": true, "value": "new-api-key-value" } ``` #### Responses ##### Status: 200 Update Custom Automation Parameter — completed. ###### Content-Type: application/json - **`id`** `string` - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "id": "148", "results": { "successful": [ { "code": 2, "message": "Automation parameters updated successfully!" } ] } } ``` ### Run Custom Automation - **Method:** `GET` - **Path:** `/v3/automations/custom/{id}/run` - **Tags:** Automation Requests Queue a custom automation for execution. Submit `debug=true` for a test run. For live runs omit the `debug` argument or set it to `false`. Use the `diff` argument to control full or diff execution mode. Submit `notify=true` and `email` with a valid email address to receive notification when the run completes. #### Parameters ##### `id` required - **In:** `path` The automation ID — required by `runCustomAutomation`. `number` ##### `debug` - **In:** `query` Run the automation in debug (dry-run) mode without persisting side effects. (Endpoint: `runCustomAutomation`.) `boolean` ##### `diff` - **In:** `query` Limit to fields whose values changed since the previous run (true) versus running the full export (false). (Endpoint: `runCustomAutomation`.) `boolean` ##### `notify` - **In:** `query` Send a completion notification when the run finishes. (Endpoint: `runCustomAutomation`.) `boolean` ##### `email` - **In:** `query` Email address to deliver the completion notification to. (Endpoint: `runCustomAutomation`.) `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `runCustomAutomation`. `string` #### Responses ##### Status: 200 Run Custom Automation — results returned. ###### Content-Type: application/json - **`id`** `string` - **`message`** `string` - **`result`** `string` **Example:** ```json { "id": "148", "message": "Automation running, please check logs for progress and /private/files/automation/debug for result", "result": "success" } ``` ### Reset Custom Automation Status - **Method:** `DELETE` - **Path:** `/v3/automations/custom/{id}/status` - **Tags:** Automation Requests Reset the run status for a custom automation. The `type` query parameter is required and must be either `debug` or `prod`. #### Parameters ##### `id` required - **In:** `path` The automation ID — required by `resetCustomAutomationStatus`. `number` ##### `type` required - **In:** `query` Status flavour to reset for the custom automation — one of `debug` (clears the last debug-run state) or `prod` (clears the last production-run state). `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `resetCustomAutomationStatus`. `string` #### Responses ##### Status: 200 Reset Custom Automation Status — completed. ###### Content-Type: application/json - **`id`** `string` - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "id": "148", "results": { "successful": [ { "code": 3, "message": "Automation debug status reset successfully" } ] } } ``` ### List Installed Automations - **Method:** `GET` - **Path:** `/v3/automations/installed` - **Tags:** Automation Requests Returns a paginated list of installed (shared) automations for the authenticated user. #### Parameters ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `listInstalledAutomations`. `string` #### Responses ##### Status: 200 List Installed Automations — results returned. ###### Content-Type: application/json - **`automations`** `array` **Items:** - **`action`** `string` - **`active`** `boolean` — Whether the installed automation is enabled and eligible to run on its schedule. - **`created`** `string` - **`id`** `string` - **`last_modified`** `string` - **`name`** `string` - **`parameters`** `array` **Items:** - **`description` (required)** `string` - **`encrypted` (required)** `number` - **`name` (required)** `string` - **`value` (required)** `string | null` - **`schedule`** `string` - **`shared_id`** `string | null` - **`slug`** `string` - **`type`** `string` - **`user_id`** `string` - **`vendor`** `string` - **`count`** `string` - **`timestamp`** `string` **Example:** ```json { "automations": [ { "parameters": [ { "description": "Turn14 API Client ID", "encrypted": 1, "name": "turn14 id", "value": "***" }, { "description": "Turn14 API Client Secret", "encrypted": 1, "name": "turn14 secret", "value": "***" } ], "action": "import", "active": true, "created": "2019-11-02 00:10:00", "id": "649", "last_modified": "2019-11-02 00:10:00", "name": "SKU ID Import", "schedule": "0 0 * * *", "shared_id": "658", "slug": "turn14-sku-id-import", "type": "products", "user_id": "1019", "vendor": "Turn14" } ], "count": "1", "timestamp": "2019-11-02T00:15:00Z" } ``` ##### Status: 400 Request rejected by the strict-params middleware (an unknown query parameter was supplied). Returned by every v3 listing endpoint. ###### Content-Type: application/json - **`results` (required)** `object` - **`failed` (required)** `object` — Map of failure index (as a string key, starting at "0") to failure details. At least one entry is present. **Example:** ```json { "results": { "failed": { "additionalProperty": { "message": "Invalid Params: foo | Valid Params: debug, diff, user_id, page, internal, showFilters, sort, sortorder, notify, email, type, disableCache", "code": 1 } } } } ``` ### Install Shared Automation - **Method:** `POST` - **Path:** `/v3/automations/installed` - **Tags:** Automation Requests Install a shared automation from the published marketplace. Requires the `shared_id` of the published automation. #### Parameters ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `installSharedAutomation`. `string` #### Request Body ##### Content-Type: application/json - **`active`** `boolean` - **`parameters`** `array` **Items:** - **`encrypted` (required)** `boolean` - **`name` (required)** `string` - **`value` (required)** `string | null` - **`shared_id`** `number` **Example:** ```json { "parameters": [ { "encrypted": true, "name": "turn14 id", "value": "your-client-id" }, { "encrypted": true, "name": "turn14 secret", "value": "your-client-secret" } ], "active": true, "shared_id": 658 } ``` #### Responses ##### Status: 200 Install Shared Automation — completed. ###### Content-Type: application/json - **`id`** `number` - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "id": 649, "results": { "successful": [ { "code": 1, "message": "Automation created successfully!" } ] } } ``` ### Delete Installed Automation - **Method:** `DELETE` - **Path:** `/v3/automations/installed/{id}` - **Tags:** Automation Requests Delete an installed automation. #### Parameters ##### `id` required - **In:** `path` The installed automation ID — required by `deleteInstalledAutomation`. `number` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `deleteInstalledAutomation`. `string` #### Responses ##### Status: 200 Delete Installed Automation — completed. ###### Content-Type: application/json - **`id`** `string` - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "id": "649", "results": { "successful": [ { "code": 3, "message": "Automation deleted successfully" } ] } } ``` ### Get Installed Automation - **Method:** `GET` - **Path:** `/v3/automations/installed/{id}` - **Tags:** Automation Requests Returns a single installed automation by ID, including its current run status. #### Parameters ##### `id` required - **In:** `path` The installed automation ID — required by `getInstalledAutomation`. `number` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `getInstalledAutomation`. `string` #### Responses ##### Status: 200 Get Installed Automation — results returned. ###### Content-Type: application/json - **`automation`** `object` - **`action`** `string` - **`active`** `boolean` — Whether this single installed automation is currently enabled. - **`id`** `string` - **`name`** `string` - **`parameters`** `array` **Items:** - **`description` (required)** `string` - **`encrypted` (required)** `number` - **`name` (required)** `string` - **`value` (required)** `string | null` - **`schedule`** `string` - **`shared_id`** `string | null` - **`slug`** `string` - **`type`** `string` - **`user_id`** `string` - **`vendor`** `string` - **`status`** `object` - **`debug_files`** `array` **Items:** `string` - **`last_run_finish_debug`** `boolean` - **`last_run_finish_prod`** `string` - **`last_run_id`** `string | null` - **`last_run_start_debug`** `boolean` - **`last_run_start_prod`** `string` - **`last_run_success_debug`** `boolean | null` - **`last_run_success_prod`** `boolean | null` - **`timestamp`** `string` **Example:** ```json { "automation": { "parameters": [ { "description": "Turn14 API Client ID", "encrypted": 1, "name": "turn14 id", "value": "***" }, { "description": "Turn14 API Client Secret", "encrypted": 1, "name": "turn14 secret", "value": "***" } ], "action": "import", "active": true, "id": "649", "name": "SKU ID Import", "schedule": "0 0 * * *", "shared_id": "658", "slug": "turn14-sku-id-import", "type": "products", "user_id": "1019", "vendor": "Turn14" }, "status": { "debug_files": [], "last_run_finish_debug": false, "last_run_finish_prod": "2019-11-01T00:02:30Z", "last_run_id": null, "last_run_start_debug": false, "last_run_start_prod": "2019-11-01T00:00:05Z", "last_run_success_debug": null, "last_run_success_prod": true }, "timestamp": "2019-11-02T00:15:00Z" } ``` ### Update Installed Automation - **Method:** `PATCH` - **Path:** `/v3/automations/installed/{id}` - **Tags:** Automation Requests Update an installed automation. Typically used to change the `active` state or update `parameters`. #### Parameters ##### `id` required - **In:** `path` The installed automation ID — required by `updateInstalledAutomation`. `number` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `updateInstalledAutomation`. `string` #### Request Body ##### Content-Type: application/json - **`active`** `boolean` - **`parameters`** `array` **Items:** - **`encrypted`** `boolean` - **`name`** `string` - **`value`** `string | null` **Example:** ```json { "parameters": [ { "encrypted": true, "name": "turn14 id", "value": "updated-client-id" } ], "active": true } ``` #### Responses ##### Status: 200 Update Installed Automation — completed. ###### Content-Type: application/json - **`id`** `string` - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "id": "649", "results": { "successful": [ { "code": 2, "message": "Automation parameters updated successfully!" } ] } } ``` ### Update Installed Automation Parameter - **Method:** `PUT` - **Path:** `/v3/automations/installed/{id}/parameters/{name}` - **Tags:** Automation Requests Update a single parameter on an installed automation. The parameter name is specified in the URL path, and the request body contains the parameter properties to update. #### Parameters ##### `id` required - **In:** `path` The installed automation ID — required by `updateInstalledAutomationParameter`. `number` ##### `name` required - **In:** `path` The parameter name (key in the automation parameters map). (Endpoint: `updateInstalledAutomationParameter`.) `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `updateInstalledAutomationParameter`. `string` #### Request Body ##### Content-Type: application/json - **`encrypted`** `boolean` - **`value`** `string | null` **Example:** ```json { "encrypted": true, "value": "updated-client-id" } ``` #### Responses ##### Status: 200 Update Installed Automation Parameter — completed. ###### Content-Type: application/json - **`id`** `string` - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "id": "649", "results": { "successful": [ { "code": 2, "message": "Automation parameters updated successfully!" } ] } } ``` ### Run Installed Automation - **Method:** `GET` - **Path:** `/v3/automations/installed/{id}/run` - **Tags:** Automation Requests Queue an installed automation for execution. Submit `debug=true` for a test run. For live runs omit the `debug` argument or set it to `false`. Use the `diff` argument to control full or diff execution mode. #### Parameters ##### `id` required - **In:** `path` The installed automation ID — required by `runInstalledAutomation`. `number` ##### `debug` - **In:** `query` Run the automation in debug (dry-run) mode without persisting side effects. (Endpoint: `runInstalledAutomation`.) `boolean` ##### `diff` - **In:** `query` Limit to fields whose values changed since the previous run (true) versus running the full export (false). (Endpoint: `runInstalledAutomation`.) `boolean` ##### `notify` - **In:** `query` Send a completion notification when the run finishes. (Endpoint: `runInstalledAutomation`.) `boolean` ##### `email` - **In:** `query` Email address to deliver the completion notification to. (Endpoint: `runInstalledAutomation`.) `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `runInstalledAutomation`. `string` #### Responses ##### Status: 200 Run Installed Automation — results returned. ###### Content-Type: application/json - **`id`** `string` - **`message`** `string` - **`result`** `string` **Example:** ```json { "id": "649", "message": "Automation running, please check logs for progress and /private/files/automation/debug for result", "result": "success" } ``` ### Reset Installed Automation Status - **Method:** `DELETE` - **Path:** `/v3/automations/installed/{id}/status` - **Tags:** Automation Requests Reset the run status for an installed automation. The `type` query parameter is required and must be either `debug` or `prod`. #### Parameters ##### `id` required - **In:** `path` The installed automation ID — required by `resetInstalledAutomationStatus`. `number` ##### `type` required - **In:** `query` Status flavour to reset for the installed (shared) automation — one of `debug` (clears the last debug-run state) or `prod` (clears the last production-run state). `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `resetInstalledAutomationStatus`. `string` #### Responses ##### Status: 200 Reset Installed Automation Status — completed. ###### Content-Type: application/json - **`id`** `string` - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "id": "649", "results": { "successful": [ { "code": 3, "message": "Automation prod status reset successfully" } ] } } ``` ### List Published Automations - **Method:** `GET` - **Path:** `/v3/automations/published` - **Tags:** Automation Requests Returns a list of all published (shared) automations available for installation from the SureDone marketplace. #### Parameters ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `listPublishedAutomations`. `string` #### Responses ##### Status: 200 List Published Automations — results returned. ###### Content-Type: application/json - **`automations`** `array` **Items:** - **`action`** `string` - **`active`** `boolean` — Whether the published automation is enabled by default when installed. - **`connection`** `object` - **`address`** `string` - **`headers`** `object` - **`Content-Type`** `string` - **`method`** `string` - **`oauth`** `object` - **`address`** `string` - **`client_id`** `string` - **`client_secret`** `string` - **`grant_type`** `string` - **`method`** `string` - **`paginate`** `number` - **`type`** `string` - **`validate`** `boolean` - **`description`** `string` - **`file_configs`** `array` **Items:** - **`field_map`** `object` - **`turn14id`** `string` - **`turn14sku`** `string` - **`field_run`** `object` - **`upc`** `string` - **`identifier`** `string` - **`jsonpath`** `number` - **`search`** `string` - **`skip_all`** `number` - **`update`** `string` - **`id`** `string` - **`logo`** `string` - **`name`** `string` - **`parameters`** `object` - **`turn14 id`** `object` - **`description`** `string` - **`encrypted`** `number` - **`hidden_from_user`** `number` - **`value`** `string | null` - **`turn14 secret`** `object` - **`description`** `string` - **`encrypted`** `number` - **`hidden_from_user`** `number` - **`value`** `string | null` - **`readme`** `string` - **`schedule`** `string` - **`shared`** `boolean` — Whether this published automation is publicly available in the SureDone marketplace. - **`shared_id`** `string | null` - **`slug`** `string` - **`type`** `string` - **`user_id`** `string` - **`vendor`** `string` - **`count`** `string` - **`timestamp`** `string` **Example:** ```json { "automations": [ { "parameters": { "turn14 id": { "description": "Turn14 API Client ID", "encrypted": 1, "hidden_from_user": 0, "value": null }, "turn14 secret": { "description": "Turn14 API Client Secret", "encrypted": 1, "hidden_from_user": 0, "value": null } }, "action": "import", "active": false, "connection": { "address": "https://api.turn14.com/v1/items?page=1", "headers": { "Content-Type": "application/json" }, "method": "GET", "oauth": { "address": "https://api.turn14.com/v1/token", "client_id": "{{turn14 id}}", "client_secret": "{{turn14 secret}}", "grant_type": "client_credentials", "method": "POST" }, "paginate": 1, "type": "http", "validate": false }, "description": "", "file_configs": [ { "field_map": { "turn14id": "$.data.*.id", "turn14sku": "$.data.*.attributes.part_number" }, "field_run": { "upc": "$.data.*.attributes.barcode" }, "identifier": "upc", "jsonpath": 1, "search": "turn14id:= upc:-=", "skip_all": 1, "update": "edit" } ], "id": "658", "logo": "https://assets.suredone.com/logos/automation/vendors/turn14-logo.png", "name": "SKU ID Import", "readme": "", "schedule": "0 0 * * *", "shared": true, "shared_id": null, "slug": "turn14-sku-id-import", "type": "products", "user_id": "000000", "vendor": "Turn14" } ], "count": "1", "timestamp": "2019-11-02T00:05:46Z" } ``` ##### Status: 400 Request rejected by the strict-params middleware (an unknown query parameter was supplied). Returned by every v3 listing endpoint. ###### Content-Type: application/json - **`results` (required)** `object` - **`failed` (required)** `object` — Map of failure index (as a string key, starting at "0") to failure details. At least one entry is present. **Example:** ```json { "results": { "failed": { "additionalProperty": { "message": "Invalid Params: foo | Valid Params: debug, diff, user_id, page, internal, showFilters, sort, sortorder, notify, email, type, disableCache", "code": 1 } } } } ``` ### Logging API Request - **Method:** `POST` - **Path:** `/v3/logs` - **Tags:** Logging Requests Search the SureDone application log index. Filters include severity, request id, user id, and time range; results are paginated. #### Parameters ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `loggingApiRequest`. `string` #### Responses ##### Status: 200 Logging API Request — completed. ###### Content-Type: application/json - **`results`** `object` - **`found`** `number` - **`logs`** `array` **Items:** - **`action` (required)** `string` - **`channel_id` (required)** `string` - **`context` (required)** `string` - **`field_data` (required)** `string` - **`id` (required)** `string` - **`identifier` (required)** `string` - **`instance` (required)** `number` - **`integration` (required)** `string` - **`job_id` (required)** `string` - **`log_level` (required)** `number` - **`message` (required)** `string` - **`method` (required)** `string` - **`operation` (required)** `string` - **`request_id` (required)** `string` - **`result` (required)** `string` - **`sd_acct_id` (required)** `number` - **`sd_user_id` (required)** `string` - **`timestamp` (required)** `string` - **`type` (required)** `string` - **`records`** `string` - **`sort`** `string` - **`start`** `number` - **`timestamp`** `string` **Example:** ```json { "results": { "found": 2295726, "logs": [ { "action": "edit", "channel_id": "CTP6799", "context": "amazon", "field_data": "", "id": "57ba3d9ab3149971218b8ddc", "identifier": "CTP6799", "instance": 0, "integration": "", "job_id": "243427017034", "log_level": 3, "message": "{\"message\":\"successfully submitted inventory\"}", "method": "sync", "operation": "Update", "request_id": "882f93ba-63c1-490a-b461-65109d72a8b1", "result": "submitted", "sd_acct_id": -1, "sd_user_id": "XXXX", "timestamp": "2016-08-21T23:47:35Z", "type": "inventory" }, { "action": "edit", "channel_id": "ZZZ00CTP6798", "context": "amazon", "field_data": "", "id": "57ba3d9ab3149971218b8ddd", "identifier": "ZZZ00CTP6798", "instance": 0, "integration": "", "job_id": "243427017034", "log_level": 3, "message": "{\"message\":\"successfully submitted inventory\"}", "method": "sync", "operation": "Update", "request_id": "882f93ba-63c1-490a-b461-65109d72a8b2", "result": "submitted", "sd_acct_id": -1, "sd_user_id": "XXXX", "timestamp": "2016-08-21T23:47:35Z", "type": "inventory" }, { "action": "edit", "channel_id": "CTP6787", "context": "amazon", "field_data": "", "id": "57ba3d9ab3149971218b8de3", "identifier": "CTP6787", "instance": 0, "integration": "", "job_id": "243427017034", "log_level": 3, "message": "{\"message\":\"successfully submitted inventory\"}", "method": "sync", "operation": "Update", "request_id": "882f93ba-63c1-490a-b461-65109d72a8b3", "result": "submitted", "sd_acct_id": -1, "sd_user_id": "XXXX", "timestamp": "2016-08-21T23:47:35Z", "type": "inventory" }, { "action": "edit", "channel_id": "CTP6747", "context": "amazon", "field_data": "", "id": "57ba3d9ab3149971218b8de7", "identifier": "CTP6747", "instance": 0, "integration": "", "job_id": "243427017034", "log_level": 3, "message": "{\"message\":\"successfully submitted inventory\"}", "method": "sync", "operation": "Update", "request_id": "882f93ba-63c1-490a-b461-65109d72a8b4", "result": "submitted", "sd_acct_id": -1, "sd_user_id": "XXXX", "timestamp": "2016-08-21T23:47:35Z", "type": "inventory" }, { "action": "edit", "channel_id": "CTP6699", "context": "amazon", "field_data": "", "id": "57ba3d9ab3149971218b8dec", "identifier": "CTP6699", "instance": 0, "integration": "", "job_id": "243427017034", "log_level": 3, "message": "{\"message\":\"successfully submitted inventory\"}", "method": "sync", "operation": "Update", "request_id": "882f93ba-63c1-490a-b461-65109d72a8b5", "result": "submitted", "sd_acct_id": -1, "sd_user_id": "XXXX", "timestamp": "2016-08-21T23:47:35Z", "type": "inventory" }, { "action": "edit", "channel_id": "CTP6501", "context": "amazon", "field_data": "", "id": "57ba3d9ab3149971218b8dfb", "identifier": "CTP6501", "instance": 0, "integration": "", "job_id": "243427017034", "log_level": 3, "message": "{\"message\":\"successfully submitted inventory\"}", "method": "sync", "operation": "Update", "request_id": "882f93ba-63c1-490a-b461-65109d72a8b6", "result": "submitted", "sd_acct_id": -1, "sd_user_id": "XXXX", "timestamp": "2016-08-21T23:47:35Z", "type": "inventory" }, { "action": "edit", "channel_id": "CTP6010", "context": "amazon", "field_data": "", "id": "57ba3d9ab3149971218b8e07", "identifier": "CTP6010", "instance": 0, "integration": "", "job_id": "243427017034", "log_level": 3, "message": "{\"message\":\"successfully submitted inventory\"}", "method": "sync", "operation": "Update", "request_id": "882f93ba-63c1-490a-b461-65109d72a8b7", "result": "submitted", "sd_acct_id": -1, "sd_user_id": "XXXX", "timestamp": "2016-08-21T23:47:35Z", "type": "inventory" }, { "action": "edit", "channel_id": "CTP6002", "context": "amazon", "field_data": "", "id": "57ba3d9ab3149971218b8e0a", "identifier": "CTP6002", "instance": 0, "integration": "", "job_id": "243427017034", "log_level": 3, "message": "{\"message\":\"successfully submitted inventory\"}", "method": "sync", "operation": "Update", "request_id": "882f93ba-63c1-490a-b461-65109d72a8b8", "result": "submitted", "sd_acct_id": -1, "sd_user_id": "XXXX", "timestamp": "2016-08-21T23:47:35Z", "type": "inventory" }, { "action": "edit", "channel_id": "CTP5998", "context": "amazon", "field_data": "", "id": "57ba3d9ab3149971218b8e0b", "identifier": "CTP5998", "instance": 0, "integration": "", "job_id": "243427017034", "log_level": 3, "message": "{\"message\":\"successfully submitted inventory\"}", "method": "sync", "operation": "Update", "request_id": "882f93ba-63c1-490a-b461-65109d72a8b9", "result": "submitted", "sd_acct_id": -1, "sd_user_id": "XXXX", "timestamp": "2016-08-21T23:47:35Z", "type": "inventory" }, { "action": "edit", "channel_id": "CTP5968", "context": "amazon", "field_data": "", "id": "57ba3d9ab3149971218b8e0e", "identifier": "CTP5968", "instance": 0, "integration": "", "job_id": "243427017034", "log_level": 3, "message": "{\"message\":\"successfully submitted inventory\"}", "method": "sync", "operation": "Update", "request_id": "882f93ba-63c1-490a-b461-65109d72a9b1", "result": "submitted", "sd_acct_id": -1, "sd_user_id": "XXXX", "timestamp": "2016-08-21T23:47:35Z", "type": "inventory" } ], "records": "10", "sort": "timestamp desc", "start": 0 }, "timestamp": "2019-11-02T00:22:23Z" } ``` ### Create order (single or bulk) - **Method:** `POST` - **Path:** `/v3/orders` - **Tags:** Orders Requests Creates one or more orders. Two request shapes are accepted on this endpoint: - **Single order**: send the order fields directly in the JSON body. - **Bulk**: send a `header` array naming the columns and a `data` array of row tuples. The handler dispatches by the presence of `header` and `data` on the body. For Update or Delete in bulk, send the same `header`/`data` shape using PATCH or DELETE on `/v3/orders` or `/v3/orders/{oid}` respectively. | Field | Description | Required | | :------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | oid | database ID, integer Must be supplied as identifier if “order” is not supplied as the identifier. | Yes for combine and split orders | | order | concatenation of “channel” and “ordernumber” which may be used as an identifier. | | | ordernumber | order number, 100 character limit | Yes for create order | | channel | channel where the order was originated, 50 character limit | | | instance | for orders imported via SureDone, the integration instance of the channel | | | details | channel specific order details encoded as JSON such as item fees and delivery estimates | | | date | date of order, converted to timezone configured in user’s SureDone settings | | | dateutc | date or order in UTC | | | dateupdated | last modified date of order, converted to timezone configured in SureDone account | | | oidconsolidate | oid of archived or parent order in split and combined orders respectively | | | gift | whether order was marked as a gift, boolean | | | comments | order comments | | | internalnotes | array of internal notes indexed by date of each note and encoded as JSON, sending in “internalnotesoverwrite” with a non-false value will overwrite all contents of this field | | | status | order status with value one of “INCOMPLETE”, “READY”, “PENDING”, “ORDERED”, “DROPSHIPPED”, “COMPLETE” or “ARCHIVED” | | | transactionid | transaction ID of the order, may correlate to a system identifier required by the channel for fulfilling the order | | | correlationid | correlation ID for the payment of the order | | | payment | payment method of the order | | | paymentdate | date of payment to mark paymentstatus as COMPLETE | | | paymentstatus | payment status with value one of “INCOMPLETE”, “PENDING” or “COMPLETE” | | | shippingcarrier | buyer requested shipping carrier | | | shippingservice | buyer requested shipping service | | | shippingstatus | shipping status with value one of “INCOMPLETE”, “PENDING” or “COMPLETE”, sending “COMPLETE” will mark order as “shipped” on external channels | | | total | order total including all taxes, shipping, handling and discounts | Yes for create order | | itemtotal | total of all order items | | | shippingtotal | total of all shipping costs charged | | | handlingtotal | total of all handling charged | | | taxtotal | total of all taxes charged | | | discounttotal | total of all discounts applied to order | | | discountcode | code used to generate discount, 50 character limit | | | currency | currency code of the order, 10 character limit | | | account | account id of suredone storefront user | | | archived | whether order has been “deleted”, boolean | | | meta | miscellaneous order data JSON encoded including but not limited to raw payloads from channel imports and raw validated addresses | | | email | email of customer | | | billing | address data object for billing contact | | | billing > country | country of billing contact | | | billing > firstname | first name of billing contact | | | billing > middlename | middle name of billing contact | | | billing > lastname | last name of billing contact | | | billing > company | company of billing contact | | | billing > streetl | address street of billing contact | | | billing > street2 | address street 2 of billing contact | | | billing > street3 | address street 3 of billing contact | | | billing > city | city of billing contact | | | billing > stateprovince | state or province of billing contact | | | billing > postalcode | postal code of billing contact | | | billing > phone | phone number of billing contact | | | billing > phone2 | second phone number of billing contact | | | shipping | address data object for shipping contact | | | shipping > country | country of shipping contact | | | shipping > firstname | first name of shipping contact | | | shipping > middlename | middle name of shipping contact | | | shipping > lastname | last name of shipping contact | | | shipping > company | company of shipping contact | | | shipping > streetl | address street of shipping contact | | | shipping > street2 | address street 2 of shipping contact | | | shipping > street3 | address street 3 of shipping contact | | | shipping > city | city of shipping contact | | | shipping > stateprovince | state or province of shipping contact | | | shipping > postalcode | postal code of shipping contact | | | shipping > phone | phone number of shipping contact | | | shipping > phone2 | second phone number of shipping contact | | | items | order items object with one or more items, for products that exist in SureDone the following fields may be populated if they are missing during order creation | Yes for create order | | items > itemid | order item id, required for updating order item data | | | items > sku | order item SKU, for products matching in SureDone this will be the “guid”, 100 character limit | | | items > title | order item title, 500 character limit | | | items > price | order item price | | | items > quantity | order item quantity purchased | | | items > media | order item image URL | | | items > weight | order item weight | | | items > dimweight | order item dim weight | | | items > boxlength | order item box length | | | items > boxwidth | order item box width | | | items > boxheight | order item box height | | | items > source | order item stock (warehouse) source as determined by product stock levels for products that exist in SureDone | | | items > itemdetails | order item details JSON encoded including but not limited to full product payload for products existing in SureDone at the time of order creation | | | items > itemstatus | order item status | | | items > vendor | order item vendor | | | items > purchaseorderid | order item purchase order for vendors and/or erp | | | items > “customfields” | order item custom fields created | | | shipments | order shipments object with one or more shipments | | | shipments > shipid | order shipment id, required when updating an existing shipment post creation | | | shipments > shipcarrier | order shipment carrier | | | shipments > shipservice | order shipment service | | | shipments > shiptracking | order shipment tracking number | | | shipments > shipdate | date of order shipment | | | shipments > shipcost | cost of order shipment | | | shipments > shipuser | user who generated order shipment | | | shipments > shipdetails | order shipment details JSON encoded including but not limited to fulfillment order item data in the case of short shipping | | | shipments > shipdetails > items | order shipment package line item sku and quantity details, supported via API parameters `shipitems` or `shipsku` with `shipquantity`. Example `{"shipments":[{"shiptracking":"123123123123","shipdate":"NOW","shipitems":[{"sku":"U8800ZZZ","quantity":1,"fulfilled":null}]}]}`. Optionally, you may use `shipskufield` and `shipskuvalue` to internally map `shipsku` to an `order.item.sku` via matching where `order.item.itemdetails.product.{shipskufield} = shipskuvalue`. | | | refunds | order refunds object with one or more refunds | | | refunds > refundid | order refund id, required for updating an order refund | | | refunds > refunddate | date of order refund | | | refunds > refunddetails | order refund details JSON encoded | | | refunds > refunddetails > items | order refund line item sku and quantity details, supported via API parameters `refunditems` or `refundsku` with `refundquantity`. | | | sold | whether to sync inventory for existing order items during order creation, boolean | | #### Parameters ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `createOrder`. `string` #### Responses ##### Status: 200 Create order (single or bulk) — completed. ###### Content-Type: application/json - **`oid`** `number` - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "oid": 353, "results": { "successful": [ { "code": 1, "message": "Order created successfully!" } ] } } ``` ### Get orders - **Method:** `GET` - **Path:** `/v3/orders` - **Tags:** Orders Requests * Description: Use the orders endpoint without the `oid` to return a list of orders. Note: by default the API will return all orders, including `archived` ones. When SureDone imports multi item eBay orders, the system currently imports the line item as a separate order and then uses internal mechanisms combine in a single order. To accommodate this, you may filter archived orders out using the search: `archived:=0` Option GET parameters include: - `page`: return paginated results by page number - `sort`: return results sorted by valid key - `sortorder`: accepts either `desc` or `asc` - `q`: valid search to restrict search results - `lineitem`: return results in line item format, accepts boolean - `lineitem_filter`: for orders with multiple items not meeting `q` search criteria, do not return order items, accepts boolean | Field | Description | Required | | :------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | oid | database ID, integer Must be supplied as identifier if “order” is not supplied as the identifier. | Yes for combine and split orders | | order | concatenation of “channel” and “ordernumber” which may be used as an identifier. | | | ordernumber | order number, 100 character limit | Yes for create order | | channel | channel where the order was originated, 50 character limit | | | instance | for orders imported via SureDone, the integration instance of the channel | | | details | channel specific order details encoded as JSON such as item fees and delivery estimates | | | date | date of order, converted to timezone configured in user’s SureDone settings | | | dateutc | date or order in UTC | | | dateupdated | last modified date of order, converted to timezone configured in SureDone account | | | oidconsolidate | oid of archived or parent order in split and combined orders respectively | | | gift | whether order was marked as a gift, boolean | | | comments | order comments | | | internalnotes | array of internal notes indexed by date of each note and encoded as JSON, sending in “internalnotesoverwrite” with a non-false value will overwrite all contents of this field | | | status | order status with value one of “INCOMPLETE”, “READY”, “PENDING”, “ORDERED”, “DROPSHIPPED”, “COMPLETE” or “ARCHIVED” | | | transactionid | transaction ID of the order, may correlate to a system identifier required by the channel for fulfilling the order | | | correlationid | correlation ID for the payment of the order | | | payment | payment method of the order | | | paymentdate | date of payment to mark paymentstatus as COMPLETE | | | paymentstatus | payment status with value one of “INCOMPLETE”, “PENDING” or “COMPLETE” | | | shippingcarrier | buyer requested shipping carrier | | | shippingservice | buyer requested shipping service | | | shippingstatus | shipping status with value one of “INCOMPLETE”, “PENDING” or “COMPLETE”, sending “COMPLETE” will mark order as “shipped” on external channels | | | total | order total including all taxes, shipping, handling and discounts | Yes for create order | | itemtotal | total of all order items | | | shippingtotal | total of all shipping costs charged | | | handlingtotal | total of all handling charged | | | taxtotal | total of all taxes charged | | | discounttotal | total of all discounts applied to order | | | discountcode | code used to generate discount, 50 character limit | | | currency | currency code of the order, 10 character limit | | | account | account id of suredone storefront user | | | archived | whether order has been “deleted”, boolean | | | meta | miscellaneous order data JSON encoded including but not limited to raw payloads from channel imports and raw validated addresses | | | email | email of customer | | | billing | address data object for billing contact | | | billing > country | country of billing contact | | | billing > firstname | first name of billing contact | | | billing > middlename | middle name of billing contact | | | billing > lastname | last name of billing contact | | | billing > company | company of billing contact | | | billing > streetl | address street of billing contact | | | billing > street2 | address street 2 of billing contact | | | billing > street3 | address street 3 of billing contact | | | billing > city | city of billing contact | | | billing > stateprovince | state or province of billing contact | | | billing > postalcode | postal code of billing contact | | | billing > phone | phone number of billing contact | | | billing > phone2 | second phone number of billing contact | | | shipping | address data object for shipping contact | | | shipping > country | country of shipping contact | | | shipping > firstname | first name of shipping contact | | | shipping > middlename | middle name of shipping contact | | | shipping > lastname | last name of shipping contact | | | shipping > company | company of shipping contact | | | shipping > streetl | address street of shipping contact | | | shipping > street2 | address street 2 of shipping contact | | | shipping > street3 | address street 3 of shipping contact | | | shipping > city | city of shipping contact | | | shipping > stateprovince | state or province of shipping contact | | | shipping > postalcode | postal code of shipping contact | | | shipping > phone | phone number of shipping contact | | | shipping > phone2 | second phone number of shipping contact | | | items | order items object with one or more items, for products that exist in SureDone the following fields may be populated if they are missing during order creation | Yes for create order | | items > itemid | order item id, required for updating order item data | | | items > sku | order item SKU, for products matching in SureDone this will be the “guid”, 100 character limit | | | items > title | order item title, 500 character limit | | | items > price | order item price | | | items > quantity | order item quantity purchased | | | items > media | order item image URL | | | items > weight | order item weight | | | items > dimweight | order item dim weight | | | items > boxlength | order item box length | | | items > boxwidth | order item box width | | | items > boxheight | order item box height | | | items > source | order item stock (warehouse) source as determined by product stock levels for products that exist in SureDone | | | items > itemdetails | order item details JSON encoded including but not limited to full product payload for products existing in SureDone at the time of order creation | | | items > itemstatus | order item status | | | items > vendor | order item vendor | | | items > purchaseorderid | order item purchase order for vendors and/or erp | | | items > “customfields” | order item custom fields created | | | shipments | order shipments object with one or more shipments | | | shipments > shipid | order shipment id, required when updating an existing shipment post creation | | | shipments > shipcarrier | order shipment carrier | | | shipments > shipservice | order shipment service | | | shipments > shiptracking | order shipment tracking number | | | shipments > shipdate | date of order shipment | | | shipments > shipcost | cost of order shipment | | | shipments > shipuser | user who generated order shipment | | | shipments > shipdetails | order shipment details JSON encoded including but not limited to fulfillment order item data in the case of short shipping | | | shipments > shipdetails > items | order shipment package line item sku and quantity details, supported via API parameters `shipitems` or `shipsku` with `shipquantity`. Example `{"shipments":[{"shiptracking":"123123123123","shipdate":"NOW","shipitems":[{"sku":"U8800ZZZ","quantity":1,"fulfilled":null}]}]}`. Optionally, you may use `shipskufield` and `shipskuvalue` to internally map `shipsku` to an `order.item.sku` via matching where `order.item.itemdetails.product.{shipskufield} = shipskuvalue`. | | | refunds | order refunds object with one or more refunds | | | refunds > refundid | order refund id, required for updating an order refund | | | refunds > refunddate | date of order refund | | | refunds > refunddetails | order refund details JSON encoded | | | refunds > refunddetails > items | order refund line item sku and quantity details, supported via API parameters `refunditems` or `refundsku` with `refundquantity`. | | #### Parameters ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `getOrders`. `string` #### Responses ##### Status: 200 Get orders — results returned. ###### Content-Type: application/json - **`count`** `string` - **`orders`** `array` **Items:** - **`account`** `string | null` - **`archived`** `string` - **`billing`** `object` - **`city`** `string` - **`company`** `string` - **`country`** `string` - **`firstname`** `string` - **`lastname`** `string` - **`middlename`** `string` - **`phone`** `string` - **`phone2`** `string` - **`postalcode`** `string` - **`stateprovince`** `string` - **`street1`** `string` - **`street2`** `string` - **`street3`** `string` - **`channel`** `string` - **`comments`** `string` - **`correlationid`** `string` - **`currency`** `string` - **`date`** `string` - **`dateupdated`** `string` - **`dateupdatedutc`** `string` - **`dateutc`** `string` - **`details`** `object` - **`currency`** `array` **Items:** `string` - **`deliver-by-earliest`** `array` **Items:** `string` - **`deliver-by-latest`** `array` **Items:** `string` - **`handling`** `array` **Items:** `number` - **`itemfee`** `array` **Items:** `string` - **`ship-by-earliest`** `array` **Items:** `string` - **`ship-by-latest`** `array` **Items:** `string` - **`shipping`** `array` **Items:** `number` - **`shipservice`** `array` **Items:** `string` - **`shiptax`** `array` **Items:** `number` - **`tax`** `array` **Items:** `number` - **`discountcode`** `string` - **`discounttotal`** `string` - **`email`** `string | null` — Buyer email of record. May be \`null\` on channel orders that do not surface a customer email (e.g. eBay payment-only flows). - **`gift`** `string` - **`handlingtotal`** `string` - **`instance`** `string` - **`internalnotes`** `object` — Map of UTC timestamp string (e.g. \`2018-08-11T16:22:49\`) to the note body. Returned as an empty JSON array (\`\[]\`) when no notes are present — PHP serializes an empty associative array this way. - **`ip`** `string` - **`items`** `array` **Items:** - **`boxheight`** `string` - **`boxlength`** `string` - **`boxwidth`** `string` - **`dimweight`** `string` - **`itemdetails`** `object` - **`order-item-id`** `string` - **`product`** `object` - **`active`** `string` - **`actualcost`** `string` - **`amzn2asin`** `string` - **`amzn2category`** `string` - **`amzn2categorypath`** `string` - **`amzn2currency`** `string` - **`amzn2fba`** `string` - **`amzn2itemtype`** `string` - **`amzn2options`** `object | null` - **`amzn2parentbrand`** `string` - **`amzn2parentbullets`** `string` - **`amzn2parentdescription`** `string` - **`amzn2parentimage`** `string` - **`amzn2parenttitle`** `string` - **`amzn2price`** `string` - **`amzn2search`** `string` - **`amzn2skip`** `string` - **`amzn2sku`** `string` - **`amzn2status`** `string` - **`amzn2title`** `string` - **`amzn3asin`** `string` - **`amzn3category`** `string` - **`amzn3categorypath`** `string` - **`amzn3currency`** `string` - **`amzn3fba`** `string` - **`amzn3itemtype`** `string` - **`amzn3options`** `object | null` - **`amzn3parentbrand`** `string` - **`amzn3parentbullets`** `string` - **`amzn3parentdescription`** `string` - **`amzn3parentimage`** `string` - **`amzn3parenttitle`** `string` - **`amzn3price`** `string` - **`amzn3search`** `string` - **`amzn3skip`** `string` - **`amzn3sku`** `string` - **`amzn3status`** `string` - **`amzn3title`** `string` - **`amznasin`** `string` - **`amzncategory`** `string` - **`amzncategorypath`** `string` - **`amzncurrency`** `string` - **`amznfba`** `string` - **`amznitemtype`** `string` - **`amznoptions`** `object` - **`categorypath`** `string` - **`parentbrand`** `string` - **`parentbullets`** `string` - **`parentdescription`** `string` - **`parentimage`** `string` - **`parenttitle`** `string` - **`skip`** `string` - **`amznparentbrand`** `string` - **`amznparentbullets`** `string` - **`amznparentdescription`** `string` - **`amznparentimage`** `string` - **`amznparenttitle`** `string` - **`amznprice`** `string` - **`amznsearch`** `string` - **`amznskip`** `string` - **`amznsku`** `string` - **`amznstatus`** `string` - **`amzntitle`** `string` - **`asset`** `string` - **`atest3`** `string` - **`bandsize`** `string` - **`bccf1`** `string` - **`bccustom1`** `string` - **`bccustom10`** `string` - **`bccustom11`** `string` - **`bccustom12`** `string` - **`bccustom13`** `string` - **`bccustom14`** `string` - **`bccustom15`** `string` - **`bccustom16`** `string` - **`bccustom17`** `string` - **`bccustom2`** `string` - **`bccustom3`** `string` - **`bccustom4`** `string` - **`bccustom5`** `string` - **`bccustom6`** `string` - **`bccustom7`** `string` - **`bccustom8`** `string` - **`bccustom9`** `string` - **`bcf1`** `string` - **`bcnewcf1`** `string` - **`bcnewcf2`** `string` - **`bcnewcf3`** `string` - **`bcnewcf4`** `string` - **`bcnewcf5`** `string` - **`bcnewcf6`** `string` - **`bcnewcf7`** `string` - **`bcnewcfa`** `string` - **`bcnewcfb`** `string` - **`bcnewcfc`** `string` - **`bcnewcfd`** `string` - **`bcnewcfe`** `string` - **`bcnewcff`** `string` - **`bcnewcfg`** `string` - **`bcnewcfh`** `string` - **`bcnewcfi`** `string` - **`bctest1`** `string` - **`bctest2`** `string` - **`bctest3`** `string` - **`bctest4`** `string` - **`bigcommerce2availability`** `string` - **`bigcommerce2availabilitydescription`** `string` - **`bigcommerce2avalaraproducttaxcode`** `string` - **`bigcommerce2binpickingnumber`** `string` - **`bigcommerce2brandid`** `string` - **`bigcommerce2calculatedprice`** `string` - **`bigcommerce2categories`** `string` - **`bigcommerce2configurablefields`** `string` - **`bigcommerce2costprice`** `string` - **`bigcommerce2customfields`** `string` - **`bigcommerce2datecreated`** `string` - **`bigcommerce2datelastimported`** `string` - **`bigcommerce2description`** `string` - **`bigcommerce2discountrules`** `string` - **`bigcommerce2downloads`** `string` - **`bigcommerce2eventdateend`** `string` - **`bigcommerce2eventdatefieldname`** `string` - **`bigcommerce2eventdatestart`** `string` - **`bigcommerce2eventdatetype`** `string` - **`bigcommerce2fixedcostshippingprice`** `string` - **`bigcommerce2images`** `string` - **`bigcommerce2inventorywarninglevel`** `string` - **`bigcommerce2isconditionshown`** `string` - **`bigcommerce2isfeatured`** `string` - **`bigcommerce2isfreeshipping`** `string` - **`bigcommerce2isopengraphthumbnail`** `string` - **`bigcommerce2ispreorderonly`** `string` - **`bigcommerce2ispricehidden`** `string` - **`bigcommerce2keywordfilter`** `string` - **`bigcommerce2layoutfile`** `string` - **`bigcommerce2listingid`** `string` - **`bigcommerce2manageproductrules`** `string` - **`bigcommerce2media`** `string` - **`bigcommerce2metadescription`** `string` - **`bigcommerce2metakeywords`** `string` - **`bigcommerce2myobassetaccount`** `string` - **`bigcommerce2myobexpenseaccount`** `string` - **`bigcommerce2myobincomeaccount`** `string` - **`bigcommerce2name`** `string` - **`bigcommerce2opengraphdescription`** `string` - **`bigcommerce2opengraphtitle`** `string` - **`bigcommerce2opengraphtype`** `string` - **`bigcommerce2options`** `object | null` - **`bigcommerce2optionsetdisplay`** `string` - **`bigcommerce2optionsetid`** `string` - **`bigcommerce2orderquantitymaximum`** `string` - **`bigcommerce2orderquantityminimum`** `string` - **`bigcommerce2pagetitle`** `string` - **`bigcommerce2path`** `string` - **`bigcommerce2peachtreeglaccount`** `string` - **`bigcommerce2preordermessage`** `string` - **`bigcommerce2preorderreleasedate`** `string` - **`bigcommerce2price`** `string` - **`bigcommerce2pricehiddenlabel`** `string` - **`bigcommerce2productrule`** `string` - **`bigcommerce2ratingcount`** `string` - **`bigcommerce2ratingtotal`** `string` - **`bigcommerce2relatedproducts`** `string` - **`bigcommerce2retailprice`** `string` - **`bigcommerce2saleprice`** `string` - **`bigcommerce2searchkeywords`** `string` - **`bigcommerce2skip`** `string` - **`bigcommerce2sku`** `string` - **`bigcommerce2skuid`** `string` - **`bigcommerce2taxclassid`** `string` - **`bigcommerce2totalsold`** `string` - **`bigcommerce2type`** `string` - **`bigcommerce2url`** `string` - **`bigcommerce2videos`** `string` - **`bigcommerce2viewcount`** `string` - **`bigcommerce2warranty`** `string` - **`bigcommerceavailability`** `string` - **`bigcommerceavailabilitydescription`** `string` - **`bigcommerceavalaraproducttaxcode`** `string` - **`bigcommercebinpickingnumber`** `string` - **`bigcommercebrandid`** `string` - **`bigcommercecalculatedprice`** `string` - **`bigcommercecategories`** `string` - **`bigcommerceconfigurablefields`** `string` - **`bigcommercecostprice`** `string` - **`bigcommercecustomfields`** `string` - **`bigcommercedatecreated`** `string` - **`bigcommercedatelastimported`** `string` - **`bigcommercedescription`** `string` - **`bigcommercediscountrules`** `string` - **`bigcommercedownloads`** `string` - **`bigcommerceeventdateend`** `string` - **`bigcommerceeventdatefieldname`** `string` - **`bigcommerceeventdatestart`** `string` - **`bigcommerceeventdatetype`** `string` - **`bigcommercefixedcostshippingprice`** `string` - **`bigcommerceimages`** `string` - **`bigcommerceinventorywarninglevel`** `string` - **`bigcommerceisconditionshown`** `string` - **`bigcommerceisfeatured`** `string` - **`bigcommerceisfreeshipping`** `string` - **`bigcommerceisopengraphthumbnail`** `string` - **`bigcommerceispreorderonly`** `string` - **`bigcommerceispricehidden`** `string` - **`bigcommercekeywordfilter`** `string` - **`bigcommercelayoutfile`** `string` - **`bigcommercelistingid`** `string` - **`bigcommercemanageproductrules`** `string` - **`bigcommercemedia`** `string` - **`bigcommercemetadescription`** `string` - **`bigcommercemetakeywords`** `string` - **`bigcommercemyobassetaccount`** `string` - **`bigcommercemyobexpenseaccount`** `string` - **`bigcommercemyobincomeaccount`** `string` - **`bigcommercename`** `string` - **`bigcommerceopengraphdescription`** `string` - **`bigcommerceopengraphtitle`** `string` - **`bigcommerceopengraphtype`** `string` - **`bigcommerceoptions`** `object` - **`availability`** `string` - **`availability_description`** `string` - **`avalara_product_tax_code`** `string` - **`bin_picking_number`** `string` - **`brand_id`** `string` - **`calculated_price`** `string` - **`categories`** `string` - **`configurable_fields`** `string` - **`cost_price`** `string` - **`custom_fields`** `array` **Items:** `string` - **`date_created`** `string` - **`date_last_imported`** `string` - **`description`** `string` - **`discount_rules`** `string` - **`downloads`** `string` - **`event_date_end`** `string` - **`event_date_field_name`** `string` - **`event_date_start`** `string` - **`event_date_type`** `string` - **`fixed_cost_shipping_price`** `string` - **`images`** `string` - **`inventory_warning_level`** `string` - **`is_condition_shown`** `string` - **`is_featured`** `string` - **`is_free_shipping`** `string` - **`is_open_graph_thumbnail`** `string` - **`is_preorder_only`** `string` - **`is_price_hidden`** `string` - **`keyword_filter`** `string` - **`layout_file`** `string` - **`manage_product_rules`** `string` - **`media`** `string` - **`meta_description`** `string` - **`meta_keywords`** `string` - **`myob_asset_account`** `string` - **`myob_expense_account`** `string` - **`myob_income_account`** `string` - **`name`** `string` - **`open_graph_description`** `string` - **`open_graph_title`** `string` - **`open_graph_type`** `string` - **`option_set_display`** `string` - **`option_set_id`** `string` - **`order_quantity_maximum`** `string` - **`order_quantity_minimum`** `string` - **`page_title`** `string` - **`path`** `string` - **`peachtree_gl_account`** `string` - **`preorder_message`** `string` - **`preorder_release_date`** `string` - **`price`** `string` - **`price_hidden_label`** `string` - **`product_rule`** `string` - **`rating_count`** `string` - **`rating_total`** `string` - **`related_products`** `string` - **`retail_price`** `string` - **`sale_price`** `string` - **`search_keywords`** `string` - **`skip`** `string` - **`sku_id`** `string` - **`tax_class_id`** `string` - **`total_sold`** `string` - **`type`** `string` - **`url`** `string` - **`videos`** `string` - **`view_count`** `string` - **`warranty`** `string` - **`bigcommerceoptionsetdisplay`** `string` - **`bigcommerceoptionsetid`** `string` - **`bigcommerceorderquantitymaximum`** `string` - **`bigcommerceorderquantityminimum`** `string` - **`bigcommercepagetitle`** `string` - **`bigcommercepath`** `string` - **`bigcommercepeachtreeglaccount`** `string` - **`bigcommercepreordermessage`** `string` - **`bigcommercepreorderreleasedate`** `string` - **`bigcommerceprice`** `string` - **`bigcommercepricehiddenlabel`** `string` - **`bigcommerceproductrule`** `string` - **`bigcommerceratingcount`** `string` - **`bigcommerceratingtotal`** `string` - **`bigcommercerelatedproducts`** `string` - **`bigcommerceretailprice`** `string` - **`bigcommercesaleprice`** `string` - **`bigcommercesearchkeywords`** `string` - **`bigcommerceskip`** `string` - **`bigcommercesku`** `string` - **`bigcommerceskuid`** `string` - **`bigcommercetaxclassid`** `string` - **`bigcommercetotalsold`** `string` - **`bigcommercetype`** `string` - **`bigcommerceurl`** `string` - **`bigcommercevideos`** `string` - **`bigcommerceviewcount`** `string` - **`bigcommercewarranty`** `string` - **`boing`** `string` - **`bottomssizemens`** `string` - **`bottomssizewomens`** `string` - **`boxheight`** `string` - **`boxlength`** `string` - **`boxweight`** `string` - **`boxwidth`** `string` - **`brand`** `string` - **`bulletpoint1`** `string` - **`bulletpoint2`** `string` - **`bulletpoint3`** `string` - **`bulletpoint4`** `string` - **`bulletpoint5`** `string` - **`cache`** `string` - **`category1`** `string` - **`category2`** `string` - **`category3`** `string` - **`category4`** `string` - **`category5`** `string` - **`cf010301004`** `string` - **`cf020301004`** `string` - **`cf030301004`** `string` - **`cf040301004`** `string` - **`cf1`** `string` - **`cf2`** `string` - **`cf20160223001`** `string` - **`cf20160223002`** `string` - **`cf20160223004`** `string` - **`cf20160223005`** `string` - **`cf20160223007`** `string` - **`cf20160223008`** `string` - **`cf20160223009`** `string` - **`cf20160223010`** `string` - **`cf20160223020`** `string` - **`cf20160223021`** `string` - **`cf3`** `string` - **`cf4`** `string` - **`cf5`** `string` - **`cf6`** `string` - **`cf7`** `string` - **`cf8`** `string` - **`cf9`** `string` - **`cfdn1`** `string` - **`cfon1`** `string` - **`click`** `string` - **`clubtype`** `string` - **`color`** `string` - **`colors`** `string` - **`condition`** `string` - **`content`** `string` - **`cost`** `string` - **`countryregionofmanufactur`** `string` - **`crazynewstyle`** `string` - **`cupsize`** `string` - **`customname`** `string` - **`cut`** `string` - **`date`** `string` - **`datesold`** `string` - **`dateupdated`** `string` - **`deeey`** `string` - **`department`** `string` - **`description`** `string` - **`dimweight`** `string` - **`discountprice`** `string` - **`domain`** `string` - **`dormanstock`** `string` - **`dressshirtsize`** `string` - **`ean`** `string` - **`ebay2adult`** `string` - **`ebay2auctionsrelist`** `string` - **`ebay2autopay`** `string` - **`ebay2autorelistaction`** `string` - **`ebay2autorelistcount`** `string` - **`ebay2autorelistduration`** `string` - **`ebay2autorelistmax`** `string` - **`ebay2autorelistprice`** `string` - **`ebay2bestofferautoacceptprice`** `number` - **`ebay2bestofferenabled`** `string` - **`ebay2bestofferminimumprice`** `number` - **`ebay2buyitnow`** `number` - **`ebay2catid`** `string` - **`ebay2country`** `string` - **`ebay2currency`** `string` - **`ebay2description`** `string` - **`ebay2dispatch`** `string` - **`ebay2duration`** `string` - **`ebay2endtime`** `string` - **`ebay2fitmentcatalog`** `string` - **`ebay2getitfast`** `string` - **`ebay2holidayreturn`** `string` - **`ebay2id`** `string` - **`ebay2internationalon`** `string` - **`ebay2listing`** `string` - **`ebay2location`** `string` - **`ebay2minimumadvertisedprice`** `string` - **`ebay2minimumadvertisedpriceexposure`** `string` - **`ebay2options`** `object` - **`autorelist`** `object` - **`action`** `string` - **`count`** `string` - **`duration`** `string` - **`max`** `string` - **`price`** `string` - **`bestoffer`** `object` - **`autoacceptprice`** `number` - **`minimumprice`** `number` - **`buyitnow`** `number` - **`country`** `string` - **`dispatch`** `object | null` - **`duration`** `string` - **`fitmentcatalog`** `string` - **`internationalon`** `string` - **`listing`** `string` - **`location`** `string` - **`minimumadvertisedprice`** `string` - **`minimumadvertisedpriceexposure`** `string` - **`paymentinstructions`** `string` - **`paymentmethods`** `array` **Items:** `string` - **`paymentprofileid`** `string` - **`returnprofileid`** `string` - **`returns`** `object` - **`description`** `string` - **`salestaxpercent`** `number` - **`scheduletime`** `string` - **`secondcategory`** `string` - **`shipping`** `object` - **`calculated`** `object` - **`handlingfee`** `number` - **`internationalhandlingfee`** `number` - **`postalcode`** `string` - **`shippingirregular`** `boolean` - **`shippingpackage`** `string` - **`domestic`** `object` - **`1`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`2`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`3`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`4`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`excludes`** `array` **Items:** `string` - **`international`** `object` - **`1`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`2`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`3`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`4`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`5`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`shippingprofileid`** `string` - **`shiptolocations`** `array` **Items:** `string` - **`siteid`** `string` - **`siteshipping`** `string` - **`skip`** `string` - **`subtitle`** `string` - **`taxcategory`** `string` - **`template`** `string` - **`ebay2paymentinstructions`** `string` - **`ebay2paymentmethods`** `string` - **`ebay2paymentprofileid`** `string` - **`ebay2paypalemailaddress`** `string` - **`ebay2prefiliteminfo`** `string` - **`ebay2price`** `string` - **`ebay2private`** `string` - **`ebay2promotionendtime`** `string` - **`ebay2promotionstarttime`** `string` - **`ebay2returnprofileid`** `string` - **`ebay2returnsdescription`** `string` - **`ebay2returnsrefund`** `string` - **`ebay2returnsrestockingfeevalue`** `string` - **`ebay2returnsreturnsaccepted`** `string` - **`ebay2returnsreturnswithin`** `string` - **`ebay2returnsshippingcostpaidby`** `string` - **`ebay2salestaxpercent`** `number` - **`ebay2scheduletime`** `string` - **`ebay2secondcategory`** `string` - **`ebay2shippingcalculatedhandlingfee`** `number` - **`ebay2shippingcalculatedinternationalhandlingfee`** `number` - **`ebay2shippingcalculatedpostalcode`** `string` - **`ebay2shippingcalculatedshippingirregular`** `boolean` - **`ebay2shippingcalculatedshippingpackage`** `string` - **`ebay2shippingdomestic1additionalcost`** `number` - **`ebay2shippingdomestic1cost`** `number` - **`ebay2shippingdomestic1cutofftime`** `string` - **`ebay2shippingdomestic1expedited`** `string` - **`ebay2shippingdomestic1freeshipping`** `string` - **`ebay2shippingdomestic1handling`** `string` - **`ebay2shippingdomestic1insurancecost`** `number` - **`ebay2shippingdomestic1localpickup`** `string` - **`ebay2shippingdomestic1service`** `string` - **`ebay2shippingdomestic1surcharge`** `number` - **`ebay2shippingdomestic1timemax`** `number` - **`ebay2shippingdomestic1timemin`** `number` - **`ebay2shippingdomestic2additionalcost`** `number` - **`ebay2shippingdomestic2cost`** `number` - **`ebay2shippingdomestic2cutofftime`** `string` - **`ebay2shippingdomestic2expedited`** `string` - **`ebay2shippingdomestic2freeshipping`** `string` - **`ebay2shippingdomestic2handling`** `string` - **`ebay2shippingdomestic2insurancecost`** `number` - **`ebay2shippingdomestic2localpickup`** `string` - **`ebay2shippingdomestic2service`** `string` - **`ebay2shippingdomestic2surcharge`** `number` - **`ebay2shippingdomestic2timemax`** `number` - **`ebay2shippingdomestic2timemin`** `number` - **`ebay2shippingdomestic3additionalcost`** `number` - **`ebay2shippingdomestic3cost`** `number` - **`ebay2shippingdomestic3cutofftime`** `string` - **`ebay2shippingdomestic3expedited`** `string` - **`ebay2shippingdomestic3freeshipping`** `string` - **`ebay2shippingdomestic3handling`** `string` - **`ebay2shippingdomestic3insurancecost`** `number` - **`ebay2shippingdomestic3localpickup`** `string` - **`ebay2shippingdomestic3service`** `string` - **`ebay2shippingdomestic3surcharge`** `number` - **`ebay2shippingdomestic3timemax`** `number` - **`ebay2shippingdomestic3timemin`** `number` - **`ebay2shippingdomestic4additionalcost`** `number` - **`ebay2shippingdomestic4cost`** `number` - **`ebay2shippingdomestic4cutofftime`** `string` - **`ebay2shippingdomestic4expedited`** `string` - **`ebay2shippingdomestic4freeshipping`** `string` - **`ebay2shippingdomestic4handling`** `string` - **`ebay2shippingdomestic4insurancecost`** `number` - **`ebay2shippingdomestic4localpickup`** `string` - **`ebay2shippingdomestic4service`** `string` - **`ebay2shippingdomestic4surcharge`** `number` - **`ebay2shippingdomestic4timemax`** `number` - **`ebay2shippingdomestic4timemin`** `number` - **`ebay2shippingexcludes`** `string` - **`ebay2shippingglobal`** `string` - **`ebay2shippingincludedintax`** `string` - **`ebay2shippinginternational1additionalcost`** `number` - **`ebay2shippinginternational1cost`** `number` - **`ebay2shippinginternational1cutofftime`** `string` - **`ebay2shippinginternational1handling`** `string` - **`ebay2shippinginternational1insurancecost`** `number` - **`ebay2shippinginternational1location`** `string` - **`ebay2shippinginternational1service`** `string` - **`ebay2shippinginternational2additionalcost`** `number` - **`ebay2shippinginternational2cost`** `number` - **`ebay2shippinginternational2cutofftime`** `string` - **`ebay2shippinginternational2handling`** `string` - **`ebay2shippinginternational2insurancecost`** `number` - **`ebay2shippinginternational2location`** `string` - **`ebay2shippinginternational2service`** `string` - **`ebay2shippinginternational3additionalcost`** `number` - **`ebay2shippinginternational3cost`** `number` - **`ebay2shippinginternational3cutofftime`** `string` - **`ebay2shippinginternational3handling`** `string` - **`ebay2shippinginternational3insurancecost`** `number` - **`ebay2shippinginternational3location`** `string` - **`ebay2shippinginternational3service`** `string` - **`ebay2shippinginternational4additionalcost`** `number` - **`ebay2shippinginternational4cost`** `number` - **`ebay2shippinginternational4cutofftime`** `string` - **`ebay2shippinginternational4handling`** `string` - **`ebay2shippinginternational4insurancecost`** `number` - **`ebay2shippinginternational4location`** `string` - **`ebay2shippinginternational4service`** `string` - **`ebay2shippinginternational5additionalcost`** `number` - **`ebay2shippinginternational5cost`** `number` - **`ebay2shippinginternational5cutofftime`** `string` - **`ebay2shippinginternational5handling`** `string` - **`ebay2shippinginternational5insurancecost`** `number` - **`ebay2shippinginternational5location`** `string` - **`ebay2shippinginternational5service`** `string` - **`ebay2shippingprofileid`** `string` - **`ebay2shippingratetabledom`** `string` - **`ebay2shippingratetableintl`** `string` - **`ebay2shippingtype`** `string` - **`ebay2shiptolocations`** `string` - **`ebay2siteid`** `string` - **`ebay2siteshipping`** `string` - **`ebay2skip`** `string` - **`ebay2sku`** `string` - **`ebay2starttime`** `string` - **`ebay2storeid`** `string` - **`ebay2storeid2`** `string` - **`ebay2subtitle`** `string` - **`ebay2taxcategory`** `string` - **`ebay2template`** `string` - **`ebay2title`** `string` - **`ebay2upcnot`** `string` - **`ebay3adult`** `string` - **`ebay3auctionsrelist`** `string` - **`ebay3autopay`** `string` - **`ebay3autorelistaction`** `string` - **`ebay3autorelistcount`** `string` - **`ebay3autorelistduration`** `string` - **`ebay3autorelistmax`** `string` - **`ebay3autorelistprice`** `string` - **`ebay3bestofferautoacceptprice`** `number` - **`ebay3bestofferenabled`** `string` - **`ebay3bestofferminimumprice`** `number` - **`ebay3buyitnow`** `number` - **`ebay3catid`** `string` - **`ebay3country`** `string` - **`ebay3currency`** `string` - **`ebay3description`** `string` - **`ebay3dispatch`** `string` - **`ebay3duration`** `string` - **`ebay3endtime`** `string` - **`ebay3fitmentcatalog`** `string` - **`ebay3getitfast`** `string` - **`ebay3holidayreturn`** `string` - **`ebay3id`** `string` - **`ebay3internationalon`** `string` - **`ebay3listing`** `string` - **`ebay3location`** `string` - **`ebay3minimumadvertisedprice`** `string` - **`ebay3minimumadvertisedpriceexposure`** `string` - **`ebay3options`** `object` - **`autorelist`** `object` - **`action`** `string` - **`count`** `string` - **`duration`** `string` - **`max`** `string` - **`price`** `string` - **`bestoffer`** `object` - **`autoacceptprice`** `number` - **`minimumprice`** `number` - **`buyitnow`** `number` - **`country`** `string` - **`dispatch`** `object | null` - **`duration`** `string` - **`fitmentcatalog`** `string` - **`internationalon`** `string` - **`listing`** `string` - **`location`** `string` - **`minimumadvertisedprice`** `string` - **`minimumadvertisedpriceexposure`** `string` - **`paymentinstructions`** `string` - **`paymentmethods`** `array` **Items:** `string` - **`paymentprofileid`** `string` - **`returnprofileid`** `string` - **`returns`** `object` - **`description`** `string` - **`salestaxpercent`** `number` - **`scheduletime`** `string` - **`secondcategory`** `string` - **`shipping`** `object` - **`calculated`** `object` - **`handlingfee`** `number` - **`internationalhandlingfee`** `number` - **`postalcode`** `string` - **`shippingirregular`** `boolean` - **`shippingpackage`** `string` - **`domestic`** `object` - **`1`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`2`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`3`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`4`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`excludes`** `array` **Items:** `string` - **`international`** `object` - **`1`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`2`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`3`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`4`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`5`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`shippingprofileid`** `string` - **`shiptolocations`** `array` **Items:** `string` - **`siteid`** `string` - **`siteshipping`** `string` - **`subtitle`** `string` - **`taxcategory`** `string` - **`template`** `string` - **`ebay3paymentinstructions`** `string` - **`ebay3paymentmethods`** `string` - **`ebay3paymentprofileid`** `string` - **`ebay3paypalemailaddress`** `string` - **`ebay3prefiliteminfo`** `string` - **`ebay3price`** `string` - **`ebay3private`** `string` - **`ebay3promotionendtime`** `string` - **`ebay3promotionstarttime`** `string` - **`ebay3returnprofileid`** `string` - **`ebay3returnsdescription`** `string` - **`ebay3returnsrefund`** `string` - **`ebay3returnsrestockingfeevalue`** `string` - **`ebay3returnsreturnsaccepted`** `string` - **`ebay3returnsreturnswithin`** `string` - **`ebay3returnsshippingcostpaidby`** `string` - **`ebay3salestaxpercent`** `number` - **`ebay3scheduletime`** `string` - **`ebay3secondcategory`** `string` - **`ebay3shippingcalculatedhandlingfee`** `number` - **`ebay3shippingcalculatedinternationalhandlingfee`** `number` - **`ebay3shippingcalculatedpostalcode`** `string` - **`ebay3shippingcalculatedshippingirregular`** `boolean` - **`ebay3shippingcalculatedshippingpackage`** `string` - **`ebay3shippingdomestic1additionalcost`** `number` - **`ebay3shippingdomestic1cost`** `number` - **`ebay3shippingdomestic1cutofftime`** `string` - **`ebay3shippingdomestic1expedited`** `string` - **`ebay3shippingdomestic1freeshipping`** `string` - **`ebay3shippingdomestic1handling`** `string` - **`ebay3shippingdomestic1insurancecost`** `number` - **`ebay3shippingdomestic1localpickup`** `string` - **`ebay3shippingdomestic1service`** `string` - **`ebay3shippingdomestic1surcharge`** `number` - **`ebay3shippingdomestic1timemax`** `number` - **`ebay3shippingdomestic1timemin`** `number` - **`ebay3shippingdomestic2additionalcost`** `number` - **`ebay3shippingdomestic2cost`** `number` - **`ebay3shippingdomestic2cutofftime`** `string` - **`ebay3shippingdomestic2expedited`** `string` - **`ebay3shippingdomestic2freeshipping`** `string` - **`ebay3shippingdomestic2handling`** `string` - **`ebay3shippingdomestic2insurancecost`** `number` - **`ebay3shippingdomestic2localpickup`** `string` - **`ebay3shippingdomestic2service`** `string` - **`ebay3shippingdomestic2surcharge`** `number` - **`ebay3shippingdomestic2timemax`** `number` - **`ebay3shippingdomestic2timemin`** `number` - **`ebay3shippingdomestic3additionalcost`** `number` - **`ebay3shippingdomestic3cost`** `number` - **`ebay3shippingdomestic3cutofftime`** `string` - **`ebay3shippingdomestic3expedited`** `string` - **`ebay3shippingdomestic3freeshipping`** `string` - **`ebay3shippingdomestic3handling`** `string` - **`ebay3shippingdomestic3insurancecost`** `number` - **`ebay3shippingdomestic3localpickup`** `string` - **`ebay3shippingdomestic3service`** `string` - **`ebay3shippingdomestic3surcharge`** `number` - **`ebay3shippingdomestic3timemax`** `number` - **`ebay3shippingdomestic3timemin`** `number` - **`ebay3shippingdomestic4additionalcost`** `number` - **`ebay3shippingdomestic4cost`** `number` - **`ebay3shippingdomestic4cutofftime`** `string` - **`ebay3shippingdomestic4expedited`** `string` - **`ebay3shippingdomestic4freeshipping`** `string` - **`ebay3shippingdomestic4handling`** `string` - **`ebay3shippingdomestic4insurancecost`** `number` - **`ebay3shippingdomestic4localpickup`** `string` - **`ebay3shippingdomestic4service`** `string` - **`ebay3shippingdomestic4surcharge`** `number` - **`ebay3shippingdomestic4timemax`** `number` - **`ebay3shippingdomestic4timemin`** `number` - **`ebay3shippingexcludes`** `string` - **`ebay3shippingglobal`** `string` - **`ebay3shippingincludedintax`** `string` - **`ebay3shippinginternational1additionalcost`** `number` - **`ebay3shippinginternational1cost`** `number` - **`ebay3shippinginternational1cutofftime`** `string` - **`ebay3shippinginternational1handling`** `string` - **`ebay3shippinginternational1insurancecost`** `number` - **`ebay3shippinginternational1location`** `string` - **`ebay3shippinginternational1service`** `string` - **`ebay3shippinginternational2additionalcost`** `number` - **`ebay3shippinginternational2cost`** `number` - **`ebay3shippinginternational2cutofftime`** `string` - **`ebay3shippinginternational2handling`** `string` - **`ebay3shippinginternational2insurancecost`** `number` - **`ebay3shippinginternational2location`** `string` - **`ebay3shippinginternational2service`** `string` - **`ebay3shippinginternational3additionalcost`** `number` - **`ebay3shippinginternational3cost`** `number` - **`ebay3shippinginternational3cutofftime`** `string` - **`ebay3shippinginternational3handling`** `string` - **`ebay3shippinginternational3insurancecost`** `number` - **`ebay3shippinginternational3location`** `string` - **`ebay3shippinginternational3service`** `string` - **`ebay3shippinginternational4additionalcost`** `number` - **`ebay3shippinginternational4cost`** `number` - **`ebay3shippinginternational4cutofftime`** `string` - **`ebay3shippinginternational4handling`** `string` - **`ebay3shippinginternational4insurancecost`** `number` - **`ebay3shippinginternational4location`** `string` - **`ebay3shippinginternational4service`** `string` - **`ebay3shippinginternational5additionalcost`** `number` - **`ebay3shippinginternational5cost`** `number` - **`ebay3shippinginternational5cutofftime`** `string` - **`ebay3shippinginternational5handling`** `string` - **`ebay3shippinginternational5insurancecost`** `number` - **`ebay3shippinginternational5location`** `string` - **`ebay3shippinginternational5service`** `string` - **`ebay3shippingprofileid`** `string` - **`ebay3shippingratetabledom`** `string` - **`ebay3shippingratetableintl`** `string` - **`ebay3shippingtype`** `string` - **`ebay3shiptolocations`** `string` - **`ebay3siteid`** `string` - **`ebay3siteshipping`** `string` - **`ebay3skip`** `string` - **`ebay3sku`** `string` - **`ebay3starttime`** `string` - **`ebay3storeid`** `string` - **`ebay3storeid2`** `string` - **`ebay3subtitle`** `string` - **`ebay3taxcategory`** `string` - **`ebay3template`** `string` - **`ebay3title`** `string` - **`ebay3upcnot`** `string` - **`ebayadult`** `string` - **`ebayauctionsrelist`** `string` - **`ebayautopay`** `string` - **`ebayautorelistaction`** `string` - **`ebayautorelistcount`** `string` - **`ebayautorelistduration`** `string` - **`ebayautorelistmax`** `string` - **`ebayautorelistprice`** `string` - **`ebaybestofferautoacceptprice`** `number` - **`ebaybestofferenabled`** `string` - **`ebaybestofferminimumprice`** `number` - **`ebaybuyitnow`** `number` - **`ebaycatid`** `string` - **`ebaycountry`** `string` - **`ebaycurrency`** `string` - **`ebaydescription`** `string` - **`ebaydispatch`** `string` - **`ebayduration`** `string` - **`ebayendtime`** `string` - **`ebayepid`** `string` - **`ebayfitmentcatalog`** `string` - **`ebaygetitfast`** `string` - **`ebayholidayreturn`** `string` - **`ebayid`** `string` - **`ebayinternationalon`** `string` - **`ebayitemspecificsmapprice`** `string` - **`ebayitemspecificswarranty`** `string` - **`ebayktype`** `string` - **`ebaylisting`** `string` - **`ebaylocation`** `string` - **`ebayminimumadvertisedprice`** `string` - **`ebayminimumadvertisedpriceexposure`** `string` - **`ebayoptions`** `object` - **`autorelist`** `object` - **`action`** `string` - **`count`** `string` - **`duration`** `string` - **`max`** `string` - **`price`** `string` - **`bestoffer`** `object` - **`autoacceptprice`** `number` - **`minimumprice`** `number` - **`buyitnow`** `number` - **`country`** `string` - **`dispatch`** `object | null` - **`duration`** `string` - **`fitmentcatalog`** `string` - **`internationalon`** `string` - **`itemspecifics`** `array` **Items:** `string` - **`listing`** `string` - **`location`** `string` - **`minimumadvertisedprice`** `string` - **`minimumadvertisedpriceexposure`** `string` - **`paymentinstructions`** `string` - **`paymentmethods`** `array` **Items:** `string` - **`paymentprofileid`** `string` - **`returnprofileid`** `string` - **`returns`** `object` - **`description`** `string` - **`salestaxpercent`** `number` - **`scheduletime`** `string` - **`secondcategory`** `string` - **`shipping`** `object` - **`calculated`** `object` - **`handlingfee`** `number` - **`internationalhandlingfee`** `number` - **`postalcode`** `string` - **`shippingirregular`** `boolean` - **`shippingpackage`** `string` - **`domestic`** `object` - **`1`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`2`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`3`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`4`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`excludes`** `array` **Items:** `string` - **`international`** `object` - **`1`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`2`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`3`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`4`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`5`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`shippingprofileid`** `string` - **`shiptolocations`** `array` **Items:** `string` - **`siteid`** `string` - **`siteshipping`** `string` - **`skip`** `string` - **`subtitle`** `string` - **`taxcategory`** `string` - **`template`** `string` - **`ebaypaymentinstructions`** `string` - **`ebaypaymentmethods`** `string` - **`ebaypaymentprofileid`** `string` - **`ebaypaypalemailaddress`** `string` - **`ebayprefiliteminfo`** `string` - **`ebayprice`** `string` - **`ebayprivate`** `string` - **`ebayproductid`** `string` - **`ebaypromotionendtime`** `string` - **`ebaypromotionstarttime`** `string` - **`ebayreturnprofileid`** `string` - **`ebayreturnsdescription`** `string` - **`ebayreturnsrefund`** `string` - **`ebayreturnsrestockingfeevalue`** `string` - **`ebayreturnsreturnsaccepted`** `string` - **`ebayreturnsreturnswithin`** `string` - **`ebayreturnsshippingcostpaidby`** `string` - **`ebaysalestaxpercent`** `number` - **`ebayscheduletime`** `string` - **`ebaysecondcategory`** `string` - **`ebayshippingcalculatedhandlingfee`** `number` - **`ebayshippingcalculatedinternationalhandlingfee`** `number` - **`ebayshippingcalculatedpostalcode`** `string` - **`ebayshippingcalculatedshippingirregular`** `boolean` - **`ebayshippingcalculatedshippingpackage`** `string` - **`ebayshippingdomestic1additionalcost`** `number` - **`ebayshippingdomestic1cost`** `number` - **`ebayshippingdomestic1cutofftime`** `string` - **`ebayshippingdomestic1expedited`** `string` - **`ebayshippingdomestic1freeshipping`** `string` - **`ebayshippingdomestic1handling`** `string` - **`ebayshippingdomestic1insurancecost`** `number` - **`ebayshippingdomestic1localpickup`** `string` - **`ebayshippingdomestic1service`** `string` - **`ebayshippingdomestic1surcharge`** `number` - **`ebayshippingdomestic1timemax`** `number` - **`ebayshippingdomestic1timemin`** `number` - **`ebayshippingdomestic2additionalcost`** `number` - **`ebayshippingdomestic2cost`** `number` - **`ebayshippingdomestic2cutofftime`** `string` - **`ebayshippingdomestic2expedited`** `string` - **`ebayshippingdomestic2freeshipping`** `string` - **`ebayshippingdomestic2handling`** `string` - **`ebayshippingdomestic2insurancecost`** `number` - **`ebayshippingdomestic2localpickup`** `string` - **`ebayshippingdomestic2service`** `string` - **`ebayshippingdomestic2surcharge`** `number` - **`ebayshippingdomestic2timemax`** `number` - **`ebayshippingdomestic2timemin`** `number` - **`ebayshippingdomestic3additionalcost`** `number` - **`ebayshippingdomestic3cost`** `number` - **`ebayshippingdomestic3cutofftime`** `string` - **`ebayshippingdomestic3expedited`** `string` - **`ebayshippingdomestic3freeshipping`** `string` - **`ebayshippingdomestic3handling`** `string` - **`ebayshippingdomestic3insurancecost`** `number` - **`ebayshippingdomestic3localpickup`** `string` - **`ebayshippingdomestic3service`** `string` - **`ebayshippingdomestic3surcharge`** `number` - **`ebayshippingdomestic3timemax`** `number` - **`ebayshippingdomestic3timemin`** `number` - **`ebayshippingdomestic4additionalcost`** `number` - **`ebayshippingdomestic4cost`** `number` - **`ebayshippingdomestic4cutofftime`** `string` - **`ebayshippingdomestic4expedited`** `string` - **`ebayshippingdomestic4freeshipping`** `string` - **`ebayshippingdomestic4handling`** `string` - **`ebayshippingdomestic4insurancecost`** `number` - **`ebayshippingdomestic4localpickup`** `string` - **`ebayshippingdomestic4service`** `string` - **`ebayshippingdomestic4surcharge`** `number` - **`ebayshippingdomestic4timemax`** `number` - **`ebayshippingdomestic4timemin`** `number` - **`ebayshippingexcludes`** `string` - **`ebayshippingglobal`** `string` - **`ebayshippingincludedintax`** `string` - **`ebayshippinginternational1additionalcost`** `number` - **`ebayshippinginternational1cost`** `number` - **`ebayshippinginternational1cutofftime`** `string` - **`ebayshippinginternational1handling`** `string` - **`ebayshippinginternational1insurancecost`** `number` - **`ebayshippinginternational1location`** `string` - **`ebayshippinginternational1service`** `string` - **`ebayshippinginternational2additionalcost`** `number` - **`ebayshippinginternational2cost`** `number` - **`ebayshippinginternational2cutofftime`** `string` - **`ebayshippinginternational2handling`** `string` - **`ebayshippinginternational2insurancecost`** `number` - **`ebayshippinginternational2location`** `string` - **`ebayshippinginternational2service`** `string` - **`ebayshippinginternational3additionalcost`** `number` - **`ebayshippinginternational3cost`** `number` - **`ebayshippinginternational3cutofftime`** `string` - **`ebayshippinginternational3handling`** `string` - **`ebayshippinginternational3insurancecost`** `number` - **`ebayshippinginternational3location`** `string` - **`ebayshippinginternational3service`** `string` - **`ebayshippinginternational4additionalcost`** `number` - **`ebayshippinginternational4cost`** `number` - **`ebayshippinginternational4cutofftime`** `string` - **`ebayshippinginternational4handling`** `string` - **`ebayshippinginternational4insurancecost`** `number` - **`ebayshippinginternational4location`** `string` - **`ebayshippinginternational4service`** `string` - **`ebayshippinginternational5additionalcost`** `number` - **`ebayshippinginternational5cost`** `number` - **`ebayshippinginternational5cutofftime`** `string` - **`ebayshippinginternational5handling`** `string` - **`ebayshippinginternational5insurancecost`** `number` - **`ebayshippinginternational5location`** `string` - **`ebayshippinginternational5service`** `string` - **`ebayshippingprofileid`** `string` - **`ebayshippingratetabledom`** `string` - **`ebayshippingratetableintl`** `string` - **`ebayshippingtype`** `string` - **`ebayshiptolocations`** `string` - **`ebaysiteid`** `string` - **`ebaysiteshipping`** `string` - **`ebayskip`** `string` - **`ebaysku`** `string` - **`ebaystarttime`** `string` - **`ebaystoreid`** `string` - **`ebaystoreid2`** `string` - **`ebaysubtitle`** `string` - **`ebaytaxcategory`** `string` - **`ebaytemplate`** `string` - **`ebaytitle`** `string` - **`ebayupcnot`** `string` - **`etsycategoryid`** `string` - **`etsydescription`** `string` - **`etsyiscustomizable`** `string` - **`etsyissupply`** `string` - **`etsylistingid`** `string` - **`etsymaterials`** `string` - **`etsynontaxable`** `string` - **`etsyoccasion`** `string` - **`etsyoptions`** `object` - **`category_id`** `string` - **`description`** `string` - **`is_customizable`** `string` - **`is_supply`** `string` - **`materials`** `string` - **`non_taxable`** `string` - **`occasion`** `string` - **`opts_listing_id`** `string` - **`price`** `string` - **`recipient`** `string` - **`shipping_template_id`** `string` - **`shop_section_id`** `string` - **`skip`** `string` - **`state`** `string` - **`title`** `string` - **`variant_keys`** `string` - **`when_made`** `string` - **`who_made`** `string` - **`etsyoptslistingid`** `string` - **`etsyprice`** `string` - **`etsyrecipient`** `string` - **`etsyshippingtemplateid`** `string` - **`etsyshopsectionid`** `string` - **`etsyskip`** `string` - **`etsystate`** `string` - **`etsytitle`** `string` - **`etsyvariantkeys`** `string` - **`etsywhenmade`** `string` - **`etsywhomade`** `string` - **`exportlabel`** `string` - **`featured`** `string` - **`flavor`** `string` - **`floormatlogo`** `string` - **`fulfillmentlatency`** `string` - **`galleryuri`** `string` - **`geolocation`** `string` - **`googlecategory`** `string` - **`googleshopping`** `string` - **`googleshopurl`** `string` - **`guid`** `string` - **`guidad`** `string` - **`handlingfee`** `string` - **`hosierysize`** `string` - **`htmltitle`** `string` - **`id`** `string` - **`importfield`** `string` - **`inseam`** `string` - **`internationalshipping1`** `string` - **`intimatessleepsizewomens`** `string` - **`isbn`** `string` - **`iskit`** `string` - **`iskit_calculated_cost`** `boolean` - **`iskit_calculated_price`** `boolean` - **`jacketlength`** `string` - **`jacketsize`** `string` - **`keywords`** `string` - **`longdescription`** `string` - **`magento2attributeset`** `string` - **`magento2categories`** `string` - **`magento2description`** `string` - **`magento2listingid`** `string` - **`magento2metadescription`** `string` - **`magento2metakeyword`** `string` - **`magento2metatitle`** `string` - **`magento2name`** `string` - **`magento2oldlistingid`** `string` - **`magento2oldsku`** `string` - **`magento2options`** `object` - **`attribute_set`** `string` - **`price`** `string` - **`tax_class_id`** `string` - **`magento2parentsku`** `string` - **`magento2price`** `string` - **`magento2shortdescription`** `string` - **`magento2skip`** `string` - **`magento2sku`** `string` - **`magento2storepath`** `string` - **`magento2taxclassid`** `string` - **`magento2urlkey`** `string` - **`magento2urlpath`** `string` - **`magentoattributeset`** `string` - **`magentocategories`** `string` - **`magentodescription`** `string` - **`magentolistingid`** `string` - **`magentometadescription`** `string` - **`magentometakeyword`** `string` - **`magentometatitle`** `string` - **`magentoname`** `string` - **`magentooldlistingid`** `string` - **`magentooldsku`** `string` - **`magentooptions`** `object` - **`attribute_set`** `string` - **`categories`** `string` - **`description`** `string` - **`meta_description`** `string` - **`meta_keyword`** `string` - **`meta_title`** `string` - **`name`** `string` - **`old_listing_id`** `string` - **`old_sku`** `string` - **`parent_sku`** `string` - **`price`** `string` - **`short_description`** `string` - **`skip`** `string` - **`store_path`** `string` - **`tax_class_id`** `string` - **`url_key`** `string` - **`url_path`** `string` - **`magentoparentsku`** `string` - **`magentoprice`** `string` - **`magentoshortdescription`** `string` - **`magentoskip`** `string` - **`magentosku`** `string` - **`magentostorepath`** `string` - **`magentotaxclassid`** `string` - **`magentourlkey`** `string` - **`magentourlpath`** `string` - **`manufacturer`** `string` - **`manufacturerpartnumber`** `string` - **`mapprice`** `string` - **`material`** `string` - **`maxstock`** `string` - **`media1`** `string` - **`media10`** `string` - **`media10alttext`** `string` - **`media11alttext`** `string` - **`media1alttext`** `string` - **`media2`** `string` - **`media2alttext`** `string` - **`media3`** `string` - **`media3alttext`** `string` - **`media4`** `string` - **`media4alttext`** `string` - **`media5`** `string` - **`media5alttext`** `string` - **`media6`** `string` - **`media6alttext`** `string` - **`media7`** `string` - **`media7alttext`** `string` - **`media8`** `string` - **`media8alttext`** `string` - **`media9`** `string` - **`media9alttext`** `string` - **`mediacount`** `string` - **`mediax`** `string` - **`metadescription`** `string` - **`metal`** `string` - **`meyersku`** `string` - **`meyerstock`** `string` - **`minstock`** `string` - **`model`** `string` - **`modelnumber`** `string` - **`mpn`** `string` - **`msrp`** `string` - **`name`** `string` - **`nameofnewfield`** `string` - **`newbccffield1`** `string` - **`notes`** `string` - **`numberofitems`** `string` - **`packagequantity`** `string` - **`parenturi`** `string` - **`pl20160304001`** `string` - **`pl20160304003`** `string` - **`preexistingcustomarc005`** `string` - **`price`** `string` - **`productshippingtemplate`** `string` - **`producttaxcode`** `string` - **`producttype`** `string` - **`registeredparameter`** `string` - **`releasedate`** `string` - **`ringsize`** `string` - **`rule`** `string` - **`shelfdescription`** `string` - **`shipping`** `string` - **`shippingadditional`** `string` - **`size`** `string` - **`sizemens`** `string` - **`sizetype`** `string` - **`sizewomens`** `string` - **`sku`** `string` - **`skuvaultbrand`** `string` - **`skuvaultclassification`** `string` - **`skuvaultcode`** `string` - **`skuvaultcost`** `string` - **`skuvaultdescription`** `string` - **`skuvaultiskit`** `string` - **`skuvaultislisted`** `string` - **`skuvaultlocationinfo`** `string` - **`skuvaultoptions`** `object` - **`Brand`** `string` - **`Classification`** `string` - **`Code`** `string` - **`Cost`** `string` - **`Description`** `string` - **`iskit`** `string` - **`isListed`** `string` - **`locationInfo`** `string` - **`PartNumber`** `string` - **`QuantityAvailable`** `string` - **`RetailPrice`** `string` - **`SalePrice`** `string` - **`skip`** `string` - **`Supplier`** `string` - **`skuvaultpartnumber`** `string` - **`skuvaultquantityavailable`** `string` - **`skuvaultretailprice`** `string` - **`skuvaultsaleprice`** `string` - **`skuvaultskip`** `string` - **`skuvaultsku`** `string` - **`skuvaultsupplier`** `string` - **`sleevelength`** `string` - **`socksize`** `string` - **`state`** `string` - **`status`** `string` - **`stock`** `string` - **`style`** `string` - **`tags`** `string` - **`test`** `string` - **`test2`** `string` - **`testfield3`** `string` - **`testx1`** `string` - **`threadcolor`** `string` - **`title`** `string` - **`total_stock`** `string` - **`totalsold`** `string` - **`transamericansku`** `string` - **`transamericanstock`** `string` - **`tx1`** `string` - **`tx10`** `string` - **`tx11`** `string` - **`tx12`** `string` - **`tx13`** `string` - **`tx3`** `string` - **`type`** `string` - **`upc`** `string` - **`updatenotes`** `string` - **`updatereason`** `string` - **`uri`** `string` - **`usertype`** `string` - **`userupc`** `string` - **`usshoesizemens`** `string` - **`usshoesizewomens`** `string` - **`variationtheme`** `string` - **`vendorstock`** `string` - **`waistsize`** `string` - **`walmartcategory`** `string` - **`walmartdescription`** `string` - **`walmartenqueued`** `string` - **`walmartinprogress`** `string` - **`walmartislisted`** `string` - **`walmartmedia`** `string` - **`walmartname`** `string` - **`walmartoptions`** `object` - **`category`** `string` - **`description`** `string` - **`enqueued`** `string` - **`media`** `string` - **`name`** `string` - **`price`** `string` - **`skip`** `string` - **`url`** `string` - **`walmartprice`** `string` - **`walmartskip`** `string` - **`walmartsku`** `string` - **`walmartstatus`** `string` - **`walmarturl`** `string` - **`warranty`** `string` - **`weight`** `string` - **`wmcategory`** `string` - **`wmtaxcode`** `string` - **`working`** `string` - **`itemid`** `string` - **`media`** `string` - **`price`** `string` - **`quantity`** `string` - **`sku`** `string` - **`source`** `string` - **`title`** `string` - **`weight`** `string` - **`itemtotal`** `string` - **`meta`** `array` **Items:** `string` - **`oid`** `string` - **`oidconsolidate`** `string` - **`order`** `string` - **`ordernumber`** `string` - **`payment`** `string` - **`paymentdate`** `string` - **`paymentstatus`** `string` - **`refunds`** `array` **Items:** `string` - **`shipments`** `array` **Items:** - **`shipcarrier`** `string` - **`shipcost`** `string` - **`shipdate`** `string` - **`shipdetails`** `array` **Items:** `string` - **`shipid`** `string` - **`shipservice`** `string` - **`shiptracking`** `string` - **`shipuser`** `string` - **`shipping`** `object` - **`city`** `string` - **`company`** `string` - **`country`** `string` - **`firstname`** `string` - **`lastname`** `string` - **`middlename`** `string` - **`phone`** `string` - **`phone2`** `string` - **`postalcode`** `string` - **`stateprovince`** `string` - **`street1`** `string` - **`street2`** `string` - **`street3`** `string` - **`shippingcarrier`** `string` - **`shippingservice`** `string` - **`shippingstatus`** `string` - **`shippingtotal`** `string` - **`status`** `string` - **`taxtotal`** `string` - **`total`** `string` - **`transactionid`** `string` - **`timestamp`** `string` **Example:** ```json { "count": "1", "orders": [ { "account": null, "archived": "0", "billing": { "city": "New York", "company": "", "country": "US", "firstname": "Test", "lastname": "User", "middlename": "", "phone": "877-773-6755", "phone2": "", "postalcode": "10010", "stateprovince": "NY", "street1": "115 E 23rd St", "street2": "FL 3", "street3": "" }, "channel": "custom", "comments": "Please ship all packages in one box.", "correlationid": "", "currency": "USD", "date": "2018-06-27 13:38:25", "dateupdated": "2018-06-27 13:38:25", "dateupdatedutc": "2018-06-27 13:38:25", "dateutc": "2018-06-27 13:38:25", "details": { "currency": [ "USD" ], "deliver-by-earliest": [ "2018-07-03 07:00:00" ], "deliver-by-latest": [ "2018-07-07 06:59:59" ], "handling": [ 0 ], "itemfee": [ "1.58" ], "ship-by-earliest": [ "2018-06-28 07:00:00" ], "ship-by-latest": [ "2018-06-29 06:59:59" ], "shipping": [ 0 ], "shipservice": [ "Standard" ], "shiptax": [ 0 ], "tax": [ 0 ] }, "discountcode": "", "discounttotal": "0.00", "email": "demo@suredone.com", "gift": "0", "handlingtotal": "0.00", "instance": "0", "internalnotes": { "2018-08-11T16:22:49": "This is a great customer" }, "ip": "", "items": [ { "boxheight": "0.50", "boxlength": "1.00", "boxwidth": "2.50", "dimweight": "1.56", "itemdetails": { "order-item-id": "30090115962746", "product": { "tags": "", "active": "0", "actualcost": "219.99", "amzn2asin": "", "amzn2category": "0", "amzn2categorypath": "", "amzn2currency": "", "amzn2fba": "", "amzn2itemtype": "0", "amzn2options": null, "amzn2parentbrand": "", "amzn2parentbullets": "", "amzn2parentdescription": "", "amzn2parentimage": "", "amzn2parenttitle": "", "amzn2price": "0.00", "amzn2search": "", "amzn2skip": "", "amzn2sku": "", "amzn2status": "", "amzn2title": "", "amzn3asin": "", "amzn3category": "0", "amzn3categorypath": "", "amzn3currency": "", "amzn3fba": "", "amzn3itemtype": "0", "amzn3options": null, "amzn3parentbrand": "", "amzn3parentbullets": "", "amzn3parentdescription": "", "amzn3parentimage": "", "amzn3parenttitle": "", "amzn3price": "0.00", "amzn3search": "", "amzn3skip": "", "amzn3sku": "", "amzn3status": "", "amzn3title": "", "amznasin": "", "amzncategory": "0", "amzncategorypath": "", "amzncurrency": "", "amznfba": "{\"status\":\"switch_off\",\"fulfillment_center\":\"\"}", "amznitemtype": "0", "amznoptions": { "categorypath": "", "parentbrand": "", "parentbullets": "", "parentdescription": "", "parentimage": "", "parenttitle": "", "skip": "alwaysSend" }, "amznparentbrand": "", "amznparentbullets": "", "amznparentdescription": "", "amznparentimage": "", "amznparenttitle": "", "amznprice": "0.00", "amznsearch": "", "amznskip": "alwaysSend", "amznsku": "", "amznstatus": "", "amzntitle": "", "asset": "", "atest3": "", "bandsize": "", "bccf1": "", "bccustom1": "", "bccustom10": "", "bccustom11": "", "bccustom12": "", "bccustom13": "", "bccustom14": "", "bccustom15": "", "bccustom16": "", "bccustom17": "", "bccustom2": "", "bccustom3": "", "bccustom4": "", "bccustom5": "", "bccustom6": "", "bccustom7": "", "bccustom8": "", "bccustom9": "", "bcf1": "", "bcnewcf1": "", "bcnewcf2": "", "bcnewcf3": "", "bcnewcf4": "", "bcnewcf5": "", "bcnewcf6": "", "bcnewcf7": "", "bcnewcfa": "", "bcnewcfb": "", "bcnewcfc": "", "bcnewcfd": "", "bcnewcfe": "", "bcnewcff": "", "bcnewcfg": "", "bcnewcfh": "", "bcnewcfi": "", "bctest1": "", "bctest2": "", "bctest3": "", "bctest4": "", "bigcommerce2availability": "", "bigcommerce2availabilitydescription": "", "bigcommerce2avalaraproducttaxcode": "", "bigcommerce2binpickingnumber": "", "bigcommerce2brandid": "", "bigcommerce2calculatedprice": "", "bigcommerce2categories": "", "bigcommerce2configurablefields": "", "bigcommerce2costprice": "", "bigcommerce2customfields": "", "bigcommerce2datecreated": "", "bigcommerce2datelastimported": "", "bigcommerce2description": "", "bigcommerce2discountrules": "", "bigcommerce2downloads": "", "bigcommerce2eventdateend": "", "bigcommerce2eventdatefieldname": "", "bigcommerce2eventdatestart": "", "bigcommerce2eventdatetype": "", "bigcommerce2fixedcostshippingprice": "", "bigcommerce2images": "", "bigcommerce2inventorywarninglevel": "", "bigcommerce2isconditionshown": "", "bigcommerce2isfeatured": "", "bigcommerce2isfreeshipping": "", "bigcommerce2isopengraphthumbnail": "", "bigcommerce2ispreorderonly": "", "bigcommerce2ispricehidden": "", "bigcommerce2keywordfilter": "", "bigcommerce2layoutfile": "", "bigcommerce2listingid": "", "bigcommerce2manageproductrules": "", "bigcommerce2media": "", "bigcommerce2metadescription": "", "bigcommerce2metakeywords": "", "bigcommerce2myobassetaccount": "", "bigcommerce2myobexpenseaccount": "", "bigcommerce2myobincomeaccount": "", "bigcommerce2name": "", "bigcommerce2opengraphdescription": "", "bigcommerce2opengraphtitle": "", "bigcommerce2opengraphtype": "", "bigcommerce2options": null, "bigcommerce2optionsetdisplay": "", "bigcommerce2optionsetid": "", "bigcommerce2orderquantitymaximum": "", "bigcommerce2orderquantityminimum": "", "bigcommerce2pagetitle": "", "bigcommerce2path": "", "bigcommerce2peachtreeglaccount": "", "bigcommerce2preordermessage": "", "bigcommerce2preorderreleasedate": "", "bigcommerce2price": "", "bigcommerce2pricehiddenlabel": "", "bigcommerce2productrule": "", "bigcommerce2ratingcount": "", "bigcommerce2ratingtotal": "", "bigcommerce2relatedproducts": "", "bigcommerce2retailprice": "", "bigcommerce2saleprice": "", "bigcommerce2searchkeywords": "", "bigcommerce2skip": "", "bigcommerce2sku": "", "bigcommerce2skuid": "", "bigcommerce2taxclassid": "", "bigcommerce2totalsold": "", "bigcommerce2type": "", "bigcommerce2url": "", "bigcommerce2videos": "", "bigcommerce2viewcount": "", "bigcommerce2warranty": "", "bigcommerceavailability": "", "bigcommerceavailabilitydescription": "", "bigcommerceavalaraproducttaxcode": "", "bigcommercebinpickingnumber": "", "bigcommercebrandid": "", "bigcommercecalculatedprice": "", "bigcommercecategories": "", "bigcommerceconfigurablefields": "", "bigcommercecostprice": "", "bigcommercecustomfields": "[]", "bigcommercedatecreated": "", "bigcommercedatelastimported": "", "bigcommercedescription": "", "bigcommercediscountrules": "", "bigcommercedownloads": "", "bigcommerceeventdateend": "", "bigcommerceeventdatefieldname": "", "bigcommerceeventdatestart": "", "bigcommerceeventdatetype": "", "bigcommercefixedcostshippingprice": "", "bigcommerceimages": "", "bigcommerceinventorywarninglevel": "", "bigcommerceisconditionshown": "", "bigcommerceisfeatured": "", "bigcommerceisfreeshipping": "", "bigcommerceisopengraphthumbnail": "", "bigcommerceispreorderonly": "", "bigcommerceispricehidden": "", "bigcommercekeywordfilter": "", "bigcommercelayoutfile": "", "bigcommercelistingid": "", "bigcommercemanageproductrules": "", "bigcommercemedia": "", "bigcommercemetadescription": "", "bigcommercemetakeywords": "", "bigcommercemyobassetaccount": "", "bigcommercemyobexpenseaccount": "", "bigcommercemyobincomeaccount": "", "bigcommercename": "", "bigcommerceopengraphdescription": "", "bigcommerceopengraphtitle": "", "bigcommerceopengraphtype": "", "bigcommerceoptions": { "availability": "", "availability_description": "", "avalara_product_tax_code": "", "bin_picking_number": "", "brand_id": "", "calculated_price": "", "categories": "", "configurable_fields": "", "cost_price": "", "custom_fields": [], "date_created": "", "date_last_imported": "", "description": "", "discount_rules": "", "downloads": "", "event_date_end": "", "event_date_field_name": "", "event_date_start": "", "event_date_type": "", "fixed_cost_shipping_price": "", "images": "", "inventory_warning_level": "", "is_condition_shown": "", "is_featured": "", "is_free_shipping": "", "is_open_graph_thumbnail": "", "is_preorder_only": "", "is_price_hidden": "", "keyword_filter": "", "layout_file": "", "manage_product_rules": "", "media": "", "meta_description": "", "meta_keywords": "", "myob_asset_account": "", "myob_expense_account": "", "myob_income_account": "", "name": "", "open_graph_description": "", "open_graph_title": "", "open_graph_type": "", "option_set_display": "", "option_set_id": "", "order_quantity_maximum": "", "order_quantity_minimum": "", "page_title": "", "path": "https://store-988ysg.mybigcommerce.com", "peachtree_gl_account": "", "preorder_message": "", "preorder_release_date": "", "price": "", "price_hidden_label": "", "product_rule": "", "rating_count": "", "rating_total": "", "related_products": "", "retail_price": "", "sale_price": "", "search_keywords": "", "skip": "", "sku_id": "", "tax_class_id": "", "total_sold": "", "type": "", "url": "/products/", "videos": "", "view_count": "", "warranty": "" }, "bigcommerceoptionsetdisplay": "", "bigcommerceoptionsetid": "", "bigcommerceorderquantitymaximum": "", "bigcommerceorderquantityminimum": "", "bigcommercepagetitle": "", "bigcommercepath": "https://store-988ysg.mybigcommerce.com", "bigcommercepeachtreeglaccount": "", "bigcommercepreordermessage": "", "bigcommercepreorderreleasedate": "", "bigcommerceprice": "", "bigcommercepricehiddenlabel": "", "bigcommerceproductrule": "", "bigcommerceratingcount": "", "bigcommerceratingtotal": "", "bigcommercerelatedproducts": "", "bigcommerceretailprice": "", "bigcommercesaleprice": "", "bigcommercesearchkeywords": "", "bigcommerceskip": "", "bigcommercesku": "U8800", "bigcommerceskuid": "", "bigcommercetaxclassid": "", "bigcommercetotalsold": "", "bigcommercetype": "", "bigcommerceurl": "/products/", "bigcommercevideos": "", "bigcommerceviewcount": "", "bigcommercewarranty": "", "boing": "", "bottomssizemens": "", "bottomssizewomens": "", "boxheight": "0.50", "boxlength": "1.00", "boxweight": "0.75", "boxwidth": "2.50", "brand": "AT&T", "bulletpoint1": "", "bulletpoint2": "", "bulletpoint3": "", "bulletpoint4": "", "bulletpoint5": "", "cache": "", "category1": "mobile phones", "category2": "android", "category3": "", "category4": "", "category5": "", "cf010301004": "", "cf020301004": "", "cf030301004": "", "cf040301004": "", "cf1": "", "cf2": "", "cf20160223001": "", "cf20160223002": "", "cf20160223004": "", "cf20160223005": "", "cf20160223007": "", "cf20160223008": "", "cf20160223009": "", "cf20160223010": "", "cf20160223020": "", "cf20160223021": "", "cf3": "", "cf4": "", "cf5": "", "cf6": "", "cf7": "", "cf8": "", "cf9": "", "cfdn1": "", "cfon1": "", "click": "", "clubtype": "", "color": "Black", "colors": "", "condition": "New", "content": "", "cost": "0.00", "countryregionofmanufactur": "", "crazynewstyle": "", "cupsize": "", "customname": "", "cut": "", "date": "2013-07-29 15:06:20", "datesold": "2018-07-18 01:11:40", "dateupdated": "2018-08-05 00:38:50", "deeey": "", "department": "", "description": "Android 2.2 operating system4G speedWi-FiMobile hotspot for up to 5users3.8\" WGA touch screen Requires a minimum data service starting at $15/month Early terminationfees will be prorated, starting at $325 minus $10 for each full month of service commitmentcompleted.", "dimweight": "1.56", "discountprice": "0.00", "domain": "", "dormanstock": "0", "dressshirtsize": "", "ean": "", "ebay2adult": "", "ebay2auctionsrelist": "", "ebay2autopay": "", "ebay2autorelistaction": "", "ebay2autorelistcount": "", "ebay2autorelistduration": "", "ebay2autorelistmax": "", "ebay2autorelistprice": "", "ebay2bestofferautoacceptprice": 0, "ebay2bestofferenabled": "", "ebay2bestofferminimumprice": 0, "ebay2buyitnow": 0, "ebay2catid": "0", "ebay2country": "", "ebay2currency": "", "ebay2description": "", "ebay2dispatch": "", "ebay2duration": "", "ebay2endtime": "", "ebay2fitmentcatalog": "", "ebay2getitfast": "", "ebay2holidayreturn": "", "ebay2id": "0", "ebay2internationalon": "", "ebay2listing": "", "ebay2location": "", "ebay2minimumadvertisedprice": "", "ebay2minimumadvertisedpriceexposure": "", "ebay2options": { "autorelist": { "action": "", "count": "", "duration": "", "max": "", "price": "" }, "bestoffer": { "autoacceptprice": 0, "minimumprice": 0 }, "buyitnow": 0, "country": "", "dispatch": null, "duration": "", "fitmentcatalog": "", "internationalon": "", "listing": "", "location": "", "minimumadvertisedprice": "", "minimumadvertisedpriceexposure": "", "paymentinstructions": "", "paymentmethods": [ "" ], "paymentprofileid": "", "returnprofileid": "", "returns": { "description": "" }, "salestaxpercent": 0, "scheduletime": "", "secondcategory": "", "shipping": { "calculated": { "handlingfee": 0, "internationalhandlingfee": 0, "postalcode": "", "shippingirregular": false, "shippingpackage": "" }, "domestic": { "1": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "2": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "3": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "4": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 } }, "excludes": [ "" ], "international": { "1": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "2": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "3": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "4": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "5": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" } } }, "shippingprofileid": "", "shiptolocations": [ "" ], "siteid": "", "siteshipping": "", "skip": "alwaysSkip", "subtitle": "", "taxcategory": "", "template": "" }, "ebay2paymentinstructions": "", "ebay2paymentmethods": "", "ebay2paymentprofileid": "", "ebay2paypalemailaddress": "", "ebay2prefiliteminfo": "", "ebay2price": "0.00", "ebay2private": "", "ebay2promotionendtime": "", "ebay2promotionstarttime": "", "ebay2returnprofileid": "", "ebay2returnsdescription": "", "ebay2returnsrefund": "", "ebay2returnsrestockingfeevalue": "", "ebay2returnsreturnsaccepted": "", "ebay2returnsreturnswithin": "", "ebay2returnsshippingcostpaidby": "", "ebay2salestaxpercent": 0, "ebay2scheduletime": "", "ebay2secondcategory": "", "ebay2shippingcalculatedhandlingfee": 0, "ebay2shippingcalculatedinternationalhandlingfee": 0, "ebay2shippingcalculatedpostalcode": "", "ebay2shippingcalculatedshippingirregular": false, "ebay2shippingcalculatedshippingpackage": "", "ebay2shippingdomestic1additionalcost": 0, "ebay2shippingdomestic1cost": 0, "ebay2shippingdomestic1cutofftime": "", "ebay2shippingdomestic1expedited": "", "ebay2shippingdomestic1freeshipping": "", "ebay2shippingdomestic1handling": "", "ebay2shippingdomestic1insurancecost": 0, "ebay2shippingdomestic1localpickup": "", "ebay2shippingdomestic1service": "", "ebay2shippingdomestic1surcharge": 0, "ebay2shippingdomestic1timemax": 0, "ebay2shippingdomestic1timemin": 0, "ebay2shippingdomestic2additionalcost": 0, "ebay2shippingdomestic2cost": 0, "ebay2shippingdomestic2cutofftime": "", "ebay2shippingdomestic2expedited": "", "ebay2shippingdomestic2freeshipping": "", "ebay2shippingdomestic2handling": "", "ebay2shippingdomestic2insurancecost": 0, "ebay2shippingdomestic2localpickup": "", "ebay2shippingdomestic2service": "", "ebay2shippingdomestic2surcharge": 0, "ebay2shippingdomestic2timemax": 0, "ebay2shippingdomestic2timemin": 0, "ebay2shippingdomestic3additionalcost": 0, "ebay2shippingdomestic3cost": 0, "ebay2shippingdomestic3cutofftime": "", "ebay2shippingdomestic3expedited": "", "ebay2shippingdomestic3freeshipping": "", "ebay2shippingdomestic3handling": "", "ebay2shippingdomestic3insurancecost": 0, "ebay2shippingdomestic3localpickup": "", "ebay2shippingdomestic3service": "", "ebay2shippingdomestic3surcharge": 0, "ebay2shippingdomestic3timemax": 0, "ebay2shippingdomestic3timemin": 0, "ebay2shippingdomestic4additionalcost": 0, "ebay2shippingdomestic4cost": 0, "ebay2shippingdomestic4cutofftime": "", "ebay2shippingdomestic4expedited": "", "ebay2shippingdomestic4freeshipping": "", "ebay2shippingdomestic4handling": "", "ebay2shippingdomestic4insurancecost": 0, "ebay2shippingdomestic4localpickup": "", "ebay2shippingdomestic4service": "", "ebay2shippingdomestic4surcharge": 0, "ebay2shippingdomestic4timemax": 0, "ebay2shippingdomestic4timemin": 0, "ebay2shippingexcludes": "", "ebay2shippingglobal": "", "ebay2shippingincludedintax": "", "ebay2shippinginternational1additionalcost": 0, "ebay2shippinginternational1cost": 0, "ebay2shippinginternational1cutofftime": "", "ebay2shippinginternational1handling": "", "ebay2shippinginternational1insurancecost": 0, "ebay2shippinginternational1location": "", "ebay2shippinginternational1service": "", "ebay2shippinginternational2additionalcost": 0, "ebay2shippinginternational2cost": 0, "ebay2shippinginternational2cutofftime": "", "ebay2shippinginternational2handling": "", "ebay2shippinginternational2insurancecost": 0, "ebay2shippinginternational2location": "", "ebay2shippinginternational2service": "", "ebay2shippinginternational3additionalcost": 0, "ebay2shippinginternational3cost": 0, "ebay2shippinginternational3cutofftime": "", "ebay2shippinginternational3handling": "", "ebay2shippinginternational3insurancecost": 0, "ebay2shippinginternational3location": "", "ebay2shippinginternational3service": "", "ebay2shippinginternational4additionalcost": 0, "ebay2shippinginternational4cost": 0, "ebay2shippinginternational4cutofftime": "", "ebay2shippinginternational4handling": "", "ebay2shippinginternational4insurancecost": 0, "ebay2shippinginternational4location": "", "ebay2shippinginternational4service": "", "ebay2shippinginternational5additionalcost": 0, "ebay2shippinginternational5cost": 0, "ebay2shippinginternational5cutofftime": "", "ebay2shippinginternational5handling": "", "ebay2shippinginternational5insurancecost": 0, "ebay2shippinginternational5location": "", "ebay2shippinginternational5service": "", "ebay2shippingprofileid": "", "ebay2shippingratetabledom": "", "ebay2shippingratetableintl": "", "ebay2shippingtype": "", "ebay2shiptolocations": "", "ebay2siteid": "", "ebay2siteshipping": "", "ebay2skip": "alwaysSkip", "ebay2sku": "", "ebay2starttime": "", "ebay2storeid": "0", "ebay2storeid2": "0", "ebay2subtitle": "", "ebay2taxcategory": "", "ebay2template": "", "ebay2title": "", "ebay2upcnot": "", "ebay3adult": "", "ebay3auctionsrelist": "", "ebay3autopay": "", "ebay3autorelistaction": "", "ebay3autorelistcount": "", "ebay3autorelistduration": "", "ebay3autorelistmax": "", "ebay3autorelistprice": "", "ebay3bestofferautoacceptprice": 0, "ebay3bestofferenabled": "", "ebay3bestofferminimumprice": 0, "ebay3buyitnow": 0, "ebay3catid": "0", "ebay3country": "", "ebay3currency": "", "ebay3description": "", "ebay3dispatch": "", "ebay3duration": "", "ebay3endtime": "", "ebay3fitmentcatalog": "", "ebay3getitfast": "", "ebay3holidayreturn": "", "ebay3id": "0", "ebay3internationalon": "", "ebay3listing": "", "ebay3location": "", "ebay3minimumadvertisedprice": "", "ebay3minimumadvertisedpriceexposure": "", "ebay3options": { "autorelist": { "action": "", "count": "", "duration": "", "max": "", "price": "" }, "bestoffer": { "autoacceptprice": 0, "minimumprice": 0 }, "buyitnow": 0, "country": "", "dispatch": null, "duration": "", "fitmentcatalog": "", "internationalon": "", "listing": "", "location": "", "minimumadvertisedprice": "", "minimumadvertisedpriceexposure": "", "paymentinstructions": "", "paymentmethods": [ "" ], "paymentprofileid": "", "returnprofileid": "", "returns": { "description": "" }, "salestaxpercent": 0, "scheduletime": "", "secondcategory": "", "shipping": { "calculated": { "handlingfee": 0, "internationalhandlingfee": 0, "postalcode": "", "shippingirregular": false, "shippingpackage": "" }, "domestic": { "1": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "2": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "3": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "4": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 } }, "excludes": [ "" ], "international": { "1": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "2": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "3": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "4": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "5": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" } } }, "shippingprofileid": "", "shiptolocations": [ "" ], "siteid": "", "siteshipping": "", "subtitle": "", "taxcategory": "", "template": "" }, "ebay3paymentinstructions": "", "ebay3paymentmethods": "", "ebay3paymentprofileid": "", "ebay3paypalemailaddress": "", "ebay3prefiliteminfo": "", "ebay3price": "0.00", "ebay3private": "", "ebay3promotionendtime": "", "ebay3promotionstarttime": "", "ebay3returnprofileid": "", "ebay3returnsdescription": "", "ebay3returnsrefund": "", "ebay3returnsrestockingfeevalue": "", "ebay3returnsreturnsaccepted": "", "ebay3returnsreturnswithin": "", "ebay3returnsshippingcostpaidby": "", "ebay3salestaxpercent": 0, "ebay3scheduletime": "", "ebay3secondcategory": "", "ebay3shippingcalculatedhandlingfee": 0, "ebay3shippingcalculatedinternationalhandlingfee": 0, "ebay3shippingcalculatedpostalcode": "", "ebay3shippingcalculatedshippingirregular": false, "ebay3shippingcalculatedshippingpackage": "", "ebay3shippingdomestic1additionalcost": 0, "ebay3shippingdomestic1cost": 0, "ebay3shippingdomestic1cutofftime": "", "ebay3shippingdomestic1expedited": "", "ebay3shippingdomestic1freeshipping": "", "ebay3shippingdomestic1handling": "", "ebay3shippingdomestic1insurancecost": 0, "ebay3shippingdomestic1localpickup": "", "ebay3shippingdomestic1service": "", "ebay3shippingdomestic1surcharge": 0, "ebay3shippingdomestic1timemax": 0, "ebay3shippingdomestic1timemin": 0, "ebay3shippingdomestic2additionalcost": 0, "ebay3shippingdomestic2cost": 0, "ebay3shippingdomestic2cutofftime": "", "ebay3shippingdomestic2expedited": "", "ebay3shippingdomestic2freeshipping": "", "ebay3shippingdomestic2handling": "", "ebay3shippingdomestic2insurancecost": 0, "ebay3shippingdomestic2localpickup": "", "ebay3shippingdomestic2service": "", "ebay3shippingdomestic2surcharge": 0, "ebay3shippingdomestic2timemax": 0, "ebay3shippingdomestic2timemin": 0, "ebay3shippingdomestic3additionalcost": 0, "ebay3shippingdomestic3cost": 0, "ebay3shippingdomestic3cutofftime": "", "ebay3shippingdomestic3expedited": "", "ebay3shippingdomestic3freeshipping": "", "ebay3shippingdomestic3handling": "", "ebay3shippingdomestic3insurancecost": 0, "ebay3shippingdomestic3localpickup": "", "ebay3shippingdomestic3service": "", "ebay3shippingdomestic3surcharge": 0, "ebay3shippingdomestic3timemax": 0, "ebay3shippingdomestic3timemin": 0, "ebay3shippingdomestic4additionalcost": 0, "ebay3shippingdomestic4cost": 0, "ebay3shippingdomestic4cutofftime": "", "ebay3shippingdomestic4expedited": "", "ebay3shippingdomestic4freeshipping": "", "ebay3shippingdomestic4handling": "", "ebay3shippingdomestic4insurancecost": 0, "ebay3shippingdomestic4localpickup": "", "ebay3shippingdomestic4service": "", "ebay3shippingdomestic4surcharge": 0, "ebay3shippingdomestic4timemax": 0, "ebay3shippingdomestic4timemin": 0, "ebay3shippingexcludes": "", "ebay3shippingglobal": "", "ebay3shippingincludedintax": "", "ebay3shippinginternational1additionalcost": 0, "ebay3shippinginternational1cost": 0, "ebay3shippinginternational1cutofftime": "", "ebay3shippinginternational1handling": "", "ebay3shippinginternational1insurancecost": 0, "ebay3shippinginternational1location": "", "ebay3shippinginternational1service": "", "ebay3shippinginternational2additionalcost": 0, "ebay3shippinginternational2cost": 0, "ebay3shippinginternational2cutofftime": "", "ebay3shippinginternational2handling": "", "ebay3shippinginternational2insurancecost": 0, "ebay3shippinginternational2location": "", "ebay3shippinginternational2service": "", "ebay3shippinginternational3additionalcost": 0, "ebay3shippinginternational3cost": 0, "ebay3shippinginternational3cutofftime": "", "ebay3shippinginternational3handling": "", "ebay3shippinginternational3insurancecost": 0, "ebay3shippinginternational3location": "", "ebay3shippinginternational3service": "", "ebay3shippinginternational4additionalcost": 0, "ebay3shippinginternational4cost": 0, "ebay3shippinginternational4cutofftime": "", "ebay3shippinginternational4handling": "", "ebay3shippinginternational4insurancecost": 0, "ebay3shippinginternational4location": "", "ebay3shippinginternational4service": "", "ebay3shippinginternational5additionalcost": 0, "ebay3shippinginternational5cost": 0, "ebay3shippinginternational5cutofftime": "", "ebay3shippinginternational5handling": "", "ebay3shippinginternational5insurancecost": 0, "ebay3shippinginternational5location": "", "ebay3shippinginternational5service": "", "ebay3shippingprofileid": "", "ebay3shippingratetabledom": "", "ebay3shippingratetableintl": "", "ebay3shippingtype": "", "ebay3shiptolocations": "", "ebay3siteid": "", "ebay3siteshipping": "", "ebay3skip": "", "ebay3sku": "", "ebay3starttime": "", "ebay3storeid": "0", "ebay3storeid2": "0", "ebay3subtitle": "", "ebay3taxcategory": "", "ebay3template": "", "ebay3title": "", "ebay3upcnot": "", "ebayadult": "", "ebayauctionsrelist": "", "ebayautopay": "", "ebayautorelistaction": "", "ebayautorelistcount": "", "ebayautorelistduration": "", "ebayautorelistmax": "", "ebayautorelistprice": "", "ebaybestofferautoacceptprice": 0, "ebaybestofferenabled": "", "ebaybestofferminimumprice": 0, "ebaybuyitnow": 0, "ebaycatid": "0", "ebaycountry": "", "ebaycurrency": "", "ebaydescription": "", "ebaydispatch": "", "ebayduration": "", "ebayendtime": "", "ebayepid": "0", "ebayfitmentcatalog": "", "ebaygetitfast": "", "ebayholidayreturn": "", "ebayid": "0", "ebayinternationalon": "", "ebayitemspecificsmapprice": "", "ebayitemspecificswarranty": "", "ebayktype": "", "ebaylisting": "", "ebaylocation": "", "ebayminimumadvertisedprice": "", "ebayminimumadvertisedpriceexposure": "", "ebayoptions": { "autorelist": { "action": "", "count": "", "duration": "", "max": "", "price": "" }, "bestoffer": { "autoacceptprice": 0, "minimumprice": 0 }, "buyitnow": 0, "country": "", "dispatch": null, "duration": "", "fitmentcatalog": "", "internationalon": "", "itemspecifics": [], "listing": "", "location": "", "minimumadvertisedprice": "", "minimumadvertisedpriceexposure": "", "paymentinstructions": "", "paymentmethods": [ "" ], "paymentprofileid": "-1", "returnprofileid": "-1", "returns": { "description": "" }, "salestaxpercent": 0, "scheduletime": "", "secondcategory": "", "shipping": { "calculated": { "handlingfee": 0, "internationalhandlingfee": 0, "postalcode": "", "shippingirregular": false, "shippingpackage": "" }, "domestic": { "1": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "2": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "3": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "4": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 } }, "excludes": [ "" ], "international": { "1": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "2": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "3": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "4": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "5": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" } } }, "shippingprofileid": "-1", "shiptolocations": [ "" ], "siteid": "", "siteshipping": "", "skip": "alwaysSkip", "subtitle": "", "taxcategory": "", "template": "" }, "ebaypaymentinstructions": "", "ebaypaymentmethods": "", "ebaypaymentprofileid": "-1", "ebaypaypalemailaddress": "", "ebayprefiliteminfo": "", "ebayprice": "59.99", "ebayprivate": "", "ebayproductid": "", "ebaypromotionendtime": "", "ebaypromotionstarttime": "", "ebayreturnprofileid": "-1", "ebayreturnsdescription": "", "ebayreturnsrefund": "", "ebayreturnsrestockingfeevalue": "", "ebayreturnsreturnsaccepted": "", "ebayreturnsreturnswithin": "", "ebayreturnsshippingcostpaidby": "", "ebaysalestaxpercent": 0, "ebayscheduletime": "", "ebaysecondcategory": "", "ebayshippingcalculatedhandlingfee": 0, "ebayshippingcalculatedinternationalhandlingfee": 0, "ebayshippingcalculatedpostalcode": "", "ebayshippingcalculatedshippingirregular": false, "ebayshippingcalculatedshippingpackage": "", "ebayshippingdomestic1additionalcost": 0, "ebayshippingdomestic1cost": 0, "ebayshippingdomestic1cutofftime": "", "ebayshippingdomestic1expedited": "", "ebayshippingdomestic1freeshipping": "", "ebayshippingdomestic1handling": "", "ebayshippingdomestic1insurancecost": 0, "ebayshippingdomestic1localpickup": "", "ebayshippingdomestic1service": "", "ebayshippingdomestic1surcharge": 0, "ebayshippingdomestic1timemax": 0, "ebayshippingdomestic1timemin": 0, "ebayshippingdomestic2additionalcost": 0, "ebayshippingdomestic2cost": 0, "ebayshippingdomestic2cutofftime": "", "ebayshippingdomestic2expedited": "", "ebayshippingdomestic2freeshipping": "", "ebayshippingdomestic2handling": "", "ebayshippingdomestic2insurancecost": 0, "ebayshippingdomestic2localpickup": "", "ebayshippingdomestic2service": "", "ebayshippingdomestic2surcharge": 0, "ebayshippingdomestic2timemax": 0, "ebayshippingdomestic2timemin": 0, "ebayshippingdomestic3additionalcost": 0, "ebayshippingdomestic3cost": 0, "ebayshippingdomestic3cutofftime": "", "ebayshippingdomestic3expedited": "", "ebayshippingdomestic3freeshipping": "", "ebayshippingdomestic3handling": "", "ebayshippingdomestic3insurancecost": 0, "ebayshippingdomestic3localpickup": "", "ebayshippingdomestic3service": "", "ebayshippingdomestic3surcharge": 0, "ebayshippingdomestic3timemax": 0, "ebayshippingdomestic3timemin": 0, "ebayshippingdomestic4additionalcost": 0, "ebayshippingdomestic4cost": 0, "ebayshippingdomestic4cutofftime": "", "ebayshippingdomestic4expedited": "", "ebayshippingdomestic4freeshipping": "", "ebayshippingdomestic4handling": "", "ebayshippingdomestic4insurancecost": 0, "ebayshippingdomestic4localpickup": "", "ebayshippingdomestic4service": "", "ebayshippingdomestic4surcharge": 0, "ebayshippingdomestic4timemax": 0, "ebayshippingdomestic4timemin": 0, "ebayshippingexcludes": "", "ebayshippingglobal": "", "ebayshippingincludedintax": "", "ebayshippinginternational1additionalcost": 0, "ebayshippinginternational1cost": 0, "ebayshippinginternational1cutofftime": "", "ebayshippinginternational1handling": "", "ebayshippinginternational1insurancecost": 0, "ebayshippinginternational1location": "", "ebayshippinginternational1service": "", "ebayshippinginternational2additionalcost": 0, "ebayshippinginternational2cost": 0, "ebayshippinginternational2cutofftime": "", "ebayshippinginternational2handling": "", "ebayshippinginternational2insurancecost": 0, "ebayshippinginternational2location": "", "ebayshippinginternational2service": "", "ebayshippinginternational3additionalcost": 0, "ebayshippinginternational3cost": 0, "ebayshippinginternational3cutofftime": "", "ebayshippinginternational3handling": "", "ebayshippinginternational3insurancecost": 0, "ebayshippinginternational3location": "", "ebayshippinginternational3service": "", "ebayshippinginternational4additionalcost": 0, "ebayshippinginternational4cost": 0, "ebayshippinginternational4cutofftime": "", "ebayshippinginternational4handling": "", "ebayshippinginternational4insurancecost": 0, "ebayshippinginternational4location": "", "ebayshippinginternational4service": "", "ebayshippinginternational5additionalcost": 0, "ebayshippinginternational5cost": 0, "ebayshippinginternational5cutofftime": "", "ebayshippinginternational5handling": "", "ebayshippinginternational5insurancecost": 0, "ebayshippinginternational5location": "", "ebayshippinginternational5service": "", "ebayshippingprofileid": "-1", "ebayshippingratetabledom": "", "ebayshippingratetableintl": "", "ebayshippingtype": "", "ebayshiptolocations": "", "ebaysiteid": "", "ebaysiteshipping": "", "ebayskip": "alwaysSkip", "ebaysku": "", "ebaystarttime": "", "ebaystoreid": "0", "ebaystoreid2": "0", "ebaysubtitle": "", "ebaytaxcategory": "", "ebaytemplate": "", "ebaytitle": "", "ebayupcnot": "", "etsycategoryid": "", "etsydescription": "", "etsyiscustomizable": "", "etsyissupply": "", "etsylistingid": "0", "etsymaterials": "", "etsynontaxable": "", "etsyoccasion": "", "etsyoptions": { "category_id": "", "description": "", "is_customizable": "", "is_supply": "", "materials": "", "non_taxable": "", "occasion": "", "opts_listing_id": "", "price": "", "recipient": "", "shipping_template_id": "", "shop_section_id": "", "skip": "", "state": "", "title": "", "variant_keys": "", "when_made": "", "who_made": "" }, "etsyoptslistingid": "", "etsyprice": "", "etsyrecipient": "", "etsyshippingtemplateid": "", "etsyshopsectionid": "", "etsyskip": "", "etsystate": "", "etsytitle": "", "etsyvariantkeys": "", "etsywhenmade": "", "etsywhomade": "", "exportlabel": "", "featured": "0", "flavor": "", "floormatlogo": "", "fulfillmentlatency": "0", "galleryuri": "", "geolocation": "", "googlecategory": "", "googleshopping": "1", "googleshopurl": "", "guid": "U8800", "guidad": "", "handlingfee": "0.00", "hosierysize": "", "htmltitle": "", "id": "1", "importfield": "", "inseam": "", "internationalshipping1": "0.00", "intimatessleepsizewomens": "", "isbn": "", "iskit": "0", "iskit_calculated_cost": false, "iskit_calculated_price": false, "jacketlength": "", "jacketsize": "", "keywords": "", "longdescription": "

Stay connected to friends and family with this mobile phone thatfeatures 4G speed, Wi-Fi and an Android 2.2 operating system for enhanced productivity on the go.The 5.0MP digital camera features a 4x zoom and autofocus for clear photos. Requires a minimumdata service starting at $15/month. Early termination fees will be prorated, starting at $325 minus $10for each full month of service commitment completed.

", "magento2attributeset": "", "magento2categories": "", "magento2description": "", "magento2listingid": "", "magento2metadescription": "", "magento2metakeyword": "", "magento2metatitle": "", "magento2name": "", "magento2oldlistingid": "", "magento2oldsku": "", "magento2options": { "attribute_set": "", "price": "59.99", "tax_class_id": "" }, "magento2parentsku": "", "magento2price": "59.99", "magento2shortdescription": "", "magento2skip": "", "magento2sku": "", "magento2storepath": "", "magento2taxclassid": "", "magento2urlkey": "", "magento2urlpath": "", "magentoattributeset": "", "magentocategories": "", "magentodescription": "", "magentolistingid": "", "magentometadescription": "", "magentometakeyword": "", "magentometatitle": "", "magentoname": "", "magentooldlistingid": "", "magentooldsku": "", "magentooptions": { "attribute_set": "", "categories": "", "description": "", "meta_description": "", "meta_keyword": "", "meta_title": "", "name": "", "old_listing_id": "", "old_sku": "", "parent_sku": "", "price": "", "short_description": "", "skip": "", "store_path": "", "tax_class_id": "", "url_key": "", "url_path": "" }, "magentoparentsku": "", "magentoprice": "", "magentoshortdescription": "", "magentoskip": "", "magentosku": "", "magentostorepath": "", "magentotaxclassid": "", "magentourlkey": "", "magentourlpath": "", "manufacturer": "", "manufacturerpartnumber": "", "mapprice": "0.00", "material": "", "maxstock": "0", "media1": "http://assets.suredone.com/1019/media-pics/u8800-att-impulse-4g-mobile-phone-black.jpg", "media10": "", "media10alttext": "", "media11alttext": "", "media1alttext": "", "media2": "http://assets.suredone.com/1019/media-pics/u8800-att-impulse-4g-mobile-phone-black-2.jpg", "media2alttext": "", "media3": "", "media3alttext": "", "media4": "", "media4alttext": "", "media5": "", "media5alttext": "", "media6": "", "media6alttext": "", "media7": "", "media7alttext": "", "media8": "", "media8alttext": "", "media9": "", "media9alttext": "", "mediacount": "2", "mediax": "", "metadescription": "", "metal": "", "meyersku": "", "meyerstock": "0", "minstock": "0", "model": "", "modelnumber": "", "mpn": "", "msrp": "0.00", "name": "yesatt", "nameofnewfield": "", "newbccffield1": "", "notes": "", "numberofitems": "", "packagequantity": "", "parenturi": "android-smartphones", "pl20160304001": "", "pl20160304003": "", "preexistingcustomarc005": "", "price": "59.99", "productshippingtemplate": "", "producttaxcode": "", "producttype": "", "registeredparameter": "", "releasedate": "", "ringsize": "", "rule": "update", "shelfdescription": "", "shipping": "0.00", "shippingadditional": "0.00", "size": "8gb", "sizemens": "", "sizetype": "", "sizewomens": "", "sku": "U8800", "skuvaultbrand": "", "skuvaultclassification": "", "skuvaultcode": "", "skuvaultcost": "", "skuvaultdescription": "", "skuvaultiskit": "", "skuvaultislisted": "", "skuvaultlocationinfo": "", "skuvaultoptions": { "Brand": "", "Classification": "", "Code": "", "Cost": "", "Description": "", "PartNumber": "", "QuantityAvailable": "", "RetailPrice": "", "SalePrice": "", "Supplier": "", "isListed": "", "iskit": "", "locationInfo": "", "skip": "" }, "skuvaultpartnumber": "", "skuvaultquantityavailable": "", "skuvaultretailprice": "", "skuvaultsaleprice": "", "skuvaultskip": "", "skuvaultsku": "", "skuvaultsupplier": "", "sleevelength": "", "socksize": "", "state": "active", "status": "publish", "stock": "1", "style": "Matte", "test": "", "test2": "", "testfield3": "", "testx1": "", "threadcolor": "", "title": "AT&T Impulse 4G Mobile Phone - Black", "total_stock": "4", "totalsold": "5", "transamericansku": "", "transamericanstock": "0", "tx1": "", "tx10": "", "tx11": "", "tx12": "", "tx13": "", "tx3": "", "type": "", "upc": "", "updatenotes": "", "updatereason": "S*S*S*S*S", "uri": "att-impulse-4g-mobile-phone-black-u8800", "usertype": "", "userupc": "", "usshoesizemens": "", "usshoesizewomens": "", "variationtheme": "", "vendorstock": "3", "waistsize": "", "walmartcategory": "", "walmartdescription": "", "walmartenqueued": "", "walmartinprogress": "0", "walmartislisted": "0", "walmartmedia": "", "walmartname": "", "walmartoptions": { "category": "", "description": "", "enqueued": "", "media": "", "name": "", "price": "", "skip": "", "url": "" }, "walmartprice": "", "walmartskip": "", "walmartsku": "", "walmartstatus": "", "walmarturl": "", "warranty": "", "weight": "0.50", "wmcategory": "", "wmtaxcode": "", "working": "" } }, "itemid": "456", "media": "http://assets.suredone.com/1019/media-pics/u8800-att-impulse-4g-mobile-phone-black.jpg", "price": "13.17", "quantity": "1", "sku": "U8800", "source": "", "title": "mpulse 4G Mobile Phone Case", "weight": "1.00" } ], "itemtotal": "13.17", "meta": [], "oid": "353", "oidconsolidate": "0", "order": "custom12345", "ordernumber": "12345", "payment": "Visa", "paymentdate": "2018-06-27 13:38:25", "paymentstatus": "COMPLETE", "refunds": [], "shipments": [ { "shipcarrier": "FedEx", "shipcost": "0.00", "shipdate": "2018-07-01 00:00:01", "shipdetails": [], "shipid": "49", "shipservice": "", "shiptracking": "9999999999", "shipuser": "" } ], "shipping": { "city": "New York", "company": "", "country": "US", "firstname": "Test", "lastname": "User", "middlename": "", "phone": "877-773-6755", "phone2": "", "postalcode": "10010", "stateprovince": "NY", "street1": "115 E 23rd St", "street2": "FL 3", "street3": "" }, "shippingcarrier": "FedEx", "shippingservice": "Standard", "shippingstatus": "COMPLETE", "shippingtotal": "0.00", "status": "COMPLETE", "taxtotal": "0.00", "total": "13.17", "transactionid": "30090115962746" } ], "timestamp": "2018-08-11T20:04:35Z" } ``` ### Combine orders - **Method:** `POST` - **Path:** `/v3/orders/combine` - **Tags:** Orders Requests | Field | Description | Required | | :------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | oid | database ID, integer Must be supplied as identifier if “order” is not supplied as the identifier. | Yes for combine and split orders | | order | concatenation of “channel” and “ordernumber” which may be used as an identifier. | | | ordernumber | order number, 100 character limit | Yes for create order | | channel | channel where the order was originated, 50 character limit | | | instance | for orders imported via SureDone, the integration instance of the channel | | | details | channel specific order details encoded as JSON such as item fees and delivery estimates | | | date | date of order, converted to timezone configured in user’s SureDone settings | | | dateutc | date or order in UTC | | | dateupdated | last modified date of order, converted to timezone configured in SureDone account | | | oidconsolidate | oid of archived or parent order in split and combined orders respectively | | | gift | whether order was marked as a gift, boolean | | | comments | order comments | | | internalnotes | array of internal notes indexed by date of each note and encoded as JSON, sending in “internalnotesoverwrite” with a non-false value will overwrite all contents of this field | | | status | order status with value one of “INCOMPLETE”, “READY”, “PENDING”, “ORDERED”, “DROPSHIPPED”, “COMPLETE” or “ARCHIVED” | | | transactionid | transaction ID of the order, may correlate to a system identifier required by the channel for fulfilling the order | | | correlationid | correlation ID for the payment of the order | | | payment | payment method of the order | | | paymentdate | date of payment to mark paymentstatus as COMPLETE | | | paymentstatus | payment status with value one of “INCOMPLETE”, “PENDING” or “COMPLETE” | | | shippingcarrier | buyer requested shipping carrier | | | shippingservice | buyer requested shipping service | | | shippingstatus | shipping status with value one of “INCOMPLETE”, “PENDING” or “COMPLETE”, sending “COMPLETE” will mark order as “shipped” on external channels | | | total | order total including all taxes, shipping, handling and discounts | Yes for create order | | itemtotal | total of all order items | | | shippingtotal | total of all shipping costs charged | | | handlingtotal | total of all handling charged | | | taxtotal | total of all taxes charged | | | discounttotal | total of all discounts applied to order | | | discountcode | code used to generate discount, 50 character limit | | | currency | currency code of the order, 10 character limit | | | account | account id of suredone storefront user | | | archived | whether order has been “deleted”, boolean | | | meta | miscellaneous order data JSON encoded including but not limited to raw payloads from channel imports and raw validated addresses | | | email | email of customer | | | billing | address data object for billing contact | | | billing > country | country of billing contact | | | billing > firstname | first name of billing contact | | | billing > middlename | middle name of billing contact | | | billing > lastname | last name of billing contact | | | billing > company | company of billing contact | | | billing > streetl | address street of billing contact | | | billing > street2 | address street 2 of billing contact | | | billing > street3 | address street 3 of billing contact | | | billing > city | city of billing contact | | | billing > stateprovince | state or province of billing contact | | | billing > postalcode | postal code of billing contact | | | billing > phone | phone number of billing contact | | | billing > phone2 | second phone number of billing contact | | | shipping | address data object for shipping contact | | | shipping > country | country of shipping contact | | | shipping > firstname | first name of shipping contact | | | shipping > middlename | middle name of shipping contact | | | shipping > lastname | last name of shipping contact | | | shipping > company | company of shipping contact | | | shipping > streetl | address street of shipping contact | | | shipping > street2 | address street 2 of shipping contact | | | shipping > street3 | address street 3 of shipping contact | | | shipping > city | city of shipping contact | | | shipping > stateprovince | state or province of shipping contact | | | shipping > postalcode | postal code of shipping contact | | | shipping > phone | phone number of shipping contact | | | shipping > phone2 | second phone number of shipping contact | | | items | order items object with one or more items, for products that exist in SureDone the following fields may be populated if they are missing during order creation | Yes for create order | | items > itemid | order item id, required for updating order item data | | | items > sku | order item SKU, for products matching in SureDone this will be the “guid”, 100 character limit | | | items > title | order item title, 500 character limit | | | items > price | order item price | | | items > quantity | order item quantity purchased | | | items > media | order item image URL | | | items > weight | order item weight | | | items > dimweight | order item dim weight | | | items > boxlength | order item box length | | | items > boxwidth | order item box width | | | items > boxheight | order item box height | | | items > source | order item stock (warehouse) source as determined by product stock levels for products that exist in SureDone | | | items > itemdetails | order item details JSON encoded including but not limited to full product payload for products existing in SureDone at the time of order creation | | | items > itemstatus | order item status | | | items > vendor | order item vendor | | | items > purchaseorderid | order item purchase order for vendors and/or erp | | | items > “customfields” | order item custom fields created | | | shipments | order shipments object with one or more shipments | | | shipments > shipid | order shipment id, required when updating an existing shipment post creation | | | shipments > shipcarrier | order shipment carrier | | | shipments > shipservice | order shipment service | | | shipments > shiptracking | order shipment tracking number | | | shipments > shipdate | date of order shipment | | | shipments > shipcost | cost of order shipment | | | shipments > shipuser | user who generated order shipment | | | shipments > shipdetails | order shipment details JSON encoded including but not limited to fulfillment order item data in the case of short shipping | | | shipments > shipdetails > items | order shipment package line item sku and quantity details, supported via API parameters `shipitems` or `shipsku` with `shipquantity`. Example `{"shipments":[{"shiptracking":"123123123123","shipdate":"NOW","shipitems":[{"sku":"U8800ZZZ","quantity":1,"fulfilled":null}]}]}`. Optionally, you may use `shipskufield` and `shipskuvalue` to internally map `shipsku` to an `order.item.sku` via matching where `order.item.itemdetails.product.{shipskufield} = shipskuvalue`. | | | refunds | order refunds object with one or more refunds | | | refunds > refundid | order refund id, required for updating an order refund | | | refunds > refunddate | date of order refund | | | refunds > refunddetails | order refund details JSON encoded | | | refunds > refunddetails > items | order refund line item sku and quantity details, supported via API parameters `refunditems` or `refundsku` with `refundquantity`. | | #### Parameters ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `combineOrders`. `string` #### Responses ##### Status: 200 Combine orders — completed. ###### Content-Type: application/json - **`oid`** `number` - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "oid": 357, "results": { "successful": [ { "code": 1, "message": "Order created successfully!" } ] } } ``` ### Split order - **Method:** `POST` - **Path:** `/v3/orders/split` - **Tags:** Orders Requests | Field | Description | Required | | :------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | oid | database ID, integer Must be supplied as identifier if “order” is not supplied as the identifier. | Yes for combine and split orders | | order | concatenation of “channel” and “ordernumber” which may be used as an identifier. | | | ordernumber | order number, 100 character limit | Yes for create order | | channel | channel where the order was originated, 50 character limit | | | instance | for orders imported via SureDone, the integration instance of the channel | | | details | channel specific order details encoded as JSON such as item fees and delivery estimates | | | date | date of order, converted to timezone configured in user’s SureDone settings | | | dateutc | date or order in UTC | | | dateupdated | last modified date of order, converted to timezone configured in SureDone account | | | oidconsolidate | oid of archived or parent order in split and combined orders respectively | | | gift | whether order was marked as a gift, boolean | | | comments | order comments | | | internalnotes | array of internal notes indexed by date of each note and encoded as JSON, sending in “internalnotesoverwrite” with a non-false value will overwrite all contents of this field | | | status | order status with value one of “INCOMPLETE”, “READY”, “PENDING”, “ORDERED”, “DROPSHIPPED”, “COMPLETE” or “ARCHIVED” | | | transactionid | transaction ID of the order, may correlate to a system identifier required by the channel for fulfilling the order | | | correlationid | correlation ID for the payment of the order | | | payment | payment method of the order | | | paymentdate | date of payment to mark paymentstatus as COMPLETE | | | paymentstatus | payment status with value one of “INCOMPLETE”, “PENDING” or “COMPLETE” | | | shippingcarrier | buyer requested shipping carrier | | | shippingservice | buyer requested shipping service | | | shippingstatus | shipping status with value one of “INCOMPLETE”, “PENDING” or “COMPLETE”, sending “COMPLETE” will mark order as “shipped” on external channels | | | total | order total including all taxes, shipping, handling and discounts | Yes for create order | | itemtotal | total of all order items | | | shippingtotal | total of all shipping costs charged | | | handlingtotal | total of all handling charged | | | taxtotal | total of all taxes charged | | | discounttotal | total of all discounts applied to order | | | discountcode | code used to generate discount, 50 character limit | | | currency | currency code of the order, 10 character limit | | | account | account id of suredone storefront user | | | archived | whether order has been “deleted”, boolean | | | meta | miscellaneous order data JSON encoded including but not limited to raw payloads from channel imports and raw validated addresses | | | email | email of customer | | | billing | address data object for billing contact | | | billing > country | country of billing contact | | | billing > firstname | first name of billing contact | | | billing > middlename | middle name of billing contact | | | billing > lastname | last name of billing contact | | | billing > company | company of billing contact | | | billing > streetl | address street of billing contact | | | billing > street2 | address street 2 of billing contact | | | billing > street3 | address street 3 of billing contact | | | billing > city | city of billing contact | | | billing > stateprovince | state or province of billing contact | | | billing > postalcode | postal code of billing contact | | | billing > phone | phone number of billing contact | | | billing > phone2 | second phone number of billing contact | | | shipping | address data object for shipping contact | | | shipping > country | country of shipping contact | | | shipping > firstname | first name of shipping contact | | | shipping > middlename | middle name of shipping contact | | | shipping > lastname | last name of shipping contact | | | shipping > company | company of shipping contact | | | shipping > streetl | address street of shipping contact | | | shipping > street2 | address street 2 of shipping contact | | | shipping > street3 | address street 3 of shipping contact | | | shipping > city | city of shipping contact | | | shipping > stateprovince | state or province of shipping contact | | | shipping > postalcode | postal code of shipping contact | | | shipping > phone | phone number of shipping contact | | | shipping > phone2 | second phone number of shipping contact | | | items | order items object with one or more items, for products that exist in SureDone the following fields may be populated if they are missing during order creation | Yes for create order | | items > itemid | order item id, required for updating order item data | | | items > sku | order item SKU, for products matching in SureDone this will be the “guid”, 100 character limit | | | items > title | order item title, 500 character limit | | | items > price | order item price | | | items > quantity | order item quantity purchased | | | items > media | order item image URL | | | items > weight | order item weight | | | items > dimweight | order item dim weight | | | items > boxlength | order item box length | | | items > boxwidth | order item box width | | | items > boxheight | order item box height | | | items > source | order item stock (warehouse) source as determined by product stock levels for products that exist in SureDone | | | items > itemdetails | order item details JSON encoded including but not limited to full product payload for products existing in SureDone at the time of order creation | | | items > itemstatus | order item status | | | items > vendor | order item vendor | | | items > purchaseorderid | order item purchase order for vendors and/or erp | | | items > “customfields” | order item custom fields created | | | shipments | order shipments object with one or more shipments | | | shipments > shipid | order shipment id, required when updating an existing shipment post creation | | | shipments > shipcarrier | order shipment carrier | | | shipments > shipservice | order shipment service | | | shipments > shiptracking | order shipment tracking number | | | shipments > shipdate | date of order shipment | | | shipments > shipcost | cost of order shipment | | | shipments > shipuser | user who generated order shipment | | | shipments > shipdetails | order shipment details JSON encoded including but not limited to fulfillment order item data in the case of short shipping | | | shipments > shipdetails > items | order shipment package line item sku and quantity details, supported via API parameters `shipitems` or `shipsku` with `shipquantity`. Example `{"shipments":[{"shiptracking":"123123123123","shipdate":"NOW","shipitems":[{"sku":"U8800ZZZ","quantity":1,"fulfilled":null}]}]}`. Optionally, you may use `shipskufield` and `shipskuvalue` to internally map `shipsku` to an `order.item.sku` via matching where `order.item.itemdetails.product.{shipskufield} = shipskuvalue`. | | | refunds | order refunds object with one or more refunds | | | refunds > refundid | order refund id, required for updating an order refund | | | refunds > refunddate | date of order refund | | | refunds > refunddetails | order refund details JSON encoded | | | refunds > refunddetails > items | order refund line item sku and quantity details, supported via API parameters `refunditems` or `refundsku` with `refundquantity`. | | #### Parameters ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `splitOrder`. `string` #### Responses ##### Status: 200 Split order — completed. ###### Content-Type: application/json - **`results`** `object` - **`failed`** `array` **Items:** - **`message`** `string` **Example:** ```json { "results": { "failed": [ { "message": "Not enough of item to split" } ] } } ``` ### Update order by oid - **Method:** `PATCH` - **Path:** `/v3/orders/{oid}` - **Tags:** Orders Requests Update an existing order by identifier. The `{oid}` path segment accepts either the numeric database OID or the `order` string (channel + channel ordernumber). The same field schema applies for both identifier forms. - Description: Use this update to modify orders including to *mark orders shipped* on marketplaces. To mark orders shipped on channels, ensure the order has a valid shipment with `shiptracking shipcarrier` and `shipdate` - and set `shippingstatus COMPLETE` | Field | Description | Required | | :------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | oid | database ID, integer Must be supplied as identifier if “order” is not supplied as the identifier. | Yes for combine and split orders | | order | concatenation of “channel” and “ordernumber” which may be used as an identifier. | | | ordernumber | order number, 100 character limit | Yes for create order | | channel | channel where the order was originated, 50 character limit | | | instance | for orders imported via SureDone, the integration instance of the channel | | | details | channel specific order details encoded as JSON such as item fees and delivery estimates | | | date | date of order, converted to timezone configured in user’s SureDone settings | | | dateutc | date or order in UTC | | | dateupdated | last modified date of order, converted to timezone configured in SureDone account | | | oidconsolidate | oid of archived or parent order in split and combined orders respectively | | | gift | whether order was marked as a gift, boolean | | | comments | order comments | | | internalnotes | array of internal notes indexed by date of each note and encoded as JSON, sending in “internalnotesoverwrite” with a non-false value will overwrite all contents of this field | | | status | order status with value one of “INCOMPLETE”, “READY”, “PENDING”, “ORDERED”, “DROPSHIPPED”, “COMPLETE” or “ARCHIVED” | | | transactionid | transaction ID of the order, may correlate to a system identifier required by the channel for fulfilling the order | | | correlationid | correlation ID for the payment of the order | | | payment | payment method of the order | | | paymentdate | date of payment to mark paymentstatus as COMPLETE | | | paymentstatus | payment status with value one of “INCOMPLETE”, “PENDING” or “COMPLETE” | | | shippingcarrier | buyer requested shipping carrier | | | shippingservice | buyer requested shipping service | | | shippingstatus | shipping status with value one of “INCOMPLETE”, “PENDING” or “COMPLETE”, sending “COMPLETE” will mark order as “shipped” on external channels | | | total | order total including all taxes, shipping, handling and discounts | Yes for create order | | itemtotal | total of all order items | | | shippingtotal | total of all shipping costs charged | | | handlingtotal | total of all handling charged | | | taxtotal | total of all taxes charged | | | discounttotal | total of all discounts applied to order | | | discountcode | code used to generate discount, 50 character limit | | | currency | currency code of the order, 10 character limit | | | account | account id of suredone storefront user | | | archived | whether order has been “deleted”, boolean | | | meta | miscellaneous order data JSON encoded including but not limited to raw payloads from channel imports and raw validated addresses | | | email | email of customer | | | billing | address data object for billing contact | | | billing > country | country of billing contact | | | billing > firstname | first name of billing contact | | | billing > middlename | middle name of billing contact | | | billing > lastname | last name of billing contact | | | billing > company | company of billing contact | | | billing > streetl | address street of billing contact | | | billing > street2 | address street 2 of billing contact | | | billing > street3 | address street 3 of billing contact | | | billing > city | city of billing contact | | | billing > stateprovince | state or province of billing contact | | | billing > postalcode | postal code of billing contact | | | billing > phone | phone number of billing contact | | | billing > phone2 | second phone number of billing contact | | | shipping | address data object for shipping contact | | | shipping > country | country of shipping contact | | | shipping > firstname | first name of shipping contact | | | shipping > middlename | middle name of shipping contact | | | shipping > lastname | last name of shipping contact | | | shipping > company | company of shipping contact | | | shipping > streetl | address street of shipping contact | | | shipping > street2 | address street 2 of shipping contact | | | shipping > street3 | address street 3 of shipping contact | | | shipping > city | city of shipping contact | | | shipping > stateprovince | state or province of shipping contact | | | shipping > postalcode | postal code of shipping contact | | | shipping > phone | phone number of shipping contact | | | shipping > phone2 | second phone number of shipping contact | | | items | order items object with one or more items, for products that exist in SureDone the following fields may be populated if they are missing during order creation | Yes for create order | | items > itemid | order item id, required for updating order item data | | | items > sku | order item SKU, for products matching in SureDone this will be the “guid”, 100 character limit | | | items > title | order item title, 500 character limit | | | items > price | order item price | | | items > quantity | order item quantity purchased | | | items > media | order item image URL | | | items > weight | order item weight | | | items > dimweight | order item dim weight | | | items > boxlength | order item box length | | | items > boxwidth | order item box width | | | items > boxheight | order item box height | | | items > source | order item stock (warehouse) source as determined by product stock levels for products that exist in SureDone | | | items > itemdetails | order item details JSON encoded including but not limited to full product payload for products existing in SureDone at the time of order creation | | | items > itemstatus | order item status | | | items > vendor | order item vendor | | | items > purchaseorderid | order item purchase order for vendors and/or erp | | | items > “customfields” | order item custom fields created | | | shipments | order shipments object with one or more shipments | | | shipments > shipid | order shipment id, required when updating an existing shipment post creation | | | shipments > shipcarrier | order shipment carrier | | | shipments > shipservice | order shipment service | | | shipments > shiptracking | order shipment tracking number | | | shipments > shipdate | date of order shipment | | | shipments > shipcost | cost of order shipment | | | shipments > shipuser | user who generated order shipment | | | shipments > shipdetails | order shipment details JSON encoded including but not limited to fulfillment order item data in the case of short shipping | | | shipments > shipdetails > items | order shipment package line item sku and quantity details, supported via API parameters `shipitems` or `shipsku` with `shipquantity`. Example `{"shipments":[{"shiptracking":"123123123123","shipdate":"NOW","shipitems":[{"sku":"U8800ZZZ","quantity":1,"fulfilled":null}]}]}`. Optionally, you may use `shipskufield` and `shipskuvalue` to internally map `shipsku` to an `order.item.sku` via matching where `order.item.itemdetails.product.{shipskufield} = shipskuvalue`. | | | refunds | order refunds object with one or more refunds | | | refunds > refundid | order refund id, required for updating an order refund | | | refunds > refunddate | date of order refund | | | refunds > refunddetails | order refund details JSON encoded | | | refunds > refunddetails > items | order refund line item sku and quantity details, supported via API parameters `refunditems` or `refundsku` with `refundquantity`. | | #### Parameters ##### `oid` required - **In:** `path` Order identifier. Accepts either the numeric `oid` (database ID, e.g. `43`) or the customer-facing `order` string formed by concatenating the channel slug and the channel's order number (e.g. `mycustomstoreSD13097689151690`). The server selects between the two by `is_numeric()`. See `src/Orders/Api.php::patch`. `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `updateOrderByOid`. `string` #### Responses ##### Status: 200 Update order by oid — completed. ###### Content-Type: application/json - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "results": { "successful": [ { "code": 2, "message": "Order updated successfully!" } ] } } ``` ### Delete orders - **Method:** `DELETE` - **Path:** `/v3/orders/{oid}` - **Tags:** Orders Requests | Field | Description | Required | | :------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | oid | database ID, integer Must be supplied as identifier if “order” is not supplied as the identifier. | Yes for combine and split orders | | order | concatenation of “channel” and “ordernumber” which may be used as an identifier. | | | ordernumber | order number, 100 character limit | Yes for create order | | channel | channel where the order was originated, 50 character limit | | | instance | for orders imported via SureDone, the integration instance of the channel | | | details | channel specific order details encoded as JSON such as item fees and delivery estimates | | | date | date of order, converted to timezone configured in user’s SureDone settings | | | dateutc | date or order in UTC | | | dateupdated | last modified date of order, converted to timezone configured in SureDone account | | | oidconsolidate | oid of archived or parent order in split and combined orders respectively | | | gift | whether order was marked as a gift, boolean | | | comments | order comments | | | internalnotes | array of internal notes indexed by date of each note and encoded as JSON, sending in “internalnotesoverwrite” with a non-false value will overwrite all contents of this field | | | status | order status with value one of “INCOMPLETE”, “READY”, “PENDING”, “ORDERED”, “DROPSHIPPED”, “COMPLETE” or “ARCHIVED” | | | transactionid | transaction ID of the order, may correlate to a system identifier required by the channel for fulfilling the order | | | correlationid | correlation ID for the payment of the order | | | payment | payment method of the order | | | paymentdate | date of payment to mark paymentstatus as COMPLETE | | | paymentstatus | payment status with value one of “INCOMPLETE”, “PENDING” or “COMPLETE” | | | shippingcarrier | buyer requested shipping carrier | | | shippingservice | buyer requested shipping service | | | shippingstatus | shipping status with value one of “INCOMPLETE”, “PENDING” or “COMPLETE”, sending “COMPLETE” will mark order as “shipped” on external channels | | | total | order total including all taxes, shipping, handling and discounts | Yes for create order | | itemtotal | total of all order items | | | shippingtotal | total of all shipping costs charged | | | handlingtotal | total of all handling charged | | | taxtotal | total of all taxes charged | | | discounttotal | total of all discounts applied to order | | | discountcode | code used to generate discount, 50 character limit | | | currency | currency code of the order, 10 character limit | | | account | account id of suredone storefront user | | | archived | whether order has been “deleted”, boolean | | | meta | miscellaneous order data JSON encoded including but not limited to raw payloads from channel imports and raw validated addresses | | | email | email of customer | | | billing | address data object for billing contact | | | billing > country | country of billing contact | | | billing > firstname | first name of billing contact | | | billing > middlename | middle name of billing contact | | | billing > lastname | last name of billing contact | | | billing > company | company of billing contact | | | billing > streetl | address street of billing contact | | | billing > street2 | address street 2 of billing contact | | | billing > street3 | address street 3 of billing contact | | | billing > city | city of billing contact | | | billing > stateprovince | state or province of billing contact | | | billing > postalcode | postal code of billing contact | | | billing > phone | phone number of billing contact | | | billing > phone2 | second phone number of billing contact | | | shipping | address data object for shipping contact | | | shipping > country | country of shipping contact | | | shipping > firstname | first name of shipping contact | | | shipping > middlename | middle name of shipping contact | | | shipping > lastname | last name of shipping contact | | | shipping > company | company of shipping contact | | | shipping > streetl | address street of shipping contact | | | shipping > street2 | address street 2 of shipping contact | | | shipping > street3 | address street 3 of shipping contact | | | shipping > city | city of shipping contact | | | shipping > stateprovince | state or province of shipping contact | | | shipping > postalcode | postal code of shipping contact | | | shipping > phone | phone number of shipping contact | | | shipping > phone2 | second phone number of shipping contact | | | items | order items object with one or more items, for products that exist in SureDone the following fields may be populated if they are missing during order creation | Yes for create order | | items > itemid | order item id, required for updating order item data | | | items > sku | order item SKU, for products matching in SureDone this will be the “guid”, 100 character limit | | | items > title | order item title, 500 character limit | | | items > price | order item price | | | items > quantity | order item quantity purchased | | | items > media | order item image URL | | | items > weight | order item weight | | | items > dimweight | order item dim weight | | | items > boxlength | order item box length | | | items > boxwidth | order item box width | | | items > boxheight | order item box height | | | items > source | order item stock (warehouse) source as determined by product stock levels for products that exist in SureDone | | | items > itemdetails | order item details JSON encoded including but not limited to full product payload for products existing in SureDone at the time of order creation | | | items > itemstatus | order item status | | | items > vendor | order item vendor | | | items > purchaseorderid | order item purchase order for vendors and/or erp | | | items > “customfields” | order item custom fields created | | | shipments | order shipments object with one or more shipments | | | shipments > shipid | order shipment id, required when updating an existing shipment post creation | | | shipments > shipcarrier | order shipment carrier | | | shipments > shipservice | order shipment service | | | shipments > shiptracking | order shipment tracking number | | | shipments > shipdate | date of order shipment | | | shipments > shipcost | cost of order shipment | | | shipments > shipuser | user who generated order shipment | | | shipments > shipdetails | order shipment details JSON encoded including but not limited to fulfillment order item data in the case of short shipping | | | shipments > shipdetails > items | order shipment package line item sku and quantity details, supported via API parameters `shipitems` or `shipsku` with `shipquantity`. Example `{"shipments":[{"shiptracking":"123123123123","shipdate":"NOW","shipitems":[{"sku":"U8800ZZZ","quantity":1,"fulfilled":null}]}]}`. Optionally, you may use `shipskufield` and `shipskuvalue` to internally map `shipsku` to an `order.item.sku` via matching where `order.item.itemdetails.product.{shipskufield} = shipskuvalue`. | | | refunds | order refunds object with one or more refunds | | | refunds > refundid | order refund id, required for updating an order refund | | | refunds > refunddate | date of order refund | | | refunds > refunddetails | order refund details JSON encoded | | | refunds > refunddetails > items | order refund line item sku and quantity details, supported via API parameters `refunditems` or `refundsku` with `refundquantity`. | | #### Parameters ##### `oid` required - **In:** `path` Order identifier — numeric database OID or the channel order string (channel + ordernumber). `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `deleteOrders`. `string` #### Responses ##### Status: 200 Delete orders — completed. ###### Content-Type: application/json - **`results`** `object` - **`successful`** `array` **Items:** - **`code`** `number` - **`message`** `string` **Example:** ```json { "results": { "successful": [ { "code": 7, "message": "Order archived successfully!" } ] } } ``` ### Get order by oid - **Method:** `GET` - **Path:** `/v3/orders/{oid}` - **Tags:** Orders Requests Retrieve a single order by its numeric database OID or by the customer-facing order string (channel + ordernumber). The handler chooses between the two by `is_numeric()`. #### Parameters ##### `oid` required - **In:** `path` Order identifier — numeric database OID or the channel order string (channel + ordernumber). `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `getOrderByOid`. `string` #### Responses ##### Status: 200 Get order by oid — results returned. ###### Content-Type: application/json - **`count`** `string` - **`orders`** `array` **Items:** - **`account`** `string | null` - **`archived`** `string` - **`billing`** `object` - **`city`** `string` - **`company`** `string` - **`country`** `string` - **`firstname`** `string` - **`lastname`** `string` - **`middlename`** `string` - **`phone`** `string` - **`phone2`** `string` - **`postalcode`** `string` - **`stateprovince`** `string` - **`street1`** `string` - **`street2`** `string` - **`street3`** `string` - **`channel`** `string` - **`comments`** `string` - **`correlationid`** `string` - **`currency`** `string` - **`date`** `string` - **`dateupdated`** `string` - **`dateupdatedutc`** `string` - **`dateutc`** `string` - **`details`** `object` - **`currency`** `array` **Items:** `string` - **`deliver-by-earliest`** `array` **Items:** `string` - **`deliver-by-latest`** `array` **Items:** `string` - **`handling`** `array` **Items:** `number` - **`itemfee`** `array` **Items:** `string` - **`ship-by-earliest`** `array` **Items:** `string` - **`ship-by-latest`** `array` **Items:** `string` - **`shipping`** `array` **Items:** `number` - **`shipservice`** `array` **Items:** `string` - **`shiptax`** `array` **Items:** `number` - **`tax`** `array` **Items:** `number` - **`discountcode`** `string` - **`discounttotal`** `string` - **`email`** `string | null` — Buyer email of record. May be \`null\` on channel orders that do not surface a customer email (e.g. eBay payment-only flows). - **`gift`** `string` - **`handlingtotal`** `string` - **`instance`** `string` - **`internalnotes`** `object` — Map of UTC timestamp string (e.g. \`2018-08-11T16:22:49\`) to the note body. Returned as an empty JSON array (\`\[]\`) when no notes are present — PHP serializes an empty associative array this way. - **`ip`** `string` - **`items`** `array` **Items:** - **`boxheight`** `string` - **`boxlength`** `string` - **`boxwidth`** `string` - **`dimweight`** `string` - **`itemdetails`** `object` - **`order-item-id`** `string` - **`product`** `object` - **`active`** `string` - **`actualcost`** `string` - **`amzn2asin`** `string` - **`amzn2category`** `string` - **`amzn2categorypath`** `string` - **`amzn2currency`** `string` - **`amzn2fba`** `string` - **`amzn2itemtype`** `string` - **`amzn2options`** `object | null` - **`amzn2parentbrand`** `string` - **`amzn2parentbullets`** `string` - **`amzn2parentdescription`** `string` - **`amzn2parentimage`** `string` - **`amzn2parenttitle`** `string` - **`amzn2price`** `string` - **`amzn2search`** `string` - **`amzn2skip`** `string` - **`amzn2sku`** `string` - **`amzn2status`** `string` - **`amzn2title`** `string` - **`amzn3asin`** `string` - **`amzn3category`** `string` - **`amzn3categorypath`** `string` - **`amzn3currency`** `string` - **`amzn3fba`** `string` - **`amzn3itemtype`** `string` - **`amzn3options`** `object | null` - **`amzn3parentbrand`** `string` - **`amzn3parentbullets`** `string` - **`amzn3parentdescription`** `string` - **`amzn3parentimage`** `string` - **`amzn3parenttitle`** `string` - **`amzn3price`** `string` - **`amzn3search`** `string` - **`amzn3skip`** `string` - **`amzn3sku`** `string` - **`amzn3status`** `string` - **`amzn3title`** `string` - **`amznasin`** `string` - **`amzncategory`** `string` - **`amzncategorypath`** `string` - **`amzncurrency`** `string` - **`amznfba`** `string` - **`amznitemtype`** `string` - **`amznoptions`** `object` - **`categorypath`** `string` - **`parentbrand`** `string` - **`parentbullets`** `string` - **`parentdescription`** `string` - **`parentimage`** `string` - **`parenttitle`** `string` - **`skip`** `string` - **`amznparentbrand`** `string` - **`amznparentbullets`** `string` - **`amznparentdescription`** `string` - **`amznparentimage`** `string` - **`amznparenttitle`** `string` - **`amznprice`** `string` - **`amznsearch`** `string` - **`amznskip`** `string` - **`amznsku`** `string` - **`amznstatus`** `string` - **`amzntitle`** `string` - **`asset`** `string` - **`atest3`** `string` - **`bandsize`** `string` - **`bccf1`** `string` - **`bccustom1`** `string` - **`bccustom10`** `string` - **`bccustom11`** `string` - **`bccustom12`** `string` - **`bccustom13`** `string` - **`bccustom14`** `string` - **`bccustom15`** `string` - **`bccustom16`** `string` - **`bccustom17`** `string` - **`bccustom2`** `string` - **`bccustom3`** `string` - **`bccustom4`** `string` - **`bccustom5`** `string` - **`bccustom6`** `string` - **`bccustom7`** `string` - **`bccustom8`** `string` - **`bccustom9`** `string` - **`bcf1`** `string` - **`bcnewcf1`** `string` - **`bcnewcf2`** `string` - **`bcnewcf3`** `string` - **`bcnewcf4`** `string` - **`bcnewcf5`** `string` - **`bcnewcf6`** `string` - **`bcnewcf7`** `string` - **`bcnewcfa`** `string` - **`bcnewcfb`** `string` - **`bcnewcfc`** `string` - **`bcnewcfd`** `string` - **`bcnewcfe`** `string` - **`bcnewcff`** `string` - **`bcnewcfg`** `string` - **`bcnewcfh`** `string` - **`bcnewcfi`** `string` - **`bctest1`** `string` - **`bctest2`** `string` - **`bctest3`** `string` - **`bctest4`** `string` - **`bigcommerce2availability`** `string` - **`bigcommerce2availabilitydescription`** `string` - **`bigcommerce2avalaraproducttaxcode`** `string` - **`bigcommerce2binpickingnumber`** `string` - **`bigcommerce2brandid`** `string` - **`bigcommerce2calculatedprice`** `string` - **`bigcommerce2categories`** `string` - **`bigcommerce2configurablefields`** `string` - **`bigcommerce2costprice`** `string` - **`bigcommerce2customfields`** `string` - **`bigcommerce2datecreated`** `string` - **`bigcommerce2datelastimported`** `string` - **`bigcommerce2description`** `string` - **`bigcommerce2discountrules`** `string` - **`bigcommerce2downloads`** `string` - **`bigcommerce2eventdateend`** `string` - **`bigcommerce2eventdatefieldname`** `string` - **`bigcommerce2eventdatestart`** `string` - **`bigcommerce2eventdatetype`** `string` - **`bigcommerce2fixedcostshippingprice`** `string` - **`bigcommerce2images`** `string` - **`bigcommerce2inventorywarninglevel`** `string` - **`bigcommerce2isconditionshown`** `string` - **`bigcommerce2isfeatured`** `string` - **`bigcommerce2isfreeshipping`** `string` - **`bigcommerce2isopengraphthumbnail`** `string` - **`bigcommerce2ispreorderonly`** `string` - **`bigcommerce2ispricehidden`** `string` - **`bigcommerce2keywordfilter`** `string` - **`bigcommerce2layoutfile`** `string` - **`bigcommerce2listingid`** `string` - **`bigcommerce2manageproductrules`** `string` - **`bigcommerce2media`** `string` - **`bigcommerce2metadescription`** `string` - **`bigcommerce2metakeywords`** `string` - **`bigcommerce2myobassetaccount`** `string` - **`bigcommerce2myobexpenseaccount`** `string` - **`bigcommerce2myobincomeaccount`** `string` - **`bigcommerce2name`** `string` - **`bigcommerce2opengraphdescription`** `string` - **`bigcommerce2opengraphtitle`** `string` - **`bigcommerce2opengraphtype`** `string` - **`bigcommerce2options`** `object | null` - **`bigcommerce2optionsetdisplay`** `string` - **`bigcommerce2optionsetid`** `string` - **`bigcommerce2orderquantitymaximum`** `string` - **`bigcommerce2orderquantityminimum`** `string` - **`bigcommerce2pagetitle`** `string` - **`bigcommerce2path`** `string` - **`bigcommerce2peachtreeglaccount`** `string` - **`bigcommerce2preordermessage`** `string` - **`bigcommerce2preorderreleasedate`** `string` - **`bigcommerce2price`** `string` - **`bigcommerce2pricehiddenlabel`** `string` - **`bigcommerce2productrule`** `string` - **`bigcommerce2ratingcount`** `string` - **`bigcommerce2ratingtotal`** `string` - **`bigcommerce2relatedproducts`** `string` - **`bigcommerce2retailprice`** `string` - **`bigcommerce2saleprice`** `string` - **`bigcommerce2searchkeywords`** `string` - **`bigcommerce2skip`** `string` - **`bigcommerce2sku`** `string` - **`bigcommerce2skuid`** `string` - **`bigcommerce2taxclassid`** `string` - **`bigcommerce2totalsold`** `string` - **`bigcommerce2type`** `string` - **`bigcommerce2url`** `string` - **`bigcommerce2videos`** `string` - **`bigcommerce2viewcount`** `string` - **`bigcommerce2warranty`** `string` - **`bigcommerceavailability`** `string` - **`bigcommerceavailabilitydescription`** `string` - **`bigcommerceavalaraproducttaxcode`** `string` - **`bigcommercebinpickingnumber`** `string` - **`bigcommercebrandid`** `string` - **`bigcommercecalculatedprice`** `string` - **`bigcommercecategories`** `string` - **`bigcommerceconfigurablefields`** `string` - **`bigcommercecostprice`** `string` - **`bigcommercecustomfields`** `string` - **`bigcommercedatecreated`** `string` - **`bigcommercedatelastimported`** `string` - **`bigcommercedescription`** `string` - **`bigcommercediscountrules`** `string` - **`bigcommercedownloads`** `string` - **`bigcommerceeventdateend`** `string` - **`bigcommerceeventdatefieldname`** `string` - **`bigcommerceeventdatestart`** `string` - **`bigcommerceeventdatetype`** `string` - **`bigcommercefixedcostshippingprice`** `string` - **`bigcommerceimages`** `string` - **`bigcommerceinventorywarninglevel`** `string` - **`bigcommerceisconditionshown`** `string` - **`bigcommerceisfeatured`** `string` - **`bigcommerceisfreeshipping`** `string` - **`bigcommerceisopengraphthumbnail`** `string` - **`bigcommerceispreorderonly`** `string` - **`bigcommerceispricehidden`** `string` - **`bigcommercekeywordfilter`** `string` - **`bigcommercelayoutfile`** `string` - **`bigcommercelistingid`** `string` - **`bigcommercemanageproductrules`** `string` - **`bigcommercemedia`** `string` - **`bigcommercemetadescription`** `string` - **`bigcommercemetakeywords`** `string` - **`bigcommercemyobassetaccount`** `string` - **`bigcommercemyobexpenseaccount`** `string` - **`bigcommercemyobincomeaccount`** `string` - **`bigcommercename`** `string` - **`bigcommerceopengraphdescription`** `string` - **`bigcommerceopengraphtitle`** `string` - **`bigcommerceopengraphtype`** `string` - **`bigcommerceoptions`** `object` - **`availability`** `string` - **`availability_description`** `string` - **`avalara_product_tax_code`** `string` - **`bin_picking_number`** `string` - **`brand_id`** `string` - **`calculated_price`** `string` - **`categories`** `string` - **`configurable_fields`** `string` - **`cost_price`** `string` - **`custom_fields`** `array` **Items:** `string` - **`date_created`** `string` - **`date_last_imported`** `string` - **`description`** `string` - **`discount_rules`** `string` - **`downloads`** `string` - **`event_date_end`** `string` - **`event_date_field_name`** `string` - **`event_date_start`** `string` - **`event_date_type`** `string` - **`fixed_cost_shipping_price`** `string` - **`images`** `string` - **`inventory_warning_level`** `string` - **`is_condition_shown`** `string` - **`is_featured`** `string` - **`is_free_shipping`** `string` - **`is_open_graph_thumbnail`** `string` - **`is_preorder_only`** `string` - **`is_price_hidden`** `string` - **`keyword_filter`** `string` - **`layout_file`** `string` - **`manage_product_rules`** `string` - **`media`** `string` - **`meta_description`** `string` - **`meta_keywords`** `string` - **`myob_asset_account`** `string` - **`myob_expense_account`** `string` - **`myob_income_account`** `string` - **`name`** `string` - **`open_graph_description`** `string` - **`open_graph_title`** `string` - **`open_graph_type`** `string` - **`option_set_display`** `string` - **`option_set_id`** `string` - **`order_quantity_maximum`** `string` - **`order_quantity_minimum`** `string` - **`page_title`** `string` - **`path`** `string` - **`peachtree_gl_account`** `string` - **`preorder_message`** `string` - **`preorder_release_date`** `string` - **`price`** `string` - **`price_hidden_label`** `string` - **`product_rule`** `string` - **`rating_count`** `string` - **`rating_total`** `string` - **`related_products`** `string` - **`retail_price`** `string` - **`sale_price`** `string` - **`search_keywords`** `string` - **`skip`** `string` - **`sku_id`** `string` - **`tax_class_id`** `string` - **`total_sold`** `string` - **`type`** `string` - **`url`** `string` - **`videos`** `string` - **`view_count`** `string` - **`warranty`** `string` - **`bigcommerceoptionsetdisplay`** `string` - **`bigcommerceoptionsetid`** `string` - **`bigcommerceorderquantitymaximum`** `string` - **`bigcommerceorderquantityminimum`** `string` - **`bigcommercepagetitle`** `string` - **`bigcommercepath`** `string` - **`bigcommercepeachtreeglaccount`** `string` - **`bigcommercepreordermessage`** `string` - **`bigcommercepreorderreleasedate`** `string` - **`bigcommerceprice`** `string` - **`bigcommercepricehiddenlabel`** `string` - **`bigcommerceproductrule`** `string` - **`bigcommerceratingcount`** `string` - **`bigcommerceratingtotal`** `string` - **`bigcommercerelatedproducts`** `string` - **`bigcommerceretailprice`** `string` - **`bigcommercesaleprice`** `string` - **`bigcommercesearchkeywords`** `string` - **`bigcommerceskip`** `string` - **`bigcommercesku`** `string` - **`bigcommerceskuid`** `string` - **`bigcommercetaxclassid`** `string` - **`bigcommercetotalsold`** `string` - **`bigcommercetype`** `string` - **`bigcommerceurl`** `string` - **`bigcommercevideos`** `string` - **`bigcommerceviewcount`** `string` - **`bigcommercewarranty`** `string` - **`boing`** `string` - **`bottomssizemens`** `string` - **`bottomssizewomens`** `string` - **`boxheight`** `string` - **`boxlength`** `string` - **`boxweight`** `string` - **`boxwidth`** `string` - **`brand`** `string` - **`bulletpoint1`** `string` - **`bulletpoint2`** `string` - **`bulletpoint3`** `string` - **`bulletpoint4`** `string` - **`bulletpoint5`** `string` - **`cache`** `string` - **`category1`** `string` - **`category2`** `string` - **`category3`** `string` - **`category4`** `string` - **`category5`** `string` - **`cf010301004`** `string` - **`cf020301004`** `string` - **`cf030301004`** `string` - **`cf040301004`** `string` - **`cf1`** `string` - **`cf2`** `string` - **`cf20160223001`** `string` - **`cf20160223002`** `string` - **`cf20160223004`** `string` - **`cf20160223005`** `string` - **`cf20160223007`** `string` - **`cf20160223008`** `string` - **`cf20160223009`** `string` - **`cf20160223010`** `string` - **`cf20160223020`** `string` - **`cf20160223021`** `string` - **`cf3`** `string` - **`cf4`** `string` - **`cf5`** `string` - **`cf6`** `string` - **`cf7`** `string` - **`cf8`** `string` - **`cf9`** `string` - **`cfdn1`** `string` - **`cfon1`** `string` - **`click`** `string` - **`clubtype`** `string` - **`color`** `string` - **`colors`** `string` - **`condition`** `string` - **`content`** `string` - **`cost`** `string` - **`countryregionofmanufactur`** `string` - **`crazynewstyle`** `string` - **`cupsize`** `string` - **`customname`** `string` - **`cut`** `string` - **`date`** `string` - **`datesold`** `string` - **`dateupdated`** `string` - **`deeey`** `string` - **`department`** `string` - **`description`** `string` - **`dimweight`** `string` - **`discountprice`** `string` - **`domain`** `string` - **`dormanstock`** `string` - **`dressshirtsize`** `string` - **`ean`** `string` - **`ebay2adult`** `string` - **`ebay2auctionsrelist`** `string` - **`ebay2autopay`** `string` - **`ebay2autorelistaction`** `string` - **`ebay2autorelistcount`** `string` - **`ebay2autorelistduration`** `string` - **`ebay2autorelistmax`** `string` - **`ebay2autorelistprice`** `string` - **`ebay2bestofferautoacceptprice`** `number` - **`ebay2bestofferenabled`** `string` - **`ebay2bestofferminimumprice`** `number` - **`ebay2buyitnow`** `number` - **`ebay2catid`** `string` - **`ebay2country`** `string` - **`ebay2currency`** `string` - **`ebay2description`** `string` - **`ebay2dispatch`** `string` - **`ebay2duration`** `string` - **`ebay2endtime`** `string` - **`ebay2fitmentcatalog`** `string` - **`ebay2getitfast`** `string` - **`ebay2holidayreturn`** `string` - **`ebay2id`** `string` - **`ebay2internationalon`** `string` - **`ebay2listing`** `string` - **`ebay2location`** `string` - **`ebay2minimumadvertisedprice`** `string` - **`ebay2minimumadvertisedpriceexposure`** `string` - **`ebay2options`** `object` - **`autorelist`** `object` - **`action`** `string` - **`count`** `string` - **`duration`** `string` - **`max`** `string` - **`price`** `string` - **`bestoffer`** `object` - **`autoacceptprice`** `number` - **`minimumprice`** `number` - **`buyitnow`** `number` - **`country`** `string` - **`dispatch`** `object | null` - **`duration`** `string` - **`fitmentcatalog`** `string` - **`internationalon`** `string` - **`listing`** `string` - **`location`** `string` - **`minimumadvertisedprice`** `string` - **`minimumadvertisedpriceexposure`** `string` - **`paymentinstructions`** `string` - **`paymentmethods`** `array` **Items:** `string` - **`paymentprofileid`** `string` - **`returnprofileid`** `string` - **`returns`** `object` - **`description`** `string` - **`salestaxpercent`** `number` - **`scheduletime`** `string` - **`secondcategory`** `string` - **`shipping`** `object` - **`calculated`** `object` - **`handlingfee`** `number` - **`internationalhandlingfee`** `number` - **`postalcode`** `string` - **`shippingirregular`** `boolean` - **`shippingpackage`** `string` - **`domestic`** `object` - **`1`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`2`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`3`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`4`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`excludes`** `array` **Items:** `string` - **`international`** `object` - **`1`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`2`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`3`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`4`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`5`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`shippingprofileid`** `string` - **`shiptolocations`** `array` **Items:** `string` - **`siteid`** `string` - **`siteshipping`** `string` - **`skip`** `string` - **`subtitle`** `string` - **`taxcategory`** `string` - **`template`** `string` - **`ebay2paymentinstructions`** `string` - **`ebay2paymentmethods`** `string` - **`ebay2paymentprofileid`** `string` - **`ebay2paypalemailaddress`** `string` - **`ebay2prefiliteminfo`** `string` - **`ebay2price`** `string` - **`ebay2private`** `string` - **`ebay2promotionendtime`** `string` - **`ebay2promotionstarttime`** `string` - **`ebay2returnprofileid`** `string` - **`ebay2returnsdescription`** `string` - **`ebay2returnsrefund`** `string` - **`ebay2returnsrestockingfeevalue`** `string` - **`ebay2returnsreturnsaccepted`** `string` - **`ebay2returnsreturnswithin`** `string` - **`ebay2returnsshippingcostpaidby`** `string` - **`ebay2salestaxpercent`** `number` - **`ebay2scheduletime`** `string` - **`ebay2secondcategory`** `string` - **`ebay2shippingcalculatedhandlingfee`** `number` - **`ebay2shippingcalculatedinternationalhandlingfee`** `number` - **`ebay2shippingcalculatedpostalcode`** `string` - **`ebay2shippingcalculatedshippingirregular`** `boolean` - **`ebay2shippingcalculatedshippingpackage`** `string` - **`ebay2shippingdomestic1additionalcost`** `number` - **`ebay2shippingdomestic1cost`** `number` - **`ebay2shippingdomestic1cutofftime`** `string` - **`ebay2shippingdomestic1expedited`** `string` - **`ebay2shippingdomestic1freeshipping`** `string` - **`ebay2shippingdomestic1handling`** `string` - **`ebay2shippingdomestic1insurancecost`** `number` - **`ebay2shippingdomestic1localpickup`** `string` - **`ebay2shippingdomestic1service`** `string` - **`ebay2shippingdomestic1surcharge`** `number` - **`ebay2shippingdomestic1timemax`** `number` - **`ebay2shippingdomestic1timemin`** `number` - **`ebay2shippingdomestic2additionalcost`** `number` - **`ebay2shippingdomestic2cost`** `number` - **`ebay2shippingdomestic2cutofftime`** `string` - **`ebay2shippingdomestic2expedited`** `string` - **`ebay2shippingdomestic2freeshipping`** `string` - **`ebay2shippingdomestic2handling`** `string` - **`ebay2shippingdomestic2insurancecost`** `number` - **`ebay2shippingdomestic2localpickup`** `string` - **`ebay2shippingdomestic2service`** `string` - **`ebay2shippingdomestic2surcharge`** `number` - **`ebay2shippingdomestic2timemax`** `number` - **`ebay2shippingdomestic2timemin`** `number` - **`ebay2shippingdomestic3additionalcost`** `number` - **`ebay2shippingdomestic3cost`** `number` - **`ebay2shippingdomestic3cutofftime`** `string` - **`ebay2shippingdomestic3expedited`** `string` - **`ebay2shippingdomestic3freeshipping`** `string` - **`ebay2shippingdomestic3handling`** `string` - **`ebay2shippingdomestic3insurancecost`** `number` - **`ebay2shippingdomestic3localpickup`** `string` - **`ebay2shippingdomestic3service`** `string` - **`ebay2shippingdomestic3surcharge`** `number` - **`ebay2shippingdomestic3timemax`** `number` - **`ebay2shippingdomestic3timemin`** `number` - **`ebay2shippingdomestic4additionalcost`** `number` - **`ebay2shippingdomestic4cost`** `number` - **`ebay2shippingdomestic4cutofftime`** `string` - **`ebay2shippingdomestic4expedited`** `string` - **`ebay2shippingdomestic4freeshipping`** `string` - **`ebay2shippingdomestic4handling`** `string` - **`ebay2shippingdomestic4insurancecost`** `number` - **`ebay2shippingdomestic4localpickup`** `string` - **`ebay2shippingdomestic4service`** `string` - **`ebay2shippingdomestic4surcharge`** `number` - **`ebay2shippingdomestic4timemax`** `number` - **`ebay2shippingdomestic4timemin`** `number` - **`ebay2shippingexcludes`** `string` - **`ebay2shippingglobal`** `string` - **`ebay2shippingincludedintax`** `string` - **`ebay2shippinginternational1additionalcost`** `number` - **`ebay2shippinginternational1cost`** `number` - **`ebay2shippinginternational1cutofftime`** `string` - **`ebay2shippinginternational1handling`** `string` - **`ebay2shippinginternational1insurancecost`** `number` - **`ebay2shippinginternational1location`** `string` - **`ebay2shippinginternational1service`** `string` - **`ebay2shippinginternational2additionalcost`** `number` - **`ebay2shippinginternational2cost`** `number` - **`ebay2shippinginternational2cutofftime`** `string` - **`ebay2shippinginternational2handling`** `string` - **`ebay2shippinginternational2insurancecost`** `number` - **`ebay2shippinginternational2location`** `string` - **`ebay2shippinginternational2service`** `string` - **`ebay2shippinginternational3additionalcost`** `number` - **`ebay2shippinginternational3cost`** `number` - **`ebay2shippinginternational3cutofftime`** `string` - **`ebay2shippinginternational3handling`** `string` - **`ebay2shippinginternational3insurancecost`** `number` - **`ebay2shippinginternational3location`** `string` - **`ebay2shippinginternational3service`** `string` - **`ebay2shippinginternational4additionalcost`** `number` - **`ebay2shippinginternational4cost`** `number` - **`ebay2shippinginternational4cutofftime`** `string` - **`ebay2shippinginternational4handling`** `string` - **`ebay2shippinginternational4insurancecost`** `number` - **`ebay2shippinginternational4location`** `string` - **`ebay2shippinginternational4service`** `string` - **`ebay2shippinginternational5additionalcost`** `number` - **`ebay2shippinginternational5cost`** `number` - **`ebay2shippinginternational5cutofftime`** `string` - **`ebay2shippinginternational5handling`** `string` - **`ebay2shippinginternational5insurancecost`** `number` - **`ebay2shippinginternational5location`** `string` - **`ebay2shippinginternational5service`** `string` - **`ebay2shippingprofileid`** `string` - **`ebay2shippingratetabledom`** `string` - **`ebay2shippingratetableintl`** `string` - **`ebay2shippingtype`** `string` - **`ebay2shiptolocations`** `string` - **`ebay2siteid`** `string` - **`ebay2siteshipping`** `string` - **`ebay2skip`** `string` - **`ebay2sku`** `string` - **`ebay2starttime`** `string` - **`ebay2storeid`** `string` - **`ebay2storeid2`** `string` - **`ebay2subtitle`** `string` - **`ebay2taxcategory`** `string` - **`ebay2template`** `string` - **`ebay2title`** `string` - **`ebay2upcnot`** `string` - **`ebay3adult`** `string` - **`ebay3auctionsrelist`** `string` - **`ebay3autopay`** `string` - **`ebay3autorelistaction`** `string` - **`ebay3autorelistcount`** `string` - **`ebay3autorelistduration`** `string` - **`ebay3autorelistmax`** `string` - **`ebay3autorelistprice`** `string` - **`ebay3bestofferautoacceptprice`** `number` - **`ebay3bestofferenabled`** `string` - **`ebay3bestofferminimumprice`** `number` - **`ebay3buyitnow`** `number` - **`ebay3catid`** `string` - **`ebay3country`** `string` - **`ebay3currency`** `string` - **`ebay3description`** `string` - **`ebay3dispatch`** `string` - **`ebay3duration`** `string` - **`ebay3endtime`** `string` - **`ebay3fitmentcatalog`** `string` - **`ebay3getitfast`** `string` - **`ebay3holidayreturn`** `string` - **`ebay3id`** `string` - **`ebay3internationalon`** `string` - **`ebay3listing`** `string` - **`ebay3location`** `string` - **`ebay3minimumadvertisedprice`** `string` - **`ebay3minimumadvertisedpriceexposure`** `string` - **`ebay3options`** `object` - **`autorelist`** `object` - **`action`** `string` - **`count`** `string` - **`duration`** `string` - **`max`** `string` - **`price`** `string` - **`bestoffer`** `object` - **`autoacceptprice`** `number` - **`minimumprice`** `number` - **`buyitnow`** `number` - **`country`** `string` - **`dispatch`** `object | null` - **`duration`** `string` - **`fitmentcatalog`** `string` - **`internationalon`** `string` - **`listing`** `string` - **`location`** `string` - **`minimumadvertisedprice`** `string` - **`minimumadvertisedpriceexposure`** `string` - **`paymentinstructions`** `string` - **`paymentmethods`** `array` **Items:** `string` - **`paymentprofileid`** `string` - **`returnprofileid`** `string` - **`returns`** `object` - **`description`** `string` - **`salestaxpercent`** `number` - **`scheduletime`** `string` - **`secondcategory`** `string` - **`shipping`** `object` - **`calculated`** `object` - **`handlingfee`** `number` - **`internationalhandlingfee`** `number` - **`postalcode`** `string` - **`shippingirregular`** `boolean` - **`shippingpackage`** `string` - **`domestic`** `object` - **`1`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`2`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`3`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`4`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`excludes`** `array` **Items:** `string` - **`international`** `object` - **`1`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`2`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`3`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`4`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`5`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`shippingprofileid`** `string` - **`shiptolocations`** `array` **Items:** `string` - **`siteid`** `string` - **`siteshipping`** `string` - **`subtitle`** `string` - **`taxcategory`** `string` - **`template`** `string` - **`ebay3paymentinstructions`** `string` - **`ebay3paymentmethods`** `string` - **`ebay3paymentprofileid`** `string` - **`ebay3paypalemailaddress`** `string` - **`ebay3prefiliteminfo`** `string` - **`ebay3price`** `string` - **`ebay3private`** `string` - **`ebay3promotionendtime`** `string` - **`ebay3promotionstarttime`** `string` - **`ebay3returnprofileid`** `string` - **`ebay3returnsdescription`** `string` - **`ebay3returnsrefund`** `string` - **`ebay3returnsrestockingfeevalue`** `string` - **`ebay3returnsreturnsaccepted`** `string` - **`ebay3returnsreturnswithin`** `string` - **`ebay3returnsshippingcostpaidby`** `string` - **`ebay3salestaxpercent`** `number` - **`ebay3scheduletime`** `string` - **`ebay3secondcategory`** `string` - **`ebay3shippingcalculatedhandlingfee`** `number` - **`ebay3shippingcalculatedinternationalhandlingfee`** `number` - **`ebay3shippingcalculatedpostalcode`** `string` - **`ebay3shippingcalculatedshippingirregular`** `boolean` - **`ebay3shippingcalculatedshippingpackage`** `string` - **`ebay3shippingdomestic1additionalcost`** `number` - **`ebay3shippingdomestic1cost`** `number` - **`ebay3shippingdomestic1cutofftime`** `string` - **`ebay3shippingdomestic1expedited`** `string` - **`ebay3shippingdomestic1freeshipping`** `string` - **`ebay3shippingdomestic1handling`** `string` - **`ebay3shippingdomestic1insurancecost`** `number` - **`ebay3shippingdomestic1localpickup`** `string` - **`ebay3shippingdomestic1service`** `string` - **`ebay3shippingdomestic1surcharge`** `number` - **`ebay3shippingdomestic1timemax`** `number` - **`ebay3shippingdomestic1timemin`** `number` - **`ebay3shippingdomestic2additionalcost`** `number` - **`ebay3shippingdomestic2cost`** `number` - **`ebay3shippingdomestic2cutofftime`** `string` - **`ebay3shippingdomestic2expedited`** `string` - **`ebay3shippingdomestic2freeshipping`** `string` - **`ebay3shippingdomestic2handling`** `string` - **`ebay3shippingdomestic2insurancecost`** `number` - **`ebay3shippingdomestic2localpickup`** `string` - **`ebay3shippingdomestic2service`** `string` - **`ebay3shippingdomestic2surcharge`** `number` - **`ebay3shippingdomestic2timemax`** `number` - **`ebay3shippingdomestic2timemin`** `number` - **`ebay3shippingdomestic3additionalcost`** `number` - **`ebay3shippingdomestic3cost`** `number` - **`ebay3shippingdomestic3cutofftime`** `string` - **`ebay3shippingdomestic3expedited`** `string` - **`ebay3shippingdomestic3freeshipping`** `string` - **`ebay3shippingdomestic3handling`** `string` - **`ebay3shippingdomestic3insurancecost`** `number` - **`ebay3shippingdomestic3localpickup`** `string` - **`ebay3shippingdomestic3service`** `string` - **`ebay3shippingdomestic3surcharge`** `number` - **`ebay3shippingdomestic3timemax`** `number` - **`ebay3shippingdomestic3timemin`** `number` - **`ebay3shippingdomestic4additionalcost`** `number` - **`ebay3shippingdomestic4cost`** `number` - **`ebay3shippingdomestic4cutofftime`** `string` - **`ebay3shippingdomestic4expedited`** `string` - **`ebay3shippingdomestic4freeshipping`** `string` - **`ebay3shippingdomestic4handling`** `string` - **`ebay3shippingdomestic4insurancecost`** `number` - **`ebay3shippingdomestic4localpickup`** `string` - **`ebay3shippingdomestic4service`** `string` - **`ebay3shippingdomestic4surcharge`** `number` - **`ebay3shippingdomestic4timemax`** `number` - **`ebay3shippingdomestic4timemin`** `number` - **`ebay3shippingexcludes`** `string` - **`ebay3shippingglobal`** `string` - **`ebay3shippingincludedintax`** `string` - **`ebay3shippinginternational1additionalcost`** `number` - **`ebay3shippinginternational1cost`** `number` - **`ebay3shippinginternational1cutofftime`** `string` - **`ebay3shippinginternational1handling`** `string` - **`ebay3shippinginternational1insurancecost`** `number` - **`ebay3shippinginternational1location`** `string` - **`ebay3shippinginternational1service`** `string` - **`ebay3shippinginternational2additionalcost`** `number` - **`ebay3shippinginternational2cost`** `number` - **`ebay3shippinginternational2cutofftime`** `string` - **`ebay3shippinginternational2handling`** `string` - **`ebay3shippinginternational2insurancecost`** `number` - **`ebay3shippinginternational2location`** `string` - **`ebay3shippinginternational2service`** `string` - **`ebay3shippinginternational3additionalcost`** `number` - **`ebay3shippinginternational3cost`** `number` - **`ebay3shippinginternational3cutofftime`** `string` - **`ebay3shippinginternational3handling`** `string` - **`ebay3shippinginternational3insurancecost`** `number` - **`ebay3shippinginternational3location`** `string` - **`ebay3shippinginternational3service`** `string` - **`ebay3shippinginternational4additionalcost`** `number` - **`ebay3shippinginternational4cost`** `number` - **`ebay3shippinginternational4cutofftime`** `string` - **`ebay3shippinginternational4handling`** `string` - **`ebay3shippinginternational4insurancecost`** `number` - **`ebay3shippinginternational4location`** `string` - **`ebay3shippinginternational4service`** `string` - **`ebay3shippinginternational5additionalcost`** `number` - **`ebay3shippinginternational5cost`** `number` - **`ebay3shippinginternational5cutofftime`** `string` - **`ebay3shippinginternational5handling`** `string` - **`ebay3shippinginternational5insurancecost`** `number` - **`ebay3shippinginternational5location`** `string` - **`ebay3shippinginternational5service`** `string` - **`ebay3shippingprofileid`** `string` - **`ebay3shippingratetabledom`** `string` - **`ebay3shippingratetableintl`** `string` - **`ebay3shippingtype`** `string` - **`ebay3shiptolocations`** `string` - **`ebay3siteid`** `string` - **`ebay3siteshipping`** `string` - **`ebay3skip`** `string` - **`ebay3sku`** `string` - **`ebay3starttime`** `string` - **`ebay3storeid`** `string` - **`ebay3storeid2`** `string` - **`ebay3subtitle`** `string` - **`ebay3taxcategory`** `string` - **`ebay3template`** `string` - **`ebay3title`** `string` - **`ebay3upcnot`** `string` - **`ebayadult`** `string` - **`ebayauctionsrelist`** `string` - **`ebayautopay`** `string` - **`ebayautorelistaction`** `string` - **`ebayautorelistcount`** `string` - **`ebayautorelistduration`** `string` - **`ebayautorelistmax`** `string` - **`ebayautorelistprice`** `string` - **`ebaybestofferautoacceptprice`** `number` - **`ebaybestofferenabled`** `string` - **`ebaybestofferminimumprice`** `number` - **`ebaybuyitnow`** `number` - **`ebaycatid`** `string` - **`ebaycountry`** `string` - **`ebaycurrency`** `string` - **`ebaydescription`** `string` - **`ebaydispatch`** `string` - **`ebayduration`** `string` - **`ebayendtime`** `string` - **`ebayepid`** `string` - **`ebayfitmentcatalog`** `string` - **`ebaygetitfast`** `string` - **`ebayholidayreturn`** `string` - **`ebayid`** `string` - **`ebayinternationalon`** `string` - **`ebayitemspecificsmapprice`** `string` - **`ebayitemspecificswarranty`** `string` - **`ebayktype`** `string` - **`ebaylisting`** `string` - **`ebaylocation`** `string` - **`ebayminimumadvertisedprice`** `string` - **`ebayminimumadvertisedpriceexposure`** `string` - **`ebayoptions`** `object` - **`autorelist`** `object` - **`action`** `string` - **`count`** `string` - **`duration`** `string` - **`max`** `string` - **`price`** `string` - **`bestoffer`** `object` - **`autoacceptprice`** `number` - **`minimumprice`** `number` - **`buyitnow`** `number` - **`country`** `string` - **`dispatch`** `object | null` - **`duration`** `string` - **`fitmentcatalog`** `string` - **`internationalon`** `string` - **`itemspecifics`** `array` **Items:** `string` - **`listing`** `string` - **`location`** `string` - **`minimumadvertisedprice`** `string` - **`minimumadvertisedpriceexposure`** `string` - **`paymentinstructions`** `string` - **`paymentmethods`** `array` **Items:** `string` - **`paymentprofileid`** `string` - **`returnprofileid`** `string` - **`returns`** `object` - **`description`** `string` - **`salestaxpercent`** `number` - **`scheduletime`** `string` - **`secondcategory`** `string` - **`shipping`** `object` - **`calculated`** `object` - **`handlingfee`** `number` - **`internationalhandlingfee`** `number` - **`postalcode`** `string` - **`shippingirregular`** `boolean` - **`shippingpackage`** `string` - **`domestic`** `object` - **`1`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`2`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`3`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`4`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`service`** `string` - **`surcharge`** `number` - **`timemax`** `number` - **`timemin`** `number` - **`excludes`** `array` **Items:** `string` - **`international`** `object` - **`1`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`2`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`3`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`4`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`5`** `object` - **`additionalcost`** `number` - **`cost`** `number` - **`insurancecost`** `number` - **`location`** `string` - **`service`** `string` - **`shippingprofileid`** `string` - **`shiptolocations`** `array` **Items:** `string` - **`siteid`** `string` - **`siteshipping`** `string` - **`skip`** `string` - **`subtitle`** `string` - **`taxcategory`** `string` - **`template`** `string` - **`ebaypaymentinstructions`** `string` - **`ebaypaymentmethods`** `string` - **`ebaypaymentprofileid`** `string` - **`ebaypaypalemailaddress`** `string` - **`ebayprefiliteminfo`** `string` - **`ebayprice`** `string` - **`ebayprivate`** `string` - **`ebayproductid`** `string` - **`ebaypromotionendtime`** `string` - **`ebaypromotionstarttime`** `string` - **`ebayreturnprofileid`** `string` - **`ebayreturnsdescription`** `string` - **`ebayreturnsrefund`** `string` - **`ebayreturnsrestockingfeevalue`** `string` - **`ebayreturnsreturnsaccepted`** `string` - **`ebayreturnsreturnswithin`** `string` - **`ebayreturnsshippingcostpaidby`** `string` - **`ebaysalestaxpercent`** `number` - **`ebayscheduletime`** `string` - **`ebaysecondcategory`** `string` - **`ebayshippingcalculatedhandlingfee`** `number` - **`ebayshippingcalculatedinternationalhandlingfee`** `number` - **`ebayshippingcalculatedpostalcode`** `string` - **`ebayshippingcalculatedshippingirregular`** `boolean` - **`ebayshippingcalculatedshippingpackage`** `string` - **`ebayshippingdomestic1additionalcost`** `number` - **`ebayshippingdomestic1cost`** `number` - **`ebayshippingdomestic1cutofftime`** `string` - **`ebayshippingdomestic1expedited`** `string` - **`ebayshippingdomestic1freeshipping`** `string` - **`ebayshippingdomestic1handling`** `string` - **`ebayshippingdomestic1insurancecost`** `number` - **`ebayshippingdomestic1localpickup`** `string` - **`ebayshippingdomestic1service`** `string` - **`ebayshippingdomestic1surcharge`** `number` - **`ebayshippingdomestic1timemax`** `number` - **`ebayshippingdomestic1timemin`** `number` - **`ebayshippingdomestic2additionalcost`** `number` - **`ebayshippingdomestic2cost`** `number` - **`ebayshippingdomestic2cutofftime`** `string` - **`ebayshippingdomestic2expedited`** `string` - **`ebayshippingdomestic2freeshipping`** `string` - **`ebayshippingdomestic2handling`** `string` - **`ebayshippingdomestic2insurancecost`** `number` - **`ebayshippingdomestic2localpickup`** `string` - **`ebayshippingdomestic2service`** `string` - **`ebayshippingdomestic2surcharge`** `number` - **`ebayshippingdomestic2timemax`** `number` - **`ebayshippingdomestic2timemin`** `number` - **`ebayshippingdomestic3additionalcost`** `number` - **`ebayshippingdomestic3cost`** `number` - **`ebayshippingdomestic3cutofftime`** `string` - **`ebayshippingdomestic3expedited`** `string` - **`ebayshippingdomestic3freeshipping`** `string` - **`ebayshippingdomestic3handling`** `string` - **`ebayshippingdomestic3insurancecost`** `number` - **`ebayshippingdomestic3localpickup`** `string` - **`ebayshippingdomestic3service`** `string` - **`ebayshippingdomestic3surcharge`** `number` - **`ebayshippingdomestic3timemax`** `number` - **`ebayshippingdomestic3timemin`** `number` - **`ebayshippingdomestic4additionalcost`** `number` - **`ebayshippingdomestic4cost`** `number` - **`ebayshippingdomestic4cutofftime`** `string` - **`ebayshippingdomestic4expedited`** `string` - **`ebayshippingdomestic4freeshipping`** `string` - **`ebayshippingdomestic4handling`** `string` - **`ebayshippingdomestic4insurancecost`** `number` - **`ebayshippingdomestic4localpickup`** `string` - **`ebayshippingdomestic4service`** `string` - **`ebayshippingdomestic4surcharge`** `number` - **`ebayshippingdomestic4timemax`** `number` - **`ebayshippingdomestic4timemin`** `number` - **`ebayshippingexcludes`** `string` - **`ebayshippingglobal`** `string` - **`ebayshippingincludedintax`** `string` - **`ebayshippinginternational1additionalcost`** `number` - **`ebayshippinginternational1cost`** `number` - **`ebayshippinginternational1cutofftime`** `string` - **`ebayshippinginternational1handling`** `string` - **`ebayshippinginternational1insurancecost`** `number` - **`ebayshippinginternational1location`** `string` - **`ebayshippinginternational1service`** `string` - **`ebayshippinginternational2additionalcost`** `number` - **`ebayshippinginternational2cost`** `number` - **`ebayshippinginternational2cutofftime`** `string` - **`ebayshippinginternational2handling`** `string` - **`ebayshippinginternational2insurancecost`** `number` - **`ebayshippinginternational2location`** `string` - **`ebayshippinginternational2service`** `string` - **`ebayshippinginternational3additionalcost`** `number` - **`ebayshippinginternational3cost`** `number` - **`ebayshippinginternational3cutofftime`** `string` - **`ebayshippinginternational3handling`** `string` - **`ebayshippinginternational3insurancecost`** `number` - **`ebayshippinginternational3location`** `string` - **`ebayshippinginternational3service`** `string` - **`ebayshippinginternational4additionalcost`** `number` - **`ebayshippinginternational4cost`** `number` - **`ebayshippinginternational4cutofftime`** `string` - **`ebayshippinginternational4handling`** `string` - **`ebayshippinginternational4insurancecost`** `number` - **`ebayshippinginternational4location`** `string` - **`ebayshippinginternational4service`** `string` - **`ebayshippinginternational5additionalcost`** `number` - **`ebayshippinginternational5cost`** `number` - **`ebayshippinginternational5cutofftime`** `string` - **`ebayshippinginternational5handling`** `string` - **`ebayshippinginternational5insurancecost`** `number` - **`ebayshippinginternational5location`** `string` - **`ebayshippinginternational5service`** `string` - **`ebayshippingprofileid`** `string` - **`ebayshippingratetabledom`** `string` - **`ebayshippingratetableintl`** `string` - **`ebayshippingtype`** `string` - **`ebayshiptolocations`** `string` - **`ebaysiteid`** `string` - **`ebaysiteshipping`** `string` - **`ebayskip`** `string` - **`ebaysku`** `string` - **`ebaystarttime`** `string` - **`ebaystoreid`** `string` - **`ebaystoreid2`** `string` - **`ebaysubtitle`** `string` - **`ebaytaxcategory`** `string` - **`ebaytemplate`** `string` - **`ebaytitle`** `string` - **`ebayupcnot`** `string` - **`etsycategoryid`** `string` - **`etsydescription`** `string` - **`etsyiscustomizable`** `string` - **`etsyissupply`** `string` - **`etsylistingid`** `string` - **`etsymaterials`** `string` - **`etsynontaxable`** `string` - **`etsyoccasion`** `string` - **`etsyoptions`** `object` - **`category_id`** `string` - **`description`** `string` - **`is_customizable`** `string` - **`is_supply`** `string` - **`materials`** `string` - **`non_taxable`** `string` - **`occasion`** `string` - **`opts_listing_id`** `string` - **`price`** `string` - **`recipient`** `string` - **`shipping_template_id`** `string` - **`shop_section_id`** `string` - **`skip`** `string` - **`state`** `string` - **`title`** `string` - **`variant_keys`** `string` - **`when_made`** `string` - **`who_made`** `string` - **`etsyoptslistingid`** `string` - **`etsyprice`** `string` - **`etsyrecipient`** `string` - **`etsyshippingtemplateid`** `string` - **`etsyshopsectionid`** `string` - **`etsyskip`** `string` - **`etsystate`** `string` - **`etsytitle`** `string` - **`etsyvariantkeys`** `string` - **`etsywhenmade`** `string` - **`etsywhomade`** `string` - **`exportlabel`** `string` - **`featured`** `string` - **`flavor`** `string` - **`floormatlogo`** `string` - **`fulfillmentlatency`** `string` - **`galleryuri`** `string` - **`geolocation`** `string` - **`googlecategory`** `string` - **`googleshopping`** `string` - **`googleshopurl`** `string` - **`guid`** `string` - **`guidad`** `string` - **`handlingfee`** `string` - **`hosierysize`** `string` - **`htmltitle`** `string` - **`id`** `string` - **`importfield`** `string` - **`inseam`** `string` - **`internationalshipping1`** `string` - **`intimatessleepsizewomens`** `string` - **`isbn`** `string` - **`iskit`** `string` - **`iskit_calculated_cost`** `boolean` - **`iskit_calculated_price`** `boolean` - **`jacketlength`** `string` - **`jacketsize`** `string` - **`keywords`** `string` - **`longdescription`** `string` - **`magento2attributeset`** `string` - **`magento2categories`** `string` - **`magento2description`** `string` - **`magento2listingid`** `string` - **`magento2metadescription`** `string` - **`magento2metakeyword`** `string` - **`magento2metatitle`** `string` - **`magento2name`** `string` - **`magento2oldlistingid`** `string` - **`magento2oldsku`** `string` - **`magento2options`** `object` - **`attribute_set`** `string` - **`price`** `string` - **`tax_class_id`** `string` - **`magento2parentsku`** `string` - **`magento2price`** `string` - **`magento2shortdescription`** `string` - **`magento2skip`** `string` - **`magento2sku`** `string` - **`magento2storepath`** `string` - **`magento2taxclassid`** `string` - **`magento2urlkey`** `string` - **`magento2urlpath`** `string` - **`magentoattributeset`** `string` - **`magentocategories`** `string` - **`magentodescription`** `string` - **`magentolistingid`** `string` - **`magentometadescription`** `string` - **`magentometakeyword`** `string` - **`magentometatitle`** `string` - **`magentoname`** `string` - **`magentooldlistingid`** `string` - **`magentooldsku`** `string` - **`magentooptions`** `object` - **`attribute_set`** `string` - **`categories`** `string` - **`description`** `string` - **`meta_description`** `string` - **`meta_keyword`** `string` - **`meta_title`** `string` - **`name`** `string` - **`old_listing_id`** `string` - **`old_sku`** `string` - **`parent_sku`** `string` - **`price`** `string` - **`short_description`** `string` - **`skip`** `string` - **`store_path`** `string` - **`tax_class_id`** `string` - **`url_key`** `string` - **`url_path`** `string` - **`magentoparentsku`** `string` - **`magentoprice`** `string` - **`magentoshortdescription`** `string` - **`magentoskip`** `string` - **`magentosku`** `string` - **`magentostorepath`** `string` - **`magentotaxclassid`** `string` - **`magentourlkey`** `string` - **`magentourlpath`** `string` - **`manufacturer`** `string` - **`manufacturerpartnumber`** `string` - **`mapprice`** `string` - **`material`** `string` - **`maxstock`** `string` - **`media1`** `string` - **`media10`** `string` - **`media10alttext`** `string` - **`media11alttext`** `string` - **`media1alttext`** `string` - **`media2`** `string` - **`media2alttext`** `string` - **`media3`** `string` - **`media3alttext`** `string` - **`media4`** `string` - **`media4alttext`** `string` - **`media5`** `string` - **`media5alttext`** `string` - **`media6`** `string` - **`media6alttext`** `string` - **`media7`** `string` - **`media7alttext`** `string` - **`media8`** `string` - **`media8alttext`** `string` - **`media9`** `string` - **`media9alttext`** `string` - **`mediacount`** `string` - **`mediax`** `string` - **`metadescription`** `string` - **`metal`** `string` - **`meyersku`** `string` - **`meyerstock`** `string` - **`minstock`** `string` - **`model`** `string` - **`modelnumber`** `string` - **`mpn`** `string` - **`msrp`** `string` - **`name`** `string` - **`nameofnewfield`** `string` - **`newbccffield1`** `string` - **`notes`** `string` - **`numberofitems`** `string` - **`packagequantity`** `string` - **`parenturi`** `string` - **`pl20160304001`** `string` - **`pl20160304003`** `string` - **`preexistingcustomarc005`** `string` - **`price`** `string` - **`productshippingtemplate`** `string` - **`producttaxcode`** `string` - **`producttype`** `string` - **`registeredparameter`** `string` - **`releasedate`** `string` - **`ringsize`** `string` - **`rule`** `string` - **`shelfdescription`** `string` - **`shipping`** `string` - **`shippingadditional`** `string` - **`size`** `string` - **`sizemens`** `string` - **`sizetype`** `string` - **`sizewomens`** `string` - **`sku`** `string` - **`skuvaultbrand`** `string` - **`skuvaultclassification`** `string` - **`skuvaultcode`** `string` - **`skuvaultcost`** `string` - **`skuvaultdescription`** `string` - **`skuvaultiskit`** `string` - **`skuvaultislisted`** `string` - **`skuvaultlocationinfo`** `string` - **`skuvaultoptions`** `object` - **`Brand`** `string` - **`Classification`** `string` - **`Code`** `string` - **`Cost`** `string` - **`Description`** `string` - **`iskit`** `string` - **`isListed`** `string` - **`locationInfo`** `string` - **`PartNumber`** `string` - **`QuantityAvailable`** `string` - **`RetailPrice`** `string` - **`SalePrice`** `string` - **`skip`** `string` - **`Supplier`** `string` - **`skuvaultpartnumber`** `string` - **`skuvaultquantityavailable`** `string` - **`skuvaultretailprice`** `string` - **`skuvaultsaleprice`** `string` - **`skuvaultskip`** `string` - **`skuvaultsku`** `string` - **`skuvaultsupplier`** `string` - **`sleevelength`** `string` - **`socksize`** `string` - **`state`** `string` - **`status`** `string` - **`stock`** `string` - **`style`** `string` - **`tags`** `string` - **`test`** `string` - **`test2`** `string` - **`testfield3`** `string` - **`testx1`** `string` - **`threadcolor`** `string` - **`title`** `string` - **`total_stock`** `string` - **`totalsold`** `string` - **`transamericansku`** `string` - **`transamericanstock`** `string` - **`tx1`** `string` - **`tx10`** `string` - **`tx11`** `string` - **`tx12`** `string` - **`tx13`** `string` - **`tx3`** `string` - **`type`** `string` - **`upc`** `string` - **`updatenotes`** `string` - **`updatereason`** `string` - **`uri`** `string` - **`usertype`** `string` - **`userupc`** `string` - **`usshoesizemens`** `string` - **`usshoesizewomens`** `string` - **`variationtheme`** `string` - **`vendorstock`** `string` - **`waistsize`** `string` - **`walmartcategory`** `string` - **`walmartdescription`** `string` - **`walmartenqueued`** `string` - **`walmartinprogress`** `string` - **`walmartislisted`** `string` - **`walmartmedia`** `string` - **`walmartname`** `string` - **`walmartoptions`** `object` - **`category`** `string` - **`description`** `string` - **`enqueued`** `string` - **`media`** `string` - **`name`** `string` - **`price`** `string` - **`skip`** `string` - **`url`** `string` - **`walmartprice`** `string` - **`walmartskip`** `string` - **`walmartsku`** `string` - **`walmartstatus`** `string` - **`walmarturl`** `string` - **`warranty`** `string` - **`weight`** `string` - **`wmcategory`** `string` - **`wmtaxcode`** `string` - **`working`** `string` - **`itemid`** `string` - **`media`** `string` - **`price`** `string` - **`quantity`** `string` - **`sku`** `string` - **`source`** `string` - **`title`** `string` - **`weight`** `string` - **`itemtotal`** `string` - **`meta`** `array` **Items:** `string` - **`oid`** `string` - **`oidconsolidate`** `string` - **`order`** `string` - **`ordernumber`** `string` - **`payment`** `string` - **`paymentdate`** `string` - **`paymentstatus`** `string` - **`refunds`** `array` **Items:** `string` - **`shipments`** `array` **Items:** - **`shipcarrier`** `string` - **`shipcost`** `string` - **`shipdate`** `string` - **`shipdetails`** `array` **Items:** `string` - **`shipid`** `string` - **`shipservice`** `string` - **`shiptracking`** `string` - **`shipuser`** `string` - **`shipping`** `object` - **`city`** `string` - **`company`** `string` - **`country`** `string` - **`firstname`** `string` - **`lastname`** `string` - **`middlename`** `string` - **`phone`** `string` - **`phone2`** `string` - **`postalcode`** `string` - **`stateprovince`** `string` - **`street1`** `string` - **`street2`** `string` - **`street3`** `string` - **`shippingcarrier`** `string` - **`shippingservice`** `string` - **`shippingstatus`** `string` - **`shippingtotal`** `string` - **`status`** `string` - **`taxtotal`** `string` - **`total`** `string` - **`transactionid`** `string` - **`timestamp`** `string` **Example:** ```json { "count": "1", "orders": [ { "account": null, "archived": "0", "billing": { "city": "New York", "company": "", "country": "US", "firstname": "Test", "lastname": "User", "middlename": "", "phone": "877-773-6755", "phone2": "", "postalcode": "10010", "stateprovince": "NY", "street1": "115 E 23rd St", "street2": "FL 3", "street3": "" }, "channel": "custom", "comments": "Please ship all packages in one box.", "correlationid": "", "currency": "USD", "date": "2018-06-27 13:38:25", "dateupdated": "2018-06-27 13:38:25", "dateupdatedutc": "2018-06-27 13:38:25", "dateutc": "2018-06-27 13:38:25", "details": { "currency": [ "USD" ], "deliver-by-earliest": [ "2018-07-03 07:00:00" ], "deliver-by-latest": [ "2018-07-07 06:59:59" ], "handling": [ 0 ], "itemfee": [ "1.58" ], "ship-by-earliest": [ "2018-06-28 07:00:00" ], "ship-by-latest": [ "2018-06-29 06:59:59" ], "shipping": [ 0 ], "shipservice": [ "Standard" ], "shiptax": [ 0 ], "tax": [ 0 ] }, "discountcode": "", "discounttotal": "0.00", "email": "demo@suredone.com", "gift": "0", "handlingtotal": "0.00", "instance": "0", "internalnotes": { "2018-08-11T16:22:49": "This is a great customer" }, "ip": "", "items": [ { "boxheight": "0.50", "boxlength": "1.00", "boxwidth": "2.50", "dimweight": "1.56", "itemdetails": { "order-item-id": "30090115962746", "product": { "tags": "", "active": "0", "actualcost": "219.99", "amzn2asin": "", "amzn2category": "0", "amzn2categorypath": "", "amzn2currency": "", "amzn2fba": "", "amzn2itemtype": "0", "amzn2options": null, "amzn2parentbrand": "", "amzn2parentbullets": "", "amzn2parentdescription": "", "amzn2parentimage": "", "amzn2parenttitle": "", "amzn2price": "0.00", "amzn2search": "", "amzn2skip": "", "amzn2sku": "", "amzn2status": "", "amzn2title": "", "amzn3asin": "", "amzn3category": "0", "amzn3categorypath": "", "amzn3currency": "", "amzn3fba": "", "amzn3itemtype": "0", "amzn3options": null, "amzn3parentbrand": "", "amzn3parentbullets": "", "amzn3parentdescription": "", "amzn3parentimage": "", "amzn3parenttitle": "", "amzn3price": "0.00", "amzn3search": "", "amzn3skip": "", "amzn3sku": "", "amzn3status": "", "amzn3title": "", "amznasin": "", "amzncategory": "0", "amzncategorypath": "", "amzncurrency": "", "amznfba": "{\"status\":\"switch_off\",\"fulfillment_center\":\"\"}", "amznitemtype": "0", "amznoptions": { "categorypath": "", "parentbrand": "", "parentbullets": "", "parentdescription": "", "parentimage": "", "parenttitle": "", "skip": "alwaysSend" }, "amznparentbrand": "", "amznparentbullets": "", "amznparentdescription": "", "amznparentimage": "", "amznparenttitle": "", "amznprice": "0.00", "amznsearch": "", "amznskip": "alwaysSend", "amznsku": "", "amznstatus": "", "amzntitle": "", "asset": "", "atest3": "", "bandsize": "", "bccf1": "", "bccustom1": "", "bccustom10": "", "bccustom11": "", "bccustom12": "", "bccustom13": "", "bccustom14": "", "bccustom15": "", "bccustom16": "", "bccustom17": "", "bccustom2": "", "bccustom3": "", "bccustom4": "", "bccustom5": "", "bccustom6": "", "bccustom7": "", "bccustom8": "", "bccustom9": "", "bcf1": "", "bcnewcf1": "", "bcnewcf2": "", "bcnewcf3": "", "bcnewcf4": "", "bcnewcf5": "", "bcnewcf6": "", "bcnewcf7": "", "bcnewcfa": "", "bcnewcfb": "", "bcnewcfc": "", "bcnewcfd": "", "bcnewcfe": "", "bcnewcff": "", "bcnewcfg": "", "bcnewcfh": "", "bcnewcfi": "", "bctest1": "", "bctest2": "", "bctest3": "", "bctest4": "", "bigcommerce2availability": "", "bigcommerce2availabilitydescription": "", "bigcommerce2avalaraproducttaxcode": "", "bigcommerce2binpickingnumber": "", "bigcommerce2brandid": "", "bigcommerce2calculatedprice": "", "bigcommerce2categories": "", "bigcommerce2configurablefields": "", "bigcommerce2costprice": "", "bigcommerce2customfields": "", "bigcommerce2datecreated": "", "bigcommerce2datelastimported": "", "bigcommerce2description": "", "bigcommerce2discountrules": "", "bigcommerce2downloads": "", "bigcommerce2eventdateend": "", "bigcommerce2eventdatefieldname": "", "bigcommerce2eventdatestart": "", "bigcommerce2eventdatetype": "", "bigcommerce2fixedcostshippingprice": "", "bigcommerce2images": "", "bigcommerce2inventorywarninglevel": "", "bigcommerce2isconditionshown": "", "bigcommerce2isfeatured": "", "bigcommerce2isfreeshipping": "", "bigcommerce2isopengraphthumbnail": "", "bigcommerce2ispreorderonly": "", "bigcommerce2ispricehidden": "", "bigcommerce2keywordfilter": "", "bigcommerce2layoutfile": "", "bigcommerce2listingid": "", "bigcommerce2manageproductrules": "", "bigcommerce2media": "", "bigcommerce2metadescription": "", "bigcommerce2metakeywords": "", "bigcommerce2myobassetaccount": "", "bigcommerce2myobexpenseaccount": "", "bigcommerce2myobincomeaccount": "", "bigcommerce2name": "", "bigcommerce2opengraphdescription": "", "bigcommerce2opengraphtitle": "", "bigcommerce2opengraphtype": "", "bigcommerce2options": null, "bigcommerce2optionsetdisplay": "", "bigcommerce2optionsetid": "", "bigcommerce2orderquantitymaximum": "", "bigcommerce2orderquantityminimum": "", "bigcommerce2pagetitle": "", "bigcommerce2path": "", "bigcommerce2peachtreeglaccount": "", "bigcommerce2preordermessage": "", "bigcommerce2preorderreleasedate": "", "bigcommerce2price": "", "bigcommerce2pricehiddenlabel": "", "bigcommerce2productrule": "", "bigcommerce2ratingcount": "", "bigcommerce2ratingtotal": "", "bigcommerce2relatedproducts": "", "bigcommerce2retailprice": "", "bigcommerce2saleprice": "", "bigcommerce2searchkeywords": "", "bigcommerce2skip": "", "bigcommerce2sku": "", "bigcommerce2skuid": "", "bigcommerce2taxclassid": "", "bigcommerce2totalsold": "", "bigcommerce2type": "", "bigcommerce2url": "", "bigcommerce2videos": "", "bigcommerce2viewcount": "", "bigcommerce2warranty": "", "bigcommerceavailability": "", "bigcommerceavailabilitydescription": "", "bigcommerceavalaraproducttaxcode": "", "bigcommercebinpickingnumber": "", "bigcommercebrandid": "", "bigcommercecalculatedprice": "", "bigcommercecategories": "", "bigcommerceconfigurablefields": "", "bigcommercecostprice": "", "bigcommercecustomfields": "[]", "bigcommercedatecreated": "", "bigcommercedatelastimported": "", "bigcommercedescription": "", "bigcommercediscountrules": "", "bigcommercedownloads": "", "bigcommerceeventdateend": "", "bigcommerceeventdatefieldname": "", "bigcommerceeventdatestart": "", "bigcommerceeventdatetype": "", "bigcommercefixedcostshippingprice": "", "bigcommerceimages": "", "bigcommerceinventorywarninglevel": "", "bigcommerceisconditionshown": "", "bigcommerceisfeatured": "", "bigcommerceisfreeshipping": "", "bigcommerceisopengraphthumbnail": "", "bigcommerceispreorderonly": "", "bigcommerceispricehidden": "", "bigcommercekeywordfilter": "", "bigcommercelayoutfile": "", "bigcommercelistingid": "", "bigcommercemanageproductrules": "", "bigcommercemedia": "", "bigcommercemetadescription": "", "bigcommercemetakeywords": "", "bigcommercemyobassetaccount": "", "bigcommercemyobexpenseaccount": "", "bigcommercemyobincomeaccount": "", "bigcommercename": "", "bigcommerceopengraphdescription": "", "bigcommerceopengraphtitle": "", "bigcommerceopengraphtype": "", "bigcommerceoptions": { "availability": "", "availability_description": "", "avalara_product_tax_code": "", "bin_picking_number": "", "brand_id": "", "calculated_price": "", "categories": "", "configurable_fields": "", "cost_price": "", "custom_fields": [], "date_created": "", "date_last_imported": "", "description": "", "discount_rules": "", "downloads": "", "event_date_end": "", "event_date_field_name": "", "event_date_start": "", "event_date_type": "", "fixed_cost_shipping_price": "", "images": "", "inventory_warning_level": "", "is_condition_shown": "", "is_featured": "", "is_free_shipping": "", "is_open_graph_thumbnail": "", "is_preorder_only": "", "is_price_hidden": "", "keyword_filter": "", "layout_file": "", "manage_product_rules": "", "media": "", "meta_description": "", "meta_keywords": "", "myob_asset_account": "", "myob_expense_account": "", "myob_income_account": "", "name": "", "open_graph_description": "", "open_graph_title": "", "open_graph_type": "", "option_set_display": "", "option_set_id": "", "order_quantity_maximum": "", "order_quantity_minimum": "", "page_title": "", "path": "https://store-988ysg.mybigcommerce.com", "peachtree_gl_account": "", "preorder_message": "", "preorder_release_date": "", "price": "", "price_hidden_label": "", "product_rule": "", "rating_count": "", "rating_total": "", "related_products": "", "retail_price": "", "sale_price": "", "search_keywords": "", "skip": "", "sku_id": "", "tax_class_id": "", "total_sold": "", "type": "", "url": "/products/", "videos": "", "view_count": "", "warranty": "" }, "bigcommerceoptionsetdisplay": "", "bigcommerceoptionsetid": "", "bigcommerceorderquantitymaximum": "", "bigcommerceorderquantityminimum": "", "bigcommercepagetitle": "", "bigcommercepath": "https://store-988ysg.mybigcommerce.com", "bigcommercepeachtreeglaccount": "", "bigcommercepreordermessage": "", "bigcommercepreorderreleasedate": "", "bigcommerceprice": "", "bigcommercepricehiddenlabel": "", "bigcommerceproductrule": "", "bigcommerceratingcount": "", "bigcommerceratingtotal": "", "bigcommercerelatedproducts": "", "bigcommerceretailprice": "", "bigcommercesaleprice": "", "bigcommercesearchkeywords": "", "bigcommerceskip": "", "bigcommercesku": "U8800", "bigcommerceskuid": "", "bigcommercetaxclassid": "", "bigcommercetotalsold": "", "bigcommercetype": "", "bigcommerceurl": "/products/", "bigcommercevideos": "", "bigcommerceviewcount": "", "bigcommercewarranty": "", "boing": "", "bottomssizemens": "", "bottomssizewomens": "", "boxheight": "0.50", "boxlength": "1.00", "boxweight": "0.75", "boxwidth": "2.50", "brand": "AT&T", "bulletpoint1": "", "bulletpoint2": "", "bulletpoint3": "", "bulletpoint4": "", "bulletpoint5": "", "cache": "", "category1": "mobile phones", "category2": "android", "category3": "", "category4": "", "category5": "", "cf010301004": "", "cf020301004": "", "cf030301004": "", "cf040301004": "", "cf1": "", "cf2": "", "cf20160223001": "", "cf20160223002": "", "cf20160223004": "", "cf20160223005": "", "cf20160223007": "", "cf20160223008": "", "cf20160223009": "", "cf20160223010": "", "cf20160223020": "", "cf20160223021": "", "cf3": "", "cf4": "", "cf5": "", "cf6": "", "cf7": "", "cf8": "", "cf9": "", "cfdn1": "", "cfon1": "", "click": "", "clubtype": "", "color": "Black", "colors": "", "condition": "New", "content": "", "cost": "0.00", "countryregionofmanufactur": "", "crazynewstyle": "", "cupsize": "", "customname": "", "cut": "", "date": "2013-07-29 15:06:20", "datesold": "2018-07-18 01:11:40", "dateupdated": "2018-08-05 00:38:50", "deeey": "", "department": "", "description": "Android 2.2 operating system4G speedWi-FiMobile hotspot for up to 5users3.8\" WGA touch screen Requires a minimum data service starting at $15/month Early terminationfees will be prorated, starting at $325 minus $10 for each full month of service commitmentcompleted.", "dimweight": "1.56", "discountprice": "0.00", "domain": "", "dormanstock": "0", "dressshirtsize": "", "ean": "", "ebay2adult": "", "ebay2auctionsrelist": "", "ebay2autopay": "", "ebay2autorelistaction": "", "ebay2autorelistcount": "", "ebay2autorelistduration": "", "ebay2autorelistmax": "", "ebay2autorelistprice": "", "ebay2bestofferautoacceptprice": 0, "ebay2bestofferenabled": "", "ebay2bestofferminimumprice": 0, "ebay2buyitnow": 0, "ebay2catid": "0", "ebay2country": "", "ebay2currency": "", "ebay2description": "", "ebay2dispatch": "", "ebay2duration": "", "ebay2endtime": "", "ebay2fitmentcatalog": "", "ebay2getitfast": "", "ebay2holidayreturn": "", "ebay2id": "0", "ebay2internationalon": "", "ebay2listing": "", "ebay2location": "", "ebay2minimumadvertisedprice": "", "ebay2minimumadvertisedpriceexposure": "", "ebay2options": { "autorelist": { "action": "", "count": "", "duration": "", "max": "", "price": "" }, "bestoffer": { "autoacceptprice": 0, "minimumprice": 0 }, "buyitnow": 0, "country": "", "dispatch": null, "duration": "", "fitmentcatalog": "", "internationalon": "", "listing": "", "location": "", "minimumadvertisedprice": "", "minimumadvertisedpriceexposure": "", "paymentinstructions": "", "paymentmethods": [ "" ], "paymentprofileid": "", "returnprofileid": "", "returns": { "description": "" }, "salestaxpercent": 0, "scheduletime": "", "secondcategory": "", "shipping": { "calculated": { "handlingfee": 0, "internationalhandlingfee": 0, "postalcode": "", "shippingirregular": false, "shippingpackage": "" }, "domestic": { "1": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "2": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "3": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "4": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 } }, "excludes": [ "" ], "international": { "1": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "2": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "3": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "4": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "5": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" } } }, "shippingprofileid": "", "shiptolocations": [ "" ], "siteid": "", "siteshipping": "", "skip": "alwaysSkip", "subtitle": "", "taxcategory": "", "template": "" }, "ebay2paymentinstructions": "", "ebay2paymentmethods": "", "ebay2paymentprofileid": "", "ebay2paypalemailaddress": "", "ebay2prefiliteminfo": "", "ebay2price": "0.00", "ebay2private": "", "ebay2promotionendtime": "", "ebay2promotionstarttime": "", "ebay2returnprofileid": "", "ebay2returnsdescription": "", "ebay2returnsrefund": "", "ebay2returnsrestockingfeevalue": "", "ebay2returnsreturnsaccepted": "", "ebay2returnsreturnswithin": "", "ebay2returnsshippingcostpaidby": "", "ebay2salestaxpercent": 0, "ebay2scheduletime": "", "ebay2secondcategory": "", "ebay2shippingcalculatedhandlingfee": 0, "ebay2shippingcalculatedinternationalhandlingfee": 0, "ebay2shippingcalculatedpostalcode": "", "ebay2shippingcalculatedshippingirregular": false, "ebay2shippingcalculatedshippingpackage": "", "ebay2shippingdomestic1additionalcost": 0, "ebay2shippingdomestic1cost": 0, "ebay2shippingdomestic1cutofftime": "", "ebay2shippingdomestic1expedited": "", "ebay2shippingdomestic1freeshipping": "", "ebay2shippingdomestic1handling": "", "ebay2shippingdomestic1insurancecost": 0, "ebay2shippingdomestic1localpickup": "", "ebay2shippingdomestic1service": "", "ebay2shippingdomestic1surcharge": 0, "ebay2shippingdomestic1timemax": 0, "ebay2shippingdomestic1timemin": 0, "ebay2shippingdomestic2additionalcost": 0, "ebay2shippingdomestic2cost": 0, "ebay2shippingdomestic2cutofftime": "", "ebay2shippingdomestic2expedited": "", "ebay2shippingdomestic2freeshipping": "", "ebay2shippingdomestic2handling": "", "ebay2shippingdomestic2insurancecost": 0, "ebay2shippingdomestic2localpickup": "", "ebay2shippingdomestic2service": "", "ebay2shippingdomestic2surcharge": 0, "ebay2shippingdomestic2timemax": 0, "ebay2shippingdomestic2timemin": 0, "ebay2shippingdomestic3additionalcost": 0, "ebay2shippingdomestic3cost": 0, "ebay2shippingdomestic3cutofftime": "", "ebay2shippingdomestic3expedited": "", "ebay2shippingdomestic3freeshipping": "", "ebay2shippingdomestic3handling": "", "ebay2shippingdomestic3insurancecost": 0, "ebay2shippingdomestic3localpickup": "", "ebay2shippingdomestic3service": "", "ebay2shippingdomestic3surcharge": 0, "ebay2shippingdomestic3timemax": 0, "ebay2shippingdomestic3timemin": 0, "ebay2shippingdomestic4additionalcost": 0, "ebay2shippingdomestic4cost": 0, "ebay2shippingdomestic4cutofftime": "", "ebay2shippingdomestic4expedited": "", "ebay2shippingdomestic4freeshipping": "", "ebay2shippingdomestic4handling": "", "ebay2shippingdomestic4insurancecost": 0, "ebay2shippingdomestic4localpickup": "", "ebay2shippingdomestic4service": "", "ebay2shippingdomestic4surcharge": 0, "ebay2shippingdomestic4timemax": 0, "ebay2shippingdomestic4timemin": 0, "ebay2shippingexcludes": "", "ebay2shippingglobal": "", "ebay2shippingincludedintax": "", "ebay2shippinginternational1additionalcost": 0, "ebay2shippinginternational1cost": 0, "ebay2shippinginternational1cutofftime": "", "ebay2shippinginternational1handling": "", "ebay2shippinginternational1insurancecost": 0, "ebay2shippinginternational1location": "", "ebay2shippinginternational1service": "", "ebay2shippinginternational2additionalcost": 0, "ebay2shippinginternational2cost": 0, "ebay2shippinginternational2cutofftime": "", "ebay2shippinginternational2handling": "", "ebay2shippinginternational2insurancecost": 0, "ebay2shippinginternational2location": "", "ebay2shippinginternational2service": "", "ebay2shippinginternational3additionalcost": 0, "ebay2shippinginternational3cost": 0, "ebay2shippinginternational3cutofftime": "", "ebay2shippinginternational3handling": "", "ebay2shippinginternational3insurancecost": 0, "ebay2shippinginternational3location": "", "ebay2shippinginternational3service": "", "ebay2shippinginternational4additionalcost": 0, "ebay2shippinginternational4cost": 0, "ebay2shippinginternational4cutofftime": "", "ebay2shippinginternational4handling": "", "ebay2shippinginternational4insurancecost": 0, "ebay2shippinginternational4location": "", "ebay2shippinginternational4service": "", "ebay2shippinginternational5additionalcost": 0, "ebay2shippinginternational5cost": 0, "ebay2shippinginternational5cutofftime": "", "ebay2shippinginternational5handling": "", "ebay2shippinginternational5insurancecost": 0, "ebay2shippinginternational5location": "", "ebay2shippinginternational5service": "", "ebay2shippingprofileid": "", "ebay2shippingratetabledom": "", "ebay2shippingratetableintl": "", "ebay2shippingtype": "", "ebay2shiptolocations": "", "ebay2siteid": "", "ebay2siteshipping": "", "ebay2skip": "alwaysSkip", "ebay2sku": "", "ebay2starttime": "", "ebay2storeid": "0", "ebay2storeid2": "0", "ebay2subtitle": "", "ebay2taxcategory": "", "ebay2template": "", "ebay2title": "", "ebay2upcnot": "", "ebay3adult": "", "ebay3auctionsrelist": "", "ebay3autopay": "", "ebay3autorelistaction": "", "ebay3autorelistcount": "", "ebay3autorelistduration": "", "ebay3autorelistmax": "", "ebay3autorelistprice": "", "ebay3bestofferautoacceptprice": 0, "ebay3bestofferenabled": "", "ebay3bestofferminimumprice": 0, "ebay3buyitnow": 0, "ebay3catid": "0", "ebay3country": "", "ebay3currency": "", "ebay3description": "", "ebay3dispatch": "", "ebay3duration": "", "ebay3endtime": "", "ebay3fitmentcatalog": "", "ebay3getitfast": "", "ebay3holidayreturn": "", "ebay3id": "0", "ebay3internationalon": "", "ebay3listing": "", "ebay3location": "", "ebay3minimumadvertisedprice": "", "ebay3minimumadvertisedpriceexposure": "", "ebay3options": { "autorelist": { "action": "", "count": "", "duration": "", "max": "", "price": "" }, "bestoffer": { "autoacceptprice": 0, "minimumprice": 0 }, "buyitnow": 0, "country": "", "dispatch": null, "duration": "", "fitmentcatalog": "", "internationalon": "", "listing": "", "location": "", "minimumadvertisedprice": "", "minimumadvertisedpriceexposure": "", "paymentinstructions": "", "paymentmethods": [ "" ], "paymentprofileid": "", "returnprofileid": "", "returns": { "description": "" }, "salestaxpercent": 0, "scheduletime": "", "secondcategory": "", "shipping": { "calculated": { "handlingfee": 0, "internationalhandlingfee": 0, "postalcode": "", "shippingirregular": false, "shippingpackage": "" }, "domestic": { "1": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "2": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "3": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "4": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 } }, "excludes": [ "" ], "international": { "1": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "2": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "3": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "4": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "5": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" } } }, "shippingprofileid": "", "shiptolocations": [ "" ], "siteid": "", "siteshipping": "", "subtitle": "", "taxcategory": "", "template": "" }, "ebay3paymentinstructions": "", "ebay3paymentmethods": "", "ebay3paymentprofileid": "", "ebay3paypalemailaddress": "", "ebay3prefiliteminfo": "", "ebay3price": "0.00", "ebay3private": "", "ebay3promotionendtime": "", "ebay3promotionstarttime": "", "ebay3returnprofileid": "", "ebay3returnsdescription": "", "ebay3returnsrefund": "", "ebay3returnsrestockingfeevalue": "", "ebay3returnsreturnsaccepted": "", "ebay3returnsreturnswithin": "", "ebay3returnsshippingcostpaidby": "", "ebay3salestaxpercent": 0, "ebay3scheduletime": "", "ebay3secondcategory": "", "ebay3shippingcalculatedhandlingfee": 0, "ebay3shippingcalculatedinternationalhandlingfee": 0, "ebay3shippingcalculatedpostalcode": "", "ebay3shippingcalculatedshippingirregular": false, "ebay3shippingcalculatedshippingpackage": "", "ebay3shippingdomestic1additionalcost": 0, "ebay3shippingdomestic1cost": 0, "ebay3shippingdomestic1cutofftime": "", "ebay3shippingdomestic1expedited": "", "ebay3shippingdomestic1freeshipping": "", "ebay3shippingdomestic1handling": "", "ebay3shippingdomestic1insurancecost": 0, "ebay3shippingdomestic1localpickup": "", "ebay3shippingdomestic1service": "", "ebay3shippingdomestic1surcharge": 0, "ebay3shippingdomestic1timemax": 0, "ebay3shippingdomestic1timemin": 0, "ebay3shippingdomestic2additionalcost": 0, "ebay3shippingdomestic2cost": 0, "ebay3shippingdomestic2cutofftime": "", "ebay3shippingdomestic2expedited": "", "ebay3shippingdomestic2freeshipping": "", "ebay3shippingdomestic2handling": "", "ebay3shippingdomestic2insurancecost": 0, "ebay3shippingdomestic2localpickup": "", "ebay3shippingdomestic2service": "", "ebay3shippingdomestic2surcharge": 0, "ebay3shippingdomestic2timemax": 0, "ebay3shippingdomestic2timemin": 0, "ebay3shippingdomestic3additionalcost": 0, "ebay3shippingdomestic3cost": 0, "ebay3shippingdomestic3cutofftime": "", "ebay3shippingdomestic3expedited": "", "ebay3shippingdomestic3freeshipping": "", "ebay3shippingdomestic3handling": "", "ebay3shippingdomestic3insurancecost": 0, "ebay3shippingdomestic3localpickup": "", "ebay3shippingdomestic3service": "", "ebay3shippingdomestic3surcharge": 0, "ebay3shippingdomestic3timemax": 0, "ebay3shippingdomestic3timemin": 0, "ebay3shippingdomestic4additionalcost": 0, "ebay3shippingdomestic4cost": 0, "ebay3shippingdomestic4cutofftime": "", "ebay3shippingdomestic4expedited": "", "ebay3shippingdomestic4freeshipping": "", "ebay3shippingdomestic4handling": "", "ebay3shippingdomestic4insurancecost": 0, "ebay3shippingdomestic4localpickup": "", "ebay3shippingdomestic4service": "", "ebay3shippingdomestic4surcharge": 0, "ebay3shippingdomestic4timemax": 0, "ebay3shippingdomestic4timemin": 0, "ebay3shippingexcludes": "", "ebay3shippingglobal": "", "ebay3shippingincludedintax": "", "ebay3shippinginternational1additionalcost": 0, "ebay3shippinginternational1cost": 0, "ebay3shippinginternational1cutofftime": "", "ebay3shippinginternational1handling": "", "ebay3shippinginternational1insurancecost": 0, "ebay3shippinginternational1location": "", "ebay3shippinginternational1service": "", "ebay3shippinginternational2additionalcost": 0, "ebay3shippinginternational2cost": 0, "ebay3shippinginternational2cutofftime": "", "ebay3shippinginternational2handling": "", "ebay3shippinginternational2insurancecost": 0, "ebay3shippinginternational2location": "", "ebay3shippinginternational2service": "", "ebay3shippinginternational3additionalcost": 0, "ebay3shippinginternational3cost": 0, "ebay3shippinginternational3cutofftime": "", "ebay3shippinginternational3handling": "", "ebay3shippinginternational3insurancecost": 0, "ebay3shippinginternational3location": "", "ebay3shippinginternational3service": "", "ebay3shippinginternational4additionalcost": 0, "ebay3shippinginternational4cost": 0, "ebay3shippinginternational4cutofftime": "", "ebay3shippinginternational4handling": "", "ebay3shippinginternational4insurancecost": 0, "ebay3shippinginternational4location": "", "ebay3shippinginternational4service": "", "ebay3shippinginternational5additionalcost": 0, "ebay3shippinginternational5cost": 0, "ebay3shippinginternational5cutofftime": "", "ebay3shippinginternational5handling": "", "ebay3shippinginternational5insurancecost": 0, "ebay3shippinginternational5location": "", "ebay3shippinginternational5service": "", "ebay3shippingprofileid": "", "ebay3shippingratetabledom": "", "ebay3shippingratetableintl": "", "ebay3shippingtype": "", "ebay3shiptolocations": "", "ebay3siteid": "", "ebay3siteshipping": "", "ebay3skip": "", "ebay3sku": "", "ebay3starttime": "", "ebay3storeid": "0", "ebay3storeid2": "0", "ebay3subtitle": "", "ebay3taxcategory": "", "ebay3template": "", "ebay3title": "", "ebay3upcnot": "", "ebayadult": "", "ebayauctionsrelist": "", "ebayautopay": "", "ebayautorelistaction": "", "ebayautorelistcount": "", "ebayautorelistduration": "", "ebayautorelistmax": "", "ebayautorelistprice": "", "ebaybestofferautoacceptprice": 0, "ebaybestofferenabled": "", "ebaybestofferminimumprice": 0, "ebaybuyitnow": 0, "ebaycatid": "0", "ebaycountry": "", "ebaycurrency": "", "ebaydescription": "", "ebaydispatch": "", "ebayduration": "", "ebayendtime": "", "ebayepid": "0", "ebayfitmentcatalog": "", "ebaygetitfast": "", "ebayholidayreturn": "", "ebayid": "0", "ebayinternationalon": "", "ebayitemspecificsmapprice": "", "ebayitemspecificswarranty": "", "ebayktype": "", "ebaylisting": "", "ebaylocation": "", "ebayminimumadvertisedprice": "", "ebayminimumadvertisedpriceexposure": "", "ebayoptions": { "autorelist": { "action": "", "count": "", "duration": "", "max": "", "price": "" }, "bestoffer": { "autoacceptprice": 0, "minimumprice": 0 }, "buyitnow": 0, "country": "", "dispatch": null, "duration": "", "fitmentcatalog": "", "internationalon": "", "itemspecifics": [], "listing": "", "location": "", "minimumadvertisedprice": "", "minimumadvertisedpriceexposure": "", "paymentinstructions": "", "paymentmethods": [ "" ], "paymentprofileid": "-1", "returnprofileid": "-1", "returns": { "description": "" }, "salestaxpercent": 0, "scheduletime": "", "secondcategory": "", "shipping": { "calculated": { "handlingfee": 0, "internationalhandlingfee": 0, "postalcode": "", "shippingirregular": false, "shippingpackage": "" }, "domestic": { "1": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "2": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "3": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 }, "4": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "service": "", "surcharge": 0, "timemax": 0, "timemin": 0 } }, "excludes": [ "" ], "international": { "1": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "2": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "3": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "4": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" }, "5": { "additionalcost": 0, "cost": 0, "insurancecost": 0, "location": "", "service": "" } } }, "shippingprofileid": "-1", "shiptolocations": [ "" ], "siteid": "", "siteshipping": "", "skip": "alwaysSkip", "subtitle": "", "taxcategory": "", "template": "" }, "ebaypaymentinstructions": "", "ebaypaymentmethods": "", "ebaypaymentprofileid": "-1", "ebaypaypalemailaddress": "", "ebayprefiliteminfo": "", "ebayprice": "59.99", "ebayprivate": "", "ebayproductid": "", "ebaypromotionendtime": "", "ebaypromotionstarttime": "", "ebayreturnprofileid": "-1", "ebayreturnsdescription": "", "ebayreturnsrefund": "", "ebayreturnsrestockingfeevalue": "", "ebayreturnsreturnsaccepted": "", "ebayreturnsreturnswithin": "", "ebayreturnsshippingcostpaidby": "", "ebaysalestaxpercent": 0, "ebayscheduletime": "", "ebaysecondcategory": "", "ebayshippingcalculatedhandlingfee": 0, "ebayshippingcalculatedinternationalhandlingfee": 0, "ebayshippingcalculatedpostalcode": "", "ebayshippingcalculatedshippingirregular": false, "ebayshippingcalculatedshippingpackage": "", "ebayshippingdomestic1additionalcost": 0, "ebayshippingdomestic1cost": 0, "ebayshippingdomestic1cutofftime": "", "ebayshippingdomestic1expedited": "", "ebayshippingdomestic1freeshipping": "", "ebayshippingdomestic1handling": "", "ebayshippingdomestic1insurancecost": 0, "ebayshippingdomestic1localpickup": "", "ebayshippingdomestic1service": "", "ebayshippingdomestic1surcharge": 0, "ebayshippingdomestic1timemax": 0, "ebayshippingdomestic1timemin": 0, "ebayshippingdomestic2additionalcost": 0, "ebayshippingdomestic2cost": 0, "ebayshippingdomestic2cutofftime": "", "ebayshippingdomestic2expedited": "", "ebayshippingdomestic2freeshipping": "", "ebayshippingdomestic2handling": "", "ebayshippingdomestic2insurancecost": 0, "ebayshippingdomestic2localpickup": "", "ebayshippingdomestic2service": "", "ebayshippingdomestic2surcharge": 0, "ebayshippingdomestic2timemax": 0, "ebayshippingdomestic2timemin": 0, "ebayshippingdomestic3additionalcost": 0, "ebayshippingdomestic3cost": 0, "ebayshippingdomestic3cutofftime": "", "ebayshippingdomestic3expedited": "", "ebayshippingdomestic3freeshipping": "", "ebayshippingdomestic3handling": "", "ebayshippingdomestic3insurancecost": 0, "ebayshippingdomestic3localpickup": "", "ebayshippingdomestic3service": "", "ebayshippingdomestic3surcharge": 0, "ebayshippingdomestic3timemax": 0, "ebayshippingdomestic3timemin": 0, "ebayshippingdomestic4additionalcost": 0, "ebayshippingdomestic4cost": 0, "ebayshippingdomestic4cutofftime": "", "ebayshippingdomestic4expedited": "", "ebayshippingdomestic4freeshipping": "", "ebayshippingdomestic4handling": "", "ebayshippingdomestic4insurancecost": 0, "ebayshippingdomestic4localpickup": "", "ebayshippingdomestic4service": "", "ebayshippingdomestic4surcharge": 0, "ebayshippingdomestic4timemax": 0, "ebayshippingdomestic4timemin": 0, "ebayshippingexcludes": "", "ebayshippingglobal": "", "ebayshippingincludedintax": "", "ebayshippinginternational1additionalcost": 0, "ebayshippinginternational1cost": 0, "ebayshippinginternational1cutofftime": "", "ebayshippinginternational1handling": "", "ebayshippinginternational1insurancecost": 0, "ebayshippinginternational1location": "", "ebayshippinginternational1service": "", "ebayshippinginternational2additionalcost": 0, "ebayshippinginternational2cost": 0, "ebayshippinginternational2cutofftime": "", "ebayshippinginternational2handling": "", "ebayshippinginternational2insurancecost": 0, "ebayshippinginternational2location": "", "ebayshippinginternational2service": "", "ebayshippinginternational3additionalcost": 0, "ebayshippinginternational3cost": 0, "ebayshippinginternational3cutofftime": "", "ebayshippinginternational3handling": "", "ebayshippinginternational3insurancecost": 0, "ebayshippinginternational3location": "", "ebayshippinginternational3service": "", "ebayshippinginternational4additionalcost": 0, "ebayshippinginternational4cost": 0, "ebayshippinginternational4cutofftime": "", "ebayshippinginternational4handling": "", "ebayshippinginternational4insurancecost": 0, "ebayshippinginternational4location": "", "ebayshippinginternational4service": "", "ebayshippinginternational5additionalcost": 0, "ebayshippinginternational5cost": 0, "ebayshippinginternational5cutofftime": "", "ebayshippinginternational5handling": "", "ebayshippinginternational5insurancecost": 0, "ebayshippinginternational5location": "", "ebayshippinginternational5service": "", "ebayshippingprofileid": "-1", "ebayshippingratetabledom": "", "ebayshippingratetableintl": "", "ebayshippingtype": "", "ebayshiptolocations": "", "ebaysiteid": "", "ebaysiteshipping": "", "ebayskip": "alwaysSkip", "ebaysku": "", "ebaystarttime": "", "ebaystoreid": "0", "ebaystoreid2": "0", "ebaysubtitle": "", "ebaytaxcategory": "", "ebaytemplate": "", "ebaytitle": "", "ebayupcnot": "", "etsycategoryid": "", "etsydescription": "", "etsyiscustomizable": "", "etsyissupply": "", "etsylistingid": "0", "etsymaterials": "", "etsynontaxable": "", "etsyoccasion": "", "etsyoptions": { "category_id": "", "description": "", "is_customizable": "", "is_supply": "", "materials": "", "non_taxable": "", "occasion": "", "opts_listing_id": "", "price": "", "recipient": "", "shipping_template_id": "", "shop_section_id": "", "skip": "", "state": "", "title": "", "variant_keys": "", "when_made": "", "who_made": "" }, "etsyoptslistingid": "", "etsyprice": "", "etsyrecipient": "", "etsyshippingtemplateid": "", "etsyshopsectionid": "", "etsyskip": "", "etsystate": "", "etsytitle": "", "etsyvariantkeys": "", "etsywhenmade": "", "etsywhomade": "", "exportlabel": "", "featured": "0", "flavor": "", "floormatlogo": "", "fulfillmentlatency": "0", "galleryuri": "", "geolocation": "", "googlecategory": "", "googleshopping": "1", "googleshopurl": "", "guid": "U8800", "guidad": "", "handlingfee": "0.00", "hosierysize": "", "htmltitle": "", "id": "1", "importfield": "", "inseam": "", "internationalshipping1": "0.00", "intimatessleepsizewomens": "", "isbn": "", "iskit": "0", "iskit_calculated_cost": false, "iskit_calculated_price": false, "jacketlength": "", "jacketsize": "", "keywords": "", "longdescription": "

Stay connected to friends and family with this mobile phone thatfeatures 4G speed, Wi-Fi and an Android 2.2 operating system for enhanced productivity on the go.The 5.0MP digital camera features a 4x zoom and autofocus for clear photos. Requires a minimumdata service starting at $15/month. Early termination fees will be prorated, starting at $325 minus $10for each full month of service commitment completed.

", "magento2attributeset": "", "magento2categories": "", "magento2description": "", "magento2listingid": "", "magento2metadescription": "", "magento2metakeyword": "", "magento2metatitle": "", "magento2name": "", "magento2oldlistingid": "", "magento2oldsku": "", "magento2options": { "attribute_set": "", "price": "59.99", "tax_class_id": "" }, "magento2parentsku": "", "magento2price": "59.99", "magento2shortdescription": "", "magento2skip": "", "magento2sku": "", "magento2storepath": "", "magento2taxclassid": "", "magento2urlkey": "", "magento2urlpath": "", "magentoattributeset": "", "magentocategories": "", "magentodescription": "", "magentolistingid": "", "magentometadescription": "", "magentometakeyword": "", "magentometatitle": "", "magentoname": "", "magentooldlistingid": "", "magentooldsku": "", "magentooptions": { "attribute_set": "", "categories": "", "description": "", "meta_description": "", "meta_keyword": "", "meta_title": "", "name": "", "old_listing_id": "", "old_sku": "", "parent_sku": "", "price": "", "short_description": "", "skip": "", "store_path": "", "tax_class_id": "", "url_key": "", "url_path": "" }, "magentoparentsku": "", "magentoprice": "", "magentoshortdescription": "", "magentoskip": "", "magentosku": "", "magentostorepath": "", "magentotaxclassid": "", "magentourlkey": "", "magentourlpath": "", "manufacturer": "", "manufacturerpartnumber": "", "mapprice": "0.00", "material": "", "maxstock": "0", "media1": "http://assets.suredone.com/1019/media-pics/u8800-att-impulse-4g-mobile-phone-black.jpg", "media10": "", "media10alttext": "", "media11alttext": "", "media1alttext": "", "media2": "http://assets.suredone.com/1019/media-pics/u8800-att-impulse-4g-mobile-phone-black-2.jpg", "media2alttext": "", "media3": "", "media3alttext": "", "media4": "", "media4alttext": "", "media5": "", "media5alttext": "", "media6": "", "media6alttext": "", "media7": "", "media7alttext": "", "media8": "", "media8alttext": "", "media9": "", "media9alttext": "", "mediacount": "2", "mediax": "", "metadescription": "", "metal": "", "meyersku": "", "meyerstock": "0", "minstock": "0", "model": "", "modelnumber": "", "mpn": "", "msrp": "0.00", "name": "yesatt", "nameofnewfield": "", "newbccffield1": "", "notes": "", "numberofitems": "", "packagequantity": "", "parenturi": "android-smartphones", "pl20160304001": "", "pl20160304003": "", "preexistingcustomarc005": "", "price": "59.99", "productshippingtemplate": "", "producttaxcode": "", "producttype": "", "registeredparameter": "", "releasedate": "", "ringsize": "", "rule": "update", "shelfdescription": "", "shipping": "0.00", "shippingadditional": "0.00", "size": "8gb", "sizemens": "", "sizetype": "", "sizewomens": "", "sku": "U8800", "skuvaultbrand": "", "skuvaultclassification": "", "skuvaultcode": "", "skuvaultcost": "", "skuvaultdescription": "", "skuvaultiskit": "", "skuvaultislisted": "", "skuvaultlocationinfo": "", "skuvaultoptions": { "Brand": "", "Classification": "", "Code": "", "Cost": "", "Description": "", "PartNumber": "", "QuantityAvailable": "", "RetailPrice": "", "SalePrice": "", "Supplier": "", "isListed": "", "iskit": "", "locationInfo": "", "skip": "" }, "skuvaultpartnumber": "", "skuvaultquantityavailable": "", "skuvaultretailprice": "", "skuvaultsaleprice": "", "skuvaultskip": "", "skuvaultsku": "", "skuvaultsupplier": "", "sleevelength": "", "socksize": "", "state": "active", "status": "publish", "stock": "1", "style": "Matte", "test": "", "test2": "", "testfield3": "", "testx1": "", "threadcolor": "", "title": "AT&T Impulse 4G Mobile Phone - Black", "total_stock": "4", "totalsold": "5", "transamericansku": "", "transamericanstock": "0", "tx1": "", "tx10": "", "tx11": "", "tx12": "", "tx13": "", "tx3": "", "type": "", "upc": "", "updatenotes": "", "updatereason": "S*S*S*S*S", "uri": "att-impulse-4g-mobile-phone-black-u8800", "usertype": "", "userupc": "", "usshoesizemens": "", "usshoesizewomens": "", "variationtheme": "", "vendorstock": "3", "waistsize": "", "walmartcategory": "", "walmartdescription": "", "walmartenqueued": "", "walmartinprogress": "0", "walmartislisted": "0", "walmartmedia": "", "walmartname": "", "walmartoptions": { "category": "", "description": "", "enqueued": "", "media": "", "name": "", "price": "", "skip": "", "url": "" }, "walmartprice": "", "walmartskip": "", "walmartsku": "", "walmartstatus": "", "walmarturl": "", "warranty": "", "weight": "0.50", "wmcategory": "", "wmtaxcode": "", "working": "" } }, "itemid": "456", "media": "http://assets.suredone.com/1019/media-pics/u8800-att-impulse-4g-mobile-phone-black.jpg", "price": "13.17", "quantity": "1", "sku": "U8800", "source": "", "title": "mpulse 4G Mobile Phone Case", "weight": "1.00" } ], "itemtotal": "13.17", "meta": [], "oid": "353", "oidconsolidate": "0", "order": "custom12345", "ordernumber": "12345", "payment": "Visa", "paymentdate": "2018-06-27 13:38:25", "paymentstatus": "COMPLETE", "refunds": [], "shipments": [ { "shipcarrier": "FedEx", "shipcost": "0.00", "shipdate": "2018-07-01 00:00:01", "shipdetails": [], "shipid": "49", "shipservice": "", "shiptracking": "9999999999", "shipuser": "" } ], "shipping": { "city": "New York", "company": "", "country": "US", "firstname": "Test", "lastname": "User", "middlename": "", "phone": "877-773-6755", "phone2": "", "postalcode": "10010", "stateprovince": "NY", "street1": "115 E 23rd St", "street2": "FL 3", "street3": "" }, "shippingcarrier": "FedEx", "shippingservice": "Standard", "shippingstatus": "COMPLETE", "shippingtotal": "0.00", "status": "COMPLETE", "taxtotal": "0.00", "total": "13.17", "transactionid": "30090115962746" } ], "timestamp": "2018-08-11T20:04:35Z" } ``` ### Retry Failed Delivery - **Method:** `POST` - **Path:** `/v3/webhooks/deliveries/{id}/retry` - **Tags:** Webhooks Retry a failed webhook delivery. The delivery ID is in the format `{msgId}_{endpointId}` as returned in delivery logs. #### Parameters ##### `id` required - **In:** `path` The delivery ID `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `retryFailedDelivery`. `string` #### Responses ##### Status: 200 Retry Failed Delivery — completed. ###### Content-Type: application/json - **`message`** `string` - **`result`** `object` - **`status`** `string` - **`timestamp`** `string` **Example:** ```json { "message": "Delivery retry queued", "result": { "status": "queued" }, "timestamp": "2026-02-19T12:00:00+00:00" } ``` ##### Status: 404 Retry Failed Delivery — target resource not found. ###### Content-Type: application/json - **`error`** `string | null` **Example:** ```json { "error": "Delivery not found" } ``` ### List Webhook Endpoints - **Method:** `GET` - **Path:** `/v3/webhooks/endpoints` - **Tags:** Webhooks Returns all webhook endpoints configured for the authenticated user, including health metrics. #### Parameters ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `listWebhookEndpoints`. `string` #### Responses ##### Status: 200 List Webhook Endpoints — results returned. ###### Content-Type: application/json - **`endpoints`** `array` **Items:** - **`createdAt`** `string` - **`description`** `string` - **`disabled`** `boolean` - **`eventTypes`** `array` **Items:** `string` - **`health`** `string` - **`healthStatus`** `string` - **`id`** `string` - **`lastDeliveryAt`** `string | null` - **`name`** `string` - **`successRate`** `number | null` - **`updatedAt`** `string` - **`url`** `string` - **`timestamp`** `string` **Example:** ```json { "endpoints": [ { "createdAt": "2026-02-01T12:00:00Z", "description": "Receives order notifications", "disabled": false, "eventTypes": [ "order.created", "order.fulfilled" ], "health": "healthy", "healthStatus": "healthy", "id": "ep_2abc3def4ghi5jkl", "lastDeliveryAt": "2026-02-19T11:30:00Z", "name": "My Webhook Endpoint", "successRate": 99.5, "updatedAt": "2026-02-01T12:00:00Z", "url": "https://example.com/webhooks" } ], "timestamp": "2026-02-19T12:00:00+00:00" } ``` ##### Status: 400 Request rejected by the strict-params middleware (an unknown query parameter was supplied). Returned by every v3 listing endpoint. ###### Content-Type: application/json - **`results` (required)** `object` - **`failed` (required)** `object` — Map of failure index (as a string key, starting at "0") to failure details. At least one entry is present. **Example:** ```json { "results": { "failed": { "additionalProperty": { "message": "Invalid Params: foo | Valid Params: debug, diff, user_id, page, internal, showFilters, sort, sortorder, notify, email, type, disableCache", "code": 1 } } } } ``` ### Create Webhook Endpoint - **Method:** `POST` - **Path:** `/v3/webhooks/endpoints` - **Tags:** Webhooks Create a new webhook endpoint. The response includes the signing secret which is used to verify webhook signatures. Store this secret securely — it is only returned on creation. ### Request Fields | Field | Description | Required | | :----------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | url | HTTPS URL to receive webhook deliveries, maximum 2048 characters. Must be a publicly accessible HTTPS endpoint (no private/internal networks). | Yes | | event\_types | Array of event type names to subscribe to (e.g., `["order.created", "order.fulfilled"]`). At least one event type is required. | Yes | | name | Display name for the endpoint, maximum 100 characters | | | description | Description of the endpoint, maximum 500 characters | | #### Parameters ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `createWebhookEndpoint`. `string` #### Request Body ##### Content-Type: application/json - **`description`** `string` - **`event_types`** `array` **Items:** `string` - **`name`** `string` - **`url`** `string` **Example:** ```json { "description": "Receives all order events", "event_types": [ "order.created", "order.updated", "order.fulfilled", "order.status_changed" ], "name": "My Webhook Endpoint", "url": "https://example.com/webhooks" } ``` #### Responses ##### Status: 200 Create Webhook Endpoint — completed. ###### Content-Type: application/json - **`endpoint`** `object` - **`createdAt`** `string` - **`description`** `string` - **`disabled`** `boolean` - **`eventTypes`** `array` **Items:** `string` - **`health`** `string` - **`healthStatus`** `string` - **`id`** `string` - **`lastDeliveryAt`** `string | null` - **`name`** `string` - **`secret`** `string` - **`successRate`** `number | null` - **`updatedAt`** `string` - **`url`** `string` - **`message`** `string` - **`timestamp`** `string` **Example:** ```json { "endpoint": { "createdAt": "2026-02-19T12:00:00Z", "description": "Receives all order events", "disabled": false, "eventTypes": [ "order.created", "order.updated", "order.fulfilled", "order.status_changed" ], "health": "healthy", "healthStatus": "healthy", "id": "ep_2abc3def4ghi5jkl", "lastDeliveryAt": null, "name": "My Webhook Endpoint", "secret": "whsec_EXAMPLE_NOT_A_REAL_SECRET", "successRate": null, "updatedAt": "2026-02-19T12:00:00Z", "url": "https://example.com/webhooks" }, "message": "Webhook endpoint created successfully", "timestamp": "2026-02-19T12:00:00+00:00" } ``` ##### Status: 400 Create Webhook Endpoint — request rejected (validation, missing fields, or invalid identifier). ###### Content-Type: application/json - **`error`** `string | null` **Example:** ```json { "error": "Missing required fields: url, event_types" } ``` ### Delete Webhook Endpoint - **Method:** `DELETE` - **Path:** `/v3/webhooks/endpoints/{id}` - **Tags:** Webhooks Permanently delete a webhook endpoint. This action cannot be undone. #### Parameters ##### `id` required - **In:** `path` The endpoint ID — required by `deleteWebhookEndpoint`. `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `deleteWebhookEndpoint`. `string` #### Responses ##### Status: 200 Delete Webhook Endpoint — completed. ###### Content-Type: application/json - **`message`** `string` - **`timestamp`** `string` **Example:** ```json { "message": "Webhook endpoint deleted successfully", "timestamp": "2026-02-19T12:00:00+00:00" } ``` ##### Status: 404 Delete Webhook Endpoint — target resource not found. ###### Content-Type: application/json - **`error`** `string | null` **Example:** ```json { "error": "Webhook endpoint not found" } ``` ### Get Webhook Endpoint - **Method:** `GET` - **Path:** `/v3/webhooks/endpoints/{id}` - **Tags:** Webhooks Returns details for a single webhook endpoint, including health metrics. #### Parameters ##### `id` required - **In:** `path` The endpoint ID — required by `getWebhookEndpoint`. `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `getWebhookEndpoint`. `string` #### Responses ##### Status: 200 Get Webhook Endpoint — results returned. ###### Content-Type: application/json - **`endpoint`** `object` - **`createdAt`** `string` - **`description`** `string` - **`disabled`** `boolean` - **`eventTypes`** `array` **Items:** `string` - **`health`** `string` - **`healthStatus`** `string` - **`id`** `string` - **`lastDeliveryAt`** `string | null` - **`name`** `string` - **`successRate`** `number | null` - **`updatedAt`** `string` - **`url`** `string` - **`timestamp`** `string` **Example:** ```json { "endpoint": { "createdAt": "2026-02-01T12:00:00Z", "description": "Receives order notifications", "disabled": false, "eventTypes": [ "order.created", "order.fulfilled" ], "health": "healthy", "healthStatus": "healthy", "id": "ep_2abc3def4ghi5jkl", "lastDeliveryAt": "2026-02-19T11:30:00Z", "name": "My Webhook Endpoint", "successRate": 100, "updatedAt": "2026-02-01T12:00:00Z", "url": "https://example.com/webhooks" }, "timestamp": "2026-02-19T12:00:00+00:00" } ``` ##### Status: 404 Get Webhook Endpoint — target resource not found. ###### Content-Type: application/json - **`error`** `string | null` **Example:** ```json { "error": "Webhook endpoint not found" } ``` ### Update Webhook Endpoint - **Method:** `PATCH` - **Path:** `/v3/webhooks/endpoints/{id}` - **Tags:** Webhooks Update an existing webhook endpoint. Accepts partial updates — only include the fields you want to change. ### Request Fields | Field | Description | Required | | :----------- | ----------------------------------------- | -------- | | url | HTTPS URL to receive webhook deliveries | | | event\_types | Array of event type names to subscribe to | | | name | Display name for the endpoint | | | description | Description of the endpoint | | | disabled | Boolean to enable or disable the endpoint | | #### Parameters ##### `id` required - **In:** `path` The endpoint ID — required by `updateWebhookEndpoint`. `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `updateWebhookEndpoint`. `string` #### Request Body ##### Content-Type: application/json - **`disabled`** `boolean` - **`event_types`** `array` **Items:** `string` **Example:** ```json { "disabled": false, "event_types": [ "order.created", "order.fulfilled" ] } ``` #### Responses ##### Status: 200 Update Webhook Endpoint — completed. ###### Content-Type: application/json - **`endpoint`** `object` - **`createdAt`** `string` - **`description`** `string` - **`disabled`** `boolean` - **`eventTypes`** `array` **Items:** `string` - **`health`** `string` - **`healthStatus`** `string` - **`id`** `string` - **`lastDeliveryAt`** `string | null` - **`name`** `string` - **`successRate`** `number | null` - **`updatedAt`** `string` - **`url`** `string` - **`message`** `string` - **`timestamp`** `string` **Example:** ```json { "endpoint": { "createdAt": "2026-02-01T12:00:00Z", "description": "Receives all order events", "disabled": false, "eventTypes": [ "order.created", "order.fulfilled" ], "health": "healthy", "healthStatus": "healthy", "id": "ep_2abc3def4ghi5jkl", "lastDeliveryAt": "2026-02-19T11:30:00Z", "name": "My Webhook Endpoint", "successRate": 99.5, "updatedAt": "2026-02-19T12:00:00Z", "url": "https://example.com/webhooks" }, "message": "Webhook endpoint updated successfully", "timestamp": "2026-02-19T12:00:00+00:00" } ``` ##### Status: 404 Update Webhook Endpoint — target resource not found. ###### Content-Type: application/json - **`error`** `string | null` **Example:** ```json { "error": "Webhook endpoint not found" } ``` ### Get Delivery Logs - **Method:** `GET` - **Path:** `/v3/webhooks/endpoints/{id}/logs` - **Tags:** Webhooks Retrieve delivery logs for a webhook endpoint. Logs are grouped by logical delivery (retries are consolidated under a single delivery entry). Each delivery includes an array of individual attempts with status, response time, and timestamp. ### Query Parameters | Parameter | Description | Default | | :---------- | ------------------------------------------------------------ | ------- | | limit | Number of delivery logs to return (1-100) | 50 | | offset | Number of delivery logs to skip for pagination | 0 | | status | Filter by delivery status: `success`, `failed`, or `pending` | | | event\_type | Filter by event type (e.g., `order.created`) | | | before | ISO 8601 timestamp — only return deliveries before this time | | | after | ISO 8601 timestamp — only return deliveries after this time | | #### Parameters ##### `id` required - **In:** `path` The endpoint ID — required by `getDeliveryLogs`. `string` ##### `limit` - **In:** `query` Maximum number of records to return per page. `number` ##### `offset` - **In:** `query` Number of records to skip for pagination. `number` ##### `status` - **In:** `query` Filter by order status (`INCOMPLETE`, `READY`, `PENDING`, `ORDERED`, `DROPSHIPPED`, `COMPLETE`, `ARCHIVED`). `string` ##### `event_type` - **In:** `query` Filter results to a single webhook event type (e.g. `order.created`). `string` ##### `before` - **In:** `query` Return entries dated strictly before this RFC 3339 timestamp. `string` ##### `after` - **In:** `query` Return entries dated strictly after this RFC 3339 timestamp. `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `getDeliveryLogs`. `string` #### Responses ##### Status: 200 Get Delivery Logs — results returned. ###### Content-Type: application/json - **`logs`** `array` **Items:** - **`attemptCount`** `number` - **`attempts`** `array` **Items:** - **`attemptNumber`** `number` - **`error`** `string | null` - **`responseTime`** `number` - **`status`** `string` - **`statusCode`** `number` - **`timestamp`** `string` - **`eventId`** `string` - **`eventType`** `string` - **`id`** `string` - **`payload`** `object` - **`data`** `object` - **`channel`** `string` - **`oid`** `string` - **`resource_id`** `string` - **`resource_type`** `string` - **`status`** `string` - **`datacontenttype`** `string` - **`id`** `string` - **`source`** `string` - **`specversion`** `string` - **`time`** `string` - **`type`** `string` - **`responseBody`** `string` - **`responseTime`** `number` - **`status`** `string` - **`statusCode`** `number` - **`timestamp`** `string` - **`timestamp`** `string` **Example:** ```json { "logs": [ { "attemptCount": 1, "attempts": [ { "attemptNumber": 1, "error": null, "responseTime": 145, "status": "success", "statusCode": 200, "timestamp": "2026-02-19T11:30:00Z" } ], "eventId": "msg_1abc2def3ghi", "eventType": "order.created", "id": "msg_1abc2def3ghi_ep_2abc3def4ghi5jkl", "payload": { "data": { "channel": "ebay", "oid": "12345", "resource_id": "12345", "resource_type": "order", "status": "READY" }, "datacontenttype": "application/json", "id": "evt_a1b2c3d4e5f6a1b2c3d4e5f6", "source": "/suredone/users/1021", "specversion": "1.0", "time": "2026-02-19T11:30:00.000000Z", "type": "suredone.order.created" }, "responseBody": "OK", "responseTime": 145, "status": "success", "statusCode": 200, "timestamp": "2026-02-19T11:30:00Z" } ], "timestamp": "2026-02-19T12:00:00+00:00" } ``` ### Rotate Signing Secret - **Method:** `POST` - **Path:** `/v3/webhooks/endpoints/{id}/rotate-secret` - **Tags:** Webhooks Rotate the signing secret for a webhook endpoint. The previous secret is immediately invalidated and a new secret is returned. Update your verification logic with the new secret before processing further deliveries. #### Parameters ##### `id` required - **In:** `path` The endpoint ID — required by `rotateSigningSecret`. `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `rotateSigningSecret`. `string` #### Responses ##### Status: 200 Rotate Signing Secret — completed. ###### Content-Type: application/json - **`message`** `string` - **`secret`** `string` - **`timestamp`** `string` **Example:** ```json { "message": "Signing secret rotated successfully", "secret": "whsec_EXAMPLE_ROTATED_NOT_A_REAL_SECRET", "timestamp": "2026-02-19T12:00:00+00:00" } ``` ##### Status: 404 Rotate Signing Secret — target resource not found. ###### Content-Type: application/json - **`error`** `string | null` **Example:** ```json { "error": "Webhook endpoint not found" } ``` ### Test Webhook Endpoint - **Method:** `POST` - **Path:** `/v3/webhooks/endpoints/{id}/test` - **Tags:** Webhooks Send a test event to a webhook endpoint. The test is synchronous — the response includes the delivery result (HTTP status code, response time, and response body from your endpoint). If delivery takes longer than 5 seconds, the response indicates the event was queued and you can check the delivery logs for results. ### Request Fields | Field | Description | Required | | :---------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -------- | | event\_type | Event type to test. Defaults to `order.created`. Valid values: `order.created`, `order.updated`, `order.fulfilled`, `order.status_changed` | | #### Parameters ##### `id` required - **In:** `path` The endpoint ID — required by `testWebhookEndpoint`. `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `testWebhookEndpoint`. `string` #### Request Body ##### Content-Type: application/json - **`event_type`** `string` **Example:** ```json { "event_type": "order.fulfilled" } ``` #### Responses ##### Status: 200 Test Webhook Endpoint — completed. ###### Content-Type: application/json - **`message`** `string` - **`result`** `object` - **`deliveryMode`** `string` - **`error`** `string | null` - **`messageId`** `string` - **`responseBody`** `string` - **`responseTime`** `number` - **`status`** `string` - **`statusCode`** `number` - **`success`** `boolean` - **`timestamp`** `string` **Example:** ```json { "message": "Test event sent successfully", "result": { "deliveryMode": "synchronous", "error": null, "messageId": "msg_1abc2def3ghi4jkl", "responseBody": "OK", "responseTime": 145, "status": "delivered", "statusCode": 200, "success": true }, "timestamp": "2026-02-19T12:00:00+00:00" } ``` ##### Status: 404 Test Webhook Endpoint — target resource not found. ###### Content-Type: application/json - **`error`** `string | null` **Example:** ```json { "error": "Webhook endpoint not found" } ``` ### List Event Types - **Method:** `GET` - **Path:** `/v3/webhooks/event-types` - **Tags:** Webhooks Returns all available webhook event types, grouped by category. Event types marked as `enabled: false` are planned for future release and cannot be subscribed to yet. #### Parameters ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `listEventTypes`. `string` #### Responses ##### Status: 200 List Event Types — results returned. ###### Content-Type: application/json - **`event_types`** `object` - **`order`** `array` **Items:** - **`description` (required)** `string` - **`enabled` (required)** `boolean` - **`label` (required)** `string` - **`value` (required)** `string | null` - **`product`** `array` **Items:** - **`description` (required)** `string` - **`enabled` (required)** `boolean` - **`label` (required)** `string` - **`value` (required)** `string | null` - **`timestamp`** `string` **Example:** ```json { "event_types": { "order": [ { "description": "Fired when a new order is created", "enabled": true, "label": "Order Created", "value": "order.created" }, { "description": "Fired when an existing order is updated", "enabled": true, "label": "Order Updated", "value": "order.updated" }, { "description": "Fired when an order is marked as fulfilled", "enabled": true, "label": "Order Fulfilled", "value": "order.fulfilled" }, { "description": "Fired when an order status changes", "enabled": true, "label": "Order Status Changed", "value": "order.status_changed" } ], "product": [ { "description": "Fired when a new product is created", "enabled": false, "label": "Product Created", "value": "product.created" }, { "description": "Fired when an existing product is updated", "enabled": false, "label": "Product Updated", "value": "product.updated" }, { "description": "Fired when a product is deleted", "enabled": false, "label": "Product Deleted", "value": "product.deleted" }, { "description": "Fired when product inventory levels change", "enabled": false, "label": "Inventory Changed", "value": "product.inventory_changed" } ] }, "timestamp": "2026-02-19T12:00:00+00:00" } ``` ##### Status: 400 Request rejected by the strict-params middleware (an unknown query parameter was supplied). Returned by every v3 listing endpoint. ###### Content-Type: application/json - **`results` (required)** `object` - **`failed` (required)** `object` — Map of failure index (as a string key, starting at "0") to failure details. At least one entry is present. **Example:** ```json { "results": { "failed": { "additionalProperty": { "message": "Invalid Params: foo | Valid Params: debug, diff, user_id, page, internal, showFilters, sort, sortorder, notify, email, type, disableCache", "code": 1 } } } } ``` ### Get Webhook Statistics - **Method:** `GET` - **Path:** `/v3/webhooks/statistics` - **Tags:** Webhooks Retrieve aggregate delivery statistics for all webhook endpoints. Statistics include total deliveries, success/failure counts, success rate, and a breakdown by event type. ### Query Parameters | Parameter | Description | Default | | :-------- | --------------------------------------------------------------- | ------- | | period | Statistics time window. Valid values: `24h`, `7d`, `30d`, `90d` | 24h | #### Parameters ##### `period` - **In:** `query` Reporting window for the statistics aggregation (e.g. `24h`, `7d`, `30d`). `string` ##### `X-Auth-Integration` - **In:** `header` Identifies the partner integration that triggered the request. Optional; supply your partner slug or shared identifier (e.g. `mypartnername`). Used here when calling `getWebhookStatistics`. `string` #### Responses ##### Status: 200 Get Webhook Statistics — results returned. ###### Content-Type: application/json - **`period`** `string` - **`statistics`** `object` - **`byEventType`** `object` - **`order.created`** `number` - **`order.fulfilled`** `number` - **`order.status_changed`** `number` - **`order.updated`** `number` - **`failedDeliveries`** `number` - **`pendingRetries`** `number` - **`period`** `string` - **`periodEnd`** `string` - **`periodStart`** `string` - **`successfulDeliveries`** `number` - **`successRate`** `number | null` - **`totalDeliveries`** `number` - **`totalEndpoints`** `number` - **`timestamp`** `string` **Example:** ```json { "period": "7d", "statistics": { "byEventType": { "order.created": 500, "order.fulfilled": 200, "order.status_changed": 100, "order.updated": 450 }, "failedDeliveries": 10, "pendingRetries": 3, "period": "7d", "periodEnd": "2026-02-19T12:00:00+00:00", "periodStart": "2026-02-12T12:00:00+00:00", "successRate": 99.2, "successfulDeliveries": 1240, "totalDeliveries": 1250, "totalEndpoints": 2 }, "timestamp": "2026-02-19T12:00:00+00:00" } ``` ##### Status: 400 Request rejected by the strict-params middleware (an unknown query parameter was supplied). Returned by every v3 listing endpoint. ###### Content-Type: application/json - **`results` (required)** `object` - **`failed` (required)** `object` — Map of failure index (as a string key, starting at "0") to failure details. At least one entry is present. **Example:** ```json { "results": { "failed": { "additionalProperty": { "message": "Invalid Params: foo | Valid Params: debug, diff, user_id, page, internal, showFilters, sort, sortorder, notify, email, type, disableCache", "code": 1 } } } } ``` ### Create a new SureDone account - **Method:** `POST` - **Path:** `/v3/register` - **Tags:** Registration Creates a new SureDone account from an email, password, and basic contact details. On success, returns sign-in credentials so the caller can transition the user into the app immediately. Behavioral notes: - The endpoint is **unauthenticated**. No `X-Auth-*` headers are required or honored. - A 6-digit email verification code is dispatched to the supplied email address. The account is created in an unverified state; the holder verifies later via `POST /register/verify`. - On a successful response, the account exists and the returned credentials are immediately usable for subsequent API calls. Email verification is not a precondition for sign-in. - For storefront app install flows (Shopify, BigCommerce, and similar), pass `isFromExternalAuthChannel: true` and `source` set to the channel slug. The endpoint will provision a channel instance for the new account in addition to the account itself. In this mode, the post-registration verification email is the only outbound message (no internal lifecycle events are fired). - The generated username is derived from `preferredUsername`, then `company`, then the email prefix, in that order. If none yields a valid, available username, a short random suffix is appended. Rate limits: - Per source IP: 5 successful or attempted registrations per hour. - Global: 100 registrations per hour across all callers. On registration failure after partial provisioning, the server cleans up incomplete state before returning. Callers may safely retry with the same payload after addressing the reported error. #### Request Body ##### Content-Type: application/json - **`company` (required)** `string` — Organization name. Used to seed the organization profile and, if \`preferredUsername\` is not supplied, as a candidate for the account username. - **`email` (required)** `string`, format: `email` — Primary email address. Used as the account's email of record. - **`firstName` (required)** `string` — Primary user's given name. - **`lastName` (required)** `string` — Primary user's family name. - **`password` (required)** `string`, format: `password` — Account password. Must be 8–256 characters and contain at least one uppercase letter, one lowercase letter, one digit, and one non-alphanumeric character. - **`actionsToDo`** `array` — Free-form list of onboarding intents. **Items:** `string` - **`adID`** `string` — Marketing attribution — ad creative identifier captured at signup. - **`adp`** `string` — Marketing attribution — \`adp\` parameter captured at signup. - **`affid`** `string` — Affiliate identifier. - **`bio`** `string` — Short organization description for the profile. - **`businessPerson`** `string` — Primary contact name to store on the organization profile. Defaults to "\`firstName\` \`lastName\`" when omitted. - **`currentChannels`** `array` — Channels the user is currently selling on. **Items:** `string` - **`distribution`** `string` — Marketing attribution — distribution network reported by the upstream ad network. - **`gclId`** `string` — Google click identifier. - **`gmvPerMonth`** `string` — Approximate monthly GMV bucket. - **`inPersonDemo`** `boolean`, default: `false` — Caller indicates the user requested an in-person demo. - **`isAFit`** `boolean` — Qualification flag from the marketing site. - **`isFromExternalAuthChannel`** `boolean`, default: `false` — When true and \`source\` is supplied, the request is treated as an app-install registration originating from an external storefront. A channel instance is provisioned for the supplied \`source\` after account creation. - **`matchType`** `string` — Marketing attribution — keyword match type reported by the upstream ad network. - **`ordersPerMonth`** `string` — Approximate monthly order volume bucket. - **`phone`** `string` — Primary contact phone number. - **`placement`** `string` — Marketing attribution — ad placement label captured at signup. - **`plan`** `string` — Plan slug requested at signup. When omitted, the account is placed on the default trial plan. - **`preferredUsername`** `string` — Preferred account username. 2–30 characters; must start and end with an alphanumeric character; may contain hyphens in the middle; must not be purely numeric. Becomes the account's subdomain. If omitted or unavailable, a username is derived from \`company\`, then from the email prefix, with a random suffix as a last resort. - **`primaryCategory`** `string` — Primary product category the user sells in. - **`skuCount`** `string` — Approximate SKU count bucket. - **`source`** `string` — Channel slug (e.g. \`shopify\`, \`bigcommerce\`, \`ebay\`). Required when \`isFromExternalAuthChannel\` is true. Must be a recognized channel; unknown values are rejected with a 400. - **`subscribeToNewsletter`** `boolean`, default: `false` — Opt the user in to product newsletter emails. - **`subscribeToSMS`** `boolean`, default: `false` — Opt the user in to SMS notifications. - **`timezone`** `string` — IANA timezone name for the organization. - **`totalPoints`** `integer` — Qualification score from the marketing site. - **`utmAdGroupId`** `string` — Marketing attribution — \`utm\_adgroup\_id\` value (campaign ad group) captured at signup. - **`utmCampaign`** `string` — Marketing attribution — \`utm\_campaign\` value captured at signup. - **`utmCampaignId`** `string` — Marketing attribution — campaign identifier (\`utm\_campaign\_id\`) captured at signup. - **`utmKeyword`** `string` — Marketing attribution — \`utm\_keyword\` value captured at signup. - **`utmMedium`** `string` — Marketing attribution — \`utm\_medium\` value captured at signup. - **`utmSource`** `string` — Marketing attribution — \`utm\_source\` value captured at signup. - **`wantedChannels`** `array` — Channels the user intends to sell on. **Items:** `string` **Example:** ```json { "email": "jane@example.com", "password": "S3cur3-P@ss!", "firstName": "Jane", "lastName": "Doe", "company": "Acme Outfitters", "preferredUsername": "acme-outfitters", "isFromExternalAuthChannel": false, "source": "shopify", "businessPerson": "", "phone": "", "timezone": "America/New_York", "bio": "", "subscribeToNewsletter": false, "subscribeToSMS": false, "inPersonDemo": false, "currentChannels": [ "" ], "wantedChannels": [ "" ], "actionsToDo": [ "" ], "skuCount": "", "ordersPerMonth": "", "gmvPerMonth": "", "primaryCategory": "", "affid": "", "plan": "", "utmCampaign": "", "utmCampaignId": "", "utmSource": "", "utmMedium": "", "utmAdGroupId": "", "utmKeyword": "", "gclId": "", "matchType": "", "distribution": "", "adID": "", "placement": "", "adp": "", "totalPoints": 1, "isAFit": true } ``` #### Responses ##### Status: 201 Account created. The response contains sign-in tokens, the legacy username/UID/API token, and a snapshot of the user profile. The user is created in an unverified email state; verify via \`POST /register/verify\`. ###### Content-Type: application/json - **`cognito` (required)** `object` — Federated identity tokens for the new account. The token shape mirrors the response of a successful sign-in: an access token for API calls, an ID token for identity claims, a refresh token for renewing the access token, and the token lifetime. - **`AccessToken`** `string` - **`ExpiresIn`** `integer` - **`IdToken`** `string` - **`RefreshToken`** `string` - **`TokenType`** `string` - **`legacy` (required)** `object` — Legacy API credentials for endpoints that pre-date federated auth. - **`apiToken` (required)** `string` — Long-lived legacy API token. Pair with \`X-Auth-User\` (username) for v1 endpoints that accept token auth. - **`userId` (required)** `integer` — Numeric account identifier. - **`username` (required)** `string` — The provisioned account username (also the subdomain). - **`result` (required)** `string`, possible values: `"success"` - **`user` (required)** `object` - **`company` (required)** `string` - **`email` (required)** `string`, format: `email` - **`emailVerified` (required)** `boolean` — Always \`false\` immediately after registration. - **`firstName` (required)** `string` - **`lastName` (required)** `string` **Example:** ```json { "result": "success", "cognito": { "AccessToken": "", "ExpiresIn": 1, "IdToken": "", "RefreshToken": "", "TokenType": "" }, "legacy": { "username": "", "userId": 1, "apiToken": "" }, "user": { "email": "", "firstName": "", "lastName": "", "company": "", "emailVerified": true } } ``` ##### Status: 400 Request validation failed. The \`message\` field contains a semicolon-separated list of all validation errors. Common causes: \* Missing or malformed \`email\`, \`password\`, \`firstName\`, \`lastName\`, or \`company\`. \* Password does not satisfy complexity requirements (at least 8 characters and no more than 256, one upper, one lower, one digit, one symbol). \* \`isFromExternalAuthChannel\` is true but \`source\` is missing. \* \`source\` is set but is not a recognized channel slug. \* \`preferredUsername\` violates the username format (2–30 characters; alphanumeric start/end; not purely numeric; hyphens allowed in the middle). \* The derived username is not a valid subdomain. \* Request body is missing or not a JSON object. ###### Content-Type: application/json - **`message` (required)** `string` — Human-readable error message. - **`result` (required)** `string`, possible values: `"error"` **Example:** ```json { "result": "error", "message": "" } ``` ##### Status: 405 Method not allowed. Only \`POST\` is supported. The endpoint also returns this when an unknown sub-path beneath \`/register\` is requested. ###### Content-Type: application/json - **`message` (required)** `string` — Human-readable error message. - **`result` (required)** `string`, possible values: `"error"` **Example:** ```json { "result": "error", "message": "" } ``` ##### Status: 409 An account already exists for the supplied email address. ###### Content-Type: application/json - **`message` (required)** `string` — Human-readable error message. - **`result` (required)** `string`, possible values: `"error"` **Example:** ```json { "result": "error", "message": "" } ``` ##### Status: 429 Rate limit exceeded. Either the per-source-IP or global hourly registration limit has been reached. Retry after the limit window resets. ###### Content-Type: application/json - **`message` (required)** `string` — Human-readable error message. - **`result` (required)** `string`, possible values: `"error"` **Example:** ```json { "result": "error", "message": "" } ``` ##### Status: 500 The account could not be created. Any partial state is cleaned up before returning. The caller may retry. ###### Content-Type: application/json - **`message` (required)** `string` — Human-readable error message. - **`result` (required)** `string`, possible values: `"error"` **Example:** ```json { "result": "error", "message": "" } ``` ##### Status: 503 Registration is temporarily unavailable. Possible cases: \* Pre-flight checks (rate-limit store) are unavailable. \* The account was created but post-registration sign-in could not complete. The caller can sign in via the standard authentication flow shortly. \* The account was created but channel setup (for \`isFromExternalAuthChannel\`) failed; sign in and reconnect the channel manually. \* The account was created but provisioning is still finishing; retry sign-in shortly. ###### Content-Type: application/json - **`message` (required)** `string` — Human-readable error message. - **`result` (required)** `string`, possible values: `"error"` **Example:** ```json { "result": "error", "message": "" } ``` ### Verify a new account's email address - **Method:** `POST` - **Path:** `/v3/register/verify` - **Tags:** Registration Marks the email address associated with a newly registered account as verified, using the 6-digit code sent during registration. Behavioral notes: - The endpoint is **unauthenticated**. - Codes are valid for 15 minutes after registration and may be used at most once. - Verification is not required to sign in or use the API; it unlocks notifications, password reset, and other flows that depend on a verified email of record. Rate limits: - Per source IP: 30 verification attempts per hour. - Per email: 10 verification attempts per hour. #### Request Body ##### Content-Type: application/json - **`code` (required)** `string` — 6-digit verification code from the registration email. - **`email` (required)** `string`, format: `email` — Email address that received the verification code. **Example:** ```json { "email": "jane@example.com", "code": "482103" } ``` #### Responses ##### Status: 200 Email verified. ###### Content-Type: application/json - **`emailVerified` (required)** `boolean`, possible values: `true` - **`result` (required)** `string`, possible values: `"success"` **Example:** ```json { "result": "success", "emailVerified": true } ``` ##### Status: 400 The verification code is invalid, expired, malformed, or the email address is missing or malformed. ###### Content-Type: application/json - **`message` (required)** `string` — Human-readable error message. - **`result` (required)** `string`, possible values: `"error"` **Example:** ```json { "result": "error", "message": "" } ``` ##### Status: 429 Rate limit exceeded. Either the per-source-IP or per-email verification limit has been reached. ###### Content-Type: application/json - **`message` (required)** `string` — Human-readable error message. - **`result` (required)** `string`, possible values: `"error"` **Example:** ```json { "result": "error", "message": "" } ``` ##### Status: 500 Verification could not complete due to a server error. ###### Content-Type: application/json - **`message` (required)** `string` — Human-readable error message. - **`result` (required)** `string`, possible values: `"error"` **Example:** ```json { "result": "error", "message": "" } ``` ##### Status: 503 Verification is temporarily unavailable. Retry shortly. ###### Content-Type: application/json - **`message` (required)** `string` — Human-readable error message. - **`result` (required)** `string`, possible values: `"error"` **Example:** ```json { "result": "error", "message": "" } ``` ## Schemas ### RegisterRequest - **Type:**`object` Request payload for `POST /v3/register`. Captures the new account holder's identity and the marketing/installation context needed to provision the account. - **`company` (required)** `string` — Organization name. Used to seed the organization profile and, if \`preferredUsername\` is not supplied, as a candidate for the account username. - **`email` (required)** `string`, format: `email` — Primary email address. Used as the account's email of record. - **`firstName` (required)** `string` — Primary user's given name. - **`lastName` (required)** `string` — Primary user's family name. - **`password` (required)** `string`, format: `password` — Account password. Must be 8–256 characters and contain at least one uppercase letter, one lowercase letter, one digit, and one non-alphanumeric character. - **`actionsToDo`** `array` — Free-form list of onboarding intents. **Items:** `string` - **`adID`** `string` — Marketing attribution — ad creative identifier captured at signup. - **`adp`** `string` — Marketing attribution — \`adp\` parameter captured at signup. - **`affid`** `string` — Affiliate identifier. - **`bio`** `string` — Short organization description for the profile. - **`businessPerson`** `string` — Primary contact name to store on the organization profile. Defaults to "\`firstName\` \`lastName\`" when omitted. - **`currentChannels`** `array` — Channels the user is currently selling on. **Items:** `string` - **`distribution`** `string` — Marketing attribution — distribution network reported by the upstream ad network. - **`gclId`** `string` — Google click identifier. - **`gmvPerMonth`** `string` — Approximate monthly GMV bucket. - **`inPersonDemo`** `boolean`, default: `false` — Caller indicates the user requested an in-person demo. - **`isAFit`** `boolean` — Qualification flag from the marketing site. - **`isFromExternalAuthChannel`** `boolean`, default: `false` — When true and \`source\` is supplied, the request is treated as an app-install registration originating from an external storefront. A channel instance is provisioned for the supplied \`source\` after account creation. - **`matchType`** `string` — Marketing attribution — keyword match type reported by the upstream ad network. - **`ordersPerMonth`** `string` — Approximate monthly order volume bucket. - **`phone`** `string` — Primary contact phone number. - **`placement`** `string` — Marketing attribution — ad placement label captured at signup. - **`plan`** `string` — Plan slug requested at signup. When omitted, the account is placed on the default trial plan. - **`preferredUsername`** `string` — Preferred account username. 2–30 characters; must start and end with an alphanumeric character; may contain hyphens in the middle; must not be purely numeric. Becomes the account's subdomain. If omitted or unavailable, a username is derived from \`company\`, then from the email prefix, with a random suffix as a last resort. - **`primaryCategory`** `string` — Primary product category the user sells in. - **`skuCount`** `string` — Approximate SKU count bucket. - **`source`** `string` — Channel slug (e.g. \`shopify\`, \`bigcommerce\`, \`ebay\`). Required when \`isFromExternalAuthChannel\` is true. Must be a recognized channel; unknown values are rejected with a 400. - **`subscribeToNewsletter`** `boolean`, default: `false` — Opt the user in to product newsletter emails. - **`subscribeToSMS`** `boolean`, default: `false` — Opt the user in to SMS notifications. - **`timezone`** `string` — IANA timezone name for the organization. - **`totalPoints`** `integer` — Qualification score from the marketing site. - **`utmAdGroupId`** `string` — Marketing attribution — \`utm\_adgroup\_id\` value (campaign ad group) captured at signup. - **`utmCampaign`** `string` — Marketing attribution — \`utm\_campaign\` value captured at signup. - **`utmCampaignId`** `string` — Marketing attribution — campaign identifier (\`utm\_campaign\_id\`) captured at signup. - **`utmKeyword`** `string` — Marketing attribution — \`utm\_keyword\` value captured at signup. - **`utmMedium`** `string` — Marketing attribution — \`utm\_medium\` value captured at signup. - **`utmSource`** `string` — Marketing attribution — \`utm\_source\` value captured at signup. - **`wantedChannels`** `array` — Channels the user intends to sell on. **Items:** `string` **Example:** ```json { "email": "jane@example.com", "password": "S3cur3-P@ss!", "firstName": "Jane", "lastName": "Doe", "company": "Acme Outfitters", "preferredUsername": "acme-outfitters", "isFromExternalAuthChannel": false, "source": "shopify", "businessPerson": "", "phone": "", "timezone": "America/New_York", "bio": "", "subscribeToNewsletter": false, "subscribeToSMS": false, "inPersonDemo": false, "currentChannels": [ "" ], "wantedChannels": [ "" ], "actionsToDo": [ "" ], "skuCount": "", "ordersPerMonth": "", "gmvPerMonth": "", "primaryCategory": "", "affid": "", "plan": "", "utmCampaign": "", "utmCampaignId": "", "utmSource": "", "utmMedium": "", "utmAdGroupId": "", "utmKeyword": "", "gclId": "", "matchType": "", "distribution": "", "adID": "", "placement": "", "adp": "", "totalPoints": 1, "isAFit": true } ``` ### VerifyRequest - **Type:**`object` Request payload for `POST /v3/register/verify`. Submitted by the new account holder after they receive the email verification code. - **`code` (required)** `string` — 6-digit verification code from the registration email. - **`email` (required)** `string`, format: `email` — Email address that received the verification code. **Example:** ```json { "email": "jane@example.com", "code": "482103" } ``` ### RegisterSuccessResponse - **Type:**`object` Success payload returned by `POST /v3/register` when the account is created. Includes the identity token bundle plus the legacy API credentials needed for follow-up calls. - **`cognito` (required)** `object` — Federated identity tokens for the new account. The token shape mirrors the response of a successful sign-in: an access token for API calls, an ID token for identity claims, a refresh token for renewing the access token, and the token lifetime. - **`AccessToken`** `string` - **`ExpiresIn`** `integer` - **`IdToken`** `string` - **`RefreshToken`** `string` - **`TokenType`** `string` - **`legacy` (required)** `object` — Legacy API credentials for endpoints that pre-date federated auth. - **`apiToken` (required)** `string` — Long-lived legacy API token. Pair with \`X-Auth-User\` (username) for v1 endpoints that accept token auth. - **`userId` (required)** `integer` — Numeric account identifier. - **`username` (required)** `string` — The provisioned account username (also the subdomain). - **`result` (required)** `string`, possible values: `"success"` - **`user` (required)** `object` - **`company` (required)** `string` - **`email` (required)** `string`, format: `email` - **`emailVerified` (required)** `boolean` — Always \`false\` immediately after registration. - **`firstName` (required)** `string` - **`lastName` (required)** `string` **Example:** ```json { "result": "success", "cognito": { "AccessToken": "", "ExpiresIn": 1, "IdToken": "", "RefreshToken": "", "TokenType": "" }, "legacy": { "username": "", "userId": 1, "apiToken": "" }, "user": { "email": "", "firstName": "", "lastName": "", "company": "", "emailVerified": true } } ``` ### VerifySuccessResponse - **Type:**`object` Success payload returned by `POST /v3/register/verify` once the submitted code matches the one issued during registration. - **`emailVerified` (required)** `boolean`, possible values: `true` - **`result` (required)** `string`, possible values: `"success"` **Example:** ```json { "result": "success", "emailVerified": true } ``` ### ErrorResponse - **Type:**`object` Generic error envelope returned by the public registration endpoints when the request is rejected (validation failure, duplicate email, invalid verification code, etc.). - **`message` (required)** `string` — Human-readable error message. - **`result` (required)** `string`, possible values: `"error"` **Example:** ```json { "result": "error", "message": "" } ``` ### InvalidParamsError - **Type:**`object` Envelope returned by SureDone's strict-params middleware when a v3 request includes a query parameter the endpoint does not accept. The `failed` object is keyed by the failure index (0-based) and each entry carries a human-readable `message` enumerating the offending parameter and the valid parameter set for the endpoint. - **`results` (required)** `object` - **`failed` (required)** `object` — Map of failure index (as a string key, starting at "0") to failure details. At least one entry is present. **Example:** ```json { "results": { "failed": { "additionalProperty": { "message": "Invalid Params: foo | Valid Params: debug, diff, user_id, page, internal, showFilters, sort, sortorder, notify, email, type, disableCache", "code": 1 } } } } ``` # SureDone API V1 - **OpenAPI Version:** `3.1.0` - **API Version:** `1.0.0` SureDone REST API v1. Authentication uses paired `X-Auth-User` and `X-Auth-Token` headers. The API Username and Token are available at . The `POST /auth` endpoint also accepts an `?apiuser=` query parameter for sub-account / partner lookups. ## Throttling (released 2022-12-09) Every request is throttled with the following basic schema: - `read`: 300 requests per minute for `GET`, `TRACE`, `CONNECT` and related calls - `write`: 60 requests per minute for `POST`, `PATCH`, `PUT` and `DELETE` calls - `options`: 300 requests per minute for `OPTIONS` (for apps and UI integrations) When the throttle is hit, the API returns HTTP `429` with these response headers: - `X-Rate-Limit-Limit` (e.g. `300`) - `X-Rate-Limit-Remaining` (e.g. `295`) - `X-Rate-Limit-Reset` (e.g. `1666020201`) - `X-Rate-Limit-Type` (e.g. `read`) ## Servers - **URL:** `https://api.suredone.com/v1` - **Description:** Production ## Operations ### Exchange username/password for an API token - **Method:** `POST` - **Path:** `/auth` - **Tags:** Authentication POST a JSON (or form-encoded) body with `user` and `pass`. On success the response includes a `token` you can use in the `X-Auth-Token` header for subsequent authenticated calls. This endpoint authenticates from the request body alone. `X-Auth-User` / `X-Auth-Token` headers and the `?apiuser=` query parameter, if present, are ignored. To check or refresh an existing token, use `GET /auth` instead. #### Request Body ##### Content-Type: application/json - **`pass` (required)** `string`, format: `password` — Account password. - **`user` (required)** `string` — Account username (typically the account email). **Example:** ```json { "user": "", "pass": "" } ``` #### Responses ##### Status: 200 Always 200. The \`result\` field discriminates: \`success\` returns the authenticated user with a \`token\`; \`failure\` returns a \`message\` explaining why (missing/invalid credentials). ###### Content-Type: application/json **One of:** - **`result` (required)** `string`, possible values: `"success"` - **`token` (required)** `string` — API token for the \`X-Auth-Token\` header. - **`userid` (required)** `string` - **`email`** `string` - **`role`** `string` - **`userpk`** `string` * **`message` (required)** `string` * **`result` (required)** `string`, possible values: `"failure"` **Example:** ```json { "result": "success", "token": "", "userid": "", "userpk": "", "email": "", "role": "" } ``` ### Validate the supplied API token and return the user profile - **Method:** `GET` - **Path:** `/auth` - **Tags:** Authentication Returns the user profile associated with the `X-Auth-User` / `X-Auth-Token` header pair. Useful for confirming that a stored token is still valid and for fetching the user's `role`, `userid`, and `userpk` for routing decisions. System administrators (`userid: 1`) may additionally pass `?apiuser=` to read the profile of another user; for non-admin callers the parameter is silently ignored and the caller's own profile is returned. #### Parameters ##### `apiuser` - **In:** `query` Target UID for admin (`userid: 1`) impersonation. Ignored for non-admin callers. `string` #### Responses ##### Status: 200 Token is valid. ###### Content-Type: application/json - **`email` (required)** `string` - **`result` (required)** `string`, possible values: `"success"` - **`role` (required)** `string` - **`token` (required)** `string` - **`userid` (required)** `string` - **`userpk` (required)** `string` - **`agree`** `string` - **`created`** `string` - **`crmid`** `string` - **`cycle`** `string | null` - **`display`** `string` - **`lastlogin`** `string` - **`plan`** `string | null` - **`time`** `string` — Current server time at validation. - **`username`** `string | null` - **`verified`** `string` **Example:** ```json { "result": "success", "userid": "", "userpk": "", "email": "", "username": null, "display": "", "role": "", "time": "", "created": "", "lastlogin": "", "verified": "", "token": "", "cycle": null, "plan": null, "crmid": "", "agree": "" } ``` ##### Status: 401 Missing or invalid token. ###### Content-Type: application/json - **`message` (required)** `string` - **`result` (required)** `string` **Example:** ```json { "result": "error", "message": "" } ``` ### Search items by keyword - **Method:** `GET` - **Path:** `/search/items/{query}` - **Tags:** Items Returns items matching a free-text keyword query. The path segment is the search term; richer field-scoped queries (e.g. `brand:=msr price:<99`) are supported by URL-encoding them in place of the keyword. #### Parameters ##### `query` required - **In:** `path` Search term, optionally using SureDone field-scoped query syntax. `string` #### Responses ##### Status: 200 Search results keyed by ordinal position with \`all\` and \`time\` summary fields. ###### Content-Type: application/json - **`all` (required)** `integer` — Total number of matching items across all pages. - **`time` (required)** `string` - **`type` (required)** `string` **Example:** ```json { "type": "items", "all": 1, "time": "", "additionalProperty": "anything" } ``` ### Search orders - **Method:** `GET` - **Path:** `/search/orders/{query}` - **Tags:** Orders Returns orders matching a SureDone field-scoped query (e.g. `order:ebay shipdate:<2015-07-21`). The path segment must be URL-encoded. #### Parameters ##### `query` required - **In:** `path` Field-scoped order search query. `string` #### Responses ##### Status: 200 Order search results. ###### Content-Type: application/json - **`all`** `object` - **`html`** `string` — Rendered HTML packing slip (packing-slip variant only). - **`orders`** `object` — For the packing-slip variant, wraps the order map. - **`time`** `string` - **`type`** `string` **Example:** ```json { "all": "", "time": "", "type": "", "orders": { "additionalProperty": { "oid": "", "order": "", "date": "", "dateupdated": "", "status": "", "total": "", "itemtotal": "", "email": null, "shipcarrier": "", "shiptracking": "", "shipdate": "", "items": "", "qtys": "", "additionalProperty": "anything" } }, "html": "", "additionalProperty": { "oid": "", "order": "", "date": "", "dateupdated": "", "status": "", "total": "", "itemtotal": "", "email": null, "shipcarrier": "", "shiptracking": "", "shipdate": "", "items": "", "qtys": "", "additionalProperty": "anything" } } ``` ### List items with pagination and sorting - **Method:** `GET` - **Path:** `/editor/items` - **Tags:** Items Paginated listing of items. Use `page` for pagination, `sort` for sort field, and append `_` to the sort field for descending order (e.g. `name_`). Common sort fields include `id`, `sku`, `guid`, `stock`, `price`, `name`, `title`, `mediacount`, `media`, `size`, `color`, `condition`, `brand`, `style`, `date`, `dateupdated`, `status`, `state`, `category`. #### Parameters ##### `page` - **In:** `query` 1-based page number. `integer` ##### `sort` - **In:** `query` Sort field. Append `_` for descending sort. `string` #### Responses ##### Status: 200 Paginated list of items keyed by ordinal position. ###### Content-Type: application/json - **`all` (required)** `integer` — Total number of matching items across all pages. - **`time` (required)** `string` - **`type` (required)** `string` **Example:** ```json { "type": "items", "all": 1, "time": "", "additionalProperty": "anything" } ``` ### Bulk product create/edit/category/media request - **Method:** `POST` - **Path:** `/editor/items` - **Tags:** Items Multi-purpose POST endpoint for the product editor. The shape of the body determines the operation: - `requests=[[...]]` — bulk add/edit with a header row plus data rows. - `ebay-category-search=` — eBay category keyword search. - `action=edit&identifier=&...&mediaN=` — set media URLs on a single product. Add `?importmedia=true` to download and host the URLs instead of referencing them in place. Responses for bulk requests return per-row status entries keyed by ordinal position alongside top-level `result`, `time`, and `actions` fields. #### Parameters ##### `importmedia` - **In:** `query` When `true`, instructs SureDone to download referenced media URLs into its CDN. `string`, possible values: `"true", "false"` #### Request Body ##### Content-Type: application/x-www-form-urlencoded - **`action`** `string` — Action verb (\`add\`, \`edit\`, \`start\`, \`end\`, \`relist\`, \`delete\`). - **`ebay-category-search`** `string` — Keyword search across eBay category tree. - **`guid`** `string` - **`identifier`** `string` — Field used as the row identifier (e.g. \`guid\`, \`sku\`). - **`media1`** `string` — Image URL or local file reference for media slot 1. - **`requests`** `string` — JSON-encoded array-of-arrays. First row is header, subsequent rows are data. **Example:** ```json { "requests": "", "action": "", "identifier": "", "guid": "", "ebay-category-search": "", "media1": "" } ``` #### Responses ##### Status: 200 Per-row result entries plus top-level summary. ###### Content-Type: application/json - **`actions` (required)** `integer` - **`result` (required)** `string` - **`time` (required)** `string` - **`message`** `string | null` - **`type`** `string` **Example:** ```json { "result": "", "message": null, "type": "", "time": "", "actions": 1, "additionalProperty": "anything" } ``` ### Add a single item - **Method:** `POST` - **Path:** `/editor/items/add` - **Tags:** Items Creates a single product. Required: an `identifier` field (typically `guid`) and a `title`. All other product fields are optional. Use `mediaN` slots or `mediax` (asterisk-delimited URL list) to attach images. #### Request Body ##### Content-Type: application/x-www-form-urlencoded - **`identifier` (required)** `string` — Field used as the unique identifier (commonly \`guid\`). - **`title` (required)** `string` — Required for product creation. - **`brand`** `string` - **`guid`** `string` - **`media1`** `string` - **`mediax`** `string` — Asterisk-delimited list of additional image URLs. - **`price`** `string` - **`sku`** `string` - **`stock`** `string` **Example:** ```json { "identifier": "", "guid": "", "sku": "", "title": "", "price": "", "stock": "", "brand": "", "media1": "", "mediax": "" } ``` #### Responses ##### Status: 200 Single-action response with per-row status. ###### Content-Type: application/json - **`result` (required)** `string` - **`time` (required)** `string` - **`actions`** `integer` - **`email`** `string | null` - **`id`** `string` - **`message`** `string | null` - **`type`** `string` - **`url`** `string | null` **Example:** ```json { "result": "", "message": null, "type": "", "id": "", "time": "", "actions": 1, "email": null, "url": null, "additionalProperty": "anything" } ``` ### Get an item by identifier (GUID or SKU) - **Method:** `GET` - **Path:** `/editor/items/edit` - **Tags:** Items Returns the full product record for the item identified by either a `sku` or `guid` query parameter (e.g. `?sku=ABC123`). If neither is supplied the endpoint falls through to the listing handler and returns an ordinal-keyed map of items (same shape as `GET /editor/items`). If a `sku`/`guid` is supplied but no item matches, the response is the metadata-only envelope `{time, type: "items"}`. #### Parameters ##### `sku` - **In:** `query` SKU to look up. Mutually exclusive with `guid`. `string` ##### `guid` - **In:** `query` GUID to look up. Mutually exclusive with `sku`. `string` #### Responses ##### Status: 200 One of three shapes: a flat \`Item\` record (when \`sku\`/\`guid\` matches), an empty-result envelope \`{time, type: "items"}\` (when supplied \`sku\`/\`guid\` does not match), or an ordinal-keyed listing map (when no lookup parameter was supplied). ###### Content-Type: application/json **One of:** - **`guid` (required)** `string` - **`id` (required)** `string` - **`amznasin`** `string` - **`amznsku`** `string` - **`brand`** `string` - **`condition`** `string` - **`date`** `string` - **`dateupdated`** `string` - **`description`** `string` - **`ebayid`** `string` - **`media`** `string` - **`media1`** `string` - **`mediacount`** `string` - **`price`** `string` - **`sku`** `string` - **`state`** `string` - **`status`** `string` - **`stock`** `string` - **`title`** `string` * **`time` (required)** `string` * **`type` (required)** `string`, possible values: `"items"` - **`all` (required)** `integer` — Total number of matching items across all pages. - **`time` (required)** `string` - **`type` (required)** `string` **Example:** ```json { "id": "", "sku": "", "guid": "", "title": "", "price": "", "stock": "", "brand": "", "condition": "", "description": "", "media": "", "media1": "", "mediacount": "", "status": "", "state": "", "date": "", "dateupdated": "", "ebayid": "", "amznsku": "", "amznasin": "", "additionalProperty": "anything" } ``` ### Edit a single item - **Method:** `POST` - **Path:** `/editor/items/edit` - **Tags:** Items Updates fields on an existing item. Identify the target with `identifier` + the value of that identifier (e.g. `identifier=guid&guid=XYZ`). Any product field may be sent; unspecified fields are left unchanged. Also accepts setting product-level eBay item specifics (`ebayitemspecifics=`), a product-level eBay template (`ebaytemplate=