logo
Powered by Redocly

Schema

WP EasyCart maintains schema for key elements in the API.

Address

address_id
integer

The unique ID for the address.

first_name
string

Customer first name

last_name
string

Customer last name

company_name
string

Customer company name

address_line_1
string

Customer address line 1

address_line_2
string

Customer address line 2

city
string

Customer city

state
string

Customer state, province, territory, or other division

zip
string

Customer zip or postal code

country
string

Customer country code

phone
string

Customer phone

{
  • "address_id": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "company_name": "string",
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "string",
  • "phone": "string"
}

Category

category_id
integer

The unique ID for the category in WP EasyCart. Leave blank if you are adding or updating.

post_id
integer

The unqiue post ID to connect this item to WordPress

parent_id
integer

The category_id connecting this to another WP EasyCart category

enabled
boolean

True to enable this on your store.

featured
boolean

True to make a featured category, which may apply if your is setup to use this option.

category_name
string

The category name.

short_description
string

Optional description for this category

category_image
string

Optional banner image for this category, should be a URL.

priority
integer

The sort order of category, higher numbers are higher priority.

square_id
string

The unqiue ID connecting this item to SquareUp, if enabled in your store.

{
  • "category_id": 0,
  • "post_id": 0,
  • "parent_id": 0,
  • "enabled": true,
  • "featured": true,
  • "category_name": "string",
  • "short_description": "string",
  • "category_image": "string",
  • "priority": 0,
  • "square_id": "string"
}

Country

country_id
integer

The internal ID for this country

name_cnt
string

The full name of this country

enabled
boolean

True to enable this on your store.

iso2_cnt
string

The 2 character code for this country.

iso3_cnt
string

The 3 character code for this country.

vat_rate
number

VAT rate by country, custom to this country.

stripe_taxrate_id
string

Stripe ID to link to your Stripe account tax rate.

vat_b2b_enabled
boolean

Should VAT be charged for businesses in this country.

{
  • "country_id": 0,
  • "name_cnt": "string",
  • "enabled": true,
  • "iso2_cnt": "string",
  • "iso3_cnt": "string",
  • "vat_rate": 0,
  • "stripe_taxrate_id": "string",
  • "vat_b2b_enabled": true
}

CustomerReview

review_id
integer

The unique review ID.

product_id
integer

The product this review applies to.

user_id
integer

The user, if applicable, that posted this review. Use 0 for no user connection (or guest).

approved
boolean

If true, this is approved and shows on the store.

rating
integer

The rating (1-5) of the review.

title
string

The review title by the customer.

review_description
string

The content of the review.

date_submitted
string

The timestamp of when the review was submitted.

reviewer_name
string

The name entered for the reviewer (if applicable).

{
  • "review_id": 0,
  • "product_id": 0,
  • "user_id": 0,
  • "approved": true,
  • "rating": 0,
  • "title": "string",
  • "review_description": "string",
  • "date_submitted": "string",
  • "reviewer_name": "string"
}

Deconetwork

enabled
boolean

True to enable this as a deconetwork product.

mode
string

The mode, typically designer

product_id
string

Deconetwork product ID

size_id
string

Deconetwork size ID

color_id
string

Deconetwork color ID

design_id
string

Deconetwork design ID

{
  • "enabled": true,
  • "mode": "string",
  • "product_id": "string",
  • "size_id": "string",
  • "color_id": "string",
  • "design_id": "string"
}

Dimensions

weight
number

The weight of the product

length
number

the lenght of the product in the default dimensions of your store.

width
number

the width of the product in the default dimensions of your store.

height
number

the height of the product in the default dimensions of your store.

{
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0
}

Download

enabled
boolean

True will make this a download product

file_name
string

The file name of the download that is available in the WordPress wp-content/uploads/wp-easycart/ folder. You may also use a full URL.

max_downloads
integer

The maximum allowed times to download.

max_seconds
integer

The timeout of this download in seconds, from the time of purchase.

is_amazon
boolean

Is the download hosted on Amazon S3

amazon_key
string

This is the key for the file on Amazon S3

{
  • "enabled": true,
  • "file_name": "string",
  • "max_downloads": 0,
  • "max_seconds": 0,
  • "is_amazon": true,
  • "amazon_key": "string"
}

Flexfee

fee_id
integer

The internal ID for this flex-fee

fee_label
string

The label for the fee shown to admin and shopper.

fee_description
string

A description in the form of a list of requirements for the fee.

countries
string

Optional, comma separated list, of 2-character country code(s) (typically iso2_cnt).

states
string

Optional, comma separated list, of 2-character state code.

cities
string

Optional, comma separated list, of city names.

postal_codes
string

Optional, comma separated list, of postal codes.

categories
string

Optional, comma separated list, of category IDs.

roles
string

Optional, comma separated list, of user roles.

zones
string

Optional, comma separated list, of shipping zone IDs.

fee_type
number

Types may be 1 (Rate Fee) or 2 (Price Fee).

rate
number

The percentage of this fee when it applies and the type is a rate type fee.

price
number

The price or amount to apply when this fee applies and is a price fee type.

min
number

The minimum charge, applicable only for rate based fees.

max
number

The maximum charge, applicable only for rate based fees.

payment_types
string

Optional, comma separated list, of payment types in which this fee applies. Possible values are card, affirm, klarna, afterpay_clearpay, third_party, amazonpay, or manual_bill. Types affirm, klarna, and afterpay_clearpay only apply to Stripe payments.

{
  • "fee_id": 0,
  • "fee_label": "string",
  • "fee_description": "string",
  • "countries": "string",
  • "states": "string",
  • "cities": "string",
  • "postal_codes": "string",
  • "categories": "string",
  • "roles": "string",
  • "zones": "string",
  • "fee_type": 0,
  • "rate": 0,
  • "price": 0,
  • "min": 0,
  • "max": 0,
  • "payment_types": "string"
}

FeaturedProducts

featured_product_1
integer

The unique product ID in the WP EasyCart.

featured_product_2
integer

The unique product ID in the WP EasyCart.

featured_product_3
integer

The unique product ID in the WP EasyCart.

featured_product_4
integer

The unique product ID in the WP EasyCart.

{
  • "featured_product_1": 0,
  • "featured_product_2": 0,
  • "featured_product_3": 0,
  • "featured_product_4": 0
}

Gateway

gateway
string

The gateway used for this payment.

transaction_id
string

The transaction id or string for a payment

stripe_charge_id
string

This applies only to a stripe payment

nets_transaction_id
string

This applies only to a nets payment

paypal_email_id
string

This applies only to a PayPal payment

paypal_transaction_id
string

This applies only to a PayPal payment

paypal_payer_id
string

This applies only to a PayPal payment

{
  • "gateway": "string",
  • "transaction_id": "string",
  • "stripe_charge_id": "string",
  • "nets_transaction_id": "string",
  • "paypal_email_id": "string",
  • "paypal_transaction_id": "string",
  • "paypal_payer_id": "string"
}

Giftcard

giftcard_id
string

The unique, redeemable ID and should be 12 characters.

amount
number

The amount available on the giftcard.

message
string

The redeem message to the customer

{
  • "giftcard_id": "string",
  • "amount": 0,
  • "message": "string"
}

Images

enable_option_images
boolean

If true, images wil be shown as an array for each variant or modifier.

images_use_modifier
boolean

If true, and enable_option_images true, option images will apply to the first modifier attached to the product.

Array of objects (ImagesGroupArray)
Array of objects (ImagesOptionsArray)

Does not apply to adding a new product.

{
  • "enable_option_images": true,
  • "images_use_modifier": true,
  • "product_images": [
    ],
  • "option_images": [
    ]
}

ImagesGroup

type
string

The type of item. Valid values can be image, video, vimeo, youtube, media.

value
any

Values should always be a url except media types, which are a media library ID.

{
  • "type": "string",
  • "value": null
}

ImagesOption

optionitem_id
integer

The option item that this applies to.

product_id
integer

The product that this applies to.

Array of objects (ImagesGroupArray)
{
  • "optionitem_id": 0,
  • "product_id": 0,
  • "images": [
    ]
}

Manufacturer

manufacturer_id
integer

The ID of the manufacturer. Leave blank when adding a new manufacturer or sending an update.

manufacturer_name
string

The name of the manufacturer

clicks
integer

Number of times this has been viewed

post_id
integer

The post ID in WordPress for this store_item in your store.

{
  • "manufacturer_id": 0,
  • "manufacturer_name": "string",
  • "clicks": 0,
  • "post_id": 0
}

MenuItem

level
integer

The level of this menu item, must be 1-3.

menu_id
integer

The unique ID of this menu item in WP EasyCart

post_id
integer

The unique ID of this item in WordPress

menu_name
string

The name of this menu.

sort_order
integer

The sort order of this menu item.

clicks
integer

The number of views/clicks for this menu item.

banner_image
string

The image that can show on the menu page, should be a URL.

seo_description
string

The meta description for this menu.

seo_keywords
string

The meta keywords for this menu.

{
  • "level": 0,
  • "menu_id": 0,
  • "post_id": 0,
  • "menu_name": "string",
  • "sort_order": 0,
  • "clicks": 0,
  • "banner_image": "string",
  • "seo_description": "string",
  • "seo_keywords": "string"
}

MenuLocation

object (MenuItem)
object (MenuItem)
object (MenuItem)
{
  • "level_1": {
    },
  • "level_2": {
    },
  • "level_3": {
    }
}

Modifier

modifier_id
integer

The unique modifier ID in the WP EasyCart.

