Skip to content

DEVDOCS-6658 Fix issues in integrations docs #1297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TomA-R wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DEVDOCS-6658 Fix issues in integrations docs #1297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/integrations/apps/guide/best-practices.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Review the following best practices before submitting your app to the [App Marke
* Provide mechanisms that make it easy for end-users to confirm the authenticity of your app.
* Implement CSRF protection on redirect URI.

For details, see [Security Considerations in RC6749](https://tools.ietf.org/html/rfc6749#section-10). For a list of the top web application security risks and best practices to avoid them, see [OWASP Top Ten](https://owasp.org/www-project-top-ten/).
For details, see [Security Considerations in RFC 6749](https://tools.ietf.org/html/rfc6749#section-10). For a list of the top web application security risks and best practices to avoid them, see [OWASP Top Ten](https://owasp.org/www-project-top-ten/).

## API requests

Expand Down
24 changes: 12 additions & 12 deletions docs/integrations/buy-online-pick-up-in-store/api-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ You start by first creating a location. Customers can pick up their orders from
"state": "TX",
"zip": "78726",
"country_code": "US",
"phone": "+15128654500",
"phone": "+15125550100",
"geo_coordinates": {
"longitude": -97.849560,
"latitude": 30.404500
Expand All @@ -113,7 +113,7 @@ You start by first creating a location. Customers can pick up their orders from

```json filename="Example response: Create locations" showLineNumbers copy
{
"transaction_id": "f2e9c9da-8f35-403c-8f9f-d0b1b3302efbv"
"transaction_id": "f2e9c9da-8f35-403c-8f9f-d0b1b3302efb0"
}
```

Expand Down Expand Up @@ -173,7 +173,7 @@ Once a location has been created, you may choose to update its details.
"state": "TX",
"zip": "78726",
"country_code": "US",
"phone": "+15128654500",
"phone": "+15125550100",
"geo_coordinates": {
"longitude": -97.849560,
"latitude": 30.404500
Expand All @@ -200,7 +200,7 @@ Once a location has been created, you may choose to update its details.

```json filename="Example response: Update locations" showLineNumbers copy
{
"transaction_id": "d3f9c9df-8d35-403c-8f9f-d1v1b3302efbv"
"transaction_id": "d3f9c9df-8d35-403c-8f9f-d1a1b3302efb0"
}
```

Expand Down Expand Up @@ -281,11 +281,11 @@ At this point, you may have created multiple locations and want to check on all
"state": "TX",
"zip": "78726",
"email": "jane.doe@bigcommerce.com",
"phone": "+15128654500",
"phone": "+15125550100",
"geo_coordinates": {
"longitude": -97.849560,
"latitude": 30.404500
}
},
"country_code": "US"
},
"storefront_visibility": true,
Expand All @@ -303,7 +303,7 @@ At this point, you may have created multiple locations and want to check on all
},
{
"id": 3,
"code": "UPTOWN_MAYFAIR)LANE",
"code": "UPTOWN_MAYFAIR_LANE",
"label": "Uptown Location - Mayfair Lane",
"description": "Customer-facing additional details about this location.",
"managed_by_external_source": false,
Expand Down Expand Up @@ -356,11 +356,11 @@ At this point, you may have created multiple locations and want to check on all
"state": "TX",
"zip": "78726",
"email": "jane.doe@bigcommerce.com",
"phone": "+15128654500",
"phone": "+15125550100",
"geo_coordinates": {
"longitude": -120.123456,
"latitude": 60.987654
}
},
"country_code": "US"
},
"storefront_visibility": true,
Expand Down Expand Up @@ -541,7 +541,7 @@ You can make relative adjustments for inventory tracked by variant.

```json filename="Example response: Relative adjustment to inventory" showLineNumbers copy
{
"transaction_id": "d0e1c1ca-8f35-403c-8d9f-d9a1b3302efbv"
"transaction_id": "d0e1c1ca-8f35-403c-8d9f-d9a1b3302efb0"
}
```

