@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
package/schemas/tables/ultracart_dw_medium/uc_cart_abandons.json ADDED
@@ -0,0 +1,4245 @@
1
+ [
2
+ {
3
+ "mode": "NULLABLE",
4
+ "name": "partition_date",
5
+ "type": "DATE"
6
+ },
7
+ {
8
+ "mode": "NULLABLE",
9
+ "name": "cart_abandon_uuid",
10
+ "type": "STRING"
11
+ },
12
+ {
13
+ "mode": "NULLABLE",
14
+ "name": "cart_abandon_dts",
15
+ "type": "DATETIME"
16
+ },
17
+ {
18
+ "mode": "NULLABLE",
19
+ "name": "merchant_id",
20
+ "description": "Merchant ID this cart is associated with",
21
+ "type": "STRING"
22
+ },
23
+ {
24
+ "mode": "NULLABLE",
25
+ "name": "cart_id",
26
+ "description": "Unique identifier for this cart",
27
+ "type": "STRING"
28
+ },
29
+ {
30
+ "mode": "NULLABLE",
31
+ "name": "currency_code",
32
+ "description": "The ISO-4217 three letter currency code the customer is viewing prices in",
33
+ "type": "STRING"
34
+ },
35
+ {
36
+ "mode": "NULLABLE",
37
+ "name": "base_currency_code",
38
+ "description": "The ISO-4217 three letter base currency code of the account",
39
+ "type": "STRING"
40
+ },
41
+ {
42
+ "mode": "NULLABLE",
43
+ "name": "exchange_rate",
44
+ "description": "The exchange rate if the customer is viewing a different currency than the base",
45
+ "type": "NUMERIC"
46
+ },
47
+ {
48
+ "mode": "NULLABLE",
49
+ "name": "language_iso_code",
50
+ "description": "The ISO-631 three letter code the customer would like to checkout with",
51
+ "type": "STRING"
52
+ },
53
+ {
54
+ "name": "billing",
55
+ "description": "Billing",
56
+ "type": "RECORD",
57
+ "fields": [
58
+ {
59
+ "mode": "NULLABLE",
60
+ "name": "first_name",
61
+ "description": "First name",
62
+ "type": "STRING"
63
+ },
64
+ {
65
+ "mode": "NULLABLE",
66
+ "name": "last_name",
67
+ "description": "Last name",
68
+ "type": "STRING"
69
+ },
70
+ {
71
+ "mode": "NULLABLE",
72
+ "name": "title",
73
+ "description": "Title",
74
+ "type": "STRING"
75
+ },
76
+ {
77
+ "mode": "NULLABLE",
78
+ "name": "company",
79
+ "description": "Company",
80
+ "type": "STRING"
81
+ },
82
+ {
83
+ "mode": "NULLABLE",
84
+ "name": "address1",
85
+ "description": "Address line 1",
86
+ "type": "STRING"
87
+ },
88
+ {
89
+ "mode": "NULLABLE",
90
+ "name": "address2",
91
+ "description": "Address line 2",
92
+ "type": "STRING"
93
+ },
94
+ {
95
+ "mode": "NULLABLE",
96
+ "name": "city",
97
+ "description": "City",
98
+ "type": "STRING"
99
+ },
100
+ {
101
+ "mode": "NULLABLE",
102
+ "name": "state_region",
103
+ "description": "State for United States otherwise region or province for other countries",
104
+ "type": "STRING"
105
+ },
106
+ {
107
+ "mode": "NULLABLE",
108
+ "name": "postal_code",
109
+ "description": "Postal code",
110
+ "type": "STRING"
111
+ },
112
+ {
113
+ "mode": "NULLABLE",
114
+ "name": "country_code",
115
+ "description": "ISO-3166 two letter country code",
116
+ "type": "STRING"
117
+ },
118
+ {
119
+ "mode": "NULLABLE",
120
+ "name": "day_phone",
121
+ "description": "Day phone",
122
+ "type": "STRING"
123
+ },
124
+ {
125
+ "mode": "NULLABLE",
126
+ "name": "evening_phone",
127
+ "description": "Evening phone",
128
+ "type": "STRING"
129
+ },
130
+ {
131
+ "mode": "NULLABLE",
132
+ "name": "email",
133
+ "description": "Email",
134
+ "type": "STRING"
135
+ },
136
+ {
137
+ "mode": "NULLABLE",
138
+ "name": "email_confirm",
139
+ "description": "Email entered for confirmation",
140
+ "type": "STRING"
141
+ },
142
+ {
143
+ "mode": "REPEATED",
144
+ "name": "cc_emails",
145
+ "description": "CC emails. Multiple allowed, but total length of all emails can not exceed 100 characters.",
146
+ "type": "RECORD",
147
+ "fields": [{
148
+ "mode": "NULLABLE",
149
+ "name": "value",
150
+ "type": "STRING"
151
+ }]
152
+ },
153
+ {
154
+ "mode": "NULLABLE",
155
+ "name": "cell_phone",
156
+ "description": "Cell phone",
157
+ "type": "STRING"
158
+ },
159
+ {
160
+ "mode": "NULLABLE",
161
+ "name": "cell_phone_e164",
162
+ "description": "Cell phone (E164 format)",
163
+ "type": "STRING"
164
+ },
165
+ {
166
+ "mode": "NULLABLE",
167
+ "name": "company_hash",
168
+ "description": "Company Hash SHA-256 Base64",
169
+ "type": "STRING"
170
+ },
171
+ {
172
+ "mode": "NULLABLE",
173
+ "name": "title_hash",
174
+ "description": "Title Hash SHA-256 Base64",
175
+ "type": "STRING"
176
+ },
177
+ {
178
+ "mode": "NULLABLE",
179
+ "name": "first_name_hash",
180
+ "description": "First name Hash SHA-256 Base64",
181
+ "type": "STRING"
182
+ },
183
+ {
184
+ "mode": "NULLABLE",
185
+ "name": "last_name_hash",
186
+ "description": "Last name Hash SHA-256 Base64",
187
+ "type": "STRING"
188
+ },
189
+ {
190
+ "mode": "NULLABLE",
191
+ "name": "address1_hash",
192
+ "description": "Address line 1 Hash SHA-256 Base64",
193
+ "type": "STRING"
194
+ },
195
+ {
196
+ "mode": "NULLABLE",
197
+ "name": "address2_hash",
198
+ "description": "Address line 2 Hash SHA-256 Base64",
199
+ "type": "STRING"
200
+ },
201
+ {
202
+ "mode": "NULLABLE",
203
+ "name": "day_phone_hash",
204
+ "description": "Day time phone Hash SHA-256 Base64",
205
+ "type": "STRING"
206
+ },
207
+ {
208
+ "mode": "NULLABLE",
209
+ "name": "evening_phone_hash",
210
+ "description": "Evening phone Hash SHA-256 Base64",
211
+ "type": "STRING"
212
+ },
213
+ {
214
+ "mode": "NULLABLE",
215
+ "name": "cell_phone_hash",
216
+ "description": "Cell phone Hash SHA-256 Base64",
217
+ "type": "STRING"
218
+ },
219
+ {
220
+ "mode": "NULLABLE",
221
+ "name": "cell_phone_e164_hash",
222
+ "description": "Cell phone (E164 format) Hash SHA-256 Base64",
223
+ "type": "STRING"
224
+ },
225
+ {
226
+ "mode": "NULLABLE",
227
+ "name": "email_hash",
228
+ "description": "Email Hash SHA-256 Base64",
229
+ "type": "STRING"
230
+ },
231
+ {
232
+ "mode": "REPEATED",
233
+ "name": "cc_emails_hashes",
234
+ "description": "CC emails Hash SHA-256 Base64",
235
+ "type": "RECORD",
236
+ "fields": [{
237
+ "mode": "NULLABLE",
238
+ "name": "value",
239
+ "type": "STRING"
240
+ }]
241
+ }
242
+ ]
243
+ },
244
+ {
245
+ "name": "shipping",
246
+ "description": "Shipping",
247
+ "type": "RECORD",
248
+ "fields": [
249
+ {
250
+ "mode": "NULLABLE",
251
+ "name": "first_name",
252
+ "description": "First name",
253
+ "type": "STRING"
254
+ },
255
+ {
256
+ "mode": "NULLABLE",
257
+ "name": "last_name",
258
+ "description": "Last name",
259
+ "type": "STRING"
260
+ },
261
+ {
262
+ "mode": "NULLABLE",
263
+ "name": "title",
264
+ "description": "Title",
265
+ "type": "STRING"
266
+ },
267
+ {
268
+ "mode": "NULLABLE",
269
+ "name": "company",
270
+ "description": "Company",
271
+ "type": "STRING"
272
+ },
273
+ {
274
+ "mode": "NULLABLE",
275
+ "name": "address1",
276
+ "description": "Address line 1",
277
+ "type": "STRING"
278
+ },
279
+ {
280
+ "mode": "NULLABLE",
281
+ "name": "address2",
282
+ "description": "Address line 2",
283
+ "type": "STRING"
284
+ },
285
+ {
286
+ "mode": "NULLABLE",
287
+ "name": "city",
288
+ "description": "City",
289
+ "type": "STRING"
290
+ },
291
+ {
292
+ "mode": "NULLABLE",
293
+ "name": "state_region",
294
+ "description": "State/Region",
295
+ "type": "STRING"
296
+ },
297
+ {
298
+ "mode": "NULLABLE",
299
+ "name": "postal_code",
300
+ "description": "Postal code",
301
+ "type": "STRING"
302
+ },
303
+ {
304
+ "mode": "NULLABLE",
305
+ "name": "country_code",
306
+ "description": "ISO-3166 two letter country code",
307
+ "type": "STRING"
308
+ },
309
+ {
310
+ "mode": "NULLABLE",
311
+ "name": "day_phone",
312
+ "description": "Day time phone",
313
+ "type": "STRING"
314
+ },
315
+ {
316
+ "mode": "NULLABLE",
317
+ "name": "evening_phone",
318
+ "description": "Evening phone",
319
+ "type": "STRING"
320
+ },
321
+ {
322
+ "mode": "NULLABLE",
323
+ "name": "shipping_method",
324
+ "description": "Shipping method",
325
+ "type": "STRING"
326
+ },
327
+ {
328
+ "mode": "NULLABLE",
329
+ "name": "delivery_date",
330
+ "description": "Date the customer is requesting delivery on. Typically used for perishable product delivery.",
331
+ "type": "DATETIME"
332
+ },
333
+ {
334
+ "mode": "NULLABLE",
335
+ "name": "ship_on_date",
336
+ "description": "Date the customer is requesting that the order ship on. Typically used for perishable product delivery.",
337
+ "type": "DATETIME"
338
+ },
339
+ {
340
+ "mode": "NULLABLE",
341
+ "name": "ship_to_residential",
342
+ "description": "True if the shipping adress is residential. Effects the methods that are available to the customer as well as the price of the shipping method.",
343
+ "type": "BOOLEAN"
344
+ },
345
+ {
346
+ "mode": "NULLABLE",
347
+ "name": "special_instructions",
348
+ "description": "Special instructions from the customer regarding shipping",
349
+ "type": "STRING"
350
+ },
351
+ {
352
+ "mode": "NULLABLE",
353
+ "name": "lift_gate",
354
+ "description": "Lift gate requested (LTL shipping methods only)",
355
+ "type": "BOOLEAN"
356
+ },
357
+ {
358
+ "mode": "NULLABLE",
359
+ "name": "shipping_3rd_party_account_number",
360
+ "description": "3rd party account number to ship against for UPS or FedEx",
361
+ "type": "STRING"
362
+ },
363
+ {
364
+ "mode": "NULLABLE",
365
+ "name": "company_hash",
366
+ "description": "Company Hash SHA-256 Base64",
367
+ "type": "STRING"
368
+ },
369
+ {
370
+ "mode": "NULLABLE",
371
+ "name": "title_hash",
372
+ "description": "Title Hash SHA-256 Base64",
373
+ "type": "STRING"
374
+ },
375
+ {
376
+ "mode": "NULLABLE",
377
+ "name": "first_name_hash",
378
+ "description": "First name Hash SHA-256 Base64",
379
+ "type": "STRING"
380
+ },
381
+ {
382
+ "mode": "NULLABLE",
383
+ "name": "last_name_hash",
384
+ "description": "Last name Hash SHA-256 Base64",
385
+ "type": "STRING"
386
+ },
387
+ {
388
+ "mode": "NULLABLE",
389
+ "name": "address1_hash",
390
+ "description": "Address line 1 Hash SHA-256 Base64",
391
+ "type": "STRING"
392
+ },
393
+ {
394
+ "mode": "NULLABLE",
395
+ "name": "address2_hash",
396
+ "description": "Address line 2 Hash SHA-256 Base64",
397
+ "type": "STRING"
398
+ },
399
+ {
400
+ "mode": "NULLABLE",
401
+ "name": "day_phone_hash",
402
+ "description": "Day time phone Hash SHA-256 Base64",
403
+ "type": "STRING"
404
+ },
405
+ {
406
+ "mode": "NULLABLE",
407
+ "name": "evening_phone_hash",
408
+ "description": "Evening phone Hash SHA-256 Base64",
409
+ "type": "STRING"
410
+ }
411
+ ]
412
+ },
413
+ {
414
+ "name": "checkout",
415
+ "description": "Checkout",
416
+ "type": "RECORD",
417
+ "fields": [
418
+ {
419
+ "mode": "NULLABLE",
420
+ "name": "comments",
421
+ "description": "Comments from the customer. Rarely used on the single page checkout.",
422
+ "type": "STRING"
423
+ },
424
+ {
425
+ "mode": "NULLABLE",
426
+ "name": "custom_field1",
427
+ "description": "Custom field 1",
428
+ "type": "STRING"
429
+ },
430
+ {
431
+ "mode": "NULLABLE",
432
+ "name": "custom_field2",
433
+ "description": "Custom field 2",
434
+ "type": "STRING"
435
+ },
436
+ {
437
+ "mode": "NULLABLE",
438
+ "name": "custom_field3",
439
+ "description": "Custom field 3",
440
+ "type": "STRING"
441
+ },
442
+ {
443
+ "mode": "NULLABLE",
444
+ "name": "custom_field4",
445
+ "description": "Custom field 4",
446
+ "type": "STRING"
447
+ },
448
+ {
449
+ "mode": "NULLABLE",
450
+ "name": "custom_field5",
451
+ "description": "Custom field 5",
452
+ "type": "STRING"
453
+ },
454
+ {
455
+ "mode": "NULLABLE",
456
+ "name": "custom_field6",
457
+ "description": "Custom field 6",
458
+ "type": "STRING"
459
+ },
460
+ {
461
+ "mode": "NULLABLE",
462
+ "name": "custom_field7",
463
+ "description": "Custom field 7",
464
+ "type": "STRING"
465
+ },
466
+ {
467
+ "mode": "NULLABLE",
468
+ "name": "custom_field8",
469
+ "description": "Custom field 8",
470
+ "type": "STRING"
471
+ },
472
+ {
473
+ "mode": "NULLABLE",
474
+ "name": "custom_field9",
475
+ "description": "Custom field 9",
476
+ "type": "STRING"
477
+ },
478
+ {
479
+ "mode": "NULLABLE",
480
+ "name": "custom_field10",
481
+ "description": "Custom field 10",
482
+ "type": "STRING"
483
+ },
484
+ {
485
+ "mode": "NULLABLE",
486
+ "name": "ip_address",
487
+ "description": "IP Address (read only unless non-browser key authenticated)",
488
+ "type": "STRING"
489
+ },
490
+ {
491
+ "mode": "NULLABLE",
492
+ "name": "screen_branding_theme_code",
493
+ "description": "Screen branding theme code",
494
+ "type": "STRING"
495
+ },
496
+ {
497
+ "mode": "NULLABLE",
498
+ "name": "storefront_host_name",
499
+ "description": "StoreFront Host Name",
500
+ "type": "STRING"
501
+ },
502
+ {
503
+ "mode": "NULLABLE",
504
+ "name": "return_code",
505
+ "description": "Return code assigned for send return email operation",
506
+ "type": "STRING"
507
+ },
508
+ {
509
+ "mode": "NULLABLE",
510
+ "name": "user_agent",
511
+ "description": "User agent of the browser",
512
+ "type": "STRING"
513
+ },
514
+ {
515
+ "mode": "NULLABLE",
516
+ "name": "return_url",
517
+ "description": "The URL to redirect the customer to when they return from an abandon cart email. Must be https protocol.",
518
+ "type": "STRING"
519
+ },
520
+ {
521
+ "mode": "NULLABLE",
522
+ "name": "abandon_return_url",
523
+ "description": "This is the URL you can use in a custom abandon marketing to return the customer to their cart",
524
+ "type": "STRING"
525
+ },
526
+ {
527
+ "mode": "NULLABLE",
528
+ "name": "current_step",
529
+ "description": "Current step of the checkout (read only)",
530
+ "type": "STRING"
531
+ }
532
+ ]
533
+ },
534
+ {
535
+ "name": "upsell_after",
536
+ "description": "Upsell After",
537
+ "type": "RECORD",
538
+ "fields": [
539
+ {
540
+ "mode": "NULLABLE",
541
+ "name": "upsell_path_code",
542
+ "description": "Upsell path code (this is for legacy upsells only)",
543
+ "type": "STRING"
544
+ },
545
+ {
546
+ "mode": "NULLABLE",
547
+ "name": "finalize_after_dts",
548
+ "description": "The date/time after which the cart will finalize into an order.",
549
+ "type": "DATETIME"
550
+ },
551
+ {
552
+ "mode": "NULLABLE",
553
+ "name": "finalize_after_minutes",
554
+ "description": "The amount of inactivity in minutes after which the cart should be finalized into an order. This will calculate the finalize_after_dts field.",
555
+ "type": "INTEGER"
556
+ }
557
+ ]
558
+ },
559
+ {
560
+ "name": "gift",
561
+ "description": "Gift",
562
+ "type": "RECORD",
563
+ "fields": [
564
+ {
565
+ "name": "gift_charge",
566
+ "description": "Additional charge for making this order a gift",
567
+ "type": "RECORD",
568
+ "fields": [
569
+ {
570
+ "mode": "NULLABLE",
571
+ "name": "value",
572
+ "description": "Value in base currency",
573
+ "type": "NUMERIC"
574
+ },
575
+ {
576
+ "mode": "NULLABLE",
577
+ "name": "localized",
578
+ "description": "Value localized to the customer",
579
+ "type": "NUMERIC"
580
+ },
581
+ {
582
+ "mode": "NULLABLE",
583
+ "name": "localized_formatted",
584
+ "description": "Value localized and formatted for the customer",
585
+ "type": "STRING"
586
+ },
587
+ {
588
+ "mode": "NULLABLE",
589
+ "name": "exchange_rate",
590
+ "description": "Exchange rate used to localize",
591
+ "type": "NUMERIC"
592
+ },
593
+ {
594
+ "mode": "NULLABLE",
595
+ "name": "currency_code",
596
+ "description": "Currency code of the localized value",
597
+ "type": "STRING"
598
+ }
599
+ ]
600
+ },
601
+ {
602
+ "name": "gift_wrap_cost",
603
+ "description": "Cost of the gift wrap selected",
604
+ "type": "RECORD",
605
+ "fields": [
606
+ {
607
+ "mode": "NULLABLE",
608
+ "name": "value",
609
+ "description": "Value in base currency",
610
+ "type": "NUMERIC"
611
+ },
612
+ {
613
+ "mode": "NULLABLE",
614
+ "name": "localized",
615
+ "description": "Value localized to the customer",
616
+ "type": "NUMERIC"
617
+ },
618
+ {
619
+ "mode": "NULLABLE",
620
+ "name": "localized_formatted",
621
+ "description": "Value localized and formatted for the customer",
622
+ "type": "STRING"
623
+ },
624
+ {
625
+ "mode": "NULLABLE",
626
+ "name": "exchange_rate",
627
+ "description": "Exchange rate used to localize",
628
+ "type": "NUMERIC"
629
+ },
630
+ {
631
+ "mode": "NULLABLE",
632
+ "name": "currency_code",
633
+ "description": "Currency code of the localized value",
634
+ "type": "STRING"
635
+ }
636
+ ]
637
+ },
638
+ {
639
+ "mode": "NULLABLE",
640
+ "name": "gift",
641
+ "description": "True if this order is a gift",
642
+ "type": "BOOLEAN"
643
+ },
644
+ {
645
+ "mode": "NULLABLE",
646
+ "name": "gift_email",
647
+ "description": "Email address of the gift recipient",
648
+ "type": "STRING"
649
+ },
650
+ {
651
+ "mode": "NULLABLE",
652
+ "name": "gift_message",
653
+ "description": "Message to the gift recipient",
654
+ "type": "STRING"
655
+ },
656
+ {
657
+ "mode": "NULLABLE",
658
+ "name": "gift_wrap_title",
659
+ "description": "Title of the selected gift wrap",
660
+ "type": "STRING"
661
+ },
662
+ {
663
+ "mode": "NULLABLE",
664
+ "name": "gift_email_hash",
665
+ "description": "Gift Email Hash SHA-256 Base64",
666
+ "type": "STRING"
667
+ }
668
+ ]
669
+ },
670
+ {
671
+ "name": "gift_certificate",
672
+ "description": "Gift certificate",
673
+ "type": "RECORD",
674
+ "fields": [
675
+ {
676
+ "mode": "NULLABLE",
677
+ "name": "gift_certificate_code",
678
+ "description": "Gift certificate code",
679
+ "type": "STRING"
680
+ },
681
+ {
682
+ "name": "gift_certificate_amount",
683
+ "description": "The amount used on the gift certificate",
684
+ "type": "RECORD",
685
+ "fields": [
686
+ {
687
+ "mode": "NULLABLE",
688
+ "name": "value",
689
+ "description": "Value in base currency",
690
+ "type": "NUMERIC"
691
+ },
692
+ {
693
+ "mode": "NULLABLE",
694
+ "name": "localized",
695
+ "description": "Value localized to the customer",
696
+ "type": "NUMERIC"
697
+ },
698
+ {
699
+ "mode": "NULLABLE",
700
+ "name": "localized_formatted",
701
+ "description": "Value localized and formatted for the customer",
702
+ "type": "STRING"
703
+ },
704
+ {
705
+ "mode": "NULLABLE",
706
+ "name": "exchange_rate",
707
+ "description": "Exchange rate used to localize",
708
+ "type": "NUMERIC"
709
+ },
710
+ {
711
+ "mode": "NULLABLE",
712
+ "name": "currency_code",
713
+ "description": "Currency code of the localized value",
714
+ "type": "STRING"
715
+ }
716
+ ]
717
+ },
718
+ {
719
+ "name": "gift_certificate_remaining_balance_after_order",
720
+ "description": "The amount of money left on the gift certificate after this order is completed",
721
+ "type": "RECORD",
722
+ "fields": [
723
+ {
724
+ "mode": "NULLABLE",
725
+ "name": "value",
726
+ "description": "Value in base currency",
727
+ "type": "NUMERIC"
728
+ },
729
+ {
730
+ "mode": "NULLABLE",
731
+ "name": "localized",
732
+ "description": "Value localized to the customer",
733
+ "type": "NUMERIC"
734
+ },
735
+ {
736
+ "mode": "NULLABLE",
737
+ "name": "localized_formatted",
738
+ "description": "Value localized and formatted for the customer",
739
+ "type": "STRING"
740
+ },
741
+ {
742
+ "mode": "NULLABLE",
743
+ "name": "exchange_rate",
744
+ "description": "Exchange rate used to localize",
745
+ "type": "NUMERIC"
746
+ },
747
+ {
748
+ "mode": "NULLABLE",
749
+ "name": "currency_code",
750
+ "description": "Currency code of the localized value",
751
+ "type": "STRING"
752
+ }
753
+ ]
754
+ }
755
+ ]
756
+ },
757
+ {
758
+ "name": "marketing",
759
+ "description": "Marketing",
760
+ "type": "RECORD",
761
+ "fields": [
762
+ {
763
+ "mode": "NULLABLE",
764
+ "name": "mailing_list_opt_in",
765
+ "description": "True if the customer agrees to receiving marketing emails",
766
+ "type": "BOOLEAN"
767
+ },
768
+ {
769
+ "mode": "NULLABLE",
770
+ "name": "advertising_source",
771
+ "description": "The advertising source the customer indicated",
772
+ "type": "STRING"
773
+ },
774
+ {
775
+ "mode": "NULLABLE",
776
+ "name": "cell_phone_opt_in",
777
+ "description": "True if the customer agrees to receiving marketing SMS messages",
778
+ "type": "BOOLEAN"
779
+ }
780
+ ]
781
+ },
782
+ {
783
+ "name": "payment",
784
+ "description": "Payment",
785
+ "type": "RECORD",
786
+ "fields": [
787
+ {
788
+ "mode": "NULLABLE",
789
+ "name": "payment_method",
790
+ "description": "Payment method",
791
+ "type": "STRING"
792
+ },
793
+ {
794
+ "name": "check",
795
+ "description": "Check",
796
+ "type": "RECORD",
797
+ "fields": [{
798
+ "mode": "NULLABLE",
799
+ "name": "check_number",
800
+ "description": "Check number they are paying with",
801
+ "type": "INTEGER"
802
+ }]
803
+ },
804
+ {
805
+ "name": "credit_card",
806
+ "description": "Credit card",
807
+ "type": "RECORD",
808
+ "fields": [
809
+ {
810
+ "mode": "NULLABLE",
811
+ "name": "card_type",
812
+ "description": "Card type",
813
+ "type": "STRING"
814
+ },
815
+ {
816
+ "mode": "NULLABLE",
817
+ "name": "card_expiration_month",
818
+ "description": "Card expiration month (1-12)",
819
+ "type": "INTEGER"
820
+ },
821
+ {
822
+ "mode": "NULLABLE",
823
+ "name": "card_expiration_year",
824
+ "description": "Card expiration year (four digit year)",
825
+ "type": "INTEGER"
826
+ },
827
+ {
828
+ "mode": "NULLABLE",
829
+ "name": "customer_profile_credit_card_id",
830
+ "description": "ID of the stored credit card to use",
831
+ "type": "INTEGER"
832
+ },
833
+ {
834
+ "mode": "NULLABLE",
835
+ "name": "store_credit_card",
836
+ "description": "True if the customer wants to store the card on their profile for future re-use",
837
+ "type": "BOOLEAN"
838
+ }
839
+ ]
840
+ },
841
+ {
842
+ "mode": "NULLABLE",
843
+ "name": "rtg_code",
844
+ "description": "Rotating transaction gateway code",
845
+ "type": "STRING"
846
+ },
847
+ {
848
+ "name": "purchase_order",
849
+ "description": "Purchase order",
850
+ "type": "RECORD",
851
+ "fields": [{
852
+ "mode": "NULLABLE",
853
+ "name": "purchase_order_number",
854
+ "description": "Purchase order number",
855
+ "type": "STRING"
856
+ }]
857
+ },
858
+ {
859
+ "name": "amazon",
860
+ "description": "Amazon",
861
+ "type": "RECORD",
862
+ "fields": [{
863
+ "mode": "NULLABLE",
864
+ "name": "amazon_order_reference_id",
865
+ "description": "Amazon order reference id",
866
+ "type": "STRING"
867
+ }]
868
+ },
869
+ {
870
+ "name": "affirm",
871
+ "description": "Affirm",
872
+ "type": "RECORD",
873
+ "fields": [{
874
+ "mode": "NULLABLE",
875
+ "name": "affirm_checkout_token",
876
+ "description": "Affirm checkout token",
877
+ "type": "STRING"
878
+ }]
879
+ },
880
+ {
881
+ "name": "health_benefit_card",
882
+ "description": "Health benefit card",
883
+ "type": "RECORD",
884
+ "fields": [
885
+ {
886
+ "mode": "NULLABLE",
887
+ "name": "health_benefit_card_expiration_month",
888
+ "description": "Health benefit expiration month (1-12)",
889
+ "type": "INTEGER"
890
+ },
891
+ {
892
+ "mode": "NULLABLE",
893
+ "name": "health_benefit_card_expiration_year",
894
+ "description": "Health benefit card expiration year (four digit year)",
895
+ "type": "INTEGER"
896
+ }
897
+ ]
898
+ }
899
+ ]
900
+ },
901
+ {
902
+ "name": "summary",
903
+ "description": "Summary",
904
+ "type": "RECORD",
905
+ "fields": [
906
+ {
907
+ "name": "subtotal",
908
+ "description": "Subtotal",
909
+ "type": "RECORD",
910
+ "fields": [
911
+ {
912
+ "mode": "NULLABLE",
913
+ "name": "value",
914
+ "description": "Value in base currency",
915
+ "type": "NUMERIC"
916
+ },
917
+ {
918
+ "mode": "NULLABLE",
919
+ "name": "localized",
920
+ "description": "Value localized to the customer",
921
+ "type": "NUMERIC"
922
+ },
923
+ {
924
+ "mode": "NULLABLE",
925
+ "name": "localized_formatted",
926
+ "description": "Value localized and formatted for the customer",
927
+ "type": "STRING"
928
+ },
929
+ {
930
+ "mode": "NULLABLE",
931
+ "name": "exchange_rate",
932
+ "description": "Exchange rate used to localize",
933
+ "type": "NUMERIC"
934
+ },
935
+ {
936
+ "mode": "NULLABLE",
937
+ "name": "currency_code",
938
+ "description": "Currency code of the localized value",
939
+ "type": "STRING"
940
+ }
941
+ ]
942
+ },
943
+ {
944
+ "name": "subtotal_discount",
945
+ "description": "Subtotal discount",
946
+ "type": "RECORD",
947
+ "fields": [
948
+ {
949
+ "mode": "NULLABLE",
950
+ "name": "value",
951
+ "description": "Value in base currency",
952
+ "type": "NUMERIC"
953
+ },
954
+ {
955
+ "mode": "NULLABLE",
956
+ "name": "localized",
957
+ "description": "Value localized to the customer",
958
+ "type": "NUMERIC"
959
+ },
960
+ {
961
+ "mode": "NULLABLE",
962
+ "name": "localized_formatted",
963
+ "description": "Value localized and formatted for the customer",
964
+ "type": "STRING"
965
+ },
966
+ {
967
+ "mode": "NULLABLE",
968
+ "name": "exchange_rate",
969
+ "description": "Exchange rate used to localize",
970
+ "type": "NUMERIC"
971
+ },
972
+ {
973
+ "mode": "NULLABLE",
974
+ "name": "currency_code",
975
+ "description": "Currency code of the localized value",
976
+ "type": "STRING"
977
+ }
978
+ ]
979
+ },
980
+ {
981
+ "name": "subtotal_with_discount",
982
+ "description": "Subtotal with discount",
983
+ "type": "RECORD",
984
+ "fields": [
985
+ {
986
+ "mode": "NULLABLE",
987
+ "name": "value",
988
+ "description": "Value in base currency",
989
+ "type": "NUMERIC"
990
+ },
991
+ {
992
+ "mode": "NULLABLE",
993
+ "name": "localized",
994
+ "description": "Value localized to the customer",
995
+ "type": "NUMERIC"
996
+ },
997
+ {
998
+ "mode": "NULLABLE",
999
+ "name": "localized_formatted",
1000
+ "description": "Value localized and formatted for the customer",
1001
+ "type": "STRING"
1002
+ },
1003
+ {
1004
+ "mode": "NULLABLE",
1005
+ "name": "exchange_rate",
1006
+ "description": "Exchange rate used to localize",
1007
+ "type": "NUMERIC"
1008
+ },
1009
+ {
1010
+ "mode": "NULLABLE",
1011
+ "name": "currency_code",
1012
+ "description": "Currency code of the localized value",
1013
+ "type": "STRING"
1014
+ }
1015
+ ]
1016
+ },
1017
+ {
1018
+ "name": "tax",
1019
+ "description": "Tax",
1020
+ "type": "RECORD",
1021
+ "fields": [
1022
+ {
1023
+ "mode": "NULLABLE",
1024
+ "name": "value",
1025
+ "description": "Value in base currency",
1026
+ "type": "NUMERIC"
1027
+ },
1028
+ {
1029
+ "mode": "NULLABLE",
1030
+ "name": "localized",
1031
+ "description": "Value localized to the customer",
1032
+ "type": "NUMERIC"
1033
+ },
1034
+ {
1035
+ "mode": "NULLABLE",
1036
+ "name": "localized_formatted",
1037
+ "description": "Value localized and formatted for the customer",
1038
+ "type": "STRING"
1039
+ },
1040
+ {
1041
+ "mode": "NULLABLE",
1042
+ "name": "exchange_rate",
1043
+ "description": "Exchange rate used to localize",
1044
+ "type": "NUMERIC"
1045
+ },
1046
+ {
1047
+ "mode": "NULLABLE",
1048
+ "name": "currency_code",
1049
+ "description": "Currency code of the localized value",
1050
+ "type": "STRING"
1051
+ }
1052
+ ]
1053
+ },
1054
+ {
1055
+ "name": "taxable_subtotal",
1056
+ "description": "Taxable subtotal",
1057
+ "type": "RECORD",
1058
+ "fields": [
1059
+ {
1060
+ "mode": "NULLABLE",
1061
+ "name": "value",
1062
+ "description": "Value in base currency",
1063
+ "type": "NUMERIC"
1064
+ },
1065
+ {
1066
+ "mode": "NULLABLE",
1067
+ "name": "localized",
1068
+ "description": "Value localized to the customer",
1069
+ "type": "NUMERIC"
1070
+ },
1071
+ {
1072
+ "mode": "NULLABLE",
1073
+ "name": "localized_formatted",
1074
+ "description": "Value localized and formatted for the customer",
1075
+ "type": "STRING"
1076
+ },
1077
+ {
1078
+ "mode": "NULLABLE",
1079
+ "name": "exchange_rate",
1080
+ "description": "Exchange rate used to localize",
1081
+ "type": "NUMERIC"
1082
+ },
1083
+ {
1084
+ "mode": "NULLABLE",
1085
+ "name": "currency_code",
1086
+ "description": "Currency code of the localized value",
1087
+ "type": "STRING"
1088
+ }
1089
+ ]
1090
+ },
1091
+ {
1092
+ "name": "taxable_subtotal_discount",
1093
+ "description": "Taxable subttotal discount",
1094
+ "type": "RECORD",
1095
+ "fields": [
1096
+ {
1097
+ "mode": "NULLABLE",
1098
+ "name": "value",
1099
+ "description": "Value in base currency",
1100
+ "type": "NUMERIC"
1101
+ },
1102
+ {
1103
+ "mode": "NULLABLE",
1104
+ "name": "localized",
1105
+ "description": "Value localized to the customer",
1106
+ "type": "NUMERIC"
1107
+ },
1108
+ {
1109
+ "mode": "NULLABLE",
1110
+ "name": "localized_formatted",
1111
+ "description": "Value localized and formatted for the customer",
1112
+ "type": "STRING"
1113
+ },
1114
+ {
1115
+ "mode": "NULLABLE",
1116
+ "name": "exchange_rate",
1117
+ "description": "Exchange rate used to localize",
1118
+ "type": "NUMERIC"
1119
+ },
1120
+ {
1121
+ "mode": "NULLABLE",
1122
+ "name": "currency_code",
1123
+ "description": "Currency code of the localized value",
1124
+ "type": "STRING"
1125
+ }
1126
+ ]
1127
+ },
1128
+ {
1129
+ "name": "taxable_subtotal_with_discount",
1130
+ "description": "Taxable subtotal with discount",
1131
+ "type": "RECORD",
1132
+ "fields": [
1133
+ {
1134
+ "mode": "NULLABLE",
1135
+ "name": "value",
1136
+ "description": "Value in base currency",
1137
+ "type": "NUMERIC"
1138
+ },
1139
+ {
1140
+ "mode": "NULLABLE",
1141
+ "name": "localized",
1142
+ "description": "Value localized to the customer",
1143
+ "type": "NUMERIC"
1144
+ },
1145
+ {
1146
+ "mode": "NULLABLE",
1147
+ "name": "localized_formatted",
1148
+ "description": "Value localized and formatted for the customer",
1149
+ "type": "STRING"
1150
+ },
1151
+ {
1152
+ "mode": "NULLABLE",
1153
+ "name": "exchange_rate",
1154
+ "description": "Exchange rate used to localize",
1155
+ "type": "NUMERIC"
1156
+ },
1157
+ {
1158
+ "mode": "NULLABLE",
1159
+ "name": "currency_code",
1160
+ "description": "Currency code of the localized value",
1161
+ "type": "STRING"
1162
+ }
1163
+ ]
1164
+ },
1165
+ {
1166
+ "name": "shipping_handling",
1167
+ "description": "Shipping/handling",
1168
+ "type": "RECORD",
1169
+ "fields": [
1170
+ {
1171
+ "mode": "NULLABLE",
1172
+ "name": "value",
1173
+ "description": "Value in base currency",
1174
+ "type": "NUMERIC"
1175
+ },
1176
+ {
1177
+ "mode": "NULLABLE",
1178
+ "name": "localized",
1179
+ "description": "Value localized to the customer",
1180
+ "type": "NUMERIC"
1181
+ },
1182
+ {
1183
+ "mode": "NULLABLE",
1184
+ "name": "localized_formatted",
1185
+ "description": "Value localized and formatted for the customer",
1186
+ "type": "STRING"
1187
+ },
1188
+ {
1189
+ "mode": "NULLABLE",
1190
+ "name": "exchange_rate",
1191
+ "description": "Exchange rate used to localize",
1192
+ "type": "NUMERIC"
1193
+ },
1194
+ {
1195
+ "mode": "NULLABLE",
1196
+ "name": "currency_code",
1197
+ "description": "Currency code of the localized value",
1198
+ "type": "STRING"
1199
+ }
1200
+ ]
1201
+ },
1202
+ {
1203
+ "name": "shipping_handling_discount",
1204
+ "description": "Shipping/handling discount",
1205
+ "type": "RECORD",
1206
+ "fields": [
1207
+ {
1208
+ "mode": "NULLABLE",
1209
+ "name": "value",
1210
+ "description": "Value in base currency",
1211
+ "type": "NUMERIC"
1212
+ },
1213
+ {
1214
+ "mode": "NULLABLE",
1215
+ "name": "localized",
1216
+ "description": "Value localized to the customer",
1217
+ "type": "NUMERIC"
1218
+ },
1219
+ {
1220
+ "mode": "NULLABLE",
1221
+ "name": "localized_formatted",
1222
+ "description": "Value localized and formatted for the customer",
1223
+ "type": "STRING"
1224
+ },
1225
+ {
1226
+ "mode": "NULLABLE",
1227
+ "name": "exchange_rate",
1228
+ "description": "Exchange rate used to localize",
1229
+ "type": "NUMERIC"
1230
+ },
1231
+ {
1232
+ "mode": "NULLABLE",
1233
+ "name": "currency_code",
1234
+ "description": "Currency code of the localized value",
1235
+ "type": "STRING"
1236
+ }
1237
+ ]
1238
+ },
1239
+ {
1240
+ "name": "shipping_handling_with_discount",
1241
+ "description": "Shipping/handling with discount",
1242
+ "type": "RECORD",
1243
+ "fields": [
1244
+ {
1245
+ "mode": "NULLABLE",
1246
+ "name": "value",
1247
+ "description": "Value in base currency",
1248
+ "type": "NUMERIC"
1249
+ },
1250
+ {
1251
+ "mode": "NULLABLE",
1252
+ "name": "localized",
1253
+ "description": "Value localized to the customer",
1254
+ "type": "NUMERIC"
1255
+ },
1256
+ {
1257
+ "mode": "NULLABLE",
1258
+ "name": "localized_formatted",
1259
+ "description": "Value localized and formatted for the customer",
1260
+ "type": "STRING"
1261
+ },
1262
+ {
1263
+ "mode": "NULLABLE",
1264
+ "name": "exchange_rate",
1265
+ "description": "Exchange rate used to localize",
1266
+ "type": "NUMERIC"
1267
+ },
1268
+ {
1269
+ "mode": "NULLABLE",
1270
+ "name": "currency_code",
1271
+ "description": "Currency code of the localized value",
1272
+ "type": "STRING"
1273
+ }
1274
+ ]
1275
+ },
1276
+ {
1277
+ "name": "total",
1278
+ "description": "Total",
1279
+ "type": "RECORD",
1280
+ "fields": [
1281
+ {
1282
+ "mode": "NULLABLE",
1283
+ "name": "value",
1284
+ "description": "Value in base currency",
1285
+ "type": "NUMERIC"
1286
+ },
1287
+ {
1288
+ "mode": "NULLABLE",
1289
+ "name": "localized",
1290
+ "description": "Value localized to the customer",
1291
+ "type": "NUMERIC"
1292
+ },
1293
+ {
1294
+ "mode": "NULLABLE",
1295
+ "name": "localized_formatted",
1296
+ "description": "Value localized and formatted for the customer",
1297
+ "type": "STRING"
1298
+ },
1299
+ {
1300
+ "mode": "NULLABLE",
1301
+ "name": "exchange_rate",
1302
+ "description": "Exchange rate used to localize",
1303
+ "type": "NUMERIC"
1304
+ },
1305
+ {
1306
+ "mode": "NULLABLE",
1307
+ "name": "currency_code",
1308
+ "description": "Currency code of the localized value",
1309
+ "type": "STRING"
1310
+ }
1311
+ ]
1312
+ },
1313
+ {
1314
+ "name": "arbitrary_tax",
1315
+ "description": "Arbitrary tax",
1316
+ "type": "RECORD",
1317
+ "fields": [
1318
+ {
1319
+ "mode": "NULLABLE",
1320
+ "name": "value",
1321
+ "description": "Value in base currency",
1322
+ "type": "NUMERIC"
1323
+ },
1324
+ {
1325
+ "mode": "NULLABLE",
1326
+ "name": "localized",
1327
+ "description": "Value localized to the customer",
1328
+ "type": "NUMERIC"
1329
+ },
1330
+ {
1331
+ "mode": "NULLABLE",
1332
+ "name": "localized_formatted",
1333
+ "description": "Value localized and formatted for the customer",
1334
+ "type": "STRING"
1335
+ },
1336
+ {
1337
+ "mode": "NULLABLE",
1338
+ "name": "exchange_rate",
1339
+ "description": "Exchange rate used to localize",
1340
+ "type": "NUMERIC"
1341
+ },
1342
+ {
1343
+ "mode": "NULLABLE",
1344
+ "name": "currency_code",
1345
+ "description": "Currency code of the localized value",
1346
+ "type": "STRING"
1347
+ }
1348
+ ]
1349
+ },
1350
+ {
1351
+ "name": "arbitrary_taxable_subtotal",
1352
+ "description": "Arbitrary taxable subtotal",
1353
+ "type": "RECORD",
1354
+ "fields": [
1355
+ {
1356
+ "mode": "NULLABLE",
1357
+ "name": "value",
1358
+ "description": "Value in base currency",
1359
+ "type": "NUMERIC"
1360
+ },
1361
+ {
1362
+ "mode": "NULLABLE",
1363
+ "name": "localized",
1364
+ "description": "Value localized to the customer",
1365
+ "type": "NUMERIC"
1366
+ },
1367
+ {
1368
+ "mode": "NULLABLE",
1369
+ "name": "localized_formatted",
1370
+ "description": "Value localized and formatted for the customer",
1371
+ "type": "STRING"
1372
+ },
1373
+ {
1374
+ "mode": "NULLABLE",
1375
+ "name": "exchange_rate",
1376
+ "description": "Exchange rate used to localize",
1377
+ "type": "NUMERIC"
1378
+ },
1379
+ {
1380
+ "mode": "NULLABLE",
1381
+ "name": "currency_code",
1382
+ "description": "Currency code of the localized value",
1383
+ "type": "STRING"
1384
+ }
1385
+ ]
1386
+ },
1387
+ {
1388
+ "name": "arbitrary_tax_rate",
1389
+ "description": "Arbitrary tax rate",
1390
+ "type": "RECORD",
1391
+ "fields": [
1392
+ {
1393
+ "mode": "NULLABLE",
1394
+ "name": "value",
1395
+ "description": "Value in base currency",
1396
+ "type": "NUMERIC"
1397
+ },
1398
+ {
1399
+ "mode": "NULLABLE",
1400
+ "name": "localized",
1401
+ "description": "Value localized to the customer",
1402
+ "type": "NUMERIC"
1403
+ },
1404
+ {
1405
+ "mode": "NULLABLE",
1406
+ "name": "localized_formatted",
1407
+ "description": "Value localized and formatted for the customer",
1408
+ "type": "STRING"
1409
+ },
1410
+ {
1411
+ "mode": "NULLABLE",
1412
+ "name": "exchange_rate",
1413
+ "description": "Exchange rate used to localize",
1414
+ "type": "NUMERIC"
1415
+ },
1416
+ {
1417
+ "mode": "NULLABLE",
1418
+ "name": "currency_code",
1419
+ "description": "Currency code of the localized value",
1420
+ "type": "STRING"
1421
+ }
1422
+ ]
1423
+ },
1424
+ {
1425
+ "name": "arbitrary_shipping_handling_total",
1426
+ "description": "Arbitrary shipping/handling total",
1427
+ "type": "RECORD",
1428
+ "fields": [
1429
+ {
1430
+ "mode": "NULLABLE",
1431
+ "name": "value",
1432
+ "description": "Value in base currency",
1433
+ "type": "NUMERIC"
1434
+ },
1435
+ {
1436
+ "mode": "NULLABLE",
1437
+ "name": "localized",
1438
+ "description": "Value localized to the customer",
1439
+ "type": "NUMERIC"
1440
+ },
1441
+ {
1442
+ "mode": "NULLABLE",
1443
+ "name": "localized_formatted",
1444
+ "description": "Value localized and formatted for the customer",
1445
+ "type": "STRING"
1446
+ },
1447
+ {
1448
+ "mode": "NULLABLE",
1449
+ "name": "exchange_rate",
1450
+ "description": "Exchange rate used to localize",
1451
+ "type": "NUMERIC"
1452
+ },
1453
+ {
1454
+ "mode": "NULLABLE",
1455
+ "name": "currency_code",
1456
+ "description": "Currency code of the localized value",
1457
+ "type": "STRING"
1458
+ }
1459
+ ]
1460
+ },
1461
+ {
1462
+ "name": "surcharge",
1463
+ "description": "Surcharge associated with the payment method",
1464
+ "type": "RECORD",
1465
+ "fields": [
1466
+ {
1467
+ "mode": "NULLABLE",
1468
+ "name": "value",
1469
+ "description": "Value in base currency",
1470
+ "type": "NUMERIC"
1471
+ },
1472
+ {
1473
+ "mode": "NULLABLE",
1474
+ "name": "localized",
1475
+ "description": "Value localized to the customer",
1476
+ "type": "NUMERIC"
1477
+ },
1478
+ {
1479
+ "mode": "NULLABLE",
1480
+ "name": "localized_formatted",
1481
+ "description": "Value localized and formatted for the customer",
1482
+ "type": "STRING"
1483
+ },
1484
+ {
1485
+ "mode": "NULLABLE",
1486
+ "name": "exchange_rate",
1487
+ "description": "Exchange rate used to localize",
1488
+ "type": "NUMERIC"
1489
+ },
1490
+ {
1491
+ "mode": "NULLABLE",
1492
+ "name": "currency_code",
1493
+ "description": "Currency code of the localized value",
1494
+ "type": "STRING"
1495
+ }
1496
+ ]
1497
+ },
1498
+ {
1499
+ "name": "internal_gift_certificate_amount",
1500
+ "description": "Internal gift certificate amount used (store credit)",
1501
+ "type": "RECORD",
1502
+ "fields": [
1503
+ {
1504
+ "mode": "NULLABLE",
1505
+ "name": "value",
1506
+ "description": "Value in base currency",
1507
+ "type": "NUMERIC"
1508
+ },
1509
+ {
1510
+ "mode": "NULLABLE",
1511
+ "name": "localized",
1512
+ "description": "Value localized to the customer",
1513
+ "type": "NUMERIC"
1514
+ },
1515
+ {
1516
+ "mode": "NULLABLE",
1517
+ "name": "localized_formatted",
1518
+ "description": "Value localized and formatted for the customer",
1519
+ "type": "STRING"
1520
+ },
1521
+ {
1522
+ "mode": "NULLABLE",
1523
+ "name": "exchange_rate",
1524
+ "description": "Exchange rate used to localize",
1525
+ "type": "NUMERIC"
1526
+ },
1527
+ {
1528
+ "mode": "NULLABLE",
1529
+ "name": "currency_code",
1530
+ "description": "Currency code of the localized value",
1531
+ "type": "STRING"
1532
+ }
1533
+ ]
1534
+ },
1535
+ {
1536
+ "name": "health_benefit_card_amount",
1537
+ "description": "Health benefit card amount used",
1538
+ "type": "RECORD",
1539
+ "fields": [
1540
+ {
1541
+ "mode": "NULLABLE",
1542
+ "name": "value",
1543
+ "description": "Value in base currency",
1544
+ "type": "NUMERIC"
1545
+ },
1546
+ {
1547
+ "mode": "NULLABLE",
1548
+ "name": "localized",
1549
+ "description": "Value localized to the customer",
1550
+ "type": "NUMERIC"
1551
+ },
1552
+ {
1553
+ "mode": "NULLABLE",
1554
+ "name": "localized_formatted",
1555
+ "description": "Value localized and formatted for the customer",
1556
+ "type": "STRING"
1557
+ },
1558
+ {
1559
+ "mode": "NULLABLE",
1560
+ "name": "exchange_rate",
1561
+ "description": "Exchange rate used to localize",
1562
+ "type": "NUMERIC"
1563
+ },
1564
+ {
1565
+ "mode": "NULLABLE",
1566
+ "name": "currency_code",
1567
+ "description": "Currency code of the localized value",
1568
+ "type": "STRING"
1569
+ }
1570
+ ]
1571
+ }
1572
+ ]
1573
+ },
1574
+ {
1575
+ "mode": "REPEATED",
1576
+ "name": "coupons",
1577
+ "description": "Coupons",
1578
+ "type": "RECORD",
1579
+ "fields": [{
1580
+ "mode": "NULLABLE",
1581
+ "name": "coupon_code",
1582
+ "description": "Coupon code",
1583
+ "type": "STRING"
1584
+ }]
1585
+ },
1586
+ {
1587
+ "name": "taxes",
1588
+ "description": "Taxes",
1589
+ "type": "RECORD",
1590
+ "fields": [
1591
+ {
1592
+ "mode": "NULLABLE",
1593
+ "name": "rate",
1594
+ "description": "Tax rate",
1595
+ "type": "NUMERIC"
1596
+ },
1597
+ {
1598
+ "mode": "NULLABLE",
1599
+ "name": "exempt",
1600
+ "description": "True if tax exempt",
1601
+ "type": "BOOLEAN"
1602
+ },
1603
+ {
1604
+ "mode": "NULLABLE",
1605
+ "name": "county",
1606
+ "description": "Tax county if the state requires it.",
1607
+ "type": "STRING"
1608
+ }
1609
+ ]
1610
+ },
1611
+ {
1612
+ "name": "customer_profile",
1613
+ "description": "Customer profile if logged in",
1614
+ "type": "RECORD",
1615
+ "fields": [
1616
+ {
1617
+ "mode": "NULLABLE",
1618
+ "name": "customer_profile_oid",
1619
+ "description": "Unique identifier",
1620
+ "type": "INTEGER"
1621
+ },
1622
+ {
1623
+ "mode": "NULLABLE",
1624
+ "name": "email",
1625
+ "description": "Email",
1626
+ "type": "STRING"
1627
+ },
1628
+ {
1629
+ "mode": "NULLABLE",
1630
+ "name": "tax_exempt",
1631
+ "description": "True if this profile is exempt from sales tax",
1632
+ "type": "BOOLEAN"
1633
+ },
1634
+ {
1635
+ "mode": "NULLABLE",
1636
+ "name": "allow_purchase_order",
1637
+ "description": "True if this profile is allowed to use a purchase order",
1638
+ "type": "BOOLEAN"
1639
+ },
1640
+ {
1641
+ "mode": "NULLABLE",
1642
+ "name": "allow_cod",
1643
+ "description": "True if this profile is allowed to use a COD",
1644
+ "type": "BOOLEAN"
1645
+ },
1646
+ {
1647
+ "mode": "NULLABLE",
1648
+ "name": "free_shipping",
1649
+ "description": "True if this profile always qualifies for free shipping",
1650
+ "type": "BOOLEAN"
1651
+ },
1652
+ {
1653
+ "mode": "NULLABLE",
1654
+ "name": "free_shipping_minimum",
1655
+ "description": "The minimum amount that this profile has to purchase to qualify for free shipping",
1656
+ "type": "NUMERIC"
1657
+ },
1658
+ {
1659
+ "mode": "NULLABLE",
1660
+ "name": "minimum_subtotal",
1661
+ "description": "Minimum subtotal this profile must purchase",
1662
+ "type": "NUMERIC"
1663
+ },
1664
+ {
1665
+ "mode": "NULLABLE",
1666
+ "name": "minimum_item_count",
1667
+ "description": "Minimum item count this profile must purchase",
1668
+ "type": "INTEGER"
1669
+ },
1670
+ {
1671
+ "mode": "NULLABLE",
1672
+ "name": "maximum_item_count",
1673
+ "description": "Maximum item count this profile can purchase",
1674
+ "type": "INTEGER"
1675
+ },
1676
+ {
1677
+ "mode": "NULLABLE",
1678
+ "name": "no_realtime_charge",
1679
+ "description": "True if this customers orders are not charged in real-time",
1680
+ "type": "BOOLEAN"
1681
+ },
1682
+ {
1683
+ "mode": "NULLABLE",
1684
+ "name": "no_free_shipping",
1685
+ "description": "True if this profile is never given free shipping",
1686
+ "type": "BOOLEAN"
1687
+ },
1688
+ {
1689
+ "mode": "NULLABLE",
1690
+ "name": "allow_3rd_party_billing",
1691
+ "description": "True if profile is allowed to bill to their 3rd party shipping account",
1692
+ "type": "BOOLEAN"
1693
+ },
1694
+ {
1695
+ "mode": "NULLABLE",
1696
+ "name": "no_coupons",
1697
+ "description": "True if this profile is prevented from using coupons",
1698
+ "type": "BOOLEAN"
1699
+ },
1700
+ {
1701
+ "mode": "NULLABLE",
1702
+ "name": "ups_account_number",
1703
+ "description": "UPS account number on file",
1704
+ "type": "STRING"
1705
+ },
1706
+ {
1707
+ "mode": "NULLABLE",
1708
+ "name": "fedex_account_number",
1709
+ "description": "FedEx account number on file",
1710
+ "type": "STRING"
1711
+ },
1712
+ {
1713
+ "mode": "NULLABLE",
1714
+ "name": "dhl_account_number",
1715
+ "description": "DHL account number on file",
1716
+ "type": "STRING"
1717
+ },
1718
+ {
1719
+ "mode": "NULLABLE",
1720
+ "name": "dhl_duty_account_number",
1721
+ "description": "DHL duty account number on file",
1722
+ "type": "STRING"
1723
+ },
1724
+ {
1725
+ "mode": "REPEATED",
1726
+ "name": "pricing_tiers",
1727
+ "description": "Pricing tier names this profile qualifies for",
1728
+ "type": "RECORD",
1729
+ "fields": [{
1730
+ "mode": "NULLABLE",
1731
+ "name": "value",
1732
+ "type": "STRING"
1733
+ }]
1734
+ },
1735
+ {
1736
+ "mode": "REPEATED",
1737
+ "name": "billing_addresses",
1738
+ "description": "Billing addresses on file for this profile",
1739
+ "type": "RECORD",
1740
+ "fields": [
1741
+ {
1742
+ "mode": "NULLABLE",
1743
+ "name": "tax_county",
1744
+ "description": "Tax county if a billing address",
1745
+ "type": "STRING"
1746
+ },
1747
+ {
1748
+ "mode": "NULLABLE",
1749
+ "name": "first_name",
1750
+ "description": "First name",
1751
+ "type": "STRING"
1752
+ },
1753
+ {
1754
+ "mode": "NULLABLE",
1755
+ "name": "last_name",
1756
+ "description": "Last name",
1757
+ "type": "STRING"
1758
+ },
1759
+ {
1760
+ "mode": "NULLABLE",
1761
+ "name": "company",
1762
+ "description": "Company",
1763
+ "type": "STRING"
1764
+ },
1765
+ {
1766
+ "mode": "NULLABLE",
1767
+ "name": "address1",
1768
+ "description": "Address 1",
1769
+ "type": "STRING"
1770
+ },
1771
+ {
1772
+ "mode": "NULLABLE",
1773
+ "name": "address2",
1774
+ "description": "Address 2",
1775
+ "type": "STRING"
1776
+ },
1777
+ {
1778
+ "mode": "NULLABLE",
1779
+ "name": "city",
1780
+ "description": "City",
1781
+ "type": "STRING"
1782
+ },
1783
+ {
1784
+ "mode": "NULLABLE",
1785
+ "name": "state_region",
1786
+ "description": "State for United States otherwise region or province for other countries",
1787
+ "type": "STRING"
1788
+ },
1789
+ {
1790
+ "mode": "NULLABLE",
1791
+ "name": "postal_code",
1792
+ "description": "Postal code",
1793
+ "type": "STRING"
1794
+ },
1795
+ {
1796
+ "mode": "NULLABLE",
1797
+ "name": "country_code",
1798
+ "description": "ISO-3166 Country code",
1799
+ "type": "STRING"
1800
+ },
1801
+ {
1802
+ "mode": "NULLABLE",
1803
+ "name": "day_phone",
1804
+ "description": "Day phone",
1805
+ "type": "STRING"
1806
+ },
1807
+ {
1808
+ "mode": "NULLABLE",
1809
+ "name": "evening_phone",
1810
+ "description": "Evening phone",
1811
+ "type": "STRING"
1812
+ },
1813
+ {
1814
+ "mode": "NULLABLE",
1815
+ "name": "title",
1816
+ "description": "Title",
1817
+ "type": "STRING"
1818
+ },
1819
+ {
1820
+ "mode": "NULLABLE",
1821
+ "name": "oid",
1822
+ "description": "Unique identifier for this address",
1823
+ "type": "INTEGER"
1824
+ },
1825
+ {
1826
+ "mode": "NULLABLE",
1827
+ "name": "company_hash",
1828
+ "description": "Company Hash SHA-256 Base64",
1829
+ "type": "STRING"
1830
+ },
1831
+ {
1832
+ "mode": "NULLABLE",
1833
+ "name": "title_hash",
1834
+ "description": "Title Hash SHA-256 Base64",
1835
+ "type": "STRING"
1836
+ },
1837
+ {
1838
+ "mode": "NULLABLE",
1839
+ "name": "first_name_hash",
1840
+ "description": "First name Hash SHA-256 Base64",
1841
+ "type": "STRING"
1842
+ },
1843
+ {
1844
+ "mode": "NULLABLE",
1845
+ "name": "last_name_hash",
1846
+ "description": "Last name Hash SHA-256 Base64",
1847
+ "type": "STRING"
1848
+ },
1849
+ {
1850
+ "mode": "NULLABLE",
1851
+ "name": "address1_hash",
1852
+ "description": "Address line 1 Hash SHA-256 Base64",
1853
+ "type": "STRING"
1854
+ },
1855
+ {
1856
+ "mode": "NULLABLE",
1857
+ "name": "address2_hash",
1858
+ "description": "Address line 2 Hash SHA-256 Base64",
1859
+ "type": "STRING"
1860
+ },
1861
+ {
1862
+ "mode": "NULLABLE",
1863
+ "name": "day_phone_hash",
1864
+ "description": "Day time phone Hash SHA-256 Base64",
1865
+ "type": "STRING"
1866
+ },
1867
+ {
1868
+ "mode": "NULLABLE",
1869
+ "name": "evening_phone_hash",
1870
+ "description": "Evening phone Hash SHA-256 Base64",
1871
+ "type": "STRING"
1872
+ }
1873
+ ]
1874
+ },
1875
+ {
1876
+ "mode": "REPEATED",
1877
+ "name": "shipping_addresses",
1878
+ "description": "Shipping addresses on file for this profile",
1879
+ "type": "RECORD",
1880
+ "fields": [
1881
+ {
1882
+ "mode": "NULLABLE",
1883
+ "name": "tax_county",
1884
+ "description": "Tax county if a billing address",
1885
+ "type": "STRING"
1886
+ },
1887
+ {
1888
+ "mode": "NULLABLE",
1889
+ "name": "first_name",
1890
+ "description": "First name",
1891
+ "type": "STRING"
1892
+ },
1893
+ {
1894
+ "mode": "NULLABLE",
1895
+ "name": "last_name",
1896
+ "description": "Last name",
1897
+ "type": "STRING"
1898
+ },
1899
+ {
1900
+ "mode": "NULLABLE",
1901
+ "name": "company",
1902
+ "description": "Company",
1903
+ "type": "STRING"
1904
+ },
1905
+ {
1906
+ "mode": "NULLABLE",
1907
+ "name": "address1",
1908
+ "description": "Address 1",
1909
+ "type": "STRING"
1910
+ },
1911
+ {
1912
+ "mode": "NULLABLE",
1913
+ "name": "address2",
1914
+ "description": "Address 2",
1915
+ "type": "STRING"
1916
+ },
1917
+ {
1918
+ "mode": "NULLABLE",
1919
+ "name": "city",
1920
+ "description": "City",
1921
+ "type": "STRING"
1922
+ },
1923
+ {
1924
+ "mode": "NULLABLE",
1925
+ "name": "state_region",
1926
+ "description": "State for United States otherwise region or province for other countries",
1927
+ "type": "STRING"
1928
+ },
1929
+ {
1930
+ "mode": "NULLABLE",
1931
+ "name": "postal_code",
1932
+ "description": "Postal code",
1933
+ "type": "STRING"
1934
+ },
1935
+ {
1936
+ "mode": "NULLABLE",
1937
+ "name": "country_code",
1938
+ "description": "ISO-3166 Country code",
1939
+ "type": "STRING"
1940
+ },
1941
+ {
1942
+ "mode": "NULLABLE",
1943
+ "name": "day_phone",
1944
+ "description": "Day phone",
1945
+ "type": "STRING"
1946
+ },
1947
+ {
1948
+ "mode": "NULLABLE",
1949
+ "name": "evening_phone",
1950
+ "description": "Evening phone",
1951
+ "type": "STRING"
1952
+ },
1953
+ {
1954
+ "mode": "NULLABLE",
1955
+ "name": "title",
1956
+ "description": "Title",
1957
+ "type": "STRING"
1958
+ },
1959
+ {
1960
+ "mode": "NULLABLE",
1961
+ "name": "oid",
1962
+ "description": "Unique identifier for this address",
1963
+ "type": "INTEGER"
1964
+ },
1965
+ {
1966
+ "mode": "NULLABLE",
1967
+ "name": "company_hash",
1968
+ "description": "Company Hash SHA-256 Base64",
1969
+ "type": "STRING"
1970
+ },
1971
+ {
1972
+ "mode": "NULLABLE",
1973
+ "name": "title_hash",
1974
+ "description": "Title Hash SHA-256 Base64",
1975
+ "type": "STRING"
1976
+ },
1977
+ {
1978
+ "mode": "NULLABLE",
1979
+ "name": "first_name_hash",
1980
+ "description": "First name Hash SHA-256 Base64",
1981
+ "type": "STRING"
1982
+ },
1983
+ {
1984
+ "mode": "NULLABLE",
1985
+ "name": "last_name_hash",
1986
+ "description": "Last name Hash SHA-256 Base64",
1987
+ "type": "STRING"
1988
+ },
1989
+ {
1990
+ "mode": "NULLABLE",
1991
+ "name": "address1_hash",
1992
+ "description": "Address line 1 Hash SHA-256 Base64",
1993
+ "type": "STRING"
1994
+ },
1995
+ {
1996
+ "mode": "NULLABLE",
1997
+ "name": "address2_hash",
1998
+ "description": "Address line 2 Hash SHA-256 Base64",
1999
+ "type": "STRING"
2000
+ },
2001
+ {
2002
+ "mode": "NULLABLE",
2003
+ "name": "day_phone_hash",
2004
+ "description": "Day time phone Hash SHA-256 Base64",
2005
+ "type": "STRING"
2006
+ },
2007
+ {
2008
+ "mode": "NULLABLE",
2009
+ "name": "evening_phone_hash",
2010
+ "description": "Evening phone Hash SHA-256 Base64",
2011
+ "type": "STRING"
2012
+ }
2013
+ ]
2014
+ },
2015
+ {
2016
+ "mode": "REPEATED",
2017
+ "name": "credit_cards",
2018
+ "description": "Credit cards on file for this profile (masked)",
2019
+ "type": "RECORD",
2020
+ "fields": [
2021
+ {
2022
+ "mode": "NULLABLE",
2023
+ "name": "customer_profile_credit_card_id",
2024
+ "description": "Unique identifier for this stored card",
2025
+ "type": "INTEGER"
2026
+ },
2027
+ {
2028
+ "allowed_values": [
2029
+ "AMEX",
2030
+ "Diners Club",
2031
+ "Discover",
2032
+ "MasterCard",
2033
+ "JCB",
2034
+ "VISA"
2035
+ ],
2036
+ "mode": "NULLABLE",
2037
+ "name": "card_type",
2038
+ "description": "Card type",
2039
+ "type": "STRING"
2040
+ },
2041
+ {
2042
+ "mode": "NULLABLE",
2043
+ "name": "card_expiration_month",
2044
+ "description": "Card expiration month (1-12)",
2045
+ "type": "INTEGER"
2046
+ },
2047
+ {
2048
+ "mode": "NULLABLE",
2049
+ "name": "card_expiration_year",
2050
+ "description": "Card expiration year (four digit)",
2051
+ "type": "INTEGER"
2052
+ },
2053
+ {
2054
+ "mode": "NULLABLE",
2055
+ "name": "card_number",
2056
+ "description": "Card number (masked last 4 digits)",
2057
+ "type": "STRING"
2058
+ },
2059
+ {
2060
+ "mode": "NULLABLE",
2061
+ "name": "last_used_date",
2062
+ "description": "Last used",
2063
+ "type": "DATETIME"
2064
+ },
2065
+ {
2066
+ "mode": "NULLABLE",
2067
+ "name": "card_number_hash",
2068
+ "description": "Card nmumber (masked last 4 digits) Hash SHA-256 Base64",
2069
+ "type": "STRING"
2070
+ }
2071
+ ]
2072
+ },
2073
+ {
2074
+ "mode": "NULLABLE",
2075
+ "name": "signup_dts",
2076
+ "description": "Signup date",
2077
+ "type": "STRING"
2078
+ },
2079
+ {
2080
+ "mode": "NULLABLE",
2081
+ "name": "email_hash",
2082
+ "description": "Email Hash SHA-256 Base64",
2083
+ "type": "STRING"
2084
+ },
2085
+ {
2086
+ "mode": "NULLABLE",
2087
+ "name": "ups_account_number_hash",
2088
+ "description": "UPS Account Number Hash SHA-256 Base64",
2089
+ "type": "STRING"
2090
+ },
2091
+ {
2092
+ "mode": "NULLABLE",
2093
+ "name": "fedex_account_number_hash",
2094
+ "description": "FedEx Account Number Hash SHA-256 Base64",
2095
+ "type": "STRING"
2096
+ },
2097
+ {
2098
+ "mode": "NULLABLE",
2099
+ "name": "dhl_account_number_hash",
2100
+ "description": "DHL Account Number Hash SHA-256 Base64",
2101
+ "type": "STRING"
2102
+ },
2103
+ {
2104
+ "mode": "NULLABLE",
2105
+ "name": "dhl_duty_account_number_hash",
2106
+ "description": "DHL Duty Account Number Hash SHA-256 Base64",
2107
+ "type": "STRING"
2108
+ }
2109
+ ]
2110
+ },
2111
+ {
2112
+ "name": "settings",
2113
+ "description": "Settings for options that should be available during the checkout",
2114
+ "type": "RECORD",
2115
+ "fields": [
2116
+ {
2117
+ "name": "billing",
2118
+ "description": "Billing settings for this cart",
2119
+ "type": "RECORD",
2120
+ "fields": [{
2121
+ "mode": "REPEATED",
2122
+ "name": "provinces",
2123
+ "description": "Provinces",
2124
+ "type": "RECORD",
2125
+ "fields": [
2126
+ {
2127
+ "mode": "NULLABLE",
2128
+ "name": "province",
2129
+ "type": "STRING"
2130
+ },
2131
+ {
2132
+ "mode": "NULLABLE",
2133
+ "name": "code",
2134
+ "type": "STRING"
2135
+ }
2136
+ ]
2137
+ }]
2138
+ },
2139
+ {
2140
+ "name": "gift",
2141
+ "description": "Gift giving settings",
2142
+ "type": "RECORD",
2143
+ "fields": [
2144
+ {
2145
+ "mode": "NULLABLE",
2146
+ "name": "allow_gifts",
2147
+ "description": "True if this checkout supports gift giving",
2148
+ "type": "BOOLEAN"
2149
+ },
2150
+ {
2151
+ "name": "gift_charge",
2152
+ "description": "The cost associated with sending a gift",
2153
+ "type": "RECORD",
2154
+ "fields": [
2155
+ {
2156
+ "mode": "NULLABLE",
2157
+ "name": "value",
2158
+ "description": "Value in base currency",
2159
+ "type": "NUMERIC"
2160
+ },
2161
+ {
2162
+ "mode": "NULLABLE",
2163
+ "name": "localized",
2164
+ "description": "Value localized to the customer",
2165
+ "type": "NUMERIC"
2166
+ },
2167
+ {
2168
+ "mode": "NULLABLE",
2169
+ "name": "localized_formatted",
2170
+ "description": "Value localized and formatted for the customer",
2171
+ "type": "STRING"
2172
+ },
2173
+ {
2174
+ "mode": "NULLABLE",
2175
+ "name": "exchange_rate",
2176
+ "description": "Exchange rate used to localize",
2177
+ "type": "NUMERIC"
2178
+ },
2179
+ {
2180
+ "mode": "NULLABLE",
2181
+ "name": "currency_code",
2182
+ "description": "Currency code of the localized value",
2183
+ "type": "STRING"
2184
+ }
2185
+ ]
2186
+ },
2187
+ {
2188
+ "mode": "NULLABLE",
2189
+ "name": "max_message_length",
2190
+ "description": "The maximum length of the gift message the giver can enter",
2191
+ "type": "INTEGER"
2192
+ },
2193
+ {
2194
+ "mode": "REPEATED",
2195
+ "name": "gift_wraps",
2196
+ "description": "The gift wraps available for the customer to select from",
2197
+ "type": "RECORD",
2198
+ "fields": [
2199
+ {
2200
+ "mode": "NULLABLE",
2201
+ "name": "title",
2202
+ "description": "Title of the gift wrap",
2203
+ "type": "STRING"
2204
+ },
2205
+ {
2206
+ "name": "cost",
2207
+ "description": "Cost if this gift wrap is selected",
2208
+ "type": "RECORD",
2209
+ "fields": [
2210
+ {
2211
+ "mode": "NULLABLE",
2212
+ "name": "value",
2213
+ "description": "Value in base currency",
2214
+ "type": "NUMERIC"
2215
+ },
2216
+ {
2217
+ "mode": "NULLABLE",
2218
+ "name": "localized",
2219
+ "description": "Value localized to the customer",
2220
+ "type": "NUMERIC"
2221
+ },
2222
+ {
2223
+ "mode": "NULLABLE",
2224
+ "name": "localized_formatted",
2225
+ "description": "Value localized and formatted for the customer",
2226
+ "type": "STRING"
2227
+ },
2228
+ {
2229
+ "mode": "NULLABLE",
2230
+ "name": "exchange_rate",
2231
+ "description": "Exchange rate used to localize",
2232
+ "type": "NUMERIC"
2233
+ },
2234
+ {
2235
+ "mode": "NULLABLE",
2236
+ "name": "currency_code",
2237
+ "description": "Currency code of the localized value",
2238
+ "type": "STRING"
2239
+ }
2240
+ ]
2241
+ },
2242
+ {
2243
+ "mode": "NULLABLE",
2244
+ "name": "url",
2245
+ "description": "URL for the sample of the gift wrap",
2246
+ "type": "STRING"
2247
+ }
2248
+ ]
2249
+ }
2250
+ ]
2251
+ },
2252
+ {
2253
+ "name": "terms",
2254
+ "description": "Terms of the checkout the customer must agree to",
2255
+ "type": "RECORD",
2256
+ "fields": [
2257
+ {
2258
+ "mode": "NULLABLE",
2259
+ "name": "text",
2260
+ "description": "Text version of the terms.",
2261
+ "type": "STRING"
2262
+ },
2263
+ {
2264
+ "mode": "NULLABLE",
2265
+ "name": "html",
2266
+ "description": "HTML version of the terms",
2267
+ "type": "STRING"
2268
+ }
2269
+ ]
2270
+ },
2271
+ {
2272
+ "name": "payment",
2273
+ "description": "Payment settings for this cart",
2274
+ "type": "RECORD",
2275
+ "fields": [
2276
+ {
2277
+ "mode": "NULLABLE",
2278
+ "name": "supports_check",
2279
+ "description": "True if check payments are available on this order",
2280
+ "type": "BOOLEAN"
2281
+ },
2282
+ {
2283
+ "mode": "NULLABLE",
2284
+ "name": "supports_credit_card",
2285
+ "description": "True if credit card payments are available on this order",
2286
+ "type": "BOOLEAN"
2287
+ },
2288
+ {
2289
+ "mode": "NULLABLE",
2290
+ "name": "supports_paypal",
2291
+ "description": "True if PayPal payments are available on this order",
2292
+ "type": "BOOLEAN"
2293
+ },
2294
+ {
2295
+ "mode": "NULLABLE",
2296
+ "name": "supports_purchase_order",
2297
+ "description": "True if purchase order payments are available on this order",
2298
+ "type": "BOOLEAN"
2299
+ },
2300
+ {
2301
+ "mode": "NULLABLE",
2302
+ "name": "supports_money_order",
2303
+ "description": "True if money order payments are available on this order",
2304
+ "type": "BOOLEAN"
2305
+ },
2306
+ {
2307
+ "mode": "NULLABLE",
2308
+ "name": "supports_wire_transfer",
2309
+ "description": "True if wire transfer payments are available on this order",
2310
+ "type": "BOOLEAN"
2311
+ },
2312
+ {
2313
+ "mode": "NULLABLE",
2314
+ "name": "supports_cod",
2315
+ "description": "True if COD payments are available on this order",
2316
+ "type": "BOOLEAN"
2317
+ },
2318
+ {
2319
+ "mode": "NULLABLE",
2320
+ "name": "supports_quote_request",
2321
+ "description": "True if quote requests payments are available on this order",
2322
+ "type": "BOOLEAN"
2323
+ },
2324
+ {
2325
+ "mode": "NULLABLE",
2326
+ "name": "supports_amazon",
2327
+ "description": "True if Amazon payments are available on this order",
2328
+ "type": "BOOLEAN"
2329
+ },
2330
+ {
2331
+ "name": "amazon",
2332
+ "description": "Amazon Payments information",
2333
+ "type": "RECORD",
2334
+ "fields": [
2335
+ {
2336
+ "mode": "NULLABLE",
2337
+ "name": "amazon_merchant_id",
2338
+ "description": "Amazon merchant ID",
2339
+ "type": "STRING"
2340
+ },
2341
+ {
2342
+ "mode": "NULLABLE",
2343
+ "name": "amazon_widget_url",
2344
+ "description": "Amazon widget URL",
2345
+ "type": "STRING"
2346
+ },
2347
+ {
2348
+ "mode": "NULLABLE",
2349
+ "name": "amazon_button_url",
2350
+ "description": "Amazon button URL",
2351
+ "type": "STRING"
2352
+ }
2353
+ ]
2354
+ },
2355
+ {
2356
+ "name": "credit_card",
2357
+ "description": "Credit card payment information",
2358
+ "type": "RECORD",
2359
+ "fields": [
2360
+ {
2361
+ "allowed_values": [
2362
+ "AMEX",
2363
+ "Diners Club",
2364
+ "Discover",
2365
+ "MasterCard",
2366
+ "JCB",
2367
+ "VISA"
2368
+ ],
2369
+ "mode": "REPEATED",
2370
+ "name": "credit_card_types",
2371
+ "description": "Available credit card types",
2372
+ "type": "RECORD",
2373
+ "fields": [{
2374
+ "mode": "NULLABLE",
2375
+ "name": "value",
2376
+ "type": "STRING"
2377
+ }]
2378
+ },
2379
+ {
2380
+ "mode": "NULLABLE",
2381
+ "name": "collect_credit_card_verification_number",
2382
+ "description": "True if the credit card verification number should be collected",
2383
+ "type": "BOOLEAN"
2384
+ },
2385
+ {
2386
+ "mode": "NULLABLE",
2387
+ "name": "collect_credit_card_verification_number_minimum",
2388
+ "description": "If this field is null or the total is greater than or equal to this value then collect the CVV2.",
2389
+ "type": "NUMERIC"
2390
+ }
2391
+ ]
2392
+ },
2393
+ {
2394
+ "name": "paypal",
2395
+ "description": "PayPal information",
2396
+ "type": "RECORD",
2397
+ "fields": [
2398
+ {
2399
+ "mode": "NULLABLE",
2400
+ "name": "paypal_button_url",
2401
+ "description": "PayPal button URL",
2402
+ "type": "STRING"
2403
+ },
2404
+ {
2405
+ "mode": "NULLABLE",
2406
+ "name": "paypal_button_alt_text",
2407
+ "description": "PayPal button alt text",
2408
+ "type": "STRING"
2409
+ },
2410
+ {
2411
+ "mode": "NULLABLE",
2412
+ "name": "paypal_credit_button_url",
2413
+ "description": "PayPal Credit button URL",
2414
+ "type": "STRING"
2415
+ },
2416
+ {
2417
+ "mode": "NULLABLE",
2418
+ "name": "paypal_credit_legal_url",
2419
+ "description": "PayPal Credit legal URL",
2420
+ "type": "STRING"
2421
+ },
2422
+ {
2423
+ "mode": "NULLABLE",
2424
+ "name": "paypal_credit_legal_image_url",
2425
+ "description": "PayPal Credit legal image URL",
2426
+ "type": "STRING"
2427
+ }
2428
+ ]
2429
+ },
2430
+ {
2431
+ "mode": "NULLABLE",
2432
+ "name": "need_payment",
2433
+ "description": "True if this card requires a payment from the customer",
2434
+ "type": "BOOLEAN"
2435
+ }
2436
+ ]
2437
+ },
2438
+ {
2439
+ "name": "shipping",
2440
+ "description": "Shipping settings for this cart",
2441
+ "type": "RECORD",
2442
+ "fields": [
2443
+ {
2444
+ "mode": "NULLABLE",
2445
+ "name": "need_shipping",
2446
+ "description": "True if this order needs shipping",
2447
+ "type": "BOOLEAN"
2448
+ },
2449
+ {
2450
+ "mode": "REPEATED",
2451
+ "name": "estimates",
2452
+ "description": "Estimates for this cart",
2453
+ "type": "RECORD",
2454
+ "fields": [
2455
+ {
2456
+ "mode": "NULLABLE",
2457
+ "name": "comment",
2458
+ "description": "Comment to display to the customer about this method",
2459
+ "type": "STRING"
2460
+ },
2461
+ {
2462
+ "name": "cost",
2463
+ "description": "Cost of this method",
2464
+ "type": "RECORD",
2465
+ "fields": [
2466
+ {
2467
+ "mode": "NULLABLE",
2468
+ "name": "value",
2469
+ "description": "Value in base currency",
2470
+ "type": "NUMERIC"
2471
+ },
2472
+ {
2473
+ "mode": "NULLABLE",
2474
+ "name": "localized",
2475
+ "description": "Value localized to the customer",
2476
+ "type": "NUMERIC"
2477
+ },
2478
+ {
2479
+ "mode": "NULLABLE",
2480
+ "name": "localized_formatted",
2481
+ "description": "Value localized and formatted for the customer",
2482
+ "type": "STRING"
2483
+ },
2484
+ {
2485
+ "mode": "NULLABLE",
2486
+ "name": "exchange_rate",
2487
+ "description": "Exchange rate used to localize",
2488
+ "type": "NUMERIC"
2489
+ },
2490
+ {
2491
+ "mode": "NULLABLE",
2492
+ "name": "currency_code",
2493
+ "description": "Currency code of the localized value",
2494
+ "type": "STRING"
2495
+ }
2496
+ ]
2497
+ },
2498
+ {
2499
+ "mode": "NULLABLE",
2500
+ "name": "discounted",
2501
+ "description": "True if this method is discounted because of a coupon",
2502
+ "type": "BOOLEAN"
2503
+ },
2504
+ {
2505
+ "mode": "NULLABLE",
2506
+ "name": "display_name",
2507
+ "description": "The name to display to the customer",
2508
+ "type": "STRING"
2509
+ },
2510
+ {
2511
+ "mode": "NULLABLE",
2512
+ "name": "estimated_delivery",
2513
+ "description": "Date of the estimated delivery (or range)",
2514
+ "type": "STRING"
2515
+ },
2516
+ {
2517
+ "mode": "NULLABLE",
2518
+ "name": "name",
2519
+ "description": "Shipping method name",
2520
+ "type": "STRING"
2521
+ },
2522
+ {
2523
+ "name": "cost_before_discount",
2524
+ "description": "Cost before discount by coupon",
2525
+ "type": "RECORD",
2526
+ "fields": [
2527
+ {
2528
+ "mode": "NULLABLE",
2529
+ "name": "value",
2530
+ "description": "Value in base currency",
2531
+ "type": "NUMERIC"
2532
+ },
2533
+ {
2534
+ "mode": "NULLABLE",
2535
+ "name": "localized",
2536
+ "description": "Value localized to the customer",
2537
+ "type": "NUMERIC"
2538
+ },
2539
+ {
2540
+ "mode": "NULLABLE",
2541
+ "name": "localized_formatted",
2542
+ "description": "Value localized and formatted for the customer",
2543
+ "type": "STRING"
2544
+ },
2545
+ {
2546
+ "mode": "NULLABLE",
2547
+ "name": "exchange_rate",
2548
+ "description": "Exchange rate used to localize",
2549
+ "type": "NUMERIC"
2550
+ },
2551
+ {
2552
+ "mode": "NULLABLE",
2553
+ "name": "currency_code",
2554
+ "description": "Currency code of the localized value",
2555
+ "type": "STRING"
2556
+ }
2557
+ ]
2558
+ },
2559
+ {
2560
+ "name": "discount",
2561
+ "description": "Amount discounted by a coupon",
2562
+ "type": "RECORD",
2563
+ "fields": [
2564
+ {
2565
+ "mode": "NULLABLE",
2566
+ "name": "value",
2567
+ "description": "Value in base currency",
2568
+ "type": "NUMERIC"
2569
+ },
2570
+ {
2571
+ "mode": "NULLABLE",
2572
+ "name": "localized",
2573
+ "description": "Value localized to the customer",
2574
+ "type": "NUMERIC"
2575
+ },
2576
+ {
2577
+ "mode": "NULLABLE",
2578
+ "name": "localized_formatted",
2579
+ "description": "Value localized and formatted for the customer",
2580
+ "type": "STRING"
2581
+ },
2582
+ {
2583
+ "mode": "NULLABLE",
2584
+ "name": "exchange_rate",
2585
+ "description": "Exchange rate used to localize",
2586
+ "type": "NUMERIC"
2587
+ },
2588
+ {
2589
+ "mode": "NULLABLE",
2590
+ "name": "currency_code",
2591
+ "description": "Currency code of the localized value",
2592
+ "type": "STRING"
2593
+ }
2594
+ ]
2595
+ },
2596
+ {
2597
+ "name": "tax",
2598
+ "description": "Tax applied to this method if selected",
2599
+ "type": "RECORD",
2600
+ "fields": [
2601
+ {
2602
+ "mode": "NULLABLE",
2603
+ "name": "value",
2604
+ "description": "Value in base currency",
2605
+ "type": "NUMERIC"
2606
+ },
2607
+ {
2608
+ "mode": "NULLABLE",
2609
+ "name": "localized",
2610
+ "description": "Value localized to the customer",
2611
+ "type": "NUMERIC"
2612
+ },
2613
+ {
2614
+ "mode": "NULLABLE",
2615
+ "name": "localized_formatted",
2616
+ "description": "Value localized and formatted for the customer",
2617
+ "type": "STRING"
2618
+ },
2619
+ {
2620
+ "mode": "NULLABLE",
2621
+ "name": "exchange_rate",
2622
+ "description": "Exchange rate used to localize",
2623
+ "type": "NUMERIC"
2624
+ },
2625
+ {
2626
+ "mode": "NULLABLE",
2627
+ "name": "currency_code",
2628
+ "description": "Currency code of the localized value",
2629
+ "type": "STRING"
2630
+ }
2631
+ ]
2632
+ },
2633
+ {
2634
+ "mode": "NULLABLE",
2635
+ "name": "default_method",
2636
+ "description": "True if this is the default method",
2637
+ "type": "BOOLEAN"
2638
+ },
2639
+ {
2640
+ "name": "total_tax",
2641
+ "description": "Total amount of tax on the order if this method is selected",
2642
+ "type": "RECORD",
2643
+ "fields": [
2644
+ {
2645
+ "mode": "NULLABLE",
2646
+ "name": "value",
2647
+ "description": "Value in base currency",
2648
+ "type": "NUMERIC"
2649
+ },
2650
+ {
2651
+ "mode": "NULLABLE",
2652
+ "name": "localized",
2653
+ "description": "Value localized to the customer",
2654
+ "type": "NUMERIC"
2655
+ },
2656
+ {
2657
+ "mode": "NULLABLE",
2658
+ "name": "localized_formatted",
2659
+ "description": "Value localized and formatted for the customer",
2660
+ "type": "STRING"
2661
+ },
2662
+ {
2663
+ "mode": "NULLABLE",
2664
+ "name": "exchange_rate",
2665
+ "description": "Exchange rate used to localize",
2666
+ "type": "NUMERIC"
2667
+ },
2668
+ {
2669
+ "mode": "NULLABLE",
2670
+ "name": "currency_code",
2671
+ "description": "Currency code of the localized value",
2672
+ "type": "STRING"
2673
+ }
2674
+ ]
2675
+ },
2676
+ {
2677
+ "mode": "NULLABLE",
2678
+ "name": "allow_3rd_party_billing",
2679
+ "description": "True if this method allows the customer to use their own shipper account number",
2680
+ "type": "BOOLEAN"
2681
+ },
2682
+ {
2683
+ "mode": "NULLABLE",
2684
+ "name": "lift_gate_option",
2685
+ "description": "True if a lift gate option for this method should be offered to the customer",
2686
+ "type": "BOOLEAN"
2687
+ },
2688
+ {
2689
+ "mode": "NULLABLE",
2690
+ "name": "pickup",
2691
+ "description": "True if this shipping method requires customers to physically pickup product themselves",
2692
+ "type": "BOOLEAN"
2693
+ }
2694
+ ]
2695
+ },
2696
+ {
2697
+ "mode": "REPEATED",
2698
+ "name": "provinces",
2699
+ "description": "Provinces",
2700
+ "type": "RECORD",
2701
+ "fields": [
2702
+ {
2703
+ "mode": "NULLABLE",
2704
+ "name": "province",
2705
+ "type": "STRING"
2706
+ },
2707
+ {
2708
+ "mode": "NULLABLE",
2709
+ "name": "code",
2710
+ "type": "STRING"
2711
+ }
2712
+ ]
2713
+ },
2714
+ {
2715
+ "name": "ship_on_date",
2716
+ "description": "Ship on date calendar information",
2717
+ "type": "RECORD",
2718
+ "fields": [
2719
+ {
2720
+ "mode": "NULLABLE",
2721
+ "name": "show",
2722
+ "description": "True if this calendar should be shown to the customer",
2723
+ "type": "BOOLEAN"
2724
+ },
2725
+ {
2726
+ "mode": "NULLABLE",
2727
+ "name": "require",
2728
+ "description": "True if the customer is required to select a date",
2729
+ "type": "BOOLEAN"
2730
+ },
2731
+ {
2732
+ "mode": "REPEATED",
2733
+ "name": "days_of_week",
2734
+ "description": "Days of week that should be enabled on the calendar (0 - Sunday through 6 - Saturday)",
2735
+ "type": "RECORD",
2736
+ "fields": [{
2737
+ "mode": "NULLABLE",
2738
+ "name": "value",
2739
+ "type": "BOOLEAN"
2740
+ }]
2741
+ },
2742
+ {
2743
+ "mode": "REPEATED",
2744
+ "name": "blackouts",
2745
+ "description": "Specified dates that are blacked out on the calendar in ISO8601 format",
2746
+ "type": "RECORD",
2747
+ "fields": [{
2748
+ "mode": "NULLABLE",
2749
+ "name": "value",
2750
+ "type": "STRING"
2751
+ }]
2752
+ },
2753
+ {
2754
+ "mode": "NULLABLE",
2755
+ "name": "earliest",
2756
+ "description": "The earliest date that can be selected on the calendar",
2757
+ "type": "STRING"
2758
+ }
2759
+ ]
2760
+ },
2761
+ {
2762
+ "name": "deliver_on_date",
2763
+ "description": "Deliver on date calendar information",
2764
+ "type": "RECORD",
2765
+ "fields": [
2766
+ {
2767
+ "mode": "NULLABLE",
2768
+ "name": "show",
2769
+ "description": "True if this calendar should be shown to the customer",
2770
+ "type": "BOOLEAN"
2771
+ },
2772
+ {
2773
+ "mode": "NULLABLE",
2774
+ "name": "require",
2775
+ "description": "True if the customer is required to select a date",
2776
+ "type": "BOOLEAN"
2777
+ },
2778
+ {
2779
+ "mode": "REPEATED",
2780
+ "name": "days_of_week",
2781
+ "description": "Days of week that should be enabled on the calendar (0 - Sunday through 6 - Saturday)",
2782
+ "type": "RECORD",
2783
+ "fields": [{
2784
+ "mode": "NULLABLE",
2785
+ "name": "value",
2786
+ "type": "BOOLEAN"
2787
+ }]
2788
+ },
2789
+ {
2790
+ "mode": "REPEATED",
2791
+ "name": "blackouts",
2792
+ "description": "Specified dates that are blacked out on the calendar in ISO8601 format",
2793
+ "type": "RECORD",
2794
+ "fields": [{
2795
+ "mode": "NULLABLE",
2796
+ "name": "value",
2797
+ "type": "STRING"
2798
+ }]
2799
+ },
2800
+ {
2801
+ "mode": "NULLABLE",
2802
+ "name": "earliest",
2803
+ "description": "The earliest date that can be selected on the calendar",
2804
+ "type": "STRING"
2805
+ }
2806
+ ]
2807
+ }
2808
+ ]
2809
+ },
2810
+ {
2811
+ "name": "taxes",
2812
+ "description": "Information on taxes for this cart",
2813
+ "type": "RECORD",
2814
+ "fields": [{
2815
+ "mode": "REPEATED",
2816
+ "name": "counties",
2817
+ "type": "RECORD",
2818
+ "fields": [{
2819
+ "mode": "NULLABLE",
2820
+ "name": "value",
2821
+ "type": "STRING"
2822
+ }]
2823
+ }]
2824
+ }
2825
+ ]
2826
+ },
2827
+ {
2828
+ "mode": "REPEATED",
2829
+ "name": "items",
2830
+ "description": "Items",
2831
+ "type": "RECORD",
2832
+ "fields": [
2833
+ {
2834
+ "mode": "NULLABLE",
2835
+ "name": "position",
2836
+ "description": "Position of the item in the cart",
2837
+ "type": "INTEGER"
2838
+ },
2839
+ {
2840
+ "mode": "NULLABLE",
2841
+ "name": "default_image_url",
2842
+ "description": "URL to the default multimedia image",
2843
+ "type": "STRING"
2844
+ },
2845
+ {
2846
+ "mode": "NULLABLE",
2847
+ "name": "default_thumbnail_url",
2848
+ "description": "URL to the default multimedia thumbnail",
2849
+ "type": "STRING"
2850
+ },
2851
+ {
2852
+ "name": "discount",
2853
+ "description": "The discount on this item provided by a coupon",
2854
+ "type": "RECORD",
2855
+ "fields": [
2856
+ {
2857
+ "mode": "NULLABLE",
2858
+ "name": "value",
2859
+ "description": "Value in base currency",
2860
+ "type": "NUMERIC"
2861
+ },
2862
+ {
2863
+ "mode": "NULLABLE",
2864
+ "name": "localized",
2865
+ "description": "Value localized to the customer",
2866
+ "type": "NUMERIC"
2867
+ },
2868
+ {
2869
+ "mode": "NULLABLE",
2870
+ "name": "localized_formatted",
2871
+ "description": "Value localized and formatted for the customer",
2872
+ "type": "STRING"
2873
+ },
2874
+ {
2875
+ "mode": "NULLABLE",
2876
+ "name": "exchange_rate",
2877
+ "description": "Exchange rate used to localize",
2878
+ "type": "NUMERIC"
2879
+ },
2880
+ {
2881
+ "mode": "NULLABLE",
2882
+ "name": "currency_code",
2883
+ "description": "Currency code of the localized value",
2884
+ "type": "STRING"
2885
+ }
2886
+ ]
2887
+ },
2888
+ {
2889
+ "name": "total_cost",
2890
+ "description": "Total cost of item before discount",
2891
+ "type": "RECORD",
2892
+ "fields": [
2893
+ {
2894
+ "mode": "NULLABLE",
2895
+ "name": "value",
2896
+ "description": "Value in base currency",
2897
+ "type": "NUMERIC"
2898
+ },
2899
+ {
2900
+ "mode": "NULLABLE",
2901
+ "name": "localized",
2902
+ "description": "Value localized to the customer",
2903
+ "type": "NUMERIC"
2904
+ },
2905
+ {
2906
+ "mode": "NULLABLE",
2907
+ "name": "localized_formatted",
2908
+ "description": "Value localized and formatted for the customer",
2909
+ "type": "STRING"
2910
+ },
2911
+ {
2912
+ "mode": "NULLABLE",
2913
+ "name": "exchange_rate",
2914
+ "description": "Exchange rate used to localize",
2915
+ "type": "NUMERIC"
2916
+ },
2917
+ {
2918
+ "mode": "NULLABLE",
2919
+ "name": "currency_code",
2920
+ "description": "Currency code of the localized value",
2921
+ "type": "STRING"
2922
+ }
2923
+ ]
2924
+ },
2925
+ {
2926
+ "name": "total_cost_with_discount",
2927
+ "description": "Total cost of this item after discount",
2928
+ "type": "RECORD",
2929
+ "fields": [
2930
+ {
2931
+ "mode": "NULLABLE",
2932
+ "name": "value",
2933
+ "description": "Value in base currency",
2934
+ "type": "NUMERIC"
2935
+ },
2936
+ {
2937
+ "mode": "NULLABLE",
2938
+ "name": "localized",
2939
+ "description": "Value localized to the customer",
2940
+ "type": "NUMERIC"
2941
+ },
2942
+ {
2943
+ "mode": "NULLABLE",
2944
+ "name": "localized_formatted",
2945
+ "description": "Value localized and formatted for the customer",
2946
+ "type": "STRING"
2947
+ },
2948
+ {
2949
+ "mode": "NULLABLE",
2950
+ "name": "exchange_rate",
2951
+ "description": "Exchange rate used to localize",
2952
+ "type": "NUMERIC"
2953
+ },
2954
+ {
2955
+ "mode": "NULLABLE",
2956
+ "name": "currency_code",
2957
+ "description": "Currency code of the localized value",
2958
+ "type": "STRING"
2959
+ }
2960
+ ]
2961
+ },
2962
+ {
2963
+ "mode": "REPEATED",
2964
+ "name": "schedules",
2965
+ "description": "Customer selectable auto order schedules",
2966
+ "type": "RECORD",
2967
+ "fields": [{
2968
+ "mode": "NULLABLE",
2969
+ "name": "value",
2970
+ "type": "STRING"
2971
+ }]
2972
+ },
2973
+ {
2974
+ "mode": "NULLABLE",
2975
+ "name": "item_oid",
2976
+ "description": "Item object identifier",
2977
+ "type": "INTEGER"
2978
+ },
2979
+ {
2980
+ "mode": "NULLABLE",
2981
+ "name": "item_id",
2982
+ "description": "Item ID",
2983
+ "type": "STRING"
2984
+ },
2985
+ {
2986
+ "mode": "NULLABLE",
2987
+ "name": "description",
2988
+ "description": "Description of the item",
2989
+ "type": "STRING"
2990
+ },
2991
+ {
2992
+ "mode": "NULLABLE",
2993
+ "name": "extended_description",
2994
+ "description": "Extended description of the item",
2995
+ "type": "STRING"
2996
+ },
2997
+ {
2998
+ "mode": "NULLABLE",
2999
+ "name": "quantity",
3000
+ "description": "quantity",
3001
+ "type": "NUMERIC"
3002
+ },
3003
+ {
3004
+ "name": "unit_cost",
3005
+ "description": "Unit cost of the item",
3006
+ "type": "RECORD",
3007
+ "fields": [
3008
+ {
3009
+ "mode": "NULLABLE",
3010
+ "name": "value",
3011
+ "description": "Value in base currency",
3012
+ "type": "NUMERIC"
3013
+ },
3014
+ {
3015
+ "mode": "NULLABLE",
3016
+ "name": "localized",
3017
+ "description": "Value localized to the customer",
3018
+ "type": "NUMERIC"
3019
+ },
3020
+ {
3021
+ "mode": "NULLABLE",
3022
+ "name": "localized_formatted",
3023
+ "description": "Value localized and formatted for the customer",
3024
+ "type": "STRING"
3025
+ },
3026
+ {
3027
+ "mode": "NULLABLE",
3028
+ "name": "exchange_rate",
3029
+ "description": "Exchange rate used to localize",
3030
+ "type": "NUMERIC"
3031
+ },
3032
+ {
3033
+ "mode": "NULLABLE",
3034
+ "name": "currency_code",
3035
+ "description": "Currency code of the localized value",
3036
+ "type": "STRING"
3037
+ }
3038
+ ]
3039
+ },
3040
+ {
3041
+ "name": "unit_cost_with_discount",
3042
+ "description": "Unit cost of the item after discounts",
3043
+ "type": "RECORD",
3044
+ "fields": [
3045
+ {
3046
+ "mode": "NULLABLE",
3047
+ "name": "value",
3048
+ "description": "Value in base currency",
3049
+ "type": "NUMERIC"
3050
+ },
3051
+ {
3052
+ "mode": "NULLABLE",
3053
+ "name": "localized",
3054
+ "description": "Value localized to the customer",
3055
+ "type": "NUMERIC"
3056
+ },
3057
+ {
3058
+ "mode": "NULLABLE",
3059
+ "name": "localized_formatted",
3060
+ "description": "Value localized and formatted for the customer",
3061
+ "type": "STRING"
3062
+ },
3063
+ {
3064
+ "mode": "NULLABLE",
3065
+ "name": "exchange_rate",
3066
+ "description": "Exchange rate used to localize",
3067
+ "type": "NUMERIC"
3068
+ },
3069
+ {
3070
+ "mode": "NULLABLE",
3071
+ "name": "currency_code",
3072
+ "description": "Currency code of the localized value",
3073
+ "type": "STRING"
3074
+ }
3075
+ ]
3076
+ },
3077
+ {
3078
+ "name": "arbitrary_unit_cost",
3079
+ "description": "Arbitrary unit cost",
3080
+ "type": "RECORD",
3081
+ "fields": [
3082
+ {
3083
+ "mode": "NULLABLE",
3084
+ "name": "value",
3085
+ "description": "Value in base currency",
3086
+ "type": "NUMERIC"
3087
+ },
3088
+ {
3089
+ "mode": "NULLABLE",
3090
+ "name": "localized",
3091
+ "description": "Value localized to the customer",
3092
+ "type": "NUMERIC"
3093
+ },
3094
+ {
3095
+ "mode": "NULLABLE",
3096
+ "name": "localized_formatted",
3097
+ "description": "Value localized and formatted for the customer",
3098
+ "type": "STRING"
3099
+ },
3100
+ {
3101
+ "mode": "NULLABLE",
3102
+ "name": "exchange_rate",
3103
+ "description": "Exchange rate used to localize",
3104
+ "type": "NUMERIC"
3105
+ },
3106
+ {
3107
+ "mode": "NULLABLE",
3108
+ "name": "currency_code",
3109
+ "description": "Currency code of the localized value",
3110
+ "type": "STRING"
3111
+ }
3112
+ ]
3113
+ },
3114
+ {
3115
+ "name": "phsyical",
3116
+ "description": "Physical characteristcs",
3117
+ "type": "RECORD",
3118
+ "fields": [
3119
+ {
3120
+ "name": "weight",
3121
+ "description": "Weight",
3122
+ "type": "RECORD",
3123
+ "fields": [
3124
+ {
3125
+ "mode": "NULLABLE",
3126
+ "name": "value",
3127
+ "description": "Weight",
3128
+ "type": "NUMERIC"
3129
+ },
3130
+ {
3131
+ "allowed_values": [
3132
+ "KG",
3133
+ "G",
3134
+ "LB",
3135
+ "OZ"
3136
+ ],
3137
+ "mode": "NULLABLE",
3138
+ "name": "uom",
3139
+ "description": "Unit of measure",
3140
+ "type": "STRING"
3141
+ }
3142
+ ]
3143
+ },
3144
+ {
3145
+ "name": "length",
3146
+ "description": "Length",
3147
+ "type": "RECORD",
3148
+ "fields": [
3149
+ {
3150
+ "mode": "NULLABLE",
3151
+ "name": "value",
3152
+ "description": "The distance measured in UOM",
3153
+ "type": "NUMERIC"
3154
+ },
3155
+ {
3156
+ "allowed_values": [
3157
+ "IN",
3158
+ "CM"
3159
+ ],
3160
+ "mode": "NULLABLE",
3161
+ "name": "uom",
3162
+ "description": "Unit of measure",
3163
+ "type": "STRING"
3164
+ }
3165
+ ]
3166
+ },
3167
+ {
3168
+ "name": "width",
3169
+ "description": "Width",
3170
+ "type": "RECORD",
3171
+ "fields": [
3172
+ {
3173
+ "mode": "NULLABLE",
3174
+ "name": "value",
3175
+ "description": "The distance measured in UOM",
3176
+ "type": "NUMERIC"
3177
+ },
3178
+ {
3179
+ "allowed_values": [
3180
+ "IN",
3181
+ "CM"
3182
+ ],
3183
+ "mode": "NULLABLE",
3184
+ "name": "uom",
3185
+ "description": "Unit of measure",
3186
+ "type": "STRING"
3187
+ }
3188
+ ]
3189
+ },
3190
+ {
3191
+ "name": "height",
3192
+ "description": "Height",
3193
+ "type": "RECORD",
3194
+ "fields": [
3195
+ {
3196
+ "mode": "NULLABLE",
3197
+ "name": "value",
3198
+ "description": "The distance measured in UOM",
3199
+ "type": "NUMERIC"
3200
+ },
3201
+ {
3202
+ "allowed_values": [
3203
+ "IN",
3204
+ "CM"
3205
+ ],
3206
+ "mode": "NULLABLE",
3207
+ "name": "uom",
3208
+ "description": "Unit of measure",
3209
+ "type": "STRING"
3210
+ }
3211
+ ]
3212
+ }
3213
+ ]
3214
+ },
3215
+ {
3216
+ "mode": "NULLABLE",
3217
+ "name": "kit",
3218
+ "description": "True if this item is a kit",
3219
+ "type": "BOOLEAN"
3220
+ },
3221
+ {
3222
+ "mode": "NULLABLE",
3223
+ "name": "auto_order_schedule",
3224
+ "description": "Auto order schedule the customer selected",
3225
+ "type": "STRING"
3226
+ },
3227
+ {
3228
+ "mode": "REPEATED",
3229
+ "name": "options",
3230
+ "description": "Options",
3231
+ "type": "RECORD",
3232
+ "fields": [
3233
+ {
3234
+ "mode": "NULLABLE",
3235
+ "name": "option_oid",
3236
+ "description": "Unique identifier for the option",
3237
+ "type": "INTEGER"
3238
+ },
3239
+ {
3240
+ "mode": "NULLABLE",
3241
+ "name": "name",
3242
+ "description": "Name of the option",
3243
+ "type": "STRING"
3244
+ },
3245
+ {
3246
+ "mode": "NULLABLE",
3247
+ "name": "label",
3248
+ "description": "Display label for the option",
3249
+ "type": "STRING"
3250
+ },
3251
+ {
3252
+ "mode": "NULLABLE",
3253
+ "name": "required",
3254
+ "description": "True if the customer is required to select a value",
3255
+ "type": "BOOLEAN"
3256
+ },
3257
+ {
3258
+ "mode": "NULLABLE",
3259
+ "name": "ignore_if_default",
3260
+ "description": "True if the default answer is ignored",
3261
+ "type": "BOOLEAN"
3262
+ },
3263
+ {
3264
+ "allowed_values": [
3265
+ "single",
3266
+ "multiline",
3267
+ "dropdown",
3268
+ "hidden",
3269
+ "radio",
3270
+ "fixed"
3271
+ ],
3272
+ "mode": "NULLABLE",
3273
+ "name": "type",
3274
+ "description": "Type of option",
3275
+ "type": "STRING"
3276
+ },
3277
+ {
3278
+ "mode": "NULLABLE",
3279
+ "name": "one_time_fee",
3280
+ "description": "Charge the fee a single time instead of multiplying by the quantity",
3281
+ "type": "BOOLEAN"
3282
+ },
3283
+ {
3284
+ "name": "cost_per_line",
3285
+ "description": "Cost per line of text (multiline options)",
3286
+ "type": "RECORD",
3287
+ "fields": [
3288
+ {
3289
+ "mode": "NULLABLE",
3290
+ "name": "value",
3291
+ "description": "Value in base currency",
3292
+ "type": "NUMERIC"
3293
+ },
3294
+ {
3295
+ "mode": "NULLABLE",
3296
+ "name": "localized",
3297
+ "description": "Value localized to the customer",
3298
+ "type": "NUMERIC"
3299
+ },
3300
+ {
3301
+ "mode": "NULLABLE",
3302
+ "name": "localized_formatted",
3303
+ "description": "Value localized and formatted for the customer",
3304
+ "type": "STRING"
3305
+ },
3306
+ {
3307
+ "mode": "NULLABLE",
3308
+ "name": "exchange_rate",
3309
+ "description": "Exchange rate used to localize",
3310
+ "type": "NUMERIC"
3311
+ },
3312
+ {
3313
+ "mode": "NULLABLE",
3314
+ "name": "currency_code",
3315
+ "description": "Currency code of the localized value",
3316
+ "type": "STRING"
3317
+ }
3318
+ ]
3319
+ },
3320
+ {
3321
+ "name": "cost_per_letter",
3322
+ "description": "Cost per letter of text (single or multiline options)",
3323
+ "type": "RECORD",
3324
+ "fields": [
3325
+ {
3326
+ "mode": "NULLABLE",
3327
+ "name": "value",
3328
+ "description": "Value in base currency",
3329
+ "type": "NUMERIC"
3330
+ },
3331
+ {
3332
+ "mode": "NULLABLE",
3333
+ "name": "localized",
3334
+ "description": "Value localized to the customer",
3335
+ "type": "NUMERIC"
3336
+ },
3337
+ {
3338
+ "mode": "NULLABLE",
3339
+ "name": "localized_formatted",
3340
+ "description": "Value localized and formatted for the customer",
3341
+ "type": "STRING"
3342
+ },
3343
+ {
3344
+ "mode": "NULLABLE",
3345
+ "name": "exchange_rate",
3346
+ "description": "Exchange rate used to localize",
3347
+ "type": "NUMERIC"
3348
+ },
3349
+ {
3350
+ "mode": "NULLABLE",
3351
+ "name": "currency_code",
3352
+ "description": "Currency code of the localized value",
3353
+ "type": "STRING"
3354
+ }
3355
+ ]
3356
+ },
3357
+ {
3358
+ "name": "cost_if_specified",
3359
+ "description": "Cost if the option is specified",
3360
+ "type": "RECORD",
3361
+ "fields": [
3362
+ {
3363
+ "mode": "NULLABLE",
3364
+ "name": "value",
3365
+ "description": "Value in base currency",
3366
+ "type": "NUMERIC"
3367
+ },
3368
+ {
3369
+ "mode": "NULLABLE",
3370
+ "name": "localized",
3371
+ "description": "Value localized to the customer",
3372
+ "type": "NUMERIC"
3373
+ },
3374
+ {
3375
+ "mode": "NULLABLE",
3376
+ "name": "localized_formatted",
3377
+ "description": "Value localized and formatted for the customer",
3378
+ "type": "STRING"
3379
+ },
3380
+ {
3381
+ "mode": "NULLABLE",
3382
+ "name": "exchange_rate",
3383
+ "description": "Exchange rate used to localize",
3384
+ "type": "NUMERIC"
3385
+ },
3386
+ {
3387
+ "mode": "NULLABLE",
3388
+ "name": "currency_code",
3389
+ "description": "Currency code of the localized value",
3390
+ "type": "STRING"
3391
+ }
3392
+ ]
3393
+ },
3394
+ {
3395
+ "mode": "NULLABLE",
3396
+ "name": "selected_value",
3397
+ "description": "The value of the option specified by the customer",
3398
+ "type": "STRING"
3399
+ },
3400
+ {
3401
+ "mode": "REPEATED",
3402
+ "name": "values",
3403
+ "description": "Values that the customer can select from for radio or select type options",
3404
+ "type": "RECORD",
3405
+ "fields": [
3406
+ {
3407
+ "mode": "NULLABLE",
3408
+ "name": "value",
3409
+ "description": "Value of the option the customer can select",
3410
+ "type": "STRING"
3411
+ },
3412
+ {
3413
+ "name": "additional_cost",
3414
+ "description": "Additional cost of the item if this option value is selected",
3415
+ "type": "RECORD",
3416
+ "fields": [
3417
+ {
3418
+ "mode": "NULLABLE",
3419
+ "name": "value",
3420
+ "description": "Value in base currency",
3421
+ "type": "NUMERIC"
3422
+ },
3423
+ {
3424
+ "mode": "NULLABLE",
3425
+ "name": "localized",
3426
+ "description": "Value localized to the customer",
3427
+ "type": "NUMERIC"
3428
+ },
3429
+ {
3430
+ "mode": "NULLABLE",
3431
+ "name": "localized_formatted",
3432
+ "description": "Value localized and formatted for the customer",
3433
+ "type": "STRING"
3434
+ },
3435
+ {
3436
+ "mode": "NULLABLE",
3437
+ "name": "exchange_rate",
3438
+ "description": "Exchange rate used to localize",
3439
+ "type": "NUMERIC"
3440
+ },
3441
+ {
3442
+ "mode": "NULLABLE",
3443
+ "name": "currency_code",
3444
+ "description": "Currency code of the localized value",
3445
+ "type": "STRING"
3446
+ }
3447
+ ]
3448
+ },
3449
+ {
3450
+ "name": "additional_weight",
3451
+ "description": "Additional weight of the item if this option is selected",
3452
+ "type": "RECORD",
3453
+ "fields": [
3454
+ {
3455
+ "mode": "NULLABLE",
3456
+ "name": "value",
3457
+ "description": "Weight",
3458
+ "type": "NUMERIC"
3459
+ },
3460
+ {
3461
+ "allowed_values": [
3462
+ "KG",
3463
+ "G",
3464
+ "LB",
3465
+ "OZ"
3466
+ ],
3467
+ "mode": "NULLABLE",
3468
+ "name": "uom",
3469
+ "description": "Unit of measure",
3470
+ "type": "STRING"
3471
+ }
3472
+ ]
3473
+ },
3474
+ {
3475
+ "mode": "NULLABLE",
3476
+ "name": "default_value",
3477
+ "description": "True if this is the default value",
3478
+ "type": "BOOLEAN"
3479
+ },
3480
+ {
3481
+ "mode": "NULLABLE",
3482
+ "name": "display_order",
3483
+ "description": "Display order of the option value",
3484
+ "type": "INTEGER"
3485
+ }
3486
+ ]
3487
+ }
3488
+ ]
3489
+ },
3490
+ {
3491
+ "mode": "REPEATED",
3492
+ "name": "kit_component_options",
3493
+ "description": "Options associated with the kit components",
3494
+ "type": "RECORD",
3495
+ "fields": [
3496
+ {
3497
+ "mode": "NULLABLE",
3498
+ "name": "item_id",
3499
+ "description": "Kit component item id",
3500
+ "type": "STRING"
3501
+ },
3502
+ {
3503
+ "mode": "NULLABLE",
3504
+ "name": "item_oid",
3505
+ "description": "Unique identifier for the kit component item",
3506
+ "type": "INTEGER"
3507
+ },
3508
+ {
3509
+ "mode": "NULLABLE",
3510
+ "name": "option_oid",
3511
+ "description": "Unique identifier for the option",
3512
+ "type": "INTEGER"
3513
+ },
3514
+ {
3515
+ "mode": "NULLABLE",
3516
+ "name": "name",
3517
+ "description": "Name of the option",
3518
+ "type": "STRING"
3519
+ },
3520
+ {
3521
+ "mode": "NULLABLE",
3522
+ "name": "label",
3523
+ "description": "Display label for the option",
3524
+ "type": "STRING"
3525
+ },
3526
+ {
3527
+ "mode": "NULLABLE",
3528
+ "name": "required",
3529
+ "description": "True if the customer is required to select a value",
3530
+ "type": "BOOLEAN"
3531
+ },
3532
+ {
3533
+ "mode": "NULLABLE",
3534
+ "name": "ignore_if_default",
3535
+ "description": "True if the default answer is ignored",
3536
+ "type": "BOOLEAN"
3537
+ },
3538
+ {
3539
+ "allowed_values": [
3540
+ "single",
3541
+ "multiline",
3542
+ "dropdown",
3543
+ "hidden",
3544
+ "radio",
3545
+ "fixed"
3546
+ ],
3547
+ "mode": "NULLABLE",
3548
+ "name": "type",
3549
+ "description": "Type of option",
3550
+ "type": "STRING"
3551
+ },
3552
+ {
3553
+ "mode": "NULLABLE",
3554
+ "name": "one_time_fee",
3555
+ "description": "Charge the fee a single time instead of multiplying by the quantity",
3556
+ "type": "BOOLEAN"
3557
+ },
3558
+ {
3559
+ "name": "cost_per_line",
3560
+ "description": "Cost per line of text (multiline options)",
3561
+ "type": "RECORD",
3562
+ "fields": [
3563
+ {
3564
+ "mode": "NULLABLE",
3565
+ "name": "value",
3566
+ "description": "Value in base currency",
3567
+ "type": "NUMERIC"
3568
+ },
3569
+ {
3570
+ "mode": "NULLABLE",
3571
+ "name": "localized",
3572
+ "description": "Value localized to the customer",
3573
+ "type": "NUMERIC"
3574
+ },
3575
+ {
3576
+ "mode": "NULLABLE",
3577
+ "name": "localized_formatted",
3578
+ "description": "Value localized and formatted for the customer",
3579
+ "type": "STRING"
3580
+ },
3581
+ {
3582
+ "mode": "NULLABLE",
3583
+ "name": "exchange_rate",
3584
+ "description": "Exchange rate used to localize",
3585
+ "type": "NUMERIC"
3586
+ },
3587
+ {
3588
+ "mode": "NULLABLE",
3589
+ "name": "currency_code",
3590
+ "description": "Currency code of the localized value",
3591
+ "type": "STRING"
3592
+ }
3593
+ ]
3594
+ },
3595
+ {
3596
+ "name": "cost_per_letter",
3597
+ "description": "Cost per letter of text (single or multi-line options)",
3598
+ "type": "RECORD",
3599
+ "fields": [
3600
+ {
3601
+ "mode": "NULLABLE",
3602
+ "name": "value",
3603
+ "description": "Value in base currency",
3604
+ "type": "NUMERIC"
3605
+ },
3606
+ {
3607
+ "mode": "NULLABLE",
3608
+ "name": "localized",
3609
+ "description": "Value localized to the customer",
3610
+ "type": "NUMERIC"
3611
+ },
3612
+ {
3613
+ "mode": "NULLABLE",
3614
+ "name": "localized_formatted",
3615
+ "description": "Value localized and formatted for the customer",
3616
+ "type": "STRING"
3617
+ },
3618
+ {
3619
+ "mode": "NULLABLE",
3620
+ "name": "exchange_rate",
3621
+ "description": "Exchange rate used to localize",
3622
+ "type": "NUMERIC"
3623
+ },
3624
+ {
3625
+ "mode": "NULLABLE",
3626
+ "name": "currency_code",
3627
+ "description": "Currency code of the localized value",
3628
+ "type": "STRING"
3629
+ }
3630
+ ]
3631
+ },
3632
+ {
3633
+ "name": "cost_if_specified",
3634
+ "description": "Cost if the option is specified",
3635
+ "type": "RECORD",
3636
+ "fields": [
3637
+ {
3638
+ "mode": "NULLABLE",
3639
+ "name": "value",
3640
+ "description": "Value in base currency",
3641
+ "type": "NUMERIC"
3642
+ },
3643
+ {
3644
+ "mode": "NULLABLE",
3645
+ "name": "localized",
3646
+ "description": "Value localized to the customer",
3647
+ "type": "NUMERIC"
3648
+ },
3649
+ {
3650
+ "mode": "NULLABLE",
3651
+ "name": "localized_formatted",
3652
+ "description": "Value localized and formatted for the customer",
3653
+ "type": "STRING"
3654
+ },
3655
+ {
3656
+ "mode": "NULLABLE",
3657
+ "name": "exchange_rate",
3658
+ "description": "Exchange rate used to localize",
3659
+ "type": "NUMERIC"
3660
+ },
3661
+ {
3662
+ "mode": "NULLABLE",
3663
+ "name": "currency_code",
3664
+ "description": "Currency code of the localized value",
3665
+ "type": "STRING"
3666
+ }
3667
+ ]
3668
+ },
3669
+ {
3670
+ "mode": "NULLABLE",
3671
+ "name": "selected_value",
3672
+ "description": "The value of the option specified by the customer",
3673
+ "type": "STRING"
3674
+ },
3675
+ {
3676
+ "mode": "REPEATED",
3677
+ "name": "values",
3678
+ "description": "Values that the customer can select from for radio or select type options",
3679
+ "type": "RECORD",
3680
+ "fields": [
3681
+ {
3682
+ "mode": "NULLABLE",
3683
+ "name": "value",
3684
+ "description": "Value of the option the customer can select",
3685
+ "type": "STRING"
3686
+ },
3687
+ {
3688
+ "name": "additional_cost",
3689
+ "description": "Additional cost of the item if this option value is selected",
3690
+ "type": "RECORD",
3691
+ "fields": [
3692
+ {
3693
+ "mode": "NULLABLE",
3694
+ "name": "value",
3695
+ "description": "Value in base currency",
3696
+ "type": "NUMERIC"
3697
+ },
3698
+ {
3699
+ "mode": "NULLABLE",
3700
+ "name": "localized",
3701
+ "description": "Value localized to the customer",
3702
+ "type": "NUMERIC"
3703
+ },
3704
+ {
3705
+ "mode": "NULLABLE",
3706
+ "name": "localized_formatted",
3707
+ "description": "Value localized and formatted for the customer",
3708
+ "type": "STRING"
3709
+ },
3710
+ {
3711
+ "mode": "NULLABLE",
3712
+ "name": "exchange_rate",
3713
+ "description": "Exchange rate used to localize",
3714
+ "type": "NUMERIC"
3715
+ },
3716
+ {
3717
+ "mode": "NULLABLE",
3718
+ "name": "currency_code",
3719
+ "description": "Currency code of the localized value",
3720
+ "type": "STRING"
3721
+ }
3722
+ ]
3723
+ },
3724
+ {
3725
+ "name": "additional_weight",
3726
+ "description": "Additional weight of the item if this option is selected",
3727
+ "type": "RECORD",
3728
+ "fields": [
3729
+ {
3730
+ "mode": "NULLABLE",
3731
+ "name": "value",
3732
+ "description": "Weight",
3733
+ "type": "NUMERIC"
3734
+ },
3735
+ {
3736
+ "allowed_values": [
3737
+ "KG",
3738
+ "G",
3739
+ "LB",
3740
+ "OZ"
3741
+ ],
3742
+ "mode": "NULLABLE",
3743
+ "name": "uom",
3744
+ "description": "Unit of measure",
3745
+ "type": "STRING"
3746
+ }
3747
+ ]
3748
+ },
3749
+ {
3750
+ "mode": "NULLABLE",
3751
+ "name": "default_value",
3752
+ "description": "True if this is the default value",
3753
+ "type": "BOOLEAN"
3754
+ },
3755
+ {
3756
+ "mode": "NULLABLE",
3757
+ "name": "display_order",
3758
+ "description": "Display order of the option value",
3759
+ "type": "INTEGER"
3760
+ }
3761
+ ]
3762
+ }
3763
+ ]
3764
+ },
3765
+ {
3766
+ "mode": "REPEATED",
3767
+ "name": "attributes",
3768
+ "description": "Attributes",
3769
+ "type": "RECORD",
3770
+ "fields": [
3771
+ {
3772
+ "mode": "NULLABLE",
3773
+ "name": "name",
3774
+ "description": "Name of the attribute",
3775
+ "type": "STRING"
3776
+ },
3777
+ {
3778
+ "mode": "NULLABLE",
3779
+ "name": "value",
3780
+ "description": "Value of the attribute",
3781
+ "type": "STRING"
3782
+ },
3783
+ {
3784
+ "mode": "NULLABLE",
3785
+ "name": "type",
3786
+ "description": "Type of attribute",
3787
+ "type": "STRING"
3788
+ }
3789
+ ]
3790
+ },
3791
+ {
3792
+ "mode": "NULLABLE",
3793
+ "name": "upsell",
3794
+ "description": "True if this item was added to the cart as part of an upsell",
3795
+ "type": "BOOLEAN"
3796
+ },
3797
+ {
3798
+ "name": "manufacturer_suggested_retail_price",
3799
+ "description": "Manufacture suggested retail price",
3800
+ "type": "RECORD",
3801
+ "fields": [
3802
+ {
3803
+ "mode": "NULLABLE",
3804
+ "name": "value",
3805
+ "description": "Value in base currency",
3806
+ "type": "NUMERIC"
3807
+ },
3808
+ {
3809
+ "mode": "NULLABLE",
3810
+ "name": "localized",
3811
+ "description": "Value localized to the customer",
3812
+ "type": "NUMERIC"
3813
+ },
3814
+ {
3815
+ "mode": "NULLABLE",
3816
+ "name": "localized_formatted",
3817
+ "description": "Value localized and formatted for the customer",
3818
+ "type": "STRING"
3819
+ },
3820
+ {
3821
+ "mode": "NULLABLE",
3822
+ "name": "exchange_rate",
3823
+ "description": "Exchange rate used to localize",
3824
+ "type": "NUMERIC"
3825
+ },
3826
+ {
3827
+ "mode": "NULLABLE",
3828
+ "name": "currency_code",
3829
+ "description": "Currency code of the localized value",
3830
+ "type": "STRING"
3831
+ }
3832
+ ]
3833
+ },
3834
+ {
3835
+ "mode": "REPEATED",
3836
+ "name": "multimedia",
3837
+ "description": "Multimedia",
3838
+ "type": "RECORD",
3839
+ "fields": [
3840
+ {
3841
+ "allowed_values": [
3842
+ "Image",
3843
+ "PDF",
3844
+ "Text",
3845
+ "Unknown",
3846
+ "Video"
3847
+ ],
3848
+ "mode": "NULLABLE",
3849
+ "name": "type",
3850
+ "description": "Type of multimedia",
3851
+ "type": "STRING"
3852
+ },
3853
+ {
3854
+ "mode": "NULLABLE",
3855
+ "name": "is_default",
3856
+ "description": "True if the multimedia is the default for this type",
3857
+ "type": "BOOLEAN"
3858
+ },
3859
+ {
3860
+ "mode": "NULLABLE",
3861
+ "name": "image_width",
3862
+ "description": "Image width",
3863
+ "type": "INTEGER"
3864
+ },
3865
+ {
3866
+ "mode": "NULLABLE",
3867
+ "name": "image_height",
3868
+ "description": "Image height",
3869
+ "type": "INTEGER"
3870
+ },
3871
+ {
3872
+ "mode": "NULLABLE",
3873
+ "name": "url",
3874
+ "description": "URL to view multimedia at",
3875
+ "type": "STRING"
3876
+ },
3877
+ {
3878
+ "mode": "NULLABLE",
3879
+ "name": "description",
3880
+ "description": "Description",
3881
+ "type": "STRING"
3882
+ },
3883
+ {
3884
+ "mode": "NULLABLE",
3885
+ "name": "code",
3886
+ "description": "Code assigned to the multimedia",
3887
+ "type": "STRING"
3888
+ },
3889
+ {
3890
+ "mode": "NULLABLE",
3891
+ "name": "exclude_from_gallery",
3892
+ "description": "True if the image should be excluded from galleries",
3893
+ "type": "BOOLEAN"
3894
+ },
3895
+ {
3896
+ "mode": "REPEATED",
3897
+ "name": "thumbnails",
3898
+ "description": "Thumbnails of the images",
3899
+ "type": "RECORD",
3900
+ "fields": [
3901
+ {
3902
+ "mode": "NULLABLE",
3903
+ "name": "height",
3904
+ "description": "Height in pixels",
3905
+ "type": "INTEGER"
3906
+ },
3907
+ {
3908
+ "mode": "NULLABLE",
3909
+ "name": "width",
3910
+ "description": "Width in pixels",
3911
+ "type": "INTEGER"
3912
+ },
3913
+ {
3914
+ "mode": "NULLABLE",
3915
+ "name": "url",
3916
+ "description": "URL for the thumbnail",
3917
+ "type": "STRING"
3918
+ },
3919
+ {
3920
+ "mode": "NULLABLE",
3921
+ "name": "png",
3922
+ "description": "True if thumbnail is a PNG, otherwise its a JPEG",
3923
+ "type": "BOOLEAN"
3924
+ },
3925
+ {
3926
+ "mode": "NULLABLE",
3927
+ "name": "square",
3928
+ "description": "True if the thumbnail is square",
3929
+ "type": "BOOLEAN"
3930
+ }
3931
+ ]
3932
+ }
3933
+ ]
3934
+ },
3935
+ {
3936
+ "mode": "REPEATED",
3937
+ "name": "variations",
3938
+ "description": "Variations",
3939
+ "type": "RECORD",
3940
+ "fields": [
3941
+ {
3942
+ "mode": "NULLABLE",
3943
+ "name": "variation_name",
3944
+ "description": "Variation name",
3945
+ "type": "STRING"
3946
+ },
3947
+ {
3948
+ "mode": "NULLABLE",
3949
+ "name": "variation_value",
3950
+ "description": "Variation value",
3951
+ "type": "STRING"
3952
+ }
3953
+ ]
3954
+ },
3955
+ {
3956
+ "mode": "NULLABLE",
3957
+ "name": "minimum_quantity",
3958
+ "description": "Minimum quantity the customer can purchase",
3959
+ "type": "NUMERIC"
3960
+ },
3961
+ {
3962
+ "mode": "NULLABLE",
3963
+ "name": "maximum_quantity",
3964
+ "description": "Maximum quantity the customer can purchase",
3965
+ "type": "NUMERIC"
3966
+ },
3967
+ {
3968
+ "mode": "NULLABLE",
3969
+ "name": "view_url",
3970
+ "description": "URL to view the product on the site",
3971
+ "type": "STRING"
3972
+ },
3973
+ {
3974
+ "mode": "NULLABLE",
3975
+ "name": "preorder",
3976
+ "description": "True if this item is on pre-order",
3977
+ "type": "BOOLEAN"
3978
+ },
3979
+ {
3980
+ "mode": "REPEATED",
3981
+ "name": "properties",
3982
+ "description": "Properties associated with the item",
3983
+ "type": "RECORD",
3984
+ "fields": [
3985
+ {
3986
+ "mode": "NULLABLE",
3987
+ "name": "name",
3988
+ "description": "Name",
3989
+ "type": "STRING"
3990
+ },
3991
+ {
3992
+ "mode": "NULLABLE",
3993
+ "name": "value",
3994
+ "description": "Value",
3995
+ "type": "STRING"
3996
+ },
3997
+ {
3998
+ "mode": "NULLABLE",
3999
+ "name": "display",
4000
+ "description": "True if this property is displayed to the customer",
4001
+ "type": "BOOLEAN"
4002
+ },
4003
+ {
4004
+ "mode": "NULLABLE",
4005
+ "name": "expiration_dts",
4006
+ "description": "The date/time that the property expires and is deleted",
4007
+ "type": "DATETIME"
4008
+ }
4009
+ ]
4010
+ }
4011
+ ]
4012
+ },
4013
+ {
4014
+ "name": "affiliate",
4015
+ "description": "Affiliate",
4016
+ "type": "RECORD",
4017
+ "fields": [
4018
+ {
4019
+ "mode": "NULLABLE",
4020
+ "name": "affiliate_id",
4021
+ "description": "Affiliate id associated with the cart",
4022
+ "type": "INTEGER"
4023
+ },
4024
+ {
4025
+ "mode": "NULLABLE",
4026
+ "name": "affiliate_sub_id",
4027
+ "description": "Affiliate sub id associated with the cart",
4028
+ "type": "STRING"
4029
+ }
4030
+ ]
4031
+ },
4032
+ {
4033
+ "mode": "NULLABLE",
4034
+ "name": "logged_in",
4035
+ "description": "True if the customer is logged into their profile",
4036
+ "type": "BOOLEAN"
4037
+ },
4038
+ {
4039
+ "mode": "REPEATED",
4040
+ "name": "properties",
4041
+ "description": "Properties associated with the cart",
4042
+ "type": "RECORD",
4043
+ "fields": [
4044
+ {
4045
+ "mode": "NULLABLE",
4046
+ "name": "name",
4047
+ "description": "Name",
4048
+ "type": "STRING"
4049
+ },
4050
+ {
4051
+ "mode": "NULLABLE",
4052
+ "name": "value",
4053
+ "description": "Value",
4054
+ "type": "STRING"
4055
+ },
4056
+ {
4057
+ "mode": "NULLABLE",
4058
+ "name": "display",
4059
+ "description": "True if this property is displayed to the customer",
4060
+ "type": "BOOLEAN"
4061
+ },
4062
+ {
4063
+ "mode": "NULLABLE",
4064
+ "name": "expiration_dts",
4065
+ "description": "The date/time that the property expires and is deleted",
4066
+ "type": "DATETIME"
4067
+ }
4068
+ ]
4069
+ },
4070
+ {
4071
+ "mode": "NULLABLE",
4072
+ "name": "affiliate_network_pixel_oid",
4073
+ "description": "The affiliate network pixel identifier associated with the cart",
4074
+ "type": "INTEGER"
4075
+ },
4076
+ {
4077
+ "mode": "REPEATED",
4078
+ "name": "utms",
4079
+ "description": "UTM clicks. The zero index is the most recent (last) UTM click. Only available in BigQuery and on an abandon webhook.",
4080
+ "type": "RECORD",
4081
+ "fields": [
4082
+ {
4083
+ "mode": "NULLABLE",
4084
+ "name": "click_dts",
4085
+ "description": "Date/time that the click happened",
4086
+ "type": "DATETIME"
4087
+ },
4088
+ {
4089
+ "mode": "NULLABLE",
4090
+ "name": "utm_source",
4091
+ "type": "STRING"
4092
+ },
4093
+ {
4094
+ "mode": "NULLABLE",
4095
+ "name": "utm_medium",
4096
+ "type": "STRING"
4097
+ },
4098
+ {
4099
+ "mode": "NULLABLE",
4100
+ "name": "utm_campaign",
4101
+ "type": "STRING"
4102
+ },
4103
+ {
4104
+ "mode": "NULLABLE",
4105
+ "name": "utm_term",
4106
+ "type": "STRING"
4107
+ },
4108
+ {
4109
+ "mode": "NULLABLE",
4110
+ "name": "utm_content",
4111
+ "type": "STRING"
4112
+ },
4113
+ {
4114
+ "mode": "NULLABLE",
4115
+ "name": "utm_id",
4116
+ "type": "STRING"
4117
+ },
4118
+ {
4119
+ "mode": "NULLABLE",
4120
+ "name": "facebook_ad_id",
4121
+ "type": "STRING"
4122
+ },
4123
+ {
4124
+ "mode": "NULLABLE",
4125
+ "name": "uc_message_id",
4126
+ "type": "STRING"
4127
+ },
4128
+ {
4129
+ "mode": "NULLABLE",
4130
+ "name": "glcid",
4131
+ "type": "STRING"
4132
+ },
4133
+ {
4134
+ "mode": "NULLABLE",
4135
+ "name": "wbraid",
4136
+ "type": "STRING"
4137
+ },
4138
+ {
4139
+ "mode": "NULLABLE",
4140
+ "name": "gbraid",
4141
+ "type": "STRING"
4142
+ },
4143
+ {
4144
+ "mode": "NULLABLE",
4145
+ "name": "msclkid",
4146
+ "type": "STRING"
4147
+ },
4148
+ {
4149
+ "mode": "NULLABLE",
4150
+ "name": "fbclid",
4151
+ "type": "STRING"
4152
+ },
4153
+ {
4154
+ "mode": "NULLABLE",
4155
+ "name": "ttclid",
4156
+ "type": "STRING"
4157
+ },
4158
+ {
4159
+ "mode": "NULLABLE",
4160
+ "name": "vmcid",
4161
+ "type": "STRING"
4162
+ },
4163
+ {
4164
+ "mode": "NULLABLE",
4165
+ "name": "attribution_first_click_total",
4166
+ "type": "NUMERIC"
4167
+ },
4168
+ {
4169
+ "mode": "NULLABLE",
4170
+ "name": "attribution_first_click_subtotal",
4171
+ "type": "NUMERIC"
4172
+ },
4173
+ {
4174
+ "mode": "NULLABLE",
4175
+ "name": "attribution_last_click_total",
4176
+ "type": "NUMERIC"
4177
+ },
4178
+ {
4179
+ "mode": "NULLABLE",
4180
+ "name": "attribution_last_click_subtotal",
4181
+ "type": "NUMERIC"
4182
+ },
4183
+ {
4184
+ "mode": "NULLABLE",
4185
+ "name": "attribution_linear_total",
4186
+ "type": "NUMERIC"
4187
+ },
4188
+ {
4189
+ "mode": "NULLABLE",
4190
+ "name": "attribution_linear_subtotal",
4191
+ "type": "NUMERIC"
4192
+ },
4193
+ {
4194
+ "mode": "NULLABLE",
4195
+ "name": "attribution_position_based_total",
4196
+ "type": "NUMERIC"
4197
+ },
4198
+ {
4199
+ "mode": "NULLABLE",
4200
+ "name": "attribution_position_based_subtotal",
4201
+ "type": "NUMERIC"
4202
+ },
4203
+ {
4204
+ "mode": "NULLABLE",
4205
+ "name": "itm_source",
4206
+ "type": "STRING"
4207
+ },
4208
+ {
4209
+ "mode": "NULLABLE",
4210
+ "name": "itm_medium",
4211
+ "type": "STRING"
4212
+ },
4213
+ {
4214
+ "mode": "NULLABLE",
4215
+ "name": "itm_campaign",
4216
+ "type": "STRING"
4217
+ },
4218
+ {
4219
+ "mode": "NULLABLE",
4220
+ "name": "itm_term",
4221
+ "type": "STRING"
4222
+ },
4223
+ {
4224
+ "mode": "NULLABLE",
4225
+ "name": "itm_content",
4226
+ "type": "STRING"
4227
+ },
4228
+ {
4229
+ "mode": "NULLABLE",
4230
+ "name": "itm_id",
4231
+ "type": "STRING"
4232
+ },
4233
+ {
4234
+ "mode": "NULLABLE",
4235
+ "name": "short_code",
4236
+ "type": "STRING"
4237
+ },
4238
+ {
4239
+ "mode": "NULLABLE",
4240
+ "name": "short_code_backup",
4241
+ "type": "BOOLEAN"
4242
+ }
4243
+ ]
4244
+ }
4245
+ ]