modifier_name
string

The internal name for this modifier set

modifier_label
string

The customer facing label for this modifier.

modifier_type
string

The type and can be combo, swatch, text, textarea, number, file, radio, checkbox, grid, date, dimensions1, or dimensions2.

object (ModifierMeta)
Array of objects (ModifierItemArray)
is_required
boolean

Is this modifier set required

error_message
string

The message shown to the customer when the modifier is not yet selected.

square_id
string

The SquareUp internal ID that this item connects to, if applicable.

{
  • "modifier_id": 0,
  • "modifier_name": "string",
  • "modifier_label": "string",
  • "modifier_type": "string",
  • "modifier_meta": {
    },
  • "modifier_items": [
    ],
  • "is_required": true,
  • "error_message": "string",
  • "square_id": "string"
}

ModifierAdjustment

type
string

Type of adjustment, can be basic, onetime, override, multiply, or perchar

adjustment
number

The amount to be adjusted, can be positive or negative.

{
  • "type": "string",
  • "adjustment": 0
}

ModifierItem

optionitem_id
integer

The unique ID for this modifier item in the WP EasyCart system.

option_id
integer

The unique ID for the modifier set this item connects.

item_name
string

The label for this modifier item.

sort_order
integer

The sort order for this modifier item.

sku_extension
string

This will extend the product SKU when modifier item is selected.

swatch_icon
string

Add a custom swatch icon, if this modifier item is a swatch.

default_selected
boolean

If this is a modifier item in a list of items, true will make this the initially selected item.

default_value
string

If this is a single modifier item like a text, text area, number, etc... This is the default value.

object (ModifierAdjustment)
object (ModifierAdjustment)
enable_custom_price_label
boolean

True will enable the custom_price_label to show in place of the price adjustment

custom_price_label
string

The custom price label used if enabled.

download_allowed
boolean

This item may disable the product download, if false.

download_override_file
string

You may override the product download with this file, should be a URL.

download_additional_file
string

You may add an additional file to a product download when this option is selected, should be a URL.

block_shipping
boolean

If true, the product is no longer shippable.

square_id
string

The unique SquareUp ID used when connecting your store to Square.

stripe_plan_id
string

The unique ID for Stripe when you use this with a subscription.

{
  • "optionitem_id": 0,
  • "option_id": 0,
  • "item_name": "string",
  • "sort_order": 0,
  • "sku_extension": "string",
  • "swatch_icon": "string",
  • "default_selected": true,
  • "default_value": "string",
  • "price_adjustment": {
    },
  • "weight_adjustment": {
    },
  • "enable_custom_price_label": true,
  • "custom_price_label": "string",
  • "download_allowed": true,
  • "download_override_file": "string",
  • "download_additional_file": "string",
  • "block_shipping": true,
  • "square_id": "string",
  • "stripe_plan_id": "string"
}

Order

order_id
integer

The order ID for the WP EasyCart. Leave blank if adding new or updating your order.

order_date
string <date-time>

The order date and time in format YYYY-MM-DD HH:MM:SS

object (OrderStatus)
guest_key
string

The unique key for an order to be viewed without having to log into the user account.

subscription_id
integer

The subscription ID if this connects to a subscription order.

viewed
boolean

The control if this order has been viewed

success_page_shown
boolean

This helps prevent double calls of javascript on success page view.

weight
number

The order status ID

promocode
string

The coupon code, if used for this order

giftcard
string

The gift card ID, if used for this order

order_notes_admin
string

The admin order notes.

order_notes_customer
string

The customer order notes.

object (Totals)
object (TaxRates)
object (Shipping)
object (User)
object (Payment)
object (Gateway)
object (QuickbooksOrder)
object (Terms)
{
  • "order_id": 0,
  • "order_date": "2019-08-24T14:15:22Z",
  • "order_status": {
    },
  • "guest_key": "string",
  • "subscription_id": 0,
  • "viewed": true,
  • "success_page_shown": true,
  • "weight": 0,
  • "promocode": "string",
  • "giftcard": "string",
  • "order_notes_admin": "string",
  • "order_notes_customer": "string",
  • "totals": {
    },
  • "taxrates": {
    },
  • "shipping": {
    },
  • "user": {
    },
  • "payment": {
    },
  • "gateway": {
    },
  • "quickbooks": {
    },
  • "terms": {
    }
}

OrderStatus

status_id
integer

The order status ID

order_status
string

The order status label

is_approved
boolean

Is this an approved order status type

is_archieved
boolean

Is this an archieved order status

{
  • "status_id": 0,
  • "order_status": "string",
  • "is_approved": true,
  • "is_archieved": true
}

Payment

method
string

The payment method used

card_holder_name
string

If card used, the card holder name entered

last4
string

If card used, the last 4 digits of the payment method

exp_month
integer

If card used, the expiration month

exp_year
string

If card used, the expiration year

{
  • "method": "string",
  • "card_holder_name": "string",
  • "last4": "string",
  • "exp_month": 0,
  • "exp_year": "string"
}

Pricing

price
string

Main price for a product

list_price
number

Optional discounted price for a product

product_cost
number

Cost of the product for internal use or accounting

object (PricingRange)
object (PricingRestrict)
object (PricingLabel)
{
  • "price": "string",
  • "list_price": 0,
  • "product_cost": 0,
  • "custom_price_range": {
    },
  • "restrict_pricing": {
    },
  • "price_label": {
    }
}

PricingLabel

enable
boolean

Enable a custom pricing label for this product.

replace
boolean

If true, the price label will replace the actual price in the display, otherwise it will show alongside the price.

label
string

The label to show the customer.

{
  • "enable": true,
  • "replace": true,
  • "label": "string"
}

PricingRange

enable
boolean

True to enable this feature.

range_low
number

Low end value for pricing range.

range_high
number

High end value for a pricing range.

{
  • "enable": true,
  • "range_low": 0,
  • "range_high": 0
}

Product

product_id
integer

The product ID for the item in WP EasyCart. Leave blank if adding new or updating a product.

sku
string

The model number / SKU

post_id
integer

The post ID in WordPress for this item.

active
boolean

Is this item activated in your store.

is_main
boolean

Should we show this product on the main store page

sort_position
integer

The default sort order.

title
string

The product title

description
string

The full description for the product

short_description
string

The short description for the product

specifications
string

The full specs for the product

object (Pricing)
object (ProductQuantity)
object (Images)
object (ProductShipping)
object (ProductTax)
object (Seo)
object (CustomerReviews)
object (Manufacturer)
object (Download)
object (Variants)
Array of objects (ModifiersArray)
Array of objects (CategoriesArray)
object (MenuLocations)
object (FeaturedProducts)
object (ProductSubscription)
object (ProductOrderNotes)
role_id
integer

Restrict this product to a specific user role id

is_giftcard
boolean

Is this a giftcard item

is_donation
boolean

Is this a donation item

is_special
boolean

Is this item on the special widget

object (ProductStats)
object (QuickbooksProduct)
object (ProductSeasonal)
object (ProductInquiry)
object (Deconetwork)
object (ProductDisplay)
square_id
string

The SquareUp ID for this product, used for syncing.

square_variation_id
string

The variation ID for this product, which is sometimes applicable.

{
  • "product_id": 0,
  • "sku": "string",
  • "post_id": 0,
  • "active": true,
  • "is_main": true,
  • "sort_position": 0,
  • "title": "string",
  • "description": "string",
  • "short_description": "string",
  • "specifications": "string",
  • "pricing": {
    },
  • "quantity": {
    },
  • "images": {
    },
  • "shipping": {
    },
  • "tax": {
    },
  • "seo": {
    },
  • "reviews": {
    },
  • "manufacturer": {
    },
  • "download": {
    },
  • "variants": {
    },
  • "modifiers": [
    ],
  • "categories": [
    ],
  • "menu": {
    },
  • "featured_products": {
    },
  • "subscription": {
    },
  • "order_notes": {
    },
  • "role_id": 0,
  • "is_giftcard": true,
  • "is_donation": true,
  • "is_special": true,
  • "stats": {
    },
  • "quickbooks": {
    },
  • "seasonal": {
    },
  • "inquiry": {
    },
  • "deconetwork": {
    },
  • "display": {
    },
  • "square_id": "string",
  • "square_variation_id": "string"
}

ProductDisplay

display_type
integer

This is the default product design type, 1-6, for the WP EasyCart.

image_effect
integer

The effect of the image, 0 None, 1 Border, 2 Shadow

hover_type
integer

This is the default hover type, 1 Flip, 2 Crossfade, 3 Lighten, 4 No Effect, 5 Grow, 6 Shrink, 7 Greyscale, 8 Brighten, 9 Slide, 10 Flipbook

tag_type
integer

The tag type display, 0 No tag, 1 Round, 2 Square, 3 Diagonal, 4 Classy

tag_bg_color
string

The hex color of the tag background

tag_text_color
string

The hex color of the tag text

tag_text
string

The text inside the tag

{
  • "display_type": 0,
  • "image_effect": 0,
  • "hover_type": 0,
  • "tag_type": 0,
  • "tag_bg_color": "string",
  • "tag_text_color": "string",
  • "tag_text": "string"
}

ProductInquiry

enabled
boolean

True to enable this as an inquiry product.

url
string

Optional URL to send a customer to, which is useful to submit form data to a custom URL.

{
  • "enabled": true,
  • "url": "string"
}

ProductOrderNotes

success_note
string

The note added to the order success page for the customer.

email_note
string

The note added to the email receipt.

order_details_note
string

The note added to the order details.

