@ultracart/bq-skill 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (303) hide show
  1. package/LICENSE +191 -0
  2. package/README.md +952 -0
  3. package/dist/cli.d.ts +3 -0
  4. package/dist/cli.d.ts.map +1 -0
  5. package/dist/cli.js +42 -0
  6. package/dist/cli.js.map +1 -0
  7. package/dist/commands/alarm.d.ts +3 -0
  8. package/dist/commands/alarm.d.ts.map +1 -0
  9. package/dist/commands/alarm.js +146 -0
  10. package/dist/commands/alarm.js.map +1 -0
  11. package/dist/commands/config.d.ts +3 -0
  12. package/dist/commands/config.d.ts.map +1 -0
  13. package/dist/commands/config.js +749 -0
  14. package/dist/commands/config.js.map +1 -0
  15. package/dist/commands/deck.d.ts +3 -0
  16. package/dist/commands/deck.d.ts.map +1 -0
  17. package/dist/commands/deck.js +567 -0
  18. package/dist/commands/deck.js.map +1 -0
  19. package/dist/commands/dry-run.d.ts +3 -0
  20. package/dist/commands/dry-run.d.ts.map +1 -0
  21. package/dist/commands/dry-run.js +105 -0
  22. package/dist/commands/dry-run.js.map +1 -0
  23. package/dist/commands/history.d.ts +3 -0
  24. package/dist/commands/history.d.ts.map +1 -0
  25. package/dist/commands/history.js +127 -0
  26. package/dist/commands/history.js.map +1 -0
  27. package/dist/commands/init.d.ts +3 -0
  28. package/dist/commands/init.d.ts.map +1 -0
  29. package/dist/commands/init.js +302 -0
  30. package/dist/commands/init.js.map +1 -0
  31. package/dist/commands/install-skill.d.ts +3 -0
  32. package/dist/commands/install-skill.d.ts.map +1 -0
  33. package/dist/commands/install-skill.js +132 -0
  34. package/dist/commands/install-skill.js.map +1 -0
  35. package/dist/commands/list.d.ts +3 -0
  36. package/dist/commands/list.d.ts.map +1 -0
  37. package/dist/commands/list.js +89 -0
  38. package/dist/commands/list.js.map +1 -0
  39. package/dist/commands/query.d.ts +3 -0
  40. package/dist/commands/query.d.ts.map +1 -0
  41. package/dist/commands/query.js +152 -0
  42. package/dist/commands/query.js.map +1 -0
  43. package/dist/commands/render.d.ts +3 -0
  44. package/dist/commands/render.d.ts.map +1 -0
  45. package/dist/commands/render.js +107 -0
  46. package/dist/commands/render.js.map +1 -0
  47. package/dist/commands/run-all.d.ts +3 -0
  48. package/dist/commands/run-all.d.ts.map +1 -0
  49. package/dist/commands/run-all.js +285 -0
  50. package/dist/commands/run-all.js.map +1 -0
  51. package/dist/commands/run.d.ts +3 -0
  52. package/dist/commands/run.d.ts.map +1 -0
  53. package/dist/commands/run.js +321 -0
  54. package/dist/commands/run.js.map +1 -0
  55. package/dist/commands/schema.d.ts +3 -0
  56. package/dist/commands/schema.d.ts.map +1 -0
  57. package/dist/commands/schema.js +271 -0
  58. package/dist/commands/schema.js.map +1 -0
  59. package/dist/commands/validate.d.ts +3 -0
  60. package/dist/commands/validate.d.ts.map +1 -0
  61. package/dist/commands/validate.js +109 -0
  62. package/dist/commands/validate.js.map +1 -0
  63. package/dist/lib/alarm-notify.d.ts +16 -0
  64. package/dist/lib/alarm-notify.d.ts.map +1 -0
  65. package/dist/lib/alarm-notify.js +312 -0
  66. package/dist/lib/alarm-notify.js.map +1 -0
  67. package/dist/lib/alarm-state.d.ts +26 -0
  68. package/dist/lib/alarm-state.d.ts.map +1 -0
  69. package/dist/lib/alarm-state.js +118 -0
  70. package/dist/lib/alarm-state.js.map +1 -0
  71. package/dist/lib/alarm.d.ts +28 -0
  72. package/dist/lib/alarm.d.ts.map +1 -0
  73. package/dist/lib/alarm.js +215 -0
  74. package/dist/lib/alarm.js.map +1 -0
  75. package/dist/lib/analysis.d.ts +16 -0
  76. package/dist/lib/analysis.d.ts.map +1 -0
  77. package/dist/lib/analysis.js +134 -0
  78. package/dist/lib/analysis.js.map +1 -0
  79. package/dist/lib/bigquery.d.ts +55 -0
  80. package/dist/lib/bigquery.d.ts.map +1 -0
  81. package/dist/lib/bigquery.js +321 -0
  82. package/dist/lib/bigquery.js.map +1 -0
  83. package/dist/lib/config-writer.d.ts +3 -0
  84. package/dist/lib/config-writer.d.ts.map +1 -0
  85. package/dist/lib/config-writer.js +60 -0
  86. package/dist/lib/config-writer.js.map +1 -0
  87. package/dist/lib/config.d.ts +63 -0
  88. package/dist/lib/config.d.ts.map +1 -0
  89. package/dist/lib/config.js +151 -0
  90. package/dist/lib/config.js.map +1 -0
  91. package/dist/lib/dashboard.d.ts +3 -0
  92. package/dist/lib/dashboard.d.ts.map +1 -0
  93. package/dist/lib/dashboard.js +468 -0
  94. package/dist/lib/dashboard.js.map +1 -0
  95. package/dist/lib/deck.d.ts +58 -0
  96. package/dist/lib/deck.d.ts.map +1 -0
  97. package/dist/lib/deck.js +232 -0
  98. package/dist/lib/deck.js.map +1 -0
  99. package/dist/lib/deliver-email.d.ts +14 -0
  100. package/dist/lib/deliver-email.d.ts.map +1 -0
  101. package/dist/lib/deliver-email.js +360 -0
  102. package/dist/lib/deliver-email.js.map +1 -0
  103. package/dist/lib/deliver-slack.d.ts +6 -0
  104. package/dist/lib/deliver-slack.d.ts.map +1 -0
  105. package/dist/lib/deliver-slack.js +73 -0
  106. package/dist/lib/deliver-slack.js.map +1 -0
  107. package/dist/lib/deliver.d.ts +10 -0
  108. package/dist/lib/deliver.d.ts.map +1 -0
  109. package/dist/lib/deliver.js +95 -0
  110. package/dist/lib/deliver.js.map +1 -0
  111. package/dist/lib/llm/anthropic.d.ts +7 -0
  112. package/dist/lib/llm/anthropic.d.ts.map +1 -0
  113. package/dist/lib/llm/anthropic.js +69 -0
  114. package/dist/lib/llm/anthropic.js.map +1 -0
  115. package/dist/lib/llm/bedrock.d.ts +7 -0
  116. package/dist/lib/llm/bedrock.d.ts.map +1 -0
  117. package/dist/lib/llm/bedrock.js +67 -0
  118. package/dist/lib/llm/bedrock.js.map +1 -0
  119. package/dist/lib/llm/gemini.d.ts +7 -0
  120. package/dist/lib/llm/gemini.d.ts.map +1 -0
  121. package/dist/lib/llm/gemini.js +67 -0
  122. package/dist/lib/llm/gemini.js.map +1 -0
  123. package/dist/lib/llm/index.d.ts +5 -0
  124. package/dist/lib/llm/index.d.ts.map +1 -0
  125. package/dist/lib/llm/index.js +61 -0
  126. package/dist/lib/llm/index.js.map +1 -0
  127. package/dist/lib/llm/models.d.ts +5 -0
  128. package/dist/lib/llm/models.d.ts.map +1 -0
  129. package/dist/lib/llm/models.js +33 -0
  130. package/dist/lib/llm/models.js.map +1 -0
  131. package/dist/lib/llm/openai.d.ts +8 -0
  132. package/dist/lib/llm/openai.d.ts.map +1 -0
  133. package/dist/lib/llm/openai.js +48 -0
  134. package/dist/lib/llm/openai.js.map +1 -0
  135. package/dist/lib/llm/provider.d.ts +28 -0
  136. package/dist/lib/llm/provider.d.ts.map +1 -0
  137. package/dist/lib/llm/provider.js +3 -0
  138. package/dist/lib/llm/provider.js.map +1 -0
  139. package/dist/lib/manifest.d.ts +95 -0
  140. package/dist/lib/manifest.d.ts.map +1 -0
  141. package/dist/lib/manifest.js +105 -0
  142. package/dist/lib/manifest.js.map +1 -0
  143. package/dist/lib/params.d.ts +27 -0
  144. package/dist/lib/params.d.ts.map +1 -0
  145. package/dist/lib/params.js +192 -0
  146. package/dist/lib/params.js.map +1 -0
  147. package/dist/lib/pdf.d.ts +8 -0
  148. package/dist/lib/pdf.d.ts.map +1 -0
  149. package/dist/lib/pdf.js +86 -0
  150. package/dist/lib/pdf.js.map +1 -0
  151. package/dist/lib/renderer.d.ts +17 -0
  152. package/dist/lib/renderer.d.ts.map +1 -0
  153. package/dist/lib/renderer.js +166 -0
  154. package/dist/lib/renderer.js.map +1 -0
  155. package/dist/lib/schema-filter.d.ts +3 -0
  156. package/dist/lib/schema-filter.d.ts.map +1 -0
  157. package/dist/lib/schema-filter.js +49 -0
  158. package/dist/lib/schema-filter.js.map +1 -0
  159. package/dist/lib/template.d.ts +4 -0
  160. package/dist/lib/template.d.ts.map +1 -0
  161. package/dist/lib/template.js +37 -0
  162. package/dist/lib/template.js.map +1 -0
  163. package/dist/lib/validator.d.ts +8 -0
  164. package/dist/lib/validator.d.ts.map +1 -0
  165. package/dist/lib/validator.js +88 -0
  166. package/dist/lib/validator.js.map +1 -0
  167. package/package.json +59 -0
  168. package/schemas/deck.schema.json +122 -0
  169. package/schemas/report-manifest.schema.json +309 -0
  170. package/schemas/tables/README.md +45 -0
  171. package/schemas/tables/ultracart_dw/uc_affiliate_clicks.json +186 -0
  172. package/schemas/tables/ultracart_dw/uc_affiliate_commission_groups.json +317 -0
  173. package/schemas/tables/ultracart_dw/uc_affiliate_ledgers.json +404 -0
  174. package/schemas/tables/ultracart_dw/uc_affiliate_network_pixel_postback_logs.json +166 -0
  175. package/schemas/tables/ultracart_dw/uc_affiliate_network_pixels.json +106 -0
  176. package/schemas/tables/ultracart_dw/uc_affiliate_payments.json +204 -0
  177. package/schemas/tables/ultracart_dw/uc_affiliate_postback_logs.json +90 -0
  178. package/schemas/tables/ultracart_dw/uc_affiliates.json +425 -0
  179. package/schemas/tables/ultracart_dw/uc_auto_orders.json +13848 -0
  180. package/schemas/tables/ultracart_dw/uc_cart_abandons.json +3971 -0
  181. package/schemas/tables/ultracart_dw/uc_conversation_pbx_calls.json +374 -0
  182. package/schemas/tables/ultracart_dw/uc_conversations.json +374 -0
  183. package/schemas/tables/ultracart_dw/uc_coupons.json +1893 -0
  184. package/schemas/tables/ultracart_dw/uc_customers.json +11886 -0
  185. package/schemas/tables/ultracart_dw/uc_fraud_rules.json +239 -0
  186. package/schemas/tables/ultracart_dw/uc_gift_certificates.json +135 -0
  187. package/schemas/tables/ultracart_dw/uc_item_inventory_history.json +79 -0
  188. package/schemas/tables/ultracart_dw/uc_items.json +4437 -0
  189. package/schemas/tables/ultracart_dw/uc_orders.json +6629 -0
  190. package/schemas/tables/ultracart_dw/uc_rotating_transaction_gateway_history.json +271 -0
  191. package/schemas/tables/ultracart_dw/uc_rotating_transaction_gateways.json +416 -0
  192. package/schemas/tables/ultracart_dw/uc_shipping_methods.json +1372 -0
  193. package/schemas/tables/ultracart_dw/uc_storefront_customers.json +261 -0
  194. package/schemas/tables/ultracart_dw/uc_storefront_experiments.json +386 -0
  195. package/schemas/tables/ultracart_dw/uc_storefront_pages.json +513 -0
  196. package/schemas/tables/ultracart_dw/uc_storefront_upsell_offer_events.json +338 -0
  197. package/schemas/tables/ultracart_dw/uc_storefront_upsell_offers.json +431 -0
  198. package/schemas/tables/ultracart_dw/uc_storefront_upsell_paths.json +163 -0
  199. package/schemas/tables/ultracart_dw/uc_storefronts.json +62 -0
  200. package/schemas/tables/ultracart_dw/uc_surveys.json +238 -0
  201. package/schemas/tables/ultracart_dw/uc_workflow_tasks.json +377 -0
  202. package/schemas/tables/ultracart_dw/uc_zoho_desk_tickets.json +1184 -0
  203. package/schemas/tables/ultracart_dw_high/uc_affiliate_clicks.json +186 -0
  204. package/schemas/tables/ultracart_dw_high/uc_affiliate_commission_groups.json +317 -0
  205. package/schemas/tables/ultracart_dw_high/uc_affiliate_ledgers.json +404 -0
  206. package/schemas/tables/ultracart_dw_high/uc_affiliate_network_pixel_postback_logs.json +166 -0
  207. package/schemas/tables/ultracart_dw_high/uc_affiliate_network_pixels.json +106 -0
  208. package/schemas/tables/ultracart_dw_high/uc_affiliate_payments.json +204 -0
  209. package/schemas/tables/ultracart_dw_high/uc_affiliate_postback_logs.json +90 -0
  210. package/schemas/tables/ultracart_dw_high/uc_affiliates.json +425 -0
  211. package/schemas/tables/ultracart_dw_high/uc_auto_orders.json +14332 -0
  212. package/schemas/tables/ultracart_dw_high/uc_cart_abandons.json +4245 -0
  213. package/schemas/tables/ultracart_dw_high/uc_conversation_pbx_calls.json +415 -0
  214. package/schemas/tables/ultracart_dw_high/uc_conversations.json +415 -0
  215. package/schemas/tables/ultracart_dw_high/uc_coupons.json +1893 -0
  216. package/schemas/tables/ultracart_dw_high/uc_customers.json +12250 -0
  217. package/schemas/tables/ultracart_dw_high/uc_fraud_rules.json +239 -0
  218. package/schemas/tables/ultracart_dw_high/uc_gift_certificates.json +135 -0
  219. package/schemas/tables/ultracart_dw_high/uc_item_inventory_history.json +79 -0
  220. package/schemas/tables/ultracart_dw_high/uc_items.json +4437 -0
  221. package/schemas/tables/ultracart_dw_high/uc_orders.json +6871 -0
  222. package/schemas/tables/ultracart_dw_high/uc_rotating_transaction_gateway_history.json +271 -0
  223. package/schemas/tables/ultracart_dw_high/uc_rotating_transaction_gateways.json +416 -0
  224. package/schemas/tables/ultracart_dw_high/uc_shipping_methods.json +1372 -0
  225. package/schemas/tables/ultracart_dw_high/uc_storefront_customers.json +261 -0
  226. package/schemas/tables/ultracart_dw_high/uc_storefront_experiments.json +386 -0
  227. package/schemas/tables/ultracart_dw_high/uc_storefront_pages.json +513 -0
  228. package/schemas/tables/ultracart_dw_high/uc_storefront_upsell_offer_events.json +338 -0
  229. package/schemas/tables/ultracart_dw_high/uc_storefront_upsell_offers.json +431 -0
  230. package/schemas/tables/ultracart_dw_high/uc_storefront_upsell_paths.json +163 -0
  231. package/schemas/tables/ultracart_dw_high/uc_storefronts.json +62 -0
  232. package/schemas/tables/ultracart_dw_high/uc_surveys.json +269 -0
  233. package/schemas/tables/ultracart_dw_high/uc_workflow_tasks.json +377 -0
  234. package/schemas/tables/ultracart_dw_high/uc_zoho_desk_tickets.json +1330 -0
  235. package/schemas/tables/ultracart_dw_low/uc_affiliate_clicks.json +186 -0
  236. package/schemas/tables/ultracart_dw_low/uc_affiliate_commission_groups.json +317 -0
  237. package/schemas/tables/ultracart_dw_low/uc_affiliate_ledgers.json +404 -0
  238. package/schemas/tables/ultracart_dw_low/uc_affiliate_network_pixel_postback_logs.json +166 -0
  239. package/schemas/tables/ultracart_dw_low/uc_affiliate_network_pixels.json +106 -0
  240. package/schemas/tables/ultracart_dw_low/uc_affiliate_payments.json +204 -0
  241. package/schemas/tables/ultracart_dw_low/uc_affiliate_postback_logs.json +90 -0
  242. package/schemas/tables/ultracart_dw_low/uc_affiliates.json +425 -0
  243. package/schemas/tables/ultracart_dw_low/uc_auto_orders.json +13868 -0
  244. package/schemas/tables/ultracart_dw_low/uc_cart_abandons.json +3971 -0
  245. package/schemas/tables/ultracart_dw_low/uc_conversation_pbx_calls.json +374 -0
  246. package/schemas/tables/ultracart_dw_low/uc_conversations.json +374 -0
  247. package/schemas/tables/ultracart_dw_low/uc_coupons.json +1893 -0
  248. package/schemas/tables/ultracart_dw_low/uc_customers.json +11900 -0
  249. package/schemas/tables/ultracart_dw_low/uc_fraud_rules.json +239 -0
  250. package/schemas/tables/ultracart_dw_low/uc_gift_certificates.json +135 -0
  251. package/schemas/tables/ultracart_dw_low/uc_item_inventory_history.json +79 -0
  252. package/schemas/tables/ultracart_dw_low/uc_items.json +4437 -0
  253. package/schemas/tables/ultracart_dw_low/uc_orders.json +6639 -0
  254. package/schemas/tables/ultracart_dw_low/uc_rotating_transaction_gateway_history.json +271 -0
  255. package/schemas/tables/ultracart_dw_low/uc_rotating_transaction_gateways.json +416 -0
  256. package/schemas/tables/ultracart_dw_low/uc_shipping_methods.json +1372 -0
  257. package/schemas/tables/ultracart_dw_low/uc_storefront_customers.json +261 -0
  258. package/schemas/tables/ultracart_dw_low/uc_storefront_experiments.json +386 -0
  259. package/schemas/tables/ultracart_dw_low/uc_storefront_pages.json +513 -0
  260. package/schemas/tables/ultracart_dw_low/uc_storefront_upsell_offer_events.json +338 -0
  261. package/schemas/tables/ultracart_dw_low/uc_storefront_upsell_offers.json +431 -0
  262. package/schemas/tables/ultracart_dw_low/uc_storefront_upsell_paths.json +163 -0
  263. package/schemas/tables/ultracart_dw_low/uc_storefronts.json +62 -0
  264. package/schemas/tables/ultracart_dw_low/uc_surveys.json +238 -0
  265. package/schemas/tables/ultracart_dw_low/uc_workflow_tasks.json +377 -0
  266. package/schemas/tables/ultracart_dw_low/uc_zoho_desk_tickets.json +1184 -0
  267. package/schemas/tables/ultracart_dw_medium/uc_affiliate_clicks.json +186 -0
  268. package/schemas/tables/ultracart_dw_medium/uc_affiliate_commission_groups.json +317 -0
  269. package/schemas/tables/ultracart_dw_medium/uc_affiliate_ledgers.json +404 -0
  270. package/schemas/tables/ultracart_dw_medium/uc_affiliate_network_pixel_postback_logs.json +166 -0
  271. package/schemas/tables/ultracart_dw_medium/uc_affiliate_network_pixels.json +106 -0
  272. package/schemas/tables/ultracart_dw_medium/uc_affiliate_payments.json +204 -0
  273. package/schemas/tables/ultracart_dw_medium/uc_affiliate_postback_logs.json +90 -0
  274. package/schemas/tables/ultracart_dw_medium/uc_affiliates.json +425 -0
  275. package/schemas/tables/ultracart_dw_medium/uc_auto_orders.json +14320 -0
  276. package/schemas/tables/ultracart_dw_medium/uc_cart_abandons.json +4245 -0
  277. package/schemas/tables/ultracart_dw_medium/uc_conversation_pbx_calls.json +415 -0
  278. package/schemas/tables/ultracart_dw_medium/uc_conversations.json +415 -0
  279. package/schemas/tables/ultracart_dw_medium/uc_coupons.json +1893 -0
  280. package/schemas/tables/ultracart_dw_medium/uc_customers.json +12250 -0
  281. package/schemas/tables/ultracart_dw_medium/uc_fraud_rules.json +239 -0
  282. package/schemas/tables/ultracart_dw_medium/uc_gift_certificates.json +135 -0
  283. package/schemas/tables/ultracart_dw_medium/uc_item_inventory_history.json +79 -0
  284. package/schemas/tables/ultracart_dw_medium/uc_items.json +4437 -0
  285. package/schemas/tables/ultracart_dw_medium/uc_orders.json +6865 -0
  286. package/schemas/tables/ultracart_dw_medium/uc_rotating_transaction_gateway_history.json +271 -0
  287. package/schemas/tables/ultracart_dw_medium/uc_rotating_transaction_gateways.json +416 -0
  288. package/schemas/tables/ultracart_dw_medium/uc_shipping_methods.json +1372 -0
  289. package/schemas/tables/ultracart_dw_medium/uc_storefront_customers.json +261 -0
  290. package/schemas/tables/ultracart_dw_medium/uc_storefront_experiments.json +386 -0
  291. package/schemas/tables/ultracart_dw_medium/uc_storefront_pages.json +513 -0
  292. package/schemas/tables/ultracart_dw_medium/uc_storefront_upsell_offer_events.json +338 -0
  293. package/schemas/tables/ultracart_dw_medium/uc_storefront_upsell_offers.json +431 -0
  294. package/schemas/tables/ultracart_dw_medium/uc_storefront_upsell_paths.json +163 -0
  295. package/schemas/tables/ultracart_dw_medium/uc_storefronts.json +62 -0
  296. package/schemas/tables/ultracart_dw_medium/uc_surveys.json +269 -0
  297. package/schemas/tables/ultracart_dw_medium/uc_workflow_tasks.json +377 -0
  298. package/schemas/tables/ultracart_dw_medium/uc_zoho_desk_tickets.json +1330 -0
  299. package/schemas/tables/ultracart_dw_streaming/uc_analytics_session_streaming.json +2444 -0
  300. package/schemas/tables/ultracart_dw_streaming/uc_screen_recording_streaming.json +509 -0
  301. package/schemas/ultracart-bq-config.schema.json +140 -0
  302. package/skill/skill.md +1228 -0
  303. package/templates/render.html +73 -0
