{"openapi":"3.1.0","info":{"title":"B2B Management","version":"1.0.0"},"paths":{"/countries":{"get":{"operationId":"get-addresses-countries-countryName-code","summary":"Get Country","description":"Retrieves country information based on the country name or two-letter code entered in the parameters. The response can be used to provide a valid country name or code in Company addresses.\n\nUse the `searchType` parameter to specify whether you are searching by a country's name or its two-letter [ISO code](https://www.iso.org/obp/ui/#search), and then add the appropriate value for the country to the `q` parameter. This endpoint only accepts country name values in English, but you can set the `searchBy` paramteter to `1` to retrieve country information with the standard ISO code instead.","tags":["addresses"],"parameters":[{"name":"searchType","in":"query","description":"Determines whether you are searching by a country's name (`0`) or its two-letter ISO code (`1`).","required":true,"schema":{"$ref":"#/components/schemas/CountriesGetParametersSearchType"}},{"name":"q","in":"query","description":"The country's name or its two-letter ISO code, depending on the specified `searchType`.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Addresses_get-addresses-countries-countryName-code_Response_200"}}}},"404":{"description":"Not Found\n\nThis error occurs if the `country` value is missing or invalid. Confirm that the value is formatted in accordance with the specified `searchType`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-addresses-countries-countryName-codeRequestNotFoundError"}}}}}}},"/states":{"get":{"operationId":"get-addresses-states-stateName-code","summary":"Get State","description":"Retrieves state or province information based on the state name or two-letter code entered in the parameters. The response can be used to provide a valid state name or code in Company addresses.\n\nUse the `country` parameter to specify the country associated with the queried state. If left blank, the endpoint uses the United States by default.\n\nNote that only the countries listed below will return state or province values. When [creating](#create-a-company-address) or [updating](#update-an-address) addresses in these countries, you must include state information.\n\n* Argentina  \n* Australia  \n* Austria  \n* Brazil  \n* Canada  \n* Chile  \n* Germany  \n* India  \n* Indonesia  \n* Ireland  \n* Italy  \n* Japan  \n* Malaysia  \n* Mexico  \n* Myanmar  \n* New Zealand  \n* Philippines  \n* Qatar  \n* Romania  \n* South Africa  \n* Spain  \n* Switzerland  \n* United Arab Emirates  \n* United States (default)\n\nUse the `searchType` parameter to specify whether you are searching by a state's name or its two-letter [ISO code](https://www.iso.org/obp/ui/#search), and then add the appropriate value for the state to the `q` parameter.","tags":["addresses"],"parameters":[{"name":"searchType","in":"query","description":"Determines whether you are searching by a state or province's name (`0`) or its two-letter ISO code (`1`). This parameter also defines the value type for the `country` parameter.","required":true,"schema":{"$ref":"#/components/schemas/StatesGetParametersSearchType"}},{"name":"q","in":"query","description":"The state's name or its two-letter ISO code, depending on the specified `searchType`.\n\n**Note:** The state information entered for the parameter must correspond to the country specified in the `country` value.","required":true,"schema":{"type":"string"}},{"name":"country","in":"query","description":"The country's name or its two-letter ISO code, depending on the specified `searchType`.","required":false,"schema":{"type":"string","default":"US / United States"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Addresses_get-addresses-states-stateName-code_Response_200"}}}},"404":{"description":"Not Found\n\nThis error occurs if the state name or code does not match the country specified in the country parameter. When querying states/provinces outside of the United States, you must use the `country` parameter, and its value must be formatted in accordance with the `searchBy` parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-addresses-states-stateName-codeRequestNotFoundError"}}}}}}},"/addresses":{"get":{"operationId":"get-companies","summary":"List Addresses","description":"Retrieves a list of addresses across all Company accounts. Use the parameters to filter results by different attributes like creation date, Company account, and country.\n\nBy default, the response does not include address extra fields and values. To include this information, use the `isIncludeExtraFields` parameter and provide a value of `1`.","tags":["addresses"],"parameters":[{"name":"limit","in":"query","description":"Determines the number of records to return per page. If left blank, this defaults to `10`.","required":false,"schema":{"type":"integer","default":10}},{"name":"offset","in":"query","description":"The number of results to skip before returning the first result. If left blank, this defaults to `0`.","required":false,"schema":{"type":"integer","default":0}},{"name":"minModified","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all addresses updated after that time.","required":false,"schema":{"type":"integer"}},{"name":"maxModified","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all addresses updated before that time.","required":false,"schema":{"type":"integer"}},{"name":"minCreated","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all addresses created after that time.","required":false,"schema":{"type":"integer"}},{"name":"maxCreated","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all addresses created before that time.","required":false,"schema":{"type":"integer"}},{"name":"companyId","in":"query","description":"Enter the unique numeric ID of the Company account to return its addresses.","required":false,"schema":{"type":"integer"}},{"name":"isBilling","in":"query","description":"Indicate whether you want to filter for or against billing addresses in the response.","required":false,"schema":{"type":"boolean"}},{"name":"isShipping","in":"query","description":"Indicate whether you want to filter for or against shipping addresses in the response.","required":false,"schema":{"type":"boolean"}},{"name":"isIncludeExtraFields","in":"query","description":"Indicate whether you want to include (`1`) or exclude (`0`) address extra fields in the response.","required":false,"schema":{"$ref":"#/components/schemas/AddressesGetParametersIsIncludeExtraFields","default":0}},{"name":"firstName","in":"query","description":"Filter for addresses with a specific first name.","required":false,"schema":{"type":"string"}},{"name":"lastName","in":"query","description":"Filter for addresses with a specific last name.","required":false,"schema":{"type":"string"}},{"name":"address","in":"query","description":"Enter the first or second address line to return relevant addresses.","required":false,"schema":{"type":"string"}},{"name":"city","in":"query","description":"Filter for addresses from a specific city.","required":false,"schema":{"type":"string"}},{"name":"country","in":"query","description":"Filter for addresses from a specific country. Use the country's full name or its two-letter ISO code.","required":false,"schema":{"type":"string"}},{"name":"state","in":"query","description":"Filter for addresses from a specific state or province. Use the state's full name or its two-letter ISO code.","required":false,"schema":{"type":"string"}},{"name":"zipCode","in":"query","description":"Filter for addresses from a specific postal code.","required":false,"schema":{"type":"string"}},{"name":"phoneNumber","in":"query","description":"Filter for addresses with a specific phone number.","required":false,"schema":{"type":"string"}},{"name":"externalId[]","in":"query","description":"Filter by an external ID assigned to addresses in a third-party system, such as an ERP.","required":false,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Addresses_get-companies_Response_200"}}}}}},"post":{"operationId":"post-companies-companyId-addresses","summary":"Create Company Address","description":"Creates an address for a Company account. Use [Bulk Create Addresses](#bulk-create-addresses) to create multiple addresses in a single request.\n\n## Considerations\n\nIn addition to the minimum-required fields presented in the request body example, you may need to supply a `stateName` or a `stateCode` if the address is in a [designated country](/developer/api-reference/rest/b2b/management/addresses/get-addresses-states-state-name-code).\n\nIf you have set one or more address extra fields as mandatory, you must include the `extraFields` object in the request body. If an extra field is configured to accept only unique values, each `fieldValue` must be distinct for a successful request.\n\nYou can create Company addresses without assigning them as billing or shipping addresses. However, Company users cannot use addresses at checkout without a billing or shipping designation.","tags":["addresses"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_POSTPUT"}}}},"422":{"description":"Unprocessable Content\n\nThis error occurs if you exclude a required field from the request body. See the error message in the response to identify the required field.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-companies-companyId-addressesRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/addressFields_GET/properties/firstName"},"lastName":{"$ref":"#/components/schemas/addressFields_GET/properties/lastName"},"phoneNumber":{"$ref":"#/components/schemas/addressFields_GET/properties/phoneNumber"},"zipCode":{"$ref":"#/components/schemas/addressFields_GET/properties/zipCode"},"addressLine1":{"$ref":"#/components/schemas/addressFields_GET/properties/addressLine1"},"addressLine2":{"$ref":"#/components/schemas/addressFields_GET/properties/addressLine2"},"city":{"$ref":"#/components/schemas/addressFields_GET/properties/city"},"stateName":{"type":"string","description":"The full name of the state or province on the address. This must correspond to `stateCode` in the request if the state or province is [required for the country](#get-a-state)."},"countryName":{"type":"string","description":"The full name of the country on the address. Use [Get a Country](#get-a-country) to retrieve valid country names."},"stateCode":{"type":"string","description":"The two-letter ISO code for the state or province on the address. Omit this field when adding state or province information for an [unsupported country](#get-a-state)."},"countryCode":{"type":"string","description":"The two-letter ISO code for the country on the address. Use [Get a Country](#get-a-country) to retrieve valid country codes."},"companyId":{"$ref":"#/components/schemas/addressFields_GET/properties/companyId"},"isBilling":{"$ref":"#/components/schemas/addressFields_GET/properties/isBilling"},"isShipping":{"$ref":"#/components/schemas/addressFields_GET/properties/isShipping"},"isDefaultBilling":{"$ref":"#/components/schemas/addressFields_GET/properties/isDefaultBilling"},"isDefaultShipping":{"$ref":"#/components/schemas/addressFields_GET/properties/isDefaultShipping"},"label":{"$ref":"#/components/schemas/addressFields_GET/properties/label"},"externalId":{"$ref":"#/components/schemas/addressFields_GET/properties/externalId"},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/AddressesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems"},"description":"Enter extra field information for the address."}},"required":["firstName","lastName","addressLine1","city","stateName","countryName","companyId"]}}}}}},"/addresses/{addressId}":{"get":{"operationId":"get-companies-companyId-addresses-addressId","summary":"Get Address","description":"Retrieves detailed information on a single Company address.","tags":["addresses"],"parameters":[{"name":"addressId","in":"path","description":"The unique numeric identifier of the Company address.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Addresses_get-companies-companyId-addresses-addressId_Response_200"}}}},"404":{"description":"Not Found\n\nThis error occurs if the `addressId` is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseNotFound"}}}}}},"put":{"operationId":"put-companies-companyId-addresses-addressId","summary":"Update Address","description":"Edits details of an existing Company address.\n\nThere are no required fields for this endpoint, but you must include `isBilling` or `isShipping` to change the value of `isDefaultBilling` or `isDefaultShipping` respectively.\n\nWhen changing the `countryName`, you must also update the `countryCode`. Updating the `countryCode` by itself will automatically adjust the `countryName`. If you are changing the `countryCode` to a [country that supports states](#get-a-state), you must also include the `stateCode` with a valid two-letter code value for the state.","tags":["addresses"],"parameters":[{"name":"addressId","in":"path","description":"The unique numeric identifier of the Company address.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_POSTPUT"}}}},"404":{"description":"Not Found\n\nThis error occurs if you supply an invalid addressId in the request path.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseNotFound"}}}},"422":{"description":"Unprocessable Content\n\nThis error occurs if you enter invalid information in the request body. It can also occur if you supply the `isDefaultBilling` or `isDefaultShipping` fields without also including `isBilling` and `isShipping` respectively.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-companies-companyId-addresses-addressIdRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/address_REQUEST"}}}}},"delete":{"operationId":"delete-companies-companyId-addresses-addressId","summary":"Delete Address","description":"Permanently removes an address from a Company account. Deleting addresses does not remove them from existing quotes, invoices, and orders, but the address is no longer available for future records.","tags":["addresses"],"parameters":[{"name":"addressId","in":"path","description":"The unique numeric identifier of the Company address.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_POSTPUT"}}}},"404":{"description":"Not Found\n\nThis error occurs if the `addressId` is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseNotFound"}}}}}}},"/addresses/bulk":{"post":{"operationId":"post-addresses","summary":"Bulk Create Addresses","description":"Creates multiple addresses for **up to 10** addresses at a time. You can create addresses for different Company accounts in a single request by entering a different `companyid` value for each address object.\n\nSee [Create a Company Address](#create-a-company-address) for considerations related to creating one or more addresses.","tags":["addresses"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Addresses_post-addresses_Response_200"}}}},"413":{"description":"This occurs if you include more than 10 address objects in the request body. To create more than 10 addresses, split your requests into batches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-addressesRequestContentTooLargeError"}}}},"422":{"description":"This error occurs if you exclude a required field. See the error message in the response to identify the required field. The response body presents error messages for each address in an array with the same sort order as the addresses in the request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-addressesRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/addressFields_GET/properties/firstName"},"lastName":{"$ref":"#/components/schemas/addressFields_GET/properties/lastName"},"phoneNumber":{"$ref":"#/components/schemas/addressFields_GET/properties/phoneNumber"},"zipCode":{"$ref":"#/components/schemas/addressFields_GET/properties/zipCode"},"addressLine1":{"$ref":"#/components/schemas/addressFields_GET/properties/addressLine1"},"addressLine2":{"$ref":"#/components/schemas/addressFields_GET/properties/addressLine2"},"city":{"$ref":"#/components/schemas/addressFields_GET/properties/city"},"stateName":{"type":"string","description":"The full name of the state or province on the address. This must correspond to `stateCode` in the request if the state or province is [required for the country](#get-a-state)."},"countryName":{"type":"string","description":"The full name of the country on the address. Use [Get a Country](#get-a-country) to retrieve valid country names."},"stateCode":{"type":"string","description":"The two-letter ISO code for the state or province on the address. Omit this field when adding state or province information for an [unsupported country](#get-a-state)."},"countryCode":{"type":"string","description":"The two-letter ISO code for the country on the address. Use [Get a Country](#get-a-country) to retrieve valid country codes."},"companyId":{"$ref":"#/components/schemas/addressFields_GET/properties/companyId"},"isBilling":{"$ref":"#/components/schemas/addressFields_GET/properties/isBilling"},"isShipping":{"$ref":"#/components/schemas/addressFields_GET/properties/isShipping"},"isDefaultBilling":{"$ref":"#/components/schemas/addressFields_GET/properties/isDefaultBilling"},"isDefaultShipping":{"$ref":"#/components/schemas/addressFields_GET/properties/isDefaultShipping"},"label":{"$ref":"#/components/schemas/addressFields_GET/properties/label"},"externalId":{"$ref":"#/components/schemas/addressFields_GET/properties/externalId"},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/AddressesBulkPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems"},"description":"Enter extra field information for the address."}},"required":["firstName","lastName","addressLine1","city","stateName","countryName","companyId"]}}}}}},"/addresses/extra-fields":{"get":{"operationId":"get-addresses-extra-fields","summary":"List Address Extra Field Configs","description":"Returns a list of available extra fields configurations for Company addresses.\n\nWe recommend caching the response results to avoid frequent API requests.","tags":["addresses"],"parameters":[{"name":"offset","in":"query","description":"The number of results to skip before returning the first result. If left blank, this defaults to `0`.","required":false,"schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"Determines the number of records to return per page. If left blank, this defaults to `10`.","required":false,"schema":{"type":"integer","default":10}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Addresses_get-addresses-extra-fields_Response_200"}}}}}}},"/auth/customers":{"post":{"operationId":"post-auth-customer","summary":"Get Storefront authToken with Credentials","description":"Uses the login credentials of a storefront customer or a Company user to generate a storefront authToken to validate requests to the B2B Storefront GraphQL API. Unlike the Get a Storefront API authToken endpoint, this request does not rely on a JWT from an active storefront session.\n\nBy default, the resulting storefront authToken is valid for **1 day**. However, you can adjust its validity period with the `beginAt` and `endAt` fields in the request body.","tags":["authentication"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authentication_post-auth-customer_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"storeHash":{"$ref":"#/components/schemas/storeHash"},"email":{"$ref":"#/components/schemas/email"},"password":{"$ref":"#/components/schemas/password"},"channelId":{"$ref":"#/components/schemas/channelId"},"name":{"$ref":"#/components/schemas/tokenName"},"beginAt":{"type":"integer","description":"The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the storefront authToken starts being valid."},"endAt":{"type":"integer","description":"The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the storefront authToken is no longer valid."}},"required":["storeHash","email","password","channelId","name"]}}}}}},"/auth/customers/storefront":{"post":{"operationId":"post-auth-customers-storefront","summary":"Get B2B Storefront Token","description":"Generates a storefront authToken based on the supplied `customerId` of a storefront customer or Company user. You can use [Get Users](/developer/api-reference/rest/b2b/management/users) to retrieve the IDs of Company users, or you can use [Get All Customers](/developer/api-reference/rest/admin/management/customers/v3) to retrieve IDs for B2C customers and B2B buyers alike.\n\nYou can also use the [BigCommerce Storefront GraphQL API](/developer/docs/storefront/guides/graphql-storefront-api/authentication#login-mutation) to generate a Customer Access Token (CAT) and include it in the request, but this is not required for a successful response.\n\nThe storefront authToken obtained from this endpoint is valid for **1 day**.","tags":["authentication"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authentication_post-auth-customers-storefront_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"$ref":"#/components/schemas/customerId"},"channelId":{"$ref":"#/components/schemas/channelId","default":1},"customerAccessToken":{"$ref":"#/components/schemas/customerAccessToken"}},"required":["customerId"]}}}}}},"/auth/storefront":{"get":{"operationId":"get-auth-storefront","summary":"Get Storefront API authToken","description":"Returns an existing storefront authToken from an existing JSON Web Token (JWT). You can obtain a JWT using a request to the Current Customer API. See [Authentication for hosted storefronts](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api) for instructions.\n\nThe `channelId` field is optional for stores with multiple storefronts, since the JWT is tied to a specific storefront session. Including it does enforce strict adherence of token-related activity to channel-specific rules and behaviors. However, it is not necessary at all for single-storefront stores because there is only one storefront channel.\n\nThe storefront authToken obtained from this endpoint is valid for **1 day**.","tags":["authentication"],"parameters":[{"name":"jwtToken","in":"query","description":"The JSON Web Token (JWT) obtained from a signed-in Company user. See [Current Customer API](/developer/docs/storefront/guides/customer-authentication/current-customer) to learn how to request a JWT.","required":true,"schema":{"type":"string"}},{"name":"channelId","in":"query","description":"The storefront channel ID associated with the storefront login session. Use 1 for your store’s default storefront channel. In a multi-storefront environment, this parameter enforces strict adherence of token-related activity to channel-specific rules and behaviors.\n\n**Note:** Inclusion of this parameter in single-storefront environments will result in unpredictable behavior.","required":false,"schema":{"type":"string"}},{"name":"X-Store-Hash","in":"header","description":"The unique store hash associated with a BigCommerce store that has B2B Edition enabled.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authentication_get-auth-storefront_Response_200"}}}},"401":{"description":"UNAUTHORIZED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-auth-storefrontRequestUnauthorizedError"}}}}}}},"/auth/backend":{"post":{"operationId":"post-auth-backend","summary":"Get Server to Server Token","description":"Creates a Server to Server API account with a token to validate future requests made to B2B’s Server to Server APIs.\n\nThis endpoint does not require an existing API Account, but you must validate the request with the login credentials of your backend B2B Edition user account. Only users with the pre-built Administrator or Store Owner role are allowed to create API tokens with this endpoint; custom user roles with API account permissions are **not** supported.\n\n> NOTE\n> \n> This endpoint generates `authToken` API Accounts, which are considered deprecated as of September 30, 2025. It is recommended to use the BigCommerce API `X-Auth-Token` created in the control panel moving forward.","tags":["authentication"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authentication_post-auth-backend_Response_200"}}}},"400":{"description":"BAD REQUEST","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-auth-backendRequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"storeHash":{"$ref":"#/components/schemas/storeHash"},"email":{"$ref":"#/components/schemas/email"},"password":{"$ref":"#/components/schemas/password"},"name":{"$ref":"#/components/schemas/tokenName"}},"required":["storeHash","email","password","name"]}}}}},"delete":{"operationId":"delete-auth-backend","summary":"Delete Backend API Tokens","description":"Deletes an existing Server to Server API `authToken` by specifying its ID. You can get a token’s ID using the [Get All Server to Server Tokens](#get-all-server-to-server-tokens) endpoint. This endpoint cannot be used to delete a BigCommerce API `X-Auth-Token`.\n\n**Note:**  Unlike most DELETE requests, the `id` value must be added to the request body instead of the parameters.","tags":["authentication"],"parameters":[{"name":"authToken","in":"header","description":"Required to authenticate requests. Include the token in a header parameter called `authToken`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authentication_delete-auth-backend_Response_200"}}}},"404":{"description":"NOT FOUND","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete-auth-backendRequestNotFoundError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/email"},"name":{"$ref":"#/components/schemas/tokenName"},"id":{"$ref":"#/components/schemas/tokenId"}},"required":["id"]}}}}}},"/backend/tokens":{"get":{"operationId":"get-backend-tokens","summary":"List Server to Server Tokens","description":"> NOTE\n> \n> This endpoint only retrieves `authToken` and not `X-Auth-Token` information.\n\nRetrieves all B2B S2S API tokens associated with your store. You can use the token’s ID in the response to delete it via the Delete Backend API Tokens endpoint, or you can recover existing token values for further Server to Server requests.","tags":["authentication"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of results that can be in the response.","required":false,"schema":{"type":"integer","default":10}},{"name":"offset","in":"query","description":"The number of results that should be skipped in the response.","required":false,"schema":{"type":"integer","default":0}},{"name":"authToken","in":"header","description":"Required to authenticate requests. Include the token in a header parameter called `authToken`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authentication_get-backend-tokens_Response_200"}}}}}}},"/channels":{"get":{"operationId":"get-channels","summary":"List Channels","description":"Returns all enabled channels for the current store. Analogous to [Get All Channels](/developer/api-reference/rest/admin/management/channels/get-channels) in the BigCommerce API.","tags":["channels"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channels_get-channels_Response_200"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-channelsRequestForbiddenError"}}}}}}},"/channels/{channel_id}":{"get":{"operationId":"get-channels-channelId","summary":"Get Channel Details by Channel ID","description":"Returns data for the specific channel associated with `channel_id`. Analogous to [Get A Channel](/developer/api-reference/rest/admin/management/channels/get-channel) in the BigCommerce API.","tags":["channels"],"parameters":[{"name":"channel_id","in":"path","description":"The unique BigCommerce channel ID.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channels_get-channels-channelId_Response_200"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-channels-channelIdRequestForbiddenError"}}}},"404":{"description":"Channel Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-channels-channelIdRequestNotFoundError"}}}}}}},"/companies/{companyId}/subsidiaries":{"get":{"operationId":"get-companies-companyId-subsidiaries","summary":"List Company Subsidiaries","description":"Returns all subsidiary accounts on lower hierarchy layers, based on the Company account specified.","tags":["accountHierarchies"],"parameters":[{"name":"companyId","in":"path","description":"Unique numeric ID of the Company account.","required":true,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The number of results to skip before returning the first result. If left blank, this defaults to `0`.","required":false,"schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"Determines the number of records to return per page. If left blank, this defaults to `10`.","required":false,"schema":{"type":"integer","default":10}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK\n\nThe `subsidiaries` array in the response includes nested `subsidiaries` arrays if a child account has its own subsidiaries.\n\nThe array also includes nested `subsidiaries` arrays for each Company with its own subsidiaries. For example, if the Company in question is above 2 layers of Account Hierarchy, its direct subsidiaries will also include `subsidiaries` arrays for their child accounts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account Hierarchies_get-companies-companyId-subsidiaries_Response_200"}}}},"404":{"description":"Not found error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-companies-companyId-subsidiariesRequestNotFoundError"}}}}}}},"/companies/{companyId}/subsidiaries/{childCompanyId}":{"delete":{"operationId":"delete-companies-companyId-subsidiary","summary":"Delete Company Subsidiary","description":"Removes the parent-child relationship between a specified subsidiary account and its parent Company.\n\nIf the deleted subsidiary has its own subsidiary companies, this request will create a separate hierarchy with the deleted subsidiary at the top.","tags":["accountHierarchies"],"parameters":[{"name":"companyId","in":"path","description":"Unique numeric ID of the Company account.","required":true,"schema":{"type":"integer"}},{"name":"childCompanyId","in":"path","description":"The ID of a Company account assigned as a subsidiary to the Company in question.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Parameter error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete-companies-companyId-subsidiaryRequestBadRequestError"}}}}}}},"/companies/{companyId}/parent":{"post":{"operationId":"post-companies-companyId-parents","summary":"Attach Company as The Parent of Current Company","description":"Assigns the Company account as the parent of a specific Company. Note that you **cannot** assign a Company as the parent of another Company which is already in a higher hierarchy level.\n\nFor example, if you have a client with local, national, and regional branches, their Company Account Hierarchy might look like this:\n\n```\n- Americas\n |- North America\n | |- Canada\n | |- United States\n |- South America\n | |- Brazil\n```\n\nYou cannot assign *United States* as a parent of *North America*, since the parent Company for *United States* is also a subsidiary of *North America*.","tags":["accountHierarchies"],"parameters":[{"name":"companyId","in":"path","description":"Unique numeric ID of the Company account.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account Hierarchies_post-companies-companyId-parents_Response_201"}}}},"400":{"description":"Parameter error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-companies-companyId-parentsRequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parentCompanyId":{"type":"integer","description":"Unique numeric ID of the parent Company account. This is a read-only field; do not set or modify its value in a POST or PUT request."}},"required":["parentCompanyId"]}}}}}},"/companies/{companyId}/hierarchy":{"get":{"operationId":"get-companies-companyId-hierarchy","summary":"List Company Hierarchy","description":"Returns all parent and child accounts in the hierarchy of a particular Company.\n\nThe default rate limit for this endpoint is `500` calls/min per store.","tags":["accountHierarchies"],"parameters":[{"name":"companyId","in":"path","description":"Unique numeric ID of the Company account.","required":true,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The number of results to skip before returning the first result. If left blank, this defaults to `0`.","required":false,"schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"Determines the number of records to return per page. If left blank, this defaults to `10`.","required":false,"schema":{"type":"integer","default":10}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account Hierarchies_get-companies-companyId-hierarchy_Response_200"}}}},"404":{"description":"Not found error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-companies-companyId-hierarchyRequestNotFoundError"}}}}}}},"/companies":{"get":{"operationId":"get-companies","summary":"List Companies","description":"Returns a list of all Company accounts, sorted by `companyId` from highest to lowest by default. Pass optional parameters to modify the results.","tags":["companies"],"parameters":[{"name":"limit","in":"query","description":"Determines the number of records to return per page. If left blank, this defaults to `10`.","required":false,"schema":{"type":"integer","default":10}},{"name":"offset","in":"query","description":"The number of results to skip before returning the first result. If left blank, this defaults to `0`.","required":false,"schema":{"type":"integer","default":0}},{"name":"minModified","in":"query","description":"The earliest [Unix timestamp](https://www.unixtimestamp.com/)  that can be returned for a modified Company account.","required":false,"schema":{"type":"number","format":"double"}},{"name":"maxModified","in":"query","description":"The latest [Unix timestamp](https://www.unixtimestamp.com/)  that can be returned for a modified Company account.","required":false,"schema":{"type":"number","format":"double"}},{"name":"minCreated","in":"query","description":"The earliest [Unix timestamp](https://www.unixtimestamp.com/)  that can be returned for a modified Company account.","required":false,"schema":{"type":"number","format":"double"}},{"name":"maxCreated","in":"query","description":"The latest [Unix timestamp](https://www.unixtimestamp.com/)  that can be returned for a modified Company account.","required":false,"schema":{"type":"number","format":"double"}},{"name":"sortBy","in":"query","description":"Sorts results by Company name or last updated date, defaulting to the last updated date if no parameter is provided.","required":false,"schema":{"$ref":"#/components/schemas/CompaniesGetParametersSortBy","default":"updatedAt"}},{"name":"orderBy","in":"query","description":"Establish a descending or ascending order of results. The order defaults to descending if the parameter is not included.","required":false,"schema":{"$ref":"#/components/schemas/CompaniesGetParametersOrderBy","default":"DESC"}},{"name":"isIncludeExtraFields","in":"query","description":"Indicates whether or not the response will include Company extra fields. If the parameter is not included, the response will exclude extra fields by default.\n\nA value of `0` will exclude extra fields, while a value of `1` will include them.","required":false,"schema":{"$ref":"#/components/schemas/CompaniesGetParametersIsIncludeExtraFields","default":"0"}},{"name":"companyStatus","in":"query","description":"The Company’s activity status. See [Company Status Codes](/developer/api-reference/rest/b2b/management/company/companies) to learn about their corresponding statuses.","required":false,"schema":{"$ref":"#/components/schemas/CompaniesGetParametersCompanyStatus"}},{"name":"q","in":"query","description":"Enter a Company name to return partial and exact matches.","required":false,"schema":{"type":"string"}},{"name":"companyEmail","in":"query","description":"Enter a Company's email address to return exact, case-insensitive matches.","required":false,"schema":{"type":"string","format":"email"}},{"name":"extraFields","in":"query","description":"Use this array to filter results by an extra field name-value pair.\n\nExact usage is formatted as `?extraFields=name:value`. Including this filter returns any Company account where the extra field `name` contains `value`. To search on more than one extra field, the parameter may be repeated to capture more specific instances such as `?extraFields=name1:value1&extraFields=name2,value2`, which will return all Companies where the extra fields `name1` and `name2` contain `value1` and `value2`, respectively.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"bcOrderId","in":"query","description":"The ID of a BigCommerce order placed by a particular Company account.","required":false,"schema":{"type":"integer"}},{"name":"orderId","in":"query","description":"The ID of a BigCommerce order placed by a particular Company account.","required":false,"schema":{"type":"string"}},{"name":"bcGroupId","in":"query","description":"The ID of the BigCommerce customer group assigned to the Company account.","required":false,"schema":{"type":"string"}},{"name":"customerId","in":"query","description":"The ID of a BigCommerce customer account with a corresponding Company user account.","required":false,"schema":{"type":"integer"}},{"name":"extraFieldFilterType","in":"query","description":"Establishes how results are filtered when using the `extraFields` parameter. The `search` filter type allows for partial matches, while the `exact-match` filter type only returns results that exactly match the specified criteria.\n\nThe filter type defaults to `search` when no parameter is provided.","required":false,"schema":{"$ref":"#/components/schemas/CompaniesGetParametersExtraFieldFilterType","default":"search"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_get-companies_Response_200"}}}}}},"post":{"operationId":"post-companies","summary":"Create Company","description":"Creates a new Company account. This endpoint also creates a Company user account for the administrator of the business.\n\nIf you have configured required information fields in your store’s Extra Fields settings for Company accounts or Company users, you must include the field’s name and value in the `extraFields` array of the request body. For more information on extra fields, see [B2B Edition Settings](https://support.bigcommerce.com/s/article/B2B-Edition-Settings) in the Help Center.\n\nAfter you have created a new Company account, you can configure all of its features and settings by using the [Update a Company](#update-a-company) endpoint.\n\n### Independent vs Dependent Companies Behavior\n\nWhen [Independent Company behavior](https://support.bigcommerce.com/s/article/Companies-and-Customer-Groups) is enabled on your store, the system will not automatically create a dedicated customer group for each new Company account. Instead, you can assign a customer group to a Company account as needed using the `customerGroupId` field. If the `customerGroupId` field is not included in the request body, the Company account will be assigned to your configured default customer group.\n\nIf you have not configured a default customer group or set the value of `customerGroupId` to `0`, the Company account will not be associated with any customer group, and its users will use your storefront’s default catalog visibility and pricing.\n\nIf your store is using legacy Dependent Company behavior, a new customer group will be automatically created and associated with each new Company account. In this case, you will not use the `customerGroupId` field.","tags":["companies"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_post-companies_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-companiesRequestBadRequestError"}}}},"422":{"description":"Company was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-companiesRequestUnprocessableEntityError"}}}}},"requestBody":{"description":"User Extra Field Values","content":{"application/json":{"schema":{"type":"object","properties":{"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems"}},"userExtraFields":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesPostRequestBodyContentApplicationJsonSchemaUserExtraFieldsItems"}},"companyName":{"$ref":"#/components/schemas/companyName"},"companyEmail":{"type":"string","format":"email","description":"The primary email address for the Company account."},"companyPhone":{"type":"string","description":"The primary phone number for the Company account."},"customerGroupId":{"$ref":"#/components/schemas/customerGroupId"},"addressLine1":{"type":"string","description":"The first line of the primary address for the Company account."},"addressLine2":{"type":"string","description":"The second line of the primary address for the Company account."},"city":{"type":"string","description":"The city of the primary address for the Company account."},"state":{"type":"string","description":"The state of the primary address for the Company account, if applicable. This must be the full name and not an abbreviation."},"country":{"type":"string","description":"The country of the primary address for the Company account. This must be either the full name or the ISO2 country code."},"zipCode":{"type":"string","description":"The postal code of the primary address for the Company account."},"adminFirstName":{"type":"string","description":"The first name of the Company account administrator."},"adminLastName":{"type":"string","description":"The last name of the Company account administrator."},"adminEmail":{"type":"string","format":"email","description":"The email address of the Company account administrator. If an existing BigCommerce customer account uses this email address, it is automatically linked to the administrator’s Company user account."},"adminPhoneNumber":{"type":"string","description":"The phone number of the Company account administrator."},"originChannelId":{"type":"integer","description":"The storefront channel ID designated as the origin for the Company administrator. Use `1` for your store’s default storefront channel."},"channelIds":{"type":"array","items":{"type":"integer"},"description":"The storefront channel IDs in which buyers can access their Company’s Buyer Portal. Use `1` for your store’s default storefront channel."},"catalogId":{"$ref":"#/components/schemas/catalogId_integer"},"acceptCreationEmail":{"type":"boolean","default":false,"description":"Indicates whether or not the administrator receives a welcome email when the Company account is created.\n\n`true`: Sends the welcome email to the admin user\n\n`false`: Does not send the email"}},"required":["companyName","companyEmail","companyPhone","country","adminFirstName","adminLastName","adminEmail"]}}}}}},"/companies/{companyId}":{"get":{"operationId":"get-companies-companyId","summary":"Get Company Details","description":"Returns detailed information for a specific Company account.","tags":["companies"],"parameters":[{"name":"companyId","in":"path","description":"Unique numeric ID of the Company account.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_get-companies-companyId_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-companies-companyIdRequestNotFoundError"}}}}}},"put":{"operationId":"put-companies-companyId","summary":"Update Company","description":"Updates a Company’s attributes.\n\nIf you have configured required information fields in your store’s Extra Fields settings for Company accounts or Company users, you must include the field’s name and value in the `extraFields` array of the request body. For more information on extra fields, see [B2B Edition Settings](https://support.bigcommerce.com/s/article/B2B-Edition-Settings) in the Help Center.\n\n### Independent vs. Dependent Companies Behavior\n\nThis endpoint applies the same rules to the `customerGroupId` field as [Create a Company](#create-a-company), based on the Company behavior used in your store. Additionally, the `priceListAssign` field is not compatible with Independent Companies behavior because a Company’s price list is configured from its assigned customer group.\n\nIf your store is using Dependent Companies behavior, use the `priceListAssign` field to assign a price list to the Company account.","tags":["companies"],"parameters":[{"name":"companyId","in":"path","description":"Unique numeric ID of the Company account.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_put-companies-companyId_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-companies-companyIdRequestNotFoundError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyName":{"$ref":"#/components/schemas/companyName"},"companyEmail":{"type":"string","format":"email","description":"The primary email address for the Company account."},"companyPhone":{"type":"string","description":"The primary phone number for the Company account."},"customerGroupId":{"$ref":"#/components/schemas/customerGroupId"},"addressLine1":{"type":"string","description":"The first line of the primary address for the Company account."},"addressLine2":{"type":"string","description":"The second line of the primary address for the Company account."},"city":{"type":"string","description":"The city of the primary address for the Company account."},"state":{"type":"string","description":"The state of the primary address for the Company account, if applicable. This must be the full name and not an abbreviation."},"country":{"type":"string","description":"The country of the primary address for the Company account. This must be either the full name or the ISO2 country code."},"zipCode":{"type":"string","description":"The postal code of the primary address for the Company account."},"uuid":{"type":"string","format":"uuid","description":"An external ID assigned to the Company account in a third-party system, such as an ERP. Leave this field blank if you do not have an external system."},"priceListAssign":{"$ref":"#/components/schemas/priceListAssign_REQUEST"},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesCompanyIdPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems"},"description":"To use customized extra fields with field names you need to first add company extra fields in Settings > Extra fields inside B2B edition.\n\ne.g., If you want to create a new company with an extra integer field named licenseNO, you can use this structure [{'fieldName': 'LicenseNO', 'fieldValue': 10342340323}] in the request body."}}}}}}},"delete":{"operationId":"delete-companies-companyId","summary":"Delete Company","description":"Deletes a Company account.\n\n### Independent vs. Dependent Companies Behavior\n\nIf your store is using Independent Companies behavior, deleting a Company account has no effect on its assigned customer group.\n\nWith Dependent Companies behavior, Company accounts and BigCommerce customer groups have a one-to-one relationship. Deleting a Company will also delete the corresponding customer group.","tags":["companies"],"parameters":[{"name":"companyId","in":"path","description":"Unique numeric ID of the Company account.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_delete-companies-companyId_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete-companies-companyIdRequestNotFoundError"}}}}}}},"/customer-groups/{customerGroupId}/companies":{"post":{"operationId":"post-companies-conversion-customerGroups","summary":"Convert BigCommerce Customer Group into Company","description":"Creates a Company account that is automatically assigned to a BigCommerce customer group. You cannot create a Company from a customer group that already has an assigned Company account.\n\nNote that this endpoint **is not supported** if your store:\n\n* Has Multi-Storefront enabled\n* Is using Independent Companies behavior\n\nIf you have configured required information fields in your store’s Extra Fields settings for Company accounts or Company users, you must include the field’s name and value in the extraFields array of the request body. For more information on extra fields, see [B2B Edition Settings](https://support.bigcommerce.com/s/article/B2B-Edition-Settings) in the Help Center.","tags":["companies"],"parameters":[{"name":"customerGroupId","in":"path","description":"The BigCommerce customer group ID associated with the Company account.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_post-companies-conversion-customerGroups_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-companies-conversion-customerGroupsRequestBadRequestError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-companies-conversion-customerGroupsRequestNotFoundError"}}}}},"requestBody":{"description":"User Extra Field Values","content":{"application/json":{"schema":{"type":"object","properties":{"companyName":{"$ref":"#/components/schemas/companyName"},"companyPhone":{"type":"string","description":"The primary phone number for the Company account."},"companyEmail":{"type":"string","format":"email","description":"The primary email address for the Company account."},"catalogId":{"$ref":"#/components/schemas/catalogId_string"},"acceptCreationEmail":{"type":"boolean","default":false,"description":"Indicates whether or not the administrator receives a welcome email when the Company account is created.\n\n`true`: Sends the welcome email to the admin user\n\n`false`: Does not send the email"},"addressLine1":{"type":"string","description":"The first line of the primary address for the Company account."},"addressLine2":{"type":"string","description":"The second line of the primary address for the Company account."},"city":{"type":"string","description":"The city of the primary address for the Company account."},"state":{"type":"string","description":"The state of the primary address for the Company account, if applicable. This must be the full name and not an abbreviation."},"country":{"type":"string","description":"The country of the primary address for the Company account. This must be either the full name or the ISO2 country code."},"zipCode":{"type":"string","description":"The postal code of the primary address for the Company account."},"adminFirstName":{"type":"string","description":"The first name of the Company account administrator."},"adminLastName":{"type":"string","description":"The last name of the Company account administrator."},"adminEmail":{"type":"string","format":"email","description":"The email address of the Company account administrator. If an existing BigCommerce customer account uses this email address, it is automatically linked to the administrator’s Company user account."},"adminPhoneNumber":{"type":"string","description":"The phone number of the Company account administrator."},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomerGroupsCustomerGroupIdCompaniesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems"}},"userExtraFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomerGroupsCustomerGroupIdCompaniesPostRequestBodyContentApplicationJsonSchemaUserExtraFieldsItems"}}},"required":["companyName","companyPhone","companyEmail","country","adminEmail","adminPhoneNumber"]}}}}}},"/companies/bulk":{"post":{"operationId":"post-companies-bulk","summary":"Bulk Create Companies","description":"Creates multiple Company accounts at once. You can create up to `10` Companies in a single request.\n\nSee [Create a Company](#create-a-company) for recommendations on formatting individual Companies in the array.","tags":["companies"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_post-companies-bulk_Response_200"}}}},"400":{"description":"Bad Request; creation failed for some Companies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-companies-bulkRequestBadRequestError"}}}},"409":{"description":"The Company was in conflict with another Company. This is the result of duplicate unique values, or missing or invalid `companyEmail`, `phoneNumber` or required `extraFields`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-companies-bulkRequestConflictError"}}}},"413":{"description":"Request Entity Too Large. In normal conditions, the bulk create or update method supports 10 entities in one request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-companies-bulkRequestContentTooLargeError"}}}},"422":{"description":"Company was not valid. This is the result of missing required fields or invalid data. See the response for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-companies-bulkRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesBulkPostRequestBodyContentApplicationJsonSchemaItems"}}}}}},"put":{"operationId":"put-companies","summary":"Update Companies (batch)","description":"Updates up to `10` Company accounts at once. See [Update a Company](#update-a-company) for recommendations on formatting individual Companies in the array.","tags":["companies"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_put-companies_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-companiesRequestBadRequestError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-companiesRequestNotFoundError"}}}},"413":{"description":"Request Entity Too Large. In normal conditions, the bulk create or update method supports 10 entities in one request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-companiesRequestContentTooLargeError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"$ref":"#/components/schemas/companyId_string"},"companyName":{"$ref":"#/components/schemas/companyName"},"companyEmail":{"type":"string","format":"email","description":"The primary email address for the Company account."},"companyPhone":{"type":"string","description":"The primary phone number for the Company account."},"customerGroupId":{"$ref":"#/components/schemas/customerGroupId"},"addressLine1":{"type":"string","description":"The first line of the primary address for the Company account."},"addressLine2":{"type":"string","description":"The second line of the primary address for the Company account."},"city":{"type":"string","description":"The city of the primary address for the Company account."},"state":{"type":"string","description":"The state of the primary address for the Company account, if applicable. This must be the full name and not an abbreviation."},"country":{"type":"string","description":"The country of the primary address for the Company account. This must be either the full name or the ISO2 country code."},"zipCode":{"type":"string","description":"The postal code of the primary address for the Company account."},"priceListAssign":{"$ref":"#/components/schemas/priceListAssign_REQUEST"},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesBulkPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems"},"description":"To use customized extra fields with field names you need to first add company extra fields in Settings > Extra fields inside B2B edition.\n\ne.g., If you want to create a new company with an extra integer field named licenseNO, you can use this structure [{'fieldName': 'LicenseNO', 'fieldValue': 10342340323}] in the request body."}},"required":["companyId"]}}}}}},"/companies/{companyId}/catalogs":{"put":{"operationId":"put-companies-companyId-catalog","summary":"Update Company Catalog","description":"Updates the price list assigned to the Company account. This endpoint **is not supported** for stores using Independent Companies behavior.","tags":["companies"],"parameters":[{"name":"companyId","in":"path","description":"Unique numeric ID of the Company account.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_put-companies-companyId-catalog_Response_200"}}}},"405":{"description":"Not Allowed; occurs if the store is using Independent Companies behavior","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"catalogId":{"$ref":"#/components/schemas/catalogId_string"}},"required":["catalogId"]}}}}}},"/companies/{companyId}/status":{"put":{"operationId":"put-companies-companyId-status","summary":"Update Company Status","description":"Updates a Company’s account status. See [Company Status Codes](#company-status-codes) for a description of the available statuses.","tags":["companies"],"parameters":[{"name":"companyId","in":"path","description":"Unique numeric ID of the Company account.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_put-companies-companyId-status_Response_200"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"companyStatus":{"$ref":"#/components/schemas/companyStatus_integer"}},"required":["companyStatus"]}}}}}},"/companies/extra-fields":{"get":{"operationId":"get-companies-extra-fields","summary":"List Company Extra Field Configs","description":"Returns a list of available extra fields configs for Company accounts.","tags":["companies"],"parameters":[{"name":"limit","in":"query","description":"Determines the number of records to return per page. If left blank, this defaults to `10`.","required":false,"schema":{"type":"integer","default":10}},{"name":"offset","in":"query","description":"The number of results to skip before returning the first result. If left blank, this defaults to `0`.","required":false,"schema":{"type":"integer","default":0}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_get-companies-extra-fields_Response_200"}}}}}}},"/companies/{companyId}/attachments":{"get":{"operationId":"get-companies-companyId-attachments","summary":"List Company Attachments","description":"Returns files uploaded to the Company account.","tags":["companies"],"parameters":[{"name":"companyId","in":"path","description":"Unique numeric ID of the Company account.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_get-companies-companyId-attachments_Response_200"}}}}}},"post":{"operationId":"post-companies-companyId-attachments","summary":"Add Company Attachment","description":"Attaches a file to a Company account.\n\nThe default rate limit for this endpoint is `15` calls/min per store.\n\nEach Company can have a maximum of `10` attachments. The following file types are supported:\n\n```\n- Image files (BMP, GIF, ICO, JPG/JPEG, PNG, SVG, TIF, TIFF, WEBP, WBMP, XBM)\n- PDF\n- DOC, DOCX\n- XLS, XLSX\n- CSV\n```","tags":["companies"],"parameters":[{"name":"companyId","in":"path","description":"Unique numeric ID of the Company account.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_post-companies-companyId-attachments_Response_200"}}}}},"requestBody":{"description":"","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"attachmentFile":{"type":"string","format":"binary","description":"Attaches a file to the Company account. The file must be a supported type and not exceed 10MB."}},"required":["attachmentFile"]}}}}}},"/companies/{companyId}/attachments/{attachmentId}":{"delete":{"operationId":"delete-companies-companyId-attachments-attachmentId","summary":"Delete Company Attachment","description":"Deletes an attached file from a Company account.","tags":["companies"],"parameters":[{"name":"companyId","in":"path","description":"Unique numeric ID of the Company account.","required":true,"schema":{"type":"integer"}},{"name":"attachmentId","in":"path","description":"The ID of a file attached to a Company account.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_delete-companies-companyId-attachments-attachmentId_Response_200"}}}}}}},"/companies/permissions":{"get":{"operationId":"get-stores-companies-permissions","summary":"List Company Permissions","description":"Returns a list of all predefined and custom Company permissions.","tags":["companyRolesAndPermissions"],"parameters":[{"name":"q","in":"query","description":"Enter a Company permission name to return partial and exact matches.","required":false,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company Roles and Permissions_get-stores-companies-permissions_Response_200"}}}}}},"post":{"operationId":"post-stores-companies-permissions","summary":"Create Company Permission","description":"Create a custom Company permission.\n\nNote that the permission’s `name` and `code` values cannot match an existing permission.","tags":["companyRolesAndPermissions"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company Roles and Permissions_post-stores-companies-permissions_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/permission_REQUEST"}}}}}},"/companies/permissions/{permissionId}":{"put":{"operationId":"put-stores-companies-permissions-permissionId","summary":"Update Company Permission","description":"Updates an existing custom Company permission.\n\nPredefined permissions cannot be updated.","tags":["companyRolesAndPermissions"],"parameters":[{"name":"permissionId","in":"path","description":"The unique identifier for a Company permission.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company Roles and Permissions_put-stores-companies-permissions-permissionId_Response_200"}}}}},"requestBody":{"description":"The name and code are unique within the same store.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/permission_REQUEST"}}}}},"delete":{"operationId":"delete-stores-companies-permissions-permissionId","summary":"Delete Company Permission","description":"Deletes a custom Company permission.\n\nPredefined permissions cannot be deleted.","tags":["companyRolesAndPermissions"],"parameters":[{"name":"permissionId","in":"path","description":"The unique identifier for a Company permission.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company Roles and Permissions_delete-stores-companies-permissions-permissionId_Response_200"}}}}}}},"/companies/roles":{"get":{"operationId":"get-stores-companies-roles","summary":"List Company Roles","description":"Returns a list of Company user roles.","tags":["companyRolesAndPermissions"],"parameters":[{"name":"q","in":"query","description":"Enter a Company role name to return partial and exact matches.","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"The number of results to skip before returning the first result. If left blank, this defaults to `0`.","required":false,"schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"Determines the number of records to return per page. If left blank, this defaults to `10`.","required":false,"schema":{"type":"integer","default":10}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company Roles and Permissions_get-stores-companies-roles_Response_200"}}}}}},"post":{"operationId":"post-stores-companies-roles","summary":"Create Company Role","description":"Create a custom Company user role.\n\nWhen adding predefined Company permissions to a user role, refer to [Permission Codes](/developer/api-reference/rest/b2b/management/company/companies#permission-codes) for their `name` and `code` values.\n\nSome permissions require prerequisites that must also be enabled in the role, and assigned to the same or higher permission level. See [B2B Edition Buyer Roles and Permissions](https://support.bigcommerce.com/s/article/Buyer-Roles-and-Permissions) in the Help Center to learn more.","tags":["companyRolesAndPermissions"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roleDetail_RESPONSE"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/role_REQUEST"}}}}}},"/companies/roles/{roleId}":{"get":{"operationId":"get-stores-companies-roles-int:roleId","summary":"Get Company Role Details","description":"Returns the details for a specific Company user role.","tags":["companyRolesAndPermissions"],"parameters":[{"name":"roleId","in":"path","description":"The unique identifier for a Company user role.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roleDetail_RESPONSE"}}}}}},"put":{"operationId":"put-stores-companies-roles-roleId","summary":"Update Company Role","description":"Updates the name and permissions of a custom Company user role. You cannot update predefined roles.\n\nWhen formatting the request body, you must add all permissions that you wish to keep in the role, including its existing permissions. See [Permission Codes](/developer/api-reference/rest/b2b/management/company/companies#permission-codes) for a list of predefined permission `name` and `code` values.","tags":["companyRolesAndPermissions"],"parameters":[{"name":"roleId","in":"path","description":"The unique identifier for a Company user role.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roleDetail_RESPONSE"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/role_REQUEST"}}}}},"delete":{"operationId":"delete-stores-companies-roles-roleId","summary":"Delete Company Role","description":"Deletes a custom Company user role. You cannot delete predefined Company roles, or custom roles that are currently assigned to a Company user.","tags":["companyRolesAndPermissions"],"parameters":[{"name":"roleId","in":"path","description":"The unique identifier for a Company user role.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company Roles and Permissions_delete-stores-companies-roles-roleId_Response_200"}}}}}}},"/invoices/{invoiceId}":{"get":{"operationId":"get-invoices-invoiceId","summary":"Get Invoice Detail","description":"get invoice detail","tags":["invoice"],"parameters":[{"name":"invoiceId","in":"path","description":"invoice id","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice_get-invoices-invoiceId_Response_200"}}}},"404":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-invoices-invoiceIdRequestNotFoundError"}}}}}},"put":{"operationId":"put-invoices-invoiceId","summary":"Update Invoice","description":"update an invoice","tags":["invoice"],"parameters":[{"name":"invoiceId","in":"path","description":"invoice id","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice_put-invoices-invoiceId_Response_200"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string","description":"B2B Edition Company ID"},"externalCustomerId":{"type":"string","description":"Ext Customer ID"},"externalId":{"type":"string","description":"Ext Invoice ID"},"invoiceNumber":{"type":"string","description":"Invoice Number, must be unique"},"type":{"type":"string"},"dueDate":{"type":"number","format":"double","description":"Invoice due date"},"status":{"type":"number","format":"double","description":"invoice status, noted status will be auto set to 2 when open balance is <= 0"},"purchaseOrderNumber":{"type":"string","description":"PO Number"},"details":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetails","description":"Details that will show on the invoice. When updating this field, the new value will completely replace the existing details. To preserve existing details while making updates, retrieve the current details first, and make your edits to that object before submitting the changes."},"source":{"type":"number","format":"double","description":"Mark the source of the invoice, 0 for B2B Edition, 1 for external."},"originalBalance":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaOriginalBalance","description":"Invoice original balance"},"openBalance":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaOpenBalance","description":"Invoice balance awaiting for payment"},"createdAt":{"type":"integer"},"externalPdfUrl":{"type":"string","description":"The URL of an externally hosted PDF file to be associated with this invoice. The file size must not exceed 5 MB. Ensure that the file hosting service supports Cross-Origin Resource Sharing (CORS) to allow our system to access the file. To remove an existing PDF link, use an empty string."},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems"}}}}}}}},"delete":{"operationId":"delete-invoices-invoiceId","summary":"Delete Invoice","description":"delete an invoice","tags":["invoice"],"parameters":[{"name":"invoiceId","in":"path","description":"invoice id","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice_delete-invoices-invoiceId_Response_200"}}}},"404":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete-invoices-invoiceIdRequestNotFoundError"}}}}}}},"/invoices":{"get":{"operationId":"get-invoices","summary":"List Invoices","description":"get invoices","tags":["invoice"],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"limit","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"orderBy","in":"query","description":"\"DESC\" or \"ASC\"","required":false,"schema":{"$ref":"#/components/schemas/InvoicesGetParametersOrderBy"}},{"name":"sortBy","in":"query","description":"Sort by the field value","required":false,"schema":{"$ref":"#/components/schemas/InvoicesGetParametersSortBy"}},{"name":"searchBy","in":"query","description":"Filter by a field","required":false,"schema":{"$ref":"#/components/schemas/InvoicesGetParametersSearchBy"}},{"name":"q","in":"query","description":"You can perform keyword queries on fields corresponding to the value of \"searchBy\" or, if \"searchBy\" is empty, on all fields supported by \"searchBy\".","required":false,"schema":{"type":"string"}},{"name":"customerName","in":"query","description":"Query by invoice B2B Edition company name","required":false,"schema":{"type":"string"}},{"name":"customerId","in":"query","description":"Query by invoice B2B Edition company ID","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Query by invoice status","required":false,"schema":{"$ref":"#/components/schemas/InvoicesGetParametersStatus"}},{"name":"beginDateAt","in":"query","description":"Query by the created timestamp, along with the \"endDateAt\" parameter","required":false,"schema":{"type":"string"}},{"name":"endDateAt","in":"query","description":"Query by the created timestamp, along with the with the \"beginDateAt\" parameter","required":false,"schema":{"type":"string"}},{"name":"externalId[]","in":"query","description":"Query by the invoice external ID","required":false,"schema":{"type":"array","items":{"type":"number","format":"double"}}},{"name":"isIncludeExtraFields","in":"query","description":"Determine if extra fields should show in the response","required":false,"schema":{"$ref":"#/components/schemas/InvoicesGetParametersIsIncludeExtraFields"}},{"name":"channelIds","in":"query","description":"BigCommerce Channel IDs","required":false,"schema":{"type":"array","items":{"type":"number","format":"double"}}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice_get-invoices_Response_200"}}}}}},"post":{"operationId":"post-invoices","summary":"Create Invoice","description":"Create Invoice","tags":["invoice"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice_post-invoices_Response_200"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"invoiceNumber":{"type":"string","description":"Invoice no."},"type":{"type":"string","default":"Invoice","description":"Invoice type"},"dueDate":{"type":"integer","description":"The due date for this invoice, specified as a Unix timestamp. If left empty, it will be set to the current date plus a pre-configured number of days (set in your B2B Edition control panel settings)."},"status":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaStatus","default":0,"description":"Invoice status. Possible values:\n0: Open (default)\n1: Partially paid\n2: Completed\n\nThe status will automatically be set to Completed (2) when the open balance becomes zero or negative."},"orderNumber":{"type":"string","description":"BigCommerce order ID associated with this invoice."},"purchaseOrderNumber":{"type":"string","description":"PO Number"},"originalBalance":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaOriginalBalance","description":"Original balance"},"openBalance":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaOpenBalance","description":"Open balance , when it is <= 0, status will be auto set to 2"},"issuedAt":{"type":"number","format":"double","description":"When the invoice was created. The current timestamp is the default."},"details":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaDetails","description":"Invoice details"},"source":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaSource","default":0,"description":"The source of the invoice. Possible values:\n0: B2B Edition\n1: External"},"customerId":{"type":"string","description":"B2B Edition Company ID"},"externalId":{"type":"string","description":"ERP Invoice ID"},"externalCustomerId":{"type":"string","description":"ERP Customer ID"},"channelId":{"type":"integer","description":"BigCommerce Channel ID"},"externalPdfUrl":{"type":"string","description":"The URL of an externally hosted PDF file to be associated with this invoice. The file size must not exceed 5 MB. Ensure that the file hosting service supports Cross-Origin Resource Sharing (CORS) to allow our system to access the file."},"termsConditions":{"type":"string","description":"Terms & Conditions. Visible on the default Invoice PDF."},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems"}}},"required":["invoiceNumber","originalBalance","openBalance","customerId"]}}}}}},"/orders/{orderId}/invoices":{"post":{"operationId":"post-orders-orderId-invoices","summary":"Create Invoice from Order","description":"create invoice from B2B Edition order","tags":["invoice"],"parameters":[{"name":"orderId","in":"path","description":"B2B Edition order ID","required":true,"schema":{"type":"number","format":"double"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice_post-orders-orderId-invoices_Response_200"}}}}}}},"/invoices/{invoiceId}/download-pdf":{"get":{"operationId":"get-invoices-invoiceId-download-pdf","summary":"Download Invoice PDF","description":"Get invoice download PDF","tags":["invoice"],"parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice_get-invoices-invoiceId-download-pdf_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-invoices-invoiceId-download-pdfRequestNotFoundError"}}}}}}},"/invoices/extra-fields":{"get":{"operationId":"get-invoices-extra-fields","summary":"Get Invoice Extra Field Configs","description":"Get invoice extra field configs","tags":["invoice"],"parameters":[{"name":"offset","in":"query","description":"The number of items to skip before starting to collect the result set.","required":false,"schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of results to return.","required":false,"schema":{"type":"integer","default":10}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice_get-invoices-extra-fields_Response_200"}}}}}}},"/payments":{"get":{"operationId":"get-payments","summary":"List Payment Methods","description":"Returns a list of all payment methods available on the store.","tags":["payment"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment_get-payments_Response_200"}}}}}}},"/payments/{paymentId}":{"get":{"operationId":"get-payments-paymentId","summary":"Get Payment Detail","description":"Get payment detail","tags":["payments"],"parameters":[{"name":"paymentId","in":"path","description":"Payment ID","required":true,"schema":{"type":"number","format":"double"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_get-payments-paymentId_Response_200"}}}},"404":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-payments-paymentIdRequestNotFoundError"}}}}}},"delete":{"operationId":"delete-a-payment","summary":"Delete Payment","description":"Delete a payment","tags":["payments"],"parameters":[{"name":"paymentId","in":"path","description":"Payment ID","required":true,"schema":{"type":"number","format":"double"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_delete-a-payment_Response_200"}}}},"404":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete-a-paymentRequestNotFoundError"}}}}}}},"/payments/{paymentId}/operations":{"get":{"operationId":"get-payment-operations-operations","summary":"Get Payment Operation","description":"Get a payment for all operations","tags":["payments"],"parameters":[{"name":"paymentId","in":"path","description":"Payment ID","required":true,"schema":{"type":"number","format":"double"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_get-payment-operations-operations_Response_200"}}}},"404":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-payment-operations-operationsRequestNotFoundError"}}}}}},"post":{"operationId":"post-payments-paymentId-operations","summary":"Perform Payment Operation","description":"Performing payment operation","tags":["payments"],"parameters":[{"name":"paymentId","in":"path","description":"Payment ID","required":true,"schema":{"type":"number","format":"double"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_post-payments-paymentId-operations_Response_200"}}}},"400":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-payments-paymentId-operationsRequestBadRequestError"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"operationCode":{"$ref":"#/components/schemas/PaymentsPaymentIdOperationsPostRequestBodyContentApplicationJsonSchemaOperationCode","description":"Payment operation code. The list of allowed operations for this payment."}},"required":["operationCode"]}}}}}},"/payments/{paymentId}/processing-status":{"put":{"operationId":"put-payments-paymentId-processing-status","summary":"Update Payment Processing Status","description":"Update payment processing status","tags":["payments"],"parameters":[{"name":"paymentId","in":"path","description":"Payment ID","required":true,"schema":{"type":"number","format":"double"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_put-payments-paymentId-processing-status_Response_200"}}}},"400":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-payments-paymentId-processing-statusRequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"processingStatus":{"type":"number","format":"double","description":"payment processing status(1=\"Awaiting Processing\", 2=\"Processing\", 3=\"Completed\", 4=\"Refunded\")"}},"required":["processingStatus"]}}}}}},"/payments/{paymentId}/transactions":{"get":{"operationId":"get-payments-paymentId-transactions","summary":"List Payment Transactions","description":"Get payment transactions","tags":["payments"],"parameters":[{"name":"paymentId","in":"path","description":"Payment ID","required":true,"schema":{"type":"number","format":"double"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_get-payments-paymentId-transactions_Response_200"}}}},"404":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-payments-paymentId-transactionsRequestNotFoundError"}}}}}}},"/payments/offline":{"post":{"operationId":"post-payments-offline","summary":"Create Offline Payment","description":"Create offline payment","tags":["payments"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_post-payments-offline_Response_200"}}}},"422":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-payments-offlineRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/PaymentsOfflinePostRequestBodyContentApplicationJsonSchemaLineItemsItems"}},"currency":{"type":"string"},"details":{"$ref":"#/components/schemas/PaymentsOfflinePostRequestBodyContentApplicationJsonSchemaDetails"},"externalId":{"type":"string"},"customerId":{"type":"string","description":"B2B Edition Company ID"},"externalCustomerId":{"type":"string"},"payerName":{"type":"string","default":"Store offline payment","description":"Default is \"Store Offline Payment \" if no value is passed in."},"payerCustomerId":{"type":"string","description":"The default value is the same as the customerId."},"processingStatus":{"$ref":"#/components/schemas/PaymentsOfflinePostRequestBodyContentApplicationJsonSchemaProcessingStatus","default":3,"description":"payment status, 3 is the default "},"channelId":{"type":"integer","description":"BigCommerce channel ID"}},"required":["lineItems","currency","details","customerId"]}}}}}},"/payments/offline/{paymentId}":{"put":{"operationId":"put-payments-offline-paymentId","summary":"Update Offline Payment","description":"Update offline payment","tags":["payments"],"parameters":[{"name":"paymentId","in":"path","description":"Payment ID","required":true,"schema":{"type":"number","format":"double"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payments_put-payments-offline-paymentId_Response_200"}}}},"422":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-payments-offline-paymentIdRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/PaymentsOfflinePaymentIdPutRequestBodyContentApplicationJsonSchemaLineItemsItems"}},"currency":{"type":"string"},"details":{"$ref":"#/components/schemas/PaymentsOfflinePaymentIdPutRequestBodyContentApplicationJsonSchemaDetails"},"externalId":{"type":"string"},"customerId":{"type":"string","description":"B2B Edition Company ID"},"externalCustomerId":{"type":"string"},"payerName":{"type":"string","default":"Store offline payment","description":"Default is \"Store Offline Payment \" if no value is passed in."},"payerCustomerId":{"type":"string","description":"The default is the same as the customerId."},"processingStatus":{"$ref":"#/components/schemas/PaymentsOfflinePaymentIdPutRequestBodyContentApplicationJsonSchemaProcessingStatus","default":3},"fundingStatus":{"$ref":"#/components/schemas/PaymentsOfflinePaymentIdPutRequestBodyContentApplicationJsonSchemaFundingStatus","default":2}},"required":["lineItems","currency","details","customerId"]}}}}}},"/receipts":{"get":{"operationId":"get-ip-receipts","summary":"List Receipts","description":"Get receipts, with pagination data","tags":["receipt"],"parameters":[{"name":"offset","in":"query","description":"Pagination offset default: 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Pagination limit default: 10","required":false,"schema":{"type":"integer","default":10}},{"name":"orderBy","in":"query","description":"Allow: 'DESC', 'ASC'","required":false,"schema":{"$ref":"#/components/schemas/ReceiptsGetParametersOrderBy","default":"DESC"}},{"name":"sortBy","in":"query","description":"The response sorted by which field","required":false,"schema":{"$ref":"#/components/schemas/ReceiptsGetParametersSortBy","default":"createdAt"}},{"name":"q","in":"query","description":"You can perform keyword queries on fields corresponding to the value of \"searchBy\" or, if \"searchBy\" is empty, on all fields supported by \"searchBy\".","required":false,"schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"The response search by which field","required":false,"schema":{"$ref":"#/components/schemas/ReceiptsGetParametersSearchBy"}},{"name":"paymentStatus[]","in":"query","description":"Payment processing status. 0 means ‘Incomplete’ status, 1 means ‘Awaiting Processing’ status, 2 means ‘Processing’ status, 3 means ‘Completed’ status, 4 means ‘Refunded' status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReceiptsGetParametersPaymentStatusSchemaItems"}}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt_get-ip-receipts_Response_200"}}}}}}},"/receipts/{receiptId}":{"get":{"operationId":"get-ip-receipts-receiptId","summary":"Get Receipt","description":"Get a receipt detail","tags":["receipt"],"parameters":[{"name":"receiptId","in":"path","description":"The unique ID of the receipt.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt_get-ip-receipts-receiptId_Response_200"}}}},"404":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-ip-receipts-receiptIdRequestNotFoundError"}}}}}},"delete":{"operationId":"delete-ip-receipts-receiptId","summary":"Delete Receipt","description":"Delete a receipt","tags":["receipt"],"parameters":[{"name":"receiptId","in":"path","description":"The unique ID of the receipt.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt_delete-ip-receipts-receiptId_Response_200"}}}},"404":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete-ip-receipts-receiptIdRequestNotFoundError"}}}}}}},"/receipt-lines":{"get":{"operationId":"get-ip-receipt-lines","summary":"List Receipt Lines","description":"Get all receipt lines, with pagination data","tags":["receipt"],"parameters":[{"name":"offset","in":"query","description":"Pagination offset default: 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Pagination limit default: 10","required":false,"schema":{"type":"integer","default":10}},{"name":"orderBy","in":"query","description":"Allow: 'DESC', 'ASC'","required":false,"schema":{"$ref":"#/components/schemas/ReceiptLinesGetParametersOrderBy","default":"DESC"}},{"name":"paymentStatus[]","in":"query","description":"Payment processing status. 0 means ‘Incomplete’ status, 1 means ‘Awaiting Processing’ status, 2 means ‘Processing’ status, 3 means ‘Completed’ status, 4 means ‘Refunded' status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReceiptLinesGetParametersPaymentStatusSchemaItems"}}},{"name":"q","in":"query","description":"You can perform keyword queries on fields corresponding to the value of \"searchBy\" or, if \"searchBy\" is empty, on all fields supported by \"searchBy\".","required":false,"schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"The response search by which field","required":false,"schema":{"$ref":"#/components/schemas/ReceiptLinesGetParametersSearchBy"}},{"name":"sortBy","in":"query","description":"The response sorted by which field","required":false,"schema":{"$ref":"#/components/schemas/ReceiptLinesGetParametersSortBy","default":"createdAt"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt_get-ip-receipt-lines_Response_200"}}}}}}},"/receipts/{receiptId}/lines":{"get":{"operationId":"get-ip-lines-of-receipt","summary":"List Lines of Receipt","description":"Get lines of a receipt, with pagination data","tags":["receipt"],"parameters":[{"name":"receiptId","in":"path","description":"The unique ID of the receipt.","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Pagination offset default: 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Pagination limit default: 10","required":false,"schema":{"type":"integer","default":10}},{"name":"orderBy","in":"query","description":"Allow: 'DESC', 'ASC'","required":false,"schema":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesGetParametersOrderBy","default":"DESC"}},{"name":"paymentStatus[]","in":"query","description":"Payment processing status. 0 means ‘Incomplete’ status, 1 means ‘Awaiting Processing’ status, 2 means ‘Processing’ status, 3 means ‘Completed’ status, 4 means ‘Refunded' status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesGetParametersPaymentStatusSchemaItems"}}},{"name":"q","in":"query","description":"You can perform keyword queries on fields corresponding to the value of \"searchBy\" or, if \"searchBy\" is empty, on all fields supported by \"searchBy\".","required":false,"schema":{"type":"string"}},{"name":"searchBy","in":"query","description":"The response search by which field","required":false,"schema":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesGetParametersSearchBy"}},{"name":"sortBy","in":"query","description":"The response sorted by which field","required":false,"schema":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesGetParametersSortBy","default":"createdAt"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt_get-ip-lines-of-receipt_Response_200"}}}},"404":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-ip-lines-of-receiptRequestNotFoundError"}}}}}}},"/receipts/{receiptId}/lines/{receiptLineId}":{"get":{"operationId":"get-ip-receipts-receiptId-lines-receiptLineId","summary":"Get Receipt Line Detail","description":"Get a receipt line detail","tags":["receipt"],"parameters":[{"name":"receiptId","in":"path","description":"The unique ID of the receipt.","required":true,"schema":{"type":"string"}},{"name":"receiptLineId","in":"path","description":"The unique ID of the receipt line.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt_get-ip-receipts-receiptId-lines-receiptLineId_Response_200"}}}}}},"delete":{"operationId":"delete-ip-receipts-receiptId-lines-receiptLineId","summary":"Delete Receipt Line","description":"Delete a receipt line","tags":["receipt"],"parameters":[{"name":"receiptId","in":"path","description":"The unique ID of the receipt.","required":true,"schema":{"type":"string"}},{"name":"receiptLineId","in":"path","description":"The unique ID of the receipt line.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt_delete-ip-receipts-receiptId-lines-receiptLineId_Response_200"}}}}}}},"/orders":{"get":{"operationId":"get-orders","summary":"List Orders","description":"Retrieves limited information for all orders, including B2B-specific information like Company IDs and order extra fields. The response includes orders placed by B2C customers and guest shoppers. Use [Get Order Products](#get-order-products) to retrieve an order's product details, or use the BigCommerce [Orders V2 API](/developer/api-reference/rest/admin/management/orders) to retrieve all order details except those specific to B2B Edition, like Company ID and extra fields.\n\nUse the parameters to filter the returned orders by attributes like associated Company ID, date created, or storefront channel. You can also set the `showExtra` parameter to `true` in order to return extra field values associated with the order.","tags":["orders"],"parameters":[{"name":"companyId","in":"query","description":"Unique numeric ID of the Company account.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Determines the number of records to return per page. If left blank, this defaults to `10`.","required":false,"schema":{"type":"integer","default":10}},{"name":"offset","in":"query","description":"The number of results to skip before returning the first result. If left blank, this defaults to `0`.","required":false,"schema":{"type":"integer","default":0}},{"name":"orderBy","in":"query","description":"Establish a descending or ascending order of results. The order defaults to descending if the parameter is not included.","required":false,"schema":{"$ref":"#/components/schemas/OrdersGetParametersOrderBy","default":"DESC"}},{"name":"sortBy","in":"query","description":"Sorts results by creation date or the last updated date. It defaults to the last updated date if no parameter is provided.","required":false,"schema":{"$ref":"#/components/schemas/OrdersGetParametersSortBy","default":"updatedAt"}},{"name":"bcOrderId","in":"query","description":"The BigCommerce order ID. This parameter **does not** accept the B2B Edition order ID returned in certain [Server to Server Orders](/developer/api-reference/rest/b2b/management/orders) endpoints.","required":false,"schema":{"type":"integer"}},{"name":"minModified","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all orders updated after that time.","required":false,"schema":{"type":"integer"}},{"name":"maxModified","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all orders updated before that time.","required":false,"schema":{"type":"integer"}},{"name":"minCreated","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all orders created after that time.","required":false,"schema":{"type":"integer"}},{"name":"maxCreated","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all orders created before that time.","required":false,"schema":{"type":"integer"}},{"name":"showExtra","in":"query","description":"Indicates whether or not extra fields should be included in the response.","required":false,"schema":{"type":"boolean","default":false}},{"name":"channelIds[]","in":"query","description":"BigCommerce channel IDs","required":false,"schema":{"type":"array","items":{"type":"number","format":"double"},"default":1}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders_get-orders_Response_200"}}}}}},"post":{"operationId":"post-orders","summary":"Create Order","description":"Generates an order record in B2B Edition after a Company user places an order. This occurs automatically; however, you can populate extra information on a B2B order by using a [webhook](/developer/docs/integrations/webhooks) that first listens for BigCommerce order creation and then calls the Create an Order endpoint. The request must be made within 10 seconds of an order's creation for it to be successful.\n\nThis endpoint **does not** create a new order in your store. Use the [Orders V2 API](/developer/api-reference/rest/admin/management/orders) to add new orders via the API.","tags":["orders"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders_post-orders_Response_200"}}}},"400":{"description":"Bad Request\n\nThis error occurs if the order has existed for longer than 10 seconds before making the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-ordersRequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createOrder"}}}}}},"/orders/{bcOrderId}":{"get":{"operationId":"get-orders-orderId","summary":"Get Order","description":"Retrieves limited information for a specific order based on the `bcOrderId` provided. The response includes the same fields as the Get All Orders endpoint, including B2B extra fields and PO numbers.\n\nThe `bcOrderId` parameter must include a valid BigCommerce Order ID (**not** the B2B Edition order ID returned in certain Orders endpoints) for the request to be successful.","tags":["orders"],"parameters":[{"name":"bcOrderId","in":"path","description":"The BigCommerce order ID.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders_get-orders-orderId_Response_200"}}}},"404":{"description":"Not Found\n\nThis error occurs when an invalid order ID is provided in the `bcOrderId` parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-orders-orderIdRequestNotFoundError"}}}}}},"put":{"operationId":"put-orders-orderId","summary":"Update Order","description":"Updates B2B information on a specific order based on the `bcOrderId` provided.\n\nThe `bcOrderId` parameter must include a valid BigCommerce Order ID (**not** the B2B Edition order ID returned in certain Orders endpoints) for the request to be successful. You must also include at least one of the following fields in the request body:\n\n- `poNumber`\n- `extraFields` (array with `fieldName` and `fieldValue`)\n    - This array must be included if your store has required order extra fields.","tags":["orders"],"parameters":[{"name":"bcOrderId","in":"path","description":"The BigCommerce order ID.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders_put-orders-orderId_Response_200"}}}},"404":{"description":"Not Found\n\nThis error occurs when an invalid order ID is provided in the `bcOrderId` parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-orders-orderIdRequestNotFoundError"}}}},"422":{"description":"Required Extra Field Missing\n\nThis error occurs if your store has required order extra fields, but the `extraFields` array is not included in the request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-orders-orderIdRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"poNumber":{"$ref":"#/components/schemas/poNumber"},"extraFields":{"$ref":"#/components/schemas/extraField_BASIC/properties/extraFields"}}}}}}}},"/customers/{customerId}/orders/company":{"put":{"operationId":"put-orders-company","summary":"Reassign Orders to Different Company","description":"Reassigns all orders from a specific B2B Edition Company user to a different Company account. This adds the orders to the Company's Buyer Portal. This **does not** automatically reassign the Company user account to the Company, however.\n\n### Independent vs. Dependent Companies Behavior\n\nThis request uses the `bcGroupId` field to assign orders by customer group ID instead of the Company ID. As a result, it is only supported if your store uses the legacy Dependent Companies behavior. Do not use this request if your store uses [Independent Companies behavior](https://support.bigcommerce.com/s/article/Companies-and-Customer-Groups).\n\nFor a successful response, you must include the `bcGroupId` field with a BigCommerce customer group ID value that corresponds to a Company account.","tags":["orders"],"parameters":[{"name":"customerId","in":"path","description":"The ID of a BigCommerce customer account with a corresponding Company user account.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders_put-orders-company_Response_200"}}}},"404":{"description":"Not Found\n\nThis error occurs when the `customerId   parameter or the   bcGroupId  field do not correspond to a valid customer account or customer group respectively. Confirm that the `customerId` corresponds to an existing Company user, and that the `bcGroupId` corresponds to a customer group dedicated to a single Company account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-orders-companyRequestNotFoundError"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bcGroupId":{"type":"integer","description":"The unique identifier for the BigCommerce customer group that corresponds to the Company account that you are assigning to the order."}},"required":["bcGroupId"]}}}}}},"/orders/{bcOrderId}/products":{"get":{"operationId":"get-orders-orderId-products","summary":"List Order Products","description":"Retrieves product details of a specific order based on the `bcOrderId` provided. The `bcOrderId` parameter must include a valid BigCommerce Order ID (**not** the B2B Edition order ID returned in certain Orders endpoints) for the request to be successful.\n\nThis does not include all product information, such as pricing and physical dimensions. You can retrieve this information by using the [List Order Products](/developer/api-reference/rest/admin/management/orders/order-products/get-order-products) endpoint of the BigCommerce Orders API.","tags":["orders"],"parameters":[{"name":"bcOrderId","in":"path","description":"The BigCommerce order ID.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders_get-orders-orderId-products_Response_200"}}}},"404":{"description":"Not Found\n\nThis error occurs when you provide an invalid `bcOrderId` value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-orders-orderId-productsRequestNotFoundError"}}}}}}},"/customers/{customerId}/orders/b2b":{"put":{"operationId":"put-customers-customerId-orders-bc","summary":"Assign Customer Orders to Company","description":"Associates orders from a buyer to their Company account based on the `customerId` entered. This endpoint is useful if a buyer has orders they placed before applying for or being added to a Company account.\n\nThe `customerId` parameter must include a valid BigCommerce customer ID for the request to be successful. This is different from the B2B Edition Company user ID returned by some B2B API endpoints, such as the `id` field in [Get Users](/developer/api-reference/rest/b2b/management/users).","tags":["orders"],"parameters":[{"name":"customerId","in":"path","description":"The ID of a BigCommerce customer account with a corresponding Company user account.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders_put-customers-customerId-orders-bc_Response_200"}}}},"404":{"description":"Not Found\n\nThis error occurs when you provide a `customerId` that does not correspond to a Company user’s customer account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-customers-customerId-orders-bcRequestNotFoundError"}}}}}}},"/orders/extra-fields":{"get":{"operationId":"get-orders-extra-fields","summary":"List Order Extra Field Configs","description":"Returns a list of available extra fields configurations for B2B orders.\n\nWe recommend caching the response results to avoid frequent API requests.","tags":["orders"],"parameters":[{"name":"limit","in":"query","description":"Determines the number of records to return per page. If left blank, this defaults to `10`.","required":false,"schema":{"type":"integer","default":10}},{"name":"offset","in":"query","description":"The number of results to skip before returning the first result. If left blank, this defaults to `0`.","required":false,"schema":{"type":"integer","default":0}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders_get-orders-extra-fields_Response_200"}}}}}}},"/companies/{companyId}/payments":{"get":{"operationId":"get-companies-companyId-payments","summary":"List Company Payment Methods","description":"Returns the list of payment methods for the Company associated with `companyId`, indicating which ones are currently available to the Company users.","tags":["payment"],"parameters":[{"name":"companyId","in":"path","description":"The unique numeric ID of the Company assigned by B2B Edition.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment_get-companies-companyId-payments_Response_200"}}}}}},"put":{"operationId":"put-companies-companyId-payments","summary":"Update Company Payment Methods","description":"Updates whether the payment methods included in the request body are enabled for the Company associated with `companyId`.","tags":["payment"],"parameters":[{"name":"companyId","in":"path","description":"The unique numeric ID of the Company assigned by B2B Edition.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment_put-companies-companyId-payments_Response_200"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-companies-companyId-paymentsRequestBadRequestError"}}}},"404":{"description":"Resource Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-companies-companyId-paymentsRequestNotFoundError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payments":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentsPutRequestBodyContentApplicationJsonSchemaPaymentsItems"}}}}}}}}},"/company-payment-methods":{"get":{"operationId":"get-company-payment-methods","summary":"List Active Payment Methods","description":"Get all currently enabled payment methods across Companies. If multiple Companies have a given payment method enabled, each one will be returned in the results. Data is returned with pagination.","tags":["payment"],"parameters":[{"name":"orderBy","in":"query","description":"Specifies the order data should be returned in. If not included, defaults to 'DESC'.","required":false,"schema":{"$ref":"#/components/schemas/CompanyPaymentMethodsGetParametersOrderBy"}},{"name":"sortBy","in":"query","description":"Sorts data based on creation or modification time while respecting the `orderBy` parameter. If not included, defaults to 'updatedAt'.","required":false,"schema":{"$ref":"#/components/schemas/CompanyPaymentMethodsGetParametersSortBy","default":"updatedAt"}},{"name":"limit","in":"query","description":"Sets the maximum number of records to display in the response.","required":false,"schema":{"type":"integer","default":10}},{"name":"offset","in":"query","description":"Sets the number of records to skip before displaying the response.","required":false,"schema":{"type":"integer","default":0}},{"name":"companyId","in":"query","description":"Filters results by `companyId`, only showing payment methods enabled for the specified Company.","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","description":"The search string by which data should be filtered. Currently supports payment method code & payment method title, so that a value of `q=auth` would return any payment method with 'auth' in either the code or the title.","required":false,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment_get-company-payment-methods_Response_200"}}}}}}},"/companies/{companyId}/credit":{"get":{"operationId":"get-companies-companyId-credit","summary":"Get Company Credit Status","description":"Returns the credit settings for the Company specified by `companyId`. If the Company credit feature is disabled, this request will fail. See [B2B Edition Settings](https://support.bigcommerce.com/s/article/B2B-Edition-Settings) for more information.","tags":["payment"],"parameters":[{"name":"companyId","in":"path","description":"The unique numeric ID of the Company assigned by B2B Edition.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment_get-companies-companyId-credit_Response_200"}}}},"400":{"description":"Invalid Request\n\nThis error is returned if the credit feature is disabled for the store. Enable the feature in B2B Edition to get valid response data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-companies-companyId-creditRequestBadRequestError"}}}}}},"put":{"operationId":"put-companies-companyId-credit","summary":"Update Company Credit Status","description":"Updates the credit settings for the Company specified by `companyId`. All fields are optional, but an empty request will result in unexpected behavior. If the Company credit feature is disabled, this request will fail. See [B2B Edition Settings](https://support.bigcommerce.com/s/article/B2B-Edition-Settings) for more information.","tags":["payment"],"parameters":[{"name":"companyId","in":"path","description":"The unique numeric ID of the Company assigned by B2B Edition.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment_put-companies-companyId-credit_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/creditStatus"}}}}}},"/companies/{companyId}/payment-terms":{"get":{"operationId":"get-companies-companyId-payment-terms","summary":"Get Company-Level Payment Terms","description":"Returns the Company-level payment terms for the Company specified by `companyId`. If payment on terms is disabled for the Company, the value of `paymentTerms` in the response will reflect the store-level default.","tags":["payment"],"parameters":[{"name":"companyId","in":"path","description":"The unique numeric ID of the Company assigned by B2B Edition.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment_get-companies-companyId-payment-terms_Response_200"}}}}}},"put":{"operationId":"put-companies-companyId-payment-terms","summary":"Update Company-Level Payment Terms","description":"Updates the Company-level payment terms for the Company specified by `companyId`. If the value of `isEnabled` is set to `false`, the `paymentTerms` field will be ignored and will default to the store-level value.","tags":["payment"],"parameters":[{"name":"companyId","in":"path","description":"The unique numeric ID of the Company assigned by B2B Edition.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment_put-companies-companyId-payment-terms_Response_200"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-companies-companyId-payment-termsRequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"Indicates whether payment on terms is available for the specified Company."},"paymentTerms":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentTermsPutRequestBodyContentApplicationJsonSchemaPaymentTerms","description":"The term set for the specified Company. This field takes the store-level default value if `isEnabled` is `false`."}},"required":["isEnabled","paymentTerms"]}}}}}},"/rfq":{"get":{"operationId":"get-rfq","summary":"List Quotes","description":"Retrieves basic information for all sales quotes in your store. Use the parameters to narrow your results, such as filtering by a date range or quotes from a specific Company account.\n\nMore detailed information, such as line items and shipping details, can be retrieved with the [Get Quote Details](#get-quote-details) endpoint.","tags":["quotes"],"parameters":[{"name":"offset","in":"query","description":"The number of results to skip before returning the first result. If left blank, this defaults to `0`.","required":false,"schema":{"type":"integer","default":"0"}},{"name":"limit","in":"query","description":"Determines the number of records to return per page. If left blank, this defaults to `10`.","required":false,"schema":{"type":"integer","default":"10"}},{"name":"sortBy","in":"query","description":"Sorts results by Company name (`company`), quote status (`status`), sales rep name (`salesRep`), creation date (`createdAt`), expiration date (`expiredAt`), or last updated date (`updatedAt`). It defaults to the last updated date if no parameter is provided.","required":false,"schema":{"$ref":"#/components/schemas/RfqGetParametersSortBy","default":"updatedAt"}},{"name":"orderBy","in":"query","description":"Establish a descending or ascending order of results. The order defaults to descending if the parameter is not included.","required":false,"schema":{"$ref":"#/components/schemas/RfqGetParametersOrderBy","default":"desc"}},{"name":"q","in":"query","description":"Enter quote information to return partial and exact matches. Accepted information fields include quote number, quote title, Company name, assigned sales rep, and Company user first and last name.","required":false,"schema":{"type":"string"}},{"name":"quoteNumber","in":"query","description":"Enter a full or partial quote number to retrieve relevant quotes.","required":false,"schema":{"type":"string"}},{"name":"company","in":"query","description":"Enter a full or partial Company name to retrieve relevant quotes.","required":false,"schema":{"type":"string"}},{"name":"salesRep","in":"query","description":"The name of the sales rep assigned to the quote.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"The backend status of the sales quote. Note that these are not the same as buyer-facing quote status. See [Quote Statuses](#quote-statuses) for more information.","required":false,"schema":{"$ref":"#/components/schemas/RfqGetParametersStatus"}},{"name":"quoteTitle","in":"query","description":"The external title given to the quote.","required":false,"schema":{"type":"string"}},{"name":"createdBy","in":"query","description":"The name of the sales rep or buyer who created the quote.","required":false,"schema":{"type":"string"}},{"name":"maxCreated","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all quotes created before that time.","required":false,"schema":{"type":"integer"}},{"name":"minCreated","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all quotes created after that time.","required":false,"schema":{"type":"integer"}},{"name":"maxModified","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all quotes modified before that time.","required":false,"schema":{"type":"integer"}},{"name":"minModified","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all quotes modified after that time.","required":false,"schema":{"type":"integer"}},{"name":"maxExpired","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all quotes that expired before that time.","required":false,"schema":{"type":"integer"}},{"name":"minExpired","in":"query","description":"Enter a [Unix timestamp](https://www.unixtimestamp.com/) to retrieve all quotes that expired after that time.","required":false,"schema":{"type":"integer"}},{"name":"channelIds[]","in":"query","description":"Enter one or more storefront channel IDs to retrieve quotes assigned to the storefront(s). Use 1 for your store’s default storefront channel. Separate channel IDs with a comma.","required":false,"schema":{"type":"array","items":{"type":"integer"},"default":1}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK\n\nA 200 response has a body with information on all quotes based on the provided parameters. If there are no quotes that correspond to the provided parameter values, the endpoint still returns a 200 response, but the `data` array is empty.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quotes_get-rfq_Response_200"}}}},"400":{"description":"Bad Requests Error\n\nThe 400 error occurs if the `channelIds` parameter is not formatted correctly. The parameter must be formatted as an array, and you must separate each channel ID value with a comma. An example of  proper format is `?channelIds[]=1,12345678`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-rfqRequestBadRequestError"}}}}}},"post":{"operationId":"post-rfq","summary":"Create Quote","description":"Creates a new sales quote and automatically submits it to the assigned buyer. \n\nWhile the B2B Edition control panel allows you to save a new quote as a draft without sending it to the buyer, quotes created with this endpoint are automatically visible in a Company user's Buyer Portal. However, you can give the `allowCheckout` a value of `false` to prevent the buyer from purchasing it immediately upon submission.\n\n### Custom Products\n\nWhile you can create custom products from within a quote while creating or editing it in your B2B Edition control panel, you cannot create a custom product with this endpoint. \n\nCreate a custom product while [creating or editing](https://support.bigcommerce.com/s/article/B2B-Edition-Quotes) a quote in the B2B Edition control panel, or by using the [Create a Product](/developer/api-reference/rest/admin/catalog/products/create-product) endpoint in the Catalog API. Obtain your newly-created product’s ID and add it to the `productId` field of the Create a Quote request body to include it in the quote.\n\n### Minimum Required Fields\n\nIn order to create a sales quote, the request body must include the following fields. Fields marked with an asterisk are only required under specific conditions.\n\n* `grandTotal`\n* `discount`\n* `subtotal`\n* `userEmail`\n* `expiredAt`\n* `contactInfo`\n    * `name`\n    * `email`\n* `companyId`*\n* `productList`\n    * `sku`\n    * `productId`\n    * `basePrice`\n    * `discount`\n    * `offeredPrice`\n    * `quantity`\n* `extraFields`*\n    * `fieldName`*\n    * `fieldValue`*\n* `channelId`*\n\nThe `companyId` field is only required if you are linking a quote to an existing Company account. The `companyName` and `email` fields under `contactInfo` cannot be used to link a quote to a particular Company account or user.\n\nThe optional `bcCustomerId` field links a quote to an existing registered non-company customer account. If both `companyId` and `bcCustomerId` are provided, `companyId` takes precedence. If neither is provided, the quote is created as a guest quote.\n\nThe `contactInfo` object is display-only metadata. Customer association is determined solely by `bcCustomerId` and `companyId`; `contactInfo.email` and `userEmail` are not used to look up or validate the customer record.\n\nThe `extraFields` array is only required if you have created Quote extra fields which are marked as required. To learn more about extra fields, see B2B Edition Settings (Help Center).\n\nThe `channelId` field is required if you have multiple storefront channels. If you only have a single storefront, then you do not need to include it.","tags":["quotes"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quotes_post-rfq_Response_200"}}}},"404":{"description":"Not Found\n\nThe 404 error occurs when the `bcCustomerId` or `companyId` provided in the request body does not match an existing customer or Company account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseError"}}}},"422":{"description":"Missing or Invalid Data\n\nThe 422 error occurs if any of the fields are not formatted correctly. Check the detailed error message to determine which field is affected and what must be corrected.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/quoteData_POST"}}}}}},"/rfq/custom/shipping-methods":{"get":{"operationId":"get-rfq-quote_id-custom-shipping","summary":"List B2B Quote Custom Shipping Methods","description":"Retrieves all custom shipping methods that you’ve enabled in the Quotes settings of your B2B Edition control panel. See [Custom Shipping](#custom-shipping) for more information.","tags":["quotes"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quotes_get-rfq-quote_id-custom-shipping_Response_200"}}}},"422":{"description":"Parameter error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseError"}}}}}}},"/rfq/emails":{"post":{"operationId":"post-rfq-emails","summary":"Send Quote Email","description":"Sends an email to the buyer with information on a specific quote based on the provided `quoteId`.\n\nThe email address in the `email` field must correspond with the buyer’s email address on the quote. However, you can use the `ccTo` field to include additional recipients.\n\n### Quote Email Templates\n\nThe request uses the `emailTemplate` field to format the quote contents with one of the pre-built quote email templates. You must enter the exact name of the template in the field.\n\nThe following email templates can be used:\n\n* `Simple`\n* `Simple with Pictures`\n* `Waves with Pictures`\n* `Database with checkout button`\n* `Modern with checkout link`\n* `Modern without checkout link`\n\nThe selected template applies to the quote PDF if `withAttach` is specified as `true`.","tags":["quotes"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseWithMessage"}}}},"422":{"description":"Missing or Invalid Data\n\nThe 422 error occurs if the request fields have unsupported values. Make sure that the `email` field matches the email address of the quote’s assigned buyer, and confirm that you are using allowed values for `emailTemplate` and `emailLang`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-rfq-emailsRequestUnprocessableEntityError"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"quoteId":{"type":"string","description":"The internal numeric ID of the sales quote."},"email":{"type":"string","format":"email","description":"The recipient's email. This should match the buyer's email on the quote."},"withAttach":{"type":"boolean","default":true,"description":"Indicates whether or not a quote PDF will be included with the email."},"emailTemplate":{"$ref":"#/components/schemas/RfqEmailsPostRequestBodyContentApplicationJsonSchemaEmailTemplate","description":"The template used to format the quote email."},"ccTo":{"type":"array","items":{"type":"string","format":"email"},"description":"The list of emails to CC."},"emailLang":{"$ref":"#/components/schemas/RfqEmailsPostRequestBodyContentApplicationJsonSchemaEmailLang","description":"The two-letter code for the language of the quote email and PDF, if included."}},"required":["quoteId","email","withAttach","emailTemplate"]}}}}}},"/rfq/extra-fields":{"get":{"operationId":"get-rfq-extra-fields","summary":"List Quote Extra Fields Configs","description":"Returns a list of available extra fields configs for sales quotes.\n\nWe recommend caching the response results to avoid frequent API requests.","tags":["quotes"],"parameters":[{"name":"offset","in":"query","description":"The number of results to skip before returning the first result. If left blank, this defaults to `0`.","required":false,"schema":{"type":"integer","default":"0"}},{"name":"limit","in":"query","description":"Determines the number of records to return per page. If left blank, this defaults to `10`.","required":false,"schema":{"type":"integer","default":"10"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quotes_get-rfq-extra-fields_Response_200"}}}}}}},"/rfq/{quote_id}":{"get":{"operationId":"get-rfq-quote_id","summary":"Get Quote Details","description":"Retrieves the full details of a specific quote based on the provided `quote_id`.\n\nThis endpoint provides more detailed information about a specific quote than [Get All Quotes](#get-all-quotes). This includes line items, shipping address fields, and even a history of messages sent by the buyer and their sales representative.","tags":["quotes"],"parameters":[{"name":"quote_id","in":"path","description":"The internal numeric ID of the sales quote.","required":true,"schema":{"type":"integer"}},{"name":"date","in":"query","description":"The date that the quote was created. Use %m/%d/%Y format.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quotes_get-rfq-quote_id_Response_200"}}}}}},"put":{"operationId":"put-rfq-quote_id","summary":"Update Quote","description":"Updates an existing quote based on the details provided in the request body.\n\nBefore using this endpoint to update a quote, review the following considerations:\n\n* None of the fields in the body are required for a successful response. This means that you can use this endpoint to update a single field or a subset of fields.\n* When adding or updating line items, you must include all existing line items that you want to keep in the quote. Omitting existing line items from a quote will remove them from the quote when you send the request.\n* If you add products or change discounts, you must also update the `grandTotal` and `subtotal` fields to reflect the new totals.\n* You cannot use this endpoint to change the sales rep or Company account assigned to an existing quote.\n* To update a quote’s shipping rate, use the [Select a Shipping Rate for a Quote](#select-a-shipping-rate-for-quote) endpoint.\n\nSee [Create a Quote](#create-a-quote) for experience- and setting-specific requirements related to adding custom shipping or non-purchasable products to a quote.\n\n## Archiving a quote\n\nYou can use this endpoint to archive a quote by including `\"status\": \"archived\"` in the request body. Archiving hides the quote from the Buyer Portal and prevents it from being purchased.\n\n* A quote in any status can be archived.","tags":["quotes"],"parameters":[{"name":"quote_id","in":"path","description":"The internal numeric ID of the sales quote.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quotes_put-rfq-quote_id_Response_200"}}}},"404":{"description":"Not Found\n\nThe 404 error occurs when the `quote_id` in the URL does not match an existing quote in the store. This response is currently emitted only on the archive flow (`\"status\": \"archived\"`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"subtotal":{"type":"number","format":"double","description":"The quoted total after discounts and before shipping and tax. If you are updating the line items or discounts on a quote, you must also update the subtotal to reflect the new pricing."},"channelId":{"type":"integer","default":1,"description":"The storefront channel ID associated with the quote. This is required if your store has multiple storefront channels. Use `1` for your store’s default storefront channel."},"quoteTitle":{"type":"string","description":"The external title given to the quote."},"referenceNumber":{"type":"string","description":"An identifier for the quote that can be supplied by the sales rep or the buyer, such as a Purchase Order number."},"currency":{"$ref":"#/components/schemas/RfqQuoteIdPutRequestBodyContentApplicationJsonSchemaCurrency"},"extraFields":{"$ref":"#/components/schemas/extraFields"},"notes":{"type":"string","description":"The quote’s buyer-facing notes. Use the newline character `\n` to separate each line of text."},"discount":{"type":"number","format":"double","description":"The total value of discounts applied to the quote."},"grandTotal":{"type":"number","format":"double","description":"The quoted total after discounts, shipping, and tax are applied. If you are updating the line items or discounts on a quote, you must also update the grand total to reflect the new pricing."},"legalTerms":{"type":"string","description":"The quote’s terms and conditions. Use the newline character `\n` to separate each line of text. Omitting this field or leaving it blank does not add your store’s default terms and conditions to the quote. Instead, the quote will not display any terms."},"displayDiscount":{"type":"boolean","description":"Determines if buyers can see quoted discount values in the Buyer Portal, or if they only see the quoted prices. If left blank, the quote uses the discount display selection in your Quote settings."},"allowCheckout":{"type":"boolean","description":"Determines whether or not the buyer can take the quote to the checkout page. If left blank, the quote uses the checkout selection in your Quote settings."},"productList":{"$ref":"#/components/schemas/productList"},"shippingAddress":{"$ref":"#/components/schemas/companyAddress"},"contactInfo":{"$ref":"#/components/schemas/contactInfo"},"message":{"type":"string","description":"A message sent to the buyer via the in-quote messaging system."},"userEmail":{"type":"string","format":"email","description":"The email address of the quote’s sales rep. Any user email found within the B2B Edition System Users menu is considered a valid value for this field.\n\nThis field is optional. If left blank, it will default to the store owner's email address as shown in the B2B Edition System Users menu."},"expiredAt":{"type":"string","description":"The date when the buyer can no longer purchase the quote. Use '%m/%d/%Y' format when entering the expiration date."},"status":{"$ref":"#/components/schemas/RfqQuoteIdPutRequestBodyContentApplicationJsonSchemaStatus","description":"Set to `\"archived\"` to archive the quote."}}}}}}},"delete":{"operationId":"delete-rfq-quote_id","summary":"Delete Quote","description":"Permanently deletes a specific quote based on the provided `quote_id`.\n\nIf you want to hide a quote from a buyer without deleting it, you can archive it by sending `\"status\": \"archived\"` in the request body of the [Update a Quote](#update-quote) endpoint. You can also archive quotes from the **Quotes** area of your B2B Edition control panel. See [Managing Sales Quotes in B2B Edition (Help Center)](https://support.bigcommerce.com/s/article/B2B-Edition-Quotes) for more information.","tags":["quotes"],"parameters":[{"name":"quote_id","in":"path","description":"The internal numeric ID of the sales quote.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseWithMessage"}}}}}}},"/rfq/{quote_id}/checkout":{"post":{"operationId":"post-rfq-quote_id-checkout","summary":"Generate Cart and Checkout URL for Quote","description":"Generates a cart URL and a checkout URL for a specific quote based on the provided `quote_id`.\n\nYou can only generate cart and checkout URLs for quotes in one of the following [statuses](#quote-statuses):\n\n* New (0)\n* In Process (2)\n* Updated by Customer (3)\n\nThis endpoint will generate a checkout link for a quote even if it is configured to hide the checkout button on the Buyer Portal. You can use this to create an alternate checkout flow for your sales quotes.","tags":["quotes"],"parameters":[{"name":"quote_id","in":"path","description":"The internal numeric ID of the sales quote.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quotes_post-rfq-quote_id-checkout_Response_200"}}}},"422":{"description":"Missing or Invalid Data\n\nThe 422 error occurs if the quote_id in the request path corresponds to a quote in an unsupported status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}},"/rfq/{quote_id}/ordered":{"post":{"operationId":"post-rfq-quote_id-ordered","summary":"Assign Quote to BigCommerce Order","description":"Associates an existing BigCommerce order with a specific quote based on the provided `quote_id`. \n\nIn order to assign a quote to an order, it must be in one of the following statuses:\n\n* New (0)\n* In Process (2)\n* Updated by Customer (3)\n\nWhen specifying the order to be associated with the quote, use its **BigCommerce Order ID**, not the **B2B Edition Order ID**.\n\nThis endpoint **does not** convert an unpurchased quote into a new BigCommerce order. You can manually convert a quote while editing it in your B2B Edition control panel.","tags":["quotes"],"parameters":[{"name":"quote_id","in":"path","description":"The internal numeric ID of the sales quote.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseWithMessage"}}}},"422":{"description":"Missing or Invalid Data\n\nThe 422 error occurs if the BigCommerce Order ID is invalid, or if the quote is in an unsupported status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseError"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"$ref":"#/components/schemas/orderId"}},"required":["orderId"]}}}}}},"/rfq/{quote_id}/pdf-export":{"post":{"operationId":"get-rfq-quote_id-pdf-export","summary":"Export Quote PDF","description":"Creates a download link for a PDF with information on a specific quote based on the provided `quoteId`.\n\nThe PDF does not use one of the buyer-facing templates that can be selected for PDFs and emails. Instead, it uses a non-configurable template that also communicates backend information, like storefront channel and line item cost margins.\n\nYou can optionally update the currency information and also supply a custom exchange rate by using the `currency` array.","tags":["quotes"],"parameters":[{"name":"quote_id","in":"path","description":"The internal numeric ID of the sales quote.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quotes_get-rfq-quote_id-pdf-export_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/RfqQuoteIdPdfExportPostRequestBodyContentApplicationJsonSchemaCurrency"}}}}}}}},"/rfq/{quote_id}/shipping-rate":{"put":{"operationId":"rfq-quote_id-select-shipping-rate","summary":"Select Shipping Rate for Quote","description":"Adds a shipping method to a specific quote based on the provided `quoteId`.\n\nUse the [Get Available Shipping Rates for a Quote](#get-rfq-quote_id-shipping-rates) or [Get All B2B Quote Custom Shipping Methods](#get-rfq-quote_id-custom-shipping) endpoints to retrieve shipping method information that you can add to the quote.\n\nThe request body must include either the `shippingMethodId` field to add a static or real-time shipping method, *or* the `customShippingMethodName` **and** the `customShippingMethodCost` fields to add a custom shipping method.\n\n<Warning>This endpoint uses `/shipping-rate` (singular). Don't confuse it with the [Get Available Shipping Rates for a Quote](#get-rfq-quote_id-shipping-rates) endpoint, which uses `/shipping-rates` (plural). Using the wrong URL returns a **405 - Method Not Allowed** error.</Warning>","tags":["quotes"],"parameters":[{"name":"quote_id","in":"path","description":"The internal numeric ID of the sales quote.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quotes_rfq-quote_id-select-shipping-rate_Response_200"}}}},"422":{"description":"Missing or Invalid Data\n\nThe 422 error occurs if the fields have incorrect data, such as entering a `shippingMethodId` value which does not correspond to an available shipping method.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"shippingMethodId":{"type":"string","description":"Shipping method ID. Cannot be used with `customShippingMethodName` at the same time."},"customShippingMethodName":{"type":"string","description":"Custom shipping method name. Cannot be used with `shippingMethodId` at the same time."},"customShippingMethodCost":{"type":"number","format":"double","description":"Custom shipping method cost. Required when using custom shipping method."}}}}}}},"delete":{"operationId":"rfq-quote_id-delete-shipping-rate","summary":"Remove Selected Shipping Rate from Quote","description":"Removes the current shipping method associated with a specific quote based on the provided `quoteId`.\n\n<Warning>This endpoint uses `/shipping-rate` (singular). Don't confuse it with the [Get Available Shipping Rates for a Quote](#get-rfq-quote_id-shipping-rates) endpoint, which uses `/shipping-rates` (plural). Using the wrong URL returns a **405 - Method Not Allowed** error.</Warning>","tags":["quotes"],"parameters":[{"name":"quote_id","in":"path","description":"The internal numeric ID of the sales quote.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"422":{"description":"Missing or invalid data\n\nThe 422 error occurs if the queried quote does not currently have a shipping method, or if the quote has already been ordered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseError"}}}}}}},"/rfq/{quote_id}/shipping-rates":{"get":{"operationId":"get-rfq-quote_id-shipping-rates","summary":"Get Available Shipping Rates for Quote","description":"Retrieves all shipping rates available to a specific quote based on the provided `quoteId`.\n\nThis endpoint only returns the static and real-time shipping methods available to a quote based on its product specifications and shipping address. Use the [Get All B2B Quote Custom Shipping Methods](#get-rfq-quote_id-custom-shipping) endpoint to retrieve information on custom shipping methods.\n\n<Warning>This endpoint uses `/shipping-rates` (plural). Don't confuse it with the [Select Shipping Rate for Quote](#rfq-quote_id-select-shipping-rate) and [Remove Selected Shipping Rate from Quote](#rfq-quote_id-delete-shipping-rate) endpoints, which use `/shipping-rate` (singular). Using the wrong URL returns a **405 - Method Not Allowed** error.</Warning>","tags":["quotes"],"parameters":[{"name":"quote_id","in":"path","description":"The internal numeric ID of the sales quote.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quotes_get-rfq-quote_id-shipping-rates_Response_200"}}}},"404":{"description":"Not found error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/responseError"}}}}}}},"/sales-staffs":{"get":{"operationId":"get-sales-staffs","summary":"List Sales Staff","description":"Returns an array of all B2B Edition users who are assigned to a user role that is labelled as Sales Staff.","tags":["salesStaff"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of results to display per page.","required":false,"schema":{"type":"integer","default":10}},{"name":"offset","in":"query","description":"Number of results to skip before displaying the current page.","required":false,"schema":{"type":"integer","default":0}},{"name":"orderBy","in":"query","description":"Sort direction of results, ascending or descending, applied to the `sortBy` parameter.","required":false,"schema":{"$ref":"#/components/schemas/SalesStaffsGetParametersOrderBy","default":"DESC"}},{"name":"companyId","in":"query","description":"Unique numeric ID of the Company account.","required":false,"schema":{"type":"string"}},{"name":"minModified","in":"query","description":"The earliest [Unix timestamp](https://www.unixtimestamp.com/) that can be returned for a modified Company account.","required":false,"schema":{"type":"integer"}},{"name":"sortBy","in":"query","description":"Field by which data should be sorted in the response.","required":false,"schema":{"$ref":"#/components/schemas/SalesStaffsGetParametersSortBy","default":"updated_at"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sales Staff_get-sales-staffs_Response_200"}}}}}}},"/sales-staffs/{salesStaffId}":{"get":{"operationId":"get-sales-staffs-salesStaffId","summary":"Get Sales Staff Account Details","description":"Returns detailed information about the Sales Staff account associated with `salesStaffId`, including an array of Companies to which the account is assigned and when the assignment was made.","tags":["salesStaff"],"parameters":[{"name":"salesStaffId","in":"path","description":"Unique numeric ID of the Sales Staff account.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sales Staff_get-sales-staffs-salesStaffId_Response_200"}}}}}},"put":{"operationId":"put-sales-staffs-salesStaffId","summary":"Update Sales Staff Assignments","description":"Updates the Company assignments of the Sales Staff account associated with `salesStaffId`. This operation is non-destructive, meaning that assigning or unassigning a single Company from the Sales Staff does not affect the other assignments.","tags":["salesStaff"],"parameters":[{"name":"salesStaffId","in":"path","description":"Unique numeric ID of the Sales Staff account.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sales Staff_put-sales-staffs-salesStaffId_Response_200"}}}},"400":{"description":"Bad Request\n\nThis response will be returned only for malformed JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-sales-staffs-salesStaffIdRequestBadRequestError"}}}},"422":{"description":"Parameter Error\n\nThis error may be thrown for any of the following:\n- incorrect `salesStaffId`,\n- incorrect `companyId`,\n- invalid `assignStatus` type, or\n- invalid `companyId` type.\n\nUse `errMsg` to determine the specific cause.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-sales-staffs-salesStaffIdRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesStaffsSalesStaffIdPutRequestBodyContentApplicationJsonSchemaItems"}}}}}}},"/shopping-list":{"get":{"operationId":"get-shopping-list","summary":"List Shopping Lists","description":"Get a list of shopping lists viewable based on user permissions of a buyer user ID.\n\nA junior buyer can see all of the lists they create and no one else's.\n\nA senior buyer or admin can see all of the companies approved or ready for approval lists. This would include lists sent by junior buyers.","tags":["shoppingList"],"parameters":[{"name":"userId","in":"query","description":"B2B Edition buyer user ID (Either userId or customerId must be passed, but not both.)","required":true,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Pagination limit default: 10","required":false,"schema":{"type":"integer","default":10}},{"name":"offset","in":"query","description":"Pagination offset default: 0","required":false,"schema":{"type":"integer"}},{"name":"channelId","in":"query","description":"BigCommerce channel ID","required":false,"schema":{"type":"number","format":"double"}},{"name":"customerId","in":"query","description":"BigCommerce customer ID (Either userId or customerId must be passed, but not both.)","required":true,"schema":{"type":"integer"}},{"name":"createdUserId","in":"query","description":"B2B Edition buyer user ID, if the userId has permissions to view all shopping lists of the company, entering this parameter will filter out the shopping lists created by that user.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shopping List_get-shopping-list_Response_200"}}}},"422":{"description":"Parameter Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-shopping-listRequestUnprocessableEntityError"}}}}}},"post":{"operationId":"post-shopping-list","summary":"Create Shopping List","description":"Create a shopping list for a user","tags":["shoppingList"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shopping List_post-shopping-list_Response_200"}}}},"422":{"description":"Parameter Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-shopping-listRequestUnprocessableEntityError"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","description":"Description information for shopping list"},"status":{"$ref":"#/components/schemas/ShoppingListPostRequestBodyContentApplicationJsonSchemaStatus","description":"status of shopping list, (0: approved, 20: deleted, 30: draft, 40: ready for approval)"},"userId":{"type":"integer","description":"B2B Edition buyer user ID (one of userId and customerId must be passed, and only one of them can be passed)."},"customerId":{"type":"integer","description":"BigCommerce customer ID(one of userId and customerId must be passed, and only one of them can be passed)."},"channelId":{"type":"integer","description":"BigCommerce channel ID"},"items":{"type":"array","items":{"$ref":"#/components/schemas/shopping_list_item"}}},"required":["name"]}}}}}},"/shopping-list/{shoppingListId}":{"get":{"operationId":"get-shopping-list-shoppingListId","summary":"Get Shopping List","description":"Get a shopping list detail information","tags":["shoppingList"],"parameters":[{"name":"shoppingListId","in":"path","description":"The unique ID for a shopping list.","required":true,"schema":{"type":"integer"}},{"name":"userId","in":"query","description":"B2B Edition buyer user ID, you can enter a user ID to check if this user can view this shopping list.","required":false,"schema":{"type":"integer"}},{"name":"sortBy","in":"query","description":"the field to sort by","required":false,"schema":{"$ref":"#/components/schemas/ShoppingListShoppingListIdGetParametersSortBy"}},{"name":"orderBy","in":"query","description":"desc or asc for sort by","required":false,"schema":{"$ref":"#/components/schemas/ShoppingListShoppingListIdGetParametersOrderBy"}},{"name":"customerId","in":"query","description":"BigCommerce customer ID, passing this parameter will obtain the shopping list according to the b2c user.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Pagination offset for shopping list items","required":false,"schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"Pagination limit for shopping list items","required":false,"schema":{"type":"integer","default":250}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shopping List_get-shopping-list-shoppingListId_Response_200"}}}},"404":{"description":"Not Found Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-shopping-list-shoppingListIdRequestNotFoundError"}}}}}},"put":{"operationId":"put-shopping-list-shoppingListId","summary":"Update Shopping List","description":"update a shopping list detail. you can also update shopping list items by update the items field by this API endpoints. \nnote: \n1. User id for update the shopping list is not required. You can optionally enter this field according to whether you need to judge user permissions.\n2. The ID field in shopping list items is an optional field. If it is null, you can only change the quantity of this item by product ID, variant ID and option list, these three fields will determine an actual item. If it is not null, the ID field will determine an actual item and you can change product ID, variant ID, and option list by this way.\n3. Set a zero quantity of shopping list item will delete this item.\n4. Quantity = 0 will remove item, you can modify multiple items at one time.","tags":["shoppingList"],"parameters":[{"name":"shoppingListId","in":"path","description":"The unique ID for a shopping list.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shopping List_put-shopping-list-shoppingListId_Response_200"}}}},"404":{"description":"Not Found Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-shopping-list-shoppingListIdRequestNotFoundError"}}}},"422":{"description":"Parameter Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-shopping-list-shoppingListIdRequestUnprocessableEntityError"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"name for shopping list"},"description":{"type":"string","description":"description information for shopping list"},"status":{"$ref":"#/components/schemas/ShoppingListShoppingListIdPutRequestBodyContentApplicationJsonSchemaStatus","description":"status of shopping list, (0: approved, 20: deleted, 30: draft, 40: ready for approval)"},"userId":{"type":"integer","description":"B2B Edition buyer user ID, you can enter a user ID to check if this user can update this shopping list."},"customerId":{"type":"integer","description":"BigCommerce customer ID, passing this parameter will obtain the shopping list according to the b2c user."},"items":{"type":"array","items":{"$ref":"#/components/schemas/ShoppingListShoppingListIdPutRequestBodyContentApplicationJsonSchemaItemsItems"}}}}}}}},"delete":{"operationId":"delete-shopping-list-shoppingListId","summary":"Delete Shopping List","description":"Delete a shopping list. Note this will not delete a shopping list item.","tags":["shoppingList"],"parameters":[{"name":"shoppingListId","in":"path","description":"The unique ID for a shopping list.","required":true,"schema":{"type":"integer"}},{"name":"userId","in":"query","description":"B2B Edition buyer user ID, you can enter a user ID for check if this user can delete this shopping list.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shopping List_delete-shopping-list-shoppingListId_Response_200"}}}},"404":{"description":"Parameter Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete-shopping-list-shoppingListIdRequestNotFoundError"}}}}}}},"/shopping-list/{shoppingListId}/items/{itemId}":{"delete":{"operationId":"delete-shopping-list-shoppingListId-items-itemId","summary":"Delete Shopping List Item","description":"Delete a shopping list item","tags":["shoppingList"],"parameters":[{"name":"shoppingListId","in":"path","required":true,"schema":{"type":"string"}},{"name":"itemId","in":"path","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shopping List_delete-shopping-list-shoppingListId-items-itemId_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete-shopping-list-shoppingListId-items-itemIdRequestNotFoundError"}}}}}}},"/super-admins":{"post":{"operationId":"post-super-admins","summary":"Create Super Admin","description":"Creates a new Super Admin user and assigns the new account to BigCommerce channels as provided in the request body. An existing BigCommerce customer account will be converted to a B2B Edition Super Admin account.\n\n> **NOTE**  \n> If there is already a B2B Edition Company user account associated with the email address provided, this endpoint will return a 400 error, regardless of the role assigned to the B2B Edition Company user account. Existing BigCommerce customer accounts will not throw the error as long as they are not also B2B Edition Company user accounts.\n\nIf a user account for the provided `email` doesn't currently exist within BigCommerce, it will be created when the request is called. ","tags":["superAdmin"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Super Admin_post-super-admins_Response_200"}}}},"400":{"description":"BAD REQUEST.\n\nThis response indicates that the body of the request was invalid in some way. The most common cause is that a B2B Edition user account exists for the provided email address already. See `meta.message` for more information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-super-adminsRequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name listed on the Super Admin's BigCommerce customer account."},"lastName":{"type":"string","description":"The last name listed on the Super Admin's BigCommerce customer account."},"phone":{"type":"string","description":"The phone number listed on the Super Admin's BigCommerce customer account."},"uuid":{"type":"string","format":"uuid","description":"An external ID associated with the Super Admin account. B2B Edition does not require UUID to be unique, despite the field's label. B2B Edition will not assign a UUID by default.\n\n> NOTE  \n> Some endpoints will only return this field if it has a non-empty value. If your code relies on the presence of a UUID in responses, ensure it is defined for each user, and prefer endpoints that provide more details.\n> \n> Regardless of individual user status, make sure to check for existence before attempting to use the value of the `uuid` field."},"email":{"type":"string","format":"email","description":"The email address associated with the Super Admin's BigCommerce customer account."},"originChannelId":{"$ref":"#/components/schemas/superAdminOrigin"},"channelIds":{"$ref":"#/components/schemas/superAdminChannelIds"},"extraFields":{"$ref":"#/components/schemas/extraFieldsArray"}},"required":["firstName","lastName","email"]}}}}}},"/super-admins/bulk":{"post":{"operationId":"post-super-admins-bulk","summary":"Create Super Admins (batch)","description":"Creates new Super Admin users and assign them to BigCommerce channels as provided in the request body. Existing BigCommerce customer accounts will be converted to B2B Edition Super Admin accounts.\n\nIn normal conditions, this endpoint supports creation of no more than `10` Super Admins in a single request.\n\n> **NOTE**  \n> If there is already a B2B Edition Company user account associated with an email address provided, this endpoint will return with errors, regardless of the role assigned to the B2B Edition Company user account. Existing BigCommerce customer accounts will not throw errors as long as they are not also B2B Edition Company user accounts.\n\nIf a user account for a given `email` doesn't currently exist within BigCommerce, it will be created when the request is called. ","tags":["superAdmin"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Super Admin_post-super-admins-bulk_Response_200"}}}},"400":{"description":"BAD REQUEST","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-super-admins-bulkRequestBadRequestError"}}}},"413":{"description":"REQUEST TOO LARGE","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-super-admins-bulkRequestContentTooLargeError"}}}},"422":{"description":"INVALID REQUEST\n\nThis response is returned when required fields are missing from the request body. See the response data for specific details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post-super-admins-bulkRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SuperAdminsBulkPostRequestBodyContentApplicationJsonSchemaItems"}}}}}}},"/super-admins/companies":{"get":{"operationId":"get-super-admins-companies","summary":"List Companies with Assigned Super Admins","description":"Returns a list of Companies with basic Company data and a count of Super Admins associated with them. The `companyId` returned with Company data may be used with B2B Edition Companies API endpoints (see [Company Management](/developer/api-reference/rest/b2b/management/company/companies) or [Companies and Users](/developer/api-reference/rest/b2b/storefront/company/companies) for more information).","tags":["superAdmin"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of entries to return per page of results.","required":false,"schema":{"type":"integer","default":10}},{"name":"offset","in":"query","description":"The number of entries to skip before returning the current page of results.","required":false,"schema":{"type":"integer","default":0}},{"name":"orderBy","in":"query","description":"Determines whether results will be sorted in acending (`ASC`) or descending (`DESC`) order.","required":false,"schema":{"$ref":"#/components/schemas/SuperAdminsCompaniesGetParametersOrderBy","default":"DESC"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Super Admin_get-super-admins-companies_Response_200"}}}}}}},"/super-admins/{superAdminId}":{"put":{"operationId":"put-super-admins-superAdminId","summary":"Update Super Admin Company Assignments","description":"Assigns or unassigns Companies for the Super Admin associated with `superAdminId`. This operation is non-destructive, meaning that only Companies represented in the request body will be affected by the request.","tags":["superAdmin"],"parameters":[{"name":"superAdminId","in":"path","description":"The unique ID of the Super Admin account. Does **not** match the BigCommerce customer account ID.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Super Admin_put-super-admins-superAdminId_Response_200"}}}},"404":{"description":"NOT FOUND","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-super-admins-superAdminIdRequestNotFoundError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companies":{"type":"array","items":{"$ref":"#/components/schemas/SuperAdminsSuperAdminIdPutRequestBodyContentApplicationJsonSchemaCompaniesItems"}}},"required":["companies"]}}}}}},"/super-admins/{superAdminId}/companies":{"get":{"operationId":"get-super-admins-superAdminId-companies","summary":"Get Super Admin's Assigned Companies","description":"Lists all Companies assigned to the Super Admin account associated with `superAdminId`. The response will contain limited information about each Company, but more information is available through the B2B Edition Companies API endpoints (see [Company Management](/developer/api-reference/rest/b2b/management/company/companies) or [Companies and Users](/developer/api-reference/rest/b2b/storefront/company/companies) for more information).","tags":["superAdmin"],"parameters":[{"name":"superAdminId","in":"path","description":"The unique ID of the Super Admin account. Does **not** match the BigCommerce customer account ID.","required":true,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Maximum number of entries to return per page of results.","required":false,"schema":{"type":"integer","default":10}},{"name":"offset","in":"query","description":"The number of entries to skip before returning the current page of results.","required":false,"schema":{"type":"integer","default":0}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Super Admin_get-super-admins-superAdminId-companies_Response_200"}}}},"404":{"description":"NOT FOUND","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-super-admins-superAdminId-companiesRequestNotFoundError"}}}}}}},"/super-admins/info/{superAdminId}":{"get":{"operationId":"get-super-admins-info-superAdminId","summary":"Get Super Admin Details","description":"Returns detailed information about the Super Admin account associated with `superAdminId`.","tags":["superAdmin"],"parameters":[{"name":"superAdminId","in":"path","description":"The unique ID of the Super Admin account. Does **not** match the BigCommerce customer account ID.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Super Admin_get-super-admins-info-superAdminId_Response_200"}}}},"404":{"description":"NOT FOUND","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-super-admins-info-superAdminIdRequestNotFoundError"}}}}}},"put":{"operationId":"put-super-admins-info-superAdminId","summary":"Update Super Admin Details","description":"Updates the account information of the Super Admin associated with `superAdminId`.\n\n> **NOTE**  \n> A BigCommerce customer account and a B2B Edition user account are both uniquely identified by their email address. As such, the `email` field is considered read-only. Updating the email address should be avoided, but may be done with the [Update Customers](/developer/api-reference/rest/admin/management/customers/v3/update-customers) endpoint.","tags":["superAdmin"],"parameters":[{"name":"superAdminId","in":"path","description":"The unique ID of the Super Admin account. Does **not** match the BigCommerce customer account ID.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Super Admin_put-super-admins-info-superAdminId_Response_200"}}}},"404":{"description":"NOT FOUND","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-super-admins-info-superAdminIdRequestNotFoundError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name listed on the Super Admin's BigCommerce customer account."},"lastName":{"type":"string","description":"The last name listed on the Super Admin's BigCommerce customer account."},"phone":{"type":"string","description":"The phone number listed on the Super Admin's BigCommerce customer account."},"uuid":{"type":"string","format":"uuid","description":"An external ID associated with the Super Admin account. B2B Edition does not require UUID to be unique, despite the field's label. B2B Edition will not assign a UUID by default.\n\n> NOTE  \n> Some endpoints will only return this field if it has a non-empty value. If your code relies on the presence of a UUID in responses, ensure it is defined for each user, and prefer endpoints that provide more details.\n> \n> Regardless of individual user status, make sure to check for existence before attempting to use the value of the `uuid` field."},"channelIds":{"$ref":"#/components/schemas/superAdminChannelIds"},"extraFields":{"$ref":"#/components/schemas/extraFieldsArray"}}}}}}}},"/companies/super-admins":{"get":{"operationId":"get-companies-super-admins","summary":"List Super Admins with Assigned Companies","description":"Returns a list of Super Admins with basic account data and a count of Companies associated with them. The `id` returned with Super Admin data may be used with other Super Admin API endpoints as the `superAdminId`.","tags":["superAdmin"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of entries to return per page of results.","required":false,"schema":{"type":"integer","default":10}},{"name":"offset","in":"query","description":"The number of entries to skip before returning the current page of results.","required":false,"schema":{"type":"integer","default":0}},{"name":"orderBy","in":"query","description":"Determines whether results will be sorted in acending (`ASC`) or descending (`DESC`) order.","required":false,"schema":{"$ref":"#/components/schemas/CompaniesSuperAdminsGetParametersOrderBy","default":"DESC"}},{"name":"q","in":"query","description":"Search string for the request. Response data will be limited to accounts matching this string in `firstName`, `lastName`, or `email`.","required":false,"schema":{"type":"string"}},{"name":"uuid","in":"query","description":"Filter results by `uuid`. An empty `uuid` parameter will return all results.","required":false,"schema":{"type":"string"}},{"name":"maxCreated","in":"query","description":"Filter results by `createdAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value less than `maxCreated`.","required":false,"schema":{"type":"string"}},{"name":"minCreated","in":"query","description":"Filter results by `createdAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value greater than `minCreated`.","required":false,"schema":{"type":"string"}},{"name":"maxModified","in":"query","description":"Filter results by `updatedAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value less than `maxModified`.","required":false,"schema":{"type":"string"}},{"name":"minModified","in":"query","description":"Filter results by `updatedAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value greater than `minModified`.","required":false,"schema":{"type":"string"}},{"name":"isIncludeExtraFields","in":"query","description":"Indicates whether to include extra fields in the response. A value of `0` will exclude extra fields, while a value of `1` will include them.","required":false,"schema":{"$ref":"#/components/schemas/CompaniesSuperAdminsGetParametersIsIncludeExtraFields","default":"0"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Super Admin_get-companies-super-admins_Response_200"}}}}}}},"/companies/{companyId}/super-admins":{"get":{"operationId":"get-companies","summary":"List Super Admins Assigned to Company","description":"Lists all Super Admins assigned to the Company associated with `companyId`. This endpoint includes extended Super Admin account data for each Super Admin. The `id` returned in the response may be used with other Super Admin API endpoints as the `superAdminId`.","tags":["superAdmin"],"parameters":[{"name":"companyId","in":"path","description":"The unique ID of a Company. Can be used with the B2B Edition Companies API endpoints (see [Company Management](/developer/api-reference/rest/b2b/management/company/companies) or [Companies and Users](/developer/api-reference/rest/b2b/storefront/company/companies) for more information).","required":true,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Maximum number of entries to return per page of results.","required":false,"schema":{"type":"integer","default":10}},{"name":"offset","in":"query","description":"The number of entries to skip before returning the current page of results.","required":false,"schema":{"type":"integer","default":0}},{"name":"q","in":"query","description":"Search string for the request. Response data will be limited to accounts matching this string in `firstName`, `lastName`, or `email`.","required":false,"schema":{"type":"string"}},{"name":"isIncludeExtraFields","in":"query","description":"Indicates whether to include extra fields in the response. A value of `0` will exclude extra fields, while a value of `1` will include them.","required":false,"schema":{"$ref":"#/components/schemas/CompaniesCompanyIdSuperAdminsGetParametersIsIncludeExtraFields","default":"0"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Super Admin_get-companies_Response_200"}}}},"404":{"description":"NOT FOUND","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get-companiesRequestNotFoundError"}}}}}},"put":{"operationId":"put-companies-companyId-super-admins","summary":"Update Company Super Admins Assignments","description":"Assigns or unassigns Super Admins for the Company associated with `companyId`. This operation is non-destructive, meaning that only Super Admins represented in the request body will be affected by the request.","tags":["superAdmin"],"parameters":[{"name":"companyId","in":"path","description":"The unique ID of a Company. Can be used with the B2B Edition Companies API endpoints (see [Company Management](/developer/api-reference/rest/b2b/management/company/companies) or [Companies and Users](/developer/api-reference/rest/b2b/storefront/company/companies) for more information).","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Super Admin_put-companies-companyId-super-admins_Response_200"}}}},"404":{"description":"NOT FOUND","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Put-companies-companyId-super-adminsRequestNotFoundError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"superAdmins":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesCompanyIdSuperAdminsPutRequestBodyContentApplicationJsonSchemaSuperAdminsItems"}}},"required":["superAdmins"]}}}}}},"/users":{"get":{"operationId":"companies_users_list","summary":"List B2B Users","description":"Returns a paginated list of B2B users with optional filters.","tags":["users"],"parameters":[{"name":"offset","in":"query","description":"The number of items to skip before starting to collect the result set.","required":false,"schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of results to return.","required":false,"schema":{"type":"integer","default":10}},{"name":"companyId","in":"query","description":"If included, filters users in the response based on their Company ID as reported by the [Server to Server Companies](/developer/api-reference/rest/b2b/management/company/companies) endpoints.","required":false,"schema":{"type":"integer"}},{"name":"roles","in":"query","description":"Filters users according to their assigned role ID. This filter is limited to admin (`0`), senior buyer (`1`), and junior buyer (`2`).\n\nBy default, custom roles are treated as junior buyer, but they can be differentiated in the response data by the `companyRoleId` and `companyRoleName` fields. For more information, see [Company Roles and Permissions](/developer/api-reference/rest/b2b/management/company/company-roles-and-permissions).","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/UsersGetParametersRolesSchemaItems"}}},{"name":"minModified","in":"query","description":"Filters results by the `updatedAt` field, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) later than `minModified`.","required":false,"schema":{"type":"string"}},{"name":"maxModified","in":"query","description":"Filters results by the `updatedAt` field, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) earlier than `maxModified`.","required":false,"schema":{"type":"string"}},{"name":"minCreated","in":"query","description":"Filters results by the `createdAt` field, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) later than `minCreated`.","required":false,"schema":{"type":"string"}},{"name":"maxCreated","in":"query","description":"Filters results by the `createdAt` field, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) earlier than `maxCreated`.","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Filters users by email address. This field requires an exact match.","required":false,"schema":{"type":"string","format":"email"}},{"name":"channelId","in":"query","description":"Filters users by their assigned BigCommerce channel ID.","required":false,"schema":{"type":"integer"}},{"name":"isIncludeExtraFields","in":"query","description":"Indicates whether to include extra fields in the response. A value of `1` indicates they will be included, while a value of `0` indicates they will not.","required":false,"schema":{"$ref":"#/components/schemas/UsersGetParametersIsIncludeExtraFields"}},{"name":"q","in":"query","description":"Search term for filtering on supported fields. Currently, this is email address.","required":false,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_companies_users_list_Response_200"}}}},"422":{"description":"Validation Error\n\nThis error indicates some part of the request is invalid. See the `errMsg` field for more information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_users_listRequestUnprocessableEntityError"}}}}}},"post":{"operationId":"companies_users_create","summary":"Create Company User","description":"Create a Company user within an existing Company.\n\nWith [Independent Company behavior](/developer/api-reference/rest/b2b/management/company/companies#independent-vs-dependent-companies-behavior) enabled, B2B Edition Company accounts are the source of truth for defining a Company user’s customer group assignment.\n\nOn stores without Independent Company behavior, each Company account has a one-to-one relationship with its customer group.\n\nIf no default customer group is configured, or the set value of `customerGroupId` is 0, the B2B Company will not be associated with any customer group. The Company users will have their corresponding customer records assigned to No Group in BigCommerce.","tags":["users"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_companies_users_create_Response_200"}}}},"422":{"description":"Validation Error\n\nThis error returns when one or more fields are invalid or if the email address provided already exists as a B2B Edition user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_users_createRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/userPost"}}}}}},"/users/bulk":{"post":{"operationId":"companies_users_bulk_create_create","summary":"Bulk Create Users","description":"Create up to 10 Company users at once.\n\nWith (Independent Company behavior)[/developer/api-reference/rest/b2b/management/company/companies#independent-vs-dependent-companies-behavior] enabled, B2B Edition Company accounts are the source of truth for defining a Company user’s customer group assignment. If no default customer group is configured or the set value of `customerGroupId` is 0, the B2B Company will not be associated with any customer group. The Company users will have their corresponding customer records assigned to No Group in BigCommerce.","tags":["users"],"parameters":[{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_companies_users_bulk_create_create_Response_200"}}}},"413":{"description":"REQUEST TOO LARGE\n\nThis error is thrown when more than ten records are included in the body of the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_users_bulk_create_createRequestContentTooLargeError"}}}},"422":{"description":"Validation Error\n\nThis error returns when one or more fields are invalid or if the email address provided already exists as a B2B Edition user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_users_bulk_create_createRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/userPost"}}}}}}},"/users/{userId}":{"get":{"operationId":"companies_user_by_id","summary":"Get User Details","description":"Returns detailed user information for the user specified by `userId`. Unlike [Get All Users](#get-all-users), this endpoint includes extra fields by default.","tags":["users"],"parameters":[{"name":"userId","in":"path","description":"The unique identifier of the user as reported by [Get All Users](#get-all-users).","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_companies_user_by_id_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_user_by_idRequestNotFoundError"}}}}}},"put":{"operationId":"companies_user_update","summary":"Update User Details","description":"Updates the B2B Edition user account associated with `userId`. All fields may be updated except `companyId` and `originChannelId`, which are read-only for a user account.","tags":["users"],"parameters":[{"name":"userId","in":"path","description":"The unique identifier of the user as reported by [Get All Users](#get-all-users).","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_companies_user_update_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_user_updateRequestNotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_user_updateRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","description":"User's first name."},"lastName":{"type":"string","description":"User's last name."},"email":{"type":"string","format":"email","description":"User's email address. This must be unique within B2B Edition."},"phoneNumber":{"type":"string","description":"User's phone number."},"role":{"$ref":"#/components/schemas/UsersUserIdPutRequestBodyContentApplicationJsonSchemaRole","description":"Numeric code representing the user's role as admin (`0`), senior buyer (`1`), or junior buyer (`2`)."},"companyRoleId":{"type":"integer","description":"Numeric code representing the user's Company-specific role. When present this field overrides the value of the `role` field."},"uuid":{"type":"string","description":"External identifier for the user. This field may be used to represent any external user ID. Using the name `uuid`, B2B Edition does not require the field to be unique."},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/extraField"}},"channelIds":{"$ref":"#/components/schemas/channelIds"}}}}}}},"delete":{"operationId":"companies_user_delete","summary":"Delete User","description":"Deletes a B2B Edition user account. This endpoint does not delete the BigCommerce customer account. Attempting to delete the last user in a Company will fail, but deleting all admin users will not.\n\n> NOTE:  \n> Deleting the only admin user in a Company may result in the Company being unable to do business on your storefront. When using this endpoint, care must be taken to avoid deleting the last admin user.","tags":["users"],"parameters":[{"name":"userId","in":"path","description":"The unique identifier of the user as reported by [Get All Users](#get-all-users).","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_companies_user_delete_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_user_deleteRequestNotFoundError"}}}},"422":{"description":"Last User Error\n\nThis error returns when the user indicated by `userId` is the only user in its Company and cannot be deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_user_deleteRequestUnprocessableEntityError"}}}}}}},"/users/customer/{customerId}":{"get":{"operationId":"companies_user_read","summary":"Get User Details by BigCommerce Customer ID","description":"Returns detailed information for the user associated with `customerId`. Analogous to [Get User Details](#get-user-details). If the B2B Edition customer account associated with `customerId` has been deleted, this will return a `404` error.","tags":["users"],"parameters":[{"name":"customerId","in":"path","description":"The unique numeric ID associated with the BigCommerce customer account. This does not match the `userId` assigned by B2B Edition.","required":true,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_companies_user_read_Response_200"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Companies_user_readRequestNotFoundError"}}}}}}},"/users/extra-fields":{"get":{"operationId":"get_users_extra_fields","summary":"List Extra Fields for Users","description":"Returns paginated list of extra field definitions for users.","tags":["users"],"parameters":[{"name":"offset","in":"query","description":"The number of items to skip before starting to collect the result set.","required":false,"schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"The maximum number of results to return.","required":false,"schema":{"type":"integer","default":10}},{"name":"X-Auth-Token","in":"header","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_get_users_extra_fields_Response_200"}}}}}}}},"servers":[{"url":"https://api-b2b.bigcommerce.com/api/v3/io","description":"https://api-b2b.bigcommerce.com/api/v3/io"},{"url":"https://api-b2b.bigcommerce.com/api/io","description":"https://api-b2b.bigcommerce.com/api/v3/io"},{"url":"https://api-b2b.bigcommerce.com/api/v3/io/ip","description":"https://api-b2b.bigcommerce.com/api/v3/io"}],"components":{"schemas":{"CountriesGetParametersSearchType":{"type":"string","enum":["0","1"],"title":"CountriesGetParametersSearchType"},"CountriesGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"CountriesGetResponsesContentApplicationJsonSchemaData"},"CountriesGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"CountriesGetResponsesContentApplicationJsonSchemaMeta"},"Addresses_get-addresses-countries-countryName-code_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double","default":200},"data":{"$ref":"#/components/schemas/CountriesGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CountriesGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Addresses_get-addresses-countries-countryName-code_Response_200"},"Get-addresses-countries-countryName-codeRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/CountriesGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CountriesGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Get-addresses-countries-countryName-codeRequestNotFoundError"},"StatesGetParametersSearchType":{"type":"string","enum":["0","1"],"title":"StatesGetParametersSearchType"},"StatesGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"StatesGetResponsesContentApplicationJsonSchemaData"},"StatesGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"StatesGetResponsesContentApplicationJsonSchemaMeta"},"Addresses_get-addresses-states-stateName-code_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double","default":200},"data":{"$ref":"#/components/schemas/StatesGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/StatesGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Addresses_get-addresses-states-stateName-code_Response_200"},"Get-addresses-states-stateName-codeRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/StatesGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/StatesGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Get-addresses-states-stateName-codeRequestNotFoundError"},"AddressesGetParametersIsIncludeExtraFields":{"type":"string","enum":["0","1"],"title":"AddressesGetParametersIsIncludeExtraFields"},"ResponseSuccessData":{"type":"object","properties":{},"title":"ResponseSuccessData"},"MetaFullPagination":{"type":"object","properties":{"totalCount":{"type":"integer","description":"The total number of records available."},"limit":{"type":"integer","description":"The number of records returned per page."},"offset":{"type":"integer","description":"The number of records skipped before returning the first record."}},"title":"MetaFullPagination"},"meta_full":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/MetaFullPagination"},"message":{"type":"string","default":"SUCCESS"}},"title":"meta_full"},"ExtraFieldsBasicFieldType":{"type":"string","enum":["0","1","2","3"],"description":"The type of data that can be added as the extra field's value. This field uses numeric values to represent the data type, as follows:\n\n- 0 - Text\n- 1 - Multi-line text\n- 2 - Number\n- 3 - dropdown","title":"ExtraFieldsBasicFieldType"},"extraFields_BASIC":{"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the address extra field."},"fieldValue":{"type":"string","description":"The value assigned to the address extra field."},"fieldType":{"$ref":"#/components/schemas/ExtraFieldsBasicFieldType","description":"The type of data that can be added as the extra field's value. This field uses numeric values to represent the data type, as follows:\n\n- 0 - Text\n- 1 - Multi-line text\n- 2 - Number\n- 3 - dropdown"}},"title":"extraFields_BASIC"},"addressFields_GET":{"type":"object","properties":{"addressId":{"type":"integer","description":"The unique numeric identifier of the Company address."},"firstName":{"type":"string","description":"The first name on the address."},"lastName":{"type":"string","description":"The last name on the address."},"phoneNumber":{"type":"string","description":"The phone number on the address."},"zipCode":{"type":"string","description":"The postal code on the address."},"addressLine1":{"type":"string","description":"The first line of the address."},"addressLine2":{"type":"string","description":"The second line of the address."},"city":{"type":"string","description":"The city on the address."},"stateName":{"type":"string","description":"The full name of the state or province on the address."},"countryName":{"type":"string","description":"The full name of the country on the address."},"stateCode":{"type":"string","description":"The two-letter ISO code for the state or province on the address."},"countryCode":{"type":"string","description":"The two-letter ISO code for the country on the address."},"companyId":{"type":"integer","description":"The unique numeric ID of the Company account."},"isBilling":{"type":"boolean","description":"Indicates whether the address is a billing address."},"isShipping":{"type":"boolean","description":"Indicates whether the address is a shipping address."},"isDefaultBilling":{"type":"boolean","description":"Indicates whether the address is the default billing address."},"isDefaultShipping":{"type":"boolean","description":"Indicates whether the address is the default shipping address."},"label":{"type":"string","description":"The label used on the storefront to identify the address."},"externalId":{"type":"string","description":"An external ID assigned to the address in a third-party system, such as an ERP."},"createdAt":{"type":"integer","description":"The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the address was created."},"updatedAt":{"type":"integer","description":"The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the address was last updated."},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/extraFields_BASIC"},"description":"Contains extra field information for the address."}},"title":"addressFields_GET"},"Addresses_get-companies_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/addressFields_GET"},"meta":{"$ref":"#/components/schemas/meta_full"}},"required":["data"],"title":"Addresses_get-companies_Response_200"},"addressFields_GET/properties/firstName":{"type":"string","description":"The first name on the address.","title":"addressFields_GET/properties/firstName"},"addressFields_GET/properties/lastName":{"type":"string","description":"The last name on the address.","title":"addressFields_GET/properties/lastName"},"addressFields_GET/properties/phoneNumber":{"type":"string","description":"The phone number on the address.","title":"addressFields_GET/properties/phoneNumber"},"addressFields_GET/properties/zipCode":{"type":"string","description":"The postal code on the address.","title":"addressFields_GET/properties/zipCode"},"addressFields_GET/properties/addressLine1":{"type":"string","description":"The first line of the address.","title":"addressFields_GET/properties/addressLine1"},"addressFields_GET/properties/addressLine2":{"type":"string","description":"The second line of the address.","title":"addressFields_GET/properties/addressLine2"},"addressFields_GET/properties/city":{"type":"string","description":"The city on the address.","title":"addressFields_GET/properties/city"},"addressFields_GET/properties/companyId":{"type":"integer","description":"The unique numeric ID of the Company account.","title":"addressFields_GET/properties/companyId"},"addressFields_GET/properties/isBilling":{"type":"boolean","description":"Indicates whether the address is a billing address.","title":"addressFields_GET/properties/isBilling"},"addressFields_GET/properties/isShipping":{"type":"boolean","description":"Indicates whether the address is a shipping address.","title":"addressFields_GET/properties/isShipping"},"addressFields_GET/properties/isDefaultBilling":{"type":"boolean","description":"Indicates whether the address is the default billing address.","title":"addressFields_GET/properties/isDefaultBilling"},"addressFields_GET/properties/isDefaultShipping":{"type":"boolean","description":"Indicates whether the address is the default shipping address.","title":"addressFields_GET/properties/isDefaultShipping"},"addressFields_GET/properties/label":{"type":"string","description":"The label used on the storefront to identify the address.","title":"addressFields_GET/properties/label"},"addressFields_GET/properties/externalId":{"type":"string","description":"An external ID assigned to the address in a third-party system, such as an ERP.","title":"addressFields_GET/properties/externalId"},"extraFields_BASIC/properties/fieldName":{"type":"string","description":"The name of the address extra field.","title":"extraFields_BASIC/properties/fieldName"},"extraFields_BASIC/properties/fieldValue":{"type":"string","description":"The value assigned to the address extra field.","title":"extraFields_BASIC/properties/fieldValue"},"AddressesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems":{"type":"object","properties":{"fieldName":{"$ref":"#/components/schemas/extraFields_BASIC/properties/fieldName"},"fieldValue":{"$ref":"#/components/schemas/extraFields_BASIC/properties/fieldValue"}},"title":"AddressesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems"},"ResponsePostputData":{"type":"object","properties":{"addressId":{"$ref":"#/components/schemas/addressFields_GET/properties/companyId"}},"required":["addressId"],"title":"ResponsePostputData"},"meta_full/properties/message":{"type":"string","default":"SUCCESS","title":"meta_full/properties/message"},"ResponsePostputMeta":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/meta_full/properties/message"}},"required":["message"],"title":"ResponsePostputMeta"},"response_POSTPUT":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"$ref":"#/components/schemas/ResponsePostputData"},"meta":{"$ref":"#/components/schemas/ResponsePostputMeta"}},"required":["code","data","meta"],"title":"response_POSTPUT"},"AddressesPostResponsesContentApplicationJsonSchemaDataErrMsg":{"type":"object","properties":{},"description":"Lists the required fields that were missing from the request.","title":"AddressesPostResponsesContentApplicationJsonSchemaDataErrMsg"},"AddressesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"$ref":"#/components/schemas/AddressesPostResponsesContentApplicationJsonSchemaDataErrMsg","description":"Lists the required fields that were missing from the request."}},"title":"AddressesPostResponsesContentApplicationJsonSchemaData"},"AddressesPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"AddressesPostResponsesContentApplicationJsonSchemaMeta"},"Post-companies-companyId-addressesRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/AddressesPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/AddressesPostResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Post-companies-companyId-addressesRequestUnprocessableEntityError"},"AddressesAddressIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/meta_full/properties/message"}},"required":["message"],"title":"AddressesAddressIdGetResponsesContentApplicationJsonSchemaMeta"},"Addresses_get-companies-companyId-addresses-addressId_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"$ref":"#/components/schemas/addressFields_GET"},"meta":{"$ref":"#/components/schemas/AddressesAddressIdGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Addresses_get-companies-companyId-addresses-addressId_Response_200"},"ResponseNotFoundData":{"type":"object","properties":{"errMsg":{"type":"string","default":"Address matching query does not exist."}},"required":["errMsg"],"title":"ResponseNotFoundData"},"ResponseNotFoundMeta":{"type":"object","properties":{"message":{"type":"string","default":"Not Found Error"}},"required":["message"],"title":"ResponseNotFoundMeta"},"responseNotFound":{"type":"object","properties":{"code":{"type":"number","format":"double","default":404},"data":{"$ref":"#/components/schemas/ResponseNotFoundData"},"meta":{"$ref":"#/components/schemas/ResponseNotFoundMeta"}},"required":["code","data","meta"],"title":"responseNotFound"},"AddressRequestExtraFieldsItems":{"type":"object","properties":{"fieldName":{"$ref":"#/components/schemas/extraFields_BASIC/properties/fieldName"},"fieldValue":{"$ref":"#/components/schemas/extraFields_BASIC/properties/fieldValue"}},"title":"AddressRequestExtraFieldsItems"},"address_REQUEST":{"type":"object","properties":{"firstName":{"$ref":"#/components/schemas/addressFields_GET/properties/firstName"},"lastName":{"$ref":"#/components/schemas/addressFields_GET/properties/lastName"},"phoneNumber":{"$ref":"#/components/schemas/addressFields_GET/properties/phoneNumber"},"zipCode":{"$ref":"#/components/schemas/addressFields_GET/properties/zipCode"},"addressLine1":{"$ref":"#/components/schemas/addressFields_GET/properties/addressLine1"},"addressLine2":{"$ref":"#/components/schemas/addressFields_GET/properties/addressLine2"},"city":{"$ref":"#/components/schemas/addressFields_GET/properties/city"},"stateName":{"type":"string","description":"The full name of the state or province on the address. This must correspond to `stateCode` in the request if the state or province is [required for the country](#get-a-state)."},"countryName":{"type":"string","description":"The full name of the country on the address. Use [Get a Country](#get-a-country) to retrieve valid country names."},"stateCode":{"type":"string","description":"The two-letter ISO code for the state or province on the address. Omit this field when adding state or province information for an [unsupported country](#get-a-state)."},"countryCode":{"type":"string","description":"The two-letter ISO code for the country on the address. Use [Get a Country](#get-a-country) to retrieve valid country codes."},"companyId":{"$ref":"#/components/schemas/addressFields_GET/properties/companyId"},"isBilling":{"$ref":"#/components/schemas/addressFields_GET/properties/isBilling"},"isShipping":{"$ref":"#/components/schemas/addressFields_GET/properties/isShipping"},"isDefaultBilling":{"$ref":"#/components/schemas/addressFields_GET/properties/isDefaultBilling"},"isDefaultShipping":{"$ref":"#/components/schemas/addressFields_GET/properties/isDefaultShipping"},"label":{"$ref":"#/components/schemas/addressFields_GET/properties/label"},"externalId":{"$ref":"#/components/schemas/addressFields_GET/properties/externalId"},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/AddressRequestExtraFieldsItems"},"description":"Enter extra field information for the address."}},"title":"address_REQUEST"},"AddressesAddressIdPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string","description":"Lists the required fields that were missing from the request."}},"required":["errMsg"],"title":"AddressesAddressIdPutResponsesContentApplicationJsonSchemaData"},"AddressesAddressIdPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Processing data contains logical errors"}},"required":["message"],"title":"AddressesAddressIdPutResponsesContentApplicationJsonSchemaMeta"},"Put-companies-companyId-addresses-addressIdRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/AddressesAddressIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/AddressesAddressIdPutResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Put-companies-companyId-addresses-addressIdRequestUnprocessableEntityError"},"AddressesBulkPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems":{"type":"object","properties":{"fieldName":{"$ref":"#/components/schemas/extraFields_BASIC/properties/fieldName"},"fieldValue":{"$ref":"#/components/schemas/extraFields_BASIC/properties/fieldValue"}},"title":"AddressesBulkPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems"},"Addresses_post-addresses_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/addressFields_GET"},"meta":{"$ref":"#/components/schemas/meta_full"}},"required":["data"],"title":"Addresses_post-addresses_Response_200"},"AddressesBulkPostResponsesContentApplicationJsonSchemaDataErrMsg":{"type":"object","properties":{},"description":"Lists the required fields that were missing from the request.","title":"AddressesBulkPostResponsesContentApplicationJsonSchemaDataErrMsg"},"AddressesBulkPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"$ref":"#/components/schemas/AddressesBulkPostResponsesContentApplicationJsonSchemaDataErrMsg","description":"Lists the required fields that were missing from the request."}},"title":"AddressesBulkPostResponsesContentApplicationJsonSchemaData"},"AddressesBulkPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"AddressesBulkPostResponsesContentApplicationJsonSchemaMeta"},"Post-addressesRequestContentTooLargeError":{"type":"object","properties":{"code":{"type":"number","format":"double","default":413},"data":{"$ref":"#/components/schemas/AddressesBulkPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/AddressesBulkPostResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Post-addressesRequestContentTooLargeError"},"Post-addressesRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/AddressesBulkPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/AddressesBulkPostResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Post-addressesRequestUnprocessableEntityError"},"extraFields_BASIC/properties/fieldType":{"type":"string","enum":["0","1","2","3"],"description":"The type of data that can be added as the extra field's value. This field uses numeric values to represent the data type, as follows:\n\n- 0 - Text\n- 1 - Multi-line text\n- 2 - Number\n- 3 - dropdown","title":"extraFields_BASIC/properties/fieldType"},"AddressesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsConfigType":{"type":"string","enum":["1","2"],"description":"Indicates whether an extra field is built-in or user-defined.\n\nIf the value is `1`, the extra field is built-in. If the value is `2`, the extra field is user-defined.","title":"AddressesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsConfigType"},"AddressesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"The unique identifier for an address extra field."},"uuid":{"type":"string","format":"uuid","description":"An external ID assigned to the address extra field in a third-party system, such as an ERP."},"fieldName":{"$ref":"#/components/schemas/extraFields_BASIC/properties/fieldName"},"fieldType":{"$ref":"#/components/schemas/extraFields_BASIC/properties/fieldType"},"isRequired":{"type":"boolean","description":"Indicates whether or not the extra field must be filled out in order to create a new address.\n\nIf `true`, the extra field is required. If `false`, the extra field is optional."},"isUnique":{"type":"boolean","description":"Indicates whether or not unique values are required for the extra field. Specifically if `true`, no two addresses may have the same value for the field."},"visibleToEnduser":{"type":"boolean","description":"Indicates whether or not the extra field is visible on the storefront.\n\nIf `true`, the extra field is visible on the storefront. If `false`, the extra field is only visible in the B2B Edition control panel."},"configType":{"$ref":"#/components/schemas/AddressesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsConfigType","description":"Indicates whether an extra field is built-in or user-defined.\n\nIf the value is `1`, the extra field is built-in. If the value is `2`, the extra field is user-defined."},"defaultValue":{"type":"string","description":"The default value configured for the extra field."},"maximumLength":{"type":"string","description":"The maximum character length of the value entered for the extra field. This only applies to extra fields with a `fieldType` of `0` (text)."},"numberOfRows":{"type":"string","description":"The maximum number or text rows for the value entered for the extra field. This only applies to extra fields with a `fieldType` of `1` (multi-line text)."},"maximumValue":{"type":"string","description":"The maximum numeric value that can be entered for the extra field. This only applies to extra fields with a `fieldType` of `2` (number)."},"listOfValue":{"type":"array","items":{"type":"string"},"description":"The available options that can be selected for the extra field. This only applies to extra fields with a `fieldType` of `3` (dropdown)."}},"title":"AddressesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItems"},"Addresses_get-addresses-extra-fields_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"type":"array","items":{"$ref":"#/components/schemas/AddressesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/meta_full"}},"required":["code","data","meta"],"title":"Addresses_get-addresses-extra-fields_Response_200"},"storeHash":{"type":"string","description":"The unique store hash for the BigCommerce store.","title":"storeHash"},"email":{"type":"string","format":"email","description":"The email address associated with the user's account.","title":"email"},"password":{"type":"string","format":"password","description":"The password associated with the user's account.","title":"password"},"channelId":{"type":"integer","description":"The storefront channel ID where the order was placed.","title":"channelId"},"tokenName":{"type":"string","description":"The internal name assigned to the generated API token.","title":"tokenName"},"tokenValue":{"type":"string","title":"tokenValue"},"AuthCustomersPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/tokenName"},"token":{"$ref":"#/components/schemas/tokenValue"}},"title":"AuthCustomersPostResponsesContentApplicationJsonSchemaData"},"AuthCustomersPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"AuthCustomersPostResponsesContentApplicationJsonSchemaMeta"},"Authentication_post-auth-customer_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"The HTTP Status code of the response."},"data":{"$ref":"#/components/schemas/AuthCustomersPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/AuthCustomersPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Authentication_post-auth-customer_Response_200"},"customerId":{"type":"integer","description":"The ID of a BigCommerce customer account with a corresponding Company user account.","title":"customerId"},"customerAccessToken":{"type":"object","properties":{"expires_at":{"type":"string","description":"The expiration date of the CAT, in [ISO format](https://www.iso.org/iso-8601-date-and-time-format.html)."},"value":{"$ref":"#/components/schemas/tokenValue"}},"description":"This object contains information related to the Customer Access Token (CAT) being associated with the storefront authToken.","title":"customerAccessToken"},"AuthCustomersStorefrontPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"token":{"type":"array","items":{"type":"string"},"description":"The token value used to authenticate requests."}},"title":"AuthCustomersStorefrontPostResponsesContentApplicationJsonSchemaData"},"AuthCustomersStorefrontPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"AuthCustomersStorefrontPostResponsesContentApplicationJsonSchemaMeta"},"Authentication_post-auth-customers-storefront_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"The HTTP Status code of the response."},"data":{"$ref":"#/components/schemas/AuthCustomersStorefrontPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/AuthCustomersStorefrontPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Authentication_post-auth-customers-storefront_Response_200"},"AuthStorefrontGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string","description":"Message associated with the error."}},"title":"AuthStorefrontGetResponsesContentApplicationJsonSchemaData"},"AuthStorefrontGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"AuthStorefrontGetResponsesContentApplicationJsonSchemaMeta"},"Authentication_get-auth-storefront_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"The HTTP Status code of the response."},"data":{"$ref":"#/components/schemas/AuthStorefrontGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/AuthStorefrontGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Authentication_get-auth-storefront_Response_200"},"Get-auth-storefrontRequestUnauthorizedError":{"type":"object","properties":{"code":{"type":"integer","default":401,"description":"The HTTP Status code of the response."},"data":{"$ref":"#/components/schemas/AuthStorefrontGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/AuthStorefrontGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Get-auth-storefrontRequestUnauthorizedError"},"AuthBackendPostResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/tokenName"},"token":{"$ref":"#/components/schemas/tokenValue"}},"title":"AuthBackendPostResponsesContentApplicationJsonSchemaDataItems"},"AuthBackendPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"AuthBackendPostResponsesContentApplicationJsonSchemaMeta"},"Authentication_post-auth-backend_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"The HTTP Status code of the response."},"data":{"type":"array","items":{"$ref":"#/components/schemas/AuthBackendPostResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/AuthBackendPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Authentication_post-auth-backend_Response_200"},"AuthBackendPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string","description":"Message associated with the error."}},"title":"AuthBackendPostResponsesContentApplicationJsonSchemaData"},"Post-auth-backendRequestBadRequestError":{"type":"object","properties":{"code":{"type":"integer","default":400,"description":"The HTTP Status code of the response."},"data":{"$ref":"#/components/schemas/AuthBackendPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/AuthBackendPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-auth-backendRequestBadRequestError"},"tokenId":{"type":"integer","description":"The internal ID for the API token.","title":"tokenId"},"AuthBackendDeleteResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"AuthBackendDeleteResponsesContentApplicationJsonSchemaMeta"},"Authentication_delete-auth-backend_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"The HTTP Status code of the response."},"data":{"type":"array","items":{"description":"Any type"}},"meta":{"$ref":"#/components/schemas/AuthBackendDeleteResponsesContentApplicationJsonSchemaMeta"}},"title":"Authentication_delete-auth-backend_Response_200"},"AuthBackendDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string","description":"Message associated with the error."}},"title":"AuthBackendDeleteResponsesContentApplicationJsonSchemaData"},"Delete-auth-backendRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer","default":404,"description":"The HTTP Status code of the response."},"data":{"$ref":"#/components/schemas/AuthBackendDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/AuthBackendDeleteResponsesContentApplicationJsonSchemaMeta"}},"title":"Delete-auth-backendRequestNotFoundError"},"BackendTokensGetResponsesContentApplicationJsonSchemaDataItemsEventChannel":{"type":"string","enum":["app","admin","api"],"description":"This field indicates whether the token was created in the B2B Edition control panel (`app`), the admin (`admin`), or the API (`api`).","title":"BackendTokensGetResponsesContentApplicationJsonSchemaDataItemsEventChannel"},"BackendTokensGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/tokenId"},"name":{"$ref":"#/components/schemas/tokenName"},"email":{"$ref":"#/components/schemas/email"},"storeHash":{"$ref":"#/components/schemas/storeHash"},"token":{"$ref":"#/components/schemas/tokenValue"},"eventChannel":{"$ref":"#/components/schemas/BackendTokensGetResponsesContentApplicationJsonSchemaDataItemsEventChannel","description":"This field indicates whether the token was created in the B2B Edition control panel (`app`), the admin (`admin`), or the API (`api`)."}},"title":"BackendTokensGetResponsesContentApplicationJsonSchemaDataItems"},"responsePagination":{"type":"object","properties":{"totalCount":{"type":"integer","description":"The total number of items in the full response."},"offset":{"type":"integer","default":0,"description":"The number of results skipped before the first result."},"limit":{"type":"integer","default":10,"description":"The number of records returned per page."}},"title":"responsePagination"},"BackendTokensGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"},"pagination":{"$ref":"#/components/schemas/responsePagination"}},"title":"BackendTokensGetResponsesContentApplicationJsonSchemaMeta"},"Authentication_get-backend-tokens_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"The HTTP Status code of the response."},"data":{"type":"array","items":{"$ref":"#/components/schemas/BackendTokensGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/BackendTokensGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Authentication_get-backend-tokens_Response_200"},"ChannelType":{"type":"string","enum":["storefront","marketplace","pos","custom"],"description":"The type of channel. Currently, only `storefront` channel type is supported within B2B Edition.","title":"ChannelType"},"ChannelPlatform":{"type":"string","enum":["bigcommerce","amazon","ebay","custom"],"description":"The platform provider for the channel. Currently, only `bigcommerce` channel platform is supported within B2B Edition.","title":"ChannelPlatform"},"ChannelStatus":{"type":"string","enum":["active","inactive","archived"],"description":"The status of the channel, indicating whether it is prelaunch (`prelaunch`), live (`active`), down for maintenance (`inactive`), archived (`archived`), or marked for deletion (`deleted`). Once a channel is deleted, it will no longer be available to the API.","title":"ChannelStatus"},"Channel":{"type":"object","properties":{"id":{"type":"integer","description":"The unique numeric ID assigned to the storefront channel by B2B Edition. Does **not** match `channelId`."},"channelId":{"type":"integer","description":"The unique numeric ID assigned to the storefront channel by BigCommerce. Does **not** match `id`."},"name":{"type":"string","description":"The display name for the channel as shown in the Channels menu in the BigCommerce control panel."},"type":{"$ref":"#/components/schemas/ChannelType","description":"The type of channel. Currently, only `storefront` channel type is supported within B2B Edition."},"platform":{"$ref":"#/components/schemas/ChannelPlatform","description":"The platform provider for the channel. Currently, only `bigcommerce` channel platform is supported within B2B Edition."},"status":{"$ref":"#/components/schemas/ChannelStatus","description":"The status of the channel, indicating whether it is prelaunch (`prelaunch`), live (`active`), down for maintenance (`inactive`), archived (`archived`), or marked for deletion (`deleted`). Once a channel is deleted, it will no longer be available to the API."},"site":{"type":"string","description":"The domain associated with the channel, as reported within BigCommerce."},"isVisible":{"type":"boolean","description":"Indicates whether the channel is visible in the BigCommerce control panel."},"isEnabled":{"type":"boolean","description":"Indicates whether the channel is enabled."},"iconUrl":{"type":"string","description":"The URL for the channel's icon seen in B2B Edition's Storefronts settings. Note that this does not correspond to the storefront channel's logo or favicon."},"b2bEnabled":{"type":"boolean","description":"Indicates whether B2B features are enabled for this channel."},"allowGlobalLogins":{"type":"boolean","description":"Determines if customers created on this channel will get global access/login."},"createdAt":{"type":"string","format":"date-time","description":"The [Unix Timestap](https://www.unixtimestamp.com/) creation date for the channel."},"updatedAt":{"type":"string","format":"date-time","description":"The [Unix Timestap](https://www.unixtimestamp.com/) last update date for the channel."}},"description":"A BigCommerce store channel object","title":"Channel"},"ChannelsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"}},"title":"ChannelsGetResponsesContentApplicationJsonSchemaMeta"},"Channels_get-channels_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"meta":{"$ref":"#/components/schemas/ChannelsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Channels_get-channels_Response_200"},"Get-channelsRequestForbiddenError":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code."},"message":{"type":"string","description":"Error message."}},"title":"Get-channelsRequestForbiddenError"},"ChannelsChannelIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"}},"title":"ChannelsChannelIdGetResponsesContentApplicationJsonSchemaMeta"},"Channels_get-channels-channelId_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"$ref":"#/components/schemas/Channel"},"meta":{"$ref":"#/components/schemas/ChannelsChannelIdGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Channels_get-channels-channelId_Response_200"},"Get-channels-channelIdRequestForbiddenError":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code."},"message":{"type":"string","description":"Error message."}},"title":"Get-channels-channelIdRequestForbiddenError"},"Get-channels-channelIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code."},"message":{"type":"string","description":"Error message."}},"title":"Get-channels-channelIdRequestNotFoundError"},"companyId_integer":{"type":"integer","description":"Unique numeric ID of the Company account. This is a **read-only** field; do not set or modify its value in a `POST` or `PUT` request.","title":"companyId_integer"},"companyName":{"type":"string","description":"The name of the business associated with the Company account.","title":"companyName"},"companyStatus_integer":{"type":"string","enum":["0","1","2","3"],"description":"See [Company Status Codes](/developer/api-reference/rest/b2b/management/company/companies) to learn about their corresponding statuses.","title":"companyStatus_integer"},"hierarchyCompany":{"type":"object","properties":{"companyId":{"$ref":"#/components/schemas/companyId_integer"},"companyName":{"$ref":"#/components/schemas/companyName"},"companyStatus":{"$ref":"#/components/schemas/companyStatus_integer"}},"title":"hierarchyCompany"},"CompaniesCompanyIdSubsidiariesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"companyId":{"$ref":"#/components/schemas/companyId_integer"},"companyName":{"$ref":"#/components/schemas/companyName"},"companyStatus":{"$ref":"#/components/schemas/companyStatus_integer"},"subsidiaries":{"type":"array","items":{"$ref":"#/components/schemas/hierarchyCompany"},"description":"Displays information about the Company's subsidiary accounts in its hierarchy. The array includes the `companyId`, `companyName`, and `companyStatus` fields for each subsidiary Company.\n\nThe array can include nested `subsidiaries` arrays for each Company with its own subsidiaries."}},"title":"CompaniesCompanyIdSubsidiariesGetResponsesContentApplicationJsonSchemaDataItems"},"CompaniesCompanyIdSubsidiariesGetResponsesContentApplicationJsonSchemaMetaPagination":{"type":"object","properties":{"totalCount":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"}},"title":"CompaniesCompanyIdSubsidiariesGetResponsesContentApplicationJsonSchemaMetaPagination"},"CompaniesCompanyIdSubsidiariesGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"},"pagination":{"$ref":"#/components/schemas/CompaniesCompanyIdSubsidiariesGetResponsesContentApplicationJsonSchemaMetaPagination"}},"title":"CompaniesCompanyIdSubsidiariesGetResponsesContentApplicationJsonSchemaMeta"},"Account Hierarchies_get-companies-companyId-subsidiaries_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesCompanyIdSubsidiariesGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdSubsidiariesGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Account Hierarchies_get-companies-companyId-subsidiaries_Response_200"},"CompaniesCompanyIdSubsidiariesGetResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{"index":{"type":"string"}},"title":"CompaniesCompanyIdSubsidiariesGetResponsesContentApplicationJsonSchemaErrors"},"Get-companies-companyId-subsidiariesRequestNotFoundError":{"type":"object","properties":{"status":{"type":"number","format":"double"},"title":{"type":"string"},"errors":{"$ref":"#/components/schemas/CompaniesCompanyIdSubsidiariesGetResponsesContentApplicationJsonSchemaErrors"}},"title":"Get-companies-companyId-subsidiariesRequestNotFoundError"},"CompaniesCompanyIdSubsidiariesChildCompanyIdDeleteResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{"index":{"type":"string"}},"title":"CompaniesCompanyIdSubsidiariesChildCompanyIdDeleteResponsesContentApplicationJsonSchemaErrors"},"Delete-companies-companyId-subsidiaryRequestBadRequestError":{"type":"object","properties":{"status":{"type":"number","format":"double"},"title":{"type":"string"},"errors":{"$ref":"#/components/schemas/CompaniesCompanyIdSubsidiariesChildCompanyIdDeleteResponsesContentApplicationJsonSchemaErrors"}},"title":"Delete-companies-companyId-subsidiaryRequestBadRequestError"},"CompaniesCompanyIdParentPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"}},"title":"CompaniesCompanyIdParentPostResponsesContentApplicationJsonSchemaMeta"},"Account Hierarchies_post-companies-companyId-parents_Response_201":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdParentPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Account Hierarchies_post-companies-companyId-parents_Response_201"},"CompaniesCompanyIdParentPostResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{"index":{"type":"string"}},"title":"CompaniesCompanyIdParentPostResponsesContentApplicationJsonSchemaErrors"},"Post-companies-companyId-parentsRequestBadRequestError":{"type":"object","properties":{"status":{"type":"number","format":"double"},"title":{"type":"string"},"errors":{"$ref":"#/components/schemas/CompaniesCompanyIdParentPostResponsesContentApplicationJsonSchemaErrors"}},"title":"Post-companies-companyId-parentsRequestBadRequestError"},"CompaniesCompanyIdHierarchyGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"companyId":{"$ref":"#/components/schemas/companyId_integer"},"companyName":{"$ref":"#/components/schemas/companyName"},"companyStatus":{"$ref":"#/components/schemas/companyStatus_integer"},"subsidiaries":{"type":"array","items":{"$ref":"#/components/schemas/hierarchyCompany"},"description":"Displays information about the Company's subsidiary accounts in its hierarchy. The array includes the `companyId`, `companyName`, and `companyStatus` fields for each subsidiary Company.\n\nThe array can include nested `subsidiaries` arrays for each Company with its own subsidiaries."}},"title":"CompaniesCompanyIdHierarchyGetResponsesContentApplicationJsonSchemaDataItems"},"CompaniesCompanyIdHierarchyGetResponsesContentApplicationJsonSchemaMetaPagination":{"type":"object","properties":{"totalCount":{"type":"integer","description":"Total number of subsidiaries of current company."},"limit":{"type":"integer"},"offset":{"type":"integer"}},"title":"CompaniesCompanyIdHierarchyGetResponsesContentApplicationJsonSchemaMetaPagination"},"CompaniesCompanyIdHierarchyGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"},"pagination":{"$ref":"#/components/schemas/CompaniesCompanyIdHierarchyGetResponsesContentApplicationJsonSchemaMetaPagination"}},"title":"CompaniesCompanyIdHierarchyGetResponsesContentApplicationJsonSchemaMeta"},"Account Hierarchies_get-companies-companyId-hierarchy_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesCompanyIdHierarchyGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdHierarchyGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Account Hierarchies_get-companies-companyId-hierarchy_Response_200"},"CompaniesCompanyIdHierarchyGetResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{"index":{"type":"string"}},"title":"CompaniesCompanyIdHierarchyGetResponsesContentApplicationJsonSchemaErrors"},"Get-companies-companyId-hierarchyRequestNotFoundError":{"type":"object","properties":{"status":{"type":"number","format":"double"},"title":{"type":"string"},"errors":{"$ref":"#/components/schemas/CompaniesCompanyIdHierarchyGetResponsesContentApplicationJsonSchemaErrors"}},"title":"Get-companies-companyId-hierarchyRequestNotFoundError"},"CompaniesGetParametersSortBy":{"type":"string","enum":["companyName","updatedAt"],"default":"updatedAt","title":"CompaniesGetParametersSortBy"},"CompaniesGetParametersOrderBy":{"type":"string","enum":["ASC","DESC"],"default":"DESC","title":"CompaniesGetParametersOrderBy"},"CompaniesGetParametersIsIncludeExtraFields":{"type":"string","enum":["0","1"],"default":"0","title":"CompaniesGetParametersIsIncludeExtraFields"},"CompaniesGetParametersCompanyStatus":{"type":"string","enum":["0","1","2","3"],"title":"CompaniesGetParametersCompanyStatus"},"CompaniesGetParametersExtraFieldFilterType":{"type":"string","enum":["search","exact-match"],"default":"search","title":"CompaniesGetParametersExtraFieldFilterType"},"companyId_string":{"type":"integer","description":"Unique numeric ID of the Company account. This is a **read-only** field; do not set or modify its value in a `POST` or `PUT` request.","title":"companyId_string"},"catalogId_string":{"type":"string","description":"The ID of the price list assigned to the Company account. This field is read-only for stores using [Independent Companies Behavior](/developer/api-reference/rest/b2b/management/company/companies#independent-vs-dependent-companies-behavior).\n\nIf your store uses legacy Dependent Companies behavior **and** it does not have Multi-Storefront enabled, this field is **required** for creating new Company accounts. If your store has Multi-Storefront enabled, use the `priceListAssign` array instead.","title":"catalogId_string"},"companyStatus_string":{"type":"string","enum":["0","1","2","3"],"description":"See [Company Status Codes](/developer/api-reference/rest/b2b/management/company/companies) to learn about their corresponding statuses.","title":"companyStatus_string"},"parentCompany":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the Company’s parent account in its hierarchy."},"name":{"type":"string","description":"The name of the Company’s parent account in its hierarchy."}},"description":"The name and ID of a Company account assigned as the parent of the Company in question. Leave these fields blank if the Company is at the top layer of its hierarchy.","title":"parentCompany"},"PriceListAssignResponseItems":{"type":"object","properties":{"channelId":{"type":"integer","description":"The ID of the storefront channel where the price list is applied to the Company. Use 1 for your store’s default storefront channel."},"priceListId":{"type":"integer","description":"The ID of the price list assigned to the Company account."},"priceListName":{"type":"string","description":"The internal name of the price list assigned to the Company account."},"channelName":{"type":"string","description":"The name of the storefront channel where the price list is applied to the Company."}},"title":"PriceListAssignResponseItems"},"priceListAssign_RESPONSE":{"type":"array","items":{"$ref":"#/components/schemas/PriceListAssignResponseItems"},"description":"Use this array to assign a price list to a Company account if your store uses legacy Dependent Companies behavior *and* it has Multi-Storefront enabled. Use `catalogId` to assign price lists if you have not enabled Multi-Storefront.\n\nThis field is read-only for stores using Independent Companies behavior. See [Independent Companies Behavior](/developer/api-reference/rest/b2b/management/company/companies#independent-vs-dependent-companies-behavior) for more information.","title":"priceListAssign_RESPONSE"},"ExtraFieldsResponseItemsIsRequired":{"type":"string","enum":["0","1"],"description":"Indicates whether or not the extra field must be filled out in order to create a Company account.\n\n`0`=not required, `1`=required","title":"ExtraFieldsResponseItemsIsRequired"},"ExtraFieldsResponseItemsDataType":{"type":"string","enum":["0","1","2","3"],"description":"The type of data that can be added as the extra field’s value. This shares the same value as the `fieldType`\n\n| Value | Type |\n| --- | ---|\n| `0` | text |\n| `1` | multi-line text |\n| `2` | numbers |\n| `3` | dropdown |","title":"ExtraFieldsResponseItemsDataType"},"ExtraFieldsResponseItemsFieldType":{"type":"string","enum":["0","1","2","3"],"description":"The type of data that can be added as the extra field’s value.\n\n| Value | Type |\n| --- | ---|\n| `0` | text |\n| `1` | multi-line text |\n| `2` | numbers |\n| `3` | dropdown |","title":"ExtraFieldsResponseItemsFieldType"},"ExtraFieldsResponseItems":{"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the Company extra field."},"fieldValue":{"type":"string","description":"The value of the Company extra field."},"labelName":{"type":"string","description":"The label name of the Company extra field. This value matches the value of `fieldName`."},"isRequired":{"$ref":"#/components/schemas/ExtraFieldsResponseItemsIsRequired","description":"Indicates whether or not the extra field must be filled out in order to create a Company account.\n\n`0`=not required, `1`=required"},"dataType":{"$ref":"#/components/schemas/ExtraFieldsResponseItemsDataType","description":"The type of data that can be added as the extra field’s value. This shares the same value as the `fieldType`\n\n| Value | Type |\n| --- | ---|\n| `0` | text |\n| `1` | multi-line text |\n| `2` | numbers |\n| `3` | dropdown |"},"fieldType":{"$ref":"#/components/schemas/ExtraFieldsResponseItemsFieldType","description":"The type of data that can be added as the extra field’s value.\n\n| Value | Type |\n| --- | ---|\n| `0` | text |\n| `1` | multi-line text |\n| `2` | numbers |\n| `3` | dropdown |"}},"title":"ExtraFieldsResponseItems"},"extraFields_RESPONSE":{"type":"array","items":{"$ref":"#/components/schemas/ExtraFieldsResponseItems"},"description":"Controlled by isIncludeExtraFields params","title":"extraFields_RESPONSE"},"CompaniesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"companyName":{"$ref":"#/components/schemas/companyName"},"companyEmail":{"type":"string","format":"email","description":"The primary email address for the Company account."},"companyPhone":{"type":"string","description":"The primary phone number for the Company account."},"companyId":{"$ref":"#/components/schemas/companyId_string"},"catalogId":{"$ref":"#/components/schemas/catalogId_string"},"catalogName":{"type":"string","description":"Catalog name"},"bcGroupName":{"type":"string","description":"The internal name of the BigCommerce customer group assigned to the Company account. This field is read-only."},"companyStatus":{"$ref":"#/components/schemas/companyStatus_string"},"parentCompany":{"$ref":"#/components/schemas/parentCompany"},"priceListAssign":{"$ref":"#/components/schemas/priceListAssign_RESPONSE"},"extraFields":{"$ref":"#/components/schemas/extraFields_RESPONSE"},"uuid":{"type":"string","format":"uuid","description":"An external ID assigned to the Company account in a third-party system, such as an ERP. Leave this field blank if you do not have an external system."},"updatedAt":{"type":"string","format":"time","description":"The [Unix timestamp](https://www.unixtimestamp.com/) for when the Company account was last updated. This is a read-only field."},"createdAt":{"type":"string","format":"time","description":"The [Unix timestamp](https://www.unixtimestamp.com/) for when the Company account was created. This is a read-only field."},"bcGroupId":{"type":"integer","description":"The ID of the BigCommerce customer group assigned to the Company account. This field is read-only; use customerGroupID for POST/PUT requests."}},"title":"CompaniesGetResponsesContentApplicationJsonSchemaDataItems"},"CompaniesGetResponsesContentApplicationJsonSchemaMetaPagination":{"type":"object","properties":{"totalCount":{"type":"integer","description":"The total number of items matching the query."},"limit":{"type":"integer","description":"Maximum number of results displayed per page."},"offset":{"type":"integer","description":"Number of results skipped before the current page."}},"title":"CompaniesGetResponsesContentApplicationJsonSchemaMetaPagination"},"CompaniesGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"},"pagination":{"$ref":"#/components/schemas/CompaniesGetResponsesContentApplicationJsonSchemaMetaPagination"}},"title":"CompaniesGetResponsesContentApplicationJsonSchemaMeta"},"Companies_get-companies_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/CompaniesGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_get-companies_Response_200"},"CompaniesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems":{"type":"object","properties":{"fieldName":{"type":"string","description":"Field name that config in you store"},"fieldValue":{"type":"string","description":"Value of the extra field."}},"required":["fieldName","fieldValue"],"title":"CompaniesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems"},"CompaniesPostRequestBodyContentApplicationJsonSchemaUserExtraFieldsItems":{"type":"object","properties":{"fieldName":{"type":"string","description":"Field name that config in you store"},"fieldValue":{"type":"string","description":"Value of the extra field."}},"required":["fieldName","fieldValue"],"title":"CompaniesPostRequestBodyContentApplicationJsonSchemaUserExtraFieldsItems"},"customerGroupId":{"type":"integer","description":"The ID of the BigCommerce customer group assigned to the Company account. This field can be static or configurable depending on whether or not your store uses Independent Companies behavior. See [Independent Companies Behavior](/developer/api-reference/rest/b2b/management/company/companies#independent-vs-dependent-companies-behavior) for more information.","title":"customerGroupId"},"catalogId_integer":{"type":"integer","description":"The ID of the price list assigned to the Company account. This field is read-only for stores using [Independent Companies Behavior](/developer/api-reference/rest/b2b/management/company/companies#independent-vs-dependent-companies-behavior).\n\nIf your store uses legacy Dependent Companies behavior **and** it does not have Multi-Storefront enabled, this field is **required** for creating new Company accounts. If your store has Multi-Storefront enabled, use the `priceListAssign` array instead.","title":"catalogId_integer"},"CompaniesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"companyId":{"$ref":"#/components/schemas/companyId_integer"},"customerId":{"type":"integer"},"customerGroupId":{"$ref":"#/components/schemas/customerGroupId"}},"title":"CompaniesPostResponsesContentApplicationJsonSchemaData"},"CompaniesPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"CompaniesPostResponsesContentApplicationJsonSchemaMeta"},"Companies_post-companies_Response_200":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/CompaniesPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_post-companies_Response_200"},"Post-companiesRequestBadRequestError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/CompaniesPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-companiesRequestBadRequestError"},"Post-companiesRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/CompaniesPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-companiesRequestUnprocessableEntityError"},"CompaniesCompanyIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"CompaniesCompanyIdGetResponsesContentApplicationJsonSchemaData"},"CompaniesCompanyIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"CompaniesCompanyIdGetResponsesContentApplicationJsonSchemaMeta"},"Companies_get-companies-companyId_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_get-companies-companyId_Response_200"},"Get-companies-companyIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Get-companies-companyIdRequestNotFoundError"},"PriceListAssignRequestItems":{"type":"object","properties":{"channelId":{"type":"integer","description":"The ID of the storefront channel where the price list is applied to the Company. Use 1 for your store’s default storefront channel."},"priceListId":{"type":"integer","description":"The ID of the price list assigned to the Company account."}},"title":"PriceListAssignRequestItems"},"priceListAssign_REQUEST":{"type":"array","items":{"$ref":"#/components/schemas/PriceListAssignRequestItems"},"description":"Use this array to assign a price list to a Company account if your store uses legacy Dependent Companies behavior *and* it has Multi-Storefront enabled. Use catalogId to assign price lists if you have not enabled Multi-Storefront.\n\nThis field is read-only for stores using Independent Companies behavior. See [Independent Companies Behavior](/developer/api-reference/rest/b2b/management/company/companies#independent-vs-dependent-companies-behavior) for more information.","title":"priceListAssign_REQUEST"},"CompaniesCompanyIdPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems":{"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the Company extra field."},"fieldValue":{"type":"string","description":"The value of the Company extra field."}},"title":"CompaniesCompanyIdPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems"},"CompaniesCompanyIdPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"CompaniesCompanyIdPutResponsesContentApplicationJsonSchemaMeta"},"CompaniesCompanyIdPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"CompaniesCompanyIdPutResponsesContentApplicationJsonSchemaData"},"Companies_put-companies-companyId_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdPutResponsesContentApplicationJsonSchemaMeta"},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdPutResponsesContentApplicationJsonSchemaData"}},"title":"Companies_put-companies-companyId_Response_200"},"Put-companies-companyIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Put-companies-companyIdRequestNotFoundError"},"CompaniesCompanyIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"companyId":{"$ref":"#/components/schemas/companyId_integer"},"customerId":{"type":"integer"},"customerGroupId":{"$ref":"#/components/schemas/customerGroupId"}},"title":"CompaniesCompanyIdDeleteResponsesContentApplicationJsonSchemaData"},"CompaniesCompanyIdDeleteResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"CompaniesCompanyIdDeleteResponsesContentApplicationJsonSchemaMeta"},"Companies_delete-companies-companyId_Response_200":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_delete-companies-companyId_Response_200"},"Delete-companies-companyIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"title":"Delete-companies-companyIdRequestNotFoundError"},"CustomerGroupsCustomerGroupIdCompaniesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems":{"type":"object","properties":{"fieldName":{"type":"string","description":"Field name that config in you store"},"fieldValue":{"type":"string","description":"Value of the extra field."}},"required":["fieldName","fieldValue"],"title":"CustomerGroupsCustomerGroupIdCompaniesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems"},"CustomerGroupsCustomerGroupIdCompaniesPostRequestBodyContentApplicationJsonSchemaUserExtraFieldsItems":{"type":"object","properties":{"fieldName":{"type":"string","description":"Field name that config in you store"},"fieldValue":{"type":"string","description":"Value of the extra field."}},"required":["fieldName","fieldValue"],"title":"CustomerGroupsCustomerGroupIdCompaniesPostRequestBodyContentApplicationJsonSchemaUserExtraFieldsItems"},"CustomerGroupsCustomerGroupIdCompaniesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"CustomerGroupsCustomerGroupIdCompaniesPostResponsesContentApplicationJsonSchemaData"},"CustomerGroupsCustomerGroupIdCompaniesPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"CustomerGroupsCustomerGroupIdCompaniesPostResponsesContentApplicationJsonSchemaMeta"},"Companies_post-companies-conversion-customerGroups_Response_200":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/CustomerGroupsCustomerGroupIdCompaniesPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CustomerGroupsCustomerGroupIdCompaniesPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_post-companies-conversion-customerGroups_Response_200"},"Post-companies-conversion-customerGroupsRequestBadRequestError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/CustomerGroupsCustomerGroupIdCompaniesPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CustomerGroupsCustomerGroupIdCompaniesPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-companies-conversion-customerGroupsRequestBadRequestError"},"Post-companies-conversion-customerGroupsRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/CustomerGroupsCustomerGroupIdCompaniesPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CustomerGroupsCustomerGroupIdCompaniesPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-companies-conversion-customerGroupsRequestNotFoundError"},"CompaniesBulkPostRequestBodyContentApplicationJsonSchemaItemsUserExtraFieldsItems":{"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the user extra field."},"fieldValue":{"type":"string","description":"The value of the user extra field."}},"required":["fieldName","fieldValue"],"title":"CompaniesBulkPostRequestBodyContentApplicationJsonSchemaItemsUserExtraFieldsItems"},"CompaniesBulkPostRequestBodyContentApplicationJsonSchemaItemsExtraFields":{"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the Company extra field."},"fieldValue":{"type":"string","description":"The value of the Company extra field."}},"description":"Extra fields you want to add to the company fields.","title":"CompaniesBulkPostRequestBodyContentApplicationJsonSchemaItemsExtraFields"},"CompaniesBulkPostRequestBodyContentApplicationJsonSchemaItems":{"type":"object","properties":{"companyName":{"$ref":"#/components/schemas/companyName"},"companyEmail":{"type":"string","format":"email","description":"The primary email address for the Company account."},"companyPhone":{"type":"string","description":"The primary phone number for the Company account."},"customerGroupId":{"$ref":"#/components/schemas/customerGroupId"},"addressLine1":{"type":"string","description":"The first line of the primary address for the Company account."},"addressLine2":{"type":"string","description":"The second line of the primary address for the Company account."},"city":{"type":"string","description":"The city of the primary address for the Company account."},"state":{"type":"string","description":"The state of the primary address for the Company account, if applicable. This must be the full name and not an abbreviation."},"country":{"type":"string","description":"The country of the primary address for the Company account. This must be either the full name or the ISO2 country code."},"zipCode":{"type":"string","description":"The postal code of the primary address for the Company account."},"adminFirstName":{"type":"string","description":"The first name of the Company account administrator."},"adminLastName":{"type":"string","description":"The last name of the Company account administrator."},"adminEmail":{"type":"string","format":"email","description":"The email address of the Company account administrator. If an existing BigCommerce customer account uses this email address, it is automatically linked to the administrator’s Company user account."},"adminPhoneNumber":{"type":"string","description":"The phone number of the Company account administrator."},"userExtraFields":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesBulkPostRequestBodyContentApplicationJsonSchemaItemsUserExtraFieldsItems"},"description":"Extra fields to apply to the Company administrator user."},"acceptWelcomeEmail":{"type":"boolean","description":"If user accepts, the system sends a welcome email."},"extraFields":{"$ref":"#/components/schemas/CompaniesBulkPostRequestBodyContentApplicationJsonSchemaItemsExtraFields","description":"Extra fields you want to add to the company fields."},"channelIds":{"type":"array","items":{"type":"integer"},"description":"The storefront channel IDs in which buyers can access their Company’s Buyer Portal. Use `1` for your store’s default storefront channel."},"originChannelId":{"type":"integer","description":"The storefront channel ID designated as the origin for the Company administrator. Use 1 for your store’s default storefront channel."}},"required":["companyName","companyEmail","companyPhone","country","adminFirstName","adminLastName","adminEmail"],"title":"CompaniesBulkPostRequestBodyContentApplicationJsonSchemaItems"},"CompaniesBulkPostResponsesContentApplicationJsonSchemaMetaItems":{"type":"object","properties":{"companyId":{"$ref":"#/components/schemas/companyId_integer"}},"title":"CompaniesBulkPostResponsesContentApplicationJsonSchemaMetaItems"},"CompaniesBulkPostResponsesContentApplicationJsonSchemaDataErrorsItems":{"type":"object","properties":{"id":{"type":"string"},"_detail":{"type":"string"}},"title":"CompaniesBulkPostResponsesContentApplicationJsonSchemaDataErrorsItems"},"CompaniesBulkPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesBulkPostResponsesContentApplicationJsonSchemaDataErrorsItems"}}},"title":"CompaniesBulkPostResponsesContentApplicationJsonSchemaData"},"Companies_post-companies-bulk_Response_200":{"type":"object","properties":{"code":{"type":"integer"},"meta":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesBulkPostResponsesContentApplicationJsonSchemaMetaItems"}},"data":{"$ref":"#/components/schemas/CompaniesBulkPostResponsesContentApplicationJsonSchemaData"}},"title":"Companies_post-companies-bulk_Response_200"},"CompaniesBulkPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"CompaniesBulkPostResponsesContentApplicationJsonSchemaMeta"},"Post-companies-bulkRequestBadRequestError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/CompaniesBulkPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesBulkPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-companies-bulkRequestBadRequestError"},"Post-companies-bulkRequestConflictError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/CompaniesBulkPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesBulkPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-companies-bulkRequestConflictError"},"Post-companies-bulkRequestContentTooLargeError":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code of the response."},"data":{"$ref":"#/components/schemas/CompaniesBulkPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesBulkPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-companies-bulkRequestContentTooLargeError"},"Post-companies-bulkRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/CompaniesBulkPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesBulkPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-companies-bulkRequestUnprocessableEntityError"},"CompaniesBulkPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems":{"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the Company extra field."},"fieldValue":{"type":"string","description":"The value of the Company extra field."}},"title":"CompaniesBulkPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems"},"CompaniesBulkPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"Response message."}},"title":"CompaniesBulkPutResponsesContentApplicationJsonSchemaMeta"},"CompaniesBulkPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"CompaniesBulkPutResponsesContentApplicationJsonSchemaData"},"Companies_put-companies_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"meta":{"$ref":"#/components/schemas/CompaniesBulkPutResponsesContentApplicationJsonSchemaMeta"},"data":{"$ref":"#/components/schemas/CompaniesBulkPutResponsesContentApplicationJsonSchemaData"}},"title":"Companies_put-companies_Response_200"},"Put-companiesRequestBadRequestError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/CompaniesBulkPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesBulkPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Put-companiesRequestBadRequestError"},"Put-companiesRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/CompaniesBulkPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesBulkPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Put-companiesRequestNotFoundError"},"Put-companiesRequestContentTooLargeError":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code of the response."},"data":{"$ref":"#/components/schemas/CompaniesBulkPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesBulkPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Put-companiesRequestContentTooLargeError"},"CompaniesCompanyIdCatalogsPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"CompaniesCompanyIdCatalogsPutResponsesContentApplicationJsonSchemaMeta"},"CompaniesCompanyIdCatalogsPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"companyId":{"$ref":"#/components/schemas/companyId_integer"}},"title":"CompaniesCompanyIdCatalogsPutResponsesContentApplicationJsonSchemaData"},"Companies_put-companies-companyId-catalog_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdCatalogsPutResponsesContentApplicationJsonSchemaMeta"},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdCatalogsPutResponsesContentApplicationJsonSchemaData"}},"title":"Companies_put-companies-companyId-catalog_Response_200"},"CompaniesCompanyIdStatusPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"CompaniesCompanyIdStatusPutResponsesContentApplicationJsonSchemaMeta"},"CompaniesCompanyIdStatusPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"companyId":{"$ref":"#/components/schemas/companyId_integer"}},"title":"CompaniesCompanyIdStatusPutResponsesContentApplicationJsonSchemaData"},"Companies_put-companies-companyId-status_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdStatusPutResponsesContentApplicationJsonSchemaMeta"},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdStatusPutResponsesContentApplicationJsonSchemaData"}},"title":"Companies_put-companies-companyId-status_Response_200"},"CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaMetaPagination":{"type":"object","properties":{"limit":{"type":"integer","description":"Pagination limit default: 10"},"offset":{"type":"integer","description":"Pagination offset default: 0"},"totalCount":{"type":"integer","description":"The total number of the all data"}},"title":"CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaMetaPagination"},"CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"},"pagination":{"$ref":"#/components/schemas/CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaMetaPagination"}},"description":"Used to response pagination information","title":"CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaMeta"},"CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsFieldType":{"type":"string","enum":["0","1","2","3"],"description":"The type of data that can be added as the extra field’s value.\n\n| Value | Type |\n| --- | ---|\n| `0` | text |\n| `1` | multi-line text |\n| `2` | numbers |\n| `3` | dropdown |","title":"CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsFieldType"},"CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsConfigType":{"type":"string","enum":["1","2"],"description":"Indicates whether an extra field is built-in or user-defined.\n\nIf the value is `1`, the extra field is built-in. If the value is `2`, the extra field is user-defined.","title":"CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsConfigType"},"CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"The unique identifier for a Company extra field."},"uuid":{"type":"string","format":"uuid","description":"An external ID assigned to the Company extra field in a third-party system, such as an ERP. Leave this field blank if you do not have an external system."},"fieldName":{"type":"string","description":"The name of the Company extra field."},"fieldType":{"$ref":"#/components/schemas/CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsFieldType","description":"The type of data that can be added as the extra field’s value.\n\n| Value | Type |\n| --- | ---|\n| `0` | text |\n| `1` | multi-line text |\n| `2` | numbers |\n| `3` | dropdown |"},"isRequired":{"type":"boolean","description":"Indicates whether or not the extra field must be filled out in order to create a Company account.\n\nIf `true`, the extra field is required. If `false`, the extra field is optional."},"isUnique":{"type":"boolean","description":"Indicates whether or not unique values are required for the extra field. Specifically if `true`, no two companies may have the same value for the field."},"visibleToEnduser":{"type":"boolean","description":"Indicates whether or not the extra field is visible on the storefront.\n\nIf `true`, the extra field is visible on the storefront. If `false`, the extra field is only visible in the B2B Edition control panel."},"configType":{"$ref":"#/components/schemas/CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsConfigType","description":"Indicates whether an extra field is built-in or user-defined.\n\nIf the value is `1`, the extra field is built-in. If the value is `2`, the extra field is user-defined."},"defaultValue":{"type":"string","description":"The default value configured for the extra field."},"maximumLength":{"type":"string","description":"The maximum character length of the value entered for the extra field. This only applies to extra fields with a `fieldType` of `0` (text)."},"numberOfRows":{"type":"string","description":"The maximum number or text rows for the value entered for the extra field. This only applies to extra fields with a `fieldType` of `1` (multi-line text)."},"maximumValue":{"type":"string","description":"The maximum numeric value that can be entered for the extra field. This only applies to extra fields with a `fieldType` of `2` (number)."},"listOfValue":{"type":"array","items":{"type":"string"},"description":"The available options that can be selected for the extra field. This only applies to extra fields with a `fieldType` of `3` (dropdown)."}},"description":"Extra Fields","title":"CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItems"},"Companies_get-companies-extra-fields_Response_200":{"type":"object","properties":{"code":{"type":"integer","description":"Response code of success request."},"meta":{"$ref":"#/components/schemas/CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaMeta","description":"Used to response pagination information"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItems"}}},"description":"Response for successful request","title":"Companies_get-companies-extra-fields_Response_200"},"CompaniesCompanyIdAttachmentsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"attachmentFile":{"type":"string","format":"url","description":"The file attached to the Company account."}},"title":"CompaniesCompanyIdAttachmentsGetResponsesContentApplicationJsonSchemaData"},"CompaniesCompanyIdAttachmentsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"}},"title":"CompaniesCompanyIdAttachmentsGetResponsesContentApplicationJsonSchemaMeta"},"Companies_get-companies-companyId-attachments_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double","default":200},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdAttachmentsGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdAttachmentsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_get-companies-companyId-attachments_Response_200"},"CompaniesCompanyIdAttachmentsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"attachmentFile":{"type":"string","format":"url","description":"The file attached to the Company account."}},"title":"CompaniesCompanyIdAttachmentsPostResponsesContentApplicationJsonSchemaData"},"CompaniesCompanyIdAttachmentsPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"}},"title":"CompaniesCompanyIdAttachmentsPostResponsesContentApplicationJsonSchemaMeta"},"Companies_post-companies-companyId-attachments_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double","default":200},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdAttachmentsPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdAttachmentsPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_post-companies-companyId-attachments_Response_200"},"CompaniesCompanyIdAttachmentsAttachmentIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"CompaniesCompanyIdAttachmentsAttachmentIdDeleteResponsesContentApplicationJsonSchemaData"},"CompaniesCompanyIdAttachmentsAttachmentIdDeleteResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"CompaniesCompanyIdAttachmentsAttachmentIdDeleteResponsesContentApplicationJsonSchemaMeta"},"Companies_delete-companies-companyId-attachments-attachmentId_Response_200":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdAttachmentsAttachmentIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdAttachmentsAttachmentIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_delete-companies-companyId-attachments-attachmentId_Response_200"},"permission_RESPONSE":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Company permission."},"description":{"type":"string","description":"The simple description for the Company permission. See [Permission Codes](/developer/api-reference/rest/b2b/management/company/companies#permission-code) for a more detailed description of each predefined Company permission."},"code":{"type":"string","description":"The [code string](/developer/api-reference/rest/b2b/management/company/companies#permission-code) of the Company permission."},"moduleName":{"type":"string","description":"The name of the module to which the permission belongs. This corresponds to the organizational section containing the permission when managing Company roles from the B2B Edition control panel."},"id":{"type":"integer"},"isCustom":{"type":"boolean","description":"Indicates whether a Company permission is predefined or custom. If `true`, the permission is custom. If `false`, it is predefined."}},"title":"permission_RESPONSE"},"CompaniesPermissionsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"}},"title":"CompaniesPermissionsGetResponsesContentApplicationJsonSchemaMeta"},"Company Roles and Permissions_get-stores-companies-permissions_Response_200":{"type":"object","properties":{"code":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/permission_RESPONSE"}},"meta":{"$ref":"#/components/schemas/CompaniesPermissionsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Company Roles and Permissions_get-stores-companies-permissions_Response_200"},"permission_REQUEST":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Company permission."},"description":{"type":"string","description":"The simple description for the Company permission. See [Permission Codes](/developer/api-reference/rest/b2b/management/company/companies#permission-code) for a more detailed description of each predefined Company permission."},"code":{"type":"string","description":"The [code string](/developer/api-reference/rest/b2b/management/company/companies#permission-code) of the Company permission."},"moduleName":{"type":"string","description":"The name of the module to which the permission belongs. This corresponds to the organizational section containing the permission when managing Company roles from the B2B Edition control panel."}},"required":["name","description","code"],"title":"permission_REQUEST"},"CompaniesPermissionsPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"}},"title":"CompaniesPermissionsPostResponsesContentApplicationJsonSchemaMeta"},"Company Roles and Permissions_post-stores-companies-permissions_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"$ref":"#/components/schemas/permission_RESPONSE"},"meta":{"$ref":"#/components/schemas/CompaniesPermissionsPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Company Roles and Permissions_post-stores-companies-permissions_Response_200"},"CompaniesPermissionsPermissionIdPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"}},"title":"CompaniesPermissionsPermissionIdPutResponsesContentApplicationJsonSchemaMeta"},"Company Roles and Permissions_put-stores-companies-permissions-permissionId_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"$ref":"#/components/schemas/permission_RESPONSE"},"meta":{"$ref":"#/components/schemas/CompaniesPermissionsPermissionIdPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Company Roles and Permissions_put-stores-companies-permissions-permissionId_Response_200"},"CompaniesPermissionsPermissionIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"CompaniesPermissionsPermissionIdDeleteResponsesContentApplicationJsonSchemaData"},"CompaniesPermissionsPermissionIdDeleteResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"CompaniesPermissionsPermissionIdDeleteResponsesContentApplicationJsonSchemaMeta"},"Company Roles and Permissions_delete-stores-companies-permissions-permissionId_Response_200":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/CompaniesPermissionsPermissionIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesPermissionsPermissionIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"title":"Company Roles and Permissions_delete-stores-companies-permissions-permissionId_Response_200"},"CompaniesRolesGetResponsesContentApplicationJsonSchemaDataRoleType":{"type":"string","enum":["1","2"],"description":"Indicates whether a Company user role is predefined or custom.\n\nIf this value is `1`, the role is predefined. If this value is `2`, the role is custom.","title":"CompaniesRolesGetResponsesContentApplicationJsonSchemaDataRoleType"},"CompaniesRolesGetResponsesContentApplicationJsonSchemaDataRoleLevel":{"type":"string","enum":["1"],"description":"Indicates how many Company accounts can view and assign the role to users. Currently, all Company roles are available at the store level, which has a value of `1`.","title":"CompaniesRolesGetResponsesContentApplicationJsonSchemaDataRoleLevel"},"CompaniesRolesGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the Company user role."},"name":{"type":"string","description":"The name of the Company user role. This name is visible to system users and Company users."},"roleType":{"$ref":"#/components/schemas/CompaniesRolesGetResponsesContentApplicationJsonSchemaDataRoleType","description":"Indicates whether a Company user role is predefined or custom.\n\nIf this value is `1`, the role is predefined. If this value is `2`, the role is custom."},"roleLevel":{"$ref":"#/components/schemas/CompaniesRolesGetResponsesContentApplicationJsonSchemaDataRoleLevel","description":"Indicates how many Company accounts can view and assign the role to users. Currently, all Company roles are available at the store level, which has a value of `1`."}},"title":"CompaniesRolesGetResponsesContentApplicationJsonSchemaData"},"CompaniesRolesGetResponsesContentApplicationJsonSchemaMetaPagination":{"type":"object","properties":{"totalCount":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"}},"title":"CompaniesRolesGetResponsesContentApplicationJsonSchemaMetaPagination"},"CompaniesRolesGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"},"pagination":{"$ref":"#/components/schemas/CompaniesRolesGetResponsesContentApplicationJsonSchemaMetaPagination"}},"title":"CompaniesRolesGetResponsesContentApplicationJsonSchemaMeta"},"Company Roles and Permissions_get-stores-companies-roles_Response_200":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/CompaniesRolesGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesRolesGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Company Roles and Permissions_get-stores-companies-roles_Response_200"},"RoleRequestPermissionsItemsPermissionLevel":{"type":"string","enum":["1","2"],"description":"The scope level for permission.","title":"RoleRequestPermissionsItemsPermissionLevel"},"RoleRequestPermissionsItems":{"type":"object","properties":{"code":{"type":"string","description":"The [code string](/developer/api-reference/rest/b2b/management/company/companies#permission-code) for the permission."},"permissionLevel":{"$ref":"#/components/schemas/RoleRequestPermissionsItemsPermissionLevel","description":"The scope level for permission."}},"required":["code","permissionLevel"],"title":"RoleRequestPermissionsItems"},"role_REQUEST":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Company user role. This name is visible to system users and Company users."},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/RoleRequestPermissionsItems"}}},"required":["name","permissions"],"title":"role_REQUEST"},"RoleDetailResponseDataRoleType":{"type":"string","enum":["1","2"],"description":"Indicates whether a Company user role is predefined or custom.\n\nIf this value is `1`, the role is predefined. If this value is `2`, the role is custom.","title":"RoleDetailResponseDataRoleType"},"RoleDetailResponseDataRoleLevel":{"type":"string","enum":["1"],"description":"Indicates how many Company accounts can view and assign the role to users. Currently, all Company roles are available at the store level, which has a value of `1`.","title":"RoleDetailResponseDataRoleLevel"},"RoleDetailResponseDataPermissionsItemsPermissionLevel":{"type":"string","enum":["1","2"],"description":"The scope level for permission.","title":"RoleDetailResponseDataPermissionsItemsPermissionLevel"},"RoleDetailResponseDataPermissionsItems":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the Company user role."},"code":{"type":"string","description":"The [code string](/developer/api-reference/rest/b2b/management/company/companies#permission-code) for the permission."},"permissionLevel":{"$ref":"#/components/schemas/RoleDetailResponseDataPermissionsItemsPermissionLevel","description":"The scope level for permission."}},"title":"RoleDetailResponseDataPermissionsItems"},"RoleDetailResponseData":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the Company user role."},"name":{"type":"string","description":"The name of the Company user role. This name is visible to system users and Company users."},"roleType":{"$ref":"#/components/schemas/RoleDetailResponseDataRoleType","description":"Indicates whether a Company user role is predefined or custom.\n\nIf this value is `1`, the role is predefined. If this value is `2`, the role is custom."},"roleLevel":{"$ref":"#/components/schemas/RoleDetailResponseDataRoleLevel","description":"Indicates how many Company accounts can view and assign the role to users. Currently, all Company roles are available at the store level, which has a value of `1`."},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/RoleDetailResponseDataPermissionsItems"}}},"title":"RoleDetailResponseData"},"RoleDetailResponseMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"RoleDetailResponseMeta"},"roleDetail_RESPONSE":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/RoleDetailResponseData"},"meta":{"$ref":"#/components/schemas/RoleDetailResponseMeta"}},"title":"roleDetail_RESPONSE"},"CompaniesRolesRoleIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"CompaniesRolesRoleIdDeleteResponsesContentApplicationJsonSchemaData"},"CompaniesRolesRoleIdDeleteResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"CompaniesRolesRoleIdDeleteResponsesContentApplicationJsonSchemaMeta"},"Company Roles and Permissions_delete-stores-companies-roles-roleId_Response_200":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/CompaniesRolesRoleIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesRolesRoleIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"title":"Company Roles and Permissions_delete-stores-companies-roles-roleId_Response_200"},"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"required":["errMsg"],"title":"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData"},"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaMeta"},"Invoice_get-invoices-invoiceId_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData","description":"Extra Field Values"},"meta":{"$ref":"#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaMeta"}},"required":["meta"],"title":"Invoice_get-invoices-invoiceId_Response_200"},"Get-invoices-invoiceIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Get-invoices-invoiceIdRequestNotFoundError"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeaderCostLinesItemsAmount":{"type":"object","properties":{"code":{"type":"string"},"value":{"type":"string"}},"required":["code","value"],"title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeaderCostLinesItemsAmount"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeaderCostLinesItems":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeaderCostLinesItemsAmount"},"description":{"type":"string"}},"required":["amount","description"],"title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeaderCostLinesItems"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeaderBillingAddress":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipCode":{"type":"string"},"lastName":{"type":"string"},"firstName":{"type":"string"},"customFields":{"type":"string"}},"required":["city","state","country","street1","street2","zipCode","lastName","firstName","customFields"],"title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeaderBillingAddress"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeaderShippingAddressesItems":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipCode":{"type":"string"},"lastName":{"type":"string"},"firstName":{"type":"string"}},"required":["city","state","country","street1","street2","zipCode","lastName","firstName"],"title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeaderShippingAddressesItems"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeader":{"type":"object","properties":{"costLines":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeaderCostLinesItems"}},"billingAddress":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeaderBillingAddress"},"shippingAddresses":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeaderShippingAddressesItems"}}},"title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeader"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsShipmentsItems":{"type":"object","properties":{"addressIndex":{"type":"string"},"shipDate":{"type":"string"},"shipVia":{"type":"string"},"trackingNumber":{"type":"string"},"comments":{"type":"string"}},"required":["addressIndex","shipDate","shipVia","trackingNumber","comments"],"title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsShipmentsItems"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsUnitPrice":{"type":"object","properties":{"code":{"type":"string"},"value":{"type":"string"}},"required":["code","value"],"title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsUnitPrice"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsCustomFields":{"type":"object","properties":{"key":{"type":"string","description":"The custom field name."},"value":{"type":"string","description":"The custom field value."}},"description":"Adds custom information to the product.","title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsCustomFields"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsUnitDiscount":{"type":"object","properties":{"code":{"type":"string"},"value":{"type":"string"}},"required":["code","value"],"title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsUnitDiscount"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItems":{"type":"object","properties":{"sku":{"type":"string"},"type":{"type":"string"},"comments":{"type":"string"},"quantity":{"type":"string"},"unitPrice":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsUnitPrice"},"description":{"type":"string","description":"Product description or product name. This field is required for custom product."},"customFields":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsCustomFields","description":"Adds custom information to the product."},"unitDiscount":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsUnitDiscount"}},"required":["sku","quantity","unitPrice"],"title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItems"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetails":{"type":"object","properties":{"shipments":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsShipmentsItems"}},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItems"}}},"title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetails"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetails":{"type":"object","properties":{"header":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsHeader"},"details":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetailsDetails"}},"description":"Details that will show on the invoice. When updating this field, the new value will completely replace the existing details. To preserve existing details while making updates, retrieve the current details first, and make your edits to that object before submitting the changes.","title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaDetails"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaOriginalBalance":{"type":"object","properties":{"code":{"type":"string"},"value":{"type":"string"}},"required":["code","value"],"description":"Invoice original balance","title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaOriginalBalance"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaOpenBalance":{"type":"object","properties":{"code":{"type":"string"},"value":{"type":"string"}},"required":["code","value"],"description":"Invoice balance awaiting for payment","title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaOpenBalance"},"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems":{"type":"object","properties":{"fieldName":{"type":"string","description":"Field name that config in you store"},"fieldValue":{"type":"string","description":"Value of the extra field."}},"required":["fieldName","fieldValue"],"title":"InvoicesInvoiceIdPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems"},"InvoicesInvoiceIdPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Invoice ID"}},"required":["id"],"title":"InvoicesInvoiceIdPutResponsesContentApplicationJsonSchemaData"},"InvoicesInvoiceIdPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"InvoicesInvoiceIdPutResponsesContentApplicationJsonSchemaMeta"},"Invoice_put-invoices-invoiceId_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/InvoicesInvoiceIdPutResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Invoice_put-invoices-invoiceId_Response_200"},"InvoicesInvoiceIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"required":["errMsg"],"title":"InvoicesInvoiceIdDeleteResponsesContentApplicationJsonSchemaData"},"InvoicesInvoiceIdDeleteResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"InvoicesInvoiceIdDeleteResponsesContentApplicationJsonSchemaMeta"},"Invoice_delete-invoices-invoiceId_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/InvoicesInvoiceIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/InvoicesInvoiceIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Invoice_delete-invoices-invoiceId_Response_200"},"Delete-invoices-invoiceIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/InvoicesInvoiceIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/InvoicesInvoiceIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Delete-invoices-invoiceIdRequestNotFoundError"},"InvoicesGetParametersOrderBy":{"type":"string","enum":["DESC","ASC"],"title":"InvoicesGetParametersOrderBy"},"InvoicesGetParametersSortBy":{"type":"string","enum":["invoiceNumber","createdAt","customerId","externalCustomerId","dueDate","updatedAt","isPendingPayment","openBalance","originalBalance","status"],"title":"InvoicesGetParametersSortBy"},"InvoicesGetParametersSearchBy":{"type":"string","enum":["invoiceNumber","type","orderNumber","purchaseOrderNumber","customerId","externalCustomerId"],"title":"InvoicesGetParametersSearchBy"},"InvoicesGetParametersStatus":{"type":"string","enum":["0","1","2"],"title":"InvoicesGetParametersStatus"},"InvoicesGetParametersIsIncludeExtraFields":{"type":"string","enum":["0","1"],"title":"InvoicesGetParametersIsIncludeExtraFields"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderCostLinesItemsAmount":{"type":"object","properties":{"code":{"type":"string"},"value":{"type":"string"}},"required":["code","value"],"description":"cost amount","title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderCostLinesItemsAmount"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderCostLinesItems":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderCostLinesItemsAmount","description":"cost amount"},"description":{"type":"string","description":"cost description"}},"required":["amount","description"],"title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderCostLinesItems"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderBillingAddressCustomFields":{"type":"object","properties":{"key":{"type":"string","description":"custom field key"},"value":{"type":"string","description":"custom field value"}},"title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderBillingAddressCustomFields"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderBillingAddress":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipCode":{"type":"string"},"lastName":{"type":"string"},"firstName":{"type":"string"},"customFields":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderBillingAddressCustomFields"}},"required":["city","state","country","street1","street2","zipCode","lastName","firstName"],"description":"Invoice billing address","title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderBillingAddress"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderCustomerFields":{"type":"object","properties":{"key":{"type":"string","description":"custom field key"},"value":{"type":"string","description":"custom field value"}},"description":"User-defined additional fields","title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderCustomerFields"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderShippingAddressesItemsCustomFields":{"type":"object","properties":{"key":{"type":"string","description":"custom field key"},"value":{"type":"string","description":"custom field value"}},"title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderShippingAddressesItemsCustomFields"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderShippingAddressesItems":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipCode":{"type":"string"},"lastName":{"type":"string"},"firstName":{"type":"string"},"customFields":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderShippingAddressesItemsCustomFields"}},"required":["city","state","country","street1","street2","zipCode","lastName","firstName"],"title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderShippingAddressesItems"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeader":{"type":"object","properties":{"costLines":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderCostLinesItems"},"description":"Invoice cost information"},"orderDate":{"type":"number","format":"double","description":"Invoice order creation time"},"billingAddress":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderBillingAddress","description":"Invoice billing address"},"customerFields":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderCustomerFields","description":"User-defined additional fields"},"shippingAddresses":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeaderShippingAddressesItems"},"description":"Invoice shipping addresses"}},"required":["costLines","orderDate","billingAddress","shippingAddresses"],"title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeader"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsShipmentsItemsCustomFields":{"type":"object","properties":{"key":{"type":"string","description":"custom field key"},"value":{"type":"string","description":"custom field value"}},"title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsShipmentsItemsCustomFields"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsShipmentsItems":{"type":"object","properties":{"addressIndex":{"type":"string","description":"address ID"},"shipDate":{"type":"string","description":"Time of shipment"},"shipVia":{"type":"string"},"trackingNumber":{"type":"string","description":"tracking number"},"comments":{"type":"string","description":"comments"},"customFields":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsShipmentsItemsCustomFields"}},"required":["addressIndex","shipDate","shipVia","trackingNumber","comments"],"title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsShipmentsItems"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsLineItemsItemsUnitPrice":{"type":"object","properties":{"code":{"type":"string","description":"currency code"},"value":{"type":"string","description":"amount"}},"required":["code","value"],"description":"product unit price","title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsLineItemsItemsUnitPrice"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsLineItemsItemsCustomFields":{"type":"object","properties":{"key":{"type":"string","description":"custom field key"},"value":{"type":"string","description":"custom field value"}},"title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsLineItemsItemsCustomFields"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsLineItemsItemsUnitDiscount":{"type":"object","properties":{"code":{"type":"string","description":"currency code"},"value":{"type":"string","description":"amount"}},"required":["code","value"],"description":"product unit discount","title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsLineItemsItemsUnitDiscount"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsLineItemsItems":{"type":"object","properties":{"sku":{"type":"string","description":"Product sku"},"type":{"type":"string","description":"product type"},"comments":{"type":"string"},"quantity":{"type":"string","description":"product qyantity"},"unitPrice":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsLineItemsItemsUnitPrice","description":"product unit price"},"description":{"type":"string","description":"product description or product name"},"customFields":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsLineItemsItemsCustomFields"},"unitDiscount":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsLineItemsItemsUnitDiscount","description":"product unit discount"}},"required":["sku","type","comments","quantity","unitPrice","description","unitDiscount"],"title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsLineItemsItems"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetails":{"type":"object","properties":{"shipments":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsShipmentsItems"},"description":"Invoice shipments information"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetailsLineItemsItems"},"description":"Invoice Product Information"}},"required":["lineItems"],"title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetails"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetails":{"type":"object","properties":{"type":{"type":"string","description":"Invoice details type"},"header":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsHeader"},"details":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetailsDetails"}},"required":["type","header"],"description":"Invoice details","title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetails"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsSource":{"type":"string","enum":["0","1"],"description":"Source of invoice   0 for B2B Edition   1 for External","title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsSource"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsOriginalBalance":{"type":"object","properties":{"code":{"type":"string","description":"currency code"},"value":{"type":"string","description":"amount"}},"required":["code","value"],"description":"Origin balance","title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsOriginalBalance"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsOpenBalance":{"type":"object","properties":{"code":{"type":"string","description":"currency code"},"value":{"type":"string","description":"amount"}},"required":["code","value"],"description":"Invoice open balance","title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsOpenBalance"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsExtraFieldsItems":{"type":"object","properties":{"fieldName":{"type":"string","description":"Field name that config in you store"},"fieldValue":{"type":"string","description":"Value of the extra field."}},"required":["fieldName","fieldValue"],"title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsExtraFieldsItems"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Invoice ID"},"customerId":{"type":"string","description":"B2B Edition Company ID"},"externalCustomerId":{"type":"string","description":"ID of a company associated with a third party"},"externalId":{"type":"string","description":"The ID of the invoice associated with the third party"},"invoiceNumber":{"type":"string","description":"Invoice no."},"type":{"type":"string","description":"Invoice Type"},"dueDate":{"type":"number","format":"double","description":"Invoice due date"},"status":{"type":"number","format":"double","description":"Invoice status. If the balance is less than or equal to 0, then it will automatically update to status \"2\"."},"orderNumber":{"type":"string","description":"BigCommerce order ID"},"purchaseOrderNumber":{"type":"string","description":"PO no."},"details":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsDetails","description":"Invoice details"},"isPendingPayment":{"type":"number","format":"double"},"source":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsSource","description":"Source of invoice   0 for B2B Edition   1 for External"},"originalBalance":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsOriginalBalance","description":"Origin balance"},"openBalance":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsOpenBalance","description":"Invoice open balance"},"customerName":{"type":"string","description":"BigCommerce customer group name"},"createdAt":{"type":"string","description":"Invoice creation time"},"updatedAt":{"type":"string","description":"Invoice last updated time"},"channelId":{"type":"string","description":"BigCommerce channel id"},"channelName":{"type":"string","description":"Store Channel Name"},"termsConditions":{"type":"string","description":"Terms & Conditions. Visible on the default Invoice PDF."},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsExtraFieldsItems"}}},"required":["customerId","originalBalance","openBalance"],"description":"Extra Field Values","title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItems"},"InvoicesGetResponsesContentApplicationJsonSchemaMetaPagination":{"type":"object","properties":{"totalCount":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"}},"title":"InvoicesGetResponsesContentApplicationJsonSchemaMetaPagination"},"InvoicesGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"},"pagination":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaMetaPagination"}},"title":"InvoicesGetResponsesContentApplicationJsonSchemaMeta"},"Invoice_get-invoices_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Invoice_get-invoices_Response_200"},"InvoicesPostRequestBodyContentApplicationJsonSchemaStatus":{"type":"string","enum":["0","1","2"],"description":"Invoice status. Possible values:\n0: Open (default)\n1: Partially paid\n2: Completed\n\nThe status will automatically be set to Completed (2) when the open balance becomes zero or negative.","title":"InvoicesPostRequestBodyContentApplicationJsonSchemaStatus"},"InvoicesPostRequestBodyContentApplicationJsonSchemaOriginalBalance":{"type":"object","properties":{"code":{"type":"string","description":"Currency code"},"value":{"type":"number","format":"double","description":"Amount"}},"required":["code","value"],"description":"Original balance","title":"InvoicesPostRequestBodyContentApplicationJsonSchemaOriginalBalance"},"InvoicesPostRequestBodyContentApplicationJsonSchemaOpenBalance":{"type":"object","properties":{"code":{"type":"string","description":"Currency code"},"value":{"type":"number","format":"double","description":"Amount"}},"required":["code","value"],"description":"Open balance , when it is <= 0, status will be auto set to 2","title":"InvoicesPostRequestBodyContentApplicationJsonSchemaOpenBalance"},"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeaderCostLinesItemsAmount":{"type":"object","properties":{"code":{"type":"string","description":"currency code"},"value":{"type":"string","description":"amount"}},"required":["code","value"],"description":"cost amount","title":"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeaderCostLinesItemsAmount"},"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeaderCostLinesItems":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeaderCostLinesItemsAmount","description":"cost amount"},"description":{"type":"string","description":"Price description, e.g., subtotal or other types of prices or fees."}},"required":["amount","description"],"title":"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeaderCostLinesItems"},"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeaderBillingAddress":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipCode":{"type":"string"},"lastName":{"type":"string"},"firstName":{"type":"string"}},"required":["city","state","country","street1","street2","zipCode","lastName","firstName"],"description":"Invoice billing address. This field is optional. If provided, it should contain an object with address details.","title":"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeaderBillingAddress"},"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeaderShippingAddressesItems":{"type":"object","properties":{"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipCode":{"type":"string"},"lastName":{"type":"string"},"firstName":{"type":"string"}},"required":["city","state","country","street1","street2","zipCode","lastName","firstName"],"title":"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeaderShippingAddressesItems"},"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeader":{"type":"object","properties":{"costLines":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeaderCostLinesItems"},"description":"Invoice cost information. This field is optional. If provided, it should contain an array of cost line items. The information in this field will be displayed on the invoice detail page."},"billingAddress":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeaderBillingAddress","description":"Invoice billing address. This field is optional. If provided, it should contain an object with address details."},"shippingAddresses":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeaderShippingAddressesItems"},"description":"Invoice shipping address. This field is optional. If provided, it should contain an object with address details."}},"title":"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeader"},"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetailsShipmentsItems":{"type":"object","properties":{"addressIndex":{"type":"string","description":"address ID"},"shipDate":{"type":"string","description":"shipment time"},"shipVia":{"type":"string"},"trackingNumber":{"type":"string","description":"tracking number"},"comments":{"type":"string"}},"required":["addressIndex","shipDate","shipVia","trackingNumber","comments"],"title":"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetailsShipmentsItems"},"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsUnitPrice":{"type":"object","properties":{"code":{"type":"string","description":"currency code"},"value":{"type":"string","description":"amount"}},"required":["code","value"],"description":"product unit price","title":"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsUnitPrice"},"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsUnitDiscount":{"type":"object","properties":{"code":{"type":"string","description":"currency code"},"value":{"type":"string","description":"amount"}},"required":["code","value"],"description":"Product level discount details. This field is optional. If provided, it should contain a discount object.","title":"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsUnitDiscount"},"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItems":{"type":"object","properties":{"sku":{"type":"string","description":"product sku"},"type":{"type":"string","description":"product type"},"comments":{"type":"string"},"quantity":{"type":"string","description":"product quantity"},"unitPrice":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsUnitPrice","description":"product unit price"},"description":{"type":"string","description":"Product description or product name. This field is required for custom product."},"unitDiscount":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItemsUnitDiscount","description":"Product level discount details. This field is optional. If provided, it should contain a discount object."}},"required":["sku","quantity","unitPrice"],"title":"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItems"},"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetails":{"type":"object","properties":{"shipments":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetailsShipmentsItems"},"description":"Invoice shipments. This field is optional. If provided, it should contain an array of shipments. Required fields within each shipment object can be an empty string."},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetailsLineItemsItems"},"description":"Products within the invoice. This field is optional. If provided, it should contain an array of products."}},"title":"InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetails"},"InvoicesPostRequestBodyContentApplicationJsonSchemaDetails":{"type":"object","properties":{"header":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsHeader"},"details":{"$ref":"#/components/schemas/InvoicesPostRequestBodyContentApplicationJsonSchemaDetailsDetails"}},"description":"Invoice details","title":"InvoicesPostRequestBodyContentApplicationJsonSchemaDetails"},"InvoicesPostRequestBodyContentApplicationJsonSchemaSource":{"type":"string","enum":["0","1"],"description":"The source of the invoice. Possible values:\n0: B2B Edition\n1: External","title":"InvoicesPostRequestBodyContentApplicationJsonSchemaSource"},"InvoicesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems":{"type":"object","properties":{"fieldName":{"type":"string","description":"Field name that config in you store"},"fieldValue":{"type":"string","description":"Value of the extra field."}},"required":["fieldName","fieldValue"],"title":"InvoicesPostRequestBodyContentApplicationJsonSchemaExtraFieldsItems"},"InvoicesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Invoice ID"}},"title":"InvoicesPostResponsesContentApplicationJsonSchemaData"},"InvoicesPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"Success"},"errors":{"type":"string"}},"title":"InvoicesPostResponsesContentApplicationJsonSchemaMeta"},"Invoice_post-invoices_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double","description":"200"},"data":{"$ref":"#/components/schemas/InvoicesPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/InvoicesPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Invoice_post-invoices_Response_200"},"OrdersOrderIdInvoicesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"invoiceNumber":{"type":"string","description":"Invoice number"},"invoiceId":{"type":"number","format":"double","description":"Invoice ID"}},"required":["invoiceNumber","invoiceId"],"title":"OrdersOrderIdInvoicesPostResponsesContentApplicationJsonSchemaData"},"OrdersOrderIdInvoicesPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"string"}},"required":["message"],"title":"OrdersOrderIdInvoicesPostResponsesContentApplicationJsonSchemaMeta"},"Invoice_post-orders-orderId-invoices_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/OrdersOrderIdInvoicesPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/OrdersOrderIdInvoicesPostResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Invoice_post-orders-orderId-invoices_Response_200"},"InvoicesInvoiceIdDownloadPdfGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"title":"InvoicesInvoiceIdDownloadPdfGetResponsesContentApplicationJsonSchemaData"},"InvoicesInvoiceIdDownloadPdfGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"InvoicesInvoiceIdDownloadPdfGetResponsesContentApplicationJsonSchemaMeta"},"Invoice_get-invoices-invoiceId-download-pdf_Response_200":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/InvoicesInvoiceIdDownloadPdfGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/InvoicesInvoiceIdDownloadPdfGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Invoice_get-invoices-invoiceId-download-pdf_Response_200"},"Get-invoices-invoiceId-download-pdfRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/InvoicesInvoiceIdDownloadPdfGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/InvoicesInvoiceIdDownloadPdfGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Get-invoices-invoiceId-download-pdfRequestNotFoundError"},"InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaMetaPagination":{"type":"object","properties":{"limit":{"type":"integer","description":"Pagination limit default: 10"},"offset":{"type":"integer","description":"Pagination offset default: 0"},"totalCount":{"type":"integer","description":"The total number of the all data"}},"title":"InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaMetaPagination"},"InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"},"pagination":{"$ref":"#/components/schemas/InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaMetaPagination"}},"description":"Used to response pagination information","title":"InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaMeta"},"InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsFieldType":{"type":"string","enum":["0","1","2","3"],"description":"Field type of the extra field. 0 means text type. 1 means textarea type. 2 means number type. 3 means dropdown type.","title":"InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsFieldType"},"InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsConfigType":{"type":"string","enum":["1","2"],"description":"Extra field config type. 1 means built in. 2 means user defined.","title":"InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsConfigType"},"InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Unique id"},"uuid":{"type":"string","description":"UUID of the extra field"},"fieldName":{"type":"string","description":"Field name that config in you store"},"fieldType":{"$ref":"#/components/schemas/InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsFieldType","description":"Field type of the extra field. 0 means text type. 1 means textarea type. 2 means number type. 3 means dropdown type."},"isRequired":{"type":"boolean","description":"Is this field is required"},"isUnique":{"type":"boolean","description":"Is the value of this field is unique"},"visibleToEnduser":{"type":"boolean","description":"Is this field visible to end-user"},"configType":{"$ref":"#/components/schemas/InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItemsConfigType","description":"Extra field config type. 1 means built in. 2 means user defined."},"defaultValue":{"type":"string","description":"Default value of this field."},"maximumLength":{"type":"string","description":"The maximum length of the value of this field. fieldType == 0"},"numberOfRows":{"type":"string","description":"The maximum number of rows of the value of this field. fieldType == 1"},"maximumValue":{"type":"string","description":"Maximum value of the field value. fieldType == 2"},"listOfValue":{"type":"array","items":{"type":"string"},"description":"List of all optional values for the field value. fieldType == 3"}},"description":"Extra Fields","title":"InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItems"},"Invoice_get-invoices-extra-fields_Response_200":{"type":"object","properties":{"code":{"type":"integer","description":"Response code of success request."},"meta":{"$ref":"#/components/schemas/InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaMeta","description":"Used to response pagination information"},"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesExtraFieldsGetResponsesContentApplicationJsonSchemaDataItems"}}},"description":"Response for successful request","title":"Invoice_get-invoices-extra-fields_Response_200"},"PaymentsGetParametersOrderBy":{"type":"string","enum":["DESC","ASC"],"title":"PaymentsGetParametersOrderBy"},"PaymentsGetParametersSortBy":{"type":"string","enum":["moduleName","processingStatus","appliedStatus","createdAt","customerId","externalCustomerId","fundingStatus","updatedAt","totalAmount"],"title":"PaymentsGetParametersSortBy"},"PaymentsGetParametersSearchBy":{"type":"string","enum":["id","customerId","externalId","externalCustomerId"],"title":"PaymentsGetParametersSearchBy"},"PaymentsGetParametersProcessingStatus":{"type":"string","enum":["0","1","2","3","4"],"title":"PaymentsGetParametersProcessingStatus"},"paymentId":{"type":"integer","description":"The unique numeric ID for the payment method.","title":"paymentId"},"paymentCode":{"type":"string","description":"The string identifying the processor for the payment.","title":"paymentCode"},"paymentTitle":{"type":"string","description":"The label for the payment displayed to customers.","title":"paymentTitle"},"PaymentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/paymentId"},"paymentCode":{"$ref":"#/components/schemas/paymentCode"},"paymentTitle":{"$ref":"#/components/schemas/paymentTitle"}},"title":"PaymentsGetResponsesContentApplicationJsonSchemaDataItems"},"PaymentsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Success","description":"Human-readable status message."}},"title":"PaymentsGetResponsesContentApplicationJsonSchemaMeta"},"Payments_get-payments_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Payments_get-payments_Response_200"},"PaymentsPaymentIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"required":["errMsg"],"title":"PaymentsPaymentIdGetResponsesContentApplicationJsonSchemaData"},"PaymentsPaymentIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"PaymentsPaymentIdGetResponsesContentApplicationJsonSchemaMeta"},"Payments_get-payments-paymentId_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/PaymentsPaymentIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PaymentsPaymentIdGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Payments_get-payments-paymentId_Response_200"},"Get-payments-paymentIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/PaymentsPaymentIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PaymentsPaymentIdGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Get-payments-paymentIdRequestNotFoundError"},"PaymentsPaymentIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"required":["errMsg"],"title":"PaymentsPaymentIdDeleteResponsesContentApplicationJsonSchemaData"},"PaymentsPaymentIdDeleteResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"PaymentsPaymentIdDeleteResponsesContentApplicationJsonSchemaMeta"},"Payments_delete-a-payment_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/PaymentsPaymentIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PaymentsPaymentIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Payments_delete-a-payment_Response_200"},"Delete-a-paymentRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/PaymentsPaymentIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PaymentsPaymentIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Delete-a-paymentRequestNotFoundError"},"PaymentsPaymentIdOperationsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"required":["errMsg"],"title":"PaymentsPaymentIdOperationsGetResponsesContentApplicationJsonSchemaData"},"PaymentsPaymentIdOperationsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"PaymentsPaymentIdOperationsGetResponsesContentApplicationJsonSchemaMeta"},"Payments_get-payment-operations-operations_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/PaymentsPaymentIdOperationsGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PaymentsPaymentIdOperationsGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Payments_get-payment-operations-operations_Response_200"},"Get-payment-operations-operationsRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/PaymentsPaymentIdOperationsGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PaymentsPaymentIdOperationsGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Get-payment-operations-operationsRequestNotFoundError"},"PaymentsPaymentIdOperationsPostRequestBodyContentApplicationJsonSchemaOperationCode":{"type":"string","enum":["0","1","2","3"],"description":"Payment operation code. The list of allowed operations for this payment.","title":"PaymentsPaymentIdOperationsPostRequestBodyContentApplicationJsonSchemaOperationCode"},"PaymentsPaymentIdOperationsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"required":["errMsg"],"title":"PaymentsPaymentIdOperationsPostResponsesContentApplicationJsonSchemaData"},"PaymentsPaymentIdOperationsPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"PaymentsPaymentIdOperationsPostResponsesContentApplicationJsonSchemaMeta"},"Payments_post-payments-paymentId-operations_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/PaymentsPaymentIdOperationsPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PaymentsPaymentIdOperationsPostResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Payments_post-payments-paymentId-operations_Response_200"},"Post-payments-paymentId-operationsRequestBadRequestError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/PaymentsPaymentIdOperationsPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PaymentsPaymentIdOperationsPostResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Post-payments-paymentId-operationsRequestBadRequestError"},"PaymentsPaymentIdProcessingStatusPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"required":["errMsg"],"title":"PaymentsPaymentIdProcessingStatusPutResponsesContentApplicationJsonSchemaData"},"PaymentsPaymentIdProcessingStatusPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"PaymentsPaymentIdProcessingStatusPutResponsesContentApplicationJsonSchemaMeta"},"Payments_put-payments-paymentId-processing-status_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/PaymentsPaymentIdProcessingStatusPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PaymentsPaymentIdProcessingStatusPutResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Payments_put-payments-paymentId-processing-status_Response_200"},"Put-payments-paymentId-processing-statusRequestBadRequestError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/PaymentsPaymentIdProcessingStatusPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PaymentsPaymentIdProcessingStatusPutResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Put-payments-paymentId-processing-statusRequestBadRequestError"},"PaymentsPaymentIdTransactionsGetResponsesContentApplicationJsonSchemaDataItemsCard":{"type":"object","properties":{"type":{"type":"string"},"last4":{"type":"string"},"expiryYear":{"type":"number","format":"double"},"expiryMonth":{"type":"number","format":"double"}},"title":"PaymentsPaymentIdTransactionsGetResponsesContentApplicationJsonSchemaDataItemsCard"},"PaymentsPaymentIdTransactionsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"type":{"type":"string"},"gateway":{"type":"string"},"transactionId":{"type":"string"},"authCode":{"type":"string"},"event":{"type":"string"},"card":{"$ref":"#/components/schemas/PaymentsPaymentIdTransactionsGetResponsesContentApplicationJsonSchemaDataItemsCard"},"rawTransaction":{"type":"string"}},"required":["type","rawTransaction"],"title":"PaymentsPaymentIdTransactionsGetResponsesContentApplicationJsonSchemaDataItems"},"PaymentsPaymentIdTransactionsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"PaymentsPaymentIdTransactionsGetResponsesContentApplicationJsonSchemaMeta"},"Payments_get-payments-paymentId-transactions_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentsPaymentIdTransactionsGetResponsesContentApplicationJsonSchemaDataItems"},"description":"The array contains payment transaction information that varies and depends on the payment gateway."},"meta":{"$ref":"#/components/schemas/PaymentsPaymentIdTransactionsGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Payments_get-payments-paymentId-transactions_Response_200"},"PaymentsPaymentIdTransactionsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"required":["errMsg"],"title":"PaymentsPaymentIdTransactionsGetResponsesContentApplicationJsonSchemaData"},"Get-payments-paymentId-transactionsRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/PaymentsPaymentIdTransactionsGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PaymentsPaymentIdTransactionsGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Get-payments-paymentId-transactionsRequestNotFoundError"},"PaymentsOfflinePostRequestBodyContentApplicationJsonSchemaLineItemsItems":{"type":"object","properties":{"invoiceId":{"type":"number","format":"double"},"amount":{"type":"string"}},"required":["invoiceId","amount"],"title":"PaymentsOfflinePostRequestBodyContentApplicationJsonSchemaLineItemsItems"},"PaymentsOfflinePostRequestBodyContentApplicationJsonSchemaDetails":{"type":"object","properties":{"memo":{"type":"string"}},"title":"PaymentsOfflinePostRequestBodyContentApplicationJsonSchemaDetails"},"PaymentsOfflinePostRequestBodyContentApplicationJsonSchemaProcessingStatus":{"type":"string","enum":["1","2","3","4"],"description":"payment status, 3 is the default ","title":"PaymentsOfflinePostRequestBodyContentApplicationJsonSchemaProcessingStatus"},"PaymentsOfflinePostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"title":"PaymentsOfflinePostResponsesContentApplicationJsonSchemaData"},"PaymentsOfflinePostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"PaymentsOfflinePostResponsesContentApplicationJsonSchemaMeta"},"Payments_post-payments-offline_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/PaymentsOfflinePostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PaymentsOfflinePostResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Payments_post-payments-offline_Response_200"},"Post-payments-offlineRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"meta":{"$ref":"#/components/schemas/PaymentsOfflinePostResponsesContentApplicationJsonSchemaMeta"},"data":{"$ref":"#/components/schemas/PaymentsOfflinePostResponsesContentApplicationJsonSchemaData"}},"required":["code","meta","data"],"title":"Post-payments-offlineRequestUnprocessableEntityError"},"PaymentsOfflinePaymentIdPutRequestBodyContentApplicationJsonSchemaLineItemsItems":{"type":"object","properties":{"invoiceId":{"type":"number","format":"double"},"amount":{"type":"string"}},"required":["invoiceId","amount"],"title":"PaymentsOfflinePaymentIdPutRequestBodyContentApplicationJsonSchemaLineItemsItems"},"PaymentsOfflinePaymentIdPutRequestBodyContentApplicationJsonSchemaDetails":{"type":"object","properties":{"memo":{"type":"string"}},"title":"PaymentsOfflinePaymentIdPutRequestBodyContentApplicationJsonSchemaDetails"},"PaymentsOfflinePaymentIdPutRequestBodyContentApplicationJsonSchemaProcessingStatus":{"type":"string","enum":["1","2","3","4"],"title":"PaymentsOfflinePaymentIdPutRequestBodyContentApplicationJsonSchemaProcessingStatus"},"PaymentsOfflinePaymentIdPutRequestBodyContentApplicationJsonSchemaFundingStatus":{"type":"string","enum":["0","1","2","3"],"title":"PaymentsOfflinePaymentIdPutRequestBodyContentApplicationJsonSchemaFundingStatus"},"PaymentsOfflinePaymentIdPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"title":"PaymentsOfflinePaymentIdPutResponsesContentApplicationJsonSchemaData"},"PaymentsOfflinePaymentIdPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"PaymentsOfflinePaymentIdPutResponsesContentApplicationJsonSchemaMeta"},"Payments_put-payments-offline-paymentId_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/PaymentsOfflinePaymentIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/PaymentsOfflinePaymentIdPutResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Payments_put-payments-offline-paymentId_Response_200"},"Put-payments-offline-paymentIdRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"meta":{"$ref":"#/components/schemas/PaymentsOfflinePaymentIdPutResponsesContentApplicationJsonSchemaMeta"},"data":{"$ref":"#/components/schemas/PaymentsOfflinePaymentIdPutResponsesContentApplicationJsonSchemaData"}},"required":["code","meta","data"],"title":"Put-payments-offline-paymentIdRequestUnprocessableEntityError"},"ReceiptsGetParametersOrderBy":{"type":"string","enum":["DESC","ASC"],"default":"DESC","title":"ReceiptsGetParametersOrderBy"},"ReceiptsGetParametersSortBy":{"type":"string","enum":["customerId","externalCustomerId","paymentId","total","transactionType","referenceNumber","createdAt","updatedAt"],"default":"createdAt","title":"ReceiptsGetParametersSortBy"},"ReceiptsGetParametersSearchBy":{"type":"string","enum":["payerName","referenceNumber","customerId","externalId","externalCustomerId"],"title":"ReceiptsGetParametersSearchBy"},"ReceiptsGetParametersPaymentStatusSchemaItems":{"type":"string","enum":["0","1","2","3","4"],"title":"ReceiptsGetParametersPaymentStatusSchemaItems"},"ReceiptsGetResponsesContentApplicationJsonSchemaDataItemsDetailsPaymentDetails":{"type":"object","properties":{"memo":{"type":"string"}},"required":["memo"],"title":"ReceiptsGetResponsesContentApplicationJsonSchemaDataItemsDetailsPaymentDetails"},"ReceiptsGetResponsesContentApplicationJsonSchemaDataItemsDetails":{"type":"object","properties":{"paymentDetails":{"$ref":"#/components/schemas/ReceiptsGetResponsesContentApplicationJsonSchemaDataItemsDetailsPaymentDetails"}},"required":["paymentDetails"],"title":"ReceiptsGetResponsesContentApplicationJsonSchemaDataItemsDetails"},"ReceiptsGetResponsesContentApplicationJsonSchemaDataItemsTotal":{"type":"object","properties":{"code":{"type":"string"},"value":{"type":"string"}},"required":["code","value"],"title":"ReceiptsGetResponsesContentApplicationJsonSchemaDataItemsTotal"},"ReceiptsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"number","format":"double"},"createdAt":{"type":"number","format":"double"},"updatedAt":{"type":"number","format":"double"},"storeHash":{"type":"string"},"customerId":{"type":"string"},"externalId":{"type":["string","null"]},"externalCustomerId":{"type":["string","null"]},"payerName":{"type":"string"},"payerCustomerId":{"type":"string"},"details":{"$ref":"#/components/schemas/ReceiptsGetResponsesContentApplicationJsonSchemaDataItemsDetails"},"transactionType":{"type":"string"},"paymentType":{"type":"string"},"referenceNumber":{"type":"string"},"paymentId":{"type":"number","format":"double"},"total":{"$ref":"#/components/schemas/ReceiptsGetResponsesContentApplicationJsonSchemaDataItemsTotal"}},"required":["id","createdAt","updatedAt","storeHash","customerId","payerName","payerCustomerId","transactionType","paymentType","referenceNumber","paymentId"],"title":"ReceiptsGetResponsesContentApplicationJsonSchemaDataItems"},"ReceiptsGetResponsesContentApplicationJsonSchemaMetaPagination":{"type":"object","properties":{"totalCount":{"type":"number","format":"double"},"offset":{"type":"number","format":"double"},"limit":{"type":"number","format":"double"}},"required":["totalCount","offset","limit"],"title":"ReceiptsGetResponsesContentApplicationJsonSchemaMetaPagination"},"ReceiptsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/ReceiptsGetResponsesContentApplicationJsonSchemaMetaPagination"},"message":{"type":"string"}},"required":["pagination","message"],"title":"ReceiptsGetResponsesContentApplicationJsonSchemaMeta"},"Receipt_get-ip-receipts_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ReceiptsGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/ReceiptsGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Receipt_get-ip-receipts_Response_200"},"ReceiptsReceiptIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"required":["errMsg"],"title":"ReceiptsReceiptIdGetResponsesContentApplicationJsonSchemaData"},"ReceiptsReceiptIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"ReceiptsReceiptIdGetResponsesContentApplicationJsonSchemaMeta"},"Receipt_get-ip-receipts-receiptId_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/ReceiptsReceiptIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/ReceiptsReceiptIdGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Receipt_get-ip-receipts-receiptId_Response_200"},"Get-ip-receipts-receiptIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/ReceiptsReceiptIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/ReceiptsReceiptIdGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Get-ip-receipts-receiptIdRequestNotFoundError"},"ReceiptsReceiptIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"required":["errMsg"],"title":"ReceiptsReceiptIdDeleteResponsesContentApplicationJsonSchemaData"},"ReceiptsReceiptIdDeleteResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"ReceiptsReceiptIdDeleteResponsesContentApplicationJsonSchemaMeta"},"Receipt_delete-ip-receipts-receiptId_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double","description":"Response code of a successful request."},"data":{"$ref":"#/components/schemas/ReceiptsReceiptIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/ReceiptsReceiptIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"title":"Receipt_delete-ip-receipts-receiptId_Response_200"},"Delete-ip-receipts-receiptIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/ReceiptsReceiptIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/ReceiptsReceiptIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Delete-ip-receipts-receiptIdRequestNotFoundError"},"ReceiptLinesGetParametersOrderBy":{"type":"string","enum":["DESC","ASC"],"default":"DESC","title":"ReceiptLinesGetParametersOrderBy"},"ReceiptLinesGetParametersPaymentStatusSchemaItems":{"type":"string","enum":["0","1","2","3","4"],"title":"ReceiptLinesGetParametersPaymentStatusSchemaItems"},"ReceiptLinesGetParametersSearchBy":{"type":"string","enum":["customerId","externalId","externalCustomerId","payerName","payerCustomerId","referenceNumber","invoiceId"],"title":"ReceiptLinesGetParametersSearchBy"},"ReceiptLinesGetParametersSortBy":{"type":"string","enum":["customerId","externalCustomerId","receiptId","invoiceId","amount","createdAt","updatedAt"],"default":"createdAt","title":"ReceiptLinesGetParametersSortBy"},"ReceiptLinesGetResponsesContentApplicationJsonSchemaDataItemsAmount":{"type":"object","properties":{"code":{"type":"string"},"value":{"type":"string"}},"required":["code","value"],"title":"ReceiptLinesGetResponsesContentApplicationJsonSchemaDataItemsAmount"},"ReceiptLinesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"number","format":"double"},"createdAt":{"type":"number","format":"double"},"updatedAt":{"type":"number","format":"double"},"storeHash":{"type":"string"},"customerId":{"type":"string"},"externalId":{"type":["string","null"]},"externalCustomerId":{"type":["string","null"]},"receiptId":{"type":"number","format":"double"},"invoiceId":{"type":"number","format":"double"},"amount":{"$ref":"#/components/schemas/ReceiptLinesGetResponsesContentApplicationJsonSchemaDataItemsAmount"},"paymentStatus":{"type":"number","format":"double"},"paymentType":{"type":"string"},"invoiceNumber":{"type":"string"},"paymentId":{"type":"number","format":"double"},"referenceNumber":{"type":"string"},"transactionType":{"type":"string"}},"required":["id","createdAt","updatedAt","storeHash","customerId","externalId","externalCustomerId","receiptId","invoiceId","amount","paymentStatus","paymentType","invoiceNumber","paymentId","referenceNumber","transactionType"],"title":"ReceiptLinesGetResponsesContentApplicationJsonSchemaDataItems"},"ReceiptLinesGetResponsesContentApplicationJsonSchemaMetaPagination":{"type":"object","properties":{"totalCount":{"type":"number","format":"double"},"offset":{"type":"number","format":"double"},"limit":{"type":"number","format":"double"}},"required":["totalCount","offset","limit"],"title":"ReceiptLinesGetResponsesContentApplicationJsonSchemaMetaPagination"},"ReceiptLinesGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/ReceiptLinesGetResponsesContentApplicationJsonSchemaMetaPagination"},"message":{"type":"string"}},"required":["pagination","message"],"title":"ReceiptLinesGetResponsesContentApplicationJsonSchemaMeta"},"Receipt_get-ip-receipt-lines_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ReceiptLinesGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/ReceiptLinesGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Receipt_get-ip-receipt-lines_Response_200"},"ReceiptsReceiptIdLinesGetParametersOrderBy":{"type":"string","enum":["DESC","ASC"],"default":"DESC","title":"ReceiptsReceiptIdLinesGetParametersOrderBy"},"ReceiptsReceiptIdLinesGetParametersPaymentStatusSchemaItems":{"type":"string","enum":["0","1","2","3","4"],"title":"ReceiptsReceiptIdLinesGetParametersPaymentStatusSchemaItems"},"ReceiptsReceiptIdLinesGetParametersSearchBy":{"type":"string","enum":["customerId","externalId","externalCustomerId","payerName","payerCustomerId","referenceNumber","invoiceId"],"title":"ReceiptsReceiptIdLinesGetParametersSearchBy"},"ReceiptsReceiptIdLinesGetParametersSortBy":{"type":"string","enum":["customerId","externalCustomerId","receiptId","invoiceId","amount","createdAt","updatedAt"],"default":"createdAt","title":"ReceiptsReceiptIdLinesGetParametersSortBy"},"ReceiptsReceiptIdLinesGetResponsesContentApplicationJsonSchemaDataItemsAmount":{"type":"object","properties":{"code":{"type":"string"},"value":{"type":"string"}},"required":["code","value"],"title":"ReceiptsReceiptIdLinesGetResponsesContentApplicationJsonSchemaDataItemsAmount"},"ReceiptsReceiptIdLinesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"number","format":"double"},"createdAt":{"type":"number","format":"double"},"updatedAt":{"type":"number","format":"double"},"storeHash":{"type":"string"},"customerId":{"type":"string"},"externalId":{"type":["string","null"]},"externalCustomerId":{"type":["string","null"]},"receiptId":{"type":"number","format":"double"},"invoiceId":{"type":"number","format":"double"},"amount":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesGetResponsesContentApplicationJsonSchemaDataItemsAmount"},"paymentStatus":{"type":"number","format":"double"},"paymentType":{"type":"string"},"invoiceNumber":{"type":"string"},"paymentId":{"type":"number","format":"double"},"referenceNumber":{"type":"string"},"transactionType":{"type":"string"}},"required":["id","createdAt","updatedAt","storeHash","customerId","externalId","externalCustomerId","receiptId","invoiceId","amount","paymentStatus","paymentType","invoiceNumber","paymentId","referenceNumber","transactionType"],"title":"ReceiptsReceiptIdLinesGetResponsesContentApplicationJsonSchemaDataItems"},"ReceiptsReceiptIdLinesGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"ReceiptsReceiptIdLinesGetResponsesContentApplicationJsonSchemaMeta"},"Receipt_get-ip-lines-of-receipt_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Receipt_get-ip-lines-of-receipt_Response_200"},"ReceiptsReceiptIdLinesGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"required":["errMsg"],"title":"ReceiptsReceiptIdLinesGetResponsesContentApplicationJsonSchemaData"},"Get-ip-lines-of-receiptRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Get-ip-lines-of-receiptRequestNotFoundError"},"ReceiptsReceiptIdLinesReceiptLineIdGetResponsesContentApplicationJsonSchemaDataAmount":{"type":"object","properties":{"code":{"type":"string"},"value":{"type":"string"}},"required":["code","value"],"title":"ReceiptsReceiptIdLinesReceiptLineIdGetResponsesContentApplicationJsonSchemaDataAmount"},"ReceiptsReceiptIdLinesReceiptLineIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"number","format":"double"},"createdAt":{"type":"number","format":"double"},"updatedAt":{"type":"number","format":"double"},"storeHash":{"type":"string"},"customerId":{"type":"string"},"externalId":{"type":["string","null"]},"externalCustomerId":{"type":["string","null"]},"receiptId":{"type":"number","format":"double"},"invoiceId":{"type":"number","format":"double"},"amount":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesReceiptLineIdGetResponsesContentApplicationJsonSchemaDataAmount"},"paymentStatus":{"type":"number","format":"double"},"paymentType":{"type":"string"},"invoiceNumber":{"type":"string"},"paymentId":{"type":"number","format":"double"},"referenceNumber":{"type":"string"},"transactionType":{"type":"string"}},"required":["id","createdAt","updatedAt","storeHash","customerId","externalId","externalCustomerId","receiptId","invoiceId","amount","paymentStatus","paymentType","invoiceNumber","paymentId","referenceNumber","transactionType"],"title":"ReceiptsReceiptIdLinesReceiptLineIdGetResponsesContentApplicationJsonSchemaData"},"ReceiptsReceiptIdLinesReceiptLineIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"ReceiptsReceiptIdLinesReceiptLineIdGetResponsesContentApplicationJsonSchemaMeta"},"Receipt_get-ip-receipts-receiptId-lines-receiptLineId_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesReceiptLineIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesReceiptLineIdGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Receipt_get-ip-receipts-receiptId-lines-receiptLineId_Response_200"},"ReceiptsReceiptIdLinesReceiptLineIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the receipt line."}},"title":"ReceiptsReceiptIdLinesReceiptLineIdDeleteResponsesContentApplicationJsonSchemaData"},"ReceiptsReceiptIdLinesReceiptLineIdDeleteResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"Response message of the request"}},"title":"ReceiptsReceiptIdLinesReceiptLineIdDeleteResponsesContentApplicationJsonSchemaMeta"},"Receipt_delete-ip-receipts-receiptId-lines-receiptLineId_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double","description":"Response code of a successful request."},"data":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesReceiptLineIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/ReceiptsReceiptIdLinesReceiptLineIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"title":"Receipt_delete-ip-receipts-receiptId-lines-receiptLineId_Response_200"},"OrdersGetParametersOrderBy":{"type":"string","enum":["DESC","ASC"],"default":"DESC","title":"OrdersGetParametersOrderBy"},"OrdersGetParametersSortBy":{"type":"string","enum":["createdAt","updatedAt"],"default":"updatedAt","title":"OrdersGetParametersSortBy"},"OrdersGetResponsesContentApplicationJsonSchemaMetaPagination":{"type":"object","properties":{"totalCount":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"}},"title":"OrdersGetResponsesContentApplicationJsonSchemaMetaPagination"},"OrdersGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"},"pagination":{"$ref":"#/components/schemas/OrdersGetResponsesContentApplicationJsonSchemaMetaPagination"}},"title":"OrdersGetResponsesContentApplicationJsonSchemaMeta"},"id":{"type":"integer","description":"The unique identifier of the order in B2B Edition.","title":"id"},"bcOrderId":{"type":"integer","description":"The BigCommerce order ID.","title":"bcOrderId"},"totalIncTax":{"type":"string","title":"totalIncTax","description":"The order's total value including tax."},"poNumber":{"type":"string","description":"The order's Purchase Order (PO), if used.","title":"poNumber"},"status":{"type":"string","description":"The default name of the order status. See [Order Statuses](/developer/api-reference/rest/admin/management/orders/order-status) for a complete list of accepted status names. -","title":"status"},"customStatus":{"type":"string","description":"The customized name of the order status.","title":"customStatus"},"cartId":{"type":"integer","description":"The unique identifier of the cart generated for the order.","title":"cartId"},"items":{"type":"integer","description":"The total quantity of products in the order.","title":"items"},"usdIncTax":{"type":"string","title":"usdIncTax","description":"The order's total value in USD, including tax."},"companyId":{"type":"integer","description":"The unique numeric ID of a Company account.","title":"companyId"},"currencyCode":{"type":"string","description":"The three-letter code corresponding to the order’s currency.","title":"currencyCode"},"MoneyItemsCurrencyLocation":{"type":"string","enum":["left","right"],"description":"Determines whether the currency symbol is added to the left or the right of order pricing.","title":"MoneyItemsCurrencyLocation"},"MoneyItems":{"type":"object","properties":{"currencyLocation":{"$ref":"#/components/schemas/MoneyItemsCurrencyLocation","description":"Determines whether the currency symbol is added to the left or the right of order pricing."},"currencyToken":{"type":"string","description":"The currency symbol."},"decimalToken":{"type":"string","description":"The character used to separate the whole number from the decimal in order pricing."},"decimalPlaces":{"type":"integer","description":"The number of decimal places used in order pricing."},"thousandsToken":{"type":"string","description":"The character used to separate the hundredths and thousandths places in order pricing.\""}},"title":"MoneyItems"},"money":{"type":"array","items":{"$ref":"#/components/schemas/MoneyItems"},"description":"Contains detailed information regarding the order's currency.","title":"money"},"statusCode":{"type":"integer","description":"The numeric code associated with the order status. See [Order Statuses](/developer/api-reference/rest/admin/management/orders/order-status) for a complete list of accepted status names.","title":"statusCode"},"isArchived":{"type":"boolean","description":"Indicates whether the order is archived.","title":"isArchived"},"channelName":{"type":"string","description":"The name of the storefront channel where the order was placed.","title":"channelName"},"legacyExtraFields/properties/extraInt1":{"type":"integer","description":"A legacy integer extra field configuration that does not return data in newer stores.","title":"legacyExtraFields/properties/extraInt1"},"legacyExtraFields/properties/extraInt2":{"type":"integer","description":"A legacy integer extra field configuration that does not return data in newer stores.","title":"legacyExtraFields/properties/extraInt2"},"legacyExtraFields/properties/extraInt3":{"type":"integer","description":"A legacy integer extra field configuration that does not return data in newer stores.","title":"legacyExtraFields/properties/extraInt3"},"legacyExtraFields/properties/extraInt4":{"type":"integer","description":"A legacy integer extra field configuration that does not return data in newer stores.","title":"legacyExtraFields/properties/extraInt4"},"legacyExtraFields/properties/extraInt5":{"type":"integer","description":"A legacy integer extra field configuration that does not return data in newer stores.","title":"legacyExtraFields/properties/extraInt5"},"legacyExtraFields/properties/extraStr1":{"type":"string","description":"A legacy string extra field configuration that does not return data in newer stores.","title":"legacyExtraFields/properties/extraStr1"},"legacyExtraFields/properties/extraStr2":{"type":"string","description":"A legacy string extra field configuration that does not return data in newer stores.","title":"legacyExtraFields/properties/extraStr2"},"legacyExtraFields/properties/extraStr3":{"type":"string","description":"A legacy string extra field configuration that does not return data in newer stores.","title":"legacyExtraFields/properties/extraStr3"},"legacyExtraFields/properties/extraStr4":{"type":"string","description":"A legacy string extra field configuration that does not return data in newer stores.","title":"legacyExtraFields/properties/extraStr4"},"legacyExtraFields/properties/extraStr5":{"type":"string","description":"A legacy string extra field configuration that does not return data in newer stores.","title":"legacyExtraFields/properties/extraStr5"},"legacyExtraFields/properties/extraText":{"type":"string","description":"A legacy text extra field configuration that does not return data in newer stores.","title":"legacyExtraFields/properties/extraText"},"ExtraInfoItems":{"type":"object","properties":{"billingAddressId":{"type":"integer","description":"The unique identifier for billing address in the Company account."},"shippingAddressId":{"type":"integer","description":"The unique identifier for shipping address in the Company account."}},"title":"ExtraInfoItems"},"extraInfo":{"type":"array","items":{"$ref":"#/components/schemas/ExtraInfoItems"},"description":"Contains billing and shipping address identifiers.","title":"extraInfo"},"extraField_BASIC/properties/extraFields":{"type":"array","items":{"description":"Reference to OrdersBcOrderIdPutRequestBodyContentApplicationJsonSchemaExtraFieldsItems"},"description":"Contains extra field information associated with the order.","title":"extraField_BASIC/properties/extraFields"},"createdAt":{"type":"integer","description":"The [Unix timestamp](https://www.unixtimestamp.com/) for when the order was created. This is a read-only field.","title":"createdAt"},"updatedAt":{"type":"integer","description":"The [Unix timestamp](https://www.unixtimestamp.com/) for when the order was last updated. This is a read-only field.","title":"updatedAt"},"orderData_ALL":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"bcOrderId":{"$ref":"#/components/schemas/bcOrderId"},"totalIncTax":{"$ref":"#/components/schemas/totalIncTax"},"poNumber":{"$ref":"#/components/schemas/poNumber"},"status":{"$ref":"#/components/schemas/status"},"customStatus":{"$ref":"#/components/schemas/customStatus"},"cartId":{"$ref":"#/components/schemas/cartId"},"items":{"$ref":"#/components/schemas/items"},"usdIncTax":{"$ref":"#/components/schemas/usdIncTax"},"companyId":{"$ref":"#/components/schemas/companyId"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"money":{"$ref":"#/components/schemas/money"},"statusCode":{"$ref":"#/components/schemas/statusCode"},"isArchived":{"$ref":"#/components/schemas/isArchived"},"channelId":{"$ref":"#/components/schemas/channelId"},"channelName":{"$ref":"#/components/schemas/channelName"},"extraInt1":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraInt1"},"extraInt2":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraInt2"},"extraInt3":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraInt3"},"extraInt4":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraInt4"},"extraInt5":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraInt5"},"extraStr1":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraStr1"},"extraStr2":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraStr2"},"extraStr3":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraStr3"},"extraStr4":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraStr4"},"extraStr5":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraStr5"},"extraText":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraText"},"extraInfo":{"$ref":"#/components/schemas/extraInfo"},"extraFields":{"$ref":"#/components/schemas/extraField_BASIC/properties/extraFields"},"createdAt":{"$ref":"#/components/schemas/createdAt"},"updatedAt":{"$ref":"#/components/schemas/updatedAt"}},"title":"orderData_ALL"},"Orders_get-orders_Response_200":{"type":"object","properties":{"code":{"type":"integer"},"meta":{"$ref":"#/components/schemas/OrdersGetResponsesContentApplicationJsonSchemaMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/orderData_ALL"}}},"title":"Orders_get-orders_Response_200"},"bcOrderId_REQUEST/properties/bcOrderId":{"type":"integer","description":"The BigCommerce order ID.","title":"bcOrderId_REQUEST/properties/bcOrderId"},"createOrder":{"type":"object","properties":{"bcOrderId":{"$ref":"#/components/schemas/bcOrderId_REQUEST/properties/bcOrderId"},"customerId":{"$ref":"#/components/schemas/customerId"},"poNumber":{"$ref":"#/components/schemas/poNumber"},"extraFields":{"$ref":"#/components/schemas/extraField_BASIC/properties/extraFields"}},"required":["bcOrderId","customerId"],"title":"createOrder"},"Orders_post-orders_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/orderData_ALL"},"meta":{"$ref":"#/components/schemas/meta_full"}},"title":"Orders_post-orders_Response_200"},"OrdersPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"OrdersPostResponsesContentApplicationJsonSchemaData"},"OrdersPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"The order already exists."}},"required":["message"],"title":"OrdersPostResponsesContentApplicationJsonSchemaMeta"},"Post-ordersRequestBadRequestError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/OrdersPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/OrdersPostResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Post-ordersRequestBadRequestError"},"isInvoiceOrder":{"type":"integer","description":"Indicates whether or not the order is an invoice payment. Standard orders are `0`, while invoice payment orders are `1`.","title":"isInvoiceOrder"},"invoiceId":{"type":"integer","description":"The unique identifier for the invoice associated with an invoice payment order, if applicable.","title":"invoiceId"},"invoiceNumber":{"type":"integer","description":"The invoice number associated with an invoice payment order, if applicable.","title":"invoiceNumber"},"invoiceStatus":{"type":"integer","description":"The status code of the invoice associated with an invoice payment order, if applicable. The numeric codes correspond to the following statuses:\n\n- 0 - Open\n- 1 - Partially Paid\n- 2 - Paid","title":"invoiceStatus"},"orderData_DETAIL":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"bcOrderId":{"$ref":"#/components/schemas/bcOrderId"},"totalIncTax":{"$ref":"#/components/schemas/totalIncTax"},"poNumber":{"$ref":"#/components/schemas/poNumber"},"status":{"$ref":"#/components/schemas/status"},"customStatus":{"$ref":"#/components/schemas/customStatus"},"cartId":{"$ref":"#/components/schemas/cartId"},"items":{"$ref":"#/components/schemas/items"},"usdIncTax":{"$ref":"#/components/schemas/usdIncTax"},"companyId":{"$ref":"#/components/schemas/companyId"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"money":{"$ref":"#/components/schemas/money"},"statusCode":{"$ref":"#/components/schemas/statusCode"},"isArchived":{"$ref":"#/components/schemas/isArchived"},"channelId":{"$ref":"#/components/schemas/channelId"},"channelName":{"$ref":"#/components/schemas/channelName"},"isInvoiceOrder":{"$ref":"#/components/schemas/isInvoiceOrder"},"invoiceId":{"$ref":"#/components/schemas/invoiceId"},"invoiceNumber":{"$ref":"#/components/schemas/invoiceNumber"},"invoiceStatus":{"$ref":"#/components/schemas/invoiceStatus"},"extraInt1":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraInt1"},"extraInt2":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraInt2"},"extraInt3":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraInt3"},"extraInt4":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraInt4"},"extraInt5":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraInt5"},"extraStr1":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraStr1"},"extraStr2":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraStr2"},"extraStr3":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraStr3"},"extraStr4":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraStr4"},"extraStr5":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraStr5"},"extraText":{"$ref":"#/components/schemas/legacyExtraFields/properties/extraText"},"extraInfo":{"$ref":"#/components/schemas/extraInfo"},"extraFields":{"$ref":"#/components/schemas/extraField_BASIC/properties/extraFields"},"createdAt":{"$ref":"#/components/schemas/createdAt"},"updatedAt":{"$ref":"#/components/schemas/updatedAt"}},"title":"orderData_DETAIL"},"Orders_get-orders-orderId_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":"200","description":"HTTP Response Code"},"data":{"type":"array","items":{"$ref":"#/components/schemas/orderData_DETAIL"}}},"title":"Orders_get-orders-orderId_Response_200"},"OrdersBcOrderIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"OrdersBcOrderIdGetResponsesContentApplicationJsonSchemaData"},"OrdersBcOrderIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"Error message of this response"}},"title":"OrdersBcOrderIdGetResponsesContentApplicationJsonSchemaMeta"},"Get-orders-orderIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/OrdersBcOrderIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/OrdersBcOrderIdGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data"],"title":"Get-orders-orderIdRequestNotFoundError"},"Orders_put-orders-orderId_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":"200","description":"HTTP Response Code"},"data":{"type":"array","items":{"$ref":"#/components/schemas/orderData_DETAIL"}},"message":{"type":"string","default":"SUCCESS"}},"title":"Orders_put-orders-orderId_Response_200"},"OrdersBcOrderIdPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string","description":"Error message of this response"}},"title":"OrdersBcOrderIdPutResponsesContentApplicationJsonSchemaData"},"OrdersBcOrderIdPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"Error message of this response"}},"title":"OrdersBcOrderIdPutResponsesContentApplicationJsonSchemaMeta"},"Put-orders-orderIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/OrdersBcOrderIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/OrdersBcOrderIdPutResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data"],"title":"Put-orders-orderIdRequestNotFoundError"},"Put-orders-orderIdRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/OrdersBcOrderIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/OrdersBcOrderIdPutResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data"],"title":"Put-orders-orderIdRequestUnprocessableEntityError"},"CustomersCustomerIdOrdersCompanyPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"CustomersCustomerIdOrdersCompanyPutResponsesContentApplicationJsonSchemaData"},"Orders_put-orders-company_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":"200","description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/CustomersCustomerIdOrdersCompanyPutResponsesContentApplicationJsonSchemaData"},"message":{"type":"string","default":"SUCCESS"}},"title":"Orders_put-orders-company_Response_200"},"CustomersCustomerIdOrdersCompanyPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"Error message of this response"}},"title":"CustomersCustomerIdOrdersCompanyPutResponsesContentApplicationJsonSchemaMeta"},"Put-orders-companyRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/CustomersCustomerIdOrdersCompanyPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CustomersCustomerIdOrdersCompanyPutResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data"],"title":"Put-orders-companyRequestNotFoundError"},"OrderProductsOptionsItems":{"type":"object","properties":{"id":{"type":"integer","description":"The unique numerical ID of the option; increments sequentially."},"optionId":{"type":"integer","description":"The numeric ID of the associated option."},"productOptionId":{"type":"integer","description":"The numeric ID of the option within the order."},"orderProductId":{"type":"integer","description":"The unique identifier for the order product."},"displayName":{"type":"string","description":"Alias for `displayNameCustomer`. The product option name that is shown to customer in the storefront."},"displayNameCustomer":{"type":"string","description":"The product option name that is shown to customer in the storefront."},"displayNameMerchant":{"type":"string","description":"The internal option name in the control panel."},"displayValue":{"type":"string","description":"Alias for `displayValueCustomer`. The product option value that is shown to customer in storefront."},"displayValueCustomer":{"type":"string","description":"The product option value that is shown to customer in storefront."},"displayValueMerchant":{"type":"string","description":"The internal option value name in the control panel."},"value":{"type":"integer","description":"The unique identifier for the product’s selected option value."},"type":{"type":"string","description":"The type of option, which determines how it will display on the storefront."},"name":{"type":"string","description":"The option's name, as used internally. Options given an existing name have a numeric string added to them."},"displayStyle":{"type":"string","description":"Indicates how a multiple choice option is displayed on the storefront."}},"title":"OrderProductsOptionsItems"},"orderProducts":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the base product."},"productId":{"type":"integer","description":"The unique identifier for the base product."},"createdAt":{"type":"integer","description":"The [Unix timestamp](https://www.unixtimestamp.com/) for when the order was created. This is a read-only field."},"updatedAt":{"type":"integer","description":"The [Unix timestamp](https://www.unixtimestamp.com/) for when the order was last updated. This is a read-only field."},"productName":{"type":"string","description":"The name of the product."},"variantSku":{"type":"string","description":"The product's SKU."},"variantId":{"type":"integer","description":"The unique variant ID for the product."},"productBrandName":{"type":"string","description":"The product's brand."},"quantity":{"type":"integer","description":"Quantity number of product in this order."},"options":{"type":"array","items":{"$ref":"#/components/schemas/OrderProductsOptionsItems"},"description":"Contains information about the product's options."}},"title":"orderProducts"},"Orders_get-orders-orderId-products_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":"200","description":"HTTP Response Code"},"data":{"type":"array","items":{"$ref":"#/components/schemas/orderProducts"}},"message":{"type":"string","default":"SUCCESS"}},"title":"Orders_get-orders-orderId-products_Response_200"},"OrdersBcOrderIdProductsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"OrdersBcOrderIdProductsGetResponsesContentApplicationJsonSchemaData"},"OrdersBcOrderIdProductsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"Error message of this response"}},"title":"OrdersBcOrderIdProductsGetResponsesContentApplicationJsonSchemaMeta"},"Get-orders-orderId-productsRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/OrdersBcOrderIdProductsGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/OrdersBcOrderIdProductsGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data"],"title":"Get-orders-orderId-productsRequestNotFoundError"},"CustomersCustomerIdOrdersB2BPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"CustomersCustomerIdOrdersB2BPutResponsesContentApplicationJsonSchemaData"},"Orders_put-customers-customerId-orders-bc_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":"200","description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/CustomersCustomerIdOrdersB2BPutResponsesContentApplicationJsonSchemaData"},"message":{"type":"string","default":"SUCCESS"}},"title":"Orders_put-customers-customerId-orders-bc_Response_200"},"CustomersCustomerIdOrdersB2BPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"Error message of this response"}},"title":"CustomersCustomerIdOrdersB2BPutResponsesContentApplicationJsonSchemaMeta"},"Put-customers-customerId-orders-bcRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer"},"data":{"$ref":"#/components/schemas/CustomersCustomerIdOrdersB2BPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CustomersCustomerIdOrdersB2BPutResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data"],"title":"Put-customers-customerId-orders-bcRequestNotFoundError"},"OrdersExtraFieldsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{},"title":"OrdersExtraFieldsGetResponsesContentApplicationJsonSchemaDataItems"},"Orders_get-orders-extra-fields_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":"200","description":"HTTP Response Code"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OrdersExtraFieldsGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/meta_full"}},"title":"Orders_get-orders-extra-fields_Response_200"},"Payment_get-payments_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Payment_get-payments_Response_200"},"paymentEnabled":{"type":"boolean","description":"Indicates whether the payment is enabled for the specified Company.","title":"paymentEnabled"},"CompaniesCompanyIdPaymentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"paymentId":{"$ref":"#/components/schemas/paymentId"},"code":{"$ref":"#/components/schemas/paymentCode"},"paymentTitle":{"$ref":"#/components/schemas/paymentTitle"},"isEnabled":{"$ref":"#/components/schemas/paymentEnabled"}},"title":"CompaniesCompanyIdPaymentsGetResponsesContentApplicationJsonSchemaDataItems"},"CompaniesCompanyIdPaymentsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Success","description":"Human-readable status message."}},"title":"CompaniesCompanyIdPaymentsGetResponsesContentApplicationJsonSchemaMeta"},"Payment_get-companies-companyId-payments_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentsGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Payment_get-companies-companyId-payments_Response_200"},"CompaniesCompanyIdPaymentsPutRequestBodyContentApplicationJsonSchemaPaymentsItems":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/paymentCode"},"isEnabled":{"$ref":"#/components/schemas/paymentEnabled"}},"required":["code","isEnabled"],"title":"CompaniesCompanyIdPaymentsPutRequestBodyContentApplicationJsonSchemaPaymentsItems"},"CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{},"title":"CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaDataItems"},"CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable status message."}},"title":"CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaMeta"},"Payment_put-companies-companyId-payments_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaDataItems"},"default":[]},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Payment_put-companies-companyId-payments_Response_200"},"CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"title":"CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaData"},"Put-companies-companyId-paymentsRequestBadRequestError":{"type":"object","properties":{"code":{"type":"integer","default":400,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Put-companies-companyId-paymentsRequestBadRequestError"},"Put-companies-companyId-paymentsRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer","default":404,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentsPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Put-companies-companyId-paymentsRequestNotFoundError"},"CompanyPaymentMethodsGetParametersOrderBy":{"type":"string","enum":["DESC","ASC"],"title":"CompanyPaymentMethodsGetParametersOrderBy"},"CompanyPaymentMethodsGetParametersSortBy":{"type":"string","enum":["updatedAt","createdAt"],"default":"updatedAt","title":"CompanyPaymentMethodsGetParametersSortBy"},"CompanyPaymentMethodsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"companyId":{"type":"number","format":"double","description":"The unique numeric identifier for the Company. If the `companyId` parameter is specified, this will match across all records."},"paymentId":{"$ref":"#/components/schemas/paymentId"},"createdAt":{"type":"number","format":"double","description":"The [Unix Timestamp](https://www.unixtimestamp.com/) indicating when the payment method was enabled on the store."},"updatedAt":{"type":"number","format":"double","description":"The [Unix Timestamp](https://www.unixtimestamp.com/) indicating when the payment method was most recently updated."},"paymentMethodCode":{"$ref":"#/components/schemas/paymentCode"},"paymentMethodTitle":{"$ref":"#/components/schemas/paymentTitle"}},"title":"CompanyPaymentMethodsGetResponsesContentApplicationJsonSchemaDataItems"},"paginationObject":{"type":"object","properties":{"totalCount":{"type":"integer","description":"Total number of records available."},"limit":{"type":"integer","description":"The maximum number of records to return in the response."},"offset":{"type":"integer","description":"The number of records to skip before beginning response data."}},"title":"paginationObject"},"CompanyPaymentMethodsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Success","description":"Human-readable status message."},"pagination":{"$ref":"#/components/schemas/paginationObject"}},"title":"CompanyPaymentMethodsGetResponsesContentApplicationJsonSchemaMeta"},"Payment_get-company-payment-methods_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"type":"array","items":{"$ref":"#/components/schemas/CompanyPaymentMethodsGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/CompanyPaymentMethodsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Payment_get-company-payment-methods_Response_200"},"creditStatus":{"type":"object","properties":{"creditEnabled":{"type":"boolean","description":"Indicates whether credit is enabled for the Company."},"creditCurrency":{"type":"string","description":"The 3-character currency code of the Company's credit account."},"availableCredit":{"type":"number","format":"double","description":"The amount of credit available to the Company."},"limitPurchases":{"type":"boolean","description":"Indicates whether the Company users are allowed to make purchases using purchase orders when total price exceeds available credit."},"creditHold":{"type":"boolean","description":"Indicates whether the Company account is on a credit hold. If `true`, this flag prevents all Company users from making purchases."}},"title":"creditStatus"},"CompaniesCompanyIdCreditGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"API logic error","description":"Human-readable status message."}},"title":"CompaniesCompanyIdCreditGetResponsesContentApplicationJsonSchemaMeta"},"Payment_get-companies-companyId-credit_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/creditStatus"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdCreditGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Payment_get-companies-companyId-credit_Response_200"},"CompaniesCompanyIdCreditGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string","default":"Store company credit is not enabled"}},"title":"CompaniesCompanyIdCreditGetResponsesContentApplicationJsonSchemaData"},"Get-companies-companyId-creditRequestBadRequestError":{"type":"object","properties":{"code":{"type":"integer","default":400,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdCreditGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdCreditGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Get-companies-companyId-creditRequestBadRequestError"},"CompaniesCompanyIdCreditPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Success","description":"Human-readable status message."}},"title":"CompaniesCompanyIdCreditPutResponsesContentApplicationJsonSchemaMeta"},"Payment_put-companies-companyId-credit_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/creditStatus"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdCreditPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Payment_put-companies-companyId-credit_Response_200"},"TermsStatusPaymentTerms":{"type":"string","enum":["0","5","15","30","45","60"],"description":"The term set for the specified Company. This field takes the store-level default value if `isEnabled` is `false`.","title":"TermsStatusPaymentTerms"},"termsStatus":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"Indicates whether payment on terms is available for the specified Company."},"paymentTerms":{"$ref":"#/components/schemas/TermsStatusPaymentTerms","description":"The term set for the specified Company. This field takes the store-level default value if `isEnabled` is `false`."}},"title":"termsStatus"},"CompaniesCompanyIdPaymentTermsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Success","description":"Human-readable status message."}},"title":"CompaniesCompanyIdPaymentTermsGetResponsesContentApplicationJsonSchemaMeta"},"Payment_get-companies-companyId-payment-terms_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/termsStatus"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentTermsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Payment_get-companies-companyId-payment-terms_Response_200"},"CompaniesCompanyIdPaymentTermsPutRequestBodyContentApplicationJsonSchemaPaymentTerms":{"type":"string","enum":["0","5","15","30","45","60"],"description":"The term set for the specified Company. This field takes the store-level default value if `isEnabled` is `false`.","title":"CompaniesCompanyIdPaymentTermsPutRequestBodyContentApplicationJsonSchemaPaymentTerms"},"CompaniesCompanyIdPaymentTermsPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Bad Requests Error","description":"Human-readable status message."}},"title":"CompaniesCompanyIdPaymentTermsPutResponsesContentApplicationJsonSchemaMeta"},"Payment_put-companies-companyId-payment-terms_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/termsStatus"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentTermsPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Payment_put-companies-companyId-payment-terms_Response_200"},"CompaniesCompanyIdPaymentTermsPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string","default":"Payment terms value error, must be in [0, 5, 15, 30, 45, 60]; "}},"title":"CompaniesCompanyIdPaymentTermsPutResponsesContentApplicationJsonSchemaData"},"Put-companies-companyId-payment-termsRequestBadRequestError":{"type":"object","properties":{"code":{"type":"integer","default":400,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentTermsPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdPaymentTermsPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Put-companies-companyId-payment-termsRequestBadRequestError"},"RfqGetParametersSortBy":{"type":"string","enum":["company","status","salesRep","createdAt","expiredAt","updatedAt"],"default":"updatedAt","title":"RfqGetParametersSortBy"},"RfqGetParametersOrderBy":{"type":"string","enum":["asc","desc"],"default":"desc","title":"RfqGetParametersOrderBy"},"RfqGetParametersStatus":{"type":"string","enum":["0","2","3","4","5","6","7"],"title":"RfqGetParametersStatus"},"RfqGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"channel_id_list":{"type":"array","items":{"type":"array","items":{"type":"string","default":"A valid integer is required."}}}},"title":"RfqGetResponsesContentApplicationJsonSchemaData"},"Quotes_get-rfq_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double","default":200,"description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/RfqGetResponsesContentApplicationJsonSchemaData"},"message":{"type":"string","default":"SUCCESS"}},"title":"Quotes_get-rfq_Response_200"},"RfqGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Bad Requests Error"}},"title":"RfqGetResponsesContentApplicationJsonSchemaMeta"},"Get-rfqRequestBadRequestError":{"type":"object","properties":{"code":{"type":"integer","default":400,"description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/RfqGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/RfqGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Get-rfqRequestBadRequestError"},"QuoteDataPutPostCurrencyLocation":{"type":"string","enum":["left","right"],"description":"Determines whether the currency symbol is added to the left or the right of quote pricing.","title":"QuoteDataPutPostCurrencyLocation"},"QuoteDataPutPostCurrency":{"type":"object","properties":{"token":{"type":"string","description":"The currency symbol."},"location":{"$ref":"#/components/schemas/QuoteDataPutPostCurrencyLocation","description":"Determines whether the currency symbol is added to the left or the right of quote pricing."},"currencyCode":{"type":"string","description":"The three-letter code corresponding to the quote’s currency."},"decimalToken":{"type":"string","description":"The character used to separate decimal values in quote pricing."},"decimalPlaces":{"type":"integer","description":"The number of decimal places displayed in quote pricing. You can display a maximum of 4 decimal places."},"thousandsToken":{"type":"string","description":"The character used to separate the hundredths and thousandths places in quote pricing."},"currencyExchangeRate":{"type":"number","format":"double","description":"Overrides the built-in exchange rate between your store’s default currency and the quote’s selected currency. If left blank, the exchange rate defined in your store’s settings is used."}},"title":"QuoteDataPutPostCurrency"},"ExtraFieldsItems":{"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the quote extra field."},"fieldValue":{"type":"string","description":"The value of the quote extra field."}},"title":"ExtraFieldsItems"},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/ExtraFieldsItems"},"description":"Adds extra field information to the quote. This is required if your store has required quote extra fields. If you include the array in the request, you must include all of its fields.","title":"extraFields"},"ProductListItemsOptionsItems":{"type":"object","properties":{"optionId":{"type":"integer","description":"The unique identifier for the line item’s variant or modifier option."},"optionValue":{"type":"string","description":"The unique identifier for the line item’s selected option value."},"optionLabel":{"type":"string","description":"The name of the line item’s selected option value."},"optionName":{"type":"string","description":"The name of the line item’s variant or modifier option."}},"title":"ProductListItemsOptionsItems"},"ProductListItems":{"type":"object","properties":{"productId":{"type":"integer","description":"The unique identifier for the base line item."},"productName":{"type":"string","description":"The name of the line item."},"variantId":{"type":"integer","description":"The unique identifier for the line item variant."},"sku":{"type":"string","description":"The line item’s SKU."},"basePrice":{"type":"number","format":"double","description":"The line item’s price before any discounts are applied."},"discount":{"type":"number","format":"double","description":"The discount percentage applied to the line item."},"offeredPrice":{"type":"number","format":"double","description":"The line item’s price after any discounts are applied. You can also use this field to override the base price without specifying a `discount` value."},"quantity":{"type":"integer","description":"The quantity of the line item."},"orderQuantityMaximum":{"type":"integer","description":"The maximum number of line item units that can be added to the quote. To set an unlimited order quantity, omit this field or use a value of `0`."},"orderQuantityMinimum":{"type":"integer","description":"The minimum number of line item units that can be added to the quote. To set a minimum quantity of zero, omit this field or use a value of `0`."},"imageUrl":{"type":"string","description":"The URL for the line item image on your storefront."},"options":{"type":"array","items":{"$ref":"#/components/schemas/ProductListItemsOptionsItems"},"description":"Variant and modifier option information for the line item. This array is required if the line item has variant options."}},"title":"ProductListItems"},"productList":{"type":"array","items":{"$ref":"#/components/schemas/ProductListItems"},"description":"Line item information for the quote. If you add this array to the request, you must include all existing line items that you want to keep in the quote.","title":"productList"},"companyAddress":{"type":"object","properties":{"address":{"type":"string","description":"The first line of the address."},"apartment":{"type":"string","description":"The second line of the address."},"city":{"type":"string","description":"The city on the address."},"state":{"type":"string","description":"The full name of the state on the address."},"zipCode":{"type":"string","description":"The postal code on the address."},"country":{"type":"string","description":"The full name of the country on the address."}},"title":"companyAddress"},"contactInfo":{"type":"object","properties":{"name":{"type":"string","description":"The buyer’s full name."},"email":{"type":"string","format":"email","description":"The buyer’s email address."},"companyName":{"type":"string","description":"The name of the Company associated with the quote’s buyer. For B2C customers and guest shoppers, this is the name of their business, if provided."},"phoneNumber":{"type":"string","description":"The buyer’s phone number."}},"description":"Contact information for the buyer on the quote. Display-only metadata; not used to resolve or validate the linked customer or Company record.","title":"contactInfo"},"QuoteDataPostShippingAddress":{"type":"object","properties":{},"title":"QuoteDataPostShippingAddress"},"QuoteDataPostContactInfo":{"type":"object","properties":{},"title":"QuoteDataPostContactInfo"},"QuoteDataPostExtraFields":{"type":"object","properties":{},"title":"QuoteDataPostExtraFields"},"QuoteDataPostProductListItemsOptions":{"type":"object","properties":{},"title":"QuoteDataPostProductListItemsOptions"},"QuoteDataPostProductListItems":{"type":"object","properties":{"options":{"$ref":"#/components/schemas/QuoteDataPostProductListItemsOptions"}},"title":"QuoteDataPostProductListItems"},"quoteData_POST":{"type":"object","properties":{"subtotal":{"type":"number","format":"double","description":"The quoted total after discounts and before shipping and tax. If you are updating the line items or discounts on a quote, you must also update the subtotal to reflect the new pricing."},"channelId":{"type":"integer","default":1,"description":"The storefront channel ID associated with the quote. This is required if your store has multiple storefront channels. Use `1` for your store’s default storefront channel."},"quoteTitle":{"type":"string","description":"The external title given to the quote."},"referenceNumber":{"type":"string","description":"An identifier for the quote that can be supplied by the sales rep or the buyer, such as a Purchase Order number."},"currency":{"$ref":"#/components/schemas/QuoteDataPutPostCurrency"},"extraFields":{"$ref":"#/components/schemas/QuoteDataPostExtraFields"},"notes":{"type":"string","description":"The quote’s buyer-facing notes. Use the newline character `\n` to separate each line of text."},"discount":{"type":"number","format":"double","description":"The total value of discounts applied to the quote."},"grandTotal":{"type":"number","format":"double","description":"The quoted total after discounts, shipping, and tax are applied. If you are updating the line items or discounts on a quote, you must also update the grand total to reflect the new pricing."},"legalTerms":{"type":"string","description":"The quote’s terms and conditions. Use the newline character `\n` to separate each line of text. Omitting this field or leaving it blank does not add your store’s default terms and conditions to the quote. Instead, the quote will not display any terms."},"displayDiscount":{"type":"boolean","description":"Determines if buyers can see quoted discount values in the Buyer Portal, or if they only see the quoted prices. If left blank, the quote uses the discount display selection in your Quote settings."},"allowCheckout":{"type":"boolean","description":"Determines whether or not the buyer can take the quote to the checkout page. If left blank, the quote uses the checkout selection in your Quote settings."},"productList":{"type":"array","items":{"$ref":"#/components/schemas/QuoteDataPostProductListItems"}},"shippingAddress":{"$ref":"#/components/schemas/QuoteDataPostShippingAddress"},"contactInfo":{"$ref":"#/components/schemas/QuoteDataPostContactInfo"},"message":{"type":"string","description":"A message sent to the buyer via the in-quote messaging system."},"userEmail":{"type":"string","format":"email","description":"The email address of the quote’s sales rep. Any user email found within the B2B Edition System Users menu is considered a valid value for this field.\n\nThis field is optional. If left blank, it will default to the store owner's email address as shown in the B2B Edition System Users menu."},"expiredAt":{"type":"string","description":"The date when the buyer can no longer purchase the quote. Use '%m/%d/%Y' format when entering the expiration date."},"totalAmount":{"type":"number","format":"double","description":"The total price of the quote after any discounts."},"bcCustomerId":{"type":"integer","description":"The BigCommerce customer ID to link the quote to a registered non-company customer account. Ignored when `companyId` is also provided. Returns a 404 error if the customer ID does not exist."},"companyId":{"type":"integer","description":"The unique identifier for the Company account associated with the quote. This field is required when creating a quote for a Company account. If the company ID does not exist, the API returns a 404 error."}},"required":["totalAmount","productList"],"title":"quoteData_POST"},"quoteId":{"type":"integer","description":"The internal numeric ID of the sales quote.","title":"quoteId"},"quoteUrl":{"type":"string","description":"The storefront URL for the quote.","title":"quoteUrl"},"quote_PUT_POST":{"type":"object","properties":{"quoteId":{"$ref":"#/components/schemas/quoteId"},"quoteUrl":{"$ref":"#/components/schemas/quoteUrl"}},"title":"quote_PUT_POST"},"Quotes_post-rfq_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double","default":200,"description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/quote_PUT_POST"},"message":{"type":"string","default":"SUCCESS"}},"title":"Quotes_post-rfq_Response_200"},"ResponseErrorData":{"type":"object","properties":{"errMsg":{"type":"string"}},"title":"ResponseErrorData"},"ResponseErrorMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"ResponseErrorMeta"},"responseError":{"type":"object","properties":{"code":{"type":"number","format":"double","description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/ResponseErrorData"},"meta":{"$ref":"#/components/schemas/ResponseErrorMeta"}},"title":"responseError"},"RfqCustomShippingMethodsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"customShippingMethodName":{"type":"string","description":"The name of the custom shipping method."}},"title":"RfqCustomShippingMethodsGetResponsesContentApplicationJsonSchemaDataItems"},"RfqCustomShippingMethodsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"}},"title":"RfqCustomShippingMethodsGetResponsesContentApplicationJsonSchemaMeta"},"Quotes_get-rfq-quote_id-custom-shipping_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"HTTP Response Code"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RfqCustomShippingMethodsGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/RfqCustomShippingMethodsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Quotes_get-rfq-quote_id-custom-shipping_Response_200"},"RfqEmailsPostRequestBodyContentApplicationJsonSchemaEmailTemplate":{"type":"string","enum":["Simple","Simple with Pictures","Waves with Pictures","Sky","Dots","Database with checkout button","Modern with checkout link","Modern without checkout link"],"description":"The template used to format the quote email.","title":"RfqEmailsPostRequestBodyContentApplicationJsonSchemaEmailTemplate"},"RfqEmailsPostRequestBodyContentApplicationJsonSchemaEmailLang":{"type":"string","enum":["en","nl","de","fr","it","ja","zh","es"],"description":"The two-letter code for the language of the quote email and PDF, if included.","title":"RfqEmailsPostRequestBodyContentApplicationJsonSchemaEmailLang"},"ResponseWithMessageData":{"type":"object","properties":{},"title":"ResponseWithMessageData"},"responseWithMessage":{"type":"object","properties":{"code":{"type":"number","format":"double","default":200,"description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/ResponseWithMessageData"},"message":{"type":"string","default":"SUCCESS"}},"title":"responseWithMessage"},"RfqEmailsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"email_lang":{"type":"array","items":{"type":"string"}}},"title":"RfqEmailsPostResponsesContentApplicationJsonSchemaData"},"RfqEmailsPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"RfqEmailsPostResponsesContentApplicationJsonSchemaMeta"},"Post-rfq-emailsRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"number","format":"double","description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/RfqEmailsPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/RfqEmailsPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-rfq-emailsRequestUnprocessableEntityError"},"RfqExtraFieldsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"},"pagination":{"$ref":"#/components/schemas/responsePagination"}},"title":"RfqExtraFieldsGetResponsesContentApplicationJsonSchemaMeta"},"Quotes_get-rfq-extra-fields_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"HTTP Response Code"},"data":{"type":"array","items":{"description":"Any type"}},"meta":{"$ref":"#/components/schemas/RfqExtraFieldsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Quotes_get-rfq-extra-fields_Response_200"},"QuoteDataGetOneStatus":{"type":"string","enum":["0","2","3","4","5","6","7"],"description":"The numeric ID associated with the quote’s status. See [Quote Statuses](#quote-statuses) to learn about the statuses that correspond to each ID.","title":"QuoteDataGetOneStatus"},"orderId":{"type":"string","description":"The B2B Edition internal order ID. Note that this is different from the BigCommerce order ID returned in the `bcOrderId` field.","title":"orderId"},"QuoteDataGetOneCurrencyLocation":{"type":"string","enum":["left","right"],"description":"Determines whether the currency symbol is added to the left or the right of quote pricing.","title":"QuoteDataGetOneCurrencyLocation"},"QuoteDataGetOneCurrency":{"type":"object","properties":{"token":{"type":"string","description":"The currency symbol."},"location":{"$ref":"#/components/schemas/QuoteDataGetOneCurrencyLocation","description":"Determines whether the currency symbol is added to the left or the right of quote pricing."},"currencyCode":{"type":"string","description":"The three-letter code corresponding to the quote’s currency."},"decimalToken":{"type":"string","description":"The character used to separate decimal values in quote pricing."},"decimalPlaces":{"type":"integer","description":"The number of decimal places displayed in quote pricing. You can display a maximum of 4 decimal places."},"thousandsToken":{"type":"string","description":"The character used to separate the hundredths and thousandths places in quote pricing."},"currencyExchangeRate":{"type":"number","format":"double","description":"Overrides the built-in exchange rate between your store’s default currency and the quote’s selected currency. If left blank, the exchange rate defined in your store’s settings is used."}},"title":"QuoteDataGetOneCurrency"},"QuoteDataGetOneDiscountType":{"type":"string","enum":["0","1","2"],"description":"Indicates whether the quote uses line item discounts (0), percentage discounts (1), or fixed amount discounts (2).","title":"QuoteDataGetOneDiscountType"},"QuoteDataGetOneShippingMethodType":{"type":"string","enum":["custom","provider_methodtype","shipping_flatrate"],"description":"The type of shipping method added to the quote. Custom shipping methods appear as `custom`, while static and real-time shipping methods appear as `provider_methodtype`, like `shipping_flatrate`.","title":"QuoteDataGetOneShippingMethodType"},"QuoteDataGetOneShippingMethod":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the shipping method."},"b2bId":{"type":"integer","description":"The unique identifier for custom shipping methods. This is the same value as the id value in the shipping array."},"imageUrl":{"type":"string","description":"The URL of the logo image for the shipping provider, if the quote has a real-time shipping method."},"isCustom":{"type":"boolean","description":"Indicates whether or not the quote is using a custom shipping method."},"transitTime":{"type":"string","description":"The estimated delivery time for a real-time shipping method."},"additionalDescription":{"type":"string","description":"A secondary description found on some real-time shipping methods."},"type":{"$ref":"#/components/schemas/QuoteDataGetOneShippingMethodType","description":"The type of shipping method added to the quote. Custom shipping methods appear as `custom`, while static and real-time shipping methods appear as `provider_methodtype`, like `shipping_flatrate`."},"cost":{"type":"number","format":"double","description":"The shipping rate on the quote."},"description":{"type":"string","description":"The name of the shipping method."}},"title":"QuoteDataGetOneShippingMethod"},"QuoteDataGetOneBillingAddress":{"type":"object","properties":{"address":{"type":"string","description":"The first line of the address."},"apartment":{"type":"string","description":"The second line of the address."},"city":{"type":"string","description":"The city on the address."},"state":{"type":"string","description":"The full name of the state on the address."},"zipCode":{"type":"string","description":"The postal code on the address."},"country":{"type":"string","description":"The full name of the country on the address."},"label":{"type":"string","description":"The address label specified in the Company account."},"firstName":{"type":"string","description":"The buyer’s first name on the address."},"lastName":{"type":"string","description":"The buyer’s last name on the address."},"addressId":{"type":"number","format":"double","description":"The unique identifier for addresses associated with Company accounts."},"stateCode":{"type":"string","description":"The two-letter code for the state on the address."},"countryCode":{"type":"string","description":"The two-letter code for the country on the address."}},"title":"QuoteDataGetOneBillingAddress"},"QuoteDataGetOneStoreInfo":{"type":"object","properties":{"storeName":{"type":"string","description":"The name of the storefront."},"storeAddress":{"type":"string","description":"The storefront’s full origin address. The newline character \n is used to separate each line of text."},"storeCountry":{"type":"string","description":"The full name of the storefront’s origin country."},"storeLogo":{"type":"string","description":"The image URL for the storefront logo."}},"title":"QuoteDataGetOneStoreInfo"},"QuoteDataGetOneCompanyInfo":{"type":"object","properties":{"companyId":{"type":"integer","description":"The unique identifier for the Company account."},"companyName":{"type":"string","description":"The Company account name."},"companyAddress":{"type":"string","description":"The first line of the primary address for the Company account."},"companyCity":{"type":"string","description":"The city of the primary address for the Company account."},"companyState":{"type":"string","description":"The state of the primary address for the Company account, if applicable."},"companyZipCode":{"type":"string","description":"The postal code of the primary address for the Company account."},"companyCountry":{"type":"string","description":"The full name of the country on the primary address of the Company account."},"companyphoneNumber":{"type":"string","description":"The phone number associated with the Company account."}},"title":"QuoteDataGetOneCompanyInfo"},"QuoteDataGetOneSalesRepInfo":{"type":"object","properties":{"salesRepName":{"type":"string","description":"The name of the sales rep."},"salesRepEmail":{"type":"string","format":"email","description":"The sales rep’s email address."},"salesRepPhoneNumber":{"type":"string","description":"The sales rep’s phone number."}},"title":"QuoteDataGetOneSalesRepInfo"},"QuoteDataGetOneStorefrontAttachFilesItems":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier assigned to the file attachment."},"fileName":{"type":"string","description":"The attachment’s file name."},"fileType":{"type":"string","description":"The attachment’s file type."},"fileUrl":{"type":"string","description":"The download link for the attachment file."}},"title":"QuoteDataGetOneStorefrontAttachFilesItems"},"QuoteDataGetOneBackendAttachFilesItems":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier assigned to the file attachment."},"fileName":{"type":"string","description":"The attachment’s file name."},"fileType":{"type":"string","description":"The attachment’s file type."},"fileUrl":{"type":"string","description":"The download link for the attachment file."}},"title":"QuoteDataGetOneBackendAttachFilesItems"},"QuoteDataGetOneTrackingHistoryItems":{"type":"object","properties":{"date":{"type":"number","format":"double","description":"The [Unix timestamp](https://www.unixtimestamp.com/) for when the message was sent."},"role":{"type":"string","description":"The sender of the message. Buyers are designated as `Customer:` while sales reps are designated as `Sales rep:`"},"message":{"type":"string","description":"The contents of the message."}},"title":"QuoteDataGetOneTrackingHistoryItems"},"QuoteDataGetOneExtraFieldsInfoItemsFieldType":{"type":"string","enum":["0","1","2","3"],"description":"Field type of the extra field.0 means text type. 1 means textarea type. 2 means number type. 3 means dropdown type.","title":"QuoteDataGetOneExtraFieldsInfoItemsFieldType"},"QuoteDataGetOneExtraFieldsInfoItemsConfigType":{"type":"string","enum":["1","2"],"description":"Extra field config type.1 means built in. 2 means user defined.","title":"QuoteDataGetOneExtraFieldsInfoItemsConfigType"},"QuoteDataGetOneExtraFieldsInfoItems":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Unique id"},"uuid":{"type":"string","description":"UUID of the extra field"},"fieldName":{"type":"string","description":"Field name that config in you store"},"fieldType":{"$ref":"#/components/schemas/QuoteDataGetOneExtraFieldsInfoItemsFieldType","description":"Field type of the extra field.0 means text type. 1 means textarea type. 2 means number type. 3 means dropdown type."},"isRequired":{"type":"boolean","description":"Is this field is required"},"isUnique":{"type":"boolean","description":"Is the value of this field is unique"},"visibleToEnduser":{"type":"boolean","description":"Is this field visible to end-user"},"configType":{"$ref":"#/components/schemas/QuoteDataGetOneExtraFieldsInfoItemsConfigType","description":"Extra field config type.1 means built in. 2 means user defined."},"defaultValue":{"type":"string","description":"Default value of this field."},"maximumLength":{"type":"string","description":"The maximum length of the value of this field. fieldType == 0"},"numberOfRows":{"type":"string","description":"The maximum number of rows of the value of this field. fieldType == 1"},"maximumValue":{"type":"string","description":"Maximum value of the field value. fieldType == 2"},"listOfValue":{"type":"array","items":{"type":"string"},"description":"List of all optional values for the field value. fieldType == 3"}},"description":"Extra Fields","title":"QuoteDataGetOneExtraFieldsInfoItems"},"quoteData_GET_ONE":{"type":"object","properties":{"quoteNumber":{"type":"string","description":"The quote identifier that is visible in the B2B Edition control panel and the Buyer Portal."},"status":{"$ref":"#/components/schemas/QuoteDataGetOneStatus","description":"The numeric ID associated with the quote’s status. See [Quote Statuses](#quote-statuses) to learn about the statuses that correspond to each ID."},"bcOrderId":{"type":"string","description":"The BigCommerce order ID associated with the sales quote."},"orderId":{"$ref":"#/components/schemas/orderId"},"channelName":{"type":"string","description":"The name of the storefront channel associated with the quote."},"createdAt":{"type":"integer","description":"The [Unix timestamp](https://www.unixtimestamp.com/) for when the sales quote was created. This is a read-only field."},"expiredAt":{"type":"integer","description":"The [Unix timestamp](https://www.unixtimestamp.com/) for when the sales quote expires. This is a read-only field."},"createdBy":{"type":"string","description":"The name of the sales rep or buyer who created the quote."},"subtotal":{"type":"number","format":"double","description":"The quoted total after discounts and before shipping and tax. If you are updating the line items or discounts on a quote, you must also update the subtotal to reflect the new pricing."},"channelId":{"type":"integer","default":1,"description":"The storefront channel ID associated with the quote. This is required if your store has multiple storefront channels. Use `1` for your store’s default storefront channel."},"quoteTitle":{"type":"string","description":"The external title given to the quote."},"referenceNumber":{"type":"string","description":"An identifier for the quote that can be supplied by the sales rep or the buyer, such as a Purchase Order number."},"currency":{"$ref":"#/components/schemas/QuoteDataGetOneCurrency"},"extraFields":{"$ref":"#/components/schemas/extraFields"},"notes":{"type":"string","description":"The quote’s buyer-facing notes. Use the newline character `\n` to separate each line of text."},"discount":{"type":"number","format":"double","description":"The total value of discounts applied to the quote."},"grandTotal":{"type":"number","format":"double","description":"The quoted total after discounts, shipping, and tax are applied. If you are updating the line items or discounts on a quote, you must also update the grand total to reflect the new pricing."},"legalTerms":{"type":"string","description":"The quote’s terms and conditions. Use the newline character `\n` to separate each line of text. Omitting this field or leaving it blank does not add your store’s default terms and conditions to the quote. Instead, the quote will not display any terms."},"displayDiscount":{"type":"boolean","description":"Determines if buyers can see quoted discount values in the Buyer Portal, or if they only see the quoted prices. If left blank, the quote uses the discount display selection in your Quote settings."},"allowCheckout":{"type":"boolean","description":"Determines whether or not the buyer can take the quote to the checkout page. If left blank, the quote uses the checkout selection in your Quote settings."},"productList":{"$ref":"#/components/schemas/productList"},"shippingAddress":{"$ref":"#/components/schemas/companyAddress"},"contactInfo":{"$ref":"#/components/schemas/contactInfo"},"discountType":{"$ref":"#/components/schemas/QuoteDataGetOneDiscountType","description":"Indicates whether the quote uses line item discounts (0), percentage discounts (1), or fixed amount discounts (2)."},"discountValue":{"type":["number","null"],"format":"double","description":"The total discount value on the quote. If there are no discounts, the value is `null`."},"shippingTotal":{"type":"number","format":"double","description":"The total cost of shipping on the quote."},"taxTotal":{"type":"number","format":"double","description":"The total tax cost on the quote."},"totalAmount":{"type":"number","format":"double","description":"The total price of the quote after any discounts."},"quoteLogo":{"type":"string","description":"The image URL of the store logo added to quote emails and PDFs."},"shippingMethod":{"$ref":"#/components/schemas/QuoteDataGetOneShippingMethod"},"billingAddress":{"$ref":"#/components/schemas/QuoteDataGetOneBillingAddress"},"storeInfo":{"$ref":"#/components/schemas/QuoteDataGetOneStoreInfo"},"companyInfo":{"$ref":"#/components/schemas/QuoteDataGetOneCompanyInfo"},"salesRepInfo":{"$ref":"#/components/schemas/QuoteDataGetOneSalesRepInfo"},"storefrontAttachFiles":{"type":"array","items":{"$ref":"#/components/schemas/QuoteDataGetOneStorefrontAttachFilesItems"},"description":"Information on files attached to the quote by the buyer."},"backendAttachFiles":{"type":"array","items":{"$ref":"#/components/schemas/QuoteDataGetOneBackendAttachFilesItems"},"description":"Information on files attached to the quote by the sales rep."},"trackingHistory":{"type":"array","items":{"$ref":"#/components/schemas/QuoteDataGetOneTrackingHistoryItems"},"description":"Provides a log of messages sent between the buyer and the sales rep."},"extraFieldsInfo":{"type":"array","items":{"$ref":"#/components/schemas/QuoteDataGetOneExtraFieldsInfoItems"}},"recipients":{"type":"array","items":{"type":"string","format":"email"},"description":"Lists additional recipients added to the quote. This is different from the additional recipients listed on quote emails.\n\nThis array is not supported if you are using the new Add/Edit Quote experience. See [Managing Sales Quotes in B2B Edition (Help Center)](https://support.bigcommerce.com/s/article/B2B-Edition-Quotes) to learn more."}},"title":"quoteData_GET_ONE"},"RfqQuoteIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"}},"title":"RfqQuoteIdGetResponsesContentApplicationJsonSchemaMeta"},"Quotes_get-rfq-quote_id_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/quoteData_GET_ONE"},"meta":{"$ref":"#/components/schemas/RfqQuoteIdGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Quotes_get-rfq-quote_id_Response_200"},"RfqQuoteIdPutRequestBodyContentApplicationJsonSchemaCurrencyLocation":{"type":"string","enum":["left","right"],"description":"Determines whether the currency symbol is added to the left or the right of quote pricing.","title":"RfqQuoteIdPutRequestBodyContentApplicationJsonSchemaCurrencyLocation"},"RfqQuoteIdPutRequestBodyContentApplicationJsonSchemaCurrency":{"type":"object","properties":{"token":{"type":"string","description":"The currency symbol."},"location":{"$ref":"#/components/schemas/RfqQuoteIdPutRequestBodyContentApplicationJsonSchemaCurrencyLocation","description":"Determines whether the currency symbol is added to the left or the right of quote pricing."},"currencyCode":{"type":"string","description":"The three-letter code corresponding to the quote’s currency."},"decimalToken":{"type":"string","description":"The character used to separate decimal values in quote pricing."},"decimalPlaces":{"type":"integer","description":"The number of decimal places displayed in quote pricing. You can display a maximum of 4 decimal places."},"thousandsToken":{"type":"string","description":"The character used to separate the hundredths and thousandths places in quote pricing."},"currencyExchangeRate":{"type":"number","format":"double","description":"Overrides the built-in exchange rate between your store’s default currency and the quote’s selected currency. If left blank, the exchange rate defined in your store’s settings is used."}},"title":"RfqQuoteIdPutRequestBodyContentApplicationJsonSchemaCurrency"},"RfqQuoteIdPutRequestBodyContentApplicationJsonSchemaStatus":{"type":"string","enum":["archived"],"description":"Set to `\"archived\"` to archive the quote.","title":"RfqQuoteIdPutRequestBodyContentApplicationJsonSchemaStatus"},"Quotes_put-rfq-quote_id_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double","default":200,"description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/quote_PUT_POST"},"message":{"type":"string","default":"SUCCESS"}},"title":"Quotes_put-rfq-quote_id_Response_200"},"RfqQuoteIdCheckoutPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"checkoutUrl":{"type":"string","description":"The URL that takes the quote to the storefront checkout page."},"cartId":{"type":"string","description":"The unique identifier of the cart generated for the quote."},"cartUrl":{"type":"string","description":"The URL that takes the quote to the storefront cart page."}},"title":"RfqQuoteIdCheckoutPostResponsesContentApplicationJsonSchemaData"},"Quotes_post-rfq-quote_id-checkout_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double","default":200,"description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/RfqQuoteIdCheckoutPostResponsesContentApplicationJsonSchemaData"},"message":{"type":"string","default":"SUCCESS"}},"title":"Quotes_post-rfq-quote_id-checkout_Response_200"},"RfqQuoteIdPdfExportPostRequestBodyContentApplicationJsonSchemaCurrencyLocation":{"type":"string","enum":["left","right"],"description":"Determines whether the currency symbol is added to the left or the right of quote pricing.","title":"RfqQuoteIdPdfExportPostRequestBodyContentApplicationJsonSchemaCurrencyLocation"},"RfqQuoteIdPdfExportPostRequestBodyContentApplicationJsonSchemaCurrency":{"type":"object","properties":{"token":{"type":"string","description":"The currency symbol."},"location":{"$ref":"#/components/schemas/RfqQuoteIdPdfExportPostRequestBodyContentApplicationJsonSchemaCurrencyLocation","description":"Determines whether the currency symbol is added to the left or the right of quote pricing."},"currencyCode":{"type":"string","description":"The three-letter code corresponding to the quote’s currency."},"decimalToken":{"type":"string","description":"The character used to separate decimal values in quote pricing."},"decimalPlaces":{"type":"integer","description":"The number of decimal places displayed in quote pricing. You can display a maximum of 4 decimal places."},"thousandsToken":{"type":"string","description":"The character used to separate the hundredths and thousandths places in quote pricing."},"currencyExchangeRate":{"type":"string","description":"Overrides the built-in exchange rate between your store’s default currency and the quote’s selected currency. If left blank, the exchange rate defined in your store’s settings is used."}},"title":"RfqQuoteIdPdfExportPostRequestBodyContentApplicationJsonSchemaCurrency"},"RfqQuoteIdPdfExportPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","description":"The URL for the generated PDF that can be sent to the customer or attached to the quote."}},"title":"RfqQuoteIdPdfExportPostResponsesContentApplicationJsonSchemaData"},"Quotes_get-rfq-quote_id-pdf-export_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double","default":200,"description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/RfqQuoteIdPdfExportPostResponsesContentApplicationJsonSchemaData"},"message":{"type":"string","default":"SUCCESS"}},"title":"Quotes_get-rfq-quote_id-pdf-export_Response_200"},"RfqQuoteIdShippingRatePutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"RfqQuoteIdShippingRatePutResponsesContentApplicationJsonSchemaData"},"RfqQuoteIdShippingRatePutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"}},"title":"RfqQuoteIdShippingRatePutResponsesContentApplicationJsonSchemaMeta"},"Quotes_rfq-quote_id-select-shipping-rate_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"HTTP Response Code"},"data":{"$ref":"#/components/schemas/RfqQuoteIdShippingRatePutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/RfqQuoteIdShippingRatePutResponsesContentApplicationJsonSchemaMeta"}},"title":"Quotes_rfq-quote_id-select-shipping-rate_Response_200"},"RfqQuoteIdShippingRatesGetResponsesContentApplicationJsonSchemaDataItemsType":{"type":"string","enum":["custom","provider_methodtype","shipping_flatrate"],"description":"The type of shipping method added to the quote. Custom shipping methods appear as `custom`, while static and real-time shipping methods appear as `provider_methodtype`, like `shipping_flatrate`.","title":"RfqQuoteIdShippingRatesGetResponsesContentApplicationJsonSchemaDataItemsType"},"RfqQuoteIdShippingRatesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"shippingMethodId":{"type":"string","description":"The unique identifier for the shipping method."},"type":{"$ref":"#/components/schemas/RfqQuoteIdShippingRatesGetResponsesContentApplicationJsonSchemaDataItemsType","description":"The type of shipping method added to the quote. Custom shipping methods appear as `custom`, while static and real-time shipping methods appear as `provider_methodtype`, like `shipping_flatrate`."},"description":{"type":"string","description":"The name of the shipping method."},"cost":{"type":"number","format":"double","description":"The shipping rate on the quote."}},"title":"RfqQuoteIdShippingRatesGetResponsesContentApplicationJsonSchemaDataItems"},"RfqQuoteIdShippingRatesGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"}},"title":"RfqQuoteIdShippingRatesGetResponsesContentApplicationJsonSchemaMeta"},"Quotes_get-rfq-quote_id-shipping-rates_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"HTTP Response Code"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RfqQuoteIdShippingRatesGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/RfqQuoteIdShippingRatesGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Quotes_get-rfq-quote_id-shipping-rates_Response_200"},"SalesStaffsGetParametersOrderBy":{"type":"string","enum":["DESC","ASC"],"default":"DESC","title":"SalesStaffsGetParametersOrderBy"},"SalesStaffsGetParametersSortBy":{"type":"string","enum":["updated_at","email"],"default":"updated_at","title":"SalesStaffsGetParametersSortBy"},"pagination":{"type":"object","properties":{"limit":{"type":"integer","default":10,"description":"Maximum number of results to display per page."},"offset":{"type":"integer","default":0,"description":"Number of results to skip before displaying the current page."},"totalCount":{"type":"integer","description":"The total number of items matching the query."}},"title":"pagination"},"SalesStaffsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"},"pagination":{"$ref":"#/components/schemas/pagination"}},"title":"SalesStaffsGetResponsesContentApplicationJsonSchemaMeta"},"Sales Staff_get-sales-staffs_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"The HTTP Status code of the response."},"data":{"type":"array","items":{"description":"Any type"}},"meta":{"$ref":"#/components/schemas/SalesStaffsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Sales Staff_get-sales-staffs_Response_200"},"SalesStaffsSalesStaffIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"SalesStaffsSalesStaffIdGetResponsesContentApplicationJsonSchemaData"},"SalesStaffsSalesStaffIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"SUCCESS"}},"title":"SalesStaffsSalesStaffIdGetResponsesContentApplicationJsonSchemaMeta"},"Sales Staff_get-sales-staffs-salesStaffId_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"The HTTP Status code of the response."},"data":{"$ref":"#/components/schemas/SalesStaffsSalesStaffIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SalesStaffsSalesStaffIdGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Sales Staff_get-sales-staffs-salesStaffId_Response_200"},"SalesStaffsSalesStaffIdPutRequestBodyContentApplicationJsonSchemaItems":{"type":"object","properties":{"companyId":{"$ref":"#/components/schemas/companyId"},"assignStatus":{"type":"boolean","description":"Indicates whether the Sales Staff account is being assigned to (`true`) or unassigned from (`false`) the Company."}},"required":["companyId","assignStatus"],"title":"SalesStaffsSalesStaffIdPutRequestBodyContentApplicationJsonSchemaItems"},"SalesStaffsSalesStaffIdPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"title":"SalesStaffsSalesStaffIdPutResponsesContentApplicationJsonSchemaData"},"SalesStaffsSalesStaffIdPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Parameter Error"}},"title":"SalesStaffsSalesStaffIdPutResponsesContentApplicationJsonSchemaMeta"},"Sales Staff_put-sales-staffs-salesStaffId_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"The HTTP Status code of the response."},"data":{"$ref":"#/components/schemas/SalesStaffsSalesStaffIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SalesStaffsSalesStaffIdPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Sales Staff_put-sales-staffs-salesStaffId_Response_200"},"Put-sales-staffs-salesStaffIdRequestBadRequestError":{"type":"object","properties":{"code":{"type":"integer","default":400,"description":"The HTTP Status code of the response."},"data":{"$ref":"#/components/schemas/SalesStaffsSalesStaffIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SalesStaffsSalesStaffIdPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Put-sales-staffs-salesStaffIdRequestBadRequestError"},"Put-sales-staffs-salesStaffIdRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"integer","default":422,"description":"The HTTP Status code of the response."},"data":{"$ref":"#/components/schemas/SalesStaffsSalesStaffIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SalesStaffsSalesStaffIdPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Put-sales-staffs-salesStaffIdRequestUnprocessableEntityError"},"ShoppingListGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"error information"}},"required":["message"],"title":"ShoppingListGetResponsesContentApplicationJsonSchemaMeta"},"ShoppingListStatus":{"type":"string","enum":["0","30","40"],"description":"status of shopping list, (0: approved, 20: deleted, 30: draft, 40: ready for approval) ","title":"ShoppingListStatus"},"shopping_list":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string","description":"The name for shopping list."},"description":{"type":"string","description":"The description information for shopping list."},"status":{"$ref":"#/components/schemas/ShoppingListStatus","description":"status of shopping list, (0: approved, 20: deleted, 30: draft, 40: ready for approval) "},"companyId":{"type":"integer","description":"The ID for shopping list owner company."},"userId":{"type":"integer","description":"ID for shopping list creator"},"createdAt":{"type":"integer","description":"shopping list create time"},"updatedAt":{"type":"integer","description":"update time for shopping list"},"channelId":{"type":"number","format":"double","description":"BigCommerce channel ID"},"channelName":{"type":"string","description":"Store Channel name"}},"required":["status"],"title":"shopping_list"},"Shopping List_get-shopping-list_Response_200":{"type":"object","properties":{"code":{"type":"integer","description":"Response code of success request."},"meta":{"$ref":"#/components/schemas/ShoppingListGetResponsesContentApplicationJsonSchemaMeta","description":"Used to response pagination information"},"data":{"type":"array","items":{"$ref":"#/components/schemas/shopping_list"}}},"description":"Response for successful request","title":"Shopping List_get-shopping-list_Response_200"},"ShoppingListGetResponsesContentApplicationJsonSchemaDataErrMsg":{"type":"object","properties":{},"description":"Error detail information for some parameters.","title":"ShoppingListGetResponsesContentApplicationJsonSchemaDataErrMsg"},"ShoppingListGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"$ref":"#/components/schemas/ShoppingListGetResponsesContentApplicationJsonSchemaDataErrMsg","description":"Error detail information for some parameters."}},"required":["errMsg"],"title":"ShoppingListGetResponsesContentApplicationJsonSchemaData"},"Get-shopping-listRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"number","format":"double","description":"response status code"},"data":{"$ref":"#/components/schemas/ShoppingListGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/ShoppingListGetResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Get-shopping-listRequestUnprocessableEntityError"},"ShoppingListPostRequestBodyContentApplicationJsonSchemaStatus":{"type":"string","enum":["0","30","40"],"description":"status of shopping list, (0: approved, 20: deleted, 30: draft, 40: ready for approval)","title":"ShoppingListPostRequestBodyContentApplicationJsonSchemaStatus"},"ShoppingListItemOptionList":{"type":"object","properties":{"optionId":{"type":"string"},"optionValue":{"type":"string"}},"description":"The optionlist does not need to be entered and will be automatically obtained based on productId and variantId.","title":"ShoppingListItemOptionList"},"shopping_list_item":{"type":"object","properties":{"id":{"type":"integer","description":"unique ID field for shopping list item"},"productId":{"type":"integer","description":"product ID for shopping list item"},"variantId":{"type":"integer","description":"Variant ID for shopping list item. If the product has options, variant ID is required, otherwise it can be left blank."},"quantity":{"type":"integer","description":"Quantity of product and variant"},"sortOrder":{"type":"integer","description":"The sort order for item"},"optionList":{"$ref":"#/components/schemas/ShoppingListItemOptionList","description":"The optionlist does not need to be entered and will be automatically obtained based on productId and variantId."},"productNote":{"type":"string","description":"product note"}},"required":["productId","variantId","quantity"],"description":"Shopping List Items","title":"shopping_list_item"},"ShoppingListPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"error information"}},"required":["message"],"title":"ShoppingListPostResponsesContentApplicationJsonSchemaMeta"},"ShoppingListPostResponsesContentApplicationJsonSchemaDataErrMsg":{"type":"object","properties":{},"description":"Error detail information for some parameters.","title":"ShoppingListPostResponsesContentApplicationJsonSchemaDataErrMsg"},"ShoppingListPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"$ref":"#/components/schemas/ShoppingListPostResponsesContentApplicationJsonSchemaDataErrMsg","description":"Error detail information for some parameters."}},"required":["errMsg"],"title":"ShoppingListPostResponsesContentApplicationJsonSchemaData"},"Shopping List_post-shopping-list_Response_200":{"type":"object","properties":{"code":{"type":"integer","description":"Response code of success request."},"meta":{"$ref":"#/components/schemas/ShoppingListPostResponsesContentApplicationJsonSchemaMeta"},"data":{"$ref":"#/components/schemas/ShoppingListPostResponsesContentApplicationJsonSchemaData"}},"description":"Response for successful request","title":"Shopping List_post-shopping-list_Response_200"},"Post-shopping-listRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"number","format":"double","description":"response status code"},"data":{"$ref":"#/components/schemas/ShoppingListPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/ShoppingListPostResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Post-shopping-listRequestUnprocessableEntityError"},"ShoppingListShoppingListIdGetParametersSortBy":{"type":"string","enum":["quantity","productName","productSku","sortOrder"],"title":"ShoppingListShoppingListIdGetParametersSortBy"},"ShoppingListShoppingListIdGetParametersOrderBy":{"type":"string","enum":["DESC","ASC"],"title":"ShoppingListShoppingListIdGetParametersOrderBy"},"ShoppingListShoppingListIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"Error message of this response"}},"title":"ShoppingListShoppingListIdGetResponsesContentApplicationJsonSchemaMeta"},"ShoppingListShoppingListIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string","description":"error message detail"}},"description":"Response data","title":"ShoppingListShoppingListIdGetResponsesContentApplicationJsonSchemaData"},"Shopping List_get-shopping-list-shoppingListId_Response_200":{"type":"object","properties":{"code":{"type":"integer","description":"Response code of success request."},"meta":{"$ref":"#/components/schemas/ShoppingListShoppingListIdGetResponsesContentApplicationJsonSchemaMeta"},"data":{"$ref":"#/components/schemas/ShoppingListShoppingListIdGetResponsesContentApplicationJsonSchemaData"}},"description":"Response for successful request","title":"Shopping List_get-shopping-list-shoppingListId_Response_200"},"Get-shopping-list-shoppingListIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double","description":"Response status code"},"data":{"$ref":"#/components/schemas/ShoppingListShoppingListIdGetResponsesContentApplicationJsonSchemaData","description":"Response data"},"meta":{"$ref":"#/components/schemas/ShoppingListShoppingListIdGetResponsesContentApplicationJsonSchemaMeta"}},"description":"Response body","title":"Get-shopping-list-shoppingListIdRequestNotFoundError"},"ShoppingListShoppingListIdPutRequestBodyContentApplicationJsonSchemaStatus":{"type":"string","enum":["0","30","40"],"description":"status of shopping list, (0: approved, 20: deleted, 30: draft, 40: ready for approval)","title":"ShoppingListShoppingListIdPutRequestBodyContentApplicationJsonSchemaStatus"},"ShoppingListShoppingListIdPutRequestBodyContentApplicationJsonSchemaItemsItemsOptionList":{"type":"object","properties":{"optionId":{"type":"string"},"optionValue":{"type":"string"}},"description":"The optionlist does not need to be input in and will be automatically obtained based on productId and variantId.","title":"ShoppingListShoppingListIdPutRequestBodyContentApplicationJsonSchemaItemsItemsOptionList"},"ShoppingListShoppingListIdPutRequestBodyContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{"id":{"type":"integer","description":"Unique ID field for shopping list item"},"productId":{"type":"integer","description":"Product ID for shopping list item"},"variantId":{"type":"integer","description":"Variant ID for shopping list item. If the product has options, the variant ID is required, otherwise it can be left blank."},"quantity":{"type":"integer","description":"Quantity of product and variant"},"sortOrder":{"type":"integer","description":"The sort order for item"},"optionList":{"$ref":"#/components/schemas/ShoppingListShoppingListIdPutRequestBodyContentApplicationJsonSchemaItemsItemsOptionList","description":"The optionlist does not need to be input in and will be automatically obtained based on productId and variantId."},"productNote":{"type":"string","description":"product note"}},"title":"ShoppingListShoppingListIdPutRequestBodyContentApplicationJsonSchemaItemsItems"},"ShoppingListShoppingListIdPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"error information"}},"required":["message"],"title":"ShoppingListShoppingListIdPutResponsesContentApplicationJsonSchemaMeta"},"Shopping List_put-shopping-list-shoppingListId_Response_200":{"type":"object","properties":{"code":{"type":"integer","description":"Response code of success request."},"meta":{"$ref":"#/components/schemas/ShoppingListShoppingListIdPutResponsesContentApplicationJsonSchemaMeta"},"data":{"$ref":"#/components/schemas/shopping_list"}},"description":"Response for successful request","title":"Shopping List_put-shopping-list-shoppingListId_Response_200"},"ShoppingListShoppingListIdPutResponsesContentApplicationJsonSchemaDataErrMsg":{"type":"object","properties":{},"description":"Error detail information for some parameters.","title":"ShoppingListShoppingListIdPutResponsesContentApplicationJsonSchemaDataErrMsg"},"ShoppingListShoppingListIdPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"$ref":"#/components/schemas/ShoppingListShoppingListIdPutResponsesContentApplicationJsonSchemaDataErrMsg","description":"Error detail information for some parameters."}},"required":["errMsg"],"title":"ShoppingListShoppingListIdPutResponsesContentApplicationJsonSchemaData"},"Put-shopping-list-shoppingListIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double","description":"Response status code"},"data":{"$ref":"#/components/schemas/ShoppingListShoppingListIdPutResponsesContentApplicationJsonSchemaData","description":"Response data"},"meta":{"$ref":"#/components/schemas/ShoppingListShoppingListIdPutResponsesContentApplicationJsonSchemaMeta"}},"description":"Response body","title":"Put-shopping-list-shoppingListIdRequestNotFoundError"},"Put-shopping-list-shoppingListIdRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"number","format":"double","description":"response status code"},"data":{"$ref":"#/components/schemas/ShoppingListShoppingListIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/ShoppingListShoppingListIdPutResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Put-shopping-list-shoppingListIdRequestUnprocessableEntityError"},"ShoppingListShoppingListIdDeleteResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"error information"}},"required":["message"],"title":"ShoppingListShoppingListIdDeleteResponsesContentApplicationJsonSchemaMeta"},"ShoppingListShoppingListIdDeleteResponsesContentApplicationJsonSchemaDataErrMsg":{"type":"object","properties":{},"description":"Error detail information for some parameters.","title":"ShoppingListShoppingListIdDeleteResponsesContentApplicationJsonSchemaDataErrMsg"},"ShoppingListShoppingListIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"$ref":"#/components/schemas/ShoppingListShoppingListIdDeleteResponsesContentApplicationJsonSchemaDataErrMsg","description":"Error detail information for some parameters."}},"required":["errMsg"],"title":"ShoppingListShoppingListIdDeleteResponsesContentApplicationJsonSchemaData"},"Shopping List_delete-shopping-list-shoppingListId_Response_200":{"type":"object","properties":{"code":{"type":"integer","description":"Response code of success request."},"meta":{"$ref":"#/components/schemas/ShoppingListShoppingListIdDeleteResponsesContentApplicationJsonSchemaMeta"},"data":{"$ref":"#/components/schemas/ShoppingListShoppingListIdDeleteResponsesContentApplicationJsonSchemaData"}},"description":"Response for successful request","title":"Shopping List_delete-shopping-list-shoppingListId_Response_200"},"Delete-shopping-list-shoppingListIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double","description":"response status code"},"data":{"$ref":"#/components/schemas/ShoppingListShoppingListIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/ShoppingListShoppingListIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"required":["code","data","meta"],"title":"Delete-shopping-list-shoppingListIdRequestNotFoundError"},"ShoppingListShoppingListIdItemsItemIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string"}},"title":"ShoppingListShoppingListIdItemsItemIdDeleteResponsesContentApplicationJsonSchemaData"},"Shopping List_delete-shopping-list-shoppingListId-items-itemId_Response_200":{"type":"object","properties":{"code":{"type":"number","format":"double"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/ShoppingListShoppingListIdItemsItemIdDeleteResponsesContentApplicationJsonSchemaData"}},"required":["code","message","data"],"title":"Shopping List_delete-shopping-list-shoppingListId-items-itemId_Response_200"},"ShoppingListShoppingListIdItemsItemIdDeleteResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string"}},"title":"ShoppingListShoppingListIdItemsItemIdDeleteResponsesContentApplicationJsonSchemaMeta"},"Delete-shopping-list-shoppingListId-items-itemIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"number","format":"double"},"data":{"$ref":"#/components/schemas/ShoppingListShoppingListIdItemsItemIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/ShoppingListShoppingListIdItemsItemIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"title":"Delete-shopping-list-shoppingListId-items-itemIdRequestNotFoundError"},"superAdminOrigin":{"type":"integer","description":"The unique BigCommerce channel ID, used for the BigCommerce customer account's origin channel. This field is inactive if the store has a default B2B Edition channel set.","title":"superAdminOrigin"},"superAdminChannelIds":{"type":"array","items":{"type":"integer"},"description":"An array of unique channel IDs associated with BigCommerce sales channels. The account will only be able to login on channels in this list.","title":"superAdminChannelIds"},"ExtraFieldsArrayItems":{"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the custom field"},"fieldValue":{"type":"string","description":"Value for the custom field."}},"title":"ExtraFieldsArrayItems"},"extraFieldsArray":{"type":"array","items":{"$ref":"#/components/schemas/ExtraFieldsArrayItems"},"title":"extraFieldsArray"},"SuperAdminsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"SuperAdminsPostResponsesContentApplicationJsonSchemaData"},"SuperAdminsPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"The user already exists."}},"title":"SuperAdminsPostResponsesContentApplicationJsonSchemaMeta"},"Super Admin_post-super-admins_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"$ref":"#/components/schemas/SuperAdminsPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SuperAdminsPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Super Admin_post-super-admins_Response_200"},"Post-super-adminsRequestBadRequestError":{"type":"object","properties":{"code":{"type":"integer","default":400},"data":{"$ref":"#/components/schemas/SuperAdminsPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SuperAdminsPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-super-adminsRequestBadRequestError"},"SuperAdminsBulkPostRequestBodyContentApplicationJsonSchemaItems":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name listed on the Super Admin's BigCommerce customer account."},"lastName":{"type":"string","description":"The last name listed on the Super Admin's BigCommerce customer account."},"phone":{"type":"string","description":"The phone number listed on the Super Admin's BigCommerce customer account."},"uuid":{"type":"string","format":"uuid","description":"An external ID associated with the Super Admin account. B2B Edition does not require UUID to be unique, despite the field's label. B2B Edition will not assign a UUID by default.\n\n> NOTE  \n> Some endpoints will only return this field if it has a non-empty value. If your code relies on the presence of a UUID in responses, ensure it is defined for each user, and prefer endpoints that provide more details.\n> \n> Regardless of individual user status, make sure to check for existence before attempting to use the value of the `uuid` field."},"email":{"type":"string","format":"email","description":"The email address associated with the Super Admin's BigCommerce customer account."},"originChannelId":{"$ref":"#/components/schemas/superAdminOrigin"},"channelIds":{"$ref":"#/components/schemas/superAdminChannelIds"}},"title":"SuperAdminsBulkPostRequestBodyContentApplicationJsonSchemaItems"},"SuperAdminsBulkPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"SuperAdminsBulkPostResponsesContentApplicationJsonSchemaData"},"SuperAdminsBulkPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Parameter Error"}},"title":"SuperAdminsBulkPostResponsesContentApplicationJsonSchemaMeta"},"Super Admin_post-super-admins-bulk_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"$ref":"#/components/schemas/SuperAdminsBulkPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SuperAdminsBulkPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Super Admin_post-super-admins-bulk_Response_200"},"Post-super-admins-bulkRequestBadRequestError":{"type":"object","properties":{"code":{"type":"integer","default":400},"data":{"$ref":"#/components/schemas/SuperAdminsBulkPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SuperAdminsBulkPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-super-admins-bulkRequestBadRequestError"},"Post-super-admins-bulkRequestContentTooLargeError":{"type":"object","properties":{"code":{"type":"integer","default":413},"data":{"$ref":"#/components/schemas/SuperAdminsBulkPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SuperAdminsBulkPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-super-admins-bulkRequestContentTooLargeError"},"SuperAdminsBulkPostResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"firstName":{"type":"array","items":{"type":"string","default":"This field is required"}},"lastName":{"type":"array","items":{"type":"string","default":"This field is required"}},"email":{"type":"array","items":{"type":"string","default":"This field is required"}}},"title":"SuperAdminsBulkPostResponsesContentApplicationJsonSchemaDataItems"},"Post-super-admins-bulkRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"integer","default":422},"data":{"type":"array","items":{"$ref":"#/components/schemas/SuperAdminsBulkPostResponsesContentApplicationJsonSchemaDataItems"},"description":"An array of objects containing field names with errors and corresponding messages for those errors.\n\nEach entry in the array corresponds directly to one of the elements in the response body.\n\n> **NOTE**  \n> Only fields for which there are errors will be present in the objects in this list."},"meta":{"$ref":"#/components/schemas/SuperAdminsBulkPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Post-super-admins-bulkRequestUnprocessableEntityError"},"SuperAdminsCompaniesGetParametersOrderBy":{"type":"string","enum":["DESC","ASC"],"default":"DESC","title":"SuperAdminsCompaniesGetParametersOrderBy"},"SuperAdminsCompaniesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{},"title":"SuperAdminsCompaniesGetResponsesContentApplicationJsonSchemaDataItems"},"SuperAdminsCompaniesGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Success"},"pagination":{"$ref":"#/components/schemas/paginationObject"}},"title":"SuperAdminsCompaniesGetResponsesContentApplicationJsonSchemaMeta"},"Super Admin_get-super-admins-companies_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"type":"array","items":{"$ref":"#/components/schemas/SuperAdminsCompaniesGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/SuperAdminsCompaniesGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Super Admin_get-super-admins-companies_Response_200"},"isAssigned":{"type":"boolean","description":"Indicates whether the Super Admin should be assigned to the Company. A value of `true` indicates the assignment will be added or will remain if already assigned. A value of `false` indicates the assignment will be removed or remain so if already unassigned.","title":"isAssigned"},"SuperAdminsSuperAdminIdPutRequestBodyContentApplicationJsonSchemaCompaniesItems":{"type":"object","properties":{"companyId":{"$ref":"#/components/schemas/companyId"},"isAssigned":{"$ref":"#/components/schemas/isAssigned"}},"required":["companyId","isAssigned"],"title":"SuperAdminsSuperAdminIdPutRequestBodyContentApplicationJsonSchemaCompaniesItems"},"SuperAdminsSuperAdminIdPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"SuperAdminsSuperAdminIdPutResponsesContentApplicationJsonSchemaData"},"SuperAdminsSuperAdminIdPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"The ID provided does not match an available resource of the appropriate type."}},"title":"SuperAdminsSuperAdminIdPutResponsesContentApplicationJsonSchemaMeta"},"Super Admin_put-super-admins-superAdminId_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"$ref":"#/components/schemas/SuperAdminsSuperAdminIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SuperAdminsSuperAdminIdPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Super Admin_put-super-admins-superAdminId_Response_200"},"Put-super-admins-superAdminIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer","default":404},"data":{"$ref":"#/components/schemas/SuperAdminsSuperAdminIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SuperAdminsSuperAdminIdPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Put-super-admins-superAdminIdRequestNotFoundError"},"companyCore":{"type":"object","properties":{"companyId":{"$ref":"#/components/schemas/companyId"},"companyName":{"type":"string","description":"The name of the business associated with the Company account."},"companyEmail":{"type":"string","format":"email","description":"The primary email address for the Company account."}},"title":"companyCore"},"SuperAdminsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"The ID provided does not match an available resource of the appropriate type."}},"title":"SuperAdminsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaMeta"},"Super Admin_get-super-admins-superAdminId-companies_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"type":"array","items":{"$ref":"#/components/schemas/companyCore"}},"meta":{"$ref":"#/components/schemas/SuperAdminsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Super Admin_get-super-admins-superAdminId-companies_Response_200"},"SuperAdminsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"SuperAdminsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaData"},"Get-super-admins-superAdminId-companiesRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer","default":404},"data":{"$ref":"#/components/schemas/SuperAdminsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SuperAdminsSuperAdminIdCompaniesGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Get-super-admins-superAdminId-companiesRequestNotFoundError"},"SuperAdminsInfoSuperAdminIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"SuperAdminsInfoSuperAdminIdGetResponsesContentApplicationJsonSchemaData"},"SuperAdminsInfoSuperAdminIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"The ID provided does not match an available resource of the appropriate type."}},"title":"SuperAdminsInfoSuperAdminIdGetResponsesContentApplicationJsonSchemaMeta"},"Super Admin_get-super-admins-info-superAdminId_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"$ref":"#/components/schemas/SuperAdminsInfoSuperAdminIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SuperAdminsInfoSuperAdminIdGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Super Admin_get-super-admins-info-superAdminId_Response_200"},"Get-super-admins-info-superAdminIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer","default":404},"data":{"$ref":"#/components/schemas/SuperAdminsInfoSuperAdminIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SuperAdminsInfoSuperAdminIdGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Get-super-admins-info-superAdminIdRequestNotFoundError"},"SuperAdminsInfoSuperAdminIdPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"SuperAdminsInfoSuperAdminIdPutResponsesContentApplicationJsonSchemaData"},"SuperAdminsInfoSuperAdminIdPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"The ID provided does not match an available resource of the appropriate type."}},"title":"SuperAdminsInfoSuperAdminIdPutResponsesContentApplicationJsonSchemaMeta"},"Super Admin_put-super-admins-info-superAdminId_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"$ref":"#/components/schemas/SuperAdminsInfoSuperAdminIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SuperAdminsInfoSuperAdminIdPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Super Admin_put-super-admins-info-superAdminId_Response_200"},"Put-super-admins-info-superAdminIdRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer","default":404},"data":{"$ref":"#/components/schemas/SuperAdminsInfoSuperAdminIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/SuperAdminsInfoSuperAdminIdPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Put-super-admins-info-superAdminIdRequestNotFoundError"},"CompaniesSuperAdminsGetParametersOrderBy":{"type":"string","enum":["DESC","ASC"],"default":"DESC","title":"CompaniesSuperAdminsGetParametersOrderBy"},"CompaniesSuperAdminsGetParametersIsIncludeExtraFields":{"type":"string","enum":["0","1"],"default":"0","title":"CompaniesSuperAdminsGetParametersIsIncludeExtraFields"},"CompaniesSuperAdminsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{},"title":"CompaniesSuperAdminsGetResponsesContentApplicationJsonSchemaDataItems"},"CompaniesSuperAdminsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Success"},"pagination":{"$ref":"#/components/schemas/paginationObject"}},"title":"CompaniesSuperAdminsGetResponsesContentApplicationJsonSchemaMeta"},"Super Admin_get-companies-super-admins_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesSuperAdminsGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/CompaniesSuperAdminsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Super Admin_get-companies-super-admins_Response_200"},"CompaniesCompanyIdSuperAdminsGetParametersIsIncludeExtraFields":{"type":"string","enum":["0","1"],"default":"0","title":"CompaniesCompanyIdSuperAdminsGetParametersIsIncludeExtraFields"},"CompaniesCompanyIdSuperAdminsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{},"title":"CompaniesCompanyIdSuperAdminsGetResponsesContentApplicationJsonSchemaDataItems"},"CompaniesCompanyIdSuperAdminsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"The ID provided does not match an available resource of the appropriate type."}},"title":"CompaniesCompanyIdSuperAdminsGetResponsesContentApplicationJsonSchemaMeta"},"Super Admin_get-companies_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesCompanyIdSuperAdminsGetResponsesContentApplicationJsonSchemaDataItems"}},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdSuperAdminsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Super Admin_get-companies_Response_200"},"CompaniesCompanyIdSuperAdminsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"CompaniesCompanyIdSuperAdminsGetResponsesContentApplicationJsonSchemaData"},"Get-companiesRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer","default":404},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdSuperAdminsGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdSuperAdminsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Get-companiesRequestNotFoundError"},"superAdminId":{"type":"integer","description":"The unique user ID assigned by B2B Edition and used to reference a Super Admin via API.","title":"superAdminId"},"CompaniesCompanyIdSuperAdminsPutRequestBodyContentApplicationJsonSchemaSuperAdminsItems":{"type":"object","properties":{"superAdminId":{"$ref":"#/components/schemas/superAdminId"},"isAssigned":{"$ref":"#/components/schemas/isAssigned"}},"required":["superAdminId","isAssigned"],"title":"CompaniesCompanyIdSuperAdminsPutRequestBodyContentApplicationJsonSchemaSuperAdminsItems"},"CompaniesCompanyIdSuperAdminsPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{},"title":"CompaniesCompanyIdSuperAdminsPutResponsesContentApplicationJsonSchemaData"},"CompaniesCompanyIdSuperAdminsPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"The ID provided does not match an available resource of the appropriate type."}},"title":"CompaniesCompanyIdSuperAdminsPutResponsesContentApplicationJsonSchemaMeta"},"Super Admin_put-companies-companyId-super-admins_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdSuperAdminsPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdSuperAdminsPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Super Admin_put-companies-companyId-super-admins_Response_200"},"Put-companies-companyId-super-adminsRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer","default":404},"data":{"$ref":"#/components/schemas/CompaniesCompanyIdSuperAdminsPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/CompaniesCompanyIdSuperAdminsPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Put-companies-companyId-super-adminsRequestNotFoundError"},"UsersGetParametersRolesSchemaItems":{"type":"string","enum":["0","1","2"],"title":"UsersGetParametersRolesSchemaItems"},"UsersGetParametersIsIncludeExtraFields":{"type":"string","enum":["0","1"],"title":"UsersGetParametersIsIncludeExtraFields"},"UserResponseRole":{"type":"string","enum":["0","1","2"],"description":"Numeric code representing the user's role as admin (`0`), senior buyer (`1`), or junior buyer (`2`).","title":"UserResponseRole"},"extraField":{"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the extra field displayed in B2B Edition."},"fieldValue":{"type":"string","description":"The user-specific value of the extra field."}},"title":"extraField"},"UserResponseChannelListItems":{"type":"object","properties":{"channelId":{"type":"integer","description":"The unique numeric ID associated with the channel."},"channelName":{"type":"string","description":"The display name of the channel, as shown in BigCommerce."},"iconUrl":{"type":"string","description":"The icon associated with the channel's type."}},"title":"UserResponseChannelListItems"},"userResponse":{"type":"object","properties":{"id":{"type":"integer"},"firstName":{"type":"string","description":"User's first name."},"lastName":{"type":"string","description":"User's last name."},"email":{"type":"string","format":"email","description":"User's email address. This must be unique within B2B Edition."},"phoneNumber":{"type":"string","description":"User's phone number."},"role":{"$ref":"#/components/schemas/UserResponseRole","description":"Numeric code representing the user's role as admin (`0`), senior buyer (`1`), or junior buyer (`2`)."},"companyRoleId":{"type":"integer","description":"Numeric code representing the user's Company-specific role. When present this field overrides the value of the `role` field."},"uuid":{"type":"string","description":"External identifier for the user. This field may be used to represent any external user ID. Using the name `uuid`, B2B Edition does not require the field to be unique."},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/extraField"}},"companyId":{"type":"integer","description":"The unique numeric ID associated with the user's B2B Edition Company account."},"createdAt":{"type":"integer","description":"The [Unix timestamp](https://www.unixtimestamp.com/) for when the user's account was created."},"updatedAt":{"type":"integer","description":"The [Unix timestamp](https://www.unixtimestamp.com/) for when the user's account was last modified."},"customerId":{"type":"integer","description":"The unique numeric ID associated with the user's BigCommerce customer account."},"companyRoleName":{"type":"string","description":"Display name of the user's Company-specific role."},"channelList":{"type":"array","items":{"$ref":"#/components/schemas/UserResponseChannelListItems"},"description":"Channels the user is assigned to."}},"title":"userResponse"},"UsersGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Parameter Error","description":"Human-readable status message."}},"title":"UsersGetResponsesContentApplicationJsonSchemaMeta"},"Users_companies_users_list_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"type":"array","items":{"$ref":"#/components/schemas/userResponse"}},"meta":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Users_companies_users_list_Response_200"},"UsersGetResponsesContentApplicationJsonSchemaDataErrMsg":{"type":"object","properties":{},"description":"An object whose fields report errors within the request. Fields are included or excluded based only on whether their values were invalid.","title":"UsersGetResponsesContentApplicationJsonSchemaDataErrMsg"},"UsersGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaDataErrMsg","description":"An object whose fields report errors within the request. Fields are included or excluded based only on whether their values were invalid."}},"title":"UsersGetResponsesContentApplicationJsonSchemaData"},"Companies_users_listRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"integer","default":422,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_users_listRequestUnprocessableEntityError"},"UserPostRole":{"type":"string","enum":["0","1","2"],"description":"Numeric code representing the user's role as admin (`0`), senior buyer (`1`), or junior buyer (`2`).","title":"UserPostRole"},"channelIds":{"type":"array","items":{"type":"integer"},"description":"List of numeric channel IDs the user is associated with. These represent the storefront channels the user can log in to and do business.","title":"channelIds"},"userPost":{"type":"object","properties":{"firstName":{"type":"string","description":"User's first name."},"lastName":{"type":"string","description":"User's last name."},"email":{"type":"string","format":"email","description":"User's email address. This must be unique within B2B Edition."},"phoneNumber":{"type":"string","description":"User's phone number."},"role":{"$ref":"#/components/schemas/UserPostRole","description":"Numeric code representing the user's role as admin (`0`), senior buyer (`1`), or junior buyer (`2`)."},"companyRoleId":{"type":"integer","description":"Numeric code representing the user's Company-specific role. When present this field overrides the value of the `role` field."},"uuid":{"type":"string","description":"External identifier for the user. This field may be used to represent any external user ID. Using the name `uuid`, B2B Edition does not require the field to be unique."},"extraFields":{"type":"array","items":{"$ref":"#/components/schemas/extraField"}},"companyId":{"type":"integer","description":"The unique numeric ID associated with the user's B2B Edition Company account."},"acceptWelcomeEmail":{"type":"boolean","description":"Indicates whether the user will receive a welcome email when the account is created."},"originChannelId":{"type":"integer","description":"The ID of the originating channel. A value of `0` will unset the user's origin channel, which may result in unexpected behavior. To avoid errors, ensure all necessary channels are included in `channelIds`."},"channelIds":{"$ref":"#/components/schemas/channelIds"}},"required":["firstName","lastName","email","role","companyId","channelIds"],"title":"userPost"},"newIds":{"type":"object","properties":{"userId":{"type":"integer","description":"The unique numeric identifier associated with the B2B Edition user account."},"bcId":{"type":"integer","description":"The unique numeric identifier associated with the BigCommerce customer account corresponding to the B2B Edition user account."}},"title":"newIds"},"UsersPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable status message."}},"title":"UsersPostResponsesContentApplicationJsonSchemaMeta"},"Users_companies_users_create_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/newIds"},"meta":{"$ref":"#/components/schemas/UsersPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Users_companies_users_create_Response_200"},"ErrMsgPost0":{"type":"object","properties":{"firstName":{"type":"array","items":{"type":"string","default":"This field may not be null."}},"lastName":{"type":"array","items":{"type":"string","default":"This field may not be null."}},"email":{"type":"array","items":{"type":"string","default":"This field may not be null."}},"companyId":{"type":"array","items":{"type":"string","default":"This field may not be null."}}},"description":"An unordered list of missing required fields. Fields will only be included in this list if they are missing from the request.","title":"ErrMsgPost0"},"ErrMsgPost1":{"type":"object","properties":{"non_field_errors":{"type":"array","items":{"type":"string","default":"User must have a role."}}},"description":"A message indicating missing data not explicitly required for creation, but without which validation fails.","title":"ErrMsgPost1"},"ErrMsgPost4":{"type":"object","properties":{"email":{"type":"array","items":{"type":"string","default":"Email is not correct."}},"role":{"type":"array","items":{"type":"string","default":"\"5\" is not a valid choice"}}},"title":"ErrMsgPost4"},"errMsgPost":{"oneOf":[{"$ref":"#/components/schemas/ErrMsgPost0"},{"$ref":"#/components/schemas/ErrMsgPost1"},{"type":"string","default":"At least one B2B storefront needs to be enabled for a Company user."},{"type":"string"},{"$ref":"#/components/schemas/ErrMsgPost4"}],"title":"errMsgPost"},"UsersPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"$ref":"#/components/schemas/errMsgPost"}},"description":"The content and explanation of the error(s) associated with the request. The format of this field depends on what errors are present.","title":"UsersPostResponsesContentApplicationJsonSchemaData"},"Companies_users_createRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"integer","default":422,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/UsersPostResponsesContentApplicationJsonSchemaData","description":"The content and explanation of the error(s) associated with the request. The format of this field depends on what errors are present."},"meta":{"$ref":"#/components/schemas/UsersPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_users_createRequestUnprocessableEntityError"},"UsersBulkPostResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable status message."}},"title":"UsersBulkPostResponsesContentApplicationJsonSchemaMeta"},"Users_companies_users_bulk_create_create_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"type":"array","items":{"$ref":"#/components/schemas/newIds"}},"meta":{"$ref":"#/components/schemas/UsersBulkPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Users_companies_users_bulk_create_create_Response_200"},"UsersBulkPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"$ref":"#/components/schemas/errMsgPost"}},"description":"The content and explanation of the error(s) associated with the request. The format of this field depends on what errors are present.","title":"UsersBulkPostResponsesContentApplicationJsonSchemaData"},"Companies_users_bulk_create_createRequestContentTooLargeError":{"type":"object","properties":{"code":{"type":"integer","default":413,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/UsersBulkPostResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/UsersBulkPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_users_bulk_create_createRequestContentTooLargeError"},"Companies_users_bulk_create_createRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"integer","default":422,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/UsersBulkPostResponsesContentApplicationJsonSchemaData","description":"The content and explanation of the error(s) associated with the request. The format of this field depends on what errors are present."},"meta":{"$ref":"#/components/schemas/UsersBulkPostResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_users_bulk_create_createRequestUnprocessableEntityError"},"UsersUserIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Not Found Error","description":"Human-readable status message."}},"title":"UsersUserIdGetResponsesContentApplicationJsonSchemaMeta"},"Users_companies_user_by_id_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/userResponse"},"meta":{"$ref":"#/components/schemas/UsersUserIdGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Users_companies_user_by_id_Response_200"},"UsersUserIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string","default":"User matching query does not exist."}},"title":"UsersUserIdGetResponsesContentApplicationJsonSchemaData"},"Companies_user_by_idRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer","default":404,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/UsersUserIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/UsersUserIdGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_user_by_idRequestNotFoundError"},"UsersUserIdPutRequestBodyContentApplicationJsonSchemaRole":{"type":"string","enum":["0","1","2"],"description":"Numeric code representing the user's role as admin (`0`), senior buyer (`1`), or junior buyer (`2`).","title":"UsersUserIdPutRequestBodyContentApplicationJsonSchemaRole"},"UsersUserIdPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Parameter Error","description":"Human-readable status message."}},"title":"UsersUserIdPutResponsesContentApplicationJsonSchemaMeta"},"Users_companies_user_update_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/userResponse"},"meta":{"$ref":"#/components/schemas/UsersUserIdPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Users_companies_user_update_Response_200"},"UsersUserIdPutResponsesContentApplicationJsonSchemaDataErrMsg":{"type":"object","properties":{"_fieldName":{"type":"array","items":{"type":"string"},"description":"A variable field based on the errors in the request. A different `_fieldName` will be included for each reportable error. For example, if the email address is improperly formatted, the field will be called `email`."}},"title":"UsersUserIdPutResponsesContentApplicationJsonSchemaDataErrMsg"},"UsersUserIdPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"$ref":"#/components/schemas/UsersUserIdPutResponsesContentApplicationJsonSchemaDataErrMsg"}},"title":"UsersUserIdPutResponsesContentApplicationJsonSchemaData"},"Companies_user_updateRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer","default":404,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/UsersUserIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/UsersUserIdPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_user_updateRequestNotFoundError"},"Companies_user_updateRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"integer","default":422,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/UsersUserIdPutResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/UsersUserIdPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_user_updateRequestUnprocessableEntityError"},"UsersUserIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string","default":"The last user in company can not be deleted."}},"title":"UsersUserIdDeleteResponsesContentApplicationJsonSchemaData"},"UsersUserIdDeleteResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Processing data contains logical errors","description":"Human-readable status message."}},"title":"UsersUserIdDeleteResponsesContentApplicationJsonSchemaMeta"},"Users_companies_user_delete_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/UsersUserIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/UsersUserIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"title":"Users_companies_user_delete_Response_200"},"Companies_user_deleteRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer","default":404,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/UsersUserIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/UsersUserIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_user_deleteRequestNotFoundError"},"Companies_user_deleteRequestUnprocessableEntityError":{"type":"object","properties":{"code":{"type":"integer","default":422,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/UsersUserIdDeleteResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/UsersUserIdDeleteResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_user_deleteRequestUnprocessableEntityError"},"UsersCustomerCustomerIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"message":{"type":"string","default":"Not Found Error","description":"Human-readable status message."}},"title":"UsersCustomerCustomerIdGetResponsesContentApplicationJsonSchemaMeta"},"Users_companies_user_read_Response_200":{"type":"object","properties":{"code":{"type":"integer","default":200,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/userResponse"},"meta":{"$ref":"#/components/schemas/UsersCustomerCustomerIdGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Users_companies_user_read_Response_200"},"UsersCustomerCustomerIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"errMsg":{"type":"string","default":"User matching query does not exist."}},"title":"UsersCustomerCustomerIdGetResponsesContentApplicationJsonSchemaData"},"Companies_user_readRequestNotFoundError":{"type":"object","properties":{"code":{"type":"integer","default":404,"description":"Operation status code."},"data":{"$ref":"#/components/schemas/UsersCustomerCustomerIdGetResponsesContentApplicationJsonSchemaData"},"meta":{"$ref":"#/components/schemas/UsersCustomerCustomerIdGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Companies_user_readRequestNotFoundError"},"ExtraFieldDetailFieldType":{"type":"string","enum":["0","1","2","3"],"description":"The data type allowed by the extra field. The supported types are text (`0`), multiline text (`1`), number (`2`), and dropdown (`3`).","title":"ExtraFieldDetailFieldType"},"ExtraFieldDetailConfigType":{"type":"string","enum":["2","1"],"description":"Indicates whether the extra field is built in (`1`) or user defined (`2`).","title":"ExtraFieldDetailConfigType"},"extraFieldDetail":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"The unique numeric ID for the extra field."},"uuid":{"type":"string","format":"uuid","description":"UUID of the extra field assigned by B2B Edition."},"fieldName":{"type":"string","description":"The name of the extra field displayed in B2B Edition."},"fieldType":{"$ref":"#/components/schemas/ExtraFieldDetailFieldType","description":"The data type allowed by the extra field. The supported types are text (`0`), multiline text (`1`), number (`2`), and dropdown (`3`)."},"isRequired":{"type":"boolean","description":"Indicates whether the extra field requires a value when creating or updating the user account."},"isUnique":{"type":"boolean","description":"Indicates whether the extra field's value is required to be unique when present."},"visibleToEnduser":{"type":"boolean","description":"Indicates whether the extra field is visible on the storefront."},"configType":{"$ref":"#/components/schemas/ExtraFieldDetailConfigType","description":"Indicates whether the extra field is built in (`1`) or user defined (`2`)."},"defaultValue":{"type":"string","description":"The default value the extra field takes, if it exists."},"maximumLength":{"type":"string","description":"The maximum character length for text extra fields (type `0`)."},"numberOfRows":{"type":"string","description":"The maximum number of rows for textarea extra fields (type `1`)."},"maximumValue":{"type":"string","description":"The maximum value of number extra fields (type `2`)."},"listOfValue":{"type":"array","items":{"type":"string"},"description":"The list of values for dropdown extra fields (type `3`)."}},"title":"extraFieldDetail"},"UsersExtraFieldsGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/paginationObject"},"message":{"type":"string"}},"title":"UsersExtraFieldsGetResponsesContentApplicationJsonSchemaMeta"},"Users_get_users_extra_fields_Response_200":{"type":"object","properties":{"code":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/extraFieldDetail"}},"meta":{"$ref":"#/components/schemas/UsersExtraFieldsGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Users_get_users_extra_fields_Response_200"}},"securitySchemes":{"X-Auth-Token":{"type":"apiKey","in":"header","name":"X-Auth-Token","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). |\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes)."},"X-Store-Hash":{"type":"apiKey","in":"header","name":"X-Store-Hash","description":"| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |"},"authToken":{"type":"apiKey","in":"header","name":"authToken","description":"Required to authenticate requests. Include the token in a header parameter called `authToken`."}}}}