{
  • "success_note": "string",
  • "email_note": "string",
  • "order_details_note": "string"
}

ProductQuantity

enabled
boolean

Is tracking enabled for this product.

enable_variant_tracking
boolean

Is variant quantity tracking enabled for this product.

object (ProductStock)
min_allowed
integer

The minimum required by the customer.

max_allowed
integer

The maximum allowed for a customer.

allow_backorders
boolean

Allow a user to buy more than in stock.

backorder_fill_date
string

Shown to the customer when a backorder has occurred.

{
  • "enabled": true,
  • "enable_variant_tracking": true,
  • "stock_quantity": {
    },
  • "min_allowed": 0,
  • "max_allowed": 0,
  • "allow_backorders": true,
  • "backorder_fill_date": "string"
}

ProductSeasonal

enabled
boolean

True to enable seasonal mode.

phrase
string

Phrase to show the customer when this is enabled.

{
  • "enabled": true,
  • "phrase": "string"
}

ProductShipping

enabled
boolean

Is shipping enabled for this product.

exclude_from_calculation
boolean

Use this to force the shipping address and rate, but exclude this product from that calculation.

object (Dimensions)
handling_price
number

The handling price added one-time when the product is added to the cart.

handling_price_each
number

The handling price added and multiplied by the quantity in the cart.

shipping_class_id
integer

Shipping classes are not used in the cart, but used for extensions.

ship_to_billing
boolean

Force this item to ship to the customer billing address only.

zone_restriction_id
integer

Only allow shipping to this shipping zone id, leave as 0 for no restrictions.

{
  • "enabled": true,
  • "exclude_from_calculation": true,
  • "dimensions": {
    },
  • "handling_price": 0,
  • "handling_price_each": 0,
  • "shipping_class_id": 0,
  • "ship_to_billing": true,
  • "zone_restriction_id": 0
}

ProductStats

views
integer

The total views of this product.

last_viewed
string

Last time this was viewed.

{
  • "views": 0,
  • "last_viewed": "string"
}

ProductStock

stock_quantity
integer

The base stock quantity, used if basic stock quantity is enabled.

Array of objects (VariantStockItem)

The variant stock information, which is an array of variant stock tracking.

{
  • "stock_quantity": 0,
  • "variant_stock": [
    ]
}

ProductSubscription

enabled
boolean

Is this product a subscription.

bill_length
integer

Number of bill period between payments, for example 2 for every 2 months.

bill_period
string

The bill period, must be W for Weekly, M for Monthly, or Y for Yearly.

bill_duration
integer

Leave 0 if this subscription goes on forever. This only is needed if you wish to limit payments. For example, you want a customer to pay 12 equal monthly payments, enter 12 to end after 12 payments.

email_recurring
boolean

True if an email should send for every payment.

shipping_recurring
boolean

True if your shipping charge need to happen every month or get a single charge on initial sign up.

trial_days
integer

Optionally enter a trial period in days. Leave 0 if no trial.

object (SubscriptionPlan)
allow_multiple
boolean

Can a customer buy this more than one time.

membership_page
string

If this is connected to membership content, enter the URL here.

signup_fee
number

This allows you to add a signup fee, or a one-time fee charged on purchase.

stripe_product_id
integer

This is the unique Product ID used at Stripe.

stripe_default_price_id
integer

This is the unique Price ID used at Stripe.

prorate
boolean

This determines how billing is handled when subscriptions change. Prorating will adjust billing immediately, without prorating the billing will only change on the next invoice.

{
  • "enabled": true,
  • "bill_length": 0,
  • "bill_period": "string",
  • "bill_duration": 0,
  • "email_recurring": true,
  • "shipping_recurring": true,
  • "trial_days": 0,
  • "subscription_plan": {
    },
  • "allow_multiple": true,
  • "membership_page": "string",
  • "signup_fee": 0,
  • "stripe_product_id": 0,
  • "stripe_default_price_id": 0,
  • "prorate": true
}

ProductTax

enable_tax
boolean

True will enable tax on this product. This includes all tax types EXCEPT VAT.

enable_vat
boolean

True will enable VAT rates on this product.

tic
string

TIC Code for TaxCloud

{
  • "enable_tax": true,
  • "enable_vat": true,
  • "tic": "string"
}

Quickbooks

list_id
string

List ID for a Quickbooks item.

edit_sequence
string

Edit sequence for a Quickbooks transaction

quickbooks_status
string

Status used for a Quickbooks transaction

txn_id
string

Transaction ID for a Quickbooks transaction

payment_txn_id
string

Payment transaction ID for a Quickbooks transaction

credit_memo_txn_id
string

Credit memo transaction ID for a Quickbooks transaction

income_account_ref
string

The income account reference, if applicable.

cogs_account_ref
string

The cogs account reference, if applicable.

asset_account_ref
string

The asset account reference, if applicable.

parent_name
string

The parent reference in Quickbooks, if applicable.

parent_list_id
string

The parent list id reference in Quickbooks, if applicable.

{
  • "list_id": "string",
  • "edit_sequence": "string",
  • "quickbooks_status": "string",
  • "txn_id": "string",
  • "payment_txn_id": "string",
  • "credit_memo_txn_id": "string",
  • "income_account_ref": "string",
  • "cogs_account_ref": "string",
  • "asset_account_ref": "string",
  • "parent_name": "string",
  • "parent_list_id": "string"
}

Seo

seo_description
string

The post meta description

seo_keywords
string

The post meta keywords

post_excerpt
string

The post excerpt to attach to a product post item, which is sometimes used in some places of a theme.

{
  • "seo_description": "string",
  • "seo_keywords": "string",
  • "post_excerpt": "string"
}

Shipping

method
string

The shipping method label

carrier
string

The shipping carrier of the shipment

service_code
string

The service code of the shipment

tracking_number
string

The tracking number for the shipment

use_expedited_shipping
boolean

This can apply to basic shipping methods

fraktjakt_order_id
string

The order id from Fraktjakt if you use this shipping method.

fraktjakt_shipment_id
string

The shipment id from Fraktjakt if you use this shipping method.

{
  • "method": "string",
  • "carrier": "string",
  • "service_code": "string",
  • "tracking_number": "string",
  • "use_expedited_shipping": true,
  • "fraktjakt_order_id": "string",
  • "fraktjakt_shipment_id": "string"
}

SubscriptionPlan

plan_id
integer

The internal ID this subscription plan, which is used to group subscription products.

plan_title
string

The title for this subscription plan.

can_downgrade
boolean

Allow your customers to downgrade their subscription within the plan on their own. Disabled only allows them to switch to a higher priced subscription.

{
  • "plan_id": 0,
  • "plan_title": "string",
  • "can_downgrade": true
}

TaxRates

vat_rate
number

VAT Rate percentage, e.g. 10.45

gst_rate
number

GST Rate percentage, e.g. 10.45

hst_rate
number

HST Rate percentage, e.g. 10.45

pst_rate
number

PST Rate percentage, e.g. 10.45

{
  • "vat_rate": 0,
  • "gst_rate": 0,
  • "hst_rate": 0,
  • "pst_rate": 0
}

Terms

agreed_to_terms
boolean

Have the terms been agreed to during checkout

order_ip_address
string

The IP Address recorded during the checkout process

{
  • "agreed_to_terms": true,
  • "order_ip_address": "string"
}

Totals

sub_total
number

Sub Total

tax
number

Tax Total

vat
number

VAT Total

gst
number

GST Total

hst
number

HST Total

pst
number

PST Total

duty
number

Duty Total

shipping
number

Shipping Total

tip
number

Tip Total

discount
number

Discount Total, should be a positive amount

refund
number

Refund Total

grand_total
number

Grand Total

{
  • "sub_total": 0,
  • "tax": 0,
  • "vat": 0,
  • "gst": 0,
  • "hst": 0,
  • "pst": 0,
  • "duty": 0,
  • "shipping": 0,
  • "tip": 0,
  • "discount": 0,
  • "refund": 0,
  • "grand_total": 0
}

User

user_id
integer

Unique ID in the WP EasyCart system

email
string

Unqiue email address for the customer account

email_other
string

A second email address for the customer account

password
string

The password for the customer account, leave blank to force the customer to set it.

first_name
string

The first name on the account.

last_name
string

The last name on the account.

user_level
string

The user level for a customer account, default is shopper.

vat_registration_number
string

The VAT registration number for this account.

object (Address)
object (Address)
stripe_customer_id
string

The stripe customer ID.

exclude_tax
boolean

This customer will not be charged tax, if enabled.

exclude_shipping
boolean

This customer will not be charged shipping, if enabled.

{
  • "user_id": 0,
  • "email": "string",
  • "email_other": "string",
  • "password": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "user_level": "string",
  • "vat_registration_number": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "stripe_customer_id": "string",
  • "exclude_tax": true,
  • "exclude_shipping": true
}

Variant

variant_id
integer

The variant set ID for WP EasyCart. Leave blank for new or updates.

variant_name
string

The internal name for this variant set

variant_label
string

The customer facing label for this variant set.

variant_type
string

The variant type and can be basic-swatch or basic-combo

Array of objects (VariantItemArray)
is_required
boolean

Is this variant set required

error_message
string

The message shown to the customer when the variant is not yet selected.

square_id
string

The SquareUp internal ID that this option connects to, if applicable.

{
  • "variant_id": 0,
  • "variant_name": "string",
  • "variant_label": "string",
  • "variant_type": "string",
  • "variant_items": [
    ],
  • "is_required": true,
  • "error_message": "string",
  • "square_id": "string"
}

