`.
*
* @example America/Chicago
*/
readonly name?: string;
/**
* @description A negative or positive number, identifying the offset from UTC/GMT, in seconds, during winter/standard time.
* @example -21600
*/
readonly raw_offset?: number;
/**
* @description A negative or positive number, identifying the offset from UTC/GMT, in seconds, during summer/daylight saving time.
* @example -18000
*/
readonly dst_offset?: number;
/**
* @description A boolean indicating whether this time zone observes daylight saving time.
* @example true
*/
readonly dst_correction?: boolean;
readonly date_format?: components["schemas"]["dateFormat"];
};
/**
* count_Response
* @example {
* "count": 27
* }
*/
readonly count_Response: {
/** @example 27 */
readonly count?: number;
};
/** dateFormat */
readonly dateFormat: {
/**
* @description A string that defines dates’ display formats, in the pattern: M jS Y
* @example M jS Y
*/
readonly display?: string;
/**
* @description A string that defines the CSV export format for orders, customers, and products, in the pattern: M jS Y
* @example M jS Y
*/
readonly export?: string;
/**
* @description A string that defines dates’ extended-display format, in the pattern: M jS Y @ g:i A.
* @example M jS Y @ g:i A
*/
readonly extended_display?: string;
};
/** blogTags */
readonly blogTags: readonly {
/** @example Blog */
readonly tag?: string;
/** @example [
* 1,
* 2,
* 4
* ] */
readonly post_ids?: readonly number[];
}[];
/**
* blogPost_Base_Post
* @description blogPost base for POST requests
* @example {
* "title": "Welcome to BigCommerce",
* "url": "/blog/welcome-bigcommerce/",
* "preview_url": "/blog/welcome-bigcommerce/",
* "body": "Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.
",
* "tags": [
* "string"
* ],
* "summary": "We power ecommerce websites for successful retailers all over the world
",
* "is_published": true,
* "published_date": "Thu, 18 May 2023 13:26:42 -0000",
* "published_date_iso8601": "5/18/2023 1:26:42 PM",
* "meta_description": "Welcome Post",
* "meta_keywords": "BigCommerce, welcome, ecommerce",
* "author": "BigCommerce",
* "thumbnail_path": "string"
* }
*/
readonly blogPost_Base_Post: {
/**
* @description Title of this blog post.
* @example Welcome to BigCommerce
*/
readonly title: string;
/**
* @description URL for the public blog post.
* @example /blog/welcome-bigcommerce/
*/
readonly url?: string;
/**
* @description Text body of the blog post.
* @example Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.
*/
readonly body: string;
/** @description Tags to characterize the blog post. */
readonly tags?: readonly string[];
/**
* @description Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request.
* @default false
* @example true
*/
readonly is_published: boolean;
/**
* @description Description text for this blog post’s `` element.
* @example Welcome Post
*/
readonly meta_description?: string;
/**
* @description Keywords for this blog post’s `` element.
* @example BigCommerce, welcome, ecommerce
*/
readonly meta_keywords?: string;
/**
* @description Name of the blog post’s author.
* @example BigCommerce
*/
readonly author?: string;
/** @description Local path to a thumbnail uploaded to `/product_images/` using [WebDAV](https://support.bigcommerce.com/s/article/File-Access-WebDAV). */
readonly thumbnail_path?: string;
/** @example Wed, 10 Aug 2022 15:39:15 -0500 */
readonly published_date?: string;
};
/**
* blogPost_Base
* @example {
* "title": "Welcome to BigCommerce",
* "url": "/blog/welcome-bigcommerce/",
* "preview_url": "/blog/welcome-bigcommerce/",
* "body": "Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.
",
* "tags": [
* "string"
* ],
* "summary": "We power ecommerce websites for successful retailers all over the world
",
* "is_published": true,
* "published_date": {
* "timezone_type": 1,
* "date": "2018-05-18T08:26:42Z",
* "timezone": "+00:00"
* },
* "published_date_iso8601": "5/18/2018 1:26:42 PM",
* "meta_description": "Welcome Post",
* "meta_keywords": "BigCommerce, welcome, ecommerce",
* "author": "BigCommerce",
* "thumbnail_path": "string"
* }
*/
readonly blogPost_Base: {
/**
* @description Title of this blog post.
* @example Welcome to BigCommerce
*/
readonly title: string;
/**
* @description URL for the public blog post.
* @example /blog/welcome-bigcommerce/
*/
readonly url?: string;
/**
* @description URL to preview the blog post. READ-ONLY.
* @example /blog/welcome-bigcommerce/
*/
readonly preview_url?: string;
/**
* @description Text body of the blog post.
* @example Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.
*/
readonly body: string;
/** @description Tags to characterize the blog post. */
readonly tags?: readonly string[];
/**
* @description Summary of the blog post. READ-ONLY.
* @example We power ecommerce websites for successful retailers all over the world
*/
readonly summary?: string;
/**
* @description Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request.
* @default false
* @example true
*/
readonly is_published: boolean;
readonly published_date?: components["schemas"]["publishedDate"];
/**
* @description Published date in `ISO 8601` format.
* @example 5/18/2023 1:26:42 PM
*/
readonly published_date_iso8601?: string;
/**
* @description Description text for this blog post’s `` element.
* @example Welcome Post
*/
readonly meta_description?: string;
/**
* @description Keywords for this blog post’s `` element.
* @example BigCommerce, welcome, ecommerce
*/
readonly meta_keywords?: string;
/**
* @description Name of the blog post’s author.
* @example BigCommerce
*/
readonly author?: string;
/** @description Local path to a thumbnail uploaded to `/product_images/` using [WebDAV](https://support.bigcommerce.com/s/article/File-Access-WebDAV). */
readonly thumbnail_path?: string;
};
/**
* blogPost_Base_Res
* @description blog post base response
*/
readonly blogPost_Base_Res: {
/**
* @description Title of this blog post.
* @example Welcome to BigCommerce
*/
readonly title?: string;
/**
* @description URL for the public blog post.
* @example /blog/welcome-bigcommerce/
*/
readonly url?: string;
/**
* @description URL to preview the blog post. READ-ONLY.
* @example /blog/welcome-bigcommerce/
*/
readonly preview_url?: string;
/**
* @description Text body of the blog post.
* @example Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.
*/
readonly body?: string;
/** @description Tags to characterize the blog post. */
readonly tags?: readonly string[];
/**
* @description Summary of the blog post. READ-ONLY.
* @example We power ecommerce websites for successful retailers all over the world
*/
readonly summary?: string;
/**
* @description Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request.
* @default false
* @example true
*/
readonly is_published: boolean;
readonly published_date?: components["schemas"]["publishedDate"];
/**
* @description Published date in `ISO 8601` format.
* @example 5/18/2023 1:26:42 PM
*/
readonly published_date_iso8601?: string;
/**
* @description Description text for this blog post’s `` element.
* @example Welcome Post
*/
readonly meta_description?: string | null;
/**
* @description Keywords for this blog post’s `` element.
* @example BigCommerce, welcome, ecommerce
*/
readonly meta_keywords?: string | null;
/**
* @description Name of the blog post’s author.
* @example BigCommerce
*/
readonly author?: string | null;
/** @description Local path to a thumbnail uploaded to `/product_images/` using [WebDAV](https://support.bigcommerce.com/s/article/File-Access-WebDAV). */
readonly thumbnail_path?: string | null;
};
readonly publishedDate: {
/** @example 1 */
readonly timezone_type?: number;
/**
* Format: date-time
* @example 2022-08-10 14:39:15.000000
*/
readonly date?: string;
/** @example +00:00 */
readonly timezone?: string;
};
/** @description Not returned in any responses, but accepts up to two fields allowing you to set the customer’s password. If a password is not supplied, it is generated automatically. For further information about using this object, please see the Customers resource documentation. */
readonly authentication: {
readonly force_reset?: string;
readonly password?: string;
readonly password_confirmation?: string;
};
/** page_Base */
readonly page_Base: {
/**
* @description channel ID
* @example 11
*/
readonly channel_id?: number;
/**
* @description Page name, as displayed on the storefront.
* @example Contact Form
*/
readonly name: string;
/** @description Text specified for this page’s `` element. If empty, the value of the name property is used. */
readonly meta_title?: string;
/**
* @description HTML or variable that populates this page’s `<body>` element, in default/desktop view. Required in POST if page type is `raw`.
* @example <p>We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.</p>
*/
readonly body: string;
/**
* @description If true, this page appears in the storefront’s navigation menu.
* @example true
*/
readonly is_visible?: boolean;
/**
* @description ID of any parent Web page.
* @example 5
*/
readonly parent_id?: number;
/**
* @description Order in which this page should display on the storefront. (Lower integers specify earlier display.)
* @example 3
*/
readonly sort_order?: number;
/** @description Comma-separated list of SEO-relevant keywords to include in the page’s `<meta/>` element. */
readonly meta_keywords?: string;
/**
* @description `page`: free-text page
* `link`: link to another web address
* `contact_form`: When the store’s contact form is used
*
* @enum {string}
*/
readonly type: "page" | "contact_form" | "raw" | "link";
/** @description Description contained within this page’s `<meta/>` element. */
readonly meta_description?: string;
/**
* @description If true, this page is the storefront’s home page.
* @example false
*/
readonly is_homepage?: boolean;
/**
* @description If true, this page is for customers only.
* @example false
*/
readonly is_customers_only?: boolean;
/** @description Comma-separated list of keywords that shoppers can use to locate this page when searching the store. */
readonly search_keywords?: string;
/**
* @description If true, this page has a mobile version. (For Blueprint themes only)
* @example false
*/
readonly has_mobile_version?: boolean;
/**
* @description HTML to use for this page’s body when viewed in the mobile template (deprecated - Blueprint themes only).
* @example 0
*/
readonly mobile_body?: string;
/**
* @description Where the page’s type is a contact form: object whose members are the fields enabled (in the control panel) for storefront display. Possible members are:`fullname`: full name of the customer submitting the form; `phone`: customer’s phone number, as submitted on the form; `companyname`: customer’s submitted company name; `orderno`: customer’s submitted order number; `rma`: customer’s submitted RMA (Return Merchandise Authorization) number.
* @example fullname,companyname,phone,orderno,rma
*/
readonly contact_fields?: string;
/**
* @description Where the page’s type is a contact form, the email address that receives messages sent using the form.
* @example janedoes@example.com
*/
readonly email?: string;
/**
* @description Relative URL on the storefront for this page.
* @example /contact-us/
*/
readonly url?: string;
/**
* @description Layout template for this page. This field is writable only for stores with a Blueprint theme applied.
* @example page.html
*/
readonly layout_file?: string;
/** @description If page type is `link` this field is returned. Required in POST to create a `link` page. */
readonly link?: string;
/**
* @example text/html
* @enum {string}
*/
readonly content_type?: "application/json" | "text/javascript" | "text/html";
};
/** page_Base_Res */
readonly page_Base_Res: {
/**
* @description Channel ID.
* @example 11
*/
readonly channel_id?: number;
/**
* @description Page name, as displayed on the storefront.
* @example Contact Form
*/
readonly name?: string;
/** @description Text specified for this page's `<title>` element. If empty, the value of the name property is used. */
readonly meta_title?: string;
/**
* @description Where the page’s type is a contact form, the email address that receives messages sent using the form.
* @example janedoe@example.com
*/
readonly email?: string;
/**
* @description HTML or variable that populates this page’s `<body>` element, in default/desktop view. Required in POST if page type is `raw`.
* @example <p>We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.</p>
*/
readonly body?: string;
/**
* @description If true, this page appears in the storefront navigation menu.
* @example true
*/
readonly is_visible?: boolean;
/**
* @description ID of any parent Web page.
* @example 5
*/
readonly parent_id?: number;
/**
* @description Order in which this page should display on the storefront. (Lower integers specify earlier display.)
* @example 3
*/
readonly sort_order?: number;
/** @description Comma-separated list of SEO-relevant keywords to include in the page's `<meta/>` element. */
readonly meta_keywords?: string;
/**
* @description `page`: free-text page
* `link`: link to another web address
* `contact_form`: When the store’s contact form is used
*
* @enum {string}
*/
readonly type?: "page" | "contact_form" | "raw" | "link";
/**
* @description Where the page’s type is a contact form - object whose members are the fields enabled (in the control panel) for storefront display. Possible members are:`fullname` - full name of the customer submitting the form; `phone` - customer’s phone number, as submitted on the form; `companyname`- customer’s submitted company name; `orderno`- customer’s submitted order number; `rma` - customer’s submitted RMA (Return Merchandise Authorization) number.
* @example fullname,companyname,phone,orderno,rma
*/
readonly contact_fields?: string;
/**
* @description Description contained within this page’s `<meta/>` element. HTML to use for this page’s body when viewed in the mobile template.
* @example 0
*/
readonly meta_description?: string;
/**
* @description If true, this page is the storefront’s home page.
* @example false
*/
readonly is_homepage?: boolean;
/**
* @description Layout template for this page. This field is writable only for stores with a Blueprint theme applied.
* @example page.html
*/
readonly layout_file?: string;
/**
* @description If true, this page is for customers only.
* @example false
*/
readonly is_customers_only?: boolean;
/** @description Comma-separated list of keywords that shoppers can use to locate this page when searching the store. */
readonly search_keywords?: string;
/**
* @description If true, this page has a mobile version. (For Blueprint themes only)
* @example false
*/
readonly has_mobile_version?: boolean;
/**
* @description HTML to use for this page’s body when viewed in the mobile template (deprecated - Blueprint only).
* @example 0
*/
readonly mobile_body?: string;
/**
* @example text/html
* @enum {string}
*/
readonly content_type?: "application/json" | "text/javascript" | "text/html";
/**
* @description Relative URL on the storefront for this page.
* @example /contact-us/
*/
readonly url?: string;
/** @description If page type is `link`, this field is returned. */
readonly link?: string;
};
};
responses: never;
parameters: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept: string;
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */
readonly ContentType: string;
};
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
readonly getBlogTags: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path?: never;
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
readonly "application/json": readonly components["schemas"]["blogTags"][];
};
};
};
};
readonly getBlogPosts: {
readonly parameters: {
readonly query?: {
/** @description Filter param. */
readonly is_published?: boolean;
/** @description Filter param. Value must be URL encoded. */
readonly url?: string;
/** @description Filter param. */
readonly tag?: string;
/** @description Filter param. */
readonly published_date?: string;
/** @description Filter param. */
readonly page?: number;
/** @description Filter param. */
readonly limit?: number;
};
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path?: never;
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
/** @example [
* {
* "id": 3,
* "title": "Hello Again",
* "url": "/blog/hello-again/",
* "preview_url": "/blog/hello-again/",
* "body": "<p>Jelly beans muffin marzipan gingerbread donut dessert. Cheesecake cheesecake sugar plum cookie cake tart. Soufflé sesame snaps jelly beans brownie chocolate tart. Marshmallow jujubes candy pie. Gummies lemon drops tart soufflé pastry pie. Caramels wafer biscuit gummi bears. Liquorice toffee wafer bear claw marzipan jelly-o. Dessert bear claw topping icing croissant. Pie bonbon chocolate bar chocolate bar tiramisu chocolate lemon drops candy.</p><p>Marshmallow cupcake sweet roll candy marshmallow caramels cotton candy pie icing. Powder jelly beans chupa chups lollipop liquorice marzipan dessert soufflé sesame snaps. Macaroon chupa chups gummies cheesecake ice cream caramels sesame snaps cotton candy gingerbread. Chocolate cake fruitcake tart bear claw lemon drops tart dragée tart apple pie. Halvah chupa chups soufflé jelly soufflé marshmallow. Croissant tart tart. Gingerbread apple pie biscuit.</p><p>Wafer lemon drops tart pastry brownie chocolate bar jelly. Dragée muffin cupcake liquorice caramels marzipan gingerbread marzipan. Apple pie pudding jelly sweet roll croissant bonbon wafer. Cookie chocolate bar sesame snaps bonbon macaroon candy canes donut sugar plum. Bear claw bonbon tootsie roll bonbon. Apple pie gummies donut sweet. Marzipan bear claw cotton candy topping dragée bonbon danish powder.</p>",
* "tags": [
* "sugar",
* "sweet",
* "spice",
* "everything",
* "nice"
* ],
* "summary": "Jelly beans muffin marzipan gingerbread donut dessert. Cheesecake cheesecake sugar plum cookie cake tart. Soufflé sesame snaps jelly beans brownie chocolate tart. Marshmallow jujubes candy pie. Gummies lemon drops tart soufflé pastry pie. Caramels wafer biscuit gummi bears. Liquorice toffee wafer bear claw marzipan jelly-o. Dessert bear claw topping icing croissant. Pie bonbon chocolate bar [...]",
* "is_published": true,
* "published_date": {
* "date": "2018-05-18 08:26:42.000000",
* "timezone_type": 1,
* "timezone": "+00:00"
* },
* "published_date_iso8601": "2018-05-18T13:26:42+0000",
* "meta_description": "Cupcakes post 2",
* "meta_keywords": "sugar,sweet,spice,everything,nice",
* "author": "",
* "thumbnail_path": ""
* },
* {
* "id": 2,
* "title": "Hello",
* "url": "/blog/hello/",
* "preview_url": "/blog/hello/",
* "body": "<p>Jelly beans muffin marzipan gingerbread donut dessert. Cheesecake cheesecake sugar plum cookie cake tart. Soufflé sesame snaps jelly beans brownie chocolate tart. Marshmallow jujubes candy pie. Gummies lemon drops tart soufflé pastry pie. Caramels wafer biscuit gummi bears. Liquorice toffee wafer bear claw marzipan jelly-o. Dessert bear claw topping icing croissant. Pie bonbon chocolate bar chocolate bar tiramisu chocolate lemon drops candy.</p><p>Marshmallow cupcake sweet roll candy marshmallow caramels cotton candy pie icing. Powder jelly beans chupa chups lollipop liquorice marzipan dessert soufflé sesame snaps. Macaroon chupa chups gummies cheesecake ice cream caramels sesame snaps cotton candy gingerbread. Chocolate cake fruitcake tart bear claw lemon drops tart dragée tart apple pie. Halvah chupa chups soufflé jelly soufflé marshmallow. Croissant tart tart. Gingerbread apple pie biscuit.</p><p>Wafer lemon drops tart pastry brownie chocolate bar jelly. Dragée muffin cupcake liquorice caramels marzipan gingerbread marzipan. Apple pie pudding jelly sweet roll croissant bonbon wafer. Cookie chocolate bar sesame snaps bonbon macaroon candy canes donut sugar plum. Bear claw bonbon tootsie roll bonbon. Apple pie gummies donut sweet. Marzipan bear claw cotton candy topping dragée bonbon danish powder.</p>",
* "tags": [
* "cupcakes",
* "sugar",
* "sweet"
* ],
* "summary": "Jelly beans muffin marzipan gingerbread donut dessert. Cheesecake cheesecake sugar plum cookie cake tart. Soufflé sesame snaps jelly beans brownie chocolate tart. Marshmallow jujubes candy pie. Gummies lemon drops tart soufflé pastry pie. Caramels wafer biscuit gummi bears. Liquorice toffee wafer bear claw marzipan jelly-o. Dessert bear claw topping icing croissant. Pie bonbon chocolate bar [...]",
* "is_published": true,
* "published_date": {
* "date": "2018-05-18 08:26:00.000000",
* "timezone_type": 1,
* "timezone": "+00:00"
* },
* "published_date_iso8601": "2018-05-18T13:26:00+0000",
* "meta_description": "cupcake blog post",
* "meta_keywords": "cupcakes,sugar,sweet",
* "author": "",
* "thumbnail_path": ""
* },
* {
* "id": 1,
* "title": "Your first blog post!",
* "url": "/your-first-blog-post/",
* "preview_url": "/your-first-blog-post/",
* "body": "<p><strong>Welcome to your blog!</strong><br> A blog is a great place to share details on your products, business and whatever else you think your shoppers might like to hear from you. You can include photos in your blog posts and even videos. For ideas and inspiration on how to structure your blog, take a look at the BigCommerce <a href='http://blog.bigcommerce.com/' target='_blank' rel='nofollow'>ecommerce blog</a>.</p><p><strong>How can I delete this post?</strong><br>To delete this post and add your own, login to your <a href='/admin' target='_blank'>admin area</a> and go to Storefront > Blog in the left hand menu.</p><p><strong>Powered by BigCommerce</strong><br>Your website, online store and blog are powered by BigCommerce <a href='http://www.bigcommerce.com/' target='_blank' rel='nofollow'>ecommerce software</a>. It includes everything you need to run a beautiful online store including <a href='http://www.bigcommerce.com/templates/' target='_blank' rel='nofollow'>ecommerce website templates</a>, <a href='http://www.bigcommerce.com/features/hosting/' target='_blank' rel='nofollow'>ecommerce hosting</a>, an <a href='http://www.bigcommerce.com/features/setup/' target='_blank' rel='nofollow'>online shopping cart</a> and more.</p>",
* "tags": [
* "Blog",
* "SEO"
* ],
* "summary": " Welcome to your blog! A blog is a great place to share details on your products, business and whatever else you think your shoppers might like to hear from you. You can include photos in your blog posts and even videos. For ideas and inspiration on how to structure your blog, take a look [...]",
* "is_published": true,
* "published_date": {
* "date": "2014-02-15 14:46:34.000000",
* "timezone_type": 1,
* "timezone": "+00:00"
* },
* "published_date_iso8601": "2014-02-15T19:46:34+0000",
* "meta_description": "",
* "meta_keywords": "Blog,SEO",
* "author": "",
* "thumbnail_path": ""
* }
* ] */
readonly "application/json": readonly components["schemas"]["blogPost_Full"][];
};
};
};
};
readonly createBlogPosts: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */
readonly "Content-Type"?: components["parameters"]["ContentType"];
};
readonly path?: never;
readonly cookie?: never;
};
readonly requestBody: {
readonly content: {
readonly "application/json": components["schemas"]["blogPost_Base_Post"];
};
};
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
/** @example {
* "id": 3,
* "title": "Welcome to BigCommerce",
* "url": "/blog/welcome-bigcommerce/",
* "preview_url": "/blog/welcome-bigcommerce/",
* "body": "<p>Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform. </p>",
* "tags": [
* "BigCommerce",
* "welcome",
* "ecommerce"
* ],
* "summary": "<p>We power ecommerce websites for successful retailers all over the world</p>",
* "is_published": true,
* "published_date": {
* "date": "2018-05-18T08:26:42.000Z",
* "timezone_type": 1,
* "timezone": "+00:00"
* },
* "published_date_iso8601": "2018-05-18T13:26:42.000Z",
* "meta_description": "Welcome Post",
* "meta_keywords": "BigCommerce, welcome, ecommerce",
* "author": "BigCommerce",
* "thumbnail_path": ""
* } */
readonly "application/json": components["schemas"]["blogPost_Base_Res"];
};
};
/** @description Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occurred, such as when a `POST` or `PUT` request is successful, but saving the URL has failed. */
readonly 207: {
headers: {
readonly [name: string]: unknown;
};
content: {
readonly "application/json": {
readonly [key: string]: unknown;
};
};
};
};
};
readonly deleteBlogPosts: {
readonly parameters: {
readonly query?: {
/** @description Filter param. */
readonly page?: number;
/** @description Filter param. */
readonly limit?: number;
};
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path?: never;
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 204: {
headers: {
readonly [name: string]: unknown;
};
content?: never;
};
};
};
readonly getBlogPost: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path: {
/** @description ID of the blog post. */
readonly id: number;
};
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
/** @example {
* "id": 3,
* "title": "Welcome to BigCommerce",
* "url": "/blog/welcome-bigcommerce/",
* "preview_url": "/blog/welcome-bigcommerce/",
* "body": "<p>Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform. </p>",
* "tags": [
* "BigCommerce",
* "welcome",
* "ecommerce"
* ],
* "summary": "<p>We power ecommerce websites for successful retailers all over the world</p>",
* "is_published": true,
* "published_date": {
* "date": "2018-05-18T08:26:42.000Z",
* "timezone_type": 1,
* "timezone": "+00:00"
* },
* "published_date_iso8601": "2018-05-18T13:26:42.000Z",
* "meta_description": "Welcome Post",
* "meta_keywords": "BigCommerce, welcome, ecommerce",
* "author": "BigCommerce",
* "thumbnail_path": ""
* } */
readonly "application/json": components["schemas"]["blogPost_Full"];
};
};
};
};
readonly updateBlogPost: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */
readonly "Content-Type"?: components["parameters"]["ContentType"];
};
readonly path: {
/** @description ID of the blog post. */
readonly id: number;
};
readonly cookie?: never;
};
readonly requestBody: {
readonly content: {
readonly "application/json": components["schemas"]["blogPost_Base_Post"];
};
};
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
/** @example {
* "id": 3,
* "title": "Welcome to BigCommerce",
* "url": "/blog/welcome-bigcommerce/",
* "preview_url": "/blog/welcome-bigcommerce/",
* "body": "<p>Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform. </p>",
* "tags": [
* "BigCommerce",
* "welcome",
* "ecommerce"
* ],
* "summary": "<p>We power ecommerce websites for successful retailers all over the world</p>",
* "is_published": true,
* "published_date": {
* "date": "2018-05-18T08:26:42.000Z",
* "timezone_type": 1,
* "timezone": "+00:00"
* },
* "published_date_iso8601": "2018-05-18T13:26:42.000Z",
* "meta_description": "Welcome Post",
* "meta_keywords": "BigCommerce, welcome, ecommerce",
* "author": "BigCommerce",
* "thumbnail_path": ""
* } */
readonly "application/json": components["schemas"]["blogPost_Base_Res"];
};
};
/** @description Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occurred, such as when a `POST` or `PUT` request is successful, but saving the URL has failed. */
readonly 207: {
headers: {
readonly [name: string]: unknown;
};
content: {
readonly "application/json": {
readonly [key: string]: unknown;
};
};
};
};
};
readonly deleteBlogPost: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path: {
/** @description ID of the blog post. */
readonly id: number;
};
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 204: {
headers: {
readonly [name: string]: unknown;
};
content?: never;
};
};
};
readonly getBlogPostsCount: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path?: never;
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
/** @example {
* "count": 27
* } */
readonly "application/json": components["schemas"]["count_Response"];
};
};
};
};
readonly getPages: {
readonly parameters: {
readonly query?: {
/** @description Filter param. */
readonly page?: number;
/** @description Filter param. */
readonly limit?: number;
};
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path?: never;
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
/** @example [
* {
* "id": 6,
* "channel_id": 11,
* "name": "Contact Form",
* "meta_title": "",
* "email": "janedoe@example.com",
* "body": "We are happy to answer questions or help you with...",
* "is_visible": true,
* "parent_id": 5,
* "sort_order": 3,
* "meta_keywords": "",
* "type": "page",
* "contact_fields": "fullname,companyname,phone,orderno,rma",
* "meta_description": "",
* "is_homepage": false,
* "layout_file": "page.html",
* "is_customers_only": false,
* "search_keywords": "",
* "has_mobile_version": false,
* "mobile_body": "",
* "url": "/contact-us/"
* }
* ] */
readonly "application/json": readonly components["schemas"]["page_Full"][];
};
};
};
};
readonly createPage: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */
readonly "Content-Type"?: components["parameters"]["ContentType"];
};
readonly path?: never;
readonly cookie?: never;
};
readonly requestBody: {
readonly content: {
/** @example {
* "channel_id": 1,
* "name": "Contact Form",
* "meta_title": "string",
* "body": "<p>We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.</p>",
* "is_visible": true,
* "parent_id": 5,
* "sort_order": 3,
* "meta_keywords": "string",
* "type": "page",
* "contact_fields": "fullname,companyname,phone,orderno,rma",
* "meta_description": "string",
* "is_homepage": false,
* "is_customers_only": false,
* "search_keywords": "string",
* "has_mobile_version": false,
* "mobile_body": "0",
* "url": "/contact-us/"
* } */
readonly "application/json": components["schemas"]["page_Base"];
};
};
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
/** @example {
* "id": 6,
* "channel_id": 11,
* "name": "Contact Form",
* "meta_title": "",
* "body": "We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.",
* "is_visible": true,
* "parent_id": 5,
* "sort_order": 3,
* "meta_keywords": "",
* "type": "page",
* "meta_description": "",
* "is_homepage": false,
* "layout_file": "page.html",
* "is_customers_only": true,
* "search_keywords": "",
* "has_mobile_version": false,
* "mobile_body": "",
* "url": "/contact-us/"
* } */
readonly "application/json": components["schemas"]["page_Full"];
};
};
/** @description Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occurred, such as when a `POST` or `PUT` request is successful, but saving the URL has failed. */
readonly 207: {
headers: {
readonly [name: string]: unknown;
};
content: {
readonly "application/json": {
readonly [key: string]: unknown;
};
};
};
};
};
readonly getPage: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path: {
/** @description ID of the page. */
readonly id: number;
};
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
/** @example {
* "id": 6,
* "channel_id": 11,
* "name": "Contact Form",
* "meta_title": "",
* "body": "We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.",
* "is_visible": true,
* "parent_id": 5,
* "sort_order": 3,
* "meta_keywords": "",
* "type": "page",
* "meta_description": "",
* "is_homepage": false,
* "layout_file": "page.html",
* "is_customers_only": true,
* "search_keywords": "",
* "has_mobile_version": false,
* "mobile_body": "",
* "url": "/contact-us/"
* } */
readonly "application/json": components["schemas"]["page_Full"];
};
};
};
};
readonly updatePage: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */
readonly "Content-Type"?: components["parameters"]["ContentType"];
};
readonly path: {
/** @description ID of the page. */
readonly id: number;
};
readonly cookie?: never;
};
readonly requestBody?: {
readonly content: {
readonly "application/json": components["schemas"]["page_Full"];
};
};
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
/** @example {
* "id": 2,
* "channel_id": 11,
* "name": "Shipping & Returns",
* "meta_title": "",
* "body": "<em>To edit this page simply login to the control panel, click the <strong style='font-weight: 400'>Website Content</strong> tab and choose the </em> <strong style='font-weight: 400'><em>View Web Pages option. Click Edit next to the Shipping & Returns page and you can change this text. A sample returns policy is shown below which you can edit as needed.</em><em style='font-style: normal'><br/><br/></em></strong><em style='font-style: normal'><strong>Returns Policy</strong></em><strong style='font-weight: 400'></em></em><em style='font-style: normal'><br/><br/></em>You may return most new, unopened items within 30 days of delivery for a full refund. We'll also pay the return shipping costs if the return is a result of our error (you received an incorrect or defective item, etc.).<br/><br/>You should expect to receive your refund within four weeks of giving your package to the return shipper, however, in many cases you will receive a refund more quickly. This time period includes the transit time for us to receive your return from the shipper (5 to 10 business days), the time it takes us to process your return once we receive it (3 to 5 business days), and the time it takes your bank to process our refund request (5 to 10 business days).<br/><br/>If you need to return an item, please <a href='/contact-us/'>Contact Us</a> with your order number and details about the product you would like to return. We will respond quickly with instructions for how to return items from your order.<br/><br/></strong><strong>Shipping</em></em></em></strong><strong style='font-weight: 400'><em style='font-style: normal'><br/><br/></em>We can ship to virtually any address in the world. Note that there are restrictions on some products, and some products cannot be shipped to international destinations.<br/><br/>When you place an order, we will estimate shipping and delivery dates for you based on the availability of your items and the shipping options you choose. Depending on the shipping provider you choose, shipping date estimates may appear on the shipping quotes page.<br/><br/>Please also note that the shipping rates for many items we sell are weight-based. The weight of any such item can be found on its detail page. To reflect the policies of the shipping companies we use, all weights will be rounded up to the next full pound.<br/>",
* "is_visible": true,
* "parent_id": 0,
* "sort_order": 2,
* "meta_keywords": "",
* "type": "page",
* "meta_description": "",
* "is_homepage": false,
* "layout_file": "page.html",
* "is_customers_only": false,
* "search_keywords": "",
* "has_mobile_version": false,
* "link": "",
* "mobile_body": "",
* "url": "/shipping-returns/"
* } */
readonly "application/json": components["schemas"]["page_Full"];
};
};
/** @description Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occurred, such as when a `POST` or `PUT` request is successful, but saving the URL has failed. */
readonly 207: {
headers: {
readonly [name: string]: unknown;
};
content: {
readonly "application/json": {
readonly [key: string]: unknown;
};
};
};
};
};
readonly deletePage: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path: {
/** @description ID of the page. */
readonly id: number;
};
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 204: {
headers: {
readonly [name: string]: unknown;
};
content?: never;
};
};
};
readonly getRedirects: {
readonly parameters: {
readonly query?: {
/** @description Filter param. */
readonly page?: number;
/** @description Filter param. */
readonly limit?: number;
};
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path?: never;
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
readonly "application/json": readonly components["schemas"]["redirect"][];
/** @example */
readonly "Response Schema": unknown;
};
};
};
};
readonly createRedirect: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */
readonly "Content-Type"?: components["parameters"]["ContentType"];
};
readonly path?: never;
readonly cookie?: never;
};
readonly requestBody: {
readonly content: {
readonly "application/json": components["schemas"]["redirect"];
};
};
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
/** @example {
* "id": 3,
* "path": "/mens_clothing",
* "forward": {
* "type": "category",
* "ref": 3
* },
* "url": "http://store.example.com/mens"
* } */
readonly "application/json": components["schemas"]["redirect"];
};
};
};
};
readonly deleteRedirects: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path?: never;
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 204: {
headers: {
readonly [name: string]: unknown;
};
content?: never;
};
};
};
readonly getRedirect: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path: {
/** @description ID of the redirect URL. */
readonly id: number;
};
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
/** @example {
* "id": 1,
* "path": "/smith-journal-13/",
* "forward": {
* "type": "product",
* "ref": 111
* },
* "url": "http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/"
* } */
readonly "application/json": components["schemas"]["redirect"];
};
};
};
};
readonly updateRedirect: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */
readonly "Content-Type"?: components["parameters"]["ContentType"];
};
readonly path: {
/** @description ID of the redirect URL. */
readonly id: number;
};
readonly cookie?: never;
};
readonly requestBody: {
readonly content: {
readonly "application/json": {
/**
* @description Numeric ID of the redirect.
* @example 1
*/
readonly id?: number;
/**
* @description The path from which to redirect.
* @example /smith-journal-13/
*/
readonly path: string;
readonly forward: {
/**
* @description The type of redirect. If it is a manual redirect then type will always be manual. Dynamic redirects will have the type of the page. Such as product or category.
*
* @example product
*/
readonly type?: string;
/**
* @description Reference of the redirect. Dynamic redirects will have the category or product number. Manual redirects will have the url that is being directed to.
* @example 111
*/
readonly ref?: string;
};
/**
* @description URL of the redirect. READ-ONLY.
* @example http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/
*/
readonly url?: string;
};
};
};
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
/** @example {
* "id": 1,
* "path": "/smith-journal-13/",
* "forward": {
* "type": "product",
* "ref": 111
* },
* "url": "http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/"
* } */
readonly "application/json": components["schemas"]["redirect"];
};
};
};
};
readonly deleteRedirect: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path: {
/** @description ID of the redirect URL. */
readonly id: number;
};
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 204: {
headers: {
readonly [name: string]: unknown;
};
content?: never;
};
};
};
readonly getRedirectsCount: {
readonly parameters: {
readonly query?: never;
readonly header?: {
/** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */
readonly Accept?: components["parameters"]["Accept"];
};
readonly path?: never;
readonly cookie?: never;
};
readonly requestBody?: never;
readonly responses: {
readonly 200: {
headers: {
readonly [name: string]: unknown;
};
content: {
/** @example {
* "count": 27
* } */
readonly "application/json": components["schemas"]["count_Response"];
};
};
};
};
}