@@ -0,0 +1,4437 @@
1
+ [
2
+ {
3
+ "mode": "NULLABLE",
4
+ "name": "partition_oid",
5
+ "type": "INTEGER"
6
+ },
7
+ {
8
+ "mode": "NULLABLE",
9
+ "name": "merchant_item_oid",
10
+ "description": "Unique object identifier for this item",
11
+ "type": "INTEGER"
12
+ },
13
+ {
14
+ "mode": "NULLABLE",
15
+ "name": "merchant_id",
16
+ "description": "UltraCart merchant ID owning item",
17
+ "type": "STRING"
18
+ },
19
+ {
20
+ "mode": "NULLABLE",
21
+ "name": "merchant_item_id",
22
+ "description": "Unique item id assigned to this item",
23
+ "type": "STRING"
24
+ },
25
+ {
26
+ "mode": "NULLABLE",
27
+ "name": "description",
28
+ "description": "Description of the item up to 500 characters.",
29
+ "type": "STRING"
30
+ },
31
+ {
32
+ "mode": "NULLABLE",
33
+ "name": "description_translated_text_instance_oid",
34
+ "description": "Description translated text instance id",
35
+ "type": "INTEGER"
36
+ },
37
+ {
38
+ "mode": "NULLABLE",
39
+ "name": "parent_category_id",
40
+ "description": "Parent category of the item. Zero indicates the root folder.",
41
+ "type": "INTEGER"
42
+ },
43
+ {
44
+ "mode": "NULLABLE",
45
+ "name": "parent_category_path",
46
+ "description": "Parent category path. / indicates the root folder. This is the folder structure within item management.",
47
+ "type": "STRING"
48
+ },
49
+ {
50
+ "mode": "NULLABLE",
51
+ "name": "kit",
52
+ "description": "True if this item is a kit",
53
+ "type": "BOOLEAN"
54
+ },
55
+ {
56
+ "mode": "NULLABLE",
57
+ "name": "inactive",
58
+ "description": "True if this item is inactive and can not be purchased",
59
+ "type": "BOOLEAN"
60
+ },
61
+ {
62
+ "mode": "NULLABLE",
63
+ "name": "last_modified_dts",
64
+ "description": "Date/time of last modification",
65
+ "type": "DATETIME"
66
+ },
67
+ {
68
+ "mode": "NULLABLE",
69
+ "name": "creation_dts",
70
+ "description": "Date/time of creation",
71
+ "type": "DATETIME"
72
+ },
73
+ {
74
+ "mode": "NULLABLE",
75
+ "name": "kit_component_only",
76
+ "description": "True if this item can only be usd as a kit component",
77
+ "type": "BOOLEAN"
78
+ },
79
+ {
80
+ "name": "pricing",
81
+ "description": "Pricing",
82
+ "type": "RECORD",
83
+ "fields": [
84
+ {
85
+ "mode": "NULLABLE",
86
+ "name": "cost",
87
+ "description": "Cost",
88
+ "type": "NUMERIC"
89
+ },
90
+ {
91
+ "mode": "NULLABLE",
92
+ "name": "currency_code",
93
+ "description": "Currency code",
94
+ "type": "STRING"
95
+ },
96
+ {
97
+ "mode": "NULLABLE",
98
+ "name": "manufacturer_suggested_retail_price",
99
+ "description": "Manufacturer suggested retail price",
100
+ "type": "NUMERIC"
101
+ },
102
+ {
103
+ "mode": "NULLABLE",
104
+ "name": "minimum_advertised_price",
105
+ "description": "Minimum advertised price",
106
+ "type": "NUMERIC"
107
+ },
108
+ {
109
+ "mode": "NULLABLE",
110
+ "name": "cogs",
111
+ "description": "Cost of goods sold",
112
+ "type": "NUMERIC"
113
+ },
114
+ {
115
+ "mode": "NULLABLE",
116
+ "name": "mix_and_match_group_oid",
117
+ "description": "Mix and match group object identifier",
118
+ "type": "INTEGER"
119
+ },
120
+ {
121
+ "mode": "NULLABLE",
122
+ "name": "mix_and_match_group",
123
+ "description": "Mix and match group",
124
+ "type": "STRING"
125
+ },
126
+ {
127
+ "mode": "NULLABLE",
128
+ "name": "sale_cost",
129
+ "description": "Sale cost",
130
+ "type": "NUMERIC"
131
+ },
132
+ {
133
+ "mode": "NULLABLE",
134
+ "name": "sale_start",
135
+ "description": "Sale start",
136
+ "type": "DATETIME"
137
+ },
138
+ {
139
+ "mode": "NULLABLE",
140
+ "name": "sale_end",
141
+ "description": "Sale end",
142
+ "type": "DATETIME"
143
+ },
144
+ {
145
+ "mode": "NULLABLE",
146
+ "name": "allow_arbitrary_cost",
147
+ "description": "Allow arbitrary cost",
148
+ "type": "BOOLEAN"
149
+ },
150
+ {
151
+ "mode": "NULLABLE",
152
+ "name": "minimum_arbitrary_cost",
153
+ "description": "Minimum arbitrary cost",
154
+ "type": "NUMERIC"
155
+ },
156
+ {
157
+ "mode": "NULLABLE",
158
+ "name": "maximum_arbitrary_cost",
159
+ "description": "Maximum arbitrary cost",
160
+ "type": "NUMERIC"
161
+ },
162
+ {
163
+ "mode": "NULLABLE",
164
+ "name": "arbitrary_cost_velocity_code",
165
+ "description": "Arbitrary cost velocity code",
166
+ "type": "STRING"
167
+ },
168
+ {
169
+ "mode": "NULLABLE",
170
+ "name": "automatic_pricing_tier_oid",
171
+ "description": "Automatic pricing tier object identifier",
172
+ "type": "INTEGER"
173
+ },
174
+ {
175
+ "mode": "NULLABLE",
176
+ "name": "automatic_pricing_tier_name",
177
+ "description": "Automatic pricing tier name",
178
+ "type": "STRING"
179
+ },
180
+ {
181
+ "mode": "REPEATED",
182
+ "name": "tiers",
183
+ "description": "Tiers",
184
+ "type": "RECORD",
185
+ "fields": [
186
+ {
187
+ "mode": "NULLABLE",
188
+ "name": "pricing_tier_oid",
189
+ "description": "Pricing tier object identifier",
190
+ "type": "INTEGER"
191
+ },
192
+ {
193
+ "mode": "NULLABLE",
194
+ "name": "name",
195
+ "description": "Pricing tier name",
196
+ "type": "STRING"
197
+ },
198
+ {
199
+ "mode": "NULLABLE",
200
+ "name": "default_tier",
201
+ "description": "True if this is the default tier",
202
+ "type": "BOOLEAN"
203
+ },
204
+ {
205
+ "mode": "REPEATED",
206
+ "name": "discounts",
207
+ "description": "Discounts",
208
+ "type": "RECORD",
209
+ "fields": [
210
+ {
211
+ "mode": "NULLABLE",
212
+ "name": "quantity",
213
+ "description": "Quantity",
214
+ "type": "INTEGER"
215
+ },
216
+ {
217
+ "mode": "NULLABLE",
218
+ "name": "cost",
219
+ "description": "Cost",
220
+ "type": "NUMERIC"
221
+ }
222
+ ]
223
+ },
224
+ {
225
+ "name": "limit",
226
+ "description": "Limits",
227
+ "type": "RECORD",
228
+ "fields": [
229
+ {
230
+ "mode": "NULLABLE",
231
+ "name": "individual_order_limit",
232
+ "description": "Individual order limit",
233
+ "type": "INTEGER"
234
+ },
235
+ {
236
+ "mode": "NULLABLE",
237
+ "name": "cumulative_order_limit",
238
+ "description": "Cumulative order limit",
239
+ "type": "INTEGER"
240
+ },
241
+ {
242
+ "mode": "NULLABLE",
243
+ "name": "multiple_quantity",
244
+ "description": "Multiple quantity",
245
+ "type": "INTEGER"
246
+ },
247
+ {
248
+ "mode": "NULLABLE",
249
+ "name": "exempt_from_minimum_item_count",
250
+ "description": "Exempt from Minimum Item Count",
251
+ "type": "BOOLEAN"
252
+ },
253
+ {
254
+ "mode": "REPEATED",
255
+ "name": "payment_method_validity",
256
+ "description": "Payment method validity",
257
+ "type": "RECORD",
258
+ "fields": [{
259
+ "mode": "NULLABLE",
260
+ "name": "value",
261
+ "type": "STRING"
262
+ }]
263
+ }
264
+ ]
265
+ }
266
+ ]
267
+ },
268
+ {
269
+ "mode": "NULLABLE",
270
+ "name": "auto_order_cost",
271
+ "description": "Cost if customer selects to receive item on auto order. Set to zero to delete.",
272
+ "type": "NUMERIC"
273
+ }
274
+ ]
275
+ },
276
+ {
277
+ "name": "shipping",
278
+ "description": "Shipping",
279
+ "type": "RECORD",
280
+ "fields": [
281
+ {
282
+ "mode": "NULLABLE",
283
+ "name": "allow_back_order",
284
+ "description": "Allow back order",
285
+ "type": "BOOLEAN"
286
+ },
287
+ {
288
+ "mode": "NULLABLE",
289
+ "name": "track_inventory",
290
+ "description": "Track inventory",
291
+ "type": "BOOLEAN"
292
+ },
293
+ {
294
+ "mode": "NULLABLE",
295
+ "name": "no_shipping_discount",
296
+ "description": "No shipping discounts",
297
+ "type": "BOOLEAN"
298
+ },
299
+ {
300
+ "mode": "NULLABLE",
301
+ "name": "ship_separately",
302
+ "description": "Ship this item in a separate box",
303
+ "type": "BOOLEAN"
304
+ },
305
+ {
306
+ "mode": "NULLABLE",
307
+ "name": "preorder",
308
+ "description": "This item is on pre-order",
309
+ "type": "BOOLEAN"
310
+ },
311
+ {
312
+ "mode": "NULLABLE",
313
+ "name": "hazmat",
314
+ "description": "Hazardous material",
315
+ "type": "BOOLEAN"
316
+ },
317
+ {
318
+ "mode": "NULLABLE",
319
+ "name": "country_code_of_origin",
320
+ "description": "Country code of origin for customs forms. (ISO-3166 two letter code)",
321
+ "type": "STRING"
322
+ },
323
+ {
324
+ "mode": "NULLABLE",
325
+ "name": "max_days_time_in_transit",
326
+ "description": "Maximum days allowed in transit",
327
+ "type": "INTEGER"
328
+ },
329
+ {
330
+ "mode": "NULLABLE",
331
+ "name": "customs_description",
332
+ "description": "Customs description",
333
+ "type": "STRING"
334
+ },
335
+ {
336
+ "mode": "NULLABLE",
337
+ "name": "perishable_class_oid",
338
+ "description": "Perishable class object identifier",
339
+ "type": "INTEGER"
340
+ },
341
+ {
342
+ "mode": "NULLABLE",
343
+ "name": "perishable_class_name",
344
+ "description": "Perishable class name",
345
+ "type": "STRING"
346
+ },
347
+ {
348
+ "mode": "NULLABLE",
349
+ "name": "case_units",
350
+ "description": "Case units",
351
+ "type": "INTEGER"
352
+ },
353
+ {
354
+ "mode": "NULLABLE",
355
+ "name": "freight_class",
356
+ "description": "Freight class",
357
+ "type": "STRING"
358
+ },
359
+ {
360
+ "mode": "NULLABLE",
361
+ "name": "restrict_shipment_on_sunday",
362
+ "description": "Restrict shipment on Sunday",
363
+ "type": "BOOLEAN"
364
+ },
365
+ {
366
+ "mode": "NULLABLE",
367
+ "name": "restrict_shipment_on_monday",
368
+ "description": "Restrict shipment on Monday",
369
+ "type": "BOOLEAN"
370
+ },
371
+ {
372
+ "mode": "NULLABLE",
373
+ "name": "restrict_shipment_on_tuesday",
374
+ "description": "Restrict shipment on Tuesday",
375
+ "type": "BOOLEAN"
376
+ },
377
+ {
378
+ "mode": "NULLABLE",
379
+ "name": "restrict_shipment_on_wednesday",
380
+ "description": "Restrict shipment on Wednesday",
381
+ "type": "BOOLEAN"
382
+ },
383
+ {
384
+ "mode": "NULLABLE",
385
+ "name": "restrict_shipment_on_thursday",
386
+ "description": "Restrict shipment on Thursday",
387
+ "type": "BOOLEAN"
388
+ },
389
+ {
390
+ "mode": "NULLABLE",
391
+ "name": "restrict_shipment_on_friday",
392
+ "description": "Restrict shipment on Friday",
393
+ "type": "BOOLEAN"
394
+ },
395
+ {
396
+ "mode": "NULLABLE",
397
+ "name": "restrict_shipment_on_saturday",
398
+ "description": "Restrict shipment on Saturday",
399
+ "type": "BOOLEAN"
400
+ },
401
+ {
402
+ "mode": "NULLABLE",
403
+ "name": "customs_value",
404
+ "description": "Customs value",
405
+ "type": "NUMERIC"
406
+ },
407
+ {
408
+ "mode": "NULLABLE",
409
+ "name": "eta",
410
+ "description": "Estimated time of arrival",
411
+ "type": "DATETIME"
412
+ },
413
+ {
414
+ "mode": "NULLABLE",
415
+ "name": "amazon_fba",
416
+ "description": "Fulfillment by Amazon.com",
417
+ "type": "BOOLEAN"
418
+ },
419
+ {
420
+ "name": "ship_separately_length",
421
+ "description": "Ship separately box length",
422
+ "type": "RECORD",
423
+ "fields": [
424
+ {
425
+ "mode": "NULLABLE",
426
+ "name": "value",
427
+ "description": "The distance measured in UOM",
428
+ "type": "NUMERIC"
429
+ },
430
+ {
431
+ "allowed_values": [
432
+ "IN",
433
+ "CM"
434
+ ],
435
+ "mode": "NULLABLE",
436
+ "name": "uom",
437
+ "description": "Unit of measure",
438
+ "type": "STRING"
439
+ }
440
+ ]
441
+ },
442
+ {
443
+ "name": "ship_separately_width",
444
+ "description": "Ship separately box width",
445
+ "type": "RECORD",
446
+ "fields": [
447
+ {
448
+ "mode": "NULLABLE",
449
+ "name": "value",
450
+ "description": "The distance measured in UOM",
451
+ "type": "NUMERIC"
452
+ },
453
+ {
454
+ "allowed_values": [
455
+ "IN",
456
+ "CM"
457
+ ],
458
+ "mode": "NULLABLE",
459
+ "name": "uom",
460
+ "description": "Unit of measure",
461
+ "type": "STRING"
462
+ }
463
+ ]
464
+ },
465
+ {
466
+ "name": "ship_separately_height",
467
+ "description": "Ship separately box height",
468
+ "type": "RECORD",
469
+ "fields": [
470
+ {
471
+ "mode": "NULLABLE",
472
+ "name": "value",
473
+ "description": "The distance measured in UOM",
474
+ "type": "NUMERIC"
475
+ },
476
+ {
477
+ "allowed_values": [
478
+ "IN",
479
+ "CM"
480
+ ],
481
+ "mode": "NULLABLE",
482
+ "name": "uom",
483
+ "description": "Unit of measure",
484
+ "type": "STRING"
485
+ }
486
+ ]
487
+ },
488
+ {
489
+ "name": "ship_separately_additional_weight",
490
+ "description": "Ship separately box weight",
491
+ "type": "RECORD",
492
+ "fields": [
493
+ {
494
+ "mode": "NULLABLE",
495
+ "name": "value",
496
+ "description": "Weight",
497
+ "type": "NUMERIC"
498
+ },
499
+ {
500
+ "allowed_values": [
501
+ "KG",
502
+ "G",
503
+ "LB",
504
+ "OZ"
505
+ ],
506
+ "mode": "NULLABLE",
507
+ "name": "uom",
508
+ "description": "Unit of measure",
509
+ "type": "STRING"
510
+ }
511
+ ]
512
+ },
513
+ {
514
+ "mode": "NULLABLE",
515
+ "name": "hold_for_transmission",
516
+ "description": "Hold for transmission",
517
+ "type": "BOOLEAN"
518
+ },
519
+ {
520
+ "mode": "NULLABLE",
521
+ "name": "ship_separately_package_special_type",
522
+ "description": "Ship separately package special type",
523
+ "type": "STRING"
524
+ },
525
+ {
526
+ "mode": "NULLABLE",
527
+ "name": "require_delivery_date",
528
+ "description": "True to require customer to select a delivery date",
529
+ "type": "BOOLEAN"
530
+ },
531
+ {
532
+ "mode": "NULLABLE",
533
+ "name": "delivery_on_monday",
534
+ "description": "Delivery on Monday",
535
+ "type": "BOOLEAN"
536
+ },
537
+ {
538
+ "mode": "NULLABLE",
539
+ "name": "delivery_on_tuesday",
540
+ "description": "Delivery on Tuesday",
541
+ "type": "BOOLEAN"
542
+ },
543
+ {
544
+ "mode": "NULLABLE",
545
+ "name": "delivery_on_wednesday",
546
+ "description": "Delivery on Wednesday",
547
+ "type": "BOOLEAN"
548
+ },
549
+ {
550
+ "mode": "NULLABLE",
551
+ "name": "delivery_on_thursday",
552
+ "description": "Delivery on Thursday",
553
+ "type": "BOOLEAN"
554
+ },
555
+ {
556
+ "mode": "NULLABLE",
557
+ "name": "delivery_on_friday",
558
+ "description": "Delivery on Friday",
559
+ "type": "BOOLEAN"
560
+ },
561
+ {
562
+ "mode": "NULLABLE",
563
+ "name": "delivery_on_saturday",
564
+ "description": "Delivery on Saturday",
565
+ "type": "BOOLEAN"
566
+ },
567
+ {
568
+ "mode": "NULLABLE",
569
+ "name": "delivery_on_sunday",
570
+ "description": "Delivery on Sunday",
571
+ "type": "BOOLEAN"
572
+ },
573
+ {
574
+ "mode": "NULLABLE",
575
+ "name": "made_to_order",
576
+ "description": "True if this item is made to order",
577
+ "type": "BOOLEAN"
578
+ },
579
+ {
580
+ "mode": "NULLABLE",
581
+ "name": "made_to_order_lead_time",
582
+ "description": "Number of days lead time it takes to make the item before ite can ship",
583
+ "type": "INTEGER"
584
+ },
585
+ {
586
+ "mode": "NULLABLE",
587
+ "name": "free_shipping",
588
+ "description": "Qualifies for free shipping",
589
+ "type": "BOOLEAN"
590
+ },
591
+ {
592
+ "mode": "NULLABLE",
593
+ "name": "special_product_type",
594
+ "description": "Special product type (USPS Media Mail)",
595
+ "type": "STRING"
596
+ },
597
+ {
598
+ "mode": "REPEATED",
599
+ "name": "methods",
600
+ "description": "Methods",
601
+ "type": "RECORD",
602
+ "fields": [
603
+ {
604
+ "mode": "NULLABLE",
605
+ "name": "shipping_method_oid",
606
+ "description": "Shipping method object identifier",
607
+ "type": "INTEGER"
608
+ },
609
+ {
610
+ "mode": "NULLABLE",
611
+ "name": "shipping_method",
612
+ "description": "Shipping method name",
613
+ "type": "STRING"
614
+ },
615
+ {
616
+ "mode": "NULLABLE",
617
+ "name": "cost",
618
+ "description": "Cost",
619
+ "type": "NUMERIC"
620
+ },
621
+ {
622
+ "allowed_values": [
623
+ "invalid for",
624
+ "valid for",
625
+ "valid only for"
626
+ ],
627
+ "mode": "NULLABLE",
628
+ "name": "shipping_method_validity",
629
+ "description": "Shipping method validity",
630
+ "type": "STRING"
631
+ },
632
+ {
633
+ "mode": "NULLABLE",
634
+ "name": "free_shipping",
635
+ "description": "Free shipping",
636
+ "type": "BOOLEAN"
637
+ },
638
+ {
639
+ "mode": "NULLABLE",
640
+ "name": "flat_fee_markup",
641
+ "description": "Flat fee markup",
642
+ "type": "NUMERIC"
643
+ },
644
+ {
645
+ "mode": "NULLABLE",
646
+ "name": "per_item_fee_markup",
647
+ "description": "Per item fee markup",
648
+ "type": "NUMERIC"
649
+ },
650
+ {
651
+ "mode": "NULLABLE",
652
+ "name": "percentage_markup",
653
+ "description": "Percentage markup",
654
+ "type": "NUMERIC"
655
+ },
656
+ {
657
+ "mode": "NULLABLE",
658
+ "name": "first_item_markup",
659
+ "description": "First item markup",
660
+ "type": "NUMERIC"
661
+ },
662
+ {
663
+ "mode": "NULLABLE",
664
+ "name": "each_additional_item_markup",
665
+ "description": "Each additional item markup",
666
+ "type": "NUMERIC"
667
+ },
668
+ {
669
+ "mode": "NULLABLE",
670
+ "name": "relax_restrictions_on_upsell",
671
+ "description": "Relax restrictions on upsell",
672
+ "type": "BOOLEAN"
673
+ },
674
+ {
675
+ "mode": "NULLABLE",
676
+ "name": "ships_separately",
677
+ "description": "Ships separately",
678
+ "type": "BOOLEAN"
679
+ },
680
+ {
681
+ "mode": "NULLABLE",
682
+ "name": "filter_to_if_available",
683
+ "description": "Filter to this method if available",
684
+ "type": "BOOLEAN"
685
+ },
686
+ {
687
+ "mode": "NULLABLE",
688
+ "name": "percentage_of_item_markup",
689
+ "description": "Percentage of item markup",
690
+ "type": "NUMERIC"
691
+ },
692
+ {
693
+ "mode": "NULLABLE",
694
+ "name": "fixed_shipping_cost",
695
+ "description": "Fixed shipping cost",
696
+ "type": "NUMERIC"
697
+ },
698
+ {
699
+ "mode": "NULLABLE",
700
+ "name": "signature_required",
701
+ "description": "Signature required",
702
+ "type": "BOOLEAN"
703
+ }
704
+ ]
705
+ },
706
+ {
707
+ "mode": "REPEATED",
708
+ "name": "distribution_centers",
709
+ "description": "Distribution centers",
710
+ "type": "RECORD",
711
+ "fields": [
712
+ {
713
+ "mode": "NULLABLE",
714
+ "name": "distribution_center_oid",
715
+ "description": "Distribution center object identifier",
716
+ "type": "INTEGER"
717
+ },
718
+ {
719
+ "mode": "NULLABLE",
720
+ "name": "distribution_center_code",
721
+ "description": "Distribution center code",
722
+ "type": "STRING"
723
+ },
724
+ {
725
+ "mode": "NULLABLE",
726
+ "name": "inventory_level",
727
+ "description": "Inventory level",
728
+ "type": "NUMERIC"
729
+ },
730
+ {
731
+ "mode": "NULLABLE",
732
+ "name": "desired_inventory_level",
733
+ "description": "Desired inventory level",
734
+ "type": "NUMERIC"
735
+ },
736
+ {
737
+ "mode": "NULLABLE",
738
+ "name": "reorder_inventory_level",
739
+ "description": "Reorder inventory level (triggers notification)",
740
+ "type": "NUMERIC"
741
+ },
742
+ {
743
+ "mode": "NULLABLE",
744
+ "name": "handles",
745
+ "description": "True if this distribution center handles this item",
746
+ "type": "BOOLEAN"
747
+ },
748
+ {
749
+ "mode": "NULLABLE",
750
+ "name": "stock_picking_location",
751
+ "description": "Stock picking location",
752
+ "type": "STRING"
753
+ },
754
+ {
755
+ "mode": "NULLABLE",
756
+ "name": "maximum_backorder",
757
+ "description": "Maximum back-order",
758
+ "type": "INTEGER"
759
+ },
760
+ {
761
+ "mode": "NULLABLE",
762
+ "name": "sku",
763
+ "description": "SKU",
764
+ "type": "STRING"
765
+ },
766
+ {
767
+ "mode": "NULLABLE",
768
+ "name": "eta",
769
+ "description": "Estimated time of arrival",
770
+ "type": "DATETIME"
771
+ },
772
+ {
773
+ "mode": "NULLABLE",
774
+ "name": "allocated_to_placed_orders",
775
+ "description": "Allocated to placed orders",
776
+ "type": "NUMERIC"
777
+ },
778
+ {
779
+ "mode": "NULLABLE",
780
+ "name": "allocated_to_shopping_carts",
781
+ "description": "Allocated to shopping carts",
782
+ "type": "NUMERIC"
783
+ },
784
+ {
785
+ "mode": "NULLABLE",
786
+ "name": "available_to_allocate",
787
+ "description": "Available to allocate",
788
+ "type": "NUMERIC"
789
+ },
790
+ {
791
+ "mode": "NULLABLE",
792
+ "name": "cogs",
793
+ "description": "Cost of goods sold override at the distribution center level",
794
+ "type": "NUMERIC"
795
+ }
796
+ ]
797
+ },
798
+ {
799
+ "mode": "REPEATED",
800
+ "name": "cases",
801
+ "description": "Cases",
802
+ "type": "RECORD",
803
+ "fields": [
804
+ {
805
+ "mode": "NULLABLE",
806
+ "name": "case_merchant_item_oid",
807
+ "description": "Case item object identifier",
808
+ "type": "INTEGER"
809
+ },
810
+ {
811
+ "mode": "NULLABLE",
812
+ "name": "quantity",
813
+ "description": "Case quantity",
814
+ "type": "INTEGER"
815
+ },
816
+ {
817
+ "mode": "NULLABLE",
818
+ "name": "case_merchant_item_id",
819
+ "description": "Case item id",
820
+ "type": "STRING"
821
+ },
822
+ {
823
+ "mode": "NULLABLE",
824
+ "name": "case_label",
825
+ "description": "Case label",
826
+ "type": "STRING"
827
+ }
828
+ ]
829
+ },
830
+ {
831
+ "mode": "NULLABLE",
832
+ "name": "case_inner_packs",
833
+ "description": "Case inner packs",
834
+ "type": "INTEGER"
835
+ },
836
+ {
837
+ "mode": "REPEATED",
838
+ "name": "destination_markups",
839
+ "description": "Destination markups",
840
+ "type": "RECORD",
841
+ "fields": [
842
+ {
843
+ "mode": "NULLABLE",
844
+ "name": "country_code",
845
+ "description": "Country code (ISO-3166 two letter)",
846
+ "type": "STRING"
847
+ },
848
+ {
849
+ "mode": "NULLABLE",
850
+ "name": "state",
851
+ "description": "State",
852
+ "type": "STRING"
853
+ },
854
+ {
855
+ "mode": "NULLABLE",
856
+ "name": "postal_code",
857
+ "description": "Postal code",
858
+ "type": "STRING"
859
+ },
860
+ {
861
+ "mode": "NULLABLE",
862
+ "name": "shipping_method",
863
+ "description": "Shipping method",
864
+ "type": "STRING"
865
+ },
866
+ {
867
+ "mode": "NULLABLE",
868
+ "name": "flat_fee",
869
+ "description": "Flat fee",
870
+ "type": "NUMERIC"
871
+ },
872
+ {
873
+ "mode": "NULLABLE",
874
+ "name": "per_item",
875
+ "description": "Per item",
876
+ "type": "NUMERIC"
877
+ },
878
+ {
879
+ "mode": "NULLABLE",
880
+ "name": "adult_signature_required",
881
+ "description": "Adult Signature Required (only updated if not-null value provided)",
882
+ "type": "BOOLEAN"
883
+ }
884
+ ]
885
+ },
886
+ {
887
+ "mode": "REPEATED",
888
+ "name": "destination_restrictions",
889
+ "description": "Destination restrictions",
890
+ "type": "RECORD",
891
+ "fields": [
892
+ {
893
+ "mode": "NULLABLE",
894
+ "name": "country_code",
895
+ "description": "Country code (ISO-3166 two letter)",
896
+ "type": "STRING"
897
+ },
898
+ {
899
+ "mode": "NULLABLE",
900
+ "name": "state",
901
+ "description": "State",
902
+ "type": "STRING"
903
+ },
904
+ {
905
+ "allowed_values": [
906
+ "valid only for",
907
+ "invalid for"
908
+ ],
909
+ "mode": "NULLABLE",
910
+ "name": "validity",
911
+ "description": "Validity",
912
+ "type": "STRING"
913
+ }
914
+ ]
915
+ },
916
+ {
917
+ "mode": "REPEATED",
918
+ "name": "package_requirements",
919
+ "description": "Package requirements",
920
+ "type": "RECORD",
921
+ "fields": [
922
+ {
923
+ "mode": "NULLABLE",
924
+ "name": "package_oid",
925
+ "description": "Package object identifier",
926
+ "type": "INTEGER"
927
+ },
928
+ {
929
+ "mode": "NULLABLE",
930
+ "name": "package_name",
931
+ "description": "Package name",
932
+ "type": "STRING"
933
+ }
934
+ ]
935
+ },
936
+ {
937
+ "mode": "NULLABLE",
938
+ "name": "collect_serial_numbers",
939
+ "description": "This item is on pre-order",
940
+ "type": "BOOLEAN"
941
+ },
942
+ {
943
+ "mode": "NULLABLE",
944
+ "name": "include_on_packing_slip",
945
+ "description": "Force this item onto the packing slip even if there is no weight.",
946
+ "type": "BOOLEAN"
947
+ },
948
+ {
949
+ "mode": "NULLABLE",
950
+ "name": "send_to_hold_before_fulfillment",
951
+ "description": "Send order to hold stage before fulfillment",
952
+ "type": "BOOLEAN"
953
+ }
954
+ ]
955
+ },
956
+ {
957
+ "name": "checkout",
958
+ "description": "Checkout",
959
+ "type": "RECORD",
960
+ "fields": [
961
+ {
962
+ "mode": "NULLABLE",
963
+ "name": "suppress_buysafe",
964
+ "description": "True to suppress buySAFE (deprecated)",
965
+ "type": "BOOLEAN"
966
+ },
967
+ {
968
+ "mode": "NULLABLE",
969
+ "name": "terms",
970
+ "description": "Terms for purchasing this item",
971
+ "type": "STRING"
972
+ },
973
+ {
974
+ "mode": "NULLABLE",
975
+ "name": "terms_translated_text_instance_oid",
976
+ "description": "Terms translated text instance identifier",
977
+ "type": "INTEGER"
978
+ },
979
+ {
980
+ "mode": "NULLABLE",
981
+ "name": "terms_if_auto_order",
982
+ "description": "Terms only apply if the item is on auto order",
983
+ "type": "BOOLEAN"
984
+ }
985
+ ]
986
+ },
987
+ {
988
+ "name": "auto_order",
989
+ "description": "Auto Order",
990
+ "type": "RECORD",
991
+ "fields": [
992
+ {
993
+ "mode": "NULLABLE",
994
+ "name": "auto_orderable",
995
+ "description": "True if this item can be automatically ordered by the customer",
996
+ "type": "BOOLEAN"
997
+ },
998
+ {
999
+ "mode": "REPEATED",
1000
+ "name": "auto_order_schedules",
1001
+ "description": "The user selectable schedules that are available",
1002
+ "type": "RECORD",
1003
+ "fields": [{
1004
+ "mode": "NULLABLE",
1005
+ "name": "value",
1006
+ "type": "STRING"
1007
+ }]
1008
+ },
1009
+ {
1010
+ "mode": "NULLABLE",
1011
+ "name": "auto_order_upsell",
1012
+ "description": "True if this item uses a fixed upsell step schedule",
1013
+ "type": "BOOLEAN"
1014
+ },
1015
+ {
1016
+ "mode": "NULLABLE",
1017
+ "name": "auto_order_upsell_one_per_customer",
1018
+ "description": "Limit the purchase of this item to one per customer",
1019
+ "type": "BOOLEAN"
1020
+ },
1021
+ {
1022
+ "mode": "NULLABLE",
1023
+ "name": "auto_order_upsell_no_easy_cancel",
1024
+ "description": "Do not send the easy cancel email to the customer",
1025
+ "type": "BOOLEAN"
1026
+ },
1027
+ {
1028
+ "mode": "REPEATED",
1029
+ "name": "auto_order_upgrade_items",
1030
+ "description": "List of upgrade items presented to customer service representatives",
1031
+ "type": "RECORD",
1032
+ "fields": [{
1033
+ "mode": "NULLABLE",
1034
+ "name": "value",
1035
+ "type": "STRING"
1036
+ }]
1037
+ },
1038
+ {
1039
+ "mode": "REPEATED",
1040
+ "name": "auto_order_downgrade_items",
1041
+ "description": "List of downgrade items presented to customer service representatives",
1042
+ "type": "RECORD",
1043
+ "fields": [{
1044
+ "mode": "NULLABLE",
1045
+ "name": "value",
1046
+ "type": "STRING"
1047
+ }]
1048
+ },
1049
+ {
1050
+ "mode": "NULLABLE",
1051
+ "name": "auth_test_amount",
1052
+ "description": "Amount to try and test authorize",
1053
+ "type": "NUMERIC"
1054
+ },
1055
+ {
1056
+ "mode": "NULLABLE",
1057
+ "name": "auth_future_amount",
1058
+ "description": "Amount to try and authorize for the future rebill",
1059
+ "type": "NUMERIC"
1060
+ },
1061
+ {
1062
+ "mode": "NULLABLE",
1063
+ "name": "cancel_other_auto_orders",
1064
+ "description": "True if other auto orders for this customer should be canceled when this item is ordered",
1065
+ "type": "BOOLEAN"
1066
+ },
1067
+ {
1068
+ "mode": "NULLABLE",
1069
+ "name": "auto_order_cancel_item_oid",
1070
+ "description": "Item object identifier to attempt charging the customer for if they cancel",
1071
+ "type": "INTEGER"
1072
+ },
1073
+ {
1074
+ "mode": "NULLABLE",
1075
+ "name": "auto_order_cancel_item_id",
1076
+ "description": "Item id to attempt charging the customer for if they cancel",
1077
+ "type": "STRING"
1078
+ },
1079
+ {
1080
+ "mode": "NULLABLE",
1081
+ "name": "auto_order_cancel_minimum_rebill_value",
1082
+ "description": "The minimum rebill value that must be paid in order to not be charged the cancellation item.",
1083
+ "type": "NUMERIC"
1084
+ },
1085
+ {
1086
+ "mode": "NULLABLE",
1087
+ "name": "auto_order_cancel_minimum_life_time_value",
1088
+ "description": "The minimum life time value that must be paid in order to not be charged the cancellation item.",
1089
+ "type": "NUMERIC"
1090
+ },
1091
+ {
1092
+ "mode": "NULLABLE",
1093
+ "name": "auto_order_cancel_charge_minimum_balance",
1094
+ "description": "If true, the cost of the cancel item will be the remaining balance of the minimum rebill or lifetime value",
1095
+ "type": "BOOLEAN"
1096
+ },
1097
+ {
1098
+ "mode": "NULLABLE",
1099
+ "name": "auto_order_paused",
1100
+ "description": "True if the rebill processing of this item is paused",
1101
+ "type": "BOOLEAN"
1102
+ },
1103
+ {
1104
+ "mode": "NULLABLE",
1105
+ "name": "free_shipping_auto_order",
1106
+ "description": "True if the customer should be given free shipping",
1107
+ "type": "BOOLEAN"
1108
+ },
1109
+ {
1110
+ "mode": "REPEATED",
1111
+ "name": "steps",
1112
+ "description": "The rebill steps if this auto order is an upsell",
1113
+ "type": "RECORD",
1114
+ "fields": [
1115
+ {
1116
+ "allowed_values": [
1117
+ "item",
1118
+ "pause",
1119
+ "loop",
1120
+ "kit only",
1121
+ "pause until"
1122
+ ],
1123
+ "mode": "NULLABLE",
1124
+ "name": "type",
1125
+ "description": "Type of step (item, kit only, loop or pause)",
1126
+ "type": "STRING"
1127
+ },
1128
+ {
1129
+ "mode": "NULLABLE",
1130
+ "name": "pause_days",
1131
+ "description": "Number of days to pause",
1132
+ "type": "INTEGER"
1133
+ },
1134
+ {
1135
+ "mode": "NULLABLE",
1136
+ "name": "recurring_merchant_item_oid",
1137
+ "description": "Item object identifier to rebill",
1138
+ "type": "INTEGER"
1139
+ },
1140
+ {
1141
+ "mode": "NULLABLE",
1142
+ "name": "recurring_merchant_item_id",
1143
+ "description": "Item id to rebill",
1144
+ "type": "STRING"
1145
+ },
1146
+ {
1147
+ "mode": "NULLABLE",
1148
+ "name": "schedule",
1149
+ "description": "Frequency of the rebill",
1150
+ "type": "STRING"
1151
+ },
1152
+ {
1153
+ "mode": "NULLABLE",
1154
+ "name": "repeat_count",
1155
+ "description": "Number of times to rebill. Last step can be null for infinite",
1156
+ "type": "INTEGER"
1157
+ },
1158
+ {
1159
+ "mode": "NULLABLE",
1160
+ "name": "arbitrary_unit_cost",
1161
+ "description": "Arbitrary unit cost used to override the regular item cost",
1162
+ "type": "NUMERIC"
1163
+ },
1164
+ {
1165
+ "mode": "NULLABLE",
1166
+ "name": "subscribe_email_list_oid",
1167
+ "description": "Email list identifier to subscribe the customer to when this rebill occurs (decommissioned email engine)",
1168
+ "type": "INTEGER"
1169
+ },
1170
+ {
1171
+ "mode": "NULLABLE",
1172
+ "name": "subscribe_email_list_name",
1173
+ "description": "Email list name to subscribe the customer to when the rebill occurs (decommissioned email engine)",
1174
+ "type": "STRING"
1175
+ },
1176
+ {
1177
+ "mode": "NULLABLE",
1178
+ "name": "managed_by",
1179
+ "description": "Managed by (defaults to UltraCart)",
1180
+ "type": "STRING"
1181
+ },
1182
+ {
1183
+ "mode": "NULLABLE",
1184
+ "name": "arbitrary_schedule_days",
1185
+ "description": "If the schedule is arbitrary, then this is the number of days",
1186
+ "type": "INTEGER"
1187
+ },
1188
+ {
1189
+ "mode": "NULLABLE",
1190
+ "name": "preshipment_notice_days",
1191
+ "description": "If set, a pre-shipment notice is sent to the customer this many days in advance",
1192
+ "type": "INTEGER"
1193
+ },
1194
+ {
1195
+ "mode": "REPEATED",
1196
+ "name": "grandfather_pricing",
1197
+ "description": "Grand-father pricing configuration if the rebill schedule has changed over time",
1198
+ "type": "RECORD",
1199
+ "fields": [
1200
+ {
1201
+ "mode": "NULLABLE",
1202
+ "name": "on_or_before_date",
1203
+ "description": "On or before date",
1204
+ "type": "DATETIME"
1205
+ },
1206
+ {
1207
+ "mode": "NULLABLE",
1208
+ "name": "unit_cost",
1209
+ "description": "Unit cost",
1210
+ "type": "NUMERIC"
1211
+ }
1212
+ ]
1213
+ },
1214
+ {
1215
+ "mode": "NULLABLE",
1216
+ "name": "pause_until_date",
1217
+ "description": "Wait for this step to happen until the specified date",
1218
+ "type": "DATETIME"
1219
+ },
1220
+ {
1221
+ "mode": "REPEATED",
1222
+ "name": "arbitrary_unit_cost_schedules",
1223
+ "description": "Arbitrary unit costs schedules for more advanced discounting by rebill attempt",
1224
+ "type": "RECORD",
1225
+ "fields": [
1226
+ {
1227
+ "mode": "NULLABLE",
1228
+ "name": "arbitrary_unit_cost",
1229
+ "description": "Arbitrary unit cost",
1230
+ "type": "NUMERIC"
1231
+ },
1232
+ {
1233
+ "mode": "NULLABLE",
1234
+ "name": "retry_days",
1235
+ "description": "Retry days",
1236
+ "type": "INTEGER"
1237
+ }
1238
+ ]
1239
+ },
1240
+ {
1241
+ "mode": "NULLABLE",
1242
+ "name": "pause_until_day_of_month",
1243
+ "description": "Pause until a specific day of the month",
1244
+ "type": "INTEGER"
1245
+ },
1246
+ {
1247
+ "mode": "NULLABLE",
1248
+ "name": "pause_until_minimum_delay_days",
1249
+ "description": "Pause at least this many days between the last order and the calculated next day of month",
1250
+ "type": "INTEGER"
1251
+ }
1252
+ ]
1253
+ },
1254
+ {
1255
+ "mode": "NULLABLE",
1256
+ "name": "refund_other_auto_orders",
1257
+ "description": "True if other auto orders for this customer should refunded if this item is refunded.",
1258
+ "type": "BOOLEAN"
1259
+ },
1260
+ {
1261
+ "mode": "NULLABLE",
1262
+ "name": "auto_order_prohibit_expiring_cards",
1263
+ "description": "Minimum number of months before expiration for the card. Overrides the account level setting if higher. Set to zero to disable.",
1264
+ "type": "INTEGER"
1265
+ },
1266
+ {
1267
+ "mode": "NULLABLE",
1268
+ "name": "auto_order_cancel_minimum_rebill_count",
1269
+ "description": "The minimum rebill count that must be billed in order to not be charged the cancellation item.",
1270
+ "type": "INTEGER"
1271
+ },
1272
+ {
1273
+ "mode": "NULLABLE",
1274
+ "name": "auto_order_cancel_minimum_life_time_count",
1275
+ "description": "The minimum life time count that must be billed in order to not be charged the cancellation item.",
1276
+ "type": "INTEGER"
1277
+ }
1278
+ ]
1279
+ },
1280
+ {
1281
+ "name": "reporting",
1282
+ "description": "Reporting",
1283
+ "type": "RECORD",
1284
+ "fields": [
1285
+ {
1286
+ "mode": "NULLABLE",
1287
+ "name": "report_as_upsell",
1288
+ "description": "Report as an upsell",
1289
+ "type": "BOOLEAN"
1290
+ },
1291
+ {
1292
+ "mode": "REPEATED",
1293
+ "name": "report_pickable_quantities",
1294
+ "description": "Report pickable quantities (deprecated)",
1295
+ "type": "RECORD",
1296
+ "fields": [{
1297
+ "mode": "NULLABLE",
1298
+ "name": "value",
1299
+ "type": "INTEGER"
1300
+ }]
1301
+ }
1302
+ ]
1303
+ },
1304
+ {
1305
+ "name": "identifiers",
1306
+ "description": "Identifiers such as SKU, Barcode, etc.",
1307
+ "type": "RECORD",
1308
+ "fields": [
1309
+ {
1310
+ "mode": "NULLABLE",
1311
+ "name": "barcode",
1312
+ "description": "Barcode",
1313
+ "type": "STRING"
1314
+ },
1315
+ {
1316
+ "mode": "NULLABLE",
1317
+ "name": "unspsc",
1318
+ "description": "UNSPSC",
1319
+ "type": "STRING"
1320
+ },
1321
+ {
1322
+ "mode": "NULLABLE",
1323
+ "name": "manufacturer_sku",
1324
+ "description": "Manufacturer SKU",
1325
+ "type": "STRING"
1326
+ },
1327
+ {
1328
+ "mode": "NULLABLE",
1329
+ "name": "manufacturer_name",
1330
+ "description": "Manufacturer Name",
1331
+ "type": "STRING"
1332
+ },
1333
+ {
1334
+ "mode": "NULLABLE",
1335
+ "name": "barcode_upc11",
1336
+ "description": "Barcode - UPC 11",
1337
+ "type": "STRING"
1338
+ },
1339
+ {
1340
+ "mode": "NULLABLE",
1341
+ "name": "barcode_upc12",
1342
+ "description": "Barcode - UPC 12",
1343
+ "type": "STRING"
1344
+ },
1345
+ {
1346
+ "mode": "NULLABLE",
1347
+ "name": "barcode_gtin12",
1348
+ "description": "Barcode - GTIN 12",
1349
+ "type": "STRING"
1350
+ },
1351
+ {
1352
+ "mode": "NULLABLE",
1353
+ "name": "barcode_gtin14",
1354
+ "description": "Barcode - GTIN 14",
1355
+ "type": "STRING"
1356
+ }
1357
+ ]
1358
+ },
1359
+ {
1360
+ "name": "internal",
1361
+ "description": "Internal information such as memo",
1362
+ "type": "RECORD",
1363
+ "fields": [{
1364
+ "mode": "NULLABLE",
1365
+ "name": "memo",
1366
+ "description": "Memo",
1367
+ "type": "STRING"
1368
+ }]
1369
+ },
1370
+ {
1371
+ "name": "salesforce",
1372
+ "description": "Salesforce.com configuration",
1373
+ "type": "RECORD",
1374
+ "fields": [
1375
+ {
1376
+ "mode": "NULLABLE",
1377
+ "name": "sfdc_product_id",
1378
+ "description": "Salesforce.com product id",
1379
+ "type": "STRING"
1380
+ },
1381
+ {
1382
+ "mode": "NULLABLE",
1383
+ "name": "sfdc_pricebook_id",
1384
+ "description": "Salesforce.com pricebook id",
1385
+ "type": "STRING"
1386
+ }
1387
+ ]
1388
+ },
1389
+ {
1390
+ "name": "tax",
1391
+ "description": "Tax settings",
1392
+ "type": "RECORD",
1393
+ "fields": [
1394
+ {
1395
+ "mode": "NULLABLE",
1396
+ "name": "tax_free",
1397
+ "description": "True if tax free",
1398
+ "type": "BOOLEAN"
1399
+ },
1400
+ {
1401
+ "mode": "NULLABLE",
1402
+ "name": "taxable_cost",
1403
+ "description": "Taxable cost if different than regular cost",
1404
+ "type": "NUMERIC"
1405
+ },
1406
+ {
1407
+ "mode": "REPEATED",
1408
+ "name": "exemptions",
1409
+ "description": "Exemptions",
1410
+ "type": "RECORD",
1411
+ "fields": [
1412
+ {
1413
+ "mode": "NULLABLE",
1414
+ "name": "country_code",
1415
+ "description": "Country code (ISO-3166 two letter)",
1416
+ "type": "STRING"
1417
+ },
1418
+ {
1419
+ "mode": "NULLABLE",
1420
+ "name": "state_code",
1421
+ "description": "State code",
1422
+ "type": "STRING"
1423
+ },
1424
+ {
1425
+ "mode": "NULLABLE",
1426
+ "name": "county",
1427
+ "description": "County",
1428
+ "type": "STRING"
1429
+ },
1430
+ {
1431
+ "mode": "NULLABLE",
1432
+ "name": "city",
1433
+ "description": "City",
1434
+ "type": "STRING"
1435
+ },
1436
+ {
1437
+ "mode": "NULLABLE",
1438
+ "name": "postal_code",
1439
+ "description": "Postal code",
1440
+ "type": "STRING"
1441
+ }
1442
+ ]
1443
+ },
1444
+ {
1445
+ "allowed_values": [
1446
+ "digital",
1447
+ "physical",
1448
+ "service"
1449
+ ],
1450
+ "mode": "NULLABLE",
1451
+ "name": "tax_product_type",
1452
+ "description": "Tax product type",
1453
+ "type": "STRING"
1454
+ }
1455
+ ]
1456
+ },
1457
+ {
1458
+ "name": "enrollment123",
1459
+ "description": "Enrollment123.com",
1460
+ "type": "RECORD",
1461
+ "fields": [{
1462
+ "mode": "NULLABLE",
1463
+ "name": "enrollment123_product_code",
1464
+ "description": "Enrolment 123 product code",
1465
+ "type": "STRING"
1466
+ }]
1467
+ },
1468
+ {
1469
+ "name": "revguard",
1470
+ "description": "Revguard.com (Deprecated)",
1471
+ "type": "RECORD",
1472
+ "fields": [
1473
+ {
1474
+ "mode": "NULLABLE",
1475
+ "name": "revguard_ivr_prompt_group",
1476
+ "description": "IVR prompt group",
1477
+ "type": "INTEGER"
1478
+ },
1479
+ {
1480
+ "mode": "NULLABLE",
1481
+ "name": "revguard_csr_prompt_group",
1482
+ "description": "CSR prompt group",
1483
+ "type": "INTEGER"
1484
+ },
1485
+ {
1486
+ "mode": "NULLABLE",
1487
+ "name": "revguard_web_prompt_group",
1488
+ "description": "Web prompt group",
1489
+ "type": "INTEGER"
1490
+ },
1491
+ {
1492
+ "mode": "NULLABLE",
1493
+ "name": "revguard_client_brand",
1494
+ "description": "Client brand",
1495
+ "type": "INTEGER"
1496
+ },
1497
+ {
1498
+ "mode": "NULLABLE",
1499
+ "name": "revguard_canceled_ivr_prompt_group",
1500
+ "description": "IVR prompt group",
1501
+ "type": "INTEGER"
1502
+ },
1503
+ {
1504
+ "mode": "NULLABLE",
1505
+ "name": "revguard_canceled_web_prompt_group",
1506
+ "description": "Canceled web prompt group",
1507
+ "type": "INTEGER"
1508
+ },
1509
+ {
1510
+ "mode": "NULLABLE",
1511
+ "name": "revguard_canceled_csr_prompt_group",
1512
+ "description": "Canceled CSR prompt group",
1513
+ "type": "INTEGER"
1514
+ }
1515
+ ]
1516
+ },
1517
+ {
1518
+ "name": "ccbill",
1519
+ "description": "CCBill.com (Deprecated)",
1520
+ "type": "RECORD",
1521
+ "fields": [
1522
+ {
1523
+ "mode": "NULLABLE",
1524
+ "name": "ccbill_form_name",
1525
+ "description": "Form name",
1526
+ "type": "STRING"
1527
+ },
1528
+ {
1529
+ "mode": "NULLABLE",
1530
+ "name": "ccbill_allowed_types",
1531
+ "description": "Allowed types",
1532
+ "type": "STRING"
1533
+ },
1534
+ {
1535
+ "mode": "NULLABLE",
1536
+ "name": "ccbill_subscription_type_id",
1537
+ "description": "Subscription type id",
1538
+ "type": "STRING"
1539
+ },
1540
+ {
1541
+ "mode": "NULLABLE",
1542
+ "name": "ccbill_subaccount_id",
1543
+ "description": "Sub-account id",
1544
+ "type": "STRING"
1545
+ },
1546
+ {
1547
+ "mode": "NULLABLE",
1548
+ "name": "ccbill_allowed_currencies",
1549
+ "description": "Allowed currencies",
1550
+ "type": "STRING"
1551
+ },
1552
+ {
1553
+ "mode": "NULLABLE",
1554
+ "name": "ccbill_currency_code",
1555
+ "description": "Currency code",
1556
+ "type": "STRING"
1557
+ }
1558
+ ]
1559
+ },
1560
+ {
1561
+ "name": "accounting",
1562
+ "description": "Accounting such as QuickBooks codes",
1563
+ "type": "RECORD",
1564
+ "fields": [
1565
+ {
1566
+ "mode": "NULLABLE",
1567
+ "name": "qb_class",
1568
+ "description": "QuickBooks class if you are classifying items on your invoices/receipts",
1569
+ "type": "STRING"
1570
+ },
1571
+ {
1572
+ "mode": "NULLABLE",
1573
+ "name": "accounting_code",
1574
+ "description": "QuickBooks item name if different than the item id",
1575
+ "type": "STRING"
1576
+ }
1577
+ ]
1578
+ },
1579
+ {
1580
+ "name": "email_notifications",
1581
+ "description": "Email notifications",
1582
+ "type": "RECORD",
1583
+ "fields": [
1584
+ {
1585
+ "mode": "NULLABLE",
1586
+ "name": "skip_receipt",
1587
+ "description": "Skip receipt email to customer",
1588
+ "type": "BOOLEAN"
1589
+ },
1590
+ {
1591
+ "mode": "NULLABLE",
1592
+ "name": "skip_shipment_notification",
1593
+ "description": "Skip shipment notification to customer",
1594
+ "type": "BOOLEAN"
1595
+ }
1596
+ ]
1597
+ },
1598
+ {
1599
+ "name": "gift_certificate",
1600
+ "description": "Gift Certificate",
1601
+ "type": "RECORD",
1602
+ "fields": [
1603
+ {
1604
+ "mode": "NULLABLE",
1605
+ "name": "gift_certificate",
1606
+ "description": "True if the purchase of this item generates a gift certificate",
1607
+ "type": "BOOLEAN"
1608
+ },
1609
+ {
1610
+ "mode": "NULLABLE",
1611
+ "name": "gift_certificate_expiration_days",
1612
+ "description": "The number of days that the gift certificate is good for (optional)",
1613
+ "type": "INTEGER"
1614
+ }
1615
+ ]
1616
+ },
1617
+ {
1618
+ "name": "kit_definition",
1619
+ "description": "Kit Definition",
1620
+ "type": "RECORD",
1621
+ "fields": [{
1622
+ "mode": "REPEATED",
1623
+ "name": "components",
1624
+ "description": "Components",
1625
+ "type": "RECORD",
1626
+ "fields": [
1627
+ {
1628
+ "mode": "NULLABLE",
1629
+ "name": "component_merchant_item_oid",
1630
+ "description": "Component item object identifier",
1631
+ "type": "INTEGER"
1632
+ },
1633
+ {
1634
+ "mode": "NULLABLE",
1635
+ "name": "quantity",
1636
+ "description": "Quantity",
1637
+ "type": "INTEGER"
1638
+ },
1639
+ {
1640
+ "mode": "NULLABLE",
1641
+ "name": "component_merchant_item_id",
1642
+ "description": "Component item ID",
1643
+ "type": "STRING"
1644
+ },
1645
+ {
1646
+ "mode": "NULLABLE",
1647
+ "name": "component_description",
1648
+ "description": "Component item description",
1649
+ "type": "STRING"
1650
+ },
1651
+ {
1652
+ "mode": "NULLABLE",
1653
+ "name": "component_cost",
1654
+ "description": "Component item cost",
1655
+ "type": "NUMERIC"
1656
+ }
1657
+ ]
1658
+ }]
1659
+ },
1660
+ {
1661
+ "name": "amember",
1662
+ "description": "Amember configuration",
1663
+ "type": "RECORD",
1664
+ "fields": [
1665
+ {
1666
+ "mode": "NULLABLE",
1667
+ "name": "amember_product_id",
1668
+ "description": "A-member product id give customer access to when they purchase this item",
1669
+ "type": "STRING"
1670
+ },
1671
+ {
1672
+ "mode": "NULLABLE",
1673
+ "name": "amember_payment_duration_days",
1674
+ "description": "The number of days that the customer should be given access to the item",
1675
+ "type": "INTEGER"
1676
+ }
1677
+ ]
1678
+ },
1679
+ {
1680
+ "name": "wishlist_member",
1681
+ "description": "WishList Member",
1682
+ "type": "RECORD",
1683
+ "fields": [
1684
+ {
1685
+ "mode": "NULLABLE",
1686
+ "name": "wishlist_member_sku",
1687
+ "description": "WishList Member SKU",
1688
+ "type": "STRING"
1689
+ },
1690
+ {
1691
+ "mode": "NULLABLE",
1692
+ "name": "wishlist_member_instance_oid",
1693
+ "description": "WishList Member instance object identifier",
1694
+ "type": "INTEGER"
1695
+ },
1696
+ {
1697
+ "mode": "NULLABLE",
1698
+ "name": "wishlist_member_instance_description",
1699
+ "description": "WishList Member instance description",
1700
+ "type": "STRING"
1701
+ }
1702
+ ]
1703
+ },
1704
+ {
1705
+ "name": "digital_delivery",
1706
+ "description": "Digital Delivery",
1707
+ "type": "RECORD",
1708
+ "fields": [
1709
+ {
1710
+ "mode": "REPEATED",
1711
+ "name": "digital_items",
1712
+ "description": "Digital items that customer can download when this item is purchased",
1713
+ "type": "RECORD",
1714
+ "fields": [
1715
+ {
1716
+ "mode": "NULLABLE",
1717
+ "name": "digital_item_oid",
1718
+ "description": "The Digital item oid is a primary key used internally by UltraCart. You should not set or change this value. Doing so will have no effect.",
1719
+ "type": "INTEGER"
1720
+ },
1721
+ {
1722
+ "mode": "NULLABLE",
1723
+ "name": "description",
1724
+ "description": "Description of the digital item",
1725
+ "type": "STRING"
1726
+ },
1727
+ {
1728
+ "mode": "NULLABLE",
1729
+ "name": "original_filename",
1730
+ "description": "Original filename",
1731
+ "type": "STRING"
1732
+ },
1733
+ {
1734
+ "mode": "NULLABLE",
1735
+ "name": "file_size",
1736
+ "description": "File size",
1737
+ "type": "INTEGER"
1738
+ },
1739
+ {
1740
+ "mode": "NULLABLE",
1741
+ "name": "creation_dts",
1742
+ "description": "File creation date",
1743
+ "type": "DATETIME"
1744
+ },
1745
+ {
1746
+ "mode": "NULLABLE",
1747
+ "name": "mime_type",
1748
+ "description": "Mime type associated with the file",
1749
+ "type": "STRING"
1750
+ },
1751
+ {
1752
+ "mode": "NULLABLE",
1753
+ "name": "import_from_url",
1754
+ "description": "This url is sourced to create or update a digital file in your digital library. It is only considered during an insert or update operation.",
1755
+ "type": "STRING"
1756
+ },
1757
+ {
1758
+ "mode": "NULLABLE",
1759
+ "name": "click_wrap_agreement",
1760
+ "description": "Click wrap agreement is presented to the customer before they can purchase your product.",
1761
+ "type": "STRING"
1762
+ },
1763
+ {
1764
+ "name": "pdf_meta",
1765
+ "description": "Additional properties for pdf files",
1766
+ "type": "RECORD",
1767
+ "fields": [
1768
+ {
1769
+ "mode": "NULLABLE",
1770
+ "name": "printing_allowed",
1771
+ "description": "Printing is allowed",
1772
+ "type": "BOOLEAN"
1773
+ },
1774
+ {
1775
+ "mode": "NULLABLE",
1776
+ "name": "modify_contents_allowed",
1777
+ "description": "Modifying contents is allowed",
1778
+ "type": "BOOLEAN"
1779
+ },
1780
+ {
1781
+ "mode": "NULLABLE",
1782
+ "name": "copy_allowed",
1783
+ "description": "Copy/Paste is allowed",
1784
+ "type": "BOOLEAN"
1785
+ },
1786
+ {
1787
+ "mode": "NULLABLE",
1788
+ "name": "modify_annotations_allowed",
1789
+ "description": "Modifying annotations is allowed",
1790
+ "type": "BOOLEAN"
1791
+ },
1792
+ {
1793
+ "mode": "NULLABLE",
1794
+ "name": "fillin_allowed",
1795
+ "description": "Fillin is allowed",
1796
+ "type": "BOOLEAN"
1797
+ },
1798
+ {
1799
+ "mode": "NULLABLE",
1800
+ "name": "screen_readers_allowed",
1801
+ "description": "Screen readers are allowed",
1802
+ "type": "BOOLEAN"
1803
+ },
1804
+ {
1805
+ "mode": "NULLABLE",
1806
+ "name": "assembly_allowed",
1807
+ "description": "Assembly allowed",
1808
+ "type": "BOOLEAN"
1809
+ },
1810
+ {
1811
+ "mode": "NULLABLE",
1812
+ "name": "degraded_printing_allowed",
1813
+ "description": "Degraded printing allowed",
1814
+ "type": "BOOLEAN"
1815
+ },
1816
+ {
1817
+ "mode": "NULLABLE",
1818
+ "name": "tagged",
1819
+ "description": "PDF is tagged",
1820
+ "type": "BOOLEAN"
1821
+ },
1822
+ {
1823
+ "mode": "NULLABLE",
1824
+ "name": "custom_header",
1825
+ "description": "A custom header for each pdf page",
1826
+ "type": "STRING"
1827
+ },
1828
+ {
1829
+ "mode": "NULLABLE",
1830
+ "name": "custom_footer",
1831
+ "description": "A custom footer for each pdf page",
1832
+ "type": "STRING"
1833
+ }
1834
+ ]
1835
+ },
1836
+ {
1837
+ "mode": "NULLABLE",
1838
+ "name": "external_id",
1839
+ "description": "External Id useful for syncing with a remote filesystem, this may be an MD5 hash or whatever suits your needs.",
1840
+ "type": "STRING"
1841
+ }
1842
+ ]
1843
+ },
1844
+ {
1845
+ "mode": "NULLABLE",
1846
+ "name": "activation_code_type",
1847
+ "description": "Type of activation code",
1848
+ "type": "STRING"
1849
+ },
1850
+ {
1851
+ "mode": "NULLABLE",
1852
+ "name": "activation_code_description",
1853
+ "description": "Description of the activation code",
1854
+ "type": "STRING"
1855
+ },
1856
+ {
1857
+ "mode": "NULLABLE",
1858
+ "name": "activation_code_low_warning",
1859
+ "description": "The number of activation codes whcih should generate a warning email",
1860
+ "type": "INTEGER"
1861
+ },
1862
+ {
1863
+ "mode": "NULLABLE",
1864
+ "name": "activation_code_realtime_url",
1865
+ "description": "The URL to retrieve activation codes from in real-time",
1866
+ "type": "STRING"
1867
+ }
1868
+ ]
1869
+ },
1870
+ {
1871
+ "name": "google_product_search",
1872
+ "description": "Google Product Search",
1873
+ "type": "RECORD",
1874
+ "fields": [
1875
+ {
1876
+ "mode": "NULLABLE",
1877
+ "name": "omit_from_feed",
1878
+ "description": "Omit from feed",
1879
+ "type": "BOOLEAN"
1880
+ },
1881
+ {
1882
+ "mode": "NULLABLE",
1883
+ "name": "category_description",
1884
+ "description": "Category description",
1885
+ "type": "STRING"
1886
+ },
1887
+ {
1888
+ "mode": "NULLABLE",
1889
+ "name": "search_position",
1890
+ "description": "Search position",
1891
+ "type": "INTEGER"
1892
+ },
1893
+ {
1894
+ "mode": "NULLABLE",
1895
+ "name": "search_dts",
1896
+ "description": "Search date/time",
1897
+ "type": "DATETIME"
1898
+ },
1899
+ {
1900
+ "mode": "NULLABLE",
1901
+ "name": "search_lowest_price",
1902
+ "description": "Search lowest price",
1903
+ "type": "NUMERIC"
1904
+ },
1905
+ {
1906
+ "mode": "NULLABLE",
1907
+ "name": "search_lowest_url",
1908
+ "description": "Search lowest URL",
1909
+ "type": "STRING"
1910
+ },
1911
+ {
1912
+ "mode": "NULLABLE",
1913
+ "name": "product_type",
1914
+ "description": "Product type",
1915
+ "type": "STRING"
1916
+ },
1917
+ {
1918
+ "mode": "NULLABLE",
1919
+ "name": "book_isbn",
1920
+ "description": "Bood - ISBN",
1921
+ "type": "STRING"
1922
+ },
1923
+ {
1924
+ "mode": "NULLABLE",
1925
+ "name": "book_format",
1926
+ "description": "Book - format",
1927
+ "type": "STRING"
1928
+ },
1929
+ {
1930
+ "mode": "NULLABLE",
1931
+ "name": "book_author",
1932
+ "description": "Book - author",
1933
+ "type": "STRING"
1934
+ },
1935
+ {
1936
+ "mode": "NULLABLE",
1937
+ "name": "book_publisher",
1938
+ "description": "Book - publisher",
1939
+ "type": "STRING"
1940
+ },
1941
+ {
1942
+ "mode": "NULLABLE",
1943
+ "name": "music_release_date",
1944
+ "description": "Music - release date",
1945
+ "type": "DATETIME"
1946
+ },
1947
+ {
1948
+ "mode": "NULLABLE",
1949
+ "name": "music_format",
1950
+ "description": "Music - format",
1951
+ "type": "STRING"
1952
+ },
1953
+ {
1954
+ "mode": "NULLABLE",
1955
+ "name": "music_artist",
1956
+ "description": "Music - artist",
1957
+ "type": "STRING"
1958
+ },
1959
+ {
1960
+ "mode": "NULLABLE",
1961
+ "name": "video_format",
1962
+ "description": "Video - format",
1963
+ "type": "STRING"
1964
+ },
1965
+ {
1966
+ "mode": "NULLABLE",
1967
+ "name": "video_director",
1968
+ "description": "Video - director",
1969
+ "type": "STRING"
1970
+ },
1971
+ {
1972
+ "mode": "NULLABLE",
1973
+ "name": "video_release_date",
1974
+ "description": "Video - release date",
1975
+ "type": "DATETIME"
1976
+ },
1977
+ {
1978
+ "mode": "NULLABLE",
1979
+ "name": "video_starring",
1980
+ "description": "Video - starring",
1981
+ "type": "STRING"
1982
+ },
1983
+ {
1984
+ "mode": "NULLABLE",
1985
+ "name": "video_rating",
1986
+ "description": "Video - rating",
1987
+ "type": "STRING"
1988
+ },
1989
+ {
1990
+ "mode": "NULLABLE",
1991
+ "name": "google_product_category",
1992
+ "description": "Google product category",
1993
+ "type": "STRING"
1994
+ },
1995
+ {
1996
+ "mode": "NULLABLE",
1997
+ "name": "gender",
1998
+ "description": "Gender",
1999
+ "type": "STRING"
2000
+ },
2001
+ {
2002
+ "mode": "NULLABLE",
2003
+ "name": "age_group",
2004
+ "description": "Age group",
2005
+ "type": "STRING"
2006
+ },
2007
+ {
2008
+ "mode": "NULLABLE",
2009
+ "name": "color",
2010
+ "description": "Color",
2011
+ "type": "STRING"
2012
+ },
2013
+ {
2014
+ "mode": "NULLABLE",
2015
+ "name": "size",
2016
+ "description": "Size",
2017
+ "type": "STRING"
2018
+ },
2019
+ {
2020
+ "mode": "NULLABLE",
2021
+ "name": "available_at_physical_store",
2022
+ "description": "Available at physical store",
2023
+ "type": "BOOLEAN"
2024
+ },
2025
+ {
2026
+ "mode": "NULLABLE",
2027
+ "name": "adwords_label1",
2028
+ "description": "Adwords label 1",
2029
+ "type": "STRING"
2030
+ },
2031
+ {
2032
+ "mode": "NULLABLE",
2033
+ "name": "adwords_label2",
2034
+ "description": "Adwords label 2",
2035
+ "type": "STRING"
2036
+ },
2037
+ {
2038
+ "mode": "NULLABLE",
2039
+ "name": "adwords_label3",
2040
+ "description": "Adwords label 3",
2041
+ "type": "STRING"
2042
+ },
2043
+ {
2044
+ "mode": "NULLABLE",
2045
+ "name": "adwords_label4",
2046
+ "description": "Adwords label 4",
2047
+ "type": "STRING"
2048
+ },
2049
+ {
2050
+ "mode": "NULLABLE",
2051
+ "name": "adwords_label5",
2052
+ "description": "Adwords label 5",
2053
+ "type": "STRING"
2054
+ },
2055
+ {
2056
+ "mode": "NULLABLE",
2057
+ "name": "adwords_grouping",
2058
+ "description": "Adwords grouping",
2059
+ "type": "STRING"
2060
+ },
2061
+ {
2062
+ "mode": "NULLABLE",
2063
+ "name": "custom_label0",
2064
+ "description": "Custom label 0",
2065
+ "type": "STRING"
2066
+ },
2067
+ {
2068
+ "mode": "NULLABLE",
2069
+ "name": "custom_label1",
2070
+ "description": "Custom label 1",
2071
+ "type": "STRING"
2072
+ },
2073
+ {
2074
+ "mode": "NULLABLE",
2075
+ "name": "custom_label2",
2076
+ "description": "Custom label 2",
2077
+ "type": "STRING"
2078
+ },
2079
+ {
2080
+ "mode": "NULLABLE",
2081
+ "name": "custom_label3",
2082
+ "description": "Custom label 3",
2083
+ "type": "STRING"
2084
+ },
2085
+ {
2086
+ "mode": "NULLABLE",
2087
+ "name": "custom_label4",
2088
+ "description": "Custom label 4",
2089
+ "type": "STRING"
2090
+ },
2091
+ {
2092
+ "mode": "NULLABLE",
2093
+ "name": "promotion_id1",
2094
+ "description": "Promotion ID 1",
2095
+ "type": "STRING"
2096
+ },
2097
+ {
2098
+ "mode": "NULLABLE",
2099
+ "name": "promotion_id2",
2100
+ "description": "Promotion ID 2",
2101
+ "type": "STRING"
2102
+ },
2103
+ {
2104
+ "mode": "NULLABLE",
2105
+ "name": "promotion_id3",
2106
+ "description": "Promotion ID 3",
2107
+ "type": "STRING"
2108
+ },
2109
+ {
2110
+ "mode": "NULLABLE",
2111
+ "name": "promotion_id4",
2112
+ "description": "Promotion ID 4",
2113
+ "type": "STRING"
2114
+ },
2115
+ {
2116
+ "mode": "NULLABLE",
2117
+ "name": "promotion_id5",
2118
+ "description": "Promotion ID 5",
2119
+ "type": "STRING"
2120
+ },
2121
+ {
2122
+ "mode": "NULLABLE",
2123
+ "name": "promotion_id6",
2124
+ "description": "Promotion ID 6",
2125
+ "type": "STRING"
2126
+ },
2127
+ {
2128
+ "mode": "NULLABLE",
2129
+ "name": "promotion_id7",
2130
+ "description": "Promotion ID 7",
2131
+ "type": "STRING"
2132
+ },
2133
+ {
2134
+ "mode": "NULLABLE",
2135
+ "name": "promotion_id8",
2136
+ "description": "Promotion ID 8",
2137
+ "type": "STRING"
2138
+ },
2139
+ {
2140
+ "mode": "NULLABLE",
2141
+ "name": "promotion_id9",
2142
+ "description": "Promotion ID 9",
2143
+ "type": "STRING"
2144
+ },
2145
+ {
2146
+ "mode": "NULLABLE",
2147
+ "name": "promotion_id10",
2148
+ "description": "Promotion ID 10",
2149
+ "type": "STRING"
2150
+ },
2151
+ {
2152
+ "mode": "NULLABLE",
2153
+ "name": "condition",
2154
+ "description": "Condition",
2155
+ "type": "STRING"
2156
+ },
2157
+ {
2158
+ "mode": "NULLABLE",
2159
+ "name": "shippingLabel",
2160
+ "type": "STRING"
2161
+ }
2162
+ ]
2163
+ },
2164
+ {
2165
+ "name": "payment_processing",
2166
+ "description": "Payment Processing",
2167
+ "type": "RECORD",
2168
+ "fields": [
2169
+ {
2170
+ "mode": "REPEATED",
2171
+ "name": "rotating_transaction_gateway_codes",
2172
+ "description": "Rotating transaction gateway codes",
2173
+ "type": "RECORD",
2174
+ "fields": [{
2175
+ "mode": "NULLABLE",
2176
+ "name": "value",
2177
+ "type": "STRING"
2178
+ }]
2179
+ },
2180
+ {
2181
+ "mode": "NULLABLE",
2182
+ "name": "credit_card_transaction_type",
2183
+ "description": "Credit card transaction type",
2184
+ "type": "STRING"
2185
+ },
2186
+ {
2187
+ "mode": "NULLABLE",
2188
+ "name": "block_prepaid",
2189
+ "description": "True if prepaid cards should be blocked from buying this item",
2190
+ "type": "BOOLEAN"
2191
+ },
2192
+ {
2193
+ "mode": "NULLABLE",
2194
+ "name": "block_refunds",
2195
+ "description": "True if this item should block any refund attempts, set to false otherwise, null value will not update the field",
2196
+ "type": "BOOLEAN"
2197
+ },
2198
+ {
2199
+ "mode": "REPEATED",
2200
+ "name": "payment_method_validity",
2201
+ "description": "Payment method validity",
2202
+ "type": "RECORD",
2203
+ "fields": [{
2204
+ "mode": "NULLABLE",
2205
+ "name": "value",
2206
+ "type": "STRING"
2207
+ }]
2208
+ },
2209
+ {
2210
+ "mode": "NULLABLE",
2211
+ "name": "no_realtime_charge",
2212
+ "description": "True if no real-time charge should be performed on this item.",
2213
+ "type": "BOOLEAN"
2214
+ }
2215
+ ]
2216
+ },
2217
+ {
2218
+ "name": "chargeback",
2219
+ "description": "Chargeback (deprecated)",
2220
+ "type": "RECORD",
2221
+ "fields": [
2222
+ {
2223
+ "mode": "REPEATED",
2224
+ "name": "addendums",
2225
+ "description": "Addendums (deprecated)",
2226
+ "type": "RECORD",
2227
+ "fields": [
2228
+ {
2229
+ "mode": "NULLABLE",
2230
+ "name": "chargeback_addendum_oid",
2231
+ "description": "Chargeback addendum object identifier",
2232
+ "type": "INTEGER"
2233
+ },
2234
+ {
2235
+ "mode": "NULLABLE",
2236
+ "name": "description",
2237
+ "description": "Description",
2238
+ "type": "STRING"
2239
+ },
2240
+ {
2241
+ "mode": "NULLABLE",
2242
+ "name": "pages",
2243
+ "description": "Number of pages",
2244
+ "type": "INTEGER"
2245
+ },
2246
+ {
2247
+ "mode": "NULLABLE",
2248
+ "name": "file_size",
2249
+ "description": "Size of the file",
2250
+ "type": "INTEGER"
2251
+ }
2252
+ ]
2253
+ },
2254
+ {
2255
+ "mode": "REPEATED",
2256
+ "name": "adjustment_requests",
2257
+ "description": "Adjustment requests (deprecated)",
2258
+ "type": "RECORD",
2259
+ "fields": [
2260
+ {
2261
+ "mode": "NULLABLE",
2262
+ "name": "chargeback_adjustment_request_oid",
2263
+ "description": "Chargeback adjustment request object identifier",
2264
+ "type": "INTEGER"
2265
+ },
2266
+ {
2267
+ "mode": "NULLABLE",
2268
+ "name": "description",
2269
+ "description": "Description",
2270
+ "type": "STRING"
2271
+ },
2272
+ {
2273
+ "mode": "NULLABLE",
2274
+ "name": "reason_code",
2275
+ "description": "Reason code",
2276
+ "type": "STRING"
2277
+ }
2278
+ ]
2279
+ }
2280
+ ]
2281
+ },
2282
+ {
2283
+ "name": "reviews",
2284
+ "description": "Reviews",
2285
+ "type": "RECORD",
2286
+ "fields": [
2287
+ {
2288
+ "mode": "NULLABLE",
2289
+ "name": "review_template_oid",
2290
+ "description": "Review template object identifier",
2291
+ "type": "INTEGER"
2292
+ },
2293
+ {
2294
+ "mode": "NULLABLE",
2295
+ "name": "review_template_name",
2296
+ "description": "Review template name",
2297
+ "type": "STRING"
2298
+ },
2299
+ {
2300
+ "mode": "NULLABLE",
2301
+ "name": "has_review",
2302
+ "description": "True if the item has a review",
2303
+ "type": "BOOLEAN"
2304
+ },
2305
+ {
2306
+ "mode": "NULLABLE",
2307
+ "name": "has_approved_review",
2308
+ "description": "True if the item has an approved review",
2309
+ "type": "BOOLEAN"
2310
+ },
2311
+ {
2312
+ "mode": "NULLABLE",
2313
+ "name": "review_overall",
2314
+ "description": "Overall score of reviews",
2315
+ "type": "NUMERIC"
2316
+ },
2317
+ {
2318
+ "mode": "NULLABLE",
2319
+ "name": "reviewable",
2320
+ "description": "True if the item is reviewable",
2321
+ "type": "BOOLEAN"
2322
+ },
2323
+ {
2324
+ "mode": "NULLABLE",
2325
+ "name": "review_count",
2326
+ "description": "Number of approved reviews",
2327
+ "type": "INTEGER"
2328
+ },
2329
+ {
2330
+ "mode": "NULLABLE",
2331
+ "name": "share_reviews_with_merchant_item_oid",
2332
+ "description": "Share reviews with item oid. To null out this field, set teh value to zero.",
2333
+ "type": "INTEGER"
2334
+ },
2335
+ {
2336
+ "mode": "NULLABLE",
2337
+ "name": "share_reviews_with_merchant_item_id",
2338
+ "description": "Share reviews with item id. To set, use the share_reviews_with_merchant_item_oid field.",
2339
+ "type": "STRING"
2340
+ },
2341
+ {
2342
+ "mode": "REPEATED",
2343
+ "name": "individual_reviews",
2344
+ "type": "RECORD",
2345
+ "fields": [
2346
+ {
2347
+ "mode": "NULLABLE",
2348
+ "name": "review_oid",
2349
+ "type": "INTEGER"
2350
+ },
2351
+ {
2352
+ "mode": "NULLABLE",
2353
+ "name": "customer_profile_oid",
2354
+ "description": "Customer profile object identifier",
2355
+ "type": "INTEGER"
2356
+ },
2357
+ {
2358
+ "mode": "NULLABLE",
2359
+ "name": "overall",
2360
+ "type": "NUMERIC"
2361
+ },
2362
+ {
2363
+ "mode": "NULLABLE",
2364
+ "name": "rating_name1",
2365
+ "description": "Rating Name 1",
2366
+ "type": "STRING"
2367
+ },
2368
+ {
2369
+ "mode": "NULLABLE",
2370
+ "name": "rating_name2",
2371
+ "description": "Rating Name 2",
2372
+ "type": "STRING"
2373
+ },
2374
+ {
2375
+ "mode": "NULLABLE",
2376
+ "name": "rating_name3",
2377
+ "description": "Rating Name 3",
2378
+ "type": "STRING"
2379
+ },
2380
+ {
2381
+ "mode": "NULLABLE",
2382
+ "name": "rating_name4",
2383
+ "description": "Rating Name 4",
2384
+ "type": "STRING"
2385
+ },
2386
+ {
2387
+ "mode": "NULLABLE",
2388
+ "name": "rating_name5",
2389
+ "description": "Rating Name 5",
2390
+ "type": "STRING"
2391
+ },
2392
+ {
2393
+ "mode": "NULLABLE",
2394
+ "name": "rating_name6",
2395
+ "description": "Rating Name 6",
2396
+ "type": "STRING"
2397
+ },
2398
+ {
2399
+ "mode": "NULLABLE",
2400
+ "name": "rating_name7",
2401
+ "description": "Rating Name 7",
2402
+ "type": "STRING"
2403
+ },
2404
+ {
2405
+ "mode": "NULLABLE",
2406
+ "name": "rating_name8",
2407
+ "description": "Rating Name 8",
2408
+ "type": "STRING"
2409
+ },
2410
+ {
2411
+ "mode": "NULLABLE",
2412
+ "name": "rating_name9",
2413
+ "description": "Rating Name 9",
2414
+ "type": "STRING"
2415
+ },
2416
+ {
2417
+ "mode": "NULLABLE",
2418
+ "name": "rating_name10",
2419
+ "description": "Rating Name 10",
2420
+ "type": "STRING"
2421
+ },
2422
+ {
2423
+ "mode": "NULLABLE",
2424
+ "name": "rating_score1",
2425
+ "type": "NUMERIC"
2426
+ },
2427
+ {
2428
+ "mode": "NULLABLE",
2429
+ "name": "rating_score2",
2430
+ "type": "NUMERIC"
2431
+ },
2432
+ {
2433
+ "mode": "NULLABLE",
2434
+ "name": "rating_score3",
2435
+ "type": "NUMERIC"
2436
+ },
2437
+ {
2438
+ "mode": "NULLABLE",
2439
+ "name": "rating_score4",
2440
+ "type": "NUMERIC"
2441
+ },
2442
+ {
2443
+ "mode": "NULLABLE",
2444
+ "name": "rating_score5",
2445
+ "type": "NUMERIC"
2446
+ },
2447
+ {
2448
+ "mode": "NULLABLE",
2449
+ "name": "rating_score6",
2450
+ "type": "NUMERIC"
2451
+ },
2452
+ {
2453
+ "mode": "NULLABLE",
2454
+ "name": "rating_score7",
2455
+ "type": "NUMERIC"
2456
+ },
2457
+ {
2458
+ "mode": "NULLABLE",
2459
+ "name": "rating_score8",
2460
+ "type": "NUMERIC"
2461
+ },
2462
+ {
2463
+ "mode": "NULLABLE",
2464
+ "name": "rating_score9",
2465
+ "type": "NUMERIC"
2466
+ },
2467
+ {
2468
+ "mode": "NULLABLE",
2469
+ "name": "rating_score10",
2470
+ "type": "NUMERIC"
2471
+ },
2472
+ {
2473
+ "mode": "NULLABLE",
2474
+ "name": "recommend_to_friend",
2475
+ "type": "BOOLEAN"
2476
+ },
2477
+ {
2478
+ "mode": "NULLABLE",
2479
+ "name": "title",
2480
+ "description": "Title",
2481
+ "type": "STRING"
2482
+ },
2483
+ {
2484
+ "mode": "NULLABLE",
2485
+ "name": "review",
2486
+ "description": "Review",
2487
+ "type": "STRING"
2488
+ },
2489
+ {
2490
+ "allowed_values": [
2491
+ "approved",
2492
+ "unapproved",
2493
+ "rejected",
2494
+ "multimedia processing"
2495
+ ],
2496
+ "mode": "NULLABLE",
2497
+ "name": "status",
2498
+ "description": "Status of the review",
2499
+ "type": "STRING"
2500
+ },
2501
+ {
2502
+ "mode": "NULLABLE",
2503
+ "name": "featured",
2504
+ "type": "BOOLEAN"
2505
+ },
2506
+ {
2507
+ "mode": "NULLABLE",
2508
+ "name": "recommend_store_to_friend",
2509
+ "type": "INTEGER"
2510
+ },
2511
+ {
2512
+ "mode": "NULLABLE",
2513
+ "name": "store_feedback",
2514
+ "description": "Store Feedback",
2515
+ "type": "STRING"
2516
+ },
2517
+ {
2518
+ "mode": "NULLABLE",
2519
+ "name": "submitted_dts",
2520
+ "description": "Date/time of review submission",
2521
+ "type": "DATETIME"
2522
+ },
2523
+ {
2524
+ "mode": "NULLABLE",
2525
+ "name": "helpful_yes_votes",
2526
+ "type": "INTEGER"
2527
+ },
2528
+ {
2529
+ "mode": "NULLABLE",
2530
+ "name": "helperful_no_votes",
2531
+ "type": "INTEGER"
2532
+ },
2533
+ {
2534
+ "mode": "NULLABLE",
2535
+ "name": "reviewed_nickname",
2536
+ "description": "Nickname",
2537
+ "type": "STRING"
2538
+ },
2539
+ {
2540
+ "mode": "NULLABLE",
2541
+ "name": "reviewer_location",
2542
+ "description": "Location",
2543
+ "type": "STRING"
2544
+ },
2545
+ {
2546
+ "mode": "NULLABLE",
2547
+ "name": "reviewer_email",
2548
+ "description": "Reviewer Email",
2549
+ "type": "STRING"
2550
+ },
2551
+ {
2552
+ "mode": "NULLABLE",
2553
+ "name": "order_id",
2554
+ "type": "STRING"
2555
+ },
2556
+ {
2557
+ "mode": "NULLABLE",
2558
+ "name": "merchant_reply",
2559
+ "description": "Merchant Reply (set to an empty string to remove)",
2560
+ "type": "STRING"
2561
+ }
2562
+ ]
2563
+ }
2564
+ ]
2565
+ },
2566
+ {
2567
+ "name": "physical",
2568
+ "description": "Physical characters like weight and measurements",
2569
+ "type": "RECORD",
2570
+ "fields": [
2571
+ {
2572
+ "name": "weight",
2573
+ "description": "Weight",
2574
+ "type": "RECORD",
2575
+ "fields": [
2576
+ {
2577
+ "mode": "NULLABLE",
2578
+ "name": "value",
2579
+ "description": "Weight",
2580
+ "type": "NUMERIC"
2581
+ },
2582
+ {
2583
+ "allowed_values": [
2584
+ "KG",
2585
+ "G",
2586
+ "LB",
2587
+ "OZ"
2588
+ ],
2589
+ "mode": "NULLABLE",
2590
+ "name": "uom",
2591
+ "description": "Unit of measure",
2592
+ "type": "STRING"
2593
+ }
2594
+ ]
2595
+ },
2596
+ {
2597
+ "name": "length",
2598
+ "description": "Length",
2599
+ "type": "RECORD",
2600
+ "fields": [
2601
+ {
2602
+ "mode": "NULLABLE",
2603
+ "name": "value",
2604
+ "description": "The distance measured in UOM",
2605
+ "type": "NUMERIC"
2606
+ },
2607
+ {
2608
+ "allowed_values": [
2609
+ "IN",
2610
+ "CM"
2611
+ ],
2612
+ "mode": "NULLABLE",
2613
+ "name": "uom",
2614
+ "description": "Unit of measure",
2615
+ "type": "STRING"
2616
+ }
2617
+ ]
2618
+ },
2619
+ {
2620
+ "name": "width",
2621
+ "description": "Width",
2622
+ "type": "RECORD",
2623
+ "fields": [
2624
+ {
2625
+ "mode": "NULLABLE",
2626
+ "name": "value",
2627
+ "description": "The distance measured in UOM",
2628
+ "type": "NUMERIC"
2629
+ },
2630
+ {
2631
+ "allowed_values": [
2632
+ "IN",
2633
+ "CM"
2634
+ ],
2635
+ "mode": "NULLABLE",
2636
+ "name": "uom",
2637
+ "description": "Unit of measure",
2638
+ "type": "STRING"
2639
+ }
2640
+ ]
2641
+ },
2642
+ {
2643
+ "name": "height",
2644
+ "description": "Height",
2645
+ "type": "RECORD",
2646
+ "fields": [
2647
+ {
2648
+ "mode": "NULLABLE",
2649
+ "name": "value",
2650
+ "description": "The distance measured in UOM",
2651
+ "type": "NUMERIC"
2652
+ },
2653
+ {
2654
+ "allowed_values": [
2655
+ "IN",
2656
+ "CM"
2657
+ ],
2658
+ "mode": "NULLABLE",
2659
+ "name": "uom",
2660
+ "description": "Unit of measure",
2661
+ "type": "STRING"
2662
+ }
2663
+ ]
2664
+ }
2665
+ ]
2666
+ },
2667
+ {
2668
+ "name": "related",
2669
+ "description": "Related items",
2670
+ "type": "RECORD",
2671
+ "fields": [
2672
+ {
2673
+ "mode": "REPEATED",
2674
+ "name": "related_items",
2675
+ "description": "Related items",
2676
+ "type": "RECORD",
2677
+ "fields": [
2678
+ {
2679
+ "mode": "NULLABLE",
2680
+ "name": "related_merchant_item_oid",
2681
+ "description": "Related item object identifier",
2682
+ "type": "INTEGER"
2683
+ },
2684
+ {
2685
+ "mode": "NULLABLE",
2686
+ "name": "related_merchant_item_id",
2687
+ "description": "Related item id",
2688
+ "type": "STRING"
2689
+ },
2690
+ {
2691
+ "allowed_values": [
2692
+ "System",
2693
+ "UserDefined",
2694
+ "Addon",
2695
+ "Complementary"
2696
+ ],
2697
+ "mode": "NULLABLE",
2698
+ "name": "type",
2699
+ "description": "Relationship type",
2700
+ "type": "STRING"
2701
+ }
2702
+ ]
2703
+ },
2704
+ {
2705
+ "mode": "NULLABLE",
2706
+ "name": "not_relatable",
2707
+ "description": "Not relatable",
2708
+ "type": "BOOLEAN"
2709
+ },
2710
+ {
2711
+ "mode": "NULLABLE",
2712
+ "name": "no_system_calculated_related_items",
2713
+ "description": "True to suppress system calculated relationships",
2714
+ "type": "BOOLEAN"
2715
+ }
2716
+ ]
2717
+ },
2718
+ {
2719
+ "name": "restriction",
2720
+ "description": "Restrictions",
2721
+ "type": "RECORD",
2722
+ "fields": [
2723
+ {
2724
+ "mode": "NULLABLE",
2725
+ "name": "purchase_separately",
2726
+ "description": "Purchase separately",
2727
+ "type": "BOOLEAN"
2728
+ },
2729
+ {
2730
+ "mode": "REPEATED",
2731
+ "name": "items",
2732
+ "description": "Items",
2733
+ "type": "RECORD",
2734
+ "fields": [
2735
+ {
2736
+ "mode": "NULLABLE",
2737
+ "name": "restrict_merchant_item_oid",
2738
+ "description": "Restrict item object identifier",
2739
+ "type": "INTEGER"
2740
+ },
2741
+ {
2742
+ "mode": "NULLABLE",
2743
+ "name": "restrict_merchant_item_id",
2744
+ "description": "Restrict item id",
2745
+ "type": "STRING"
2746
+ },
2747
+ {
2748
+ "allowed_values": [
2749
+ "can not be purchased with",
2750
+ "can only be purchased with",
2751
+ "must be purchased with"
2752
+ ],
2753
+ "mode": "NULLABLE",
2754
+ "name": "type",
2755
+ "description": "Restriction type",
2756
+ "type": "STRING"
2757
+ }
2758
+ ]
2759
+ },
2760
+ {
2761
+ "mode": "NULLABLE",
2762
+ "name": "one_per_customer",
2763
+ "description": "One per customer",
2764
+ "type": "BOOLEAN"
2765
+ },
2766
+ {
2767
+ "mode": "NULLABLE",
2768
+ "name": "exclude_coupon",
2769
+ "description": "Exclude coupons",
2770
+ "type": "BOOLEAN"
2771
+ },
2772
+ {
2773
+ "mode": "NULLABLE",
2774
+ "name": "exclude_from_free_promotion",
2775
+ "description": "Exclude from free promotion",
2776
+ "type": "BOOLEAN"
2777
+ },
2778
+ {
2779
+ "mode": "NULLABLE",
2780
+ "name": "minimum_quantity",
2781
+ "description": "Minimum quantity (defaults to 1)",
2782
+ "type": "INTEGER"
2783
+ },
2784
+ {
2785
+ "mode": "NULLABLE",
2786
+ "name": "maximum_quantity",
2787
+ "description": "Maximum quantity",
2788
+ "type": "INTEGER"
2789
+ },
2790
+ {
2791
+ "mode": "NULLABLE",
2792
+ "name": "multiple_quantity",
2793
+ "description": "Multiple of quantity",
2794
+ "type": "INTEGER"
2795
+ },
2796
+ {
2797
+ "mode": "NULLABLE",
2798
+ "name": "exclude_from_loyalty",
2799
+ "description": "Exclude from loyalty. Must be set to true or false to save. Null is ignored for backwards SDK compatibility",
2800
+ "type": "BOOLEAN"
2801
+ }
2802
+ ]
2803
+ },
2804
+ {
2805
+ "name": "instant_payment_notifications",
2806
+ "description": "Instance Payment Notifications",
2807
+ "type": "RECORD",
2808
+ "fields": [{
2809
+ "mode": "REPEATED",
2810
+ "name": "notifications",
2811
+ "description": "Notifications",
2812
+ "type": "RECORD",
2813
+ "fields": [
2814
+ {
2815
+ "mode": "NULLABLE",
2816
+ "name": "url",
2817
+ "description": "URL",
2818
+ "type": "STRING"
2819
+ },
2820
+ {
2821
+ "mode": "NULLABLE",
2822
+ "name": "successful_response_text",
2823
+ "description": "Successful response text",
2824
+ "type": "STRING"
2825
+ },
2826
+ {
2827
+ "mode": "NULLABLE",
2828
+ "name": "post_operation",
2829
+ "description": "True for HTTP POST instead of GET",
2830
+ "type": "BOOLEAN"
2831
+ }
2832
+ ]
2833
+ }]
2834
+ },
2835
+ {
2836
+ "name": "realtime_pricing",
2837
+ "description": "Real-time Pricing",
2838
+ "type": "RECORD",
2839
+ "fields": [
2840
+ {
2841
+ "mode": "NULLABLE",
2842
+ "name": "realtime_pricing_provider_oid",
2843
+ "description": "Real-time pricing provide object identifier",
2844
+ "type": "INTEGER"
2845
+ },
2846
+ {
2847
+ "mode": "NULLABLE",
2848
+ "name": "realtime_pricing_provider",
2849
+ "description": "Real-time pricing provider name",
2850
+ "type": "STRING"
2851
+ },
2852
+ {
2853
+ "mode": "NULLABLE",
2854
+ "name": "realtime_pricing_parameter",
2855
+ "description": "Real-time pricing provider parameters",
2856
+ "type": "STRING"
2857
+ }
2858
+ ]
2859
+ },
2860
+ {
2861
+ "name": "content",
2862
+ "description": "Content such as multimedia and attributes",
2863
+ "type": "RECORD",
2864
+ "fields": [
2865
+ {
2866
+ "mode": "NULLABLE",
2867
+ "name": "exclude_from_top_sellers",
2868
+ "description": "Exclude from the top sellers list in the StoreFront",
2869
+ "type": "BOOLEAN"
2870
+ },
2871
+ {
2872
+ "mode": "NULLABLE",
2873
+ "name": "exclude_from_search",
2874
+ "description": "Exclude from search",
2875
+ "type": "BOOLEAN"
2876
+ },
2877
+ {
2878
+ "mode": "NULLABLE",
2879
+ "name": "view_url",
2880
+ "description": "Legacy view URL (not used by StoreFronts)",
2881
+ "type": "STRING"
2882
+ },
2883
+ {
2884
+ "mode": "NULLABLE",
2885
+ "name": "new_item",
2886
+ "description": "True if the item is new",
2887
+ "type": "BOOLEAN"
2888
+ },
2889
+ {
2890
+ "mode": "NULLABLE",
2891
+ "name": "new_item_start",
2892
+ "description": "The date the item should start being considered new",
2893
+ "type": "DATETIME"
2894
+ },
2895
+ {
2896
+ "mode": "NULLABLE",
2897
+ "name": "new_item_end",
2898
+ "description": "The date the item should no longer be considered new",
2899
+ "type": "DATETIME"
2900
+ },
2901
+ {
2902
+ "mode": "NULLABLE",
2903
+ "name": "extended_description",
2904
+ "description": "Extended description (max 10000 characters)",
2905
+ "type": "STRING"
2906
+ },
2907
+ {
2908
+ "mode": "NULLABLE",
2909
+ "name": "extended_description_translated_text_instance_oid",
2910
+ "description": "Extended description text translation instance identifier",
2911
+ "type": "INTEGER"
2912
+ },
2913
+ {
2914
+ "mode": "REPEATED",
2915
+ "name": "assignments",
2916
+ "description": "StoreFront assignments",
2917
+ "type": "RECORD",
2918
+ "fields": [
2919
+ {
2920
+ "mode": "NULLABLE",
2921
+ "name": "host",
2922
+ "description": "StoreFront host name",
2923
+ "type": "STRING"
2924
+ },
2925
+ {
2926
+ "mode": "NULLABLE",
2927
+ "name": "group_path",
2928
+ "description": "Page (group) path",
2929
+ "type": "STRING"
2930
+ },
2931
+ {
2932
+ "mode": "NULLABLE",
2933
+ "name": "group_oid",
2934
+ "description": "Page (group) object identifier",
2935
+ "type": "INTEGER"
2936
+ },
2937
+ {
2938
+ "mode": "NULLABLE",
2939
+ "name": "sort_order",
2940
+ "description": "Sort order (optional)",
2941
+ "type": "INTEGER"
2942
+ },
2943
+ {
2944
+ "mode": "NULLABLE",
2945
+ "name": "url_part",
2946
+ "description": "URL part if the item id is not used",
2947
+ "type": "STRING"
2948
+ },
2949
+ {
2950
+ "mode": "NULLABLE",
2951
+ "name": "default_assignment",
2952
+ "description": "True if this group is the default assignment for this item",
2953
+ "type": "BOOLEAN"
2954
+ }
2955
+ ]
2956
+ },
2957
+ {
2958
+ "mode": "REPEATED",
2959
+ "name": "attributes",
2960
+ "description": "StoreFront attributes",
2961
+ "type": "RECORD",
2962
+ "fields": [
2963
+ {
2964
+ "mode": "NULLABLE",
2965
+ "name": "name",
2966
+ "description": "Attribute name",
2967
+ "type": "STRING"
2968
+ },
2969
+ {
2970
+ "mode": "NULLABLE",
2971
+ "name": "type",
2972
+ "description": "Attribute type",
2973
+ "type": "STRING"
2974
+ },
2975
+ {
2976
+ "mode": "NULLABLE",
2977
+ "name": "value",
2978
+ "description": "Attribute value",
2979
+ "type": "STRING"
2980
+ },
2981
+ {
2982
+ "mode": "NULLABLE",
2983
+ "name": "translated_text_instance_oid",
2984
+ "description": "Attribute translated text instance identifier",
2985
+ "type": "INTEGER"
2986
+ }
2987
+ ]
2988
+ },
2989
+ {
2990
+ "mode": "REPEATED",
2991
+ "name": "multimedia",
2992
+ "description": "Multimedia",
2993
+ "type": "RECORD",
2994
+ "fields": [
2995
+ {
2996
+ "mode": "NULLABLE",
2997
+ "name": "merchant_item_multimedia_oid",
2998
+ "description": "Item multimedia object identifier",
2999
+ "type": "INTEGER"
3000
+ },
3001
+ {
3002
+ "mode": "NULLABLE",
3003
+ "name": "file_name",
3004
+ "description": "File name",
3005
+ "type": "STRING"
3006
+ },
3007
+ {
3008
+ "mode": "NULLABLE",
3009
+ "name": "description",
3010
+ "description": "Description",
3011
+ "type": "STRING"
3012
+ },
3013
+ {
3014
+ "mode": "NULLABLE",
3015
+ "name": "url",
3016
+ "description": "URL to download file (on new multimedia record this can be a URL for UltraCart to fetch)",
3017
+ "type": "STRING"
3018
+ },
3019
+ {
3020
+ "mode": "NULLABLE",
3021
+ "name": "exclude_from_gallery",
3022
+ "description": "True to exclude from multimedia gallery",
3023
+ "type": "BOOLEAN"
3024
+ },
3025
+ {
3026
+ "allowed_values": [
3027
+ "Image",
3028
+ "PDF",
3029
+ "Text",
3030
+ "Unknown",
3031
+ "Video"
3032
+ ],
3033
+ "mode": "NULLABLE",
3034
+ "name": "type",
3035
+ "description": "Type of file",
3036
+ "type": "STRING"
3037
+ },
3038
+ {
3039
+ "mode": "NULLABLE",
3040
+ "name": "code",
3041
+ "description": "Code assigned to the file",
3042
+ "type": "STRING"
3043
+ },
3044
+ {
3045
+ "mode": "NULLABLE",
3046
+ "name": "temp_multimedia_oid",
3047
+ "description": "Temporary multimedia object identifier assigned if uploading new multimedia",
3048
+ "type": "INTEGER"
3049
+ },
3050
+ {
3051
+ "mode": "NULLABLE",
3052
+ "name": "orphan",
3053
+ "description": "True if the multimedia is an orphan of the active StoreFront themes",
3054
+ "type": "BOOLEAN"
3055
+ },
3056
+ {
3057
+ "mode": "NULLABLE",
3058
+ "name": "placeholder",
3059
+ "description": "True if the object is a place holder that can be populated",
3060
+ "type": "BOOLEAN"
3061
+ },
3062
+ {
3063
+ "mode": "NULLABLE",
3064
+ "name": "width",
3065
+ "description": "Width of the image",
3066
+ "type": "INTEGER"
3067
+ },
3068
+ {
3069
+ "mode": "NULLABLE",
3070
+ "name": "height",
3071
+ "description": "Height of the image",
3072
+ "type": "INTEGER"
3073
+ },
3074
+ {
3075
+ "mode": "NULLABLE",
3076
+ "name": "cloud_url",
3077
+ "description": "URL where the image can be downloaded from the cloud",
3078
+ "type": "STRING"
3079
+ },
3080
+ {
3081
+ "mode": "NULLABLE",
3082
+ "name": "cloud_url_expiration",
3083
+ "description": "Expiration date of the cloud URL",
3084
+ "type": "DATETIME"
3085
+ },
3086
+ {
3087
+ "mode": "REPEATED",
3088
+ "name": "thumbnails",
3089
+ "description": "Thumbnails of this image",
3090
+ "type": "RECORD",
3091
+ "fields": [
3092
+ {
3093
+ "mode": "NULLABLE",
3094
+ "name": "height",
3095
+ "description": "Height of the thumbnail",
3096
+ "type": "INTEGER"
3097
+ },
3098
+ {
3099
+ "mode": "NULLABLE",
3100
+ "name": "width",
3101
+ "description": "Width of the thumbnail",
3102
+ "type": "INTEGER"
3103
+ },
3104
+ {
3105
+ "mode": "NULLABLE",
3106
+ "name": "http_url",
3107
+ "description": "HTTP URL to view the thumbnail",
3108
+ "type": "STRING"
3109
+ },
3110
+ {
3111
+ "mode": "NULLABLE",
3112
+ "name": "https_url",
3113
+ "description": "HTTPS URL to view the thumbnail",
3114
+ "type": "STRING"
3115
+ },
3116
+ {
3117
+ "mode": "NULLABLE",
3118
+ "name": "png_format",
3119
+ "description": "True if PNG, false if JPEG",
3120
+ "type": "BOOLEAN"
3121
+ },
3122
+ {
3123
+ "mode": "NULLABLE",
3124
+ "name": "square",
3125
+ "description": "True if the thumbnail is square",
3126
+ "type": "BOOLEAN"
3127
+ }
3128
+ ]
3129
+ },
3130
+ {
3131
+ "mode": "NULLABLE",
3132
+ "name": "size",
3133
+ "description": "Size of the file in bytes if known",
3134
+ "type": "INTEGER"
3135
+ }
3136
+ ]
3137
+ },
3138
+ {
3139
+ "mode": "NULLABLE",
3140
+ "name": "custom_thank_you_url",
3141
+ "description": "Custom Thank You URL",
3142
+ "type": "STRING"
3143
+ },
3144
+ {
3145
+ "mode": "NULLABLE",
3146
+ "name": "exclude_from_sitemap",
3147
+ "description": "Exclude from the sitemap for the StoreFront",
3148
+ "type": "BOOLEAN"
3149
+ },
3150
+ {
3151
+ "mode": "NULLABLE",
3152
+ "name": "meta_title",
3153
+ "description": "SEO meta title used by Storefronts",
3154
+ "type": "STRING"
3155
+ },
3156
+ {
3157
+ "mode": "NULLABLE",
3158
+ "name": "meta_description",
3159
+ "description": "SEO meta description used by Storefronts",
3160
+ "type": "STRING"
3161
+ },
3162
+ {
3163
+ "mode": "NULLABLE",
3164
+ "name": "meta_keywords",
3165
+ "description": "SEO meta keywords used by Storefronts",
3166
+ "type": "STRING"
3167
+ }
3168
+ ]
3169
+ },
3170
+ {
3171
+ "mode": "REPEATED",
3172
+ "name": "options",
3173
+ "description": "Options",
3174
+ "type": "RECORD",
3175
+ "fields": [
3176
+ {
3177
+ "mode": "NULLABLE",
3178
+ "name": "option_oid",
3179
+ "description": "Option object identifier",
3180
+ "type": "INTEGER"
3181
+ },
3182
+ {
3183
+ "mode": "NULLABLE",
3184
+ "name": "name",
3185
+ "description": "Name",
3186
+ "type": "STRING"
3187
+ },
3188
+ {
3189
+ "mode": "NULLABLE",
3190
+ "name": "label",
3191
+ "description": "Label",
3192
+ "type": "STRING"
3193
+ },
3194
+ {
3195
+ "mode": "NULLABLE",
3196
+ "name": "system_option",
3197
+ "description": "True if this is a system option",
3198
+ "type": "BOOLEAN"
3199
+ },
3200
+ {
3201
+ "mode": "NULLABLE",
3202
+ "name": "required",
3203
+ "description": "True if the customer is required to specify an answer",
3204
+ "type": "BOOLEAN"
3205
+ },
3206
+ {
3207
+ "mode": "NULLABLE",
3208
+ "name": "ignore_if_default",
3209
+ "description": "Ignore this option on the order if the default value is selected",
3210
+ "type": "BOOLEAN"
3211
+ },
3212
+ {
3213
+ "allowed_values": [
3214
+ "dropdown",
3215
+ "file attachment",
3216
+ "fixed",
3217
+ "hidden",
3218
+ "multiline",
3219
+ "radio",
3220
+ "single"
3221
+ ],
3222
+ "mode": "NULLABLE",
3223
+ "name": "type",
3224
+ "description": "Type of option",
3225
+ "type": "STRING"
3226
+ },
3227
+ {
3228
+ "mode": "NULLABLE",
3229
+ "name": "one_time_fee",
3230
+ "description": "One time fee",
3231
+ "type": "BOOLEAN"
3232
+ },
3233
+ {
3234
+ "mode": "NULLABLE",
3235
+ "name": "cost_per_line",
3236
+ "description": "Cost per line",
3237
+ "type": "NUMERIC"
3238
+ },
3239
+ {
3240
+ "mode": "NULLABLE",
3241
+ "name": "cost_per_letter",
3242
+ "description": "Cost per letter",
3243
+ "type": "NUMERIC"
3244
+ },
3245
+ {
3246
+ "mode": "NULLABLE",
3247
+ "name": "cost_if_specified",
3248
+ "description": "Cost if specified",
3249
+ "type": "NUMERIC"
3250
+ },
3251
+ {
3252
+ "mode": "NULLABLE",
3253
+ "name": "name_translated_text_instance_oid",
3254
+ "description": "Name translated text instance ID",
3255
+ "type": "INTEGER"
3256
+ },
3257
+ {
3258
+ "mode": "NULLABLE",
3259
+ "name": "label_translated_text_instance_oid",
3260
+ "description": "Label translated text instance ID",
3261
+ "type": "INTEGER"
3262
+ },
3263
+ {
3264
+ "mode": "REPEATED",
3265
+ "name": "values",
3266
+ "description": "Values",
3267
+ "type": "RECORD",
3268
+ "fields": [
3269
+ {
3270
+ "mode": "NULLABLE",
3271
+ "name": "option_value_oid",
3272
+ "description": "Option value object identifier",
3273
+ "type": "INTEGER"
3274
+ },
3275
+ {
3276
+ "mode": "NULLABLE",
3277
+ "name": "value",
3278
+ "description": "Value",
3279
+ "type": "STRING"
3280
+ },
3281
+ {
3282
+ "mode": "NULLABLE",
3283
+ "name": "cost_change",
3284
+ "description": "Cost change",
3285
+ "type": "NUMERIC"
3286
+ },
3287
+ {
3288
+ "name": "weight_change",
3289
+ "description": "Weight change",
3290
+ "type": "RECORD",
3291
+ "fields": [
3292
+ {
3293
+ "mode": "NULLABLE",
3294
+ "name": "value",
3295
+ "description": "Weight",
3296
+ "type": "NUMERIC"
3297
+ },
3298
+ {
3299
+ "allowed_values": [
3300
+ "KG",
3301
+ "G",
3302
+ "LB",
3303
+ "OZ"
3304
+ ],
3305
+ "mode": "NULLABLE",
3306
+ "name": "uom",
3307
+ "description": "Unit of measure",
3308
+ "type": "STRING"
3309
+ }
3310
+ ]
3311
+ },
3312
+ {
3313
+ "mode": "NULLABLE",
3314
+ "name": "default_value",
3315
+ "description": "True if default value",
3316
+ "type": "BOOLEAN"
3317
+ },
3318
+ {
3319
+ "name": "length",
3320
+ "description": "Additional dimensions (length)",
3321
+ "type": "RECORD",
3322
+ "fields": [
3323
+ {
3324
+ "mode": "NULLABLE",
3325
+ "name": "value",
3326
+ "description": "The distance measured in UOM",
3327
+ "type": "NUMERIC"
3328
+ },
3329
+ {
3330
+ "allowed_values": [
3331
+ "IN",
3332
+ "CM"
3333
+ ],
3334
+ "mode": "NULLABLE",
3335
+ "name": "uom",
3336
+ "description": "Unit of measure",
3337
+ "type": "STRING"
3338
+ }
3339
+ ]
3340
+ },
3341
+ {
3342
+ "name": "height",
3343
+ "description": "Additional dimensions (height)",
3344
+ "type": "RECORD",
3345
+ "fields": [
3346
+ {
3347
+ "mode": "NULLABLE",
3348
+ "name": "value",
3349
+ "description": "The distance measured in UOM",
3350
+ "type": "NUMERIC"
3351
+ },
3352
+ {
3353
+ "allowed_values": [
3354
+ "IN",
3355
+ "CM"
3356
+ ],
3357
+ "mode": "NULLABLE",
3358
+ "name": "uom",
3359
+ "description": "Unit of measure",
3360
+ "type": "STRING"
3361
+ }
3362
+ ]
3363
+ },
3364
+ {
3365
+ "name": "width",
3366
+ "description": "Additional dimensions (width)",
3367
+ "type": "RECORD",
3368
+ "fields": [
3369
+ {
3370
+ "mode": "NULLABLE",
3371
+ "name": "value",
3372
+ "description": "The distance measured in UOM",
3373
+ "type": "NUMERIC"
3374
+ },
3375
+ {
3376
+ "allowed_values": [
3377
+ "IN",
3378
+ "CM"
3379
+ ],
3380
+ "mode": "NULLABLE",
3381
+ "name": "uom",
3382
+ "description": "Unit of measure",
3383
+ "type": "STRING"
3384
+ }
3385
+ ]
3386
+ },
3387
+ {
3388
+ "allowed_values": [
3389
+ "none",
3390
+ "set item to",
3391
+ "add item"
3392
+ ],
3393
+ "mode": "NULLABLE",
3394
+ "name": "additional_dimension_application",
3395
+ "description": "Additional dimensions application",
3396
+ "type": "STRING"
3397
+ },
3398
+ {
3399
+ "mode": "REPEATED",
3400
+ "name": "additional_items",
3401
+ "description": "Additional items to add to the order if this value is selected",
3402
+ "type": "RECORD",
3403
+ "fields": [
3404
+ {
3405
+ "mode": "NULLABLE",
3406
+ "name": "additional_merchant_item_oid",
3407
+ "description": "Additional item object identifier",
3408
+ "type": "INTEGER"
3409
+ },
3410
+ {
3411
+ "mode": "NULLABLE",
3412
+ "name": "additional_merchant_item_id",
3413
+ "description": "Additional item id",
3414
+ "type": "STRING"
3415
+ }
3416
+ ]
3417
+ },
3418
+ {
3419
+ "mode": "REPEATED",
3420
+ "name": "digital_items",
3421
+ "description": "Digital items to allow the customer to download if this option value is selected",
3422
+ "type": "RECORD",
3423
+ "fields": [
3424
+ {
3425
+ "mode": "NULLABLE",
3426
+ "name": "digital_item_oid",
3427
+ "description": "Digital item object identifier",
3428
+ "type": "INTEGER"
3429
+ },
3430
+ {
3431
+ "mode": "NULLABLE",
3432
+ "name": "original_filename",
3433
+ "description": "Original filename",
3434
+ "type": "STRING"
3435
+ }
3436
+ ]
3437
+ },
3438
+ {
3439
+ "mode": "NULLABLE",
3440
+ "name": "percent_cost_change",
3441
+ "description": "Percentage cost change",
3442
+ "type": "NUMERIC"
3443
+ },
3444
+ {
3445
+ "mode": "NULLABLE",
3446
+ "name": "weight_change_percent",
3447
+ "description": "Percentage weight change",
3448
+ "type": "NUMERIC"
3449
+ },
3450
+ {
3451
+ "mode": "NULLABLE",
3452
+ "name": "merchant_item_multimedia_oid",
3453
+ "description": "Multimedia object identifier associated with this option value",
3454
+ "type": "INTEGER"
3455
+ },
3456
+ {
3457
+ "mode": "NULLABLE",
3458
+ "name": "translated_text_instance_oid",
3459
+ "description": "Translated text instance id",
3460
+ "type": "INTEGER"
3461
+ }
3462
+ ]
3463
+ }
3464
+ ]
3465
+ },
3466
+ {
3467
+ "mode": "REPEATED",
3468
+ "name": "variations",
3469
+ "description": "Variations",
3470
+ "type": "RECORD",
3471
+ "fields": [
3472
+ {
3473
+ "mode": "NULLABLE",
3474
+ "name": "name",
3475
+ "description": "Name",
3476
+ "type": "STRING"
3477
+ },
3478
+ {
3479
+ "mode": "NULLABLE",
3480
+ "name": "default_text",
3481
+ "description": "Default text",
3482
+ "type": "STRING"
3483
+ },
3484
+ {
3485
+ "mode": "NULLABLE",
3486
+ "name": "name_translated_text_instance_oid",
3487
+ "description": "Name translated text instance id",
3488
+ "type": "INTEGER"
3489
+ },
3490
+ {
3491
+ "mode": "NULLABLE",
3492
+ "name": "default_text_translated_text_instance_oid",
3493
+ "description": "Default text translated text instance id",
3494
+ "type": "INTEGER"
3495
+ },
3496
+ {
3497
+ "mode": "REPEATED",
3498
+ "name": "options",
3499
+ "description": "Options",
3500
+ "type": "RECORD",
3501
+ "fields": [
3502
+ {
3503
+ "mode": "NULLABLE",
3504
+ "name": "value",
3505
+ "description": "Value",
3506
+ "type": "STRING"
3507
+ },
3508
+ {
3509
+ "mode": "NULLABLE",
3510
+ "name": "default_option",
3511
+ "description": "True if default option",
3512
+ "type": "BOOLEAN"
3513
+ },
3514
+ {
3515
+ "mode": "NULLABLE",
3516
+ "name": "merchant_item_multimedia_oid",
3517
+ "description": "Multimedia object identifier",
3518
+ "type": "INTEGER"
3519
+ },
3520
+ {
3521
+ "mode": "NULLABLE",
3522
+ "name": "translated_text_instance_oid",
3523
+ "description": "Translated text instance id",
3524
+ "type": "INTEGER"
3525
+ }
3526
+ ]
3527
+ }
3528
+ ]
3529
+ },
3530
+ {
3531
+ "mode": "REPEATED",
3532
+ "name": "variant_items",
3533
+ "description": "Variant Items",
3534
+ "type": "RECORD",
3535
+ "fields": [
3536
+ {
3537
+ "mode": "NULLABLE",
3538
+ "name": "variant_merchant_item_oid",
3539
+ "description": "Variant item object identifier",
3540
+ "type": "INTEGER"
3541
+ },
3542
+ {
3543
+ "mode": "NULLABLE",
3544
+ "name": "variant_merchant_item_id",
3545
+ "description": "Variant item id",
3546
+ "type": "STRING"
3547
+ },
3548
+ {
3549
+ "mode": "NULLABLE",
3550
+ "name": "description",
3551
+ "description": "Description",
3552
+ "type": "STRING"
3553
+ },
3554
+ {
3555
+ "mode": "NULLABLE",
3556
+ "name": "merchant_item_multimedia_oid",
3557
+ "description": "Multimedia object identifier",
3558
+ "type": "INTEGER"
3559
+ },
3560
+ {
3561
+ "mode": "REPEATED",
3562
+ "name": "variations",
3563
+ "description": "Variations",
3564
+ "type": "RECORD",
3565
+ "fields": [{
3566
+ "mode": "NULLABLE",
3567
+ "name": "value",
3568
+ "type": "STRING"
3569
+ }]
3570
+ },
3571
+ {
3572
+ "mode": "REPEATED",
3573
+ "name": "variation_options",
3574
+ "description": "Variation options",
3575
+ "type": "RECORD",
3576
+ "fields": [{
3577
+ "mode": "NULLABLE",
3578
+ "name": "value",
3579
+ "type": "STRING"
3580
+ }]
3581
+ }
3582
+ ]
3583
+ },
3584
+ {
3585
+ "name": "ebay",
3586
+ "description": "e-Bay",
3587
+ "type": "RECORD",
3588
+ "fields": [
3589
+ {
3590
+ "mode": "NULLABLE",
3591
+ "name": "ebay_auction_id",
3592
+ "description": "If listed, this is the e-Bay auction id",
3593
+ "type": "STRING"
3594
+ },
3595
+ {
3596
+ "mode": "NULLABLE",
3597
+ "name": "status",
3598
+ "description": "Status of the item's listing",
3599
+ "type": "STRING"
3600
+ },
3601
+ {
3602
+ "mode": "NULLABLE",
3603
+ "name": "category_id",
3604
+ "description": "e-Bay category ID",
3605
+ "type": "INTEGER"
3606
+ },
3607
+ {
3608
+ "mode": "NULLABLE",
3609
+ "name": "start_time",
3610
+ "description": "Date/time of the auction start",
3611
+ "type": "STRING"
3612
+ },
3613
+ {
3614
+ "mode": "NULLABLE",
3615
+ "name": "end_time",
3616
+ "description": "Date/time of the auction end",
3617
+ "type": "DATETIME"
3618
+ },
3619
+ {
3620
+ "mode": "NULLABLE",
3621
+ "name": "active",
3622
+ "description": "True if the item is active for listing",
3623
+ "type": "BOOLEAN"
3624
+ },
3625
+ {
3626
+ "mode": "NULLABLE",
3627
+ "name": "listing_price",
3628
+ "description": "Price to list the item at",
3629
+ "type": "NUMERIC"
3630
+ },
3631
+ {
3632
+ "mode": "NULLABLE",
3633
+ "name": "quantity",
3634
+ "description": "Quantity available of the item",
3635
+ "type": "INTEGER"
3636
+ },
3637
+ {
3638
+ "mode": "NULLABLE",
3639
+ "name": "free_shipping",
3640
+ "description": "True if item receives free shipping",
3641
+ "type": "BOOLEAN"
3642
+ },
3643
+ {
3644
+ "mode": "NULLABLE",
3645
+ "name": "custom_category1",
3646
+ "description": "e-Bay Store category 1",
3647
+ "type": "INTEGER"
3648
+ },
3649
+ {
3650
+ "mode": "NULLABLE",
3651
+ "name": "custom_category2",
3652
+ "description": "e-Bay Store category 2",
3653
+ "type": "INTEGER"
3654
+ },
3655
+ {
3656
+ "mode": "NULLABLE",
3657
+ "name": "listing_dts",
3658
+ "description": "Date/time of the listing",
3659
+ "type": "DATETIME"
3660
+ },
3661
+ {
3662
+ "mode": "NULLABLE",
3663
+ "name": "last_status_dts",
3664
+ "description": "Date/time of the last status check",
3665
+ "type": "DATETIME"
3666
+ },
3667
+ {
3668
+ "mode": "NULLABLE",
3669
+ "name": "packaging_handling_costs",
3670
+ "description": "Packaging and handling costs",
3671
+ "type": "NUMERIC"
3672
+ },
3673
+ {
3674
+ "mode": "NULLABLE",
3675
+ "name": "free_shipping_method",
3676
+ "description": "The method that is free for free shipping",
3677
+ "type": "STRING"
3678
+ },
3679
+ {
3680
+ "mode": "NULLABLE",
3681
+ "name": "ebay_template_oid",
3682
+ "description": "The template object identifier to use when rendering the e-Bay listing",
3683
+ "type": "INTEGER"
3684
+ },
3685
+ {
3686
+ "mode": "NULLABLE",
3687
+ "name": "ebay_template_name",
3688
+ "description": "The template name to use hwen rendering the e-Bay listing",
3689
+ "type": "STRING"
3690
+ },
3691
+ {
3692
+ "mode": "NULLABLE",
3693
+ "name": "listed_ebay_template_oid",
3694
+ "description": "The template object identifier used for the listing",
3695
+ "type": "INTEGER"
3696
+ },
3697
+ {
3698
+ "mode": "NULLABLE",
3699
+ "name": "no_promotional_shipping",
3700
+ "description": "True if the item should not qualify for promotional shipping",
3701
+ "type": "BOOLEAN"
3702
+ },
3703
+ {
3704
+ "mode": "NULLABLE",
3705
+ "name": "domestic_1_first_cost",
3706
+ "description": "Domestic 1 method first item cost",
3707
+ "type": "NUMERIC"
3708
+ },
3709
+ {
3710
+ "mode": "NULLABLE",
3711
+ "name": "domestic_1_additional_cost",
3712
+ "description": "Domestic 1 method additional item cost",
3713
+ "type": "NUMERIC"
3714
+ },
3715
+ {
3716
+ "mode": "NULLABLE",
3717
+ "name": "domestic_2_first_cost",
3718
+ "description": "Domestic 2 method first item cost",
3719
+ "type": "NUMERIC"
3720
+ },
3721
+ {
3722
+ "mode": "NULLABLE",
3723
+ "name": "domestic_2_additional_cost",
3724
+ "description": "Domestic 2 method additional item cost",
3725
+ "type": "NUMERIC"
3726
+ },
3727
+ {
3728
+ "mode": "NULLABLE",
3729
+ "name": "domestic_3_first_cost",
3730
+ "description": "Domestic 3 method first item cost",
3731
+ "type": "NUMERIC"
3732
+ },
3733
+ {
3734
+ "mode": "NULLABLE",
3735
+ "name": "domestic_3_additional_cost",
3736
+ "description": "Domestic 3 method additional item cost",
3737
+ "type": "NUMERIC"
3738
+ },
3739
+ {
3740
+ "mode": "NULLABLE",
3741
+ "name": "domestic_4_first_cost",
3742
+ "description": "Domestic 4 method first item cost",
3743
+ "type": "NUMERIC"
3744
+ },
3745
+ {
3746
+ "mode": "NULLABLE",
3747
+ "name": "domestic_4_additional_cost",
3748
+ "description": "Domestic 4 method additional item cost",
3749
+ "type": "NUMERIC"
3750
+ },
3751
+ {
3752
+ "mode": "NULLABLE",
3753
+ "name": "international_1_first_cost",
3754
+ "description": "International 1 method first item cost",
3755
+ "type": "NUMERIC"
3756
+ },
3757
+ {
3758
+ "mode": "NULLABLE",
3759
+ "name": "international_1_additional_cost",
3760
+ "description": "International 1 method additional item cost",
3761
+ "type": "NUMERIC"
3762
+ },
3763
+ {
3764
+ "mode": "NULLABLE",
3765
+ "name": "international_2_first_cost",
3766
+ "description": "International 2 method first item cost",
3767
+ "type": "NUMERIC"
3768
+ },
3769
+ {
3770
+ "mode": "NULLABLE",
3771
+ "name": "international_2_additional_cost",
3772
+ "description": "International 2 method additional item cost",
3773
+ "type": "NUMERIC"
3774
+ },
3775
+ {
3776
+ "mode": "NULLABLE",
3777
+ "name": "international_3_first_cost",
3778
+ "description": "International 3 method first item cost",
3779
+ "type": "NUMERIC"
3780
+ },
3781
+ {
3782
+ "mode": "NULLABLE",
3783
+ "name": "international_3_additional_cost",
3784
+ "description": "International 3 method additional item cost",
3785
+ "type": "NUMERIC"
3786
+ },
3787
+ {
3788
+ "mode": "NULLABLE",
3789
+ "name": "international_4_first_cost",
3790
+ "description": "International 4 method first item cost",
3791
+ "type": "NUMERIC"
3792
+ },
3793
+ {
3794
+ "mode": "NULLABLE",
3795
+ "name": "international_4_additional_cost",
3796
+ "description": "International 4 method additional item cost",
3797
+ "type": "NUMERIC"
3798
+ },
3799
+ {
3800
+ "mode": "NULLABLE",
3801
+ "name": "ebay_specific_inventory",
3802
+ "description": "e-Bay specific inventory",
3803
+ "type": "INTEGER"
3804
+ },
3805
+ {
3806
+ "mode": "NULLABLE",
3807
+ "name": "listing_price_override",
3808
+ "description": "The price to list the item at if different than the regular UltraCart item price",
3809
+ "type": "NUMERIC"
3810
+ },
3811
+ {
3812
+ "mode": "NULLABLE",
3813
+ "name": "send_dimensions_and_weight",
3814
+ "description": "How to send the item dimensions and weights to e-Bay",
3815
+ "type": "STRING"
3816
+ },
3817
+ {
3818
+ "mode": "NULLABLE",
3819
+ "name": "consecutive_failures",
3820
+ "description": "Number of consecutive failures trying to list this item",
3821
+ "type": "INTEGER"
3822
+ },
3823
+ {
3824
+ "mode": "NULLABLE",
3825
+ "name": "next_attempt_dts",
3826
+ "description": "Date/time for the next attempt to list",
3827
+ "type": "DATETIME"
3828
+ },
3829
+ {
3830
+ "mode": "NULLABLE",
3831
+ "name": "dispatch_time_max",
3832
+ "description": "Maximum number of days it will take to ship the item",
3833
+ "type": "INTEGER"
3834
+ },
3835
+ {
3836
+ "mode": "NULLABLE",
3837
+ "name": "target_dispatch_time_max",
3838
+ "description": "Typical number of days it will take to ship the item",
3839
+ "type": "INTEGER"
3840
+ },
3841
+ {
3842
+ "mode": "NULLABLE",
3843
+ "name": "listed_dispatch_time_max",
3844
+ "description": "Current listing dispatch time maximum",
3845
+ "type": "INTEGER"
3846
+ },
3847
+ {
3848
+ "mode": "NULLABLE",
3849
+ "name": "previous_ebay_auction_id",
3850
+ "description": "Previous e-Bay auction id",
3851
+ "type": "STRING"
3852
+ },
3853
+ {
3854
+ "mode": "NULLABLE",
3855
+ "name": "listing_duration",
3856
+ "description": "The duration of the listing",
3857
+ "type": "STRING"
3858
+ },
3859
+ {
3860
+ "mode": "NULLABLE",
3861
+ "name": "marketplace_analysis_perform",
3862
+ "description": "True if marketplace analysis should be performed",
3863
+ "type": "BOOLEAN"
3864
+ },
3865
+ {
3866
+ "mode": "NULLABLE",
3867
+ "name": "marketplace_overhead",
3868
+ "description": "Marketplace overhead",
3869
+ "type": "NUMERIC"
3870
+ },
3871
+ {
3872
+ "mode": "NULLABLE",
3873
+ "name": "marketplace_multiplier",
3874
+ "description": "Marketplace multiplier",
3875
+ "type": "NUMERIC"
3876
+ },
3877
+ {
3878
+ "mode": "NULLABLE",
3879
+ "name": "marketplace_last_check_dts",
3880
+ "description": "Date/time of the marketplace analysis last check",
3881
+ "type": "DATETIME"
3882
+ },
3883
+ {
3884
+ "mode": "NULLABLE",
3885
+ "name": "marketplace_our_price",
3886
+ "description": "Marketplace our price",
3887
+ "type": "NUMERIC"
3888
+ },
3889
+ {
3890
+ "mode": "NULLABLE",
3891
+ "name": "marketplace_our_shipping",
3892
+ "description": "Marketplace our shipping",
3893
+ "type": "NUMERIC"
3894
+ },
3895
+ {
3896
+ "mode": "NULLABLE",
3897
+ "name": "marketplace_our_total",
3898
+ "description": "Marketplace our total",
3899
+ "type": "NUMERIC"
3900
+ },
3901
+ {
3902
+ "mode": "NULLABLE",
3903
+ "name": "marketplace_profitable",
3904
+ "description": "True if our listing is profitable to sell",
3905
+ "type": "BOOLEAN"
3906
+ },
3907
+ {
3908
+ "mode": "NULLABLE",
3909
+ "name": "marketplace_other_price",
3910
+ "description": "Marketplace other price",
3911
+ "type": "NUMERIC"
3912
+ },
3913
+ {
3914
+ "mode": "NULLABLE",
3915
+ "name": "marketplace_other_shipping",
3916
+ "description": "Marketplace other shipping",
3917
+ "type": "NUMERIC"
3918
+ },
3919
+ {
3920
+ "mode": "NULLABLE",
3921
+ "name": "marketplace_other_total",
3922
+ "description": "Marketplace other total",
3923
+ "type": "NUMERIC"
3924
+ },
3925
+ {
3926
+ "mode": "NULLABLE",
3927
+ "name": "marketplace_other_seller",
3928
+ "description": "Marketplace other seller",
3929
+ "type": "STRING"
3930
+ },
3931
+ {
3932
+ "mode": "NULLABLE",
3933
+ "name": "marketplace_lowest",
3934
+ "description": "True if we are the lowest offer in the marketplace",
3935
+ "type": "BOOLEAN"
3936
+ },
3937
+ {
3938
+ "name": "marketplace_analysis",
3939
+ "description": "Details of the marketplace analysis",
3940
+ "type": "RECORD",
3941
+ "fields": [
3942
+ {
3943
+ "name": "our_listing",
3944
+ "description": "Our listing",
3945
+ "type": "RECORD",
3946
+ "fields": [
3947
+ {
3948
+ "mode": "NULLABLE",
3949
+ "name": "auction_id",
3950
+ "description": "Auction ID",
3951
+ "type": "STRING"
3952
+ },
3953
+ {
3954
+ "mode": "NULLABLE",
3955
+ "name": "seller",
3956
+ "description": "Seller",
3957
+ "type": "STRING"
3958
+ },
3959
+ {
3960
+ "mode": "NULLABLE",
3961
+ "name": "price",
3962
+ "description": "Price",
3963
+ "type": "NUMERIC"
3964
+ },
3965
+ {
3966
+ "mode": "NULLABLE",
3967
+ "name": "shipping",
3968
+ "description": "Shipping",
3969
+ "type": "NUMERIC"
3970
+ },
3971
+ {
3972
+ "mode": "NULLABLE",
3973
+ "name": "total",
3974
+ "description": "Total",
3975
+ "type": "NUMERIC"
3976
+ }
3977
+ ]
3978
+ },
3979
+ {
3980
+ "mode": "REPEATED",
3981
+ "name": "other_listings",
3982
+ "description": "Other listings",
3983
+ "type": "RECORD",
3984
+ "fields": [
3985
+ {
3986
+ "mode": "NULLABLE",
3987
+ "name": "auction_id",
3988
+ "description": "Auction ID",
3989
+ "type": "STRING"
3990
+ },
3991
+ {
3992
+ "mode": "NULLABLE",
3993
+ "name": "seller",
3994
+ "description": "Seller",
3995
+ "type": "STRING"
3996
+ },
3997
+ {
3998
+ "mode": "NULLABLE",
3999
+ "name": "price",
4000
+ "description": "Price",
4001
+ "type": "NUMERIC"
4002
+ },
4003
+ {
4004
+ "mode": "NULLABLE",
4005
+ "name": "shipping",
4006
+ "description": "Shipping",
4007
+ "type": "NUMERIC"
4008
+ },
4009
+ {
4010
+ "mode": "NULLABLE",
4011
+ "name": "total",
4012
+ "description": "Total",
4013
+ "type": "NUMERIC"
4014
+ }
4015
+ ]
4016
+ },
4017
+ {
4018
+ "mode": "NULLABLE",
4019
+ "name": "cogs",
4020
+ "description": "Cost of goods sold",
4021
+ "type": "NUMERIC"
4022
+ },
4023
+ {
4024
+ "mode": "NULLABLE",
4025
+ "name": "minimum_advertised_price",
4026
+ "description": "Minimum advertised price",
4027
+ "type": "NUMERIC"
4028
+ },
4029
+ {
4030
+ "mode": "NULLABLE",
4031
+ "name": "adjusted_price",
4032
+ "description": "Adjusted price",
4033
+ "type": "NUMERIC"
4034
+ },
4035
+ {
4036
+ "mode": "NULLABLE",
4037
+ "name": "adjusted_shipping",
4038
+ "description": "Adjusted shipping",
4039
+ "type": "NUMERIC"
4040
+ },
4041
+ {
4042
+ "mode": "NULLABLE",
4043
+ "name": "adjusted_total",
4044
+ "description": "Adjusted total",
4045
+ "type": "NUMERIC"
4046
+ },
4047
+ {
4048
+ "mode": "NULLABLE",
4049
+ "name": "profit_potential",
4050
+ "description": "Profit potential",
4051
+ "type": "NUMERIC"
4052
+ },
4053
+ {
4054
+ "mode": "NULLABLE",
4055
+ "name": "overhead",
4056
+ "description": "Overhead",
4057
+ "type": "NUMERIC"
4058
+ },
4059
+ {
4060
+ "mode": "NULLABLE",
4061
+ "name": "final_value_fee",
4062
+ "description": "Final value fee",
4063
+ "type": "NUMERIC"
4064
+ }
4065
+ ]
4066
+ },
4067
+ {
4068
+ "mode": "NULLABLE",
4069
+ "name": "marketplace_map_violation",
4070
+ "description": "True if another seller is violating MAP",
4071
+ "type": "BOOLEAN"
4072
+ },
4073
+ {
4074
+ "mode": "NULLABLE",
4075
+ "name": "marketplace_our_profit",
4076
+ "description": "Marketplace our profit",
4077
+ "type": "NUMERIC"
4078
+ },
4079
+ {
4080
+ "mode": "NULLABLE",
4081
+ "name": "next_listing_duration",
4082
+ "description": "The next listing duration to use when the current listing ends.",
4083
+ "type": "STRING"
4084
+ },
4085
+ {
4086
+ "mode": "NULLABLE",
4087
+ "name": "listing_type",
4088
+ "description": "The type of e-Bay listing",
4089
+ "type": "STRING"
4090
+ },
4091
+ {
4092
+ "mode": "NULLABLE",
4093
+ "name": "reserve_price",
4094
+ "description": "Reserve price",
4095
+ "type": "NUMERIC"
4096
+ },
4097
+ {
4098
+ "mode": "NULLABLE",
4099
+ "name": "condition_id",
4100
+ "description": "Numerical ID of the condition (e-Bay constant)",
4101
+ "type": "INTEGER"
4102
+ },
4103
+ {
4104
+ "mode": "NULLABLE",
4105
+ "name": "condition_description",
4106
+ "description": "Description of the condition (e-Bay constant)",
4107
+ "type": "STRING"
4108
+ },
4109
+ {
4110
+ "mode": "NULLABLE",
4111
+ "name": "marketplace_final_value_fee_percentage",
4112
+ "description": "Marketplace FVF percentage",
4113
+ "type": "NUMERIC"
4114
+ },
4115
+ {
4116
+ "mode": "NULLABLE",
4117
+ "name": "marketplace_our_additional_profit_potential",
4118
+ "description": "Marketplace our additional profit potential",
4119
+ "type": "NUMERIC"
4120
+ },
4121
+ {
4122
+ "mode": "REPEATED",
4123
+ "name": "category_specifics",
4124
+ "description": "Answers to category specific questions",
4125
+ "type": "RECORD",
4126
+ "fields": [
4127
+ {
4128
+ "mode": "NULLABLE",
4129
+ "name": "name",
4130
+ "description": "Name of the category specification field",
4131
+ "type": "STRING"
4132
+ },
4133
+ {
4134
+ "mode": "NULLABLE",
4135
+ "name": "value",
4136
+ "description": "Value",
4137
+ "type": "STRING"
4138
+ }
4139
+ ]
4140
+ }
4141
+ ]
4142
+ },
4143
+ {
4144
+ "mode": "REPEATED",
4145
+ "name": "third_party_email_marketing",
4146
+ "description": "3rd Party Email Marketing",
4147
+ "type": "RECORD",
4148
+ "fields": [
4149
+ {
4150
+ "allowed_values": [
4151
+ "ActiveCampaign",
4152
+ "AWeber",
4153
+ "Campaign Monitor",
4154
+ "ConstantContact",
4155
+ "Emma",
4156
+ "GetResponse",
4157
+ "iContact",
4158
+ "Klaviyo",
4159
+ "Lyris",
4160
+ "LyrisHQ",
4161
+ "MailChimp",
4162
+ "SilverPop"
4163
+ ],
4164
+ "mode": "NULLABLE",
4165
+ "name": "provider_name",
4166
+ "description": "Provider name",
4167
+ "type": "STRING"
4168
+ },
4169
+ {
4170
+ "mode": "REPEATED",
4171
+ "name": "subscribe_lists",
4172
+ "description": "Subscribe to lists",
4173
+ "type": "RECORD",
4174
+ "fields": [{
4175
+ "mode": "NULLABLE",
4176
+ "name": "value",
4177
+ "type": "STRING"
4178
+ }]
4179
+ },
4180
+ {
4181
+ "mode": "REPEATED",
4182
+ "name": "unsubscribe_lists",
4183
+ "description": "Unsubscribe from lists",
4184
+ "type": "RECORD",
4185
+ "fields": [{
4186
+ "mode": "NULLABLE",
4187
+ "name": "value",
4188
+ "type": "STRING"
4189
+ }]
4190
+ },
4191
+ {
4192
+ "mode": "REPEATED",
4193
+ "name": "add_tags",
4194
+ "description": "Add tags",
4195
+ "type": "RECORD",
4196
+ "fields": [{
4197
+ "mode": "NULLABLE",
4198
+ "name": "value",
4199
+ "type": "STRING"
4200
+ }]
4201
+ },
4202
+ {
4203
+ "mode": "REPEATED",
4204
+ "name": "remove_tags",
4205
+ "description": "Remove tags",
4206
+ "type": "RECORD",
4207
+ "fields": [{
4208
+ "mode": "NULLABLE",
4209
+ "name": "value",
4210
+ "type": "STRING"
4211
+ }]
4212
+ }
4213
+ ]
4214
+ },
4215
+ {
4216
+ "mode": "REPEATED",
4217
+ "name": "channel_partner_item_mappings",
4218
+ "description": "Channel Partner Item Mapping",
4219
+ "type": "RECORD",
4220
+ "fields": [
4221
+ {
4222
+ "mode": "NULLABLE",
4223
+ "name": "channel_partner_oid",
4224
+ "description": "Channel partner object identifier",
4225
+ "type": "INTEGER"
4226
+ },
4227
+ {
4228
+ "mode": "NULLABLE",
4229
+ "name": "channel_partner_code",
4230
+ "description": "Channel partner code",
4231
+ "type": "STRING"
4232
+ },
4233
+ {
4234
+ "mode": "NULLABLE",
4235
+ "name": "from_sku",
4236
+ "description": "From SKU",
4237
+ "type": "STRING"
4238
+ },
4239
+ {
4240
+ "mode": "NULLABLE",
4241
+ "name": "unit_of_measure",
4242
+ "description": "Unit of measure",
4243
+ "type": "STRING"
4244
+ },
4245
+ {
4246
+ "mode": "NULLABLE",
4247
+ "name": "quantity_ratio_cp",
4248
+ "description": "Ratio (Channel Partner)",
4249
+ "type": "INTEGER"
4250
+ },
4251
+ {
4252
+ "mode": "NULLABLE",
4253
+ "name": "quantity_ratio_uc",
4254
+ "description": "Ratio (UltraCart)",
4255
+ "type": "INTEGER"
4256
+ },
4257
+ {
4258
+ "mode": "NULLABLE",
4259
+ "name": "from_item_id",
4260
+ "description": "From Item ID",
4261
+ "type": "STRING"
4262
+ },
4263
+ {
4264
+ "mode": "NULLABLE",
4265
+ "name": "buyer_item_number",
4266
+ "description": "Buyer item number (EDI only)",
4267
+ "type": "STRING"
4268
+ },
4269
+ {
4270
+ "mode": "NULLABLE",
4271
+ "name": "buyer_catalog_number",
4272
+ "description": "Buyer catalog number (EDI only)",
4273
+ "type": "STRING"
4274
+ },
4275
+ {
4276
+ "mode": "NULLABLE",
4277
+ "name": "buyer_dpci",
4278
+ "description": "Buyer DPCI (EDI only)",
4279
+ "type": "STRING"
4280
+ },
4281
+ {
4282
+ "mode": "NULLABLE",
4283
+ "name": "vendor_number",
4284
+ "description": "Vendor number (EDI only)",
4285
+ "type": "STRING"
4286
+ },
4287
+ {
4288
+ "mode": "NULLABLE",
4289
+ "name": "mutually_defined_number",
4290
+ "description": "Mutually defined number (EDI only)",
4291
+ "type": "STRING"
4292
+ },
4293
+ {
4294
+ "mode": "NULLABLE",
4295
+ "name": "sku",
4296
+ "description": "SKU",
4297
+ "type": "STRING"
4298
+ },
4299
+ {
4300
+ "mode": "NULLABLE",
4301
+ "name": "vendor_style_number",
4302
+ "description": "Vendor style number (EDI only)",
4303
+ "type": "STRING"
4304
+ },
4305
+ {
4306
+ "mode": "NULLABLE",
4307
+ "name": "barcode_ua",
4308
+ "description": "Barcode UA (EDI only)",
4309
+ "type": "STRING"
4310
+ },
4311
+ {
4312
+ "mode": "NULLABLE",
4313
+ "name": "barcode_uc",
4314
+ "description": "Barcode UC (EDI only)",
4315
+ "type": "STRING"
4316
+ },
4317
+ {
4318
+ "mode": "NULLABLE",
4319
+ "name": "barcode_ui",
4320
+ "description": "Barcode UI (EDI only)",
4321
+ "type": "STRING"
4322
+ },
4323
+ {
4324
+ "mode": "NULLABLE",
4325
+ "name": "barcode_uk",
4326
+ "description": "Barcode UK (EDI only)",
4327
+ "type": "STRING"
4328
+ },
4329
+ {
4330
+ "mode": "NULLABLE",
4331
+ "name": "cost",
4332
+ "description": "Cost given to this channel partner",
4333
+ "type": "NUMERIC"
4334
+ }
4335
+ ]
4336
+ },
4337
+ {
4338
+ "name": "tags",
4339
+ "description": "Tags",
4340
+ "type": "RECORD",
4341
+ "fields": [{
4342
+ "mode": "REPEATED",
4343
+ "name": "tags",
4344
+ "description": "tags",
4345
+ "type": "RECORD",
4346
+ "fields": [
4347
+ {
4348
+ "allowed_values": [
4349
+ "item",
4350
+ "order",
4351
+ "customer"
4352
+ ],
4353
+ "mode": "NULLABLE",
4354
+ "name": "tagType",
4355
+ "description": "tag_type",
4356
+ "type": "STRING"
4357
+ },
4358
+ {
4359
+ "mode": "NULLABLE",
4360
+ "name": "tagValue",
4361
+ "description": "tag_value",
4362
+ "type": "STRING"
4363
+ }
4364
+ ]
4365
+ }]
4366
+ },
4367
+ {
4368
+ "mode": "REPEATED",
4369
+ "name": "properties",
4370
+ "description": "Properties",
4371
+ "type": "RECORD",
4372
+ "fields": [
4373
+ {
4374
+ "mode": "NULLABLE",
4375
+ "name": "name",
4376
+ "description": "Property name",
4377
+ "type": "STRING"
4378
+ },
4379
+ {
4380
+ "mode": "NULLABLE",
4381
+ "name": "value",
4382
+ "description": "Property value",
4383
+ "type": "STRING"
4384
+ },
4385
+ {
4386
+ "mode": "NULLABLE",
4387
+ "name": "expirationDts",
4388
+ "description": "Expiration of the property",
4389
+ "type": "DATETIME"
4390
+ }
4391
+ ]
4392
+ },
4393
+ {
4394
+ "mode": "NULLABLE",
4395
+ "name": "recommend_replenishment_days",
4396
+ "description": "Number of days to recommend replenishment after. Null is not configured. Set to zero to disable.",
4397
+ "type": "INTEGER"
4398
+ },
4399
+ {
4400
+ "mode": "REPEATED",
4401
+ "name": "fulfillment_addons",
4402
+ "description": "Fulfillment Add-ons",
4403
+ "type": "RECORD",
4404
+ "fields": [
4405
+ {
4406
+ "mode": "NULLABLE",
4407
+ "name": "add_item_id",
4408
+ "description": "Add Item Id",
4409
+ "type": "STRING"
4410
+ },
4411
+ {
4412
+ "mode": "NULLABLE",
4413
+ "name": "add_item_oid",
4414
+ "description": "Add Item object identifier",
4415
+ "type": "INTEGER"
4416
+ },
4417
+ {
4418
+ "mode": "NULLABLE",
4419
+ "name": "quantity",
4420
+ "description": "Quantity",
4421
+ "type": "INTEGER"
4422
+ },
4423
+ {
4424
+ "mode": "NULLABLE",
4425
+ "name": "once_per_order",
4426
+ "description": "Once Per Order",
4427
+ "type": "BOOLEAN"
4428
+ },
4429
+ {
4430
+ "mode": "NULLABLE",
4431
+ "name": "initial_order_only",
4432
+ "description": "Initial Order Only",
4433
+ "type": "BOOLEAN"
4434
+ }
4435
+ ]
4436
+ }
4437
+ ]