VariantItem

optionitem_id
integer

The unique ID for this variant item in the WP EasyCart system.

option_id
integer

The unique ID for the variant set this item connects.

item_name
string

The label for this item.

sort_order
integer

The sort order for this variant item.

sku_extension
string

This will extend the product SKU when variant item is selected.

price_adjustment
number

Adds or subtracts from the product price when selected.

weight_adjustment
number

Adds or subtracts from the product weight when selected.

enable_custom_price_label
boolean

True will enable the custom_price_label to show in place of the price adjustment

custom_price_label
string

The custom price label used if enabled.

square_id
string

The unique SquareUp ID used when connecting your store to Square.

stripe_plan_id
string

The unique ID for Stripe when you use this with a subscription.

{
  • "optionitem_id": 0,
  • "option_id": 0,
  • "item_name": "string",
  • "sort_order": 0,
  • "sku_extension": "string",
  • "price_adjustment": 0,
  • "weight_adjustment": 0,
  • "enable_custom_price_label": true,
  • "custom_price_label": "string",
  • "square_id": "string",
  • "stripe_plan_id": "string"
}

VariantStockItem

item_id
integer

The unique ID in the WP EasyCart system

product_id
integer

The unique product ID that this goes with in the WP EasyCart system.

object (VariantItem)
object (VariantItem)
object (VariantItem)
object (VariantItem)
object (VariantItem)
enabled
boolean

Is this variant item enabled.

tracking_enabled
boolean

Disable to allow for infinite of this variant item

quantity
integer

Total items in stock, applies if product has variant stock quantity tracking enabled.

sku
string

The custom SKU for this variant.

price
number

The custom price for this variant.

square_id
string

The ID to connect this to the SquareUP item.

{
  • "item_id": 0,
  • "product_id": 0,
  • "optionitem_1": {
    },
  • "optionitem_2": {
    },
  • "optionitem_3": {
    },
  • "optionitem_4": {
    },
  • "optionitem_5": {
    },
  • "enabled": true,
  • "tracking_enabled": true,
  • "quantity": 0,
  • "sku": "string",
  • "price": 0,
  • "square_id": "string"
}

Variants

object (Variant)
object (Variant)
object (Variant)
object (Variant)
object (Variant)
{
  • "option_1": {
    },
  • "option_2": {
    },
  • "option_3": {
    },
  • "option_4": {
    },
  • "option_5": {
    }
}

Webhook

type
string

The type of webhook

Enum: "new_category" "update_category" "delete_category" "activate_category" "deactivate_category" "new_product_in_category" "removed_product_from_category" "new_cart" "update_cart" "new_cartite" "update_cartitem" "delete_cartitem" "new_country" "update_country" "delete_country" "new_coupon" "update_coupon" "delete_coupon" "new_download" "update_download" "delete_download" "new_giftcard" "update_giftcard" "delete_giftcard" "new_manufacturer" "update_manufacturer" "delete_manufacturer" "new_menu" "update_menu" "delete_menu" "new_modifier_to_product" "delete_modifier_to_product" "new_optionitem" "update_optionitem" "delete_optionitem" "new_optionset" "update_optionset" "delete_optionset" "new_order" "update_order" "delete_order" "new_order_status" "update_order_status" "delete_order_status" "new_product" "update_product" "delete_product" "activate_product" "deactivate_product" "new_promotion" "update_promotion" "delete_promotion" "new_review" "update_review" "delete_review" "new_shipping_rate" "update_shipping_rate" "delete_shipping_rate" "new_state" "update_state" "delete_state" "new_subscriber" "update_subscriber" "delete_subscriber" "new_subscription" "update_subscription" "delete_subscription" "cancel_subscription" "new_subscription_plan" "update_subscription_plan" "delete_subscription_plan" "new_taxrate" "update_taxrate" "delete_taxrate" "new_user" "update_user" "delete_user" "new_userrole" "update_userrole" "delete_userrole" "new_zone" "update_zone" "delete_zone" "new_location_to_zone" "delete_location_to_zone"
endpoint
string

The endpoint for your webhook.

{
  • "type": "new_category",
  • "endpoint": "string"
}

CategoryAdd

parent_id
integer

The category_id connecting this to another WP EasyCart category

enabled
boolean

True to enable this on your store.

featured
boolean

True to make a featured category, which may apply if your is setup to use this option.

category_name
string

The category name.

short_description
string

Optional description for this category

category_image
string

Optional banner image for this category, should be a URL.

priority
integer

The sort order of category, higher numbers are higher priority.

square_id
string

The unqiue ID connecting this item to SquareUp, if enabled in your store.

{
  • "parent_id": 0,
  • "enabled": true,
  • "featured": true,
  • "category_name": "string",
  • "short_description": "string",
  • "category_image": "string",
  • "priority": 0,
  • "square_id": "string"
}

CountryAdd

name_cnt
string

The full name of this country

enabled
boolean

True to enable this on your store.

iso2_cnt
string

The 2 character code for this country.

iso3_cnt
string

The 3 character code for this country.

vat_rate
number

VAT rate by country, custom to this country.

stripe_taxrate_id
string

Stripe ID to link to your Stripe account tax rate.

vat_b2b_enabled
boolean

Should VAT be charged for businesses in this country.

{
  • "name_cnt": "string",
  • "enabled": true,
  • "iso2_cnt": "string",
  • "iso3_cnt": "string",
  • "vat_rate": 0,
  • "stripe_taxrate_id": "string",
  • "vat_b2b_enabled": true
}

Coupon

coupon_code
string

The unique coupon code for this coupon

coupon_type
string

The type of coupon code (price, percentage, shipping, free-item, bogo-price, bogo-percentage)

coupon_discount
number

The total discount.

no_filters
boolean

If set, this overrides any selection of manufacturer, category, or product.

manufacturer_id
integer

Limit to a manufacturer, you may only set manufacturer, category, or product; not a combination.

category_id
integer

Limit to a category, you may only set manufacturer, category, or product; not a combination.

product_id
integer

Limit to a product, you may only set manufacturer, category, or product; not a combination.

apply_coupon_to_shipping
boolean

Should this coupon apply to the shipping amount.

coupon_message
string

Message to customer on successful redemption.

max_redemptions
string

Max number of times (overall) that a coupon can be redeemed. Use a positive integer or unlimited.

min_required
number

Minimum items required in the cart for coupon to apply.

times_redeemed
number

Number of times this coupon has been redeemed.

expiration_date
string

Date the coupon will expire.

subscription_coupon_duration_type
string

The type way the coupon applies to a subscription product (forever, once, repeating).

subscription_coupon_duration_times
integer

The number of times, if limited, to apply a coupon to a subscription.

{
  • "coupon_code": "string",
  • "coupon_type": "string",
  • "coupon_discount": 0,
  • "no_filters": true,
  • "manufacturer_id": 0,
  • "category_id": 0,
  • "product_id": 0,
  • "apply_coupon_to_shipping": true,
  • "coupon_message": "string",
  • "max_redemptions": "string",
  • "min_required": 0,
  • "times_redeemed": 0,
  • "expiration_date": "string",
  • "subscription_coupon_duration_type": "string",
  • "subscription_coupon_duration_times": 0
}

CouponAdd

coupon_code
string

The coupon code for this coupon.

coupon_type
string

The type of coupon code (price, percentage, shipping, free-item, bogo-price, bogo-percentage)

coupon_discount
number

The total discount.

no_filter
boolean

Turn off filters for this coupon, disables manufacturer, category, or product selections.

manufacturer_id
integer

Limit to a manufacturer.

category_id
integer

Limit to a category.

product_id
integer

Limit to a product.

apply_coupon_to_shipping
boolean

Should this coupon apply to the shipping amount.

coupon_message
string

Message to customer on successful redemption.

times_redeemed
number

Number of times this coupon has been redeemed.

max_redemptions
string

Max number of times (overall) that a coupon can be redeemed. Use a positive integer or unlimited.

min_required
number

Minimum sub total required in the cart for coupon to apply.

expiration_date
string

Date the coupon will expire.

subscription_coupon_duration_type
string

The type way the coupon applies to a subscription product (forever, once, repeating).

subscription_coupon_duration_times
integer

The number of times, if limited, to apply a coupon to a subscription.

{
  • "coupon_code": "string",
  • "coupon_type": "string",
  • "coupon_discount": 0,
  • "no_filter": true,
  • "manufacturer_id": 0,
  • "category_id": 0,
  • "product_id": 0,
  • "apply_coupon_to_shipping": true,
  • "coupon_message": "string",
  • "times_redeemed": 0,
  • "max_redemptions": "string",
  • "min_required": 0,
  • "expiration_date": "string",
  • "subscription_coupon_duration_type": "string",
  • "subscription_coupon_duration_times": 0
}

CustomerReviewAdd

product_id
integer

The product this review applies to.

user_id
integer

The user, if applicable, that posted this review. Use 0 for no user connection (or guest).

approved
boolean

If true, this is approved and shows on the store.

rating
integer

The rating (1-5) of the review.

title
string

The review title by the customer.

review_description
string

The content of the review.

date_submitted
string

The timestamp of when the review was submitted.

reviewer_name
string

The name entered for the reviewer (if applicable).

{
  • "product_id": 0,
  • "user_id": 0,
  • "approved": true,
  • "rating": 0,
  • "title": "string",
  • "review_description": "string",
  • "date_submitted": "string",
  • "reviewer_name": "string"
}

DownloadItem

download_id
string

The unique ID for this download

