Reference
Input files
Look up the fields accepted by order, product, gallery, and preview files.
Order JSON
Use a UTF-8 JSON object. Add buyer_user_id for a registered account, or set as_guest to true and provide customer_name, email, and whatsapp. Use the returned buyer ID from orders options.
| Field | Accepted value |
|---|---|
fulfillment_method |
ship, the default |
goods_payment_method |
bank_transfer or zelle in v0.3.0 |
ship_destination |
Optional two-letter uppercase country code matching the shipping address |
ship_address |
Required object with address1, city, state, zip, and country. Optional name, address2, phone, and email |
bill_address |
Optional object with the same shape as the shipping address |
items |
1–200 objects, each with sku, positive integer qty, and set_type of hats_only or full_set. Each SKU and set type pair is unique. |
customer_name, store_name, email, additional_email, whatsapp, ig_username |
Buyer and contact details as needed |
mexico_customs |
Required when the shipping address is in Mexico |
For Mexico, the importer object includes tax_id_type (rfc, curp, foreign_tax_id, or passport), tax_id, full_legal_name, street_name, exterior_number, colonia, municipality, locality, state, postal_code, and legal_name_confirmed: true. Add interior_number when applicable. The Portal validates the details and enforces current requirements. See the order example.
Product create JSON
Supply sku, name, price_cents, availability, and count_stock. SKUs use 2–32 uppercase letters, digits, underscores, or hyphens. Choose an explicit SKU. Availability is available_now or sold_out. If counting stock, include a whole-number stock.
Optional fields include description, hats_only_price_cents, full_set_price_cents, item_type (product or accessory), drop_name, and require_nfc. An accessory has zero prices. See the create example.
Product update JSON
Provide one or more of the fields you intend to change. All prices use integer cents.
| Fields | Purpose |
|---|---|
name, description, category_tag, display_order |
Product details and display |
price_cents, hats_only_price_cents, full_set_price_cents |
Wholesale price tiers |
availability, stock, count_stock |
Manual availability and catalog quantity |
item_type, require_nfc |
Product or accessory type and NFC requirement |
customs_description, customs_material, customs_origin_country, customs_hs_code, customs_unit_weight_oz |
Customs details, with country as a two-letter code and weight in ounces |
Use the collections workflow for collection assignments.
Gallery order JSON
Save a JSON array containing each current photo key exactly once, in the order you want. Read the keys from finoctl wholesale products images list "$SKU". The first key becomes the cover.
Preview files
The CLI creates a fresh file at the path passed to --out and prints its checksum. Keep preview and input files private, especially when they contain buyer or customs details. Apply the reviewed preview using its checksum and preserve its original operation ID for reconciliation.