generated: '2026-10-12' method: derived generator: derive-data-model.py source: - openapi/bigcommerce-abandoned-cart-emails-api-openapi.yml - openapi/bigcommerce-abandoned-cart-settings-api-openapi.yml - openapi/bigcommerce-abandoned-carts-api-openapi.yml - openapi/bigcommerce-abandoned-carts-settings-api-openapi.yml - openapi/bigcommerce-active-theme-api-openapi.yml - openapi/bigcommerce-addresses-api-openapi.yml - openapi/bigcommerce-analytics-api-openapi.yml - openapi/bigcommerce-api-token-api-openapi.yml - openapi/bigcommerce-attribute-values-api-openapi.yml - openapi/bigcommerce-attributes-api-openapi.yml - openapi/bigcommerce-banners-api-openapi.yml - openapi/bigcommerce-batch-metafields-api-openapi.yml notation: has_one = property $ref; has_many = array of $ref; belongs_to = _id field summary: entities: 400 entities_in_spec: 544 relationships: 270 entities: - name: 301RedirectImportExportJobRead fields: 9 description: Full detail of a Redirect Import-Export job. - name: 301RedirectRead fields: 5 description: Full detail of a Redirect, optionally including the full destination URL. - name: 301RedirectUpsert fields: 3 description: Data necessary to create or update a redirect. If there’s a conflict on the from_path and site_id, the redirect will be overwritten with new data. - name: AbandondedCartEmail fields: 6 - name: AbandondedCartEmailPayload fields: 4 - name: AbandonedCartSettings fields: 8 description: Represents all settings related to the abandoned cart functionality of a store - name: Activate fields: 2 description: Request definition for activation endpoint. - name: ActiveTheme fields: 4 description: Details about the Channelʼs relationship to Themes. - name: Address fields: 10 description: Requests may have partial Address data. For example, the BigCommerce Cart page has the "Estimate Shipping & Tax" feature which is only expected to supply Country, Region and Postal Code. - name: AddressProperties fields: 13 - name: AmountBoundItem fields: 5 description: Amount Bound Item - name: AnalyticsProvider fields: 4 - name: AppliedCoupon fields: 4 description: '|Type `int`|Type Name|' - name: AppliedDiscount fields: 1 - name: AssignmentForGetResponse fields: 4 - name: AssignmentForPutRequest fields: 2 - name: AssignmentForPutResponse fields: 2 - name: AssignmentsForGetResponse fields: 2 description: Array of the price list assignments matching the filter. The response is paginated. - name: AssignmentsForRequest fields: 3 description: '`Price List Assignments` object used in a batch create request.' - name: AvailableFilter fields: 0 - name: AvailableNormalFilter fields: 4 - name: AvailableOtherFilter fields: 3 - name: AvailablePriceFilter fields: 5 - name: BankAccountInstrument fields: 5 description: A stored bank account instrument. - name: BaseError fields: 4 description: Error payload for the BigCommerce API. - name: BaseOptions fields: 6 description: The minimum required payload that is sent to retrieve rates. - name: BillingAddress fields: 12 - name: BulkPricingTier fields: 4 - name: Card fields: 9 - name: CardInstrument fields: 9 description: Details about a stored card instrument which includes details around billing, last 4 digits, issuer, etc. - name: CartCoupon fields: 5 - name: CartCreatePostData fields: 7 - name: CartSettings fields: 1 description: Represents all settings related to the shopping cart functionality of a store. - name: CartUpdatePutRequestData fields: 1 - name: Cart_Full fields: 17 description: A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data. - name: Cart_Line_Item_Update_Post fields: 3 - name: Cart_Line_Item_Update_Put fields: 3 - name: CatalogSettings fields: 2 - name: Category fields: 0 - name: CategoryBase fields: 11 - name: CategoryList fields: 2 - name: CategoryNode fields: 7 - name: CategoryNodeTree fields: 2 - name: CategoryTree fields: 2 - name: CategoryTreeList fields: 2 - name: CertificateResponse fields: 2 - name: CertificateWrite fields: 3 - name: ChannelAbandonedCartSettings fields: 8 description: Represents all settings overrides related to the abandoned cart functionality of a store for a channel - name: ChannelAbandonedCartSettingsRequest fields: 0 - name: ChannelAbandonedCartSettingsResponse fields: 2 description: The response object of abandoned cart settings overrides for a channel - name: ChannelCartSettings fields: 1 description: Represents all settings overrides related to the shopping cart functionality of a store for a channel. - name: ChannelCartSettingsRequest fields: 0 - name: ChannelCartSettingsResponse fields: 2 description: The response object of cart settings overrides for a channel. - name: ChannelConfigMeta fields: 1 description: Optional channel configuration object. - name: ChannelOrderSettings fields: 1 - name: ChannelProductVariantFull fields: 9 description: Details about a variant of the product for this channel listing. - name: ChannelProductVariantPartial fields: 6 description: Details about a variant of the product for this channel listing. - name: ChannelWithCurrencies fields: 13 - name: ChannelWithoutCurrencies fields: 12 - name: CheckConnectionOptionsRequestPayload fields: 1 description: The payload sent to a Shipping Provider to check that the store is connected to this provider. - name: CheckConnectionOptionsResponsePayload fields: 2 description: The response received back from the Shipping Provider connection check. This allows the store to understand whether the connection was successful. - name: Checkout fields: 19 - name: CheckoutCoupon fields: 5 - name: Checkout_Put fields: 1 - name: CheckoutsSettings fields: 4 - name: CheckoutsSettingsRequest fields: 4 - name: CollectionMeta fields: 1 description: Data about the response, including pagination and collection totals. - name: CollectionMeta_2 fields: 1 description: Data about the response, including pagination and collection totals. - name: ConfiguredFiltersOverride fields: 2 description: 'A new set of enabled Product Filtering filters which should display in a particular context, such as on a particular Channel, or while viewing a particular Category. Array order indicates the display ' - name: ConnectionOptionsInstance fields: 0 description: Any global request options declared by the carrier and configured by the merchant to retrieve rates. Optional. - name: ConsentPreferences fields: 2 description: List of allowed and denied consent categories. Must be populated with a complete set of allowed and denied categories. - name: ConsignmentFormField fields: 2 - name: ConsignmentLineItem fields: 1 - name: Consignments fields: 1 description: All the consignments of the order. - name: CouponCodeRequest fields: 1 - name: CreateChannelReq fields: 8 - name: CreateConsignmentRequest_2 fields: 5 - name: CreditCard fields: 5 description: A credit-card model. - name: Currency fields: 4 description: This will always be the same between cart and checkout. - name: CurrencyNotRequiredWithChannelId fields: 3 description: Details about currency assignments for a specific channel. - name: CurrencyRequiredWithChannelId fields: 3 description: Details about currency assignments for a specific channel. - name: CurrencyRequiredWithoutChannelId fields: 2 description: Details about currency assignments for a specific channel. - name: CustomField fields: 2 - name: CustomTemplateAssociation fields: 8 - name: CustomTemplateAssociationUpsert fields: 4 - name: CustomerChannelSettingsObject fields: 3 - name: CustomerSettingsObject fields: 2 description: Customer Settings. - name: DateFormat fields: 3 - name: DeclareCustomerConsentRequest fields: 2 description: Request payload for the BigCommerce API. - name: DetailedErrors fields: 0 description: Each key-value pair describes a failure or partial success case. - name: EmailTemplate fields: 4 description: Data for a particular email template - name: EmptyMeta fields: 0 description: Response metadata. - name: EmptyResponse fields: 2 - name: EnabledBrandFilter fields: 8 description: A storefront filter for product brand - name: EnabledCategoryFilter fields: 7 description: A storefront filter for product category - name: EnabledMiscFilter fields: 10 description: Miscellaneous Filters which appear as a group. - name: EnabledPriceFilter fields: 5 description: A filter based on the product’s price, shown as a price range on the storefront. - name: EnabledProductFilter fields: 8 description: A filter that uses product options and custom field data. - name: EnabledRatingFilter fields: 5 description: A filter based on product review ratings. - name: EnabledTransactionalEmails fields: 11 - name: Error fields: 4 description: Error response payload for the BigCommerce API. - name: ErrorAdditional fields: 1 - name: ErrorBasic fields: 3 - name: ErrorDetail fields: 0 description: Error detail response payload for the BigCommerce API. - name: ErrorRequest fields: 1 - name: ErrorResponse fields: 5 description: The response object containing details of an error - name: ErrorResponse400 fields: 1 - name: ErrorResponse404 fields: 1 - name: ErrorResponse409 fields: 1 - name: ErrorResponse422 fields: 1 - name: ErrorResponse_2 fields: 0 - name: Error_2 fields: 4 description: Error response payload for the BigCommerce API. - name: FailedQuoteError fields: 3 description: Failed quote response. - name: FormField fields: 13 description: Form Field - name: FormFieldGroups fields: 3 description: Group of form field groups - name: GeneralError fields: 4 - name: GeneralErrorWithErrors fields: 4 - name: GetCategories fields: 0 - name: GetCertificatesResponse fields: 2 - name: GiftCertificate fields: 2 - name: GiftCertificateRequest fields: 1 - name: GiftWrapping fields: 3 - name: GlobalAbandonedCartSettingsRequest fields: 0 - name: GlobalAbandonedCartSettingsResponse fields: 2 description: The response object of abandoned cart settings at the global level - name: GlobalCartSettingsRequest fields: 0 - name: GlobalCartSettingsResponse fields: 2 description: The response object of cart settings at the global level. - name: GlobalOrderSettings fields: 1 - name: HistoryEvent fields: 6 - name: IndexMeta fields: 1 description: BigCommerce meta payload for collection-type responses. - name: InstallCertificateData fields: 2 - name: InstalledCertificateDetail fields: 8 description: Details about the installed certificate, including the raw certificate data, without the private key. - name: InventoryNotificationsSettings fields: 2 - name: InventorySettings fields: 10 - name: ItemCustomGet fields: 5 description: Add a custom item to the shopperʼs cart. - name: ItemDigitalGet fields: 0 - name: ItemGiftCertificateGet fields: 8 - name: ItemPhysical fields: 23 - name: ItemPhysicalGet fields: 0 - name: JobId fields: 1 description: The job identifier for theme upload or download. - name: JobResponse fields: 2 description: Response for /GET Jobs by Id. - name: LineItemsGet fields: 4 description: '`GET`' - name: LineItemsRequest fields: 0 description: Cart object used in add items requests. - name: Links fields: 3 description: Pagination links for the previous and next parts of the whole collection. - name: Listing fields: 10 - name: Locale fields: 3 description: The basic locale settings for a store, used to give shopper information about languages, countries, etc. - name: LocaleObject fields: 2 description: A particular localeʼs translations. - name: LogoSettings fields: 4 - name: LogoSettingsUpdate fields: 2 - name: MeasurementUnitsSettings fields: 6 - name: MerchantOverride fields: 2 description: Merchant explicitly provided override based on their own calculation. - name: Meta fields: 1 - name: MetaData fields: 3 - name: MetaError fields: 0 - name: MetaFieldCollectionDeleteResponseSuccess fields: 3 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionPostPutResponses fields: 3 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse fields: 2 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponsePartialSuccess_DELETE fields: 3 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponsePartialSuccess_POST_PUT fields: 3 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse_2 fields: 2 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse_3 fields: 2 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse_4 fields: 2 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse_5 fields: 2 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse_6 fields: 2 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse_Batch fields: 2 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse_Batch_POST_PUT fields: 3 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse_POST_PUT fields: 3 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse_POST_PUT_2 fields: 3 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse_POST_PUT_3 fields: 3 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse_POST_PUT_4 fields: 3 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse_POST_PUT_5 fields: 3 description: Response payload for the BigCommerce API. - name: MetaFieldCollectionResponse_POST_PUT_6 fields: 3 description: Response payload for the BigCommerce API. - name: MetaOpen fields: 0 description: Response metadata. - name: MetaPagination fields: 1 - name: MetaPaginationObject fields: 1 - name: MetaWithFullPagination fields: 1 description: Data about the response, including pagination. - name: MetaWithPartialPagination fields: 1 description: Data about the response, including pagination. - name: Metafield fields: 0 description: Allows app partners to write custom data to various resources in the API. - name: MetafieldBase fields: 7 description: Common Metafield properties. - name: MetafieldBase_2 fields: 7 description: Common Metafield properties. - name: MetafieldBase_Post fields: 5 description: Common Metafield properties. - name: MetafieldBase_Post_2 fields: 5 description: Common Metafield properties. - name: MetafieldBase_Put fields: 5 description: Common Metafield properties. - name: MetafieldPost fields: 0 description: The model for a POST to create metafield. - name: MetafieldPut fields: 0 description: The model for a PUT to create metafield. - name: MetafieldResponse fields: 0 description: Response payload for the BigCommerce API. - name: MetafieldResponse_2 fields: 0 description: Response payload for the BigCommerce API. - name: Metafield_2 fields: 11 description: Common Metafield properties. - name: Metafield_3 fields: 11 description: Common Metafield properties. - name: Metafield_4 fields: 11 description: Common Metafield properties. - name: Metafield_5 fields: 11 description: Common Metafield properties. - name: Metafield_6 fields: 11 description: Common Metafield properties. - name: Metafield_7 fields: 0 description: Allows app partners to write custom data to various resources in the API. - name: MethodNotAllowedError fields: 4 - name: MultiStatus fields: 3 - name: NewUpdateConsignment fields: 5 description: One or more of these three fields is mandatory. You can update address and line items in one request. You have to update shipping option ID or pickup option ID in a separate request since changing the - name: NoContent fields: 4 description: No-content response for the BigCommerce API. - name: NotFound fields: 4 description: Error payload for the BigCommerce API. - name: OpenMeta fields: 0 description: Response metadata. - name: Order fields: 1 - name: OrderItemDigital fields: 23 - name: OrderItemGiftCertificate fields: 5 - name: OrderLineItem fields: 3 - name: Page fields: 0 - name: PageBase fields: 7 description: Common Page properties. - name: PagePut fields: 18 description: Properties of the page modification request body. - name: PagePutBulk fields: 19 description: Properties of the page modification request body. - name: PageResponse fields: 0 description: Response payload for the BigCommerce API. - name: PagesCollectionResponse fields: 2 description: Response payload for the BigCommerce API. - name: Pagination fields: 6 description: Data about the response, including pagination and collection totals. - name: PartialSuccessNoContentResponse fields: 2 - name: PartialSuccessResponse fields: 3 - name: PayPalAccountInstrument fields: 4 description: A PayPal account stored instrument. - name: PaymentOption fields: 6 - name: PaymentRequest fields: 3 - name: PickupOption fields: 1 - name: PickupOption_2 fields: 1 description: An option that represents a location where customers can pick up items. - name: PriceListAssignmentsBatchErrorResponse fields: 5 - name: PriceRecordBase fields: 5 description: Common Price Record properties. - name: PriceRecordBatchErrorResponse fields: 2 description: Error during `Price Record` batch PUT. Includes data sent in the request and errors. - name: PriceRecordBatchItem fields: 5 - name: PriceRecordIdentifiers fields: 0 description: The `Price Record` object used in batch create or update. - name: ProductCategoryAssignment fields: 2 - name: ProductChannelAssignment fields: 2 - name: ProductTaxProperty fields: 2 description: A collection of tax property values associated with a product. - name: Property fields: 6 - name: PropertyPOST fields: 3 - name: PropertyPUT fields: 4 - name: PutCheckoutUrl fields: 1 - name: QuantityBoundItem fields: 4 description: Quantity Bound Item - name: RateRequestPayload fields: 3 description: Payload sent to a Shipping Provider to get quotes. - name: RateResponsePayload fields: 3 description: The response from the Shipping Service. Contains zero or more quotes. - name: RedirectTo fields: 3 - name: Redirect_urls_Post fields: 1 - name: Refund fields: 10 - name: RefundID_Get fields: 2 - name: RefundItem fields: 5 - name: RefundPayment fields: 6 - name: RefundQuote_Full fields: 7 - name: RefundQuote_Post fields: 1 description: Request body for refund quotes. - name: RefundRequest_Post fields: 3 description: Request body for refund requests. - name: ResponseErrorBrief fields: 3 description: Error payload for the BigCommerce API. - name: ResponseErrorDetailed fields: 4 description: Error payload for the BigCommerce API. - name: ResponseErrorItemized fields: 4 description: Error payload for the BigCommerce API. - name: ResponseMeta fields: 1 description: Data about the response, including pagination and collection totals. - name: RobotsTxtSettings fields: 1 - name: SEOSettings fields: 4 - name: SalesTax fields: 5 - name: SaveError fields: 4 - name: SearchFilterOverrideContextIdentifier fields: 2 - name: ShippingConsignment fields: 30 description: Shipping consignment - name: Site fields: 8 - name: StoreInformation fields: 38 - name: Subscription fields: 7 description: Subscription properties. - name: SuccessNoContentResponse fields: 1 - name: SuccessResponse fields: 2 - name: TaxClass fields: 3 - name: TaxZone fields: 5 - name: Tax_Rate fields: 6 - name: Tax_RatePOST fields: 5 - name: Tax_RatePUT fields: 6 - name: Template fields: 3 - name: Theme fields: 4 description: A theme. - name: ThemeResponse fields: 2 description: Response payload for the BigCommerce API. - name: Timezone fields: 5 - name: Token_Base fields: 1 - name: Token_Full fields: 2 - name: Transaction fields: 0 - name: TranslationDefinition fields: 2 - name: Tree fields: 3 - name: UpdateChannelReq fields: 6 - name: UpsertListingWithListingIdReq fields: 7 description: Details about assigning a product to a specific channel. - name: Url fields: 2 - name: WriteCollectionPartialSuccessMeta fields: 3 description: Additional data about the response. - name: WriteCollectionSuccessMeta fields: 3 description: Additional data about the response. - name: ZoneOptionsInstance fields: 0 description: Any zone-specific request options declared by the carrier and configured by the merchant to retrieve rates. Optional. - name: _metaCollection fields: 1 description: Data about the response, including pagination and collection totals. - name: _site fields: 8 - name: address_Base fields: 13 - name: address_Full fields: 0 - name: address_Post fields: 13 - name: address_Put fields: 13 - name: adjuster_Full fields: 2 description: Adjuster for Complex Rules. - name: adjusters_Full fields: 4 - name: attribute_Full fields: 6 - name: beta4DetailedErrors fields: 0 - name: beta4ErrorResponse fields: 0 - name: beta5DetailedErrors fields: 0 - name: beta5ErrorResponse fields: 0 - name: blogPost_Base_Res fields: 13 description: blog post base response - name: brand_Full fields: 8 description: Common Brand properties. - name: bulkPricingRule_Full fields: 4 description: Common Bulk Pricing Rule properties - name: cartLineItemGiftCertificate_Put fields: 6 - name: cartLineItemGiftWrapping_Put fields: 2 description: if passing null, it will remove the current gift wrapping for the item - name: cartLineItemPut fields: 4 - name: cart_PostModifier fields: 5 description: Product with a modifier. - name: cart_PostVariant fields: 6 description: Product with a variant. - name: cart_Put fields: 2 - name: categoriesTreeNode_Full fields: 5 description: Used to reflect parent <> child category relationships. Used by Category Tree. - name: categoriesTree_Resp fields: 2 description: Returns the categories tree, a nested lineage of the categories with parent->child relationship. The Category objects returned are simplified versions of the category objects returned in the rest of t - name: category_Full fields: 15 description: Common Category object properties. - name: checkoutCart fields: 13 description: A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data. - name: checkoutTax fields: 2 - name: checkout_Full fields: 19 - name: complexRuleConditionBase fields: 6 description: Complex rules may return with conditions that apply to one or more variants, or with a single modifier value (if the rules were created using the v2 API or the control panel). Complex rules created or - name: complexRule_Base fields: 12 description: Common ComplexRule properties. - name: config_Full fields: 24 description: The values for option config can vary based on the Modifier created. - name: consignmentAvailableShippingOptions fields: 0 - name: consignment_Full fields: 11 description: This allows us to have multiple shipping addresses. Where there is only one shipping address, this array will contain only one value, with all the items. - name: contactEntity fields: 2 description: Model for sender and receiver objects. - name: countriesStates_Full fields: 2 description: Refers to the `states` object return in `GET` countries requests. - name: country_Full fields: 0 - name: customFields fields: 2 description: When doing a PUT or POST to the `fieldValue` with a pick list, the input must be a number. The response will be a string. - name: customUrl_Full fields: 2 description: The custom URL for the product on the storefront. - name: customerAddresses_CustomerPost fields: 12 description: The `address` object for the `customer` objectʼs `addresses` array. - name: customerAttributes_Base fields: 2 - name: customerAuthentication_PostPut fields: 0 - name: customer_Full fields: 22 - name: customer_Post fields: 16 - name: customer_Put fields: 16 - name: customsInformation fields: 7 description: Data about the customs information object. - name: customsInformation_request fields: 5 description: Data about the customs information object. - name: errorMultiStatus fields: 4 - name: errorResponse_409 fields: 0 - name: errorResponse_422 fields: 0 - name: formFieldValue fields: 2 - name: formFieldValue_Address fields: 3 - name: formFieldValue_Customer fields: 3 - name: forward fields: 2 - name: giftCertificate_Full fields: 0 - name: harmonizedSystemCodes fields: 0 description: 'Key-value pairs that are commonly used in the following form: ' - name: metaCollection_Full fields: 1 description: Data about the response, including pagination and collection totals. - name: metaCollection_open fields: 0 description: Response metadata. - name: metaEmpty_Full fields: 0 description: Response metadata. - name: pagination_Full fields: 6 description: Data about the response, including pagination and collection totals. - name: pagination_Partial fields: 4 description: Data about the pagination. - name: paymentMethodStoredInstrument fields: 8 - name: paymentMethod_Full fields: 6 - name: placement_Full fields: 0 - name: productCustomField_Put fields: 3 description: The model for a PUT to update a custom field on a product. - name: productImage_Full fields: 0 description: Common ProductImage properties. - name: productModifierOptionValue_Base fields: 5 description: Common Product Modifer `option_value` properties. - name: productModifierOptionValue_Full fields: 0 description: Product Modifer `option_value`. - name: productModifier_Base fields: 5 description: Common Modifier properties. - name: productModifier_Full fields: 0 description: Product Modifier - name: productOptionConfig_Full fields: 24 description: The values for option config can vary based on the Modifier created. - name: productOptionOptionValue_Full fields: 0 description: Product Option `option_value`. - name: productOption_Base fields: 7 description: Common Option properties. - name: productVariantOptionValue_Full fields: 0 - name: productVariant_Full fields: 0 - name: productVariant_Post fields: 0 description: The model for a POST to create variants on a product. - name: productVideo_Full fields: 0 description: A product video model. - name: product_Base fields: 67 description: 'Shared `Product` properties used in:' - name: product_Full fields: 0 - name: publishedDate fields: 3 - name: redirect fields: 4 - name: request-document fields: 7 description: Each **DocumentRequest** represents an order or part of an order of items fulfilled from a single origin address to a single destination address. In addition to shipping and billing details, a documen - name: request-item fields: 9 description: An **ItemRequest** represents required information relating to completing tax calculations for a specific line item. - name: request-item-tax-property fields: 2 description: A simple key value pairing allowing merchants to provide an additional input into a tax providerʼs tax calculation. - name: request-quote fields: 5 description: Each **QuoteRequest** represents an order. In addition to transaction details, it contains a `documents` array of one or more **DocumentRequest** objects, which represent distinct combinations of orig - name: requestLineItemGiftCertificate fields: 7 - name: requestLineItemGiftCertificateRecipient fields: 2 - name: requestLineItemGiftCertificateSender fields: 2 - name: response-document fields: 5 - name: response-item fields: 2 description: The tax liabilities calculated for a specific item. - name: response-quote fields: 2 - name: response-taxprice fields: 5 - name: responseCart fields: 14 description: Cart object used in REST Storefront API cart responses. - name: responseCartBaseItem fields: 20 - name: responseCartCurrency fields: 1 description: This will always be the same between cart and checkout. - name: responseCartLineItems fields: 4 - name: responseCartLineItemsCustomItems fields: 6 description: '**Read Only**' - name: responseCartLineItemsDigitalItems fields: 0 - name: responseCartLineItemsDigitalItemsAllOf0 fields: 20 - name: responseCartLineItemsDigitalItemsAllOf0DiscountsItems fields: 2 - name: responseCartLineItemsDigitalItemsAllOf0OptionsItems fields: 4 - name: responseCartLineItemsGiftCertificates fields: 8 - name: responseCartLineItemsGiftCertificatesRecipient fields: 2 - name: responseCartLineItemsGiftCertificatesSender fields: 2 - name: responseCartLineItemsItemsPhysicalItemsItems fields: 0 - name: responseCartLineItemsItemsPhysicalItemsItemsAllOf0OptionsItems fields: 4 - name: responseCartLineItemsItemsPhysicalItemsItemsAllOf1 fields: 2 - name: responseCartLineItemsPhysicalItemGiftWrapping fields: 3 - name: script_Full fields: 0 - name: script_Response fields: 2 description: For a list of all locations visit [Scripts Visibility](/docs/integrations/scripts#script-visibility-locations). - name: subscriber_Base fields: 6 description: Common Subscriber properties. - name: themeConfiguration_Full fields: 6 description: A theme. - name: typeBlog fields: 0 - name: typeContactForm fields: 0 - name: typeFeed fields: 0 - name: typeLink fields: 0 - name: typePage fields: 0 description: 'Schema for a Pages V3 page with `type: page`' - name: typeRaw fields: 0 - name: url fields: 2 description: If not provided, the URL is autogenerated from the category name. - name: widgetSchemaArray fields: 7 description: '**Array.** Use the **array** settings type to build collections of elements within the widget. Each element in the array can contain tabs, sections, and an entire schema.' - name: widgetSchemaHidden fields: 2 description: '**Hidden.** Use the **hidden** settings type to create controls that have no user interface drawn in Page Builder. Hidden settings are not grouped into any other tabs or arrays.' - name: widgetSchemaTab fields: 3 description: '**Tab.** Use the **tab** settings type to create settings visible in Page Builder.' - name: widgetTemplate_Full fields: 0 - name: widget_Full fields: 0 - name: wishlistItem_Full fields: 3 - name: wishlist_Full fields: 6 relationships: - from: Template to: TranslationDefinition type: has_many via: translations - from: AbandondedCartEmailPayload to: Template type: has_one via: template - from: AbandondedCartEmail to: Template type: has_one via: template - from: GlobalAbandonedCartSettingsResponse to: AbandonedCartSettings type: has_one via: data - from: GlobalAbandonedCartSettingsResponse to: metaEmpty_Full type: has_one via: meta - from: ChannelAbandonedCartSettingsResponse to: ChannelAbandonedCartSettings type: has_one via: data - from: ChannelAbandonedCartSettingsResponse to: metaEmpty_Full type: has_one via: meta - from: Error to: ErrorDetail type: has_one via: errors - from: address_Put to: formFieldValue type: has_many via: form_fields - from: _metaCollection to: Pagination type: has_one via: pagination - from: address_Post to: formFieldValue type: has_many via: form_fields - from: formFieldValue_Address to: Address type: belongs_to via: address_id - from: Pagination to: Links type: has_one via: links - from: ErrorResponse404 to: Error type: has_one via: schema - from: ErrorResponse400 to: Error type: has_one via: schema - from: ErrorResponse422 to: Error type: has_one via: schema - from: ErrorResponse409 to: Error type: has_one via: schema - from: Token_Full to: Token_Base type: has_one via: data - from: MetaFieldCollectionResponsePartialSuccess_DELETE to: Error type: has_many via: errors - from: MetaFieldCollectionResponsePartialSuccess_DELETE to: WriteCollectionPartialSuccessMeta type: has_one via: meta - from: MetaFieldCollectionResponse_Batch_POST_PUT to: Metafield type: has_many via: data - from: MetaFieldCollectionResponse_Batch_POST_PUT to: CollectionMeta type: has_one via: meta - from: MetaFieldCollectionDeleteResponseSuccess to: WriteCollectionSuccessMeta type: has_one via: meta - from: MetaFieldCollectionResponse_Batch to: Metafield type: has_many via: data - from: MetaFieldCollectionResponse_Batch to: CollectionMeta type: has_one via: meta - from: MetaFieldCollectionResponsePartialSuccess_POST_PUT to: Metafield type: has_many via: data - from: MetaFieldCollectionResponsePartialSuccess_POST_PUT to: Error type: has_many via: errors - from: MetaFieldCollectionResponsePartialSuccess_POST_PUT to: WriteCollectionPartialSuccessMeta type: has_one via: meta - from: MetaFieldCollectionResponse_POST_PUT to: Metafield_2 type: has_many via: data - from: MetaFieldCollectionResponse_POST_PUT to: CollectionMeta type: has_one via: meta - from: MetaFieldCollectionResponse to: Metafield_2 type: has_many via: data - from: MetaFieldCollectionResponse to: CollectionMeta type: has_one via: meta - from: MetaFieldCollectionResponse_POST_PUT_2 to: Metafield_3 type: has_many via: data - from: MetaFieldCollectionResponse_POST_PUT_2 to: CollectionMeta type: has_one via: meta - from: MetaFieldCollectionResponse_2 to: Metafield_3 type: has_many via: data - from: MetaFieldCollectionResponse_2 to: CollectionMeta type: has_one via: meta - from: MetaFieldCollectionResponse_POST_PUT_3 to: Metafield_4 type: has_many via: data - from: MetaFieldCollectionResponse_POST_PUT_3 to: CollectionMeta type: has_one via: meta - from: MetaFieldCollectionResponse_3 to: Metafield_4 type: has_many via: data - from: MetaFieldCollectionResponse_3 to: CollectionMeta type: has_one via: meta - from: MetaFieldCollectionResponse_POST_PUT_4 to: Metafield_5 type: has_many via: data - from: MetaFieldCollectionResponse_POST_PUT_4 to: CollectionMeta type: has_one via: meta - from: MetaFieldCollectionResponse_4 to: Metafield_5 type: has_many via: data - from: MetaFieldCollectionResponse_4 to: CollectionMeta type: has_one via: meta - from: MetaFieldCollectionResponse_POST_PUT_5 to: Metafield_6 type: has_many via: data - from: MetaFieldCollectionResponse_POST_PUT_5 to: CollectionMeta type: has_one via: meta - from: MetaFieldCollectionResponse_5 to: Metafield_6 type: has_many via: data - from: MetaFieldCollectionResponse_5 to: CollectionMeta type: has_one via: meta - from: Error_2 to: ErrorDetail type: has_one via: errors - from: MetaFieldCollectionResponse_POST_PUT_6 to: Metafield_7 type: has_many via: data - from: MetaFieldCollectionResponse_POST_PUT_6 to: CollectionMeta_2 type: has_one via: meta - from: MetaFieldCollectionResponse_6 to: Metafield_7 type: has_many via: data - from: MetaFieldCollectionResponse_6 to: CollectionMeta_2 type: has_one via: meta - from: blogPost_Base_Res to: publishedDate type: has_one via: published_date - from: brand_Full to: customUrl_Full type: has_one via: custom_url - from: metaCollection_Full to: pagination_Full type: has_one via: pagination - from: responseCartLineItemsItemsPhysicalItemsItemsAllOf1 to: responseCartLineItemsPhysicalItemGiftWrapping type: has_one via: giftWrapping - from: requestLineItemGiftCertificate to: requestLineItemGiftCertificateRecipient type: has_one via: recipient - from: requestLineItemGiftCertificate to: requestLineItemGiftCertificateSender type: has_one via: sender - from: responseCartLineItemsGiftCertificates to: responseCartLineItemsGiftCertificatesRecipient type: has_one via: recipient - from: responseCartLineItemsGiftCertificates to: responseCartLineItemsGiftCertificatesSender type: has_one via: sender - from: responseCartBaseItem to: responseCartLineItemsItemsPhysicalItemsItemsAllOf0OptionsItems type: has_many via: options - from: responseCartLineItems to: responseCartLineItemsCustomItems type: has_many via: customItems - from: responseCartLineItems to: responseCartLineItemsDigitalItems type: has_many via: digitalItems - from: responseCartLineItems to: responseCartLineItemsGiftCertificates type: has_many via: giftCertificates - from: responseCartLineItems to: responseCartLineItemsItemsPhysicalItemsItems type: has_many via: physicalItems - from: responseCartLineItemsDigitalItemsAllOf0 to: responseCartLineItemsDigitalItemsAllOf0OptionsItems type: has_many via: options - from: responseCartLineItemsDigitalItemsAllOf0 to: responseCartLineItemsDigitalItemsAllOf0DiscountsItems type: has_many via: discounts - from: responseCart to: responseCartCurrency type: has_one via: currency - from: responseCart to: responseCartLineItems type: has_one via: lineItems - from: LineItemsGet to: ItemPhysicalGet type: has_many via: physical_items - from: LineItemsGet to: ItemDigitalGet type: has_many via: digital_items - from: LineItemsGet to: ItemGiftCertificateGet type: has_many via: gift_certificates - from: LineItemsGet to: ItemCustomGet type: has_many via: custom_items - from: Cart_Full to: AppliedCoupon type: has_many via: coupons - from: Cart_Full to: LineItemsGet type: has_one via: line_items - from: CartCreatePostData to: cart_PostVariant type: has_many via: line_items - from: CartCreatePostData to: cart_PostModifier type: has_many via: line_items - from: SuccessNoContentResponse to: MetaData type: has_one via: meta - from: SuccessResponse to: GetCategories type: has_many via: data - from: SuccessResponse to: MetaData type: has_one via: meta - from: PartialSuccessResponse to: GetCategories type: has_many via: data - from: PartialSuccessResponse to: MetaError type: has_one via: errors - from: PartialSuccessResponse to: MetaData type: has_one via: meta - from: ErrorRequest to: ErrorBasic type: has_many via: errors - from: ErrorAdditional to: DetailedErrors type: has_one via: errors - from: PartialSuccessNoContentResponse to: MetaError type: has_one via: errors - from: PartialSuccessNoContentResponse to: MetaData type: has_one via: meta - from: GetCategories to: Category type: belongs_to via: category_id - from: GetCategories to: Tree type: belongs_to via: tree_id - from: GetCategories to: url type: has_one via: url - from: CategoryList to: GetCategories type: has_many via: data - from: CategoryList to: MetaPagination type: has_one via: meta - from: Category to: Url type: has_one via: custom_url - from: category_Full to: customUrl_Full type: has_one via: custom_url - from: beta5ErrorResponse to: beta5DetailedErrors type: has_one via: errors - from: ProductCategoryAssignment to: Category type: belongs_to via: category_id - from: CategoryTreeList to: Tree type: has_many via: data - from: CategoryTreeList to: MetaPaginationObject type: has_one via: meta - from: CategoryTree to: Tree type: has_many via: data - from: CategoryTree to: metaEmpty_Full type: has_one via: meta - from: beta4ErrorResponse to: beta4DetailedErrors type: has_one via: errors - from: CategoryNodeTree to: CategoryNode type: has_many via: data - from: CategoryNodeTree to: metaEmpty_Full type: has_one via: meta - from: ChannelWithoutCurrencies to: ChannelConfigMeta type: has_one via: config_meta - from: UpdateChannelReq to: ChannelConfigMeta type: has_one via: config_meta - from: CreateChannelReq to: ChannelConfigMeta type: has_one via: config_meta - from: MetaWithFullPagination to: pagination_Full type: has_one via: pagination - from: ChannelWithCurrencies to: ChannelConfigMeta type: has_one via: config_meta - from: ChannelWithCurrencies to: CurrencyNotRequiredWithChannelId type: has_one via: currencies - from: Checkout to: AppliedCoupon type: has_many via: coupons - from: Checkout to: Order type: belongs_to via: order_id - from: address_Base to: customFields type: has_many via: customFields - from: checkoutCart to: CartCoupon type: has_many via: coupons - from: consignment_Full to: address_Full type: has_one via: address - from: consignment_Full to: PickupOption_2 type: has_one via: selectedPickupOption - from: consignment_Full to: consignmentAvailableShippingOptions type: has_many via: availableShippingOptions - from: checkout_Full to: checkoutCart type: has_one via: cart - from: checkout_Full to: address_Base type: has_one via: billingAddress - from: checkout_Full to: consignment_Full type: has_many via: consignments - from: checkout_Full to: CheckoutCoupon type: has_many via: coupons - from: checkout_Full to: Order type: belongs_to via: orderId - from: checkout_Full to: checkoutTax type: has_many via: taxes - from: cartLineItemGiftCertificate_Put to: contactEntity type: has_one via: sender - from: cartLineItemGiftCertificate_Put to: contactEntity type: has_one via: recipient - from: cart_Put to: cartLineItemPut type: has_one via: lineItem - from: cart_Put to: cartLineItemGiftCertificate_Put type: has_one via: giftCertificate - from: cartLineItemPut to: cartLineItemGiftWrapping_Put type: has_one via: giftWrapping - from: complexRule_Base to: adjuster_Full type: has_one via: price_adjuster - from: complexRule_Base to: adjuster_Full type: has_one via: weight_adjuster - from: complexRule_Base to: complexRuleConditionBase type: has_many via: conditions - from: country_Full to: countriesStates_Full type: has_one via: states - from: MetaFieldCollectionPostPutResponses to: Metafield type: has_many via: data - from: MetaFieldCollectionPostPutResponses to: CollectionMeta type: has_one via: meta - from: customer_Post to: customerAddresses_CustomerPost type: has_many via: addresses - from: customer_Post to: customerAttributes_Base type: has_many via: attributes - from: customer_Post to: customerAuthentication_PostPut type: has_one via: authentication - from: customer_Post to: formFieldValue type: has_many via: form_fields - from: customerAddresses_CustomerPost to: formFieldValue type: has_many via: form_fields - from: customer_Put to: customerAuthentication_PostPut type: has_one via: authentication - from: customer_Put to: formFieldValue type: has_many via: form_fields - from: customer_Full to: address_Full type: has_many via: addresses - from: customer_Full to: attribute_Full type: has_many via: attributes - from: customer_Full to: formFieldValue_Customer type: has_many via: form_fields - from: customsInformation_request to: harmonizedSystemCodes type: has_one via: hs_codes - from: customsInformation to: harmonizedSystemCodes type: has_one via: hs_codes - from: giftCertificate_Full to: Order type: belongs_to via: order_id - from: Cart_Line_Item_Update_Put to: cart_PostVariant type: has_one via: line_item - from: Cart_Line_Item_Update_Put to: cart_PostModifier type: has_one via: line_item - from: UpsertListingWithListingIdReq to: Listing type: belongs_to via: listing_id - from: MetaWithPartialPagination to: pagination_Partial type: has_one via: pagination - from: Listing to: ChannelProductVariantFull type: has_many via: variants - from: MetafieldResponse to: Metafield type: has_one via: data - from: categoriesTree_Resp to: categoriesTreeNode_Full type: has_many via: data - from: categoriesTree_Resp to: metaEmpty_Full type: has_one via: meta - from: MetafieldResponse_2 to: Metafield_2 type: has_one via: data - from: paymentMethod_Full to: paymentMethodStoredInstrument type: has_many via: stored_instruments - from: ShippingConsignment to: ConsignmentLineItem type: has_many via: lineItems - from: ShippingConsignment to: ConsignmentFormField type: has_many via: customFields - from: ItemPhysical to: GiftWrapping type: has_one via: giftWrapping - from: OrderItemDigital to: AppliedDiscount type: has_many via: discounts - from: Consignments to: ShippingConsignment type: has_many via: shipping - from: OrderLineItem to: ItemPhysical type: has_many via: physicalItems - from: OrderLineItem to: OrderItemDigital type: has_many via: digitalItems - from: OrderLineItem to: OrderItemGiftCertificate type: has_many via: giftCertificate - from: PagesCollectionResponse to: typePage type: has_many via: data - from: PagesCollectionResponse to: typeBlog type: has_many via: data - from: PagesCollectionResponse to: typeContactForm type: has_many via: data - from: PagesCollectionResponse to: typeFeed type: has_many via: data - from: PagesCollectionResponse to: typeRaw type: has_many via: data - from: PagesCollectionResponse to: typeLink type: has_many via: data - from: PagesCollectionResponse to: ResponseMeta type: has_one via: meta - from: PageResponse to: ResponseMeta type: has_one via: meta - from: Refund to: Order type: belongs_to via: order_id - from: Refund to: RefundItem type: has_many via: items - from: Refund to: RefundPayment type: has_many via: payments - from: RefundQuote_Full to: Order type: belongs_to via: order_id - from: FailedQuoteError to: Order type: belongs_to via: order_id - from: RefundRequest_Post to: PaymentRequest type: has_many via: payments - from: RefundRequest_Post to: MerchantOverride type: has_one via: merchant_calculated_override - from: RefundID_Get to: metaEmpty_Full type: has_one via: meta - from: widgetSchemaArray to: widgetSchemaHidden type: has_many via: schema - from: widgetSchemaArray to: widgetSchemaTab type: has_many via: schema - from: placement_Full to: widget_Full type: has_one via: widget - from: widget_Full to: widgetTemplate_Full type: has_one via: widget_template - from: AssignmentForPutResponse to: Meta type: has_one via: meta - from: AssignmentsForGetResponse to: AssignmentForGetResponse type: has_many via: data - from: AssignmentsForGetResponse to: CollectionMeta type: has_one via: meta - from: PriceRecordBatchItem to: PriceRecordBase type: has_one via: items - from: PriceRecordBase to: BulkPricingTier type: has_many via: bulk_pricing_tiers - from: PriceRecordBatchErrorResponse to: PriceRecordIdentifiers type: has_one via: data - from: PriceRecordBatchErrorResponse to: DetailedErrors type: has_one via: field_errors - from: productModifier_Base to: config_Full type: has_one via: config - from: adjusters_Full to: adjuster_Full type: has_one via: price - from: adjusters_Full to: adjuster_Full type: has_one via: weight - from: productModifier_Full to: productModifierOptionValue_Full type: has_many via: option_values - from: productModifierOptionValue_Base to: adjusters_Full type: has_one via: adjusters - from: productOption_Base to: productOptionConfig_Full type: has_one via: config - from: productOption_Base to: productOptionOptionValue_Full type: has_many via: option_values - from: productVariant_Post to: productVariantOptionValue_Full type: has_many via: option_values - from: productVariant_Full to: productVariantOptionValue_Full type: has_many via: option_values - from: MultiStatus to: productVariant_Full type: has_one via: data - from: MultiStatus to: errorMultiStatus type: has_one via: errors - from: MultiStatus to: metaCollection_Full type: has_one via: meta - from: errorMultiStatus to: DetailedErrors type: has_one via: errors - from: errorResponse_409 to: DetailedErrors type: has_one via: errors - from: product_Base to: TaxClass type: belongs_to via: tax_class_id - from: product_Base to: customUrl_Full type: has_one via: custom_url - from: product_Base to: productCustomField_Put type: has_many via: custom_fields - from: product_Base to: bulkPricingRule_Full type: has_many via: bulk_pricing_rules - from: product_Base to: productImage_Full type: has_many via: images - from: product_Base to: productVideo_Full type: has_many via: videos - from: product_Base to: productVariant_Full type: has_many via: variants - from: errorResponse_422 to: DetailedErrors type: has_one via: errors - from: product_Full to: productOption_Base type: has_many via: options - from: product_Full to: productModifier_Full type: has_many via: modifiers - from: redirect to: forward type: has_one via: forward - from: 301RedirectUpsert to: Site type: belongs_to via: site_id - from: 301RedirectUpsert to: RedirectTo type: has_one via: to - from: 301RedirectRead to: Site type: belongs_to via: site_id - from: 301RedirectRead to: RedirectTo type: has_one via: to - from: script_Response to: script_Full type: has_one via: data - from: script_Response to: Meta type: has_one via: meta - from: SearchFilterOverrideContextIdentifier to: Category type: belongs_to via: category_id - from: ConfiguredFiltersOverride to: SearchFilterOverrideContextIdentifier type: has_one via: context - from: GlobalCartSettingsResponse to: CartSettings type: has_one via: data - from: GlobalCartSettingsResponse to: metaCollection_open type: has_one via: meta - from: ChannelCartSettingsResponse to: ChannelCartSettings type: has_one via: data - from: ChannelCartSettingsResponse to: metaCollection_open type: has_one via: meta - from: RateRequestPayload to: BaseOptions type: has_one via: base_options - from: RateRequestPayload to: ZoneOptionsInstance type: has_one via: zone_options - from: RateRequestPayload to: ConnectionOptionsInstance type: has_one via: connection_options - from: CheckConnectionOptionsRequestPayload to: ConnectionOptionsInstance type: has_one via: connection_options - from: Site to: Url type: has_many via: urls - from: CertificateResponse to: MetaOpen type: has_one via: meta - from: InstallCertificateData to: CertificateWrite type: has_one via: certificate - from: GetCertificatesResponse to: InstalledCertificateDetail type: has_many via: data - from: GetCertificatesResponse to: MetaOpen type: has_one via: meta - from: _site to: Url type: has_many via: urls - from: Timezone to: DateFormat type: has_one via: date_format - from: StoreInformation to: Timezone type: has_one via: timezone - from: CardInstrument to: BillingAddress type: has_one via: billing_address - from: subscriber_Base to: Order type: belongs_to via: order_id - from: Subscription to: Order type: belongs_to via: orderId - from: response-document to: response-item type: has_many via: items - from: response-document to: response-item type: has_one via: shipping - from: response-document to: response-item type: has_one via: handling - from: request-item to: TaxClass type: has_one via: tax_class - from: request-item to: request-item-tax-property type: has_many via: tax_properties - from: SalesTax to: TaxClass type: has_one via: tax_class - from: response-item to: response-taxprice type: has_one via: price - from: request-quote to: request-document type: has_many via: documents - from: request-document to: Address type: has_one via: billing_address - from: request-document to: Address type: has_one via: destination_address - from: request-document to: Address type: has_one via: origin_address - from: request-document to: request-item type: has_one via: shipping - from: request-document to: request-item type: has_one via: handling - from: request-document to: request-item type: has_many via: items - from: response-taxprice to: SalesTax type: has_many via: sales_tax_summary - from: response-quote to: response-document type: has_many via: documents - from: Tax_Rate to: TaxZone type: belongs_to via: tax_zone_id - from: Tax_RatePOST to: TaxZone type: belongs_to via: tax_zone_id - from: Tax_RatePUT to: TaxZone type: belongs_to via: tax_zone_id - from: themeConfiguration_Full to: Site type: belongs_to via: site_id - from: JobResponse to: OpenMeta type: has_one via: meta - from: ThemeResponse to: Theme type: has_one via: data - from: ThemeResponse to: CollectionMeta type: has_one via: meta - from: Transaction to: Order type: belongs_to via: order_id - from: Transaction to: CreditCard type: has_one via: credit_card - from: wishlist_Full to: wishlistItem_Full type: has_many via: items