date_created
string

The date this download was created.

product_id
integer

The product ID associated with this download.

order_id
integer

The order ID associated with this download.

download_count
integer

The number of times the user has downloaded this item.

download_file_name
string

The filename for this download item.

is_amazon
boolean

Is the download hosted on Amazon S3

amazon_key
string

The key for Amazon S3, if applicable.

{
  • "download_id": "string",
  • "date_created": "string",
  • "product_id": 0,
  • "order_id": 0,
  • "download_count": 0,
  • "download_file_name": "string",
  • "is_amazon": true,
  • "amazon_key": "string"
}

DownloadAdd

product_id
integer

The product ID associated with this download.

order_id
integer

The order ID associated with this download.

download_count
integer

The number of times the user has downloaded this item.

download_file_name
string

The filename for this download item.

is_amazon
boolean

Is the download hosted on Amazon S3

amazon_key
string

The key for Amazon S3, if applicable.

{
  • "product_id": 0,
  • "order_id": 0,
  • "download_count": 0,
  • "download_file_name": "string",
  • "is_amazon": true,
  • "amazon_key": "string"
}

FlexfeeAdd

fee_label
string

The label for the fee shown to admin and shopper.

fee_description
string

A description in the form of a list of requirements for the fee.

countries
string

Optional, comma separated list, of 2-character country code(s) (typically iso2_cnt).

states
string

Optional, comma separated list, of 2-character state code.

cities
string

Optional, comma separated list, of city names.

postal_codes
string

Optional, comma separated list, of postal codes.

categories
string

Optional, comma separated list, of category IDs.

roles
string

Optional, comma separated list, of user roles.

zones
string

Optional, comma separated list, of shipping zone IDs.

fee_type
number

Types may be 1 (Rate Fee) or 2 (Price Fee).

rate
number

The percentage of this fee when it applies and the type is a rate type fee.

price
number

The price or amount to apply when this fee applies and is a price fee type.

min
number

The minimum charge, applicable only for rate based fees.

max
number

The maximum charge, applicable only for rate based fees.

payment_types
string

Optional, comma separated list, of payment types in which this fee applies. Possible values are card, affirm, klarna, afterpay_clearpay, third_party, amazonpay, or manual_bill. Types affirm, klarna, and afterpay_clearpay only apply to Stripe payments.

{
  • "fee_label": "string",
  • "fee_description": "string",
  • "countries": "string",
  • "states": "string",
  • "cities": "string",
  • "postal_codes": "string",
  • "categories": "string",
  • "roles": "string",
  • "zones": "string",
  • "fee_type": 0,
  • "rate": 0,
  • "price": 0,
  • "min": 0,
  • "max": 0,
  • "payment_types": "string"
}

GiftcardAdd

giftcard_id
string

The unique, redeemable ID and should be 12 characters.

amount
number

The amount available on the giftcard.

message
string

The redeem message to the customer

{
  • "giftcard_id": "string",
  • "amount": 0,
  • "message": "string"
}

GiftcardUpdate

giftcard_id
string

The unique, redeemable ID and should be 12 characters.

amount
number

The amount available on the giftcard.

debit
number

The amount to deduct (subtract) from the gift card.

credit
number

The amount credit (add) to the gift card.

message
string

The redeem message to the customer

{
  • "giftcard_id": "string",
  • "amount": 0,
  • "debit": 0,
  • "credit": 0,
  • "message": "string"
}

ManufacturerAdd

manufacturer_name
string

The name of the manufacturer

clicks
integer

Number of times this has been viewed

post_id
integer

The post ID in WordPress for this store_item in your store.

{
  • "manufacturer_name": "string",
  • "clicks": 0,
  • "post_id": 0
}

MenuAdd

level
integer

The level of this menu item, must be 1-3.

menu_name
string

The name of this menu.

sort_order
integer

The sort order of this menu item.

clicks
integer

The number of views/clicks for this menu item.

banner_image
string

The image that can show on the menu page, should be a URL.

seo_description
string

The meta description for this menu.

seo_keywords
string

The meta keywords for this menu.

{
  • "level": 0,
  • "menu_name": "string",
  • "sort_order": 0,
  • "clicks": 0,
  • "banner_image": "string",
  • "seo_description": "string",
  • "seo_keywords": "string"
}

ModifierItemAddModifier

item_name
string

The label for this modifier item.

sort_order
integer

The sort order for this modifier item.

sku_extension
string

This will extend the product SKU when modifier item is selected.

swatch_icon
string

Add a custom swatch icon, if this modifier item is a swatch.

default_selected
boolean

If this is a modifier item in a list of items, true will make this the initially selected item.

default_value
string

If this is a single modifier item like a text, text area, number, etc... This is the default value.

object (ModifierAdjustment)
object (ModifierAdjustment)
enable_custom_price_label
boolean

True will enable the custom_price_label to show in place of the price adjustment

custom_price_label
string

The custom price label used if enabled.

download_allowed
boolean

This item may disable the product download, if false.

download_override_file
string

You may override the product download with this file, should be a URL.

download_additional_file
string

You may add an additional file to a product download when this option is selected, should be a URL.

block_shipping
boolean

If true, the product is no longer shippable.

square_id
string

The unique SquareUp ID used when connecting your store to Square.

stripe_plan_id
string

The unique ID for Stripe when you use this with a subscription.

{
  • "item_name": "string",
  • "sort_order": 0,
  • "sku_extension": "string",
  • "swatch_icon": "string",
  • "default_selected": true,
  • "default_value": "string",
  • "price_adjustment": {
    },
  • "weight_adjustment": {
    },
  • "enable_custom_price_label": true,
  • "custom_price_label": "string",
  • "download_allowed": true,
  • "download_override_file": "string",
  • "download_additional_file": "string",
  • "block_shipping": true,
  • "square_id": "string",
  • "stripe_plan_id": "string"
}

ModifierAdd

modifier_name
string

The internal name for this modifier set

modifier_label
string

The customer facing label for this modifier.

modifier_type
string

The type and can be combo, swatch, text, textarea, number, file, radio, checkbox, grid, date, dimensions1, or dimensions2.

object (ModifierMeta)
Array of objects (ModifierItemAddArray)
is_required
boolean

Is this modifier set required

error_message
string

The message shown to the customer when the modifier is not yet selected.

square_id
string

The SquareUp internal ID that this item connects to, if applicable.

{
  • "modifier_name": "string",
  • "modifier_label": "string",
  • "modifier_type": "string",
  • "modifier_meta": {
    },
  • "modifier_items": [
    ],
  • "is_required": true,
  • "error_message": "string",
  • "square_id": "string"
}

ModifierItemUpdate

modifier_item_id
integer

The unique ID for the modifier set this item connects. If adding a new modifier, do not include this.

item_name
string

The label for this modifier item.

sort_order
integer

The sort order for this modifier item.

sku_extension
string

This will extend the product SKU when modifier item is selected.

swatch_icon
string

Add a custom swatch icon, if this modifier item is a swatch.

default_selected
boolean

If this is a modifier item in a list of items, true will make this the initially selected item.

default_value
string

If this is a single modifier item like a text, text area, number, etc... This is the default value.

object (ModifierAdjustment)
object (ModifierAdjustment)
enable_custom_price_label
boolean

True will enable the custom_price_label to show in place of the price adjustment

custom_price_label
string

The custom price label used if enabled.

download_allowed
boolean

This item may disable the product download, if false.

download_override_file
string

You may override the product download with this file, should be a URL.

download_additional_file
string

You may add an additional file to a product download when this option is selected, should be a URL.

block_shipping
boolean

If true, the product is no longer shippable.

square_id
string

The unique SquareUp ID used when connecting your store to Square.

stripe_plan_id
string

The unique ID for Stripe when you use this with a subscription.

{
  • "modifier_item_id": 0,
  • "item_name": "string",
  • "sort_order": 0,
  • "sku_extension": "string",
  • "swatch_icon": "string",
  • "default_selected": true,
  • "default_value": "string",
  • "price_adjustment": {
    },
  • "weight_adjustment": {
    },
  • "enable_custom_price_label": true,
  • "custom_price_label": "string",
  • "download_allowed": true,
  • "download_override_file": "string",
  • "download_additional_file": "string",
  • "block_shipping": true,
  • "square_id": "string",
  • "stripe_plan_id": "string"
}

ModifierUpdate

modifier_name
string

The internal name for this modifier set

modifier_label
string

The customer facing label for this modifier.

modifier_type
string

The type and can be combo, swatch, text, textarea, number, file, radio, checkbox, grid, date, dimensions1, or dimensions2.

object (ModifierMeta)
Array of objects (ModifierItemUpdateArray)
is_required
boolean

Is this modifier set required

error_message
string

The message shown to the customer when the modifier is not yet selected.

square_id
string

The SquareUp internal ID that this item connects to, if applicable.

{
  • "modifier_name": "string",
  • "modifier_label": "string",
  • "modifier_type": "string",
  • "modifier_meta": {
    },
  • "modifier_items": [
    ],
  • "is_required": true,
  • "error_message": "string",
  • "square_id": "string"
}

ModifierItemAdd

option_id
integer

The unique ID for the modifier set this item connects. If adding a new modifier, do not include this.

item_name
string

The label for this modifier item.

sort_order
integer

The sort order for this modifier item.

sku_extension
string

This will extend the product SKU when modifier item is selected.

swatch_icon
string

Add a custom swatch icon, if this modifier item is a swatch.

default_selected
boolean

If this is a modifier item in a list of items, true will make this the initially selected item.