Expand Down Expand Up @@ -687,7 +687,7 @@ At this point you may want to view inventory by location.
"variant_id": 79,
"product_id": 112
},
"available_to_sell": ,
"available_to_sell": 5,
"total_inventory_onhand": 5,
"settings": {
"safety_stock": 0,
Expand Down Expand Up @@ -916,7 +916,7 @@ Once you have assigned the pickup methods to the location(s), you can check what
"collection_instructions": "See our staff member outside of the store",
"collection_time_description": "Wait for a pickup confirmation and visit in business hours"
}
]
],
"meta": {}
}
```
Expand Down
26 changes: 13 additions & 13 deletions docs/integrations/buy-online-pick-up-in-store/end-to-end-guide/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Create one or more locations using the [Create locations](/docs/rest-management/
"state": "TX",
"zip": "78726",
"country_code": "US",
"phone": "+15128654500",
"phone": "+15125550100",
"geo_coordinates": {
"longitude": -97.849560,
"latitude": 30.404500
Expand All @@ -99,7 +99,7 @@ Create one or more locations using the [Create locations](/docs/rest-management/

```json filename="Example response: Create locations" showLineNumbers copy
{
"transaction_id": "f2e9c9da-8f35-403c-8f9f-d0b1b3302efbv"
"transaction_id": "f2e9c9da-8f35-403c-8f9f-d0b1b3302efb0"
}
```

Expand Down Expand Up @@ -159,7 +159,7 @@ After you create a location, you can update its details using the [Update locati
"state": "TX",
"zip": "78726",
"country_code": "US",
"phone": "+15128654500",
"phone": "+15125550100",
"geo_coordinates": {
"longitude": -97.849560,
"latitude": 30.404500
Expand All @@ -186,7 +186,7 @@ After you create a location, you can update its details using the [Update locati

```json filename="Example response: Update locations" showLineNumbers copy
{
"transaction_id": "d3f9c9df-8d35-403c-8f9f-d1v1b3302efbv"
"transaction_id": "d3f9c9df-8d35-403c-8f9f-d1a1b3302efb0"
}
```

Expand Down Expand Up @@ -267,11 +267,11 @@ After you create one or more locations, use the [Get locations](/docs/rest-manag
"state": "TX",
"zip": "78726",
"email": "jane.doe@bigcommerce.com",
"phone": "+15128654500",
"phone": "+15125550100",
"geo_coordinates": {
"longitude": -97.849560,
"latitude": 30.404500
}
},
"country_code": "US"
},
"storefront_visibility": true,
Expand All @@ -289,7 +289,7 @@ After you create one or more locations, use the [Get locations](/docs/rest-manag
},
{
"id": 3,
"code": "UPTOWN_MAYFAIR)LANE",
"code": "UPTOWN_MAYFAIR_LANE",
"label": "Uptown Location - Mayfair Lane",
"description": "Customer-facing additional details about this location.",
"managed_by_external_source": false,
Expand Down Expand Up @@ -342,11 +342,11 @@ After you create one or more locations, use the [Get locations](/docs/rest-manag
"state": "TX",
"zip": "78726",
"email": "jane.doe@bigcommerce.com",
"phone": "+15128654500",
"phone": "+15125550100",
"geo_coordinates": {
"longitude": -120.123456,
"latitude": 60.987654
}
},
"country_code": "US"
},
"storefront_visibility": true,
Expand Down Expand Up @@ -377,7 +377,7 @@ _Buy Online, Pick up in Store_ uses the [Inventory API](/docs/rest-management/in
* **Relative quantity** adjusts a product or variant's inventory quantity by adding to or subtracting from the existing quantity.

Before setting inventory quantity to a location, check the inventory tracking configurations that have been enabled. There are three inventory tracking configurations:
* **Inventory is tracked by product** - This setting is used if your product has no variations. For example, champagne glasses or .
* **Inventory is tracked by product** - This setting is used if your product has no variations. For example, champagne glasses or coffee mugs.
* **Inventory is tracked by variant** - This setting is used if your product has different attributes (variations), e.g. a shirt has various sizes and colors.
* **Inventory is not tracked** - This setting is used if you do not have a need to track inventory quantity, e.g. you may sell a digital asset like a PDF or digital music title. When inventory is not tracked, the product will always be considered available to sell on your storefront, even if it may not be in your physical storage location.

Expand Down Expand Up @@ -528,7 +528,7 @@ You can also make relative adjustments to inventory tracked by variant.

```json filename="Example response: Relative adjustment to inventory" showLineNumbers copy
{
"transaction_id": "d0e1c1ca-8f35-403c-8d9f-d9a1b3302efbv"
"transaction_id": "d0e1c1ca-8f35-403c-8d9f-d9a1b3302efb0"
}
```

Expand Down Expand Up @@ -676,7 +676,7 @@ At this point you may want to view inventory by location. To do so, send a reque
"variant_id": 79,
"product_id": 112
},
"available_to_sell": ,
"available_to_sell": 5,
"total_inventory_onhand": 5,
"settings": {
"safety_stock": 0,
Expand Down Expand Up @@ -908,7 +908,7 @@ Once you have assigned the pickup methods to the location(s), you can check what
"collection_instructions": "See our staff member outside the store.",
"collection_time_description": "Wait for a pickup confirmation and visit during business hours."
}
]
],
"meta": {}
}
```
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/channels/guide/extending-existing-apps.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,4 +145,4 @@ For a high-level overview and more information on Channels Toolkit, see [Channel
### Endpoints

- [Channels API Reference](/docs/rest-management/channels)
- [Sites and Rites API Reference](/docs/rest-management/sites)
- [Sites and Routes API Reference](/docs/rest-management/sites)
2 changes: 1 addition & 1 deletion docs/integrations/channels/guide/requirements.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ All Partners:
### Endpoints

- [Channels API Reference](/docs/rest-management/channels)
- [Sites and Rites API Reference](/docs/rest-management/sites)
- [Sites and Routes API Reference](/docs/rest-management/sites)
2 changes: 1 addition & 1 deletion docs/integrations/hosted-analytics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ When the shopper clicks a button to remove a product from the cart, the followin
| `event_id` | string | Unique ID for each event instance. | Unique event ID generated by BigCommerce. |
| `product_value` | number | Item price multiplied by quantity. Product default price or, if applicable, the sale price configured in the admin panel, before discounts and coupons are applied. | [Get a cart](/docs/rest-storefront/carts#get-a-cart) <br /> `lineItems.physicalItems.listPrice` or <br /> `lineItems.digitalItems.listPrice`|
| `channel_id` | string | The BigCommerce channel ID. Channel ID of the channel where checkout is taking place. | [Get all channels](/docs/rest-management/channels#get-all-channels) <br /> `data.id` |
| `currency` | string | [ISO-4217 currency code](https://www.iso.org/iso-4217-currency-codes.html) of the order. | [Get a checkout](/docs/rest-storefront/checkouts#gset-a-checkout) <br /> `data.cart.currency.code` |
| `currency` | string | [ISO-4217 currency code](https://www.iso.org/iso-4217-currency-codes.html) of the order. | [Get a checkout](/docs/rest-storefront/checkouts#get-a-checkout) <br /> `data.cart.currency.code` |
| `line_items[]` | array of `line_item` objects | Items removed from the cart. | See [line_item](#line_item-object-schema) object for event fields |

### Start checkout
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/subscriptions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ To use an alternate SQL database (e.g., SQLite), complete the following steps:
1. Update the `/prisma/schema.prisma` file with a `provider` other than `Postgresql`. For a list of options, read [Prisma's reference docs](https://www.prisma.io/docs/concepts/components/prisma-schema/data-sources).

```
databse db {
datasource db {
provider = "sqlite"
url = env("DATABASE_URL")
```
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/webhooks/https-webhook-overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Accept: application/json
"destination": "https://yourapp.example.com/webhooks", // custom ports are not supported
"is_active": true,
"headers": {
"username": "My-Custom-Header"
"username": "My-Custom-Header",
"value": "My custom header value"
}
}
Expand Down
Loading