diff --git a/docs/store-operations/draft/void/void.mdx b/docs/store-operations/draft/void/void.mdx index 432acfbea..ca11ee8f4 100644 --- a/docs/store-operations/draft/void/void.mdx +++ b/docs/store-operations/draft/void/void.mdx @@ -1,5 +1,5 @@ # Void - Void the payment for an order updating the `payment_status` to `capture pending`. + Void the payment for an order updating the `payment_status` to `void pending`. See the [Void](/docs/rest-management/transactions/payment-actions#void) endpoint for OAuth scopes, authorization, request parameters, and response information. diff --git a/docs/store-operations/metafields/store-metafields.mdx b/docs/store-operations/metafields/store-metafields.mdx index 9899e1176..3dc3500cb 100644 --- a/docs/store-operations/metafields/store-metafields.mdx +++ b/docs/store-operations/metafields/store-metafields.mdx @@ -54,8 +54,8 @@ You can create 10,000 metafields on a store entity instead of the typical limit "metafield": { "id": "bc/store/metafield/74", "description": "", - "key": "'Location", - "namespace": Warehouse Locations", + "key": "Location", + "namespace": "Warehouse Locations", "permissionSet": "APP_ONLY", "resourceId": "bc/store/store/1001197568", "value": "4HG", @@ -118,8 +118,8 @@ You can create 10,000 metafields on a store entity instead of the typical limit "metafield": { "id": "bc/store/metafield/71", "description": "", - "key": "'Location", - "namespace": Warehouse Locations", + "key": "Location", + "namespace": "Warehouse Locations", "permissionSet": "APP_ONLY", "resourceId": "bc/store/store/1001197568", "value": "4HG", diff --git a/docs/store-operations/orders/index.mdx b/docs/store-operations/orders/index.mdx index 7a25ef60a..2d44b92c7 100644 --- a/docs/store-operations/orders/index.mdx +++ b/docs/store-operations/orders/index.mdx @@ -54,7 +54,7 @@ Accept: application/json When migrating historical orders processed on another eCommerce platform to BigCommerce, supply the code **M-MIG** for the `external_source` field. This code will exclude historical orders from the store’s GMV/order count, which factors into pricing. - + * The example above contains the minimum required fields for a [create order](/docs/rest-management/orders#create-an-order) request. * The product ordered is a *custom* product; custom products do not exist in the catalog. * The V2 Orders API will not trigger the typical [Order Email](https://support.bigcommerce.com/s/article/Customizing-Emails?language=en_US) when creating orders. To create an order that does trigger this email, you can instead [create a cart](/docs/rest-management/carts/carts-single#create-a-cart) and [convert that cart into an order](/docs/rest-management/checkouts/checkout-orders#create-an-order). @@ -67,11 +67,12 @@ Once an order has products, a billing address, and a shipping address, you can c To [create an order shipment](/docs/rest-management/orders/order-shipments#create-order-shipment), send a `POST` request to `/stores/{{STORE_HASH}}/v2/orders/{{order_id}}/shipments`. ```http filename="Example request: Create an order shipment" showLineNumbers copy -POST https://api.bigcommerce.com/stores/{{STORE_HASH}}}/v2/orders/{{order_id}}/shipments +POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v2/orders/{{order_id}}/shipments X-Auth-Token: {{ACCESS_TOKEN}} Content-Type: application/json Accept: application/json +{ "tracking_number": "EJ958083578UK", "comments": "Janes Order", "order_address_id": "128", @@ -97,7 +98,7 @@ Accept: application/json |`shipping_provider`| Optional; used to create tracking link; see [Create Order Shipment](/docs/rest-management/orders/order-shipments#create-order-shipment) for accepted values| |`items.order_product_id`|Obtain with [Get Order Products](/docs/rest-management/orders/order-products). For non-variant products, use the `id`.| - + * Create multiple shipments by specifying a subset of products and quantities in each `POST` request. * Create an order shipment with product variants by using the `id` returned in each `GET` request. * Creating order shipments triggers email notifications; adjust [Order Notification](https://support.bigcommerce.com/s/article/Customer-Order-Notifications#enable) settings in the [control panel](https://login.bigcommerce.com/deep-links/manage) to change this behavior. @@ -148,7 +149,7 @@ Accept: application/json - + * If not specified, `status_id` defaults to `1`. * The refunded status is neither paid nor unpaid. * For information on changing `custom_label` in the control panel, see [Order Statuses](https://support.bigcommerce.com/s/article/Order-Statuses#rename). @@ -181,13 +182,13 @@ X-Auth-Token: {{ACCESS_TOKEN}} Accept: application/json ``` - + Set `customer_id` to `0` to create a guest order. ## Including shipping addresses -Add [shipping addresses](/docs/rest-management/orders/order-shipping-addresses#update-a-shipping-address) by including a [shipping_address array](/docs/rest-management/orders/order-shipping-addresses#update-a-shipping-address) in the [create order](/docs/rest-management/orders#create-an-orderr) request. +Add [shipping addresses](/docs/rest-management/orders/order-shipping-addresses#update-a-shipping-address) by including a [shipping_address array](/docs/rest-management/orders/order-shipping-addresses#update-a-shipping-address) in the [create order](/docs/rest-management/orders#create-an-order) request. ```http filename="Example request: add shipping addresses" showLineNumbers copy POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v2/orders @@ -209,7 +210,7 @@ Accept: application/json "zip": "12345", "country": "United States", "country_iso2": "US", - "phone": "5128675309", + "phone": "5125550100", "email": "rusty.gates@example.com" } ], @@ -217,7 +218,7 @@ Accept: application/json } ``` - + Add multiple shipping addresses to [ship to multiple locations](#shipping-to-multiple-locations). @@ -299,7 +300,7 @@ Accept: application/json - + * Custom products do not get added to the catalog. * If the product's price is not specified in the [create order](/docs/rest-management/orders#create-an-order) request, BigCommerce's pricing service calculates the price by applying applicable currency conversions and [pricing operations](/docs/store-operations/pricing/calculations) (such as [price lists](https://support.bigcommerce.com/s/article/Price-Lists) and [customer group discounts](https://support.bigcommerce.com/s/article/Customer-Groups#pricing)) to the product's catalog price; use `price_inc_tax` and `price_ex_tax` to override the calculated price. * Marketing promotions currently do not apply to orders created with the Orders API. @@ -314,7 +315,7 @@ You can create multiple shipments for orders, and each shipment can have a diffe ```http filename="Example 1: order_address_id" showLineNumbers copy -POST https://api.bigcommerce.com/stores/{{STORE_HASH}}}/v2/orders/{{order_id}}/shipments +POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v2/orders/{{order_id}}/shipments X-Auth-Token: {{ACCESS_TOKEN}} Content-Type: application/json Accept: application/json @@ -333,7 +334,7 @@ Accept: application/json ```http filename="Example 2: different order_address_id" showLineNumbers copy -POST https://api.bigcommerce.com/stores/{{STORE_HASH}}}/v2/orders/{{order_id}}/shipments +POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v2/orders/{{order_id}}/shipments X-Auth-Token: {{ACCESS_TOKEN}} Content-Type: application/json Accept: application/json @@ -447,7 +448,7 @@ BigCommerce submits tax documents to Avalara when an order moves from an **unpai | Paid or `Refunded` | Unpaid | Unpaid | Tax document voided | | Unpaid or `Refunded` | Paid | Paid | Tax document submitted | - + * Abbreviated state names (ex: `CA` instead of `California`) in an order address will cause tax document submission to fail. * You can calculate taxes using rules specified in the store unless [automatic taxes](https://support.bigcommerce.com/s/article/Automatic-Tax-Setup) are enabled. * You can optionally override tax values by specifying `price_inc_tax` and `price_ex_tax` in an [update order request](/docs/rest-management/orders#update-an-order). @@ -501,7 +502,7 @@ To [get order transactions](/docs/rest-management/transactions#get-transactions) - + Not all payment gateways return the full card or fraud detail. Depending on the payment method, different information will be available. @@ -528,7 +529,7 @@ Order `subtotal` and `total` calculate automatically; edits to the following pro You can override calculated values such as product prices, subtotals, and totals by sending a fixed value in the request. If you do not supply values for these properties, you will automatically calculate them based on the preset store values and tax rules. - + * If you override `subtotal` or `total`, override both; the system will not re-calculate the other. * To add a manual discount, overwrite the product price or `discount_amount`. diff --git a/docs/store-operations/pricing/calculations.mdx b/docs/store-operations/pricing/calculations.mdx index f7e742878..06b32895d 100644 --- a/docs/store-operations/pricing/calculations.mdx +++ b/docs/store-operations/pricing/calculations.mdx @@ -17,7 +17,7 @@ The table below lists each price type available on a product. The table is read | Customer group discount | Available in fixed ($5), relative (-$2), or percentage (-25%) amount that overrides the variant sale price. Might apply to one product, category, subcategory, or the entire store's products. Customer group discounts do not apply to price list prices. | | Product bulk pricing | Available in fixed ($5), relative (-$2), or percentage (-25%) amount that overrides the customer group discount. Dependent on the total quantity of a single product added to the cart. Product bulk pricing will not apply for SKUs that have price list prices. | | Product product pick list | If you configure the product pick list to change the price, it will update the price and override the product modifier when the option is selected. | -Discounts | When a shopper meets certain criteria or takes certain actions to automatically modify the final product or cart price depending on the discount type. | +| Discounts | When a shopper meets certain criteria or takes certain actions to automatically modify the final product or cart price depending on the discount type. | | Coupons | Coupons require customer action to take effect and modify the final product or cart price depending on the coupon type. | | Tax | You can assign products to different tax classes, which will change the final amount the shopper pays. Tax is the last to calculate after shipping and promotions are applied. | diff --git a/docs/store-operations/promotions/examples/brand.mdx b/docs/store-operations/promotions/examples/brand.mdx index e60eb5e4d..d5841b414 100644 --- a/docs/store-operations/promotions/examples/brand.mdx +++ b/docs/store-operations/promotions/examples/brand.mdx @@ -5,7 +5,7 @@ - ```json filename="Example request" showlineNumbers copy + ```json filename="Example request" showLineNumbers copy { "name": "Order $100 of this common good brand and get free shipping", "redemption_type": "AUTOMATIC", @@ -148,7 +148,7 @@ - ```json filename="Example request" showlineNumbers copy + ```json filename="Example request" showLineNumbers copy { "name": "Apply a $ or % discount to each item in one or more brands", "redemption_type": "AUTOMATIC", diff --git a/docs/store-operations/promotions/examples/category.mdx b/docs/store-operations/promotions/examples/category.mdx index dcdf36a00..b28d5c388 100644 --- a/docs/store-operations/promotions/examples/category.mdx +++ b/docs/store-operations/promotions/examples/category.mdx @@ -7,7 +7,7 @@ - ```json filename="Example request" showlineNumbers copy + ```json filename="Example request" showLineNumbers copy { "name": "20 dollars off all garden material", "redemption_type": "AUTOMATIC", @@ -143,7 +143,7 @@ - ```json filename="Example request" showlineNumbers copy + ```json filename="Example request" showLineNumbers copy { "name": "20 dollars off all garden material, exclude items on sale", "redemption_type": "AUTOMATIC", diff --git a/docs/store-operations/promotions/examples/customer.mdx b/docs/store-operations/promotions/examples/customer.mdx index 41d0a96be..e75a386db 100644 --- a/docs/store-operations/promotions/examples/customer.mdx +++ b/docs/store-operations/promotions/examples/customer.mdx @@ -82,7 +82,7 @@ - ```json filename="Example request" showlineNumbers copy + ```json filename="Example request" showLineNumbers copy { "name": "5% off for non-VIP customers", "redemption_type": "AUTOMATIC", @@ -566,10 +566,11 @@ } ``` + ## 10% off for customers who belong to segment 3 or customers who belong to segment 1 and segment 2 (Closed Beta) - + ```json filename="Example request" showLineNumbers copy @@ -676,4 +677,3 @@ ``` - diff --git a/docs/store-operations/promotions/examples/multiple-rules.mdx b/docs/store-operations/promotions/examples/multiple-rules.mdx index f19d38594..822cabefd 100644 --- a/docs/store-operations/promotions/examples/multiple-rules.mdx +++ b/docs/store-operations/promotions/examples/multiple-rules.mdx @@ -198,7 +198,7 @@ - ```json filename="Example request" showlineNumbers copy + ```json filename="Example request" showLineNumbers copy { "name": "Apply a tiered discount to applicable products based on the quantity of items ordered within X ", "redemption_type": "AUTOMATIC", diff --git a/docs/store-operations/promotions/examples/order.mdx b/docs/store-operations/promotions/examples/order.mdx index 4509ec5f4..dae639fc0 100644 --- a/docs/store-operations/promotions/examples/order.mdx +++ b/docs/store-operations/promotions/examples/order.mdx @@ -125,7 +125,7 @@ - ```json filename="Example request" showlineNumbers copy + ```json filename="Example request" showLineNumbers copy { "name": "Spend $X and get $X off order", "redemption_type": "AUTOMATIC", diff --git a/docs/store-operations/promotions/examples/product.mdx b/docs/store-operations/promotions/examples/product.mdx index 236a4ab62..3c36241d8 100644 --- a/docs/store-operations/promotions/examples/product.mdx +++ b/docs/store-operations/promotions/examples/product.mdx @@ -146,7 +146,7 @@ - ```json filename="Example request" showlineNumbers copy + ```json filename="Example request" showLineNumbers copy { "name": "Buy two X and get 10% off Y", "redemption_type": "AUTOMATIC", diff --git a/docs/store-operations/promotions/examples/shipping.mdx b/docs/store-operations/promotions/examples/shipping.mdx index b6c2e0682..295d1d3d5 100644 --- a/docs/store-operations/promotions/examples/shipping.mdx +++ b/docs/store-operations/promotions/examples/shipping.mdx @@ -130,7 +130,7 @@ - ```json filename="Example request" showlineNumbers copy + ```json filename="Example request" showLineNumbers copy { "name": "Order at least X units of product Y and get free shipping to specific shipping zones", "redemption_type": "AUTOMATIC", diff --git a/docs/store-operations/settings/locales.mdx b/docs/store-operations/settings/locales.mdx index 2f1b41825..dee4d99c9 100644 --- a/docs/store-operations/settings/locales.mdx +++ b/docs/store-operations/settings/locales.mdx @@ -56,24 +56,24 @@ This query returns a static list of all locales currently supported by the platf { "code": "ua", "englishName": "Ukrainian", - "hasBuiltInTranslations": "false" + "hasBuiltInTranslations": false }, { "code": "en-US", "englishName": "English (United States)", - "hasBuiltInTranslations": "true" + "hasBuiltInTranslations": true }, { "code": "en-UK", "englishName": "English (United Kingdom)", - "hasBuiltInTranslations": "true" + "hasBuiltInTranslations": true }, { "code": "fr", "englishName": "French", - "hasBuiltInTranslations": "true" + "hasBuiltInTranslations": true } - } + ] } } ``` @@ -108,7 +108,7 @@ The following query returns channel locales. { "data": { "store": { - "locales": + "locales": { "edges": [ { "node": { @@ -121,6 +121,7 @@ The following query returns channel locales. } } } + } ``` @@ -158,7 +159,7 @@ The following mutation adds a locale. { "data": { "locales": { - "addlocale": + "addLocale": { "locale": { "code": "fr", "status": "INACTIVE", diff --git a/docs/store-operations/shipping/packing-slips.mdx b/docs/store-operations/shipping/packing-slips.mdx index 646a405bb..8856ea6d6 100644 --- a/docs/store-operations/shipping/packing-slips.mdx +++ b/docs/store-operations/shipping/packing-slips.mdx @@ -27,12 +27,12 @@ The following variables are available within the printable packing slip template | `%%GLOBAL_CustomerName%%` | Customer's name | | `%%GLOBAL_CustomerEmail%%` | Customer's email address | | `%%GLOBAL_CustomerId%%` | Customer's ID | -| `%%LNG_LabelPickupDetails%%` | Pickup details(if is pickup method) | -| `%%LNG_LabelPickupMethod%%` | Pickup method(if is pickup method) | -| `%%GLOBAL_LocationName%%` | Name of location(if is pickup method) | -| `%%GLOBAL_PickupAddress%%` | Pickup address(if is pickup method) | -| `%%GLOBAL_PickupPhone%%` | Pickup phone number(if is pickup method - pairs with HidePickupPhone) | -| `%%GLOBAL_PickupEmail%%` | Pickup email address(if is pickup method - pairs with HidePickupEmail) | +| `%%LNG_LabelPickupDetails%%` | Pickup details (if is pickup method) | +| `%%LNG_LabelPickupMethod%%` | Pickup method (if is pickup method) | +| `%%GLOBAL_LocationName%%` | Name of location (if is pickup method) | +| `%%GLOBAL_PickupAddress%%` | Pickup address (if is pickup method) | +| `%%GLOBAL_PickupPhone%%` | Pickup phone number (if is pickup method - pairs with HidePickupPhone) | +| `%%GLOBAL_PickupEmail%%` | Pickup email address (if is pickup method - pairs with HidePickupEmail) | | `%%GLOBAL_StoreAddressFormatted%%`| Formatted store address | | `%%GLOBAL_StorePhoneNumber%%` | Store phone number | | `%%GLOBAL_StoreNameFormatted%%` | Formatted store name | @@ -46,17 +46,17 @@ The following variables are available within the printable packing slip template | `%%GLOBAL_PackingSlipTitle%%` | Title of packing slip | | `%%GLOBAL_OrderId%%` | Order ID number | | `%%GLOBAL_OrderDate%%` | Order date | -| `%%GLOBAL_TrackingNo%%` | Shipment tracking number(if available otherwise `HideTrackingNo` is set)| -| `%%GLOBAL_Comments%%` | Your comments(pairs with `HideComments`) | -| `%%GLOBAL_DateShipped%%` | Shipment date(pairs with `HideShippingDate`) | +| `%%GLOBAL_TrackingNo%%` | Shipment tracking number (if available otherwise `HideTrackingNo` is set)| +| `%%GLOBAL_Comments%%` | Your comments (pairs with `HideComments`) | +| `%%GLOBAL_DateShipped%%` | Shipment date (pairs with `HideShippingDate`) | | `%%GLOBAL_BillingAddress%%` | Billing address | -| `%%GLOBAL_BillingPhone%%` | Billing phone(pairs with `HideBillingPhone`) | -| `%%GLOBAL_BillingEmail%%` | Billing email(pairs with `HideBillingEmail`) | -| `%%GLOBAL_PickupMethod%%` | Pickup method(pairs with `HidePickupMethod`) | +| `%%GLOBAL_BillingPhone%%` | Billing phone (pairs with `HideBillingPhone`) | +| `%%GLOBAL_BillingEmail%%` | Billing email (pairs with `HideBillingEmail`) | +| `%%GLOBAL_PickupMethod%%` | Pickup method (pairs with `HidePickupMethod`) | | `%%GLOBAL_ShippingAddress%%` | Shipping address | -| `%%GLOBAL_ShippingPhone%%` | Shipping phone number(pairs with `HideShippingPhone`) | -| `%%GLOBAL_ShippingEmail%%` | Shipping email address(pairs with `HideShippingEmail`) | -| `%%GLOBAL_ShippingMethod%%` | Shipping method(pairs with `HideShippingMethod`) | +| `%%GLOBAL_ShippingPhone%%` | Shipping phone number (pairs with `HideShippingPhone`) | +| `%%GLOBAL_ShippingEmail%%` | Shipping email address (pairs with `HideShippingEmail`) | +| `%%GLOBAL_ShippingMethod%%` | Shipping method (pairs with `HideShippingMethod`) | | `%%GLOBAL_ProductsTable%%` | List of products | The following variables are available for HTML elements to alter CSS styling. @@ -70,7 +70,7 @@ If you were to use `%%GLOBAL_ShippingPhone%%` somewhere, then it should be enclo | Variable | Description | |:----------------------------------|:-------------------------------------------------------------| -| `%%GLOBAL_HideCustomerDetails%%` | Hidden customer details(works with the CustomerX variables) | +| `%%GLOBAL_HideCustomerDetails%%` | Hidden customer details (works with the CustomerX variables) | | `%%GLOBAL_HideTrackingNo%%` | Hidden shipment tracking number | | `%%GLOBAL_HideComments%%` | Hidden comments | | `%%GLOBAL_HideShippingDate%%` | Hidden shipment date | diff --git a/docs/store-operations/tax/tax-properties.mdx b/docs/store-operations/tax/tax-properties.mdx index e54835cb0..aebf148e9 100644 --- a/docs/store-operations/tax/tax-properties.mdx +++ b/docs/store-operations/tax/tax-properties.mdx @@ -43,13 +43,13 @@ The response provides an `id` for each tax property. Use the `id` to get, update { "code": "alcohol-percentage", "display_name": "Alcohol Percentage", - "description": "Beverage Industry" + "description": "Beverage Industry", "type": "PRODUCT" }, { "code": "erp-external-id", "display_name": "ERP Customer ID", - "description": "External ID used to link customer records with ERP systems" + "description": "External ID used to link customer records with ERP systems", "type": "CUSTOMER" } ]