default_value
string

If this is a single modifier item like a text, text area, number, etc... This is the default value.

object (ModifierAdjustment)
object (ModifierAdjustment)
enable_custom_price_label
boolean

True will enable the custom_price_label to show in place of the price adjustment

custom_price_label
string

The custom price label used if enabled.

download_allowed
boolean

This item may disable the product download, if false.

download_override_file
string

You may override the product download with this file, should be a URL.

download_additional_file
string

You may add an additional file to a product download when this option is selected, should be a URL.

block_shipping
boolean

If true, the product is no longer shippable.

square_id
string

The unique SquareUp ID used when connecting your store to Square.

stripe_plan_id
string

The unique ID for Stripe when you use this with a subscription.

{
  • "option_id": 0,
  • "item_name": "string",
  • "sort_order": 0,
  • "sku_extension": "string",
  • "swatch_icon": "string",
  • "default_selected": true,
  • "default_value": "string",
  • "price_adjustment": {
    },
  • "weight_adjustment": {
    },
  • "enable_custom_price_label": true,
  • "custom_price_label": "string",
  • "download_allowed": true,
  • "download_override_file": "string",
  • "download_additional_file": "string",
  • "block_shipping": true,
  • "square_id": "string",
  • "stripe_plan_id": "string"
}

QuickbooksOrder

edit_sequence
string

Edit sequence for a Quickbooks transaction

quickbooks_status
string

Status used for a Quickbooks transaction

txn_id
string

Transaction ID for a Quickbooks transaction

payment_txn_id
string

Payment transaction ID for a Quickbooks transaction

credit_memo_txn_id
string

Credit memo transaction ID for a Quickbooks transaction

{
  • "edit_sequence": "string",
  • "quickbooks_status": "string",
  • "txn_id": "string",
  • "payment_txn_id": "string",
  • "credit_memo_txn_id": "string"
}

OrderRequest

order_date
string <date-time>

The order date and time in format YYYY-MM-DD HH:MM:SS

object (OrderStatus)
guest_key
string

The unique key for an order to be viewed without having to log into the user account.

subscription_id
integer

The subscription ID if this connects to a subscription order.

viewed
boolean

The control if this order has been viewed

success_page_shown
boolean

This helps prevent double calls of javascript on success page view.

weight
number

The weight of the entire order, typically used for shipping rates.

promocode
string

The coupon code, if used for this order

giftcard
string

The gift card ID, if used for this order

order_notes_admin
string

The admin order notes.

order_notes_customer
string

The customer order notes.

object (Totals)
object (TaxRates)
object (Shipping)
object (User)
object (Payment)
object (Gateway)
object (Quickbooks)
object (Terms)
{
  • "order_date": "2019-08-24T14:15:22Z",
  • "order_status": {
    },
  • "guest_key": "string",
  • "subscription_id": 0,
  • "viewed": true,
  • "success_page_shown": true,
  • "weight": 0,
  • "promocode": "string",
  • "giftcard": "string",
  • "order_notes_admin": "string",
  • "order_notes_customer": "string",
  • "totals": {
    },
  • "taxrates": {
    },
  • "shipping": {
    },
  • "user": {
    },
  • "payment": {
    },
  • "gateway": {
    },
  • "quickbooks": {
    },
  • "terms": {
    }
}

PricingRestrict

enable
boolean

True to enable pricing restriction by user.

user_level
string

The user level string required to view pricing.

display_label
string

The message to show the user when they do not have access to pricing.

{
  • "enable": true,
  • "user_level": "string",
  • "display_label": "string"
}

ProductQuantitySimple

enabled
boolean

Is tracking enabled for this product.

enable_variant_tracking
boolean

Is variant quantity tracking enabled for this product.

stock_quantity_total
integer

The total stock quantity available.

min_allowed
integer

The minimum required by the customer.

max_allowed
integer

The maximum allowed for a customer.

allow_backorders
boolean

Allow a user to buy more than in stock.

backorder_fill_date
string

Shown to the customer when a backorder has occurred.

{
  • "enabled": true,
  • "enable_variant_tracking": true,
  • "stock_quantity_total": 0,
  • "min_allowed": 0,
  • "max_allowed": 0,
  • "allow_backorders": true,
  • "backorder_fill_date": "string"
}

ImagesSimple

enable_option_images
boolean

If true, images wil be shown as an array for each variant or modifier.

images_use_modifier
boolean

If true, and enable_option_images true, option images will apply to the first modifier attached to the product.

Array of objects (ImagesGroupArray)
{
  • "enable_option_images": true,
  • "images_use_modifier": true,
  • "product_images": [
    ]
}

VariantsSimple

option_1_id
integer

Option group ID

option_2_id
integer

Option group ID

option_3_id
integer

Option group ID

option_4_id
integer

Option group ID

option_5_id
integer

Option group ID

{
  • "option_1_id": 0,
  • "option_2_id": 0,
  • "option_3_id": 0,
  • "option_4_id": 0,
  • "option_5_id": 0
}

MenuLocations

object (MenuLocation)
object (MenuLocation)
object (MenuLocation)
{
  • "menu1": {
    },
  • "menu2": {
    },
  • "menu3": {
    }
}

QuickbooksProduct

list_id
string

List ID for a Quickbooks item.

edit_sequence
string

Edit sequence for a Quickbooks transaction

quickbooks_status
string

Status used for a Quickbooks transaction

income_account_ref
string

The income account reference, if applicable.

cogs_account_ref
string

The cogs account reference, if applicable.

asset_account_ref
string

The asset account reference, if applicable.

parent_name
string

The parent reference in Quickbooks, if applicable.

parent_list_id
string

The parent list id reference in Quickbooks, if applicable.

{
  • "list_id": "string",
  • "edit_sequence": "string",
  • "quickbooks_status": "string",
  • "income_account_ref": "string",
  • "cogs_account_ref": "string",
  • "asset_account_ref": "string",
  • "parent_name": "string",
  • "parent_list_id": "string"
}

ProductListItem

product_id
integer

The product ID for the item in WP EasyCart. Leave blank if adding new or updating a product.

sku
string

The model number / SKU

post_id
integer

The post ID in WordPress for this item.

active
boolean

Is this item activated in your store.

is_main
boolean

Should we show this product on the main store page

sort_position
integer

The default sort order.

title
string

The product title

description
string

The full description for the product

short_description
string

The short description for the product

specifications
string

The full specs for the product

object (Pricing)
object (ProductQuantitySimple)
object (ImagesSimple)
object (ProductShipping)
object (ProductTax)
object (Seo)
reviews_enabled
boolean

Are customer reviews enabled

manufacturer_id
integer

The manufacturer ID for this product

object (Download)
object (VariantsSimple)
object (MenuLocations)
object (FeaturedProducts)
object (ProductSubscription)
object (ProductOrderNotes)
role_id
integer

Restrict this product to a specific user role id

is_giftcard
boolean

Is this a giftcard item

is_donation
boolean

Is this a donation item

is_special
boolean

Is this item on the special widget

object (ProductStats)
object (QuickbooksProduct)
object (ProductSeasonal)
object (ProductInquiry)
object (Deconetwork)
object (ProductDisplay)
square_id
string

The SquareUp ID for this product, used for syncing.

square_variation_id
string

The variation ID for this product, which is sometimes applicable.

{
  • "product_id": 0,
  • "sku": "string",
  • "post_id": 0,
  • "active": true,
  • "is_main": true,
  • "sort_position": 0,
  • "title": "string",
  • "description": "string",
  • "short_description": "string",
  • "specifications": "string",
  • "pricing": {
    },
  • "quantity": {
    },
  • "images": {
    },
  • "shipping": {
    },
  • "tax": {
    },
  • "seo": {
    },
  • "reviews_enabled": true,
  • "manufacturer_id": 0,
  • "download": {
    },
  • "variants": {
    },
  • "menu": {
    },
  • "featured_products": {
    },
  • "subscription": {
    },
  • "order_notes": {
    },
  • "role_id": 0,
  • "is_giftcard": true,
  • "is_donation": true,
  • "is_special": true,
  • "stats": {
    },
  • "quickbooks": {
    },
  • "seasonal": {
    },
  • "inquiry": {
    },
  • "deconetwork": {
    },
  • "display": {
    },
  • "square_id": "string",
  • "square_variation_id": "string"
}

ProductSubscriptionAdd

enabled
boolean

Is this product a subscription.

bill_length
integer

Number of bill period between payments, for example 2 for every 2 months.

bill_period
string

The bill period, must be W for Weekly, M for Monthly, or Y for Yearly.

bill_duration
integer

Leave 0 if this subscription goes on forever. This only is needed if you wish to limit payments. For example, you want a customer to pay 12 equal monthly payments, enter 12 to end after 12 payments.

email_recurring
boolean

True if an email should send for every payment.

shipping_recurring
boolean

True if your shipping charge need to happen every month or get a single charge on initial sign up.

trial_days
integer

Optionally enter a trial period in days. Leave 0 if no trial.

subscription_plan_id
integer

Optional subscription plan ID reference.

allow_multiple
boolean

Can a customer buy this more than one time.

membership_page
string

If this is connected to membership content, enter the URL here.

signup_fee
number

This allows you to add a signup fee, or a one-time fee charged on purchase.

stripe_product_id
integer

This is the unique Product ID used at Stripe.

stripe_default_price_id
integer

This is the unique Price ID used at Stripe.

prorate
boolean

This determines how billing is handled when subscriptions change. Prorating will adjust billing immediately, without prorating the billing will only change on the next invoice.

{
  • "enabled": true,
  • "bill_length": 0,
  • "bill_period": "string",
  • "bill_duration": 0,
  • "email_recurring": true,
  • "shipping_recurring": true,
  • "trial_days": 0,
  • "subscription_plan_id": 0,
  • "allow_multiple": true,
  • "membership_page": "string",
  • "signup_fee": 0,
  • "stripe_product_id": 0,
  • "stripe_default_price_id": 0,
  • "prorate": true
}

ProductAdd

sku
string

The model number / SKU

active
boolean

Is this item activated in your store.

is_main
boolean

Should we show this product on the main store page

sort_position
integer

The default sort order.

title
string

The product title

description
string

The full description for the product

short_description
string

The short description for the product

specifications
string

The full specs for the product

object (Pricing)
object (ProductQuantity)
object (Images)
object (ProductShipping)
object (ProductTax)
object (Seo)
reviews_enabled
boolean

Are customer reviews enabled

manufacturer_id
integer

Manufacturer ID for product.

object (Download)
object (VariantsSimple)
Array of objects (ModifiersArray)
Array of objects (CategoriesArray)
object (MenuLocations)
object (FeaturedProducts)
object (ProductSubscriptionAdd)
object (ProductOrderNotes)
role_id
integer

Restrict this product to a specific user role id

is_giftcard
boolean

Is this a giftcard item

is_donation
boolean

Is this a donation item

is_special
boolean

Is this item on the special widget

object (ProductStats)
object (QuickbooksProduct)
object (ProductSeasonal)
object (ProductInquiry)
object (Deconetwork)
object (ProductDisplay)
square_id
string

The SquareUp ID for this product, used for syncing.

square_variation_id
string

The variation ID for this product, which is sometimes applicable.

{
  • "sku": "string",
  • "active": true,
  • "is_main": true,
  • "sort_position": 0,
  • "title": "string",
  • "description": "string",
  • "short_description": "string",
  • "specifications": "string",
  • "pricing": {
    },
  • "quantity": {
    },
  • "images": {
    },
  • "shipping": {
    },
  • "tax": {
    },
  • "seo": {
    },
  • "reviews_enabled": true,
  • "manufacturer_id": 0,
  • "download": {
    },
  • "variants": {
    },
  • "modifiers": [
    ],
  • "categories": [
    ],
  • "menu": {
    },
  • "featured_products": {
    },
  • "subscription": {
    },
  • "order_notes": {
    },
  • "role_id": 0,
  • "is_giftcard": true,
  • "is_donation": true,
  • "is_special": true,
  • "stats": {
    },
  • "quickbooks": {
    },
  • "seasonal": {
    },
  • "inquiry": {
    },
  • "deconetwork": {
    },
  • "display": {
    },
  • "square_id": "string",
  • "square_variation_id": "string"
}

Promotion

promotion_id
integer

The promotion ID for the item in WP EasyCart.

promotion_type
integer

The types may be 1 (price/percent off), 4 (shipping discount), 6 (price/percetage at min total), 7 (free shipping), 8 (price/percetage at min items), and 9 (BOGO).

promotion_message
string

This is a short message, sometimes displayed to the customer, where applicable.

start_date
string

The start date of this promotion in the format of YYYY-MM-DD

end_date
string

The end date of this promotion in the format of YYYY-MM-DD

limit_type
string

When applicable, values may be limit by none, product, manufacturer, or category. Must include correct ID based on this value.

product_id
integer

Limit by product, where applicable.

manufacturer_id
integer

Limit by manufacturer, where applicable.

category_id
integer

Limit by category, where applicable.

discount_type
string

Type of discount, either price or percentage

discount_amount
number

Price or percentage to discount, when applicable.

price_threshold
number

For promo type 6 or 7, the minimum amount required for the discount to apply.

item_threshold
integer

For promo type 8, the minimum items required for the discount to apply.

bogo_max
integer

For promo type 9, the maximum times per customer this can be redeemed.

{
  • "promotion_id": 0,
  • "promotion_type": 0,
  • "promotion_message": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "limit_type": "string",
  • "product_id": 0,
  • "manufacturer_id": 0,
  • "category_id": 0,
  • "discount_type": "string",
  • "discount_amount": 0,
  • "price_threshold": 0,
  • "item_threshold": 0,
  • "bogo_max": 0
}

PromotionAdd

promotion_type
integer

The types may be 1 (price/percent off), 4 (shipping discount), 6 (price/percetage at min total), 7 (free shipping), 8 (price/percetage at min items), and 9 (BOGO).

promotion_message
string

This is a short message, sometimes displayed to the customer, where applicable.

start_date
string

The start date of this promotion in the format of YYYY-MM-DD

end_date
string

The end date of this promotion in the format of YYYY-MM-DD

limit_type
string

When applicable, values may be limit by none, product, manufacturer, or category. Must include correct ID based on this value.

product_id
integer

Limit by product, where applicable.

manufacturer_id
integer

Limit by manufacturer, where applicable.

category_id
integer

Limit by category, where applicable.

discount_type
string

Type of discount, either price or percentage

discount_amount
number

Price or percentage to discount, when applicable.

price_threshold
number

For promo type 6 or 7, the minimum amount required for the discount to apply.

item_threshold
integer

For promo type 8, the minimum items required for the discount to apply.

bogo_max
integer

For promo type 9, the maximum times per customer this can be redeemed.

{
  • "promotion_type": 0,
  • "promotion_message": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "limit_type": "string",
  • "product_id": 0,
  • "manufacturer_id": 0,
  • "category_id": 0,
  • "discount_type": "string",
  • "discount_amount": 0,
  • "price_threshold": 0,
  • "item_threshold": 0,
  • "bogo_max": 0
}

ShippingRate

rate_id
number

The unique shipping rate ID for this shipping rate.

zone_id
number

The zone ID for this rate, if you want to limit this rate type to a shipping zone.

rate_label
string

The label of the rate to display to the customer

rate_type
string

The type of shipping rate, values can be price, percentage, quantity, weight, method, or live.

rate_carrier
string

If a live based rate, the carrier for the rate. Values can be ups, usps, fedex, dhl, auspost, canpost, or other.

rate_code
string

The service code of the shipment

trigger_rate
number

The trigger rate

shipping_rate
number

The shipping rate

rate_order
integer

The sort order of the shipping rate, low to high.

override_rate
number

For live rates, the amount to always use.

free_shipping_threshold
number

The price that free shipping applies to this rate type.

{
  • "rate_id": 0,
  • "zone_id": 0,
  • "rate_label": "string",
  • "rate_type": "string",
  • "rate_carrier": "string",
  • "rate_code": "string",
  • "trigger_rate": 0,
  • "shipping_rate": 0,
  • "rate_order": 0,
  • "override_rate": 0,
  • "free_shipping_threshold": 0
}

ShippingRateAdd

zone_id
number

The zone ID for this rate, if you want to limit this rate type to a shipping zone.

rate_label
string

The label of the rate to display to the customer

rate_type
string

The type of shipping rate, values can be price, percentage, quantity, weight, method, or live.

rate_carrier
string

If a live based rate, the carrier for the rate. Values can be ups, usps, fedex, dhl, auspost, canpost, or other.

rate_code
string

The service code of the shipment

trigger_rate
number

The trigger rate

shipping_rate
number

The shipping rate

rate_order
integer

The sort order of the shipping rate, low to high.

override_rate
number

For live rates, the amount to always use.

free_shipping_threshold
number

The price that free shipping applies to this rate type.

{
  • "zone_id": 0,
  • "rate_label": "string",
  • "rate_type": "string",
  • "rate_carrier": "string",
  • "rate_code": "string",
  • "trigger_rate": 0,
  • "shipping_rate": 0,
  • "rate_order": 0,
  • "override_rate": 0,
  • "free_shipping_threshold": 0
}

ShippingZoneItem

zone_item_id
number

The unique zone item ID for this shipping zone item.

zone_id
number

The zone ID for this shipping zone item.

country_code
string

The country code for this zone item.

state_code
string

The state code for this zone item, if you want to connect beyond the country.

{
  • "zone_item_id": 0,
  • "zone_id": 0,
  • "country_code": "string",
  • "state_code": "string"
}

ShippingZone

zone_id
number

The unique zone ID for this shipping zone.

zone_name
string

The internal label for this shipping zone.

Array of objects (ShippingZoneItem)

An array of zone item locations for this shipping zone.

{
  • "zone_id": 0,
  • "zone_name": "string",
  • "zone_locations": [
    ]
}

ShippingZoneItemAdd

zone_id
number

The zone ID for this shipping zone item.

country_code
string

The country code for this zone item.

state_code
string

The state code for this zone item, if you want to connect beyond the country.

{
  • "zone_id": 0,
  • "country_code": "string",
  • "state_code": "string"
}

ShippingZoneAdd

zone_name
string

The internal label for this shipping zone.

Array of objects (ShippingZoneItemAdd)

An array of zone item locations for this shipping zone.

{
  • "zone_name": "string",
  • "zone_locations": [
    ]
}

State

state_id
integer

The internal ID for this state/territory/province/county.

country_code
string

The 2 character country code for this state/territory/province/county.

state_code
string

The 2 character code for this state/territory/province/county.

state_name
string

The full name of this state

group_name
string

You may group states/territories/provinces/counties by entering the same value for all in the group.

sort_order
integer

The sort order of this item in a list.

enabled
boolean

Determines if this is shown to the customer.

{
  • "state_id": 0,
  • "country_code": "string",
  • "state_code": "string",
  • "state_name": "string",
  • "group_name": "string",
  • "sort_order": 0,
  • "enabled": true
}

StateAdd

country_code
string

The 2 character country code for this state/territory/province/county.

state_code
string

The 2 character code for this state/territory/province/county.

state_name
string

The full name of this state

group_name
string

You may group states/territories/provinces/counties by entering the same value for all in the group.

sort_order
integer

The sort order of this item in a list.

enabled
boolean

Determines if this is shown to the customer.

{
  • "country_code": "string",
  • "state_code": "string",
  • "state_name": "string",
  • "group_name": "string",
  • "sort_order": 0,
  • "enabled": true
}

Subscription

subscription_id
integer

The internal ID for this subscription.

title
string

The description for this subscription.

type
string

This can either be stripe or paypal as the standard implementation.

status
string

This can be Active, Suspended, or Canceled.

price
number

The recurring price for this subscription.

quantity
integer

Typically 1, but can be used in cases where a user can subscription to multiple of the same product.

payment_length
integer

This is the length to recur, for example 2 is for every 2 weeks/months. Typical value is 1.

payment_period
string

This is the period to recur and can be W = Weekly, M = Monthly, or Y = Yearly.

payment_duration
integer

Typically enter 0 to allow this to recur forever. Enter an integer to cancel the subscription automatically after some number of payments (e.g. cancel after 3 months, enter 3 here).

start_date
string

The timestamp for the subscription start date, default is the current timestamp.

user_id
integer

Connect this subscription to a user in the system.

user_email
string

The email address for this subscription.

user_first_name
string

The first name associated with this subscription.

user_last_name
string

The last name associated with this subscription.

user_country
string

The 2 character country code associated with this subscription.

product_id
integer

The product for this subscription.

product_model_number
string

The model number for the product associated with this subscription.

last_payment_date
string

The unix timestamp to indicate the last payment.

next_payment_date
string

The unix timestamp to indicate the next payment.

total_payments
integer

The total number of payments completed.

failed_payments
integer

The total number of failed payments.

stripe_subscription_id
string

The connecting subscription ID from Stripe.

{
  • "subscription_id": 0,
  • "title": "string",
  • "type": "string",
  • "status": "string",
  • "price": 0,
  • "quantity": 0,
  • "payment_length": 0,
  • "payment_period": "string",
  • "payment_duration": 0,
  • "start_date": "string",
  • "user_id": 0,
  • "user_email": "string",
  • "user_first_name": "string",
  • "user_last_name": "string",
  • "user_country": "string",
  • "product_id": 0,
  • "product_model_number": "string",
  • "last_payment_date": "string",
  • "next_payment_date": "string",
  • "total_payments": 0,
  • "failed_payments": 0,
  • "stripe_subscription_id": "string"
}

SubscriptionAdd

title
string

The description for this subscription.

type
string

This can either be stripe or paypal as the standard implementation.

status
string

This can be Active, Suspended, or Canceled.

price
number

The recurring price for this subscription.

quantity
integer

Typically 1, but can be used in cases where a user can subscription to multiple of the same product.

payment_length
integer

This is the length to recur, for example 2 is for every 2 weeks/months. Typical value is 1.

payment_period
string

This is the period to recur and can be W = Weekly, M = Monthly, or Y = Yearly.

payment_duration
integer

Typically enter 0 to allow this to recur forever. Enter an integer to cancel the subscription automatically after some number of payments (e.g. cancel after 3 months, enter 3 here).

start_date
string

The timestamp for the subscription start date, default is the current timestamp.

user_id
integer

Connect this subscription to a user in the system.

user_email
string

The email address for this subscription.

user_first_name
string

The first name associated with this subscription.

user_last_name
string

The last name associated with this subscription.

user_country
string

The 2 character country code associated with this subscription.

product_id
integer

The product for this subscription.

product_model_number
string

The model number for the product associated with this subscription.

last_payment_date
string

The unix timestamp to indicate the last payment.

next_payment_date
string

The unix timestamp to indicate the next payment.

total_payments
integer

The total number of payments completed.

failed_payments
integer

The total number of failed payments.

stripe_subscription_id
string

The connecting subscription ID from Stripe.

{
  • "title": "string",
  • "type": "string",
  • "status": "string",
  • "price": 0,
  • "quantity": 0,
  • "payment_length": 0,
  • "payment_period": "string",
  • "payment_duration": 0,
  • "start_date": "string",
  • "user_id": 0,
  • "user_email": "string",
  • "user_first_name": "string",
  • "user_last_name": "string",
  • "user_country": "string",
  • "product_id": 0,
  • "product_model_number": "string",
  • "last_payment_date": "string",
  • "next_payment_date": "string",
  • "total_payments": 0,
  • "failed_payments": 0,
  • "stripe_subscription_id": "string"
}

SubscriptionPlanAdd

plan_title
string

The title for this subscription plan.

can_downgrade
boolean

Allow your customers to downgrade their subscription within the plan on their own. Disabled only allows them to switch to a higher priced subscription.

{
  • "plan_title": "string",
  • "can_downgrade": true
}

Tax

tax_id
integer

The internal ID for this tax rate.

type
string

Valid values are state, country, duty, vat, single-vat, all, or other.

tax_rate
number

The percentage rate to charge the customer.

vat_type
string

Valid values are added, included, or other. Only applies to vat and single-vat tax rate types.

state_code
string

Required for tax type state.

country_code
string

Required for tax types state, country, vat (where applicable), and duty. For type duty, this is the exempt country.

stripe_taxrate_id
string

Connect this rate to Stripe, if applicable.

{
  • "tax_id": 0,
  • "type": "string",
  • "tax_rate": 0,
  • "vat_type": "string",
  • "state_code": "string",
  • "country_code": "string",
  • "stripe_taxrate_id": "string"
}

TaxAdd

type
string

Valid values are state, country, duty, vat, single-vat, all, or other.

tax_rate
number

The percentage rate to charge the customer.

vat_type
string

Valid values are added, included, or other. Only applies to vat and single-vat tax rate types.

state_code
string

Required for tax type state.

country_code
string

Required for tax types state, country, vat (where applicable), and duty. For type duty, this is the exempt country.

stripe_taxrate_id
string

Connect this rate to Stripe, if applicable.

{
  • "type": "string",
  • "tax_rate": 0,
  • "vat_type": "string",
  • "state_code": "string",
  • "country_code": "string",
  • "stripe_taxrate_id": "string"
}

AddressAdd

first_name
string

Customer first name

last_name
string

Customer last name

company_name
string

Customer company name

address_line_1
string

Customer address line 1

address_line_2
string

Customer address line 2

city
string

Customer city

state
string

Customer state, province, territory, or other division

zip
string

Customer zip or postal code

country
string

Customer country code

phone
string

Customer phone

{
  • "first_name": "string",
  • "last_name": "string",
  • "company_name": "string",
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "string",
  • "phone": "string"
}

UserAdd

email
string

Unqiue email address for the customer account

email_other
string

A second email address for the customer account

password
string

The password for the customer account, leave blank to force the customer to set it.

user_level
string

The user level for a customer account, default is shopper.

first_name
string

The first name on the account.

last_name
string

The last name on the account.

vat_registration_number
string

The VAT registration number for this account.

object (AddressAdd)
object (AddressAdd)
stripe_customer_id
string

The stripe customer ID.

exclude_tax
boolean

This customer will not be charged tax, if enabled.

exclude_shipping
boolean

This customer will not be charged shipping, if enabled.

{
  • "email": "string",
  • "email_other": "string",
  • "password": "string",
  • "user_level": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "vat_registration_number": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "stripe_customer_id": "string",
  • "exclude_tax": true,
  • "exclude_shipping": true
}

VariantAdd

variant_id
integer

The variant set ID for WP EasyCart. Leave blank for new or updates.

variant_name
string

The internal name for this variant set

variant_label
string

The customer facing label for this variant set.

variant_type
string

The variant type and can be basic-swatch or basic-combo

Array of objects (VariantItemArray)
is_required
boolean

Is this variant set required

error_message
string

The message shown to the customer when the variant is not yet selected.

square_id
string

The SquareUp internal ID that this option connects to, if applicable.

{
  • "variant_id": 0,
  • "variant_name": "string",
  • "variant_label": "string",
  • "variant_type": "string",
  • "variant_items": [
    ],
  • "is_required": true,
  • "error_message": "string",
  • "square_id": "string"
}

VariantItemAdd

optionitem_id
integer

The unique ID for this variant item in the WP EasyCart system.

option_id
integer

The unique ID for the variant set this item connects.

item_name
string

The label for this item.

sort_order
integer

The sort order for this variant item.

sku_extension
string

This will extend the product SKU when variant item is selected.

price_adjustment
number

Adds or subtracts from the product price when selected.

weight_adjustment
number

Adds or subtracts from the product weight when selected.

enable_custom_price_label
boolean

True will enable the custom_price_label to show in place of the price adjustment

custom_price_label
string

The custom price label used if enabled.

square_id
string

The unique SquareUp ID used when connecting your store to Square.

stripe_plan_id
string

The unique ID for Stripe when you use this with a subscription.

{
  • "optionitem_id": 0,
  • "option_id": 0,
  • "item_name": "string",
  • "sort_order": 0,
  • "sku_extension": "string",
  • "price_adjustment": 0,
  • "weight_adjustment": 0,
  • "enable_custom_price_label": true,
  • "custom_price_label": "string",
  • "square_id": "string",
  • "stripe_plan_id": "string"
}