Created
June 13, 2022 14:07
-
-
Save hnestmann/7324e5e760b99023f1588d8c0aafc785 to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"basePath": "/s/-/dw/shop/v22_4", | |
"consumes": [ | |
"application/json", | |
"text/xml", | |
"application/xml" | |
], | |
"definitions": { | |
"approaching_discount": { | |
"description": "Document representing a note to an object.", | |
"properties": { | |
"condition_threshold": { | |
"description": "The total amount needed to receive the discount.", | |
"format": "double", | |
"type": "number" | |
}, | |
"discount": { | |
"$ref": "#/definitions/discount", | |
"description": "The discount the customer can receive if eligible." | |
}, | |
"merchandise_total": { | |
"description": "The amount the customer basket contributes towards the purchase condition.", | |
"format": "double", | |
"type": "number" | |
}, | |
"promotion_link": { | |
"$ref": "#/definitions/promotion_link", | |
"description": "The link to details of the promotion associated with this discount." | |
}, | |
"shipment_id": { | |
"description": "The unique id of the shipment the discount relates to.", | |
"type": "string" | |
}, | |
"shipping_methods": { | |
"description": "The shipping methods the promotion relates to.", | |
"items": { | |
"$ref": "#/definitions/shipping_method" | |
}, | |
"type": "array" | |
}, | |
"type": { | |
"description": "The type of the approaching discount (\"order\" or \"shipping\").", | |
"type": "string" | |
} | |
} | |
}, | |
"approaching_discount_result": { | |
"description": "A result of a approaching discount request.", | |
"properties": { | |
"approaching_discounts": { | |
"description": "Lists approaching discounts.", | |
"items": { | |
"$ref": "#/definitions/approaching_discount" | |
}, | |
"type": "array" | |
} | |
} | |
}, | |
"auth_request": { | |
"description": "Document representing the authentication request type.", | |
"properties": { | |
"type": { | |
"description": "Type of authentication request: guest, login (credentials), refresh or session.", | |
"enum": [ | |
"guest", | |
"credentials", | |
"refresh", | |
"session" | |
], | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"type" | |
] | |
}, | |
"basket": { | |
"description": "Document representing a basket.\n ", | |
"properties": { | |
"adjusted_merchandize_total_tax": { | |
"description": "The products tax after discounts applying in purchase currency.\n\n Adjusted merchandize prices represent the sum of product prices before\n services such as shipping have been added, but after adjustment from\n promotions have been added.", | |
"format": "double", | |
"type": "number" | |
}, | |
"adjusted_shipping_total_tax": { | |
"description": "The tax of all shipping line items of the line item container after\n shipping adjustments have been applied.", | |
"format": "double", | |
"type": "number" | |
}, | |
"agent_basket": { | |
"description": "Is the basket created by an agent?", | |
"type": "boolean" | |
}, | |
"basket_id": { | |
"description": "The unique identifier for the basket.", | |
"type": "string" | |
}, | |
"billing_address": { | |
"$ref": "#/definitions/order_address", | |
"description": "The billing address. This property is part of basket checkout information only." | |
}, | |
"bonus_discount_line_items": { | |
"description": "The bonus discount line items of the line item container.", | |
"items": { | |
"$ref": "#/definitions/bonus_discount_line_item" | |
}, | |
"type": "array" | |
}, | |
"c_CybersourceFraudDecision": { | |
"x-label": { | |
"default": "Cybersource Fraud Decision" | |
}, | |
"type": "string" | |
}, | |
"c_deltavistaScoringResult": { | |
"x-label": { | |
"default": "Deltavista Scoring Result" | |
}, | |
"type": "string" | |
}, | |
"c_geCCHash": { | |
"description": "Global-e country-currency hash.", | |
"x-label": { | |
"default": "Global-e CC Hash" | |
}, | |
"type": "string" | |
}, | |
"c_geCartToken": { | |
"description": "The token exchanged within the SendCart API call to display the Global-e checkout iframe.", | |
"x-label": { | |
"default": "Global-e Cart Token" | |
}, | |
"type": "string" | |
}, | |
"c_geMerchantOrderId": { | |
"description": "Reserved SFCC merchant order ID.", | |
"x-label": { | |
"default": "Global-e Merchant Order ID" | |
}, | |
"type": "string" | |
}, | |
"c_geSendCartJson": { | |
"format": "text", | |
"x-label": { | |
"default": "Global-e Send Cart JSON" | |
}, | |
"type": "string" | |
}, | |
"c_inStockDate": { | |
"description": "The expected in-stock date of the products in the Basket", | |
"format": "date", | |
"x-label": { | |
"default": "In-Stock Date" | |
}, | |
"type": "string" | |
}, | |
"c_inStockStatus": { | |
"description": "IN_STOCK = All products in the Basket are in-stock\r\nPREORDER = All products in the Basket are preorder with the same in-stock date\r\nBACKORDER = All products in the Basket are backorder with the same in-stock date\r\nNOT_AVAILABLE = All products in the Basket are out of stock with no preorder/backorder handling\r\nMIXED = Any combination of product availabilities, including preorder/backorder products with different in-stock dates", | |
"enum": [ | |
"IN_STOCK", | |
"PREORDER", | |
"BACKORDER", | |
"NOT_AVAILABLE", | |
"MIXED" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "IN_STOCK" | |
}, | |
{ | |
"default": "PREORDER" | |
}, | |
{ | |
"default": "BACKORDER" | |
}, | |
{ | |
"default": "NOT_AVAILABLE" | |
}, | |
{ | |
"default": "MIXED" | |
} | |
], | |
"x-label": { | |
"default": "In-Stock Status" | |
}, | |
"type": "string" | |
}, | |
"c_instore": { | |
"x-label": { | |
"default": "In store" | |
}, | |
"type": "boolean" | |
}, | |
"c_noShippingRequired": { | |
"x-label": { | |
"default": "No shipping required" | |
}, | |
"type": "boolean" | |
}, | |
"c_opluxEventID": { | |
"description": "Set the Event ID issued by OPLUX", | |
"x-label": { | |
"default": "OPLUX Event ID" | |
}, | |
"type": "string" | |
}, | |
"c_opluxScreeningResult": { | |
"description": "Set the screening results returned from OPLUX\r\n・NG (Fraudulent order detected)\r\n・OK (Not a fraudulent order)\r\n・REVIEW (Reviewing for fraudulent orders)\r\n・SERVICE_DISABLED (OPLUX service is disabled)", | |
"enum": [ | |
"NG", | |
"OK", | |
"REVIEW", | |
"SERVICE_DISABLED" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Fraudulent order detected" | |
}, | |
{ | |
"default": "Not a fraudulent order" | |
}, | |
{ | |
"default": "Reviewing for fraudulent orders" | |
}, | |
{ | |
"default": "OPLUX service is disabled" | |
} | |
], | |
"x-label": { | |
"default": "OPLUX Screening Result" | |
}, | |
"type": "string" | |
}, | |
"c_orderReturnCounter": { | |
"description": "We want to keep the original order number as a part of the RMA number, while keeping it unique. So we will append this number to the original order number", | |
"format": "int32", | |
"x-label": { | |
"default": "Order Return Counter" | |
}, | |
"type": "integer" | |
}, | |
"c_orderType": { | |
"x-label": { | |
"default": "Order Type" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorPayID": { | |
"description": "saves PayID for later referencing of paymorrow transaction", | |
"x-label": { | |
"default": "Payment Operator Pay ID" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorRefNr": { | |
"x-label": { | |
"default": "Payment Operator RefNr" | |
}, | |
"type": "string" | |
}, | |
"c_radialInventoryReservationID": { | |
"description": "This data needs to be preserved so it can be later used for the order creation webservice call.", | |
"x-label": { | |
"default": "Radial Inventory Reservation ID" | |
}, | |
"type": "string" | |
}, | |
"c_rssBasketTotalGrossPrice": { | |
"x-label": { | |
"default": "rssBasketTotalGrossPrice" | |
}, | |
"type": "string" | |
}, | |
"c_rssClientTransactionID": { | |
"x-label": { | |
"default": "rssClientTransactionID" | |
}, | |
"type": "string" | |
}, | |
"c_rssError": { | |
"x-label": { | |
"default": "rssError" | |
}, | |
"type": "boolean" | |
}, | |
"c_rssInvalidAddress": { | |
"x-label": { | |
"default": "rssInvalidAddress" | |
}, | |
"type": "boolean" | |
}, | |
"c_rssResultCode": { | |
"x-label": { | |
"default": "rssResultCode" | |
}, | |
"type": "string" | |
}, | |
"c_rssToken": { | |
"x-label": { | |
"default": "rssToken" | |
}, | |
"type": "string" | |
}, | |
"c_sessionAddressBook": { | |
"format": "text", | |
"x-label": { | |
"default": "Session Address Book" | |
}, | |
"type": "string" | |
}, | |
"c_storeEmail": { | |
"x-label": { | |
"default": "Store Email" | |
}, | |
"type": "string" | |
}, | |
"channel_type": { | |
"description": "The sales channel for the order.\n \n This is a read-only attribute that can't be modified by an OCAPI call. For OCAPI, the sales channel is determined\n based on the client ID and token used for the OCAPI call. Usually, a customer-based authentication sets the\n channel to Storefront, and an agent-based authentication sets it to CallCenter. Using applications that use other\n client IDs for OCAPI calls, like Customer Service Center, will set different channel types. To modify the channel\n type in OCAPI, use a hook. *\n ", | |
"enum": [ | |
"storefront", | |
"callcenter", | |
"marketplace", | |
"dss", | |
"store", | |
"pinterest", | |
"twitter", | |
"facebookads", | |
"subscriptions", | |
"onlinereservation", | |
"customerservicecenter", | |
"instagramcommerce" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Storefront" | |
}, | |
{ | |
"default": "Call Center" | |
}, | |
{ | |
"default": "Marketplace" | |
}, | |
{ | |
"default": "DSS" | |
}, | |
{ | |
"default": "Store" | |
}, | |
{ | |
"default": "Pinterest" | |
}, | |
{ | |
"default": "Twitter" | |
}, | |
{ | |
"default": "Facebook Ads" | |
}, | |
{ | |
"default": "Subscriptions" | |
}, | |
{ | |
"default": "Online Reservation" | |
}, | |
{ | |
"default": "Customer Service Center" | |
}, | |
{ | |
"default": "Instagram Commerce" | |
} | |
], | |
"x-label": { | |
"default": "Channel Type" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"coupon_items": { | |
"description": "The sorted array of coupon items. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/coupon_item" | |
}, | |
"type": "array" | |
}, | |
"creation_date": { | |
"description": "Returns the value of attribute 'creationDate'.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Creation Date" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"currency": { | |
"description": "The ISO 4217 mnemonic code of the currency.", | |
"type": "string" | |
}, | |
"customer_info": { | |
"$ref": "#/definitions/customer_info", | |
"description": "The customer information for logged in customers. This property is part of basket checkout information only." | |
}, | |
"gift_certificate_items": { | |
"description": "The sorted array of gift certificate line items. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/gift_certificate_item" | |
}, | |
"type": "array" | |
}, | |
"inventory_reservation_expiry": { | |
"description": "", | |
"format": "date-time", | |
"x-label": { | |
"default": "Inventory Reservation Expiry" | |
}, | |
"type": "string" | |
}, | |
"last_modified": { | |
"description": "Returns the value of attribute 'lastModified'.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Last Modified" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"merchandize_total_tax": { | |
"description": "The products total tax in purchase currency.\n\n Merchandize total prices represent the sum of product prices before\n services such as shipping or adjustment from promotions have\n been added.", | |
"format": "double", | |
"type": "number" | |
}, | |
"notes": { | |
"$ref": "#/definitions/simple_link", | |
"description": "The notes for the line item container." | |
}, | |
"order_price_adjustments": { | |
"description": "The array of order level price adjustments. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/price_adjustment" | |
}, | |
"type": "array" | |
}, | |
"order_total": { | |
"description": "The total price of the order, including products, shipping and tax. This property is part of basket checkout\n information only.", | |
"format": "double", | |
"x-label": { | |
"default": "Order Total" | |
}, | |
"type": "number" | |
}, | |
"payment_instruments": { | |
"description": "The payment instruments list for the order.", | |
"items": { | |
"$ref": "#/definitions/order_payment_instrument" | |
}, | |
"type": "array" | |
}, | |
"product_items": { | |
"description": "The sorted array of product items (up to a maximum of 50 items). This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/product_item" | |
}, | |
"type": "array" | |
}, | |
"product_sub_total": { | |
"description": "The total price of all product items after all product discounts.\n Depending on taxation policy the returned price is net or gross.", | |
"format": "double", | |
"type": "number" | |
}, | |
"product_total": { | |
"description": "The total price of all product items after all product and order discounts.\n Depending on taxation policy the returned price is net or gross.", | |
"format": "double", | |
"type": "number" | |
}, | |
"shipments": { | |
"description": "The array of shipments. This property is part of basket checkout information only.", | |
"items": { | |
"$ref": "#/definitions/shipment" | |
}, | |
"type": "array" | |
}, | |
"shipping_items": { | |
"description": "The sorted array of shipping items. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/shipping_item" | |
}, | |
"type": "array" | |
}, | |
"shipping_total": { | |
"description": "The total shipping price of the order after all shipping discounts. Excludes tax if taxation policy is net. Includes\n tax if taxation policy is gross. This property is part of basket checkout information only.", | |
"format": "double", | |
"type": "number" | |
}, | |
"shipping_total_tax": { | |
"description": "The tax of all shipping line items of the line item container before\n shipping adjustments have been applied.", | |
"format": "double", | |
"type": "number" | |
}, | |
"source_code": { | |
"description": "Gets the source code assigned to this basket.", | |
"x-label": { | |
"default": "Source Code" | |
}, | |
"type": "string" | |
}, | |
"tax_total": { | |
"description": "The total tax amount of the order. This property is part of basket checkout information only.", | |
"format": "double", | |
"type": "number" | |
}, | |
"taxation": { | |
"description": "The taxation the line item container is based on.", | |
"enum": [ | |
"gross", | |
"net" | |
], | |
"type": "string" | |
} | |
} | |
}, | |
"basket_payment_instrument_request": { | |
"description": "Document representing a basket payment instrument request.", | |
"properties": { | |
"amount": { | |
"description": "The payment transaction amount.", | |
"format": "double", | |
"x-label": { | |
"default": "Amount" | |
}, | |
"type": "number" | |
}, | |
"bank_routing_number": { | |
"description": "The bank routing number.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"customer_payment_instrument_id": { | |
"description": "The id of a customer payment instrument.", | |
"type": "string" | |
}, | |
"gift_certificate_code": { | |
"description": "The gift certificate code.", | |
"x-label": { | |
"default": "Gift Code" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"payment_bank_account": { | |
"$ref": "#/definitions/payment_bank_account_request", | |
"description": "The payment bank account request data." | |
}, | |
"payment_card": { | |
"$ref": "#/definitions/order_payment_card_request", | |
"description": "The payment card." | |
}, | |
"payment_method_id": { | |
"description": "The payment method id. Optional if a customer payment instrument id is specified.", | |
"maxLength": 256, | |
"type": "string" | |
} | |
} | |
}, | |
"basket_reference": { | |
"description": "Reference to a basket.", | |
"properties": { | |
"basket_id": { | |
"description": "The unique identifier for the basket.", | |
"type": "string" | |
}, | |
"customer_id": { | |
"description": "The unique identifier for the customer.", | |
"maxLength": 100, | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"basket_id", | |
"customer_id" | |
] | |
}, | |
"baskets_result": { | |
"description": "Result document containing an array of baskets.", | |
"properties": { | |
"baskets": { | |
"description": "The list of baskets for a customer.", | |
"items": { | |
"$ref": "#/definitions/basket" | |
}, | |
"type": "array" | |
}, | |
"total": { | |
"description": "The total number of baskets.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"bonus_discount_line_item": { | |
"description": "Document representing a bonus discount line item", | |
"properties": { | |
"bonus_products": { | |
"description": "The list of links to the bonus products the customer can choose from.", | |
"items": { | |
"$ref": "#/definitions/product_details_link" | |
}, | |
"type": "array" | |
}, | |
"coupon_code": { | |
"description": "The coupon code that triggered the promotion, if applicable.", | |
"type": "string" | |
}, | |
"id": { | |
"description": "The ID of the line item.", | |
"type": "string" | |
}, | |
"max_bonus_items": { | |
"description": "The maximum number of bonus items the user can select for this promotion.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"promotion_id": { | |
"description": "The ID of the promotion which triggered the creation of the line item.", | |
"type": "string" | |
} | |
} | |
}, | |
"bool_filter": { | |
"description": "Document representing a boolean filter.\n ", | |
"properties": { | |
"filters": { | |
"description": "A list of filters, which are logically combined by an operator.", | |
"items": { | |
"$ref": "#/definitions/filter" | |
}, | |
"x-sub_types": { | |
"range_filter": "#/definitions/range_filter", | |
"bool_filter": "#/definitions/bool_filter", | |
"query_filter": "#/definitions/query_filter", | |
"term_filter": "#/definitions/term_filter", | |
"range2_filter": "#/definitions/range2_filter" | |
}, | |
"type": "array" | |
}, | |
"operator": { | |
"description": "The logical operator the filters are combined with.", | |
"enum": [ | |
"and", | |
"or", | |
"not" | |
], | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"operator" | |
] | |
}, | |
"bool_query": { | |
"description": "A boolean query allows construction of full logical expression trees consisting of other queries (usually term and text\nqueries). A boolean query basically has 3 sets of clauses that 'must', 'should' and / or 'must not' match. If 'must',\n'must_not', or 'should' appear in the same boolean query, they are combined logically using the AND operator.\n", | |
"properties": { | |
"must": { | |
"description": "List of queries that must match.", | |
"items": { | |
"$ref": "#/definitions/query" | |
}, | |
"x-sub_types": { | |
"nested_query": "#/definitions/nested_query", | |
"filtered_query": "#/definitions/filtered_query", | |
"text_query": "#/definitions/text_query", | |
"match_all_query": "#/definitions/match_all_query", | |
"term_query": "#/definitions/term_query", | |
"bool_query": "#/definitions/bool_query" | |
}, | |
"type": "array" | |
}, | |
"must_not": { | |
"description": "List of queries that must not match.", | |
"items": { | |
"$ref": "#/definitions/query" | |
}, | |
"x-sub_types": { | |
"nested_query": "#/definitions/nested_query", | |
"filtered_query": "#/definitions/filtered_query", | |
"text_query": "#/definitions/text_query", | |
"match_all_query": "#/definitions/match_all_query", | |
"term_query": "#/definitions/term_query", | |
"bool_query": "#/definitions/bool_query" | |
}, | |
"type": "array" | |
}, | |
"should": { | |
"description": "List of queries that should match.", | |
"items": { | |
"$ref": "#/definitions/query" | |
}, | |
"x-sub_types": { | |
"nested_query": "#/definitions/nested_query", | |
"filtered_query": "#/definitions/filtered_query", | |
"text_query": "#/definitions/text_query", | |
"match_all_query": "#/definitions/match_all_query", | |
"term_query": "#/definitions/term_query", | |
"bool_query": "#/definitions/bool_query" | |
}, | |
"type": "array" | |
} | |
} | |
}, | |
"bundled_product": { | |
"description": "Document representing a bundled product within a product bundle.", | |
"properties": { | |
"id": { | |
"type": "string" | |
}, | |
"product": { | |
"$ref": "#/definitions/product", | |
"description": "The product being bundled." | |
}, | |
"quantity": { | |
"description": "For the product being bundled, the quantity added to the bundle.", | |
"format": "double", | |
"type": "number" | |
} | |
} | |
}, | |
"category": { | |
"description": "Document representing a category.", | |
"properties": { | |
"c_CountryCodeRestrictions": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Country Code Restrictions" | |
}, | |
"type": "array" | |
}, | |
"c_DisableTileRating": { | |
"description": "Hides PLP Product Tile Ratings", | |
"x-label": { | |
"default": "Disable Product Tile Ratings" | |
}, | |
"type": "boolean" | |
}, | |
"c_DisableTileSwatches": { | |
"description": "Hides PLP Product Tile Swatches", | |
"x-label": { | |
"default": "Disable Product Tile Swatches" | |
}, | |
"type": "boolean" | |
}, | |
"c_Indexation": { | |
"enum": [ | |
"index, follow", | |
"noindex, follow", | |
"noindex, nofollow" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "index, follow" | |
}, | |
{ | |
"default": "noindex, follow" | |
}, | |
{ | |
"default": "noindex, nofollow" | |
} | |
], | |
"x-label": { | |
"default": "Indexation" | |
}, | |
"type": "string" | |
}, | |
"c_MultiBrandDomain": { | |
"description": "The multi-brand domain URL for this category. Site will attempt to\n inherit this value from its parent category if blank. \r\n This is not used for storefront rendering, but assists in export of product and category URLs for\n multi-brand sites.\n ", | |
"x-label": { | |
"default": "Multi-Brand domain hostname" | |
}, | |
"type": "string" | |
}, | |
"c_SEOCategoryDescription": { | |
"format": "html", | |
"x-label": { | |
"default": "SEO Category Description" | |
}, | |
"type": "string" | |
}, | |
"c_SEOCategoryName": { | |
"x-label": { | |
"default": "SEO Category Name" | |
}, | |
"type": "string" | |
}, | |
"c_SEODescriptionContext": { | |
"format": "html", | |
"x-label": { | |
"default": "SEO Description" | |
}, | |
"type": "string" | |
}, | |
"c_ShippingReturnAssetID": { | |
"description": "Shipping Return Content Asset ID Override for default.", | |
"x-label": { | |
"default": "Shipping Return Asset ID" | |
}, | |
"type": "string" | |
}, | |
"c_ShoeFinderMenuLeft": { | |
"x-label": { | |
"default": "Shoe Finder Menu Left" | |
}, | |
"type": "string" | |
}, | |
"c_ShoeFinderMenuTop": { | |
"x-label": { | |
"default": "Shoe Finder Menu Top" | |
}, | |
"type": "string" | |
}, | |
"c_ShoeFinderMenuWidth": { | |
"x-label": { | |
"default": "Shoe Finder Menu Width" | |
}, | |
"type": "string" | |
}, | |
"c_TabSubPageComingSoonImage": { | |
"description": "160x160 Image", | |
"x-label": { | |
"default": "Tabbed SubPage Coming Soon Image" | |
}, | |
"type": "string" | |
}, | |
"c_TabSubPageComingSoonNameOverride": { | |
"description": "Overrides category displayname value while coming soon date is in the\n future\n ", | |
"x-label": { | |
"default": "Tabbed SubPage Coming Name Override" | |
}, | |
"type": "string" | |
}, | |
"c_TabSubPageComingSoonTo": { | |
"description": "Tab 'Coming Soon' message until this date-time", | |
"format": "date-time", | |
"x-label": { | |
"default": "Tabbed SubPage Coming Soon To Date" | |
}, | |
"type": "string" | |
}, | |
"c_TabSubPageImage": { | |
"description": "160x160 Image", | |
"x-label": { | |
"default": "Tabbed SubPage Image" | |
}, | |
"type": "string" | |
}, | |
"c_TabSubPageNameOverride": { | |
"description": "Overrides category displayname value", | |
"x-label": { | |
"default": "Tabbed SubPage Display Name Override" | |
}, | |
"type": "string" | |
}, | |
"c_addToCustomerSession": { | |
"x-label": { | |
"default": "Add To Customer Session" | |
}, | |
"type": "boolean" | |
}, | |
"c_alternativeUrl": { | |
"description": "Renders an alternative URL in main navigation. Uses Demandware content url notation. For example: $url('Account-Show')$ or normal URL http://xchange.demandware.com", | |
"format": "html", | |
"x-label": { | |
"default": "Alternative URL" | |
}, | |
"type": "string" | |
}, | |
"c_brandRoot": { | |
"x-label": { | |
"default": "Brand Root Category" | |
}, | |
"type": "boolean" | |
}, | |
"c_bvRRDisplayCode": { | |
"description": "Display Code override for BazaarVoice Ratings and Reviews. If blank,\n Site will attempt to use parent categories' value. If all categories are blank up the category tree,\n Site will default to SitePreference bvRRDisplayCodeMapping.\n ", | |
"x-label": { | |
"default": "BazaarVoice Ratings and Reviews Display Code" | |
}, | |
"type": "string" | |
}, | |
"c_canonicalOverrideCategoryId": { | |
"description": "Value should be category ID", | |
"x-label": { | |
"default": "Canonical Override Category ID" | |
}, | |
"type": "string" | |
}, | |
"c_canonicalOverrideEnabled": { | |
"x-label": { | |
"default": "Canonical Override" | |
}, | |
"type": "boolean" | |
}, | |
"c_catBannerID": { | |
"description": "Used to define the content asset used to populate a grid page banner for a category. This value is applied to all sub-category navigation (cascading) if no specific catBannerID has been defined for a sub-category.", | |
"x-label": { | |
"default": "Category Banner ID" | |
}, | |
"type": "string" | |
}, | |
"c_customCSSFile": { | |
"description": "Use this attribute to apply custom styles for this category.", | |
"x-label": { | |
"default": "Custom CSS File" | |
}, | |
"type": "string" | |
}, | |
"c_disablePLPBannerSitesList": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Disable PLP Global Banner only for specified sites (example value:\n \"EU\")\n " | |
}, | |
"type": "array" | |
}, | |
"c_disablePLPGlobalBanner": { | |
"x-label": { | |
"default": "Hide PLP Global Banner" | |
}, | |
"type": "boolean" | |
}, | |
"c_disableResultsRedirection": { | |
"description": "Disable redirection when 0/1 Product is returned.", | |
"x-label": { | |
"default": "Disable Results Redirection" | |
}, | |
"type": "boolean" | |
}, | |
"c_disableSecondGlobalBanner": { | |
"enum": [ | |
"Yes", | |
"No" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Yes" | |
}, | |
{ | |
"default": "No" | |
} | |
], | |
"x-label": { | |
"default": "Disable second global banner" | |
}, | |
"type": "string" | |
}, | |
"c_divider": { | |
"x-label": { | |
"default": "Read More Divider" | |
}, | |
"type": "string" | |
}, | |
"c_enableCompare": { | |
"description": "Used to define if/when the Compare feature is to be visualized in the storefront based on navigation. If enableCompare = FALSE, no Compare checkboxes will be displayed in the grid view. If enableCompare = TRUE, the category (and its children) will support the Compare feature.", | |
"x-label": { | |
"default": "Enable Compare" | |
}, | |
"type": "boolean" | |
}, | |
"c_enableNavImages": { | |
"x-label": { | |
"default": "Enable Navigation Menu Images" | |
}, | |
"type": "boolean" | |
}, | |
"c_enableNavSubcatThumbnails": { | |
"x-label": { | |
"default": "Enable Nav Subcat Thumbnails" | |
}, | |
"type": "boolean" | |
}, | |
"c_excludeFromMenu": { | |
"description": "Used to indicate that a category (such as Mens -> Footwear ->\n Boots) will be excluded from navigation.\n ", | |
"x-label": { | |
"default": "Exclude from Menu Navigation" | |
}, | |
"type": "boolean" | |
}, | |
"c_excludeFromShopByCategory": { | |
"description": "Exclude from Shop By Category Module", | |
"x-label": { | |
"default": "Exclude from Shop By Category" | |
}, | |
"type": "boolean" | |
}, | |
"c_excludeSoldOutProducts": { | |
"description": "Flag indicating that category does not contains products with soldout badge", | |
"x-label": { | |
"default": "Exclude SoldOut Products" | |
}, | |
"type": "boolean" | |
}, | |
"c_excludeSortingRulesId": { | |
"description": "comma separated list", | |
"x-label": { | |
"default": "Exclude Sorting Rules Id" | |
}, | |
"type": "string" | |
}, | |
"c_excludeSouldOutProducts": { | |
"description": "Flag indicating that category does not contains products with soldout badge", | |
"x-label": { | |
"default": "Exclude SouldOut Products" | |
}, | |
"type": "boolean" | |
}, | |
"c_excludeSubcategoryNav": { | |
"description": "Hide this category in the navigation menu on the left-hand side on the Category and Search pages.", | |
"x-label": { | |
"default": "Hide In Subcategory Navigation" | |
}, | |
"type": "boolean" | |
}, | |
"c_excludedCategory": { | |
"x-label": { | |
"default": "Exclude Category for Return/Exchange" | |
}, | |
"type": "boolean" | |
}, | |
"c_figureImage": { | |
"description": "Used in Trending Now module tabs. (Max 80x118px height x width)\n ", | |
"x-label": { | |
"default": "Homepage Trending Now Module Icon" | |
}, | |
"type": "string" | |
}, | |
"c_flyoutContent": { | |
"x-label": { | |
"default": "Navigation Flyout Content Asset ID" | |
}, | |
"type": "string" | |
}, | |
"c_flyoutProduct": { | |
"description": "Product ID (Master or Variant) which appears in the Main Navigation Flyout.", | |
"x-label": { | |
"default": "Flyout Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_fullPriceCategory": { | |
"description": "Set to display when \"IsSale\" flag is set to false. Will allow a page\n to only display full price products.\n ", | |
"x-label": { | |
"default": "Full Price Category" | |
}, | |
"type": "boolean" | |
}, | |
"c_gccLastSubmitted": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Sent for translation on" | |
}, | |
"type": "string" | |
}, | |
"c_gccLastTranslated": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Translations imported on" | |
}, | |
"type": "string" | |
}, | |
"c_gccStatus": { | |
"description": "This attribute is used by GCC.", | |
"enum": [ | |
"Ready", | |
"Sent", | |
"Imported" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Ready to Send" | |
}, | |
{ | |
"default": "In Progress" | |
}, | |
{ | |
"default": "Translated" | |
} | |
], | |
"x-label": { | |
"default": "GlobalLink Status" | |
}, | |
"type": "string" | |
}, | |
"c_gccSubmissionName": { | |
"description": "This attribute is used to store the gccSubmissionName information locale-specific.", | |
"x-label": { | |
"default": "GCC Submission Name" | |
}, | |
"type": "string" | |
}, | |
"c_headerMenuBanner": { | |
"format": "html", | |
"x-label": { | |
"default": "Header Menu Banner" | |
}, | |
"type": "string" | |
}, | |
"c_headerMenuOrientation": { | |
"description": "Which way to orient the menu and optional header menu HTML. Vertical will list all in one line. Horizontal will list in columns.", | |
"enum": [ | |
"Horizontal", | |
"Vertical" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Horizontal" | |
}, | |
{ | |
"default": "Vertical" | |
} | |
], | |
"x-label": { | |
"default": "Header Menu Orientation" | |
}, | |
"type": "string" | |
}, | |
"c_headless_online": { | |
"x-label": { | |
"default": "Online (Headless, Computed value)" | |
}, | |
"type": "boolean" | |
}, | |
"c_headless_onlineFlag": { | |
"x-label": { | |
"default": "Online Flag (Headless)" | |
}, | |
"type": "boolean" | |
}, | |
"c_headless_onlineFrom": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Online From (Headless)" | |
}, | |
"type": "string" | |
}, | |
"c_headless_onlineTo": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Online To (Headless)" | |
}, | |
"type": "string" | |
}, | |
"c_headless_pageURL": { | |
"x-label": { | |
"default": "Page URL (Headless)" | |
}, | |
"type": "string" | |
}, | |
"c_marketingRedirectsCountryCodes": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Country Codes" | |
}, | |
"type": "array" | |
}, | |
"c_marketingRedirectsDevelopmentURL": { | |
"x-label": { | |
"default": "Development URL" | |
}, | |
"type": "string" | |
}, | |
"c_marketingRedirectsProductionURL": { | |
"x-label": { | |
"default": "Production URL" | |
}, | |
"type": "string" | |
}, | |
"c_marketingRedirectsStagingURL": { | |
"x-label": { | |
"default": "Staging URL" | |
}, | |
"type": "string" | |
}, | |
"c_navImagesMaxCols": { | |
"enum": [ | |
"2", | |
"3", | |
"4", | |
"5" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "2" | |
}, | |
{ | |
"default": "3" | |
}, | |
{ | |
"default": "4" | |
}, | |
{ | |
"default": "5" | |
} | |
], | |
"x-label": { | |
"default": "Maximum Image Columns" | |
}, | |
"type": "string" | |
}, | |
"c_navigationImage": { | |
"description": "Representative Menu Image", | |
"x-label": { | |
"default": "Nav Menu Image" | |
}, | |
"type": "string" | |
}, | |
"c_newArrivalsCategory": { | |
"description": "Flag indicating category as a new arrivals category. If set only\n products flagged as \"IsNew\" will be contained in search results for this category.\n ", | |
"x-label": { | |
"default": "New Arrivals Category" | |
}, | |
"type": "boolean" | |
}, | |
"c_pisaAlternateView": { | |
"description": "Alternate / hover view", | |
"enum": [ | |
"fv", | |
"bv", | |
"bv02", | |
"sv01", | |
"sv02", | |
"sv03", | |
"sv04", | |
"dt01", | |
"dt02", | |
"dt03", | |
"dt04", | |
"mod01", | |
"mod02", | |
"mod03", | |
"mod04", | |
"mod05", | |
"mod06" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Front View" | |
}, | |
{ | |
"default": "Back View" | |
}, | |
{ | |
"default": "Back View 02" | |
}, | |
{ | |
"default": "Side View 01" | |
}, | |
{ | |
"default": "Side View 02" | |
}, | |
{ | |
"default": "Side View 03" | |
}, | |
{ | |
"default": "Side View 04" | |
}, | |
{ | |
"default": "Detail View 01" | |
}, | |
{ | |
"default": "Detail View 02" | |
}, | |
{ | |
"default": "Detail View 03" | |
}, | |
{ | |
"default": "Detail View 04" | |
}, | |
{ | |
"default": "Model View 01" | |
}, | |
{ | |
"default": "Model View 02" | |
}, | |
{ | |
"default": "Model View 03" | |
}, | |
{ | |
"default": "Model View 04" | |
}, | |
{ | |
"default": "Model View 05" | |
}, | |
{ | |
"default": "Model View 06" | |
} | |
], | |
"x-label": { | |
"default": "PISA Alternate/Hover View" | |
}, | |
"type": "string" | |
}, | |
"c_pisaDefaultView": { | |
"enum": [ | |
"fv", | |
"bv", | |
"bv02", | |
"sv01", | |
"sv02", | |
"sv03", | |
"sv04", | |
"dt01", | |
"dt02", | |
"dt03", | |
"dt04", | |
"mod01", | |
"mod02", | |
"mod03", | |
"mod04", | |
"mod05", | |
"mod06" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Front View" | |
}, | |
{ | |
"default": "Back View" | |
}, | |
{ | |
"default": "Back View 02" | |
}, | |
{ | |
"default": "Side View 01" | |
}, | |
{ | |
"default": "Side View 02" | |
}, | |
{ | |
"default": "Side View 03" | |
}, | |
{ | |
"default": "Side View 04" | |
}, | |
{ | |
"default": "Detail View 01" | |
}, | |
{ | |
"default": "Detail View 02" | |
}, | |
{ | |
"default": "Detail View 03" | |
}, | |
{ | |
"default": "Detail View 04" | |
}, | |
{ | |
"default": "Model View 01" | |
}, | |
{ | |
"default": "Model View 02" | |
}, | |
{ | |
"default": "Model View 03" | |
}, | |
{ | |
"default": "Model View 04" | |
}, | |
{ | |
"default": "Model View 05" | |
}, | |
{ | |
"default": "Model View 06" | |
} | |
], | |
"x-label": { | |
"default": "PISA Default Image View" | |
}, | |
"type": "string" | |
}, | |
"c_pmcContentAssetIds": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Content Assets IDs" | |
}, | |
"type": "array" | |
}, | |
"c_pmcContentAssetIndexes": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Content Asset Index Positions" | |
}, | |
"type": "array" | |
}, | |
"c_pmcEnable": { | |
"x-label": { | |
"default": "Enable PLP Mixed Content" | |
}, | |
"type": "boolean" | |
}, | |
"c_productGroup": { | |
"enum": [ | |
"shoes" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Shoes" | |
} | |
], | |
"x-label": { | |
"default": "Product Group" | |
}, | |
"type": "string" | |
}, | |
"c_profileAboutTitle": { | |
"format": "html", | |
"x-label": { | |
"default": "Profile About Title" | |
}, | |
"type": "string" | |
}, | |
"c_profileAchievements": { | |
"format": "html", | |
"x-label": { | |
"default": "Profile Achievements" | |
}, | |
"type": "string" | |
}, | |
"c_profileBody": { | |
"format": "html", | |
"x-label": { | |
"default": "Profile Body Content" | |
}, | |
"type": "string" | |
}, | |
"c_profileClub": { | |
"x-label": { | |
"default": "Profile Club" | |
}, | |
"type": "string" | |
}, | |
"c_profileDOB": { | |
"format": "date", | |
"x-label": { | |
"default": "Profile Date of Birth" | |
}, | |
"type": "string" | |
}, | |
"c_profileFacebookURL": { | |
"x-label": { | |
"default": "Profile Facebook URL" | |
}, | |
"type": "string" | |
}, | |
"c_profileFounded": { | |
"x-label": { | |
"default": "Profile Founded" | |
}, | |
"type": "string" | |
}, | |
"c_profileIcon": { | |
"x-label": { | |
"default": "Profile Icon" | |
}, | |
"type": "string" | |
}, | |
"c_profileKnownFor": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Profile Known For" | |
}, | |
"type": "array" | |
}, | |
"c_profileName": { | |
"format": "html", | |
"x-label": { | |
"default": "Profile Name" | |
}, | |
"type": "string" | |
}, | |
"c_profileNationality": { | |
"x-label": { | |
"default": "Profile Nationality" | |
}, | |
"type": "string" | |
}, | |
"c_profileNickname": { | |
"x-label": { | |
"default": "Profile Nickname" | |
}, | |
"type": "string" | |
}, | |
"c_profileTwitterURL": { | |
"x-label": { | |
"default": "Profile Twitter URL" | |
}, | |
"type": "string" | |
}, | |
"c_promoExclusionCategory": { | |
"enum": [ | |
"Yes", | |
"No" | |
], | |
"x-label": { | |
"default": "Promo Exclusion Category flag" | |
}, | |
"type": "string" | |
}, | |
"c_promoTileAssignments": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Promo Tile Assignment IDs" | |
}, | |
"type": "array" | |
}, | |
"c_promoTileFrom": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Promo Tile From" | |
}, | |
"type": "string" | |
}, | |
"c_promoTileGroupAssignment": { | |
"x-label": { | |
"default": "Promo Tile Group Assignment" | |
}, | |
"type": "string" | |
}, | |
"c_promoTilePosition": { | |
"format": "int32", | |
"x-label": { | |
"default": "Promo Tile Position" | |
}, | |
"minimum": 1.0, | |
"type": "integer" | |
}, | |
"c_promoTilePositions": { | |
"description": "Example:1,3,7", | |
"x-label": { | |
"default": "Comma separated list of absolute positions of promo tiles" | |
}, | |
"type": "string" | |
}, | |
"c_promoTileTo": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Promo Tile To " | |
}, | |
"type": "string" | |
}, | |
"c_radialInventoryThreshold": { | |
"description": "Threshold for when to do the real time inventory call", | |
"format": "int32", | |
"x-label": { | |
"default": "Radial Inventory Threshold" | |
}, | |
"type": "integer" | |
}, | |
"c_restrictedCountries": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Restricted Countries" | |
}, | |
"type": "array" | |
}, | |
"c_saleCategory": { | |
"description": "Flag indicating category as a sale category. If set to 'Yes' only products\r\n from sale pricebook will be contained in search results for this category.", | |
"enum": [ | |
"Yes", | |
"No" | |
], | |
"x-label": { | |
"default": "Sale Category" | |
}, | |
"type": "string" | |
}, | |
"c_scene7AlternateView": { | |
"enum": [ | |
"_01", | |
"_02", | |
"_03", | |
"_04" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "_01" | |
}, | |
{ | |
"default": "_02" | |
}, | |
{ | |
"default": "_03" | |
}, | |
{ | |
"default": "_04" | |
} | |
], | |
"x-label": { | |
"default": "Scene7 Alternate Hover View" | |
}, | |
"type": "string" | |
}, | |
"c_secondFooterNavCategories": { | |
"description": "contains list of categories which will be displayed in matching category footer on PLP", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Second Footer Navigation Categories" | |
}, | |
"type": "array" | |
}, | |
"c_selectCollectionCategoryImage": { | |
"x-label": { | |
"default": "Select Collection Category Image" | |
}, | |
"type": "string" | |
}, | |
"c_selectCollectionDescriptionBy": { | |
"x-label": { | |
"default": "Select Collection By Description" | |
}, | |
"type": "string" | |
}, | |
"c_selectCollectionLogoImage": { | |
"x-label": { | |
"default": "Select Collection Logo Image" | |
}, | |
"type": "string" | |
}, | |
"c_selectCollectionShortDescription": { | |
"x-label": { | |
"default": "Select Collection Short Description" | |
}, | |
"type": "string" | |
}, | |
"c_selectCollectionWithoutLogoImage": { | |
"x-label": { | |
"default": "Select Collection Without Logo Image" | |
}, | |
"type": "boolean" | |
}, | |
"c_shoeFinderBackgroundColor": { | |
"x-label": { | |
"default": "Shoe Finder Slide Background Color" | |
}, | |
"type": "string" | |
}, | |
"c_shoeFinderBackgroundImage": { | |
"x-label": { | |
"default": "Shoe Finder Slide Background Image" | |
}, | |
"type": "string" | |
}, | |
"c_shoeFinderBreadCrumbName": { | |
"x-label": { | |
"default": "Shoe Finder Bread Crumb Name" | |
}, | |
"type": "string" | |
}, | |
"c_shoeFinderBypassRefinements": { | |
"x-label": { | |
"default": "Bypass Shoe Finder Options" | |
}, | |
"type": "boolean" | |
}, | |
"c_shoeFinderEnableSliderNav": { | |
"x-label": { | |
"default": "Enable Slider Navigation" | |
}, | |
"type": "boolean" | |
}, | |
"c_shoeFinderQuestion": { | |
"x-label": { | |
"default": "Shoe Finder Question" | |
}, | |
"type": "string" | |
}, | |
"c_shoeFinderQuestionFontSize": { | |
"x-label": { | |
"default": "Shoe Finder Question Font Size" | |
}, | |
"type": "string" | |
}, | |
"c_shoeFinderQuestionLineHeight": { | |
"x-label": { | |
"default": "Shoe Finder Question Line Height" | |
}, | |
"type": "string" | |
}, | |
"c_shoeFinderSliderLabel": { | |
"x-label": { | |
"default": "Shoe Finder Slider Label" | |
}, | |
"type": "string" | |
}, | |
"c_shoeFinderTooltip": { | |
"description": "Content Asset ID to include within tooltip", | |
"x-label": { | |
"default": "Shoe Finder Tooltip Content Asset" | |
}, | |
"type": "string" | |
}, | |
"c_shopByModuleHideName": { | |
"x-label": { | |
"default": "Shop By Hide Category Name" | |
}, | |
"type": "boolean" | |
}, | |
"c_shopByModuleImage": { | |
"description": "Shop By Module Image (300x220px)", | |
"x-label": { | |
"default": "Shop By Homepage Image" | |
}, | |
"type": "string" | |
}, | |
"c_shopByModuleImageMobile": { | |
"description": "Shop By Module Image Mobile Size (32x32px)", | |
"x-label": { | |
"default": "Shop By Homepage Image Mobile" | |
}, | |
"type": "string" | |
}, | |
"c_showContentFirstSlot": { | |
"description": "When viewing a category page, instead of showing a product in the\n first position, it will show the content from the 'category-first-position-content' content slot.\n ", | |
"x-label": { | |
"default": "Show Content In First Position?" | |
}, | |
"type": "boolean" | |
}, | |
"c_showEvenEmpty": { | |
"description": "Used to indicate that a category will display in navigation always, even when no products are assigned to it (used with template rendering/category/categorylandinglarge in this case).", | |
"x-label": { | |
"default": "Show in Menu Navigation (Even Without Products)" | |
}, | |
"type": "boolean" | |
}, | |
"c_showInMenu": { | |
"description": "Used to indicate that a category (such as Mens -> Footwear -> Boots) will display in the top menu navigation. Up to three category levels are shown in top menu navigation.", | |
"x-label": { | |
"default": "Show in Menu Navigation" | |
}, | |
"type": "boolean" | |
}, | |
"c_showPercentBadgeInCategory": { | |
"x-label": { | |
"default": "Show Percentage Discount Badge" | |
}, | |
"type": "boolean" | |
}, | |
"c_showReadMoreSEODescription": { | |
"x-label": { | |
"default": "Show read more button for SEO Category Description" | |
}, | |
"type": "boolean" | |
}, | |
"c_showTier3Bold": { | |
"x-label": { | |
"default": "Show as Navigation header" | |
}, | |
"type": "boolean" | |
}, | |
"c_sizeChartID": { | |
"description": "Used to define the content asset ID of the Size Chart that is appropriate for products whose PRIMARY category is the associated category (and its children). Whenever a product detail page (or quick view) is rendered, the Size Chart link is populated based on the value of this attribute for the products primary categorization. If not defined, NO size chart link is displayed.", | |
"x-label": { | |
"default": "Size Chart" | |
}, | |
"type": "string" | |
}, | |
"c_slotBannerHtml": { | |
"format": "html", | |
"x-label": { | |
"default": "Slot Banner HTML" | |
}, | |
"type": "string" | |
}, | |
"c_slotBannerImage": { | |
"description": "Image used on either the top or bottom slot on the category landing pages.", | |
"x-label": { | |
"default": "Category Landing Slot Image" | |
}, | |
"type": "string" | |
}, | |
"c_suppressNewsletterSubscription": { | |
"x-label": { | |
"default": "Suppress Newsletter Subscription Field" | |
}, | |
"type": "boolean" | |
}, | |
"c_thumbnailUrl": { | |
"x-label": { | |
"default": "PISA Thumbnail URL" | |
}, | |
"type": "string" | |
}, | |
"c_trackingCategoryName": { | |
"description": "This is the category name which will be referenced in Omniture. If the Tracking Category Name is left blank, Omniture will track the default category name.", | |
"x-label": { | |
"default": "Tracking Category Name" | |
}, | |
"type": "string" | |
}, | |
"c_wcCategoryFilter": { | |
"description": "This category will only show the name. This category children categories will be the filter links.", | |
"x-label": { | |
"default": "Use as filter" | |
}, | |
"type": "boolean" | |
}, | |
"c_wcCategoryNavigationChildren": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Category children" | |
}, | |
"type": "array" | |
}, | |
"c_wcLinkGroup": { | |
"description": "Format:\r\nLink group name;Category id 1;Category id 2;Category id N", | |
"x-label": { | |
"default": "Link group" | |
}, | |
"type": "string" | |
}, | |
"c_wcType": { | |
"enum": [ | |
"standard", | |
"general", | |
"gallery", | |
"categories" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Standard" | |
}, | |
{ | |
"default": "General" | |
}, | |
{ | |
"default": "Gallery" | |
}, | |
{ | |
"default": "Categories" | |
} | |
], | |
"x-label": { | |
"default": "Type" | |
}, | |
"type": "string" | |
}, | |
"c_yandexMarketCategory": { | |
"x-label": { | |
"default": "Yandex Market Category" | |
}, | |
"type": "string" | |
}, | |
"categories": { | |
"description": "Array of subcategories. Can be empty.", | |
"items": { | |
"$ref": "#/definitions/category" | |
}, | |
"type": "array" | |
}, | |
"description": { | |
"description": "The localized description of the category.", | |
"x-label": { | |
"default": "Description" | |
}, | |
"type": "string" | |
}, | |
"id": { | |
"description": "The id of the category.", | |
"x-label": { | |
"default": "ID" | |
}, | |
"type": "string" | |
}, | |
"image": { | |
"description": "The URL to the category image.", | |
"x-label": { | |
"default": "Shop By Category Image" | |
}, | |
"type": "string" | |
}, | |
"name": { | |
"description": "The localized name of the category.", | |
"x-label": { | |
"default": "Name" | |
}, | |
"type": "string" | |
}, | |
"page_description": { | |
"description": "The localized page description of the category.", | |
"x-label": { | |
"default": "Page Description" | |
}, | |
"type": "string" | |
}, | |
"page_keywords": { | |
"description": "The localized page keywords of the category.", | |
"x-label": { | |
"default": "Page Keywords" | |
}, | |
"type": "string" | |
}, | |
"page_title": { | |
"description": "The localized page title of the category.", | |
"x-label": { | |
"default": "Page Title" | |
}, | |
"type": "string" | |
}, | |
"parent_category_id": { | |
"description": "The id of the parent category.", | |
"type": "string" | |
}, | |
"parent_category_tree": { | |
"description": "List of parent categories", | |
"items": { | |
"$ref": "#/definitions/path_record" | |
}, | |
"type": "array" | |
}, | |
"thumbnail": { | |
"description": "The URL to the category thumbnail.", | |
"x-label": { | |
"default": "Thumbnail Image" | |
}, | |
"type": "string" | |
} | |
} | |
}, | |
"category_result": { | |
"description": "Result document containing an array of categories.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"description": "The array of category documents.", | |
"items": { | |
"$ref": "#/definitions/category" | |
}, | |
"type": "array" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"content": { | |
"description": "Document representing a content asset.", | |
"properties": { | |
"c_CTAColorAll": { | |
"enum": [ | |
"black-white", | |
"green-white", | |
"white-red", | |
"gray-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Black Box/White Font" | |
}, | |
{ | |
"default": "Green Box/White Font" | |
}, | |
{ | |
"default": "White Box/Red Font" | |
}, | |
{ | |
"default": "Gray Box/White Font" | |
} | |
], | |
"x-label": { | |
"default": "Color for CTA's" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselAlignment": { | |
"enum": [ | |
"left", | |
"center", | |
"right", | |
"top-left", | |
"top-center", | |
"top-right", | |
"bottom-left", | |
"bottom-center", | |
"bottom-right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left Align" | |
}, | |
{ | |
"default": "Center Align" | |
}, | |
{ | |
"default": "Right Align" | |
}, | |
{ | |
"default": "Top Left Align" | |
}, | |
{ | |
"default": "Top Center Align" | |
}, | |
{ | |
"default": "Top Right Align" | |
}, | |
{ | |
"default": "Bottom Left Align" | |
}, | |
{ | |
"default": "Bottom Center Align" | |
}, | |
{ | |
"default": "Bottom Right" | |
} | |
], | |
"x-label": { | |
"default": "Alignment" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselBackgroundHEXColor": { | |
"description": "Six character hexadecimal color code. Default to theme color(s).\n ", | |
"x-label": { | |
"default": "Image Background Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_CarouselCTA1CategoryID": { | |
"x-label": { | |
"default": "CTA 1 CategoryID" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselCTA1Dialogify": { | |
"description": "Make the corresponding CTA URL open as a modal dialog", | |
"x-label": { | |
"default": "Carousel CTA 1 Opens Modal" | |
}, | |
"type": "boolean" | |
}, | |
"c_CarouselCTA1OpenInNewTab": { | |
"x-label": { | |
"default": "CTA 1 Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_CarouselCTA1ProductID": { | |
"x-label": { | |
"default": "CTA 1 ProductID" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselCTA1Text": { | |
"format": "text", | |
"x-label": { | |
"default": "CTA 1 Text" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselCTA1URL": { | |
"format": "html", | |
"x-label": { | |
"default": "CTA 1 URL" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselCTA2CategoryID": { | |
"x-label": { | |
"default": "CTA 2 CategoryID" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselCTA2Dialogify": { | |
"description": "Make the corresponding CTA URL open as a modal dialog", | |
"x-label": { | |
"default": "Carousel CTA 2 Opens Modal" | |
}, | |
"type": "boolean" | |
}, | |
"c_CarouselCTA2OpenInNewTab": { | |
"x-label": { | |
"default": "CTA 2 Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_CarouselCTA2ProductID": { | |
"x-label": { | |
"default": "CTA 2 ProductID" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselCTA2Text": { | |
"format": "text", | |
"x-label": { | |
"default": "CTA 2 Text" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselCTA2URL": { | |
"format": "html", | |
"x-label": { | |
"default": "CTA 2 URL" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselCTA3CategoryID": { | |
"x-label": { | |
"default": "CTA 3 CategoryID" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselCTA3Dialogify": { | |
"description": "Make the corresponding CTA URL open as a modal dialog", | |
"x-label": { | |
"default": "Carousel CTA 3 Opens Modal" | |
}, | |
"type": "boolean" | |
}, | |
"c_CarouselCTA3OpenInNewTab": { | |
"x-label": { | |
"default": "CTA 3 Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_CarouselCTA3ProductID": { | |
"x-label": { | |
"default": "CTA 3 ProductID" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselCTA3Text": { | |
"format": "text", | |
"x-label": { | |
"default": "CTA 3 Text" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselCTA3URL": { | |
"format": "html", | |
"x-label": { | |
"default": "CTA 3 URL" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselCopy": { | |
"description": "140 character length.", | |
"format": "text", | |
"x-label": { | |
"default": "Copy" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselCopyHEXColor": { | |
"description": "Six character hexadecimal color code. Default to theme color(s).\n ", | |
"x-label": { | |
"default": "Copy Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_CarouselDWImageLg": { | |
"x-label": { | |
"default": "DW Image Lg" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselDWImageMd": { | |
"x-label": { | |
"default": "DW Image Md" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselDWImageSm": { | |
"x-label": { | |
"default": "DW Image Sm" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselDWImageXs": { | |
"x-label": { | |
"default": "DW Image Xs" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselExternalMediaMP4URL": { | |
"description": "URL *.mp4 or *.m4v, Video Encoding MP4 + H.264, Audio Codec AAC\n ", | |
"x-label": { | |
"default": "MP4 Media URL" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselExternalMediaOGGURL": { | |
"description": "URL *.ogv, Video Encoding Ogg + Theora, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "OGG Media URL" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselExternalMediaWEBMURL": { | |
"description": "URL *.webm, Video Encoding WebM + VP8, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "WEBM Media URL" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHeadline": { | |
"description": "24 character length.", | |
"format": "text", | |
"x-label": { | |
"default": "Headline" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHeadlineHEXColor": { | |
"description": "Six character hexadecimal color code. Default to theme color(s).\n ", | |
"x-label": { | |
"default": "Headline Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_CarouselHotspot1HTML": { | |
"description": "Copy", | |
"format": "html", | |
"x-label": { | |
"default": "Hotspot 1 Content" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot1Horizontal": { | |
"description": "Percentage Position from Left", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 1 Horizontal" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselHotspot1Image": { | |
"description": "Image", | |
"x-label": { | |
"default": "Hotspot 1 Image" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot1Link": { | |
"description": "The URL or anchor to redirect the user when clicking the hotspot\n ", | |
"x-label": { | |
"default": "Hotspot 1 Link" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot1Orientation": { | |
"description": "Popover position relative to Spot", | |
"enum": [ | |
"top", | |
"bottom", | |
"right", | |
"left" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Top" | |
}, | |
{ | |
"default": "Bottom" | |
}, | |
{ | |
"default": "Right" | |
}, | |
{ | |
"default": "Left" | |
} | |
], | |
"x-label": { | |
"default": "Hotspot 1 Orientation" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot1PID": { | |
"x-label": { | |
"default": "Hotspot 1 Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot1Title": { | |
"description": "Title", | |
"x-label": { | |
"default": "Hotspot 1 Title" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot1Vertical": { | |
"description": "Percentage Position from Top", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 1 Vertical" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselHotspot2HTML": { | |
"description": "Copy", | |
"format": "html", | |
"x-label": { | |
"default": "Hotspot 2 Content" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot2Horizontal": { | |
"description": "Percentage Position from Left", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 2 Horizontal" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselHotspot2Image": { | |
"description": "Image", | |
"x-label": { | |
"default": "Hotspot 2 Image" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot2Link": { | |
"description": "The URL or anchor to redirect the user when clicking the hotspot\n ", | |
"x-label": { | |
"default": "Hotspot 2 Link" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot2Orientation": { | |
"description": "Popover position relative to Spot", | |
"enum": [ | |
"top", | |
"bottom", | |
"right", | |
"left" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Top" | |
}, | |
{ | |
"default": "Bottom" | |
}, | |
{ | |
"default": "Right" | |
}, | |
{ | |
"default": "Left" | |
} | |
], | |
"x-label": { | |
"default": "Hotspot 2 Orientation" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot2PID": { | |
"x-label": { | |
"default": "Hotspot 2 Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot2Title": { | |
"description": "Title", | |
"x-label": { | |
"default": "Hotspot 2 Title" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot2Vertical": { | |
"description": "Percentage Position from Top", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 2 Vertical" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselHotspot3HTML": { | |
"description": "Copy", | |
"format": "html", | |
"x-label": { | |
"default": "Hotspot 3 Content" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot3Horizontal": { | |
"description": "Percentage Position from Left", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 3 Horizontal" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselHotspot3Image": { | |
"description": "Image", | |
"x-label": { | |
"default": "Hotspot 3 Image" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot3Link": { | |
"description": "The URL or anchor to redirect the user when clicking the hotspot\n ", | |
"x-label": { | |
"default": "Hotspot 3 Link" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot3Orientation": { | |
"description": "Popover position relative to Spot", | |
"enum": [ | |
"top", | |
"bottom", | |
"right", | |
"left" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Top" | |
}, | |
{ | |
"default": "Bottom" | |
}, | |
{ | |
"default": "Right" | |
}, | |
{ | |
"default": "Left" | |
} | |
], | |
"x-label": { | |
"default": "Hotspot 3 Orientation" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot3PID": { | |
"x-label": { | |
"default": "Hotspot 3 Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot3Title": { | |
"description": "Title", | |
"x-label": { | |
"default": "Hotspot 3 Title" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot3Vertical": { | |
"description": "Percentage Position from Top", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 3 Vertical" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselHotspot4HTML": { | |
"description": "Copy", | |
"format": "html", | |
"x-label": { | |
"default": "Hotspot 4 Content" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot4Horizontal": { | |
"description": "Percentage Position from Left", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 4 Horizontal" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselHotspot4Image": { | |
"description": "Image", | |
"x-label": { | |
"default": "Hotspot 4 Image" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot4Link": { | |
"description": "The URL or anchor to redirect the user when clicking the hotspot\n ", | |
"x-label": { | |
"default": "Hotspot 4 Link" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot4Orientation": { | |
"description": "Popover position relative to Spot", | |
"enum": [ | |
"top", | |
"bottom", | |
"right", | |
"left" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Top" | |
}, | |
{ | |
"default": "Bottom" | |
}, | |
{ | |
"default": "Right" | |
}, | |
{ | |
"default": "Left" | |
} | |
], | |
"x-label": { | |
"default": "Hotspot 4 Orientation" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot4PID": { | |
"x-label": { | |
"default": "Hotspot 4 Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot4Title": { | |
"description": "Title", | |
"x-label": { | |
"default": "Hotspot 4 Title" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot4Vertical": { | |
"description": "Percentage Position from Top", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 4 Vertical" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselHotspot5HTML": { | |
"description": "Copy", | |
"format": "html", | |
"x-label": { | |
"default": "Hotspot 5 Content" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot5Horizontal": { | |
"description": "Percentage Position from Left", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 5 Horizontal" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselHotspot5Image": { | |
"description": "Image", | |
"x-label": { | |
"default": "Hotspot 5 Image" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot5Link": { | |
"description": "The URL or anchor to redirect the user when clicking the hotspot\n ", | |
"x-label": { | |
"default": "Hotspot 5 Link" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot5Orientation": { | |
"description": "Popover position relative to Spot", | |
"enum": [ | |
"top", | |
"bottom", | |
"right", | |
"left" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Top" | |
}, | |
{ | |
"default": "Bottom" | |
}, | |
{ | |
"default": "Right" | |
}, | |
{ | |
"default": "Left" | |
} | |
], | |
"x-label": { | |
"default": "Hotspot 5 Orientation" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot5PID": { | |
"x-label": { | |
"default": "Hotspot 5 Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot5Title": { | |
"description": "Title", | |
"x-label": { | |
"default": "Hotspot 5 Title" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot5Vertical": { | |
"description": "Percentage Position from Top", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 5 Vertical" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselHotspot6HTML": { | |
"description": "Copy", | |
"format": "html", | |
"x-label": { | |
"default": "Hotspot 6 Content" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot6Horizontal": { | |
"description": "Percentage Position from Left", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 6 Horizontal" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselHotspot6Image": { | |
"description": "Image", | |
"x-label": { | |
"default": "Hotspot 6 Image" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot6Link": { | |
"description": "The URL or anchor to redirect the user when clicking the hotspot\n ", | |
"x-label": { | |
"default": "Hotspot 6 Link" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot6Orientation": { | |
"description": "Popover position relative to Spot", | |
"enum": [ | |
"top", | |
"bottom", | |
"right", | |
"left" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Top" | |
}, | |
{ | |
"default": "Bottom" | |
}, | |
{ | |
"default": "Right" | |
}, | |
{ | |
"default": "Left" | |
} | |
], | |
"x-label": { | |
"default": "Hotspot 6 Orientation" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot6PID": { | |
"x-label": { | |
"default": "Hotspot 6 Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot6Title": { | |
"description": "Title", | |
"x-label": { | |
"default": "Hotspot 6 Title" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot6Vertical": { | |
"description": "Percentage Position from Top", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 6 Vertical" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselHotspot7HTML": { | |
"description": "Copy", | |
"format": "html", | |
"x-label": { | |
"default": "Hotspot 7 Content" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot7Horizontal": { | |
"description": "Percentage Position from Left", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 7 Horizontal" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselHotspot7Image": { | |
"description": "Image", | |
"x-label": { | |
"default": "Hotspot 7 Image" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot7Link": { | |
"description": "The URL or anchor to redirect the user when clicking the hotspot\n ", | |
"x-label": { | |
"default": "Hotspot 7 Link" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot7Orientation": { | |
"description": "Popover position relative to Spot", | |
"enum": [ | |
"top", | |
"bottom", | |
"right", | |
"left" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Top" | |
}, | |
{ | |
"default": "Bottom" | |
}, | |
{ | |
"default": "Right" | |
}, | |
{ | |
"default": "Left" | |
} | |
], | |
"x-label": { | |
"default": "Hotspot 7 Orientation" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot7PID": { | |
"x-label": { | |
"default": "Hotspot 7 Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot7Title": { | |
"description": "Title", | |
"x-label": { | |
"default": "Hotspot 7 Title" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselHotspot7Vertical": { | |
"description": "Percentage Position from Top", | |
"format": "int32", | |
"x-label": { | |
"default": "Hotspot 7 Vertical" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_CarouselLayoutOrder": { | |
"enum": [ | |
"primary-secondary-copy-ctas", | |
"secondary-primary-copy-ctas" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Headline, Sub-Headline, Copy, CTAs" | |
}, | |
{ | |
"default": "Sub-Headline, Headline, Copy, CTAs" | |
} | |
], | |
"x-label": { | |
"default": "Layout Order" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselPIDs": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Product Carousel Product IDs" | |
}, | |
"type": "array" | |
}, | |
"c_CarouselPisaImageURL": { | |
"description": "Overrides DWImage", | |
"x-label": { | |
"default": "PISA ImageURL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_CarouselProductsHeadline": { | |
"format": "html", | |
"x-label": { | |
"default": "Product Carousel Headline" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselScene7ImageURL": { | |
"description": "Overrides DWImage", | |
"x-label": { | |
"default": "Scene7ImageURL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_CarouselSubHeadline": { | |
"description": "34 character length.", | |
"format": "text", | |
"x-label": { | |
"default": "Sub-Headline" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselSubHeadlineHEXColor": { | |
"description": "Six character hexadecimal color code. Default to theme color(s).\n ", | |
"x-label": { | |
"default": "Sub-Headline Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_CarouselTheme": { | |
"enum": [ | |
"light", | |
"dark" | |
], | |
"x-label": { | |
"default": "Utility Theme" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselThemeHEX": { | |
"x-label": { | |
"default": "Utility Background Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_CarouselVideoDisableAutoPlay": { | |
"description": "Default False", | |
"x-label": { | |
"default": "Disable AutoPlay" | |
}, | |
"type": "boolean" | |
}, | |
"c_CarouselVideoDisableLoop": { | |
"description": "Default False", | |
"x-label": { | |
"default": "Disable Play Loop" | |
}, | |
"type": "boolean" | |
}, | |
"c_CarouselVideoEnableAudio": { | |
"description": "Default False, Audio is recommended to be enabled on initial load\n ", | |
"x-label": { | |
"default": "Enable Audio" | |
}, | |
"type": "boolean" | |
}, | |
"c_CarouselVideoMediaMP4": { | |
"description": "File *.mp4 or *.m4v, Video Encoding MP4 + H.264, Audio Codec AAC\n ", | |
"x-label": { | |
"default": "MP4 Media File" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselVideoMediaOGG": { | |
"description": "File *.ogv, Video Encoding Ogg + Theora, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "OGG Media File" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselVideoMediaWEBM": { | |
"description": "File *.webm, Video Encoding WebM + VP8, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "WEBM Media File" | |
}, | |
"type": "string" | |
}, | |
"c_CarouselVideoYoutubeID": { | |
"description": "Youtube Video ID", | |
"format": "text", | |
"x-label": { | |
"default": "Youtube Video ID" | |
}, | |
"type": "string" | |
}, | |
"c_FeatureRowAlignment": { | |
"description": "Optional, default value opposite (left/right) of prior row. First row\n default is left.\n ", | |
"enum": [ | |
"left", | |
"right" | |
], | |
"x-label": { | |
"default": "Row Alignment" | |
}, | |
"type": "string" | |
}, | |
"c_FeatureRowCTA1CategoryID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "CTA 1 CGID" | |
}, | |
"type": "string" | |
}, | |
"c_FeatureRowCTA1OpenInModal": { | |
"x-label": { | |
"default": "CTA 1 Open In Modal" | |
}, | |
"type": "boolean" | |
}, | |
"c_FeatureRowCTA1OpenInNewTab": { | |
"x-label": { | |
"default": "CTA 1 Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_FeatureRowCTA1ProductID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "CTA 1 PID" | |
}, | |
"type": "string" | |
}, | |
"c_FeatureRowCTA1Text": { | |
"description": "Optional, Required to render CTA 1", | |
"x-label": { | |
"default": "CTA 1 Text" | |
}, | |
"type": "string" | |
}, | |
"c_FeatureRowCTA1URL": { | |
"description": "Optional, plain text or BM Url Functions", | |
"format": "html", | |
"x-label": { | |
"default": "CTA 1 URL" | |
}, | |
"type": "string" | |
}, | |
"c_FeatureRowHTML": { | |
"description": "Optional, HTML Content & Copy below Headline", | |
"format": "html", | |
"x-label": { | |
"default": "Feature Row Content" | |
}, | |
"type": "string" | |
}, | |
"c_FeatureRowHeadline": { | |
"description": "Required, Headline within Copy Square", | |
"x-label": { | |
"default": "Feature Row Headline" | |
}, | |
"type": "string" | |
}, | |
"c_FeatureRowHeadlineHEXColor": { | |
"description": "Six character hexadecimal color code. Default to theme color(s).\n ", | |
"x-label": { | |
"default": "Headline Hex Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_FeatureRowImageRectangular": { | |
"description": "Required. DW Hosted Image (590px by 300px)", | |
"x-label": { | |
"default": "Rectangular Image" | |
}, | |
"type": "string" | |
}, | |
"c_FeatureRowImageSquare": { | |
"description": "Required. DW Hosted Image (295px x 300px)", | |
"x-label": { | |
"default": "Square Image" | |
}, | |
"type": "string" | |
}, | |
"c_FeatureRowRectangularOpenInModal": { | |
"x-label": { | |
"default": "Rectangular Open In Modal" | |
}, | |
"type": "boolean" | |
}, | |
"c_FeatureRowRectangularOpenInNewTab": { | |
"x-label": { | |
"default": "Rectangular Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_FeatureRowRectangularURL": { | |
"description": "Optional, plain text or BM URL Functions", | |
"format": "html", | |
"x-label": { | |
"default": "Rectangular URL" | |
}, | |
"type": "string" | |
}, | |
"c_FeatureRowSquareOpenInModal": { | |
"x-label": { | |
"default": "Square Open In Modal" | |
}, | |
"type": "boolean" | |
}, | |
"c_FeatureRowSquareOpenInNewTab": { | |
"x-label": { | |
"default": "Square Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_FeatureRowSquareURL": { | |
"description": "Optional, plain text or BM URL Functions", | |
"format": "html", | |
"x-label": { | |
"default": "Square URL" | |
}, | |
"type": "string" | |
}, | |
"c_FlyoutCTA1Display": { | |
"enum": [ | |
"button", | |
"text" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Headline with CTA displayed as a button. Left aligned." | |
}, | |
{ | |
"default": "CTA displayed as text. Bottom/Center aligned." | |
} | |
], | |
"x-label": { | |
"default": "FlyoutCTA1Display" | |
}, | |
"type": "string" | |
}, | |
"c_FlyoutCTA1HeaderText": { | |
"x-label": { | |
"default": "Flyout Header Text" | |
}, | |
"type": "string" | |
}, | |
"c_FlyoutCTA1Image": { | |
"x-label": { | |
"default": "Flyout Image Asset" | |
}, | |
"type": "string" | |
}, | |
"c_FlyoutCTA1ImageURL": { | |
"description": "Use this for external images URLs such as a CDN. If set, this will override the Image Asset.", | |
"x-label": { | |
"default": "Flyout Image URL" | |
}, | |
"type": "string" | |
}, | |
"c_FlyoutCTA1Text": { | |
"x-label": { | |
"default": "Flyout CTA Text" | |
}, | |
"type": "string" | |
}, | |
"c_FlyoutCTA1URL": { | |
"description": "Leave blank to link to this Category.", | |
"x-label": { | |
"default": "Flyout URL" | |
}, | |
"type": "string" | |
}, | |
"c_GlobalBannerBottom": { | |
"enum": [ | |
"1.1375rem", | |
"1.125rem", | |
"0.875rem" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "22px" | |
}, | |
{ | |
"default": "18px" | |
}, | |
{ | |
"default": "14px" | |
} | |
], | |
"x-label": { | |
"default": "Padding Bottom" | |
}, | |
"type": "string" | |
}, | |
"c_GlobalBannerTop": { | |
"enum": [ | |
"1.1375rem", | |
"1.125rem", | |
"0.875rem" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "22px" | |
}, | |
{ | |
"default": "18px" | |
}, | |
{ | |
"default": "14px" | |
} | |
], | |
"x-label": { | |
"default": "Padding Top" | |
}, | |
"type": "string" | |
}, | |
"c_NMBctaText": { | |
"x-label": { | |
"default": "NMB CTA Text" | |
}, | |
"type": "string" | |
}, | |
"c_NMBctaURL": { | |
"x-label": { | |
"default": "NMB CTA URL" | |
}, | |
"type": "string" | |
}, | |
"c_NMBimage": { | |
"x-label": { | |
"default": "NMB Image" | |
}, | |
"type": "string" | |
}, | |
"c_NMBproductID": { | |
"x-label": { | |
"default": "NMB Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_NMBtitleHTML": { | |
"description": "Accepts valid HTML", | |
"x-label": { | |
"default": "NMB Title" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventBody": { | |
"format": "html", | |
"x-label": { | |
"default": "News/Event Body" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventCTA1CategoryID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "CTA 1 Category ID" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventCTA1OpenInNewTab": { | |
"x-label": { | |
"default": "CTA 1 Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_NewsEventCTA1ProductID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "CTA 1 Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventCTA1Text": { | |
"description": "Required to render CTA", | |
"x-label": { | |
"default": "CTA 1 Text" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventCTA1URL": { | |
"description": "Optional, plain text or BM URL functions", | |
"x-label": { | |
"default": "CTA 1 URL" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventCategoryIDs": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "News/Event Category IDs" | |
}, | |
"type": "array" | |
}, | |
"c_NewsEventCountryCodeRestriction": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "News/Event Country Code Restriction" | |
}, | |
"type": "array" | |
}, | |
"c_NewsEventDateTimeBegin": { | |
"format": "date-time", | |
"x-label": { | |
"default": "News/Event Date-Time Begin" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventDateTimeEnd": { | |
"format": "date-time", | |
"x-label": { | |
"default": "News/Event Date-Time End" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventHeadline": { | |
"format": "text", | |
"x-label": { | |
"default": "News/Event Headline" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventImageLg": { | |
"x-label": { | |
"default": "News/Event Image Lg" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventImageMd": { | |
"x-label": { | |
"default": "News/Event Image Md" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventImagePreviewLg": { | |
"x-label": { | |
"default": "News/Event Image Preview Lg" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventImagePreviewMd": { | |
"x-label": { | |
"default": "NewsEventImagePreviewMd" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventImagePreviewSmSquare": { | |
"x-label": { | |
"default": "News/Event Image Preview Sm Square" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventImagePreviewSmTall": { | |
"x-label": { | |
"default": "News/Event Image Preview Sm Tall" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventImagePreviewXs": { | |
"x-label": { | |
"default": "News/Event Image Preview Xs" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventImageSm": { | |
"x-label": { | |
"default": "News/Event Image Sm" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventImageXs": { | |
"x-label": { | |
"default": "News/Event Image Xs" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventLocationAddress1": { | |
"format": "text", | |
"x-label": { | |
"default": "News/Event Location Address 1" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventLocationAddress2": { | |
"format": "text", | |
"x-label": { | |
"default": "News/Event Location Address 2" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventLocationCity": { | |
"format": "text", | |
"x-label": { | |
"default": "News/Event Location City" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventLocationCountry": { | |
"format": "text", | |
"x-label": { | |
"default": "News/Event Location Country" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventLocationName": { | |
"format": "text", | |
"x-label": { | |
"default": "News/Event Location Name" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventLocationStateProv": { | |
"format": "text", | |
"x-label": { | |
"default": "News/Event Location State/Prov" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventPreview": { | |
"format": "text", | |
"x-label": { | |
"default": "News/Event Preview" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventQuote": { | |
"format": "text", | |
"x-label": { | |
"default": "News/Event Quote" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventSubHeadline": { | |
"format": "text", | |
"x-label": { | |
"default": "News/Event SubHeadline" | |
}, | |
"type": "string" | |
}, | |
"c_NewsEventTopics": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "News/Event Topics" | |
}, | |
"type": "array" | |
}, | |
"c_ProfileAchievements": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Profile Achievements" | |
}, | |
"type": "array" | |
}, | |
"c_ProfileClub": { | |
"x-label": { | |
"default": "Club" | |
}, | |
"type": "string" | |
}, | |
"c_ProfileCopy": { | |
"format": "html", | |
"x-label": { | |
"default": "Copy" | |
}, | |
"type": "string" | |
}, | |
"c_ProfileDateOfBirth": { | |
"x-label": { | |
"default": "Date of Birth" | |
}, | |
"type": "string" | |
}, | |
"c_ProfileFacebook": { | |
"x-label": { | |
"default": "Team or Player Facebook" | |
}, | |
"type": "string" | |
}, | |
"c_ProfileFollow": { | |
"format": "html", | |
"x-label": { | |
"default": "Follow" | |
}, | |
"type": "string" | |
}, | |
"c_ProfileFollowImage": { | |
"x-label": { | |
"default": "Follow Avatar" | |
}, | |
"type": "string" | |
}, | |
"c_ProfileFounded": { | |
"x-label": { | |
"default": "Founded" | |
}, | |
"type": "string" | |
}, | |
"c_ProfileImage": { | |
"x-label": { | |
"default": "Main Image" | |
}, | |
"type": "string" | |
}, | |
"c_ProfileKnownFor": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Known For" | |
}, | |
"type": "array" | |
}, | |
"c_ProfileNationality": { | |
"x-label": { | |
"default": "Nationality" | |
}, | |
"type": "string" | |
}, | |
"c_ProfileNickname": { | |
"x-label": { | |
"default": "Nickname" | |
}, | |
"type": "string" | |
}, | |
"c_ProfilePosition": { | |
"x-label": { | |
"default": "Position" | |
}, | |
"type": "string" | |
}, | |
"c_ProfileSecondaryTitle": { | |
"x-label": { | |
"default": "Secondary About Title" | |
}, | |
"type": "string" | |
}, | |
"c_ProfileTeam": { | |
"x-label": { | |
"default": "Team" | |
}, | |
"type": "string" | |
}, | |
"c_ProfileTitle": { | |
"x-label": { | |
"default": "Main Title" | |
}, | |
"type": "string" | |
}, | |
"c_ProfileTwitter": { | |
"x-label": { | |
"default": "Twitter" | |
}, | |
"type": "string" | |
}, | |
"c_ShowcaseDisplayName": { | |
"description": "Showcase\r\n Display\r\n Name\n ", | |
"x-label": { | |
"default": "Showcase Display Name" | |
}, | |
"type": "string" | |
}, | |
"c_ShowcaseImage": { | |
"description": "Showcase\r\n Image\n ", | |
"x-label": { | |
"default": "Showcase Image" | |
}, | |
"type": "string" | |
}, | |
"c_ShowcaseProductID": { | |
"description": "Product ID used to link the showcase to specific product page\n ", | |
"x-label": { | |
"default": "Showcase Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_ShowcaseRecipeID": { | |
"description": "Recipe ID used in conjunction with 'Showcase Product ID' to render\n link to specific product page & custom recipe for configurator.\n ", | |
"x-label": { | |
"default": "Showcase Recipe ID" | |
}, | |
"type": "string" | |
}, | |
"c_SliderLeftDWImage": { | |
"description": "The left image for the ImageSlider content asset type", | |
"x-label": { | |
"default": "Slider Left Demandware Image" | |
}, | |
"type": "string" | |
}, | |
"c_SliderLeftPisaImage": { | |
"description": "The left image for the ImageSlider content asset type, served from\n PISA\n ", | |
"x-label": { | |
"default": "Slider Left PISA Image" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_SliderLeftScene7Image": { | |
"description": "The left image for the ImageSlider content asset type, served from\n Scene 7\n ", | |
"x-label": { | |
"default": "Slider Left Scene 7 Image" | |
}, | |
"type": "string" | |
}, | |
"c_SliderRightDWImage": { | |
"description": "The right image for the ImageSlider content asset type", | |
"x-label": { | |
"default": "Slider Right Demandware Image" | |
}, | |
"type": "string" | |
}, | |
"c_SliderRightPisaImage": { | |
"description": "The right image for the ImageSlider content asset type, served from\n PISA\n ", | |
"x-label": { | |
"default": "Slider Right PISA Image" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_SliderRightScene7Image": { | |
"description": "The right image for the ImageSlider content asset type, served from\n Scene 7\n ", | |
"x-label": { | |
"default": "Slider Right Scene 7 Image" | |
}, | |
"type": "string" | |
}, | |
"c_SliderScreenReaderCaption": { | |
"description": "Caption for screen readers to read when the user focuses the\n ImageSlider control in a ImageSlider content asset\n ", | |
"x-label": { | |
"default": "Slider Screen Reader Caption" | |
}, | |
"type": "string" | |
}, | |
"c_SpinnerCTA1CategoryID": { | |
"description": "Optional, overrides Product URL with Category URL", | |
"x-label": { | |
"default": "Spinner CTA 1 CGID" | |
}, | |
"pattern": "^[A-Fa-f0-9\\-\\+\\_]$", | |
"type": "string" | |
}, | |
"c_SpinnerCTA1HEXColor": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Spinner CTA 1 HEX Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_SpinnerCTA1TargetNew": { | |
"description": "Default false", | |
"x-label": { | |
"default": "Spinner CTA 1 New Window Target" | |
}, | |
"type": "boolean" | |
}, | |
"c_SpinnerCTA1Text": { | |
"description": "Optional, overrides Product Name CTA", | |
"x-label": { | |
"default": "Spinner CTA 1 Text" | |
}, | |
"type": "string" | |
}, | |
"c_SpinnerCTA1URL": { | |
"description": "Optional, plain text or BM Url Functions, overrides Product URL\n ", | |
"format": "html", | |
"x-label": { | |
"default": "Spinner CTA 1 URL" | |
}, | |
"type": "string" | |
}, | |
"c_SpinnerCTA2CategoryID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Spinner CTA 2 CGID" | |
}, | |
"type": "string" | |
}, | |
"c_SpinnerCTA2HEXColor": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Spinner CTA 2 HEX Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_SpinnerCTA2TargetNew": { | |
"description": "Default false", | |
"x-label": { | |
"default": "Spinner CTA 2 New Window Target" | |
}, | |
"type": "boolean" | |
}, | |
"c_SpinnerCTA2Text": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Spinner CTA 2 Text" | |
}, | |
"type": "string" | |
}, | |
"c_SpinnerCTA2URL": { | |
"description": "Optional, plain text or BM Url Functions", | |
"format": "html", | |
"x-label": { | |
"default": "Spinner CTA 2 URL" | |
}, | |
"type": "string" | |
}, | |
"c_SpinnerCopy": { | |
"description": "Optional, overrides Product Short Description", | |
"x-label": { | |
"default": "Spinner Copy" | |
}, | |
"type": "string" | |
}, | |
"c_SpinnerCopyHEXColor": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Spinner Copy HEX Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_SpinnerHeadline": { | |
"description": "Optional, overrides Product Name", | |
"x-label": { | |
"default": "Spinner Headline" | |
}, | |
"type": "string" | |
}, | |
"c_SpinnerHeadlineHEXColor": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Spinner Headline HEX Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_SpinnerLayout": { | |
"description": "Optional, Default 'Left'", | |
"enum": [ | |
"middle-left", | |
"middle-center", | |
"middle-right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Spinner Layout" | |
}, | |
"type": "string" | |
}, | |
"c_SpinnerPID": { | |
"description": "Product ID reference", | |
"x-label": { | |
"default": "Spinner PID" | |
}, | |
"type": "string" | |
}, | |
"c_SpinnerPrice": { | |
"description": "Optional, overrides Product Price", | |
"x-label": { | |
"default": "Spinner Price" | |
}, | |
"type": "string" | |
}, | |
"c_SpinnerPriceHEXColor": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Spinner Price HEX Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_SpinnerSubheadline": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Spinner Subheadline" | |
}, | |
"type": "string" | |
}, | |
"c_SpinnerSubheadlineHEXColor": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Spinner Subheadline HEX Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_SpinnerThumbnailPisaView": { | |
"description": "Optional, represents PISA product view value. Default 'sv01'\n ", | |
"enum": [ | |
"fv", | |
"bv", | |
"bv02", | |
"sv01", | |
"sv02", | |
"sv03", | |
"dt01", | |
"dt02", | |
"mod01", | |
"mod02" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Front View" | |
}, | |
{ | |
"default": "Back View" | |
}, | |
{ | |
"default": "Back View 02" | |
}, | |
{ | |
"default": "Side View 01" | |
}, | |
{ | |
"default": "Side View 02" | |
}, | |
{ | |
"default": "Side View 03" | |
}, | |
{ | |
"default": "Detail View 01" | |
}, | |
{ | |
"default": "Detail View 02" | |
}, | |
{ | |
"default": "Model View 01" | |
}, | |
{ | |
"default": "Model View 02" | |
} | |
], | |
"x-label": { | |
"default": "Spinner Thumbnail View" | |
}, | |
"type": "string" | |
}, | |
"c_SpinnerThumbnailView": { | |
"description": "Optional, represents Scene7 product view value. \r\n Default '_03'.\n ", | |
"enum": [ | |
"_01", | |
"_02", | |
"_03", | |
"_04", | |
"_05", | |
"_06", | |
"_07", | |
"_08", | |
"_09", | |
"_10" | |
], | |
"x-label": { | |
"default": "Spinner Thumbnail View" | |
}, | |
"type": "string" | |
}, | |
"c_SpotlightBannerHEX": { | |
"description": "Six character hexadecimal color code. Default to theme color(s).\n ", | |
"x-label": { | |
"default": "Banner Background Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_SpotlightBannerPisaImageURL": { | |
"x-label": { | |
"default": "PISA Banner Image URL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_SpotlightBannerScene7ImageURL": { | |
"x-label": { | |
"default": "Scene7 Banner Image ID" | |
}, | |
"type": "string" | |
}, | |
"c_SpotlightBottomPisaImageURL": { | |
"x-label": { | |
"default": "PISA Bottom Image URL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_SpotlightBottomScene7ImageURL": { | |
"x-label": { | |
"default": "Scene7 Bottom Image ID" | |
}, | |
"type": "string" | |
}, | |
"c_SpotlightImageLeftAlignment": { | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "left" | |
}, | |
{ | |
"default": "center" | |
}, | |
{ | |
"default": "right" | |
} | |
], | |
"x-label": { | |
"default": "Left Image Alignment" | |
}, | |
"type": "string" | |
}, | |
"c_SpotlightLeftPisaImageURL": { | |
"x-label": { | |
"default": "PISA Left Image URL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_SpotlightLeftScene7ImageURL": { | |
"x-label": { | |
"default": "Scene7 Left Image ID" | |
}, | |
"type": "string" | |
}, | |
"c_StyliticsCarouselArrows": { | |
"description": "Toggles whether or not arrows should be displayed on the mobile version of the Stylitics Carousel or Full Page Gallery.", | |
"x-label": { | |
"default": "Stylitics Carousel and Gallery Arrows" | |
}, | |
"type": "boolean" | |
}, | |
"c_StyliticsCarouselCTABackToLookText": { | |
"description": "Defines the text to be used for Stylitics Stacked Carousel and Full Page Gallery CTA back to look text.", | |
"x-label": { | |
"default": "Stylitics Carousel and Gallery CTA Back to Look Text" | |
}, | |
"type": "string" | |
}, | |
"c_StyliticsCarouselCTAText": { | |
"description": "Defines the text to be used for Stylitics Stacked Carousel and Full Page Gallery CTA text.", | |
"x-label": { | |
"default": "Stylitics Carousel and Gallery CTA Text" | |
}, | |
"type": "string" | |
}, | |
"c_StyliticsCarouselClickToReveal": { | |
"description": "Toggles whether the click to reveal functionality should be enabled/disabled for the Stylitics Stacked Carousel and Full Page Gallery widgets.", | |
"x-label": { | |
"default": "Stylitics Carousel and Gallery Click to Reveal" | |
}, | |
"type": "boolean" | |
}, | |
"c_StyliticsCarouselCols": { | |
"description": "Contains the number of columns/slides to be used for the Stylitics Stacked Carousels and Full Page Gallery.", | |
"format": "int32", | |
"x-label": { | |
"default": "Stylitics Carousel and Gallery Columns" | |
}, | |
"type": "integer" | |
}, | |
"c_StyliticsCarouselItemCTAText": { | |
"description": "Defines the text to be used for Stylitics Stacked Carousel and Full Page Gallery item CTA text.", | |
"x-label": { | |
"default": "Stylitics Carousel and Gallery Item CTA Text" | |
}, | |
"type": "string" | |
}, | |
"c_StyliticsCarouselPosition": { | |
"description": "Defines the CTA position to be used for Stylitics Stacked Carousel and Full Page Gallery widgets.", | |
"x-label": { | |
"default": "Stylitics Carousel and Gallery Position" | |
}, | |
"type": "string" | |
}, | |
"c_StyliticsCarouselTags": { | |
"description": "Tags to be used for Stylitics Stacked Carousels and Full Page Galleries. NOTE: MUST BE COMMA SEPARATED FOR MULTIPLE STACKED CAROUSELS AND FULL PAGE GALLERIES!", | |
"x-label": { | |
"default": "Stylitics Carousel and Gallery Tags" | |
}, | |
"type": "string" | |
}, | |
"c_StyliticsCarouselThemeClass": { | |
"description": "Defines the theme class to be used for Stylitics Stacked Carousels.", | |
"x-label": { | |
"default": "Stylitics Carousel Theme Class" | |
}, | |
"type": "string" | |
}, | |
"c_StyliticsCarouselWrap": { | |
"x-label": { | |
"default": "Stylitics Carousel and Gallery Wrap" | |
}, | |
"type": "boolean" | |
}, | |
"c_StyliticsGalleryPadding": { | |
"description": "Adjusts the padding, in pixels, for the Stylitics gallery.", | |
"format": "int32", | |
"x-label": { | |
"default": "Stylitics Gallery Padding" | |
}, | |
"type": "integer" | |
}, | |
"c_StyliticsGalleryRows": { | |
"description": "Contains the number of rows to be used for the Stylitics Full Page Gallery.", | |
"format": "int32", | |
"x-label": { | |
"default": "Stylitics Gallery Rows" | |
}, | |
"type": "integer" | |
}, | |
"c_StyliticsPDPTags": { | |
"x-label": { | |
"default": "Stylitics PDP Tags" | |
}, | |
"type": "string" | |
}, | |
"c_StyliticsProductID": { | |
"description": "Product ID to be used for Stylitics.", | |
"x-label": { | |
"default": "Stylitics Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavAlwaysVisible": { | |
"x-label": { | |
"default": "Always Visible" | |
}, | |
"type": "boolean" | |
}, | |
"c_SubNavAnchor1CategoryID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Anchor 1 CTA CGID" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavAnchor1OpenInNewTab": { | |
"x-label": { | |
"default": "Anchor 1 CTA Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_SubNavAnchor1ProductID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Anchor 1 CTA PID" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavAnchor1URL": { | |
"description": "Optional", | |
"format": "html", | |
"x-label": { | |
"default": "Anchor 1 CTA URL" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavAnchor2CategoryID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Anchor 2 CTA CGID" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavAnchor2OpenInNewTab": { | |
"x-label": { | |
"default": "Anchor 2 CTA Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_SubNavAnchor2ProductID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Anchor 2 CTA PID" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavAnchor2URL": { | |
"description": "Optional", | |
"format": "html", | |
"x-label": { | |
"default": "Anchor 2 CTA URL" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavAnchor3CategoryID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Anchor 3 CTA CGID" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavAnchor3OpenInNewTab": { | |
"x-label": { | |
"default": "Anchor 3 CTA Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_SubNavAnchor3ProductID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Anchor 3 CTA PID" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavAnchor3URL": { | |
"description": "Optional", | |
"format": "html", | |
"x-label": { | |
"default": "Anchor 3 CTA URL" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavAnchor4CategoryID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Anchor 4 CTA CGID" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavAnchor4OpenInNewTab": { | |
"x-label": { | |
"default": "Anchor 4 CTA Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_SubNavAnchor4ProductID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "Anchor 4 CTA PID" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavAnchor4URL": { | |
"description": "Optional", | |
"format": "html", | |
"x-label": { | |
"default": "Anchor 4 CTA URL" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavAnchorIDs": { | |
"description": "Set of HTML IDs to target for scrollTo events", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "HTML Anchor IDs" | |
}, | |
"type": "array" | |
}, | |
"c_SubNavAnchorText": { | |
"description": "Set of Anchor Labels respective to Anchor IDs", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Anchor Labels" | |
}, | |
"type": "array" | |
}, | |
"c_SubNavBackgroundHEXColor": { | |
"description": "Optional, six character hexadecimal color code. Default to theme\n color(s).\n ", | |
"x-label": { | |
"default": "Background Hex Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_SubNavBackgroundOpacity": { | |
"description": "Optional, default value is 80%.", | |
"format": "int32", | |
"x-label": { | |
"default": "Background Color Opacity" | |
}, | |
"maximum": 100.0, | |
"type": "integer" | |
}, | |
"c_SubNavBordersHEXColor": { | |
"description": "Optional, six character hexadecimal color code. Default to theme\n color(s).\n ", | |
"x-label": { | |
"default": "Dividers Hex Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_SubNavCTA1CategoryID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "CTA 1 CGID" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavCTA1OpenInNewTab": { | |
"description": "Optional", | |
"x-label": { | |
"default": "CTA 1 Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_SubNavCTA1ProductID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "CTA 1 PID" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavCTA1Text": { | |
"description": "Optional, Required to render CTA 1", | |
"x-label": { | |
"default": "CTA 1 Text" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavCTA1URL": { | |
"description": "Optional", | |
"format": "html", | |
"x-label": { | |
"default": "CTA 1 URL" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavCTA2CategoryID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "CTA 2 CGID" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavCTA2OpenInNewTab": { | |
"x-label": { | |
"default": "CTA 2 Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_SubNavCTA2ProductID": { | |
"description": "Optional", | |
"x-label": { | |
"default": "CTA 2 PID" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavCTA2Text": { | |
"description": "Optional, Required to render CTA 2", | |
"x-label": { | |
"default": "CTA 2 Text" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavCTA2URL": { | |
"description": "Optional", | |
"format": "html", | |
"x-label": { | |
"default": "CTA 2 URL" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavCopyHEXColor": { | |
"description": "Optional, six character hexadecimal color code. Default to theme\n color(s).\n ", | |
"x-label": { | |
"default": "Copy Hex Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_SubNavHTML": { | |
"description": "Optional. Content to appear next to branding image", | |
"format": "html", | |
"x-label": { | |
"default": "Image Adjacent Content" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavImage": { | |
"description": "Optional. DW Hosted Image (Flexible width, 30px height).", | |
"x-label": { | |
"default": "Brand Image" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavMenuArrow": { | |
"description": "Optional. Default to Puma Arrow (15px by 15px)", | |
"x-label": { | |
"default": "XS Menu Icon" | |
}, | |
"type": "string" | |
}, | |
"c_SubNavMenuDivider": { | |
"description": "Optional.", | |
"x-label": { | |
"default": "XS Menu Divider" | |
}, | |
"type": "string" | |
}, | |
"c_TrendingNowInlineCategoryID": { | |
"description": "Optional, Category ID reference", | |
"x-label": { | |
"default": "TrendingNowInline CategotyID" | |
}, | |
"type": "string" | |
}, | |
"c_TrendingNowInlineCategotyID": { | |
"x-label": { | |
"default": "TrendingNowInline CategotyID" | |
}, | |
"type": "string" | |
}, | |
"c_TrendingNowInlineOpenInNewTab": { | |
"description": "Optional", | |
"x-label": { | |
"default": "TrendingNowInline Open In New Tab" | |
}, | |
"type": "boolean" | |
}, | |
"c_TrendingNowInlineProductID": { | |
"description": "Optional, Product ID reference", | |
"x-label": { | |
"default": "TrendingNowInline ProductID" | |
}, | |
"type": "string" | |
}, | |
"c_TrendingNowInlineURL": { | |
"description": "Optional", | |
"format": "html", | |
"x-label": { | |
"default": "TrendingNowInlineURL" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridRectangular3Image": { | |
"description": "DW Hosted Image (360x722)", | |
"x-label": { | |
"default": "Rectangular Image for Video 3" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridRectangular3URLMP4": { | |
"description": "URL to *.mp4 or *.m4v, Video Encoding MP4 + H.264, Audio Codec AAC\n ", | |
"x-label": { | |
"default": "MP4 Rectangular URL 3" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridRectangular3URLOGG": { | |
"description": "URL to *.ogv, Video Encoding Ogg + Theora, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "OGG Rectangular URL 3" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridRectangular3URLWEBM": { | |
"description": "URL File *.webm, Video Encoding WebM + VP8, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "WEBM Rectangular URL 3" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridRectangular6Image": { | |
"description": "DW Hosted Image (360x722)", | |
"x-label": { | |
"default": "Rectangular Image for Video 6" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridRectangular6URLMP4": { | |
"description": "URL to *.mp4 or *.m4v, Video Encoding MP4 + H.264, Audio Codec AAC\n ", | |
"x-label": { | |
"default": "MP4 Rectangular URL 6" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridRectangular6URLOGG": { | |
"description": "URL to *.ogv, Video Encoding Ogg + Theora, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "OGG Rectangular URL 6" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridRectangular6URLWEBM": { | |
"description": "URL File *.webm, Video Encoding WebM + VP8, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "WEBM Rectangular URL 6" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare1Image": { | |
"description": "DW Hosted Image (360x360)", | |
"x-label": { | |
"default": "Square Image for Video 1" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare1URLMP4": { | |
"description": "URL to *.mp4 or *.m4v, Video Encoding MP4 + H.264, Audio Codec AAC\n ", | |
"x-label": { | |
"default": "MP4 Square URL 1" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare1URLOGG": { | |
"description": "URL to *.ogv, Video Encoding Ogg + Theora, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "OGG Square URL 1" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare1URLWEBM": { | |
"description": "URL File *.webm, Video Encoding WebM + VP8, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "WEBM Square URL 1" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare2Image": { | |
"description": "DW Hosted Image (360x360)", | |
"x-label": { | |
"default": "Square Image for Video 2" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare2URLMP4": { | |
"description": "URL to *.mp4 or *.m4v, Video Encoding MP4 + H.264, Audio Codec AAC\n ", | |
"x-label": { | |
"default": "MP4 Square URL 2" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare2URLOGG": { | |
"description": "URL to *.ogv, Video Encoding Ogg + Theora, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "OGG Square URL 2" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare2URLWEBM": { | |
"description": "URL File *.webm, Video Encoding WebM + VP8, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "WEBM Square URL 2" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare3Image": { | |
"description": "DW Hosted Image (360x360)", | |
"x-label": { | |
"default": "Square Image for Video 3" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare3URLMP4": { | |
"description": "URL to *.mp4 or *.m4v, Video Encoding MP4 + H.264, Audio Codec AAC\n ", | |
"x-label": { | |
"default": "MP4 Square URL 3" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare3URLOGG": { | |
"description": "URL to *.ogv, Video Encoding Ogg + Theora, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "OGG Square URL 3" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare3URLWEBM": { | |
"description": "URL File *.webm, Video Encoding WebM + VP8, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "WEBM Square URL 3" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare4Image": { | |
"description": "DW Hosted Image (360x360)", | |
"x-label": { | |
"default": "Square Image for Video 4" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare4URLMP4": { | |
"description": "URL to *.mp4 or *.m4v, Video Encoding MP4 + H.264, Audio Codec AAC\n ", | |
"x-label": { | |
"default": "MP4 Square URL 4" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare4URLOGG": { | |
"description": "URL to *.ogv, Video Encoding Ogg + Theora, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "OGG Square URL 4" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare4URLWEBM": { | |
"description": "URL File *.webm, Video Encoding WebM + VP8, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "WEBM Square URL 4" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare5Image": { | |
"description": "DW Hosted Image (360x360)", | |
"x-label": { | |
"default": "Square Image for Video 5" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare5URLMP4": { | |
"description": "URL to *.mp4 or *.m4v, Video Encoding MP4 + H.264, Audio Codec AAC\n ", | |
"x-label": { | |
"default": "MP4 Square URL 5" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare5URLOGG": { | |
"description": "URL to *.ogv, Video Encoding Ogg + Theora, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "OGG Square URL 5" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare5URLWEBM": { | |
"description": "URL File *.webm, Video Encoding WebM + VP8, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "WEBM Square URL 5" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare6Image": { | |
"description": "DW Hosted Image (360x360)", | |
"x-label": { | |
"default": "Square Image for Video 6" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare6URLMP4": { | |
"description": "URL to *.mp4 or *.m4v, Video Encoding MP4 + H.264, Audio Codec AAC\n ", | |
"x-label": { | |
"default": "MP4 Square URL 6" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare6URLOGG": { | |
"description": "URL to *.ogv, Video Encoding Ogg + Theora, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "OGG Square URL 6" | |
}, | |
"type": "string" | |
}, | |
"c_VideoGridSquare6URLWEBM": { | |
"description": "URL File *.webm, Video Encoding WebM + VP8, Audio Codec Vorbis\n ", | |
"x-label": { | |
"default": "WEBM Square URL 6" | |
}, | |
"type": "string" | |
}, | |
"c_Year": { | |
"x-label": { | |
"default": "Year" | |
}, | |
"type": "string" | |
}, | |
"c_YoutubePlayerCopy": { | |
"format": "text", | |
"x-label": { | |
"default": "Player Copy" | |
}, | |
"type": "string" | |
}, | |
"c_YoutubePlayerHeadline": { | |
"format": "text", | |
"x-label": { | |
"default": "Player Headline" | |
}, | |
"type": "string" | |
}, | |
"c_YoutubePlaylistID": { | |
"description": "youtube playlist ID", | |
"format": "text", | |
"x-label": { | |
"default": "Playlist ID" | |
}, | |
"type": "string" | |
}, | |
"c_YoutubeVideoID": { | |
"description": "youtube video ID", | |
"format": "text", | |
"x-label": { | |
"default": "Video ID" | |
}, | |
"type": "string" | |
}, | |
"c_align-text-1": { | |
"description": "Determine the Text Alignment. Default value is center, if nothing else specified.", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Alignment Of Text 1" | |
}, | |
"type": "string" | |
}, | |
"c_align-text-2": { | |
"description": "Determine the Text Alignment. Default value is center, if nothing else specified.", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Alignment Of Text 2" | |
}, | |
"type": "string" | |
}, | |
"c_align-text-3": { | |
"description": "Determine the Text Alignment. Default value is center, if nothing else specified.", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Alignment Of Text 3" | |
}, | |
"type": "string" | |
}, | |
"c_align-text-4": { | |
"description": "Determine the Text Alignment. Default value is center, if nothing else specified.", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Alignment Of Text 4" | |
}, | |
"type": "string" | |
}, | |
"c_align-text-5": { | |
"description": "Determine the Text Alignment. Default value is center, if nothing else specified.", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Alignment Of Text 5" | |
}, | |
"type": "string" | |
}, | |
"c_align-text-6": { | |
"description": "Determine the Text Alignment. Default value is center, if nothing else specified.", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Alignment Of Text 6" | |
}, | |
"type": "string" | |
}, | |
"c_assetPadding": { | |
"description": "Padding size between content assets in pixels.", | |
"format": "int32", | |
"x-label": { | |
"default": "Asset Padding" | |
}, | |
"type": "integer" | |
}, | |
"c_autoplay": { | |
"description": "Autoplay first video when Video Carousel is first loaded (Only works on desktop)", | |
"x-label": { | |
"default": "Autoplay First Video" | |
}, | |
"type": "boolean" | |
}, | |
"c_background-color": { | |
"description": "Six character hexadecimal color code.", | |
"x-label": { | |
"default": "Background Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_background-color-mobile": { | |
"description": "Six character hexadecimal color code for mobile. Must set overlay-content-text-mobile to false to show.", | |
"x-label": { | |
"default": "Background Color (Mobile)" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_background-image": { | |
"x-label": { | |
"default": "Background image" | |
}, | |
"type": "string" | |
}, | |
"c_banner-color-options": { | |
"description": "Color options for use with global promo banner.", | |
"enum": [ | |
"light-gray-black", | |
"dark-gray-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Light Gray Background with Black Text" | |
}, | |
{ | |
"default": "Dark Gray Background with White Text" | |
} | |
], | |
"x-label": { | |
"default": "Global Promo Banner Color Options" | |
}, | |
"type": "string" | |
}, | |
"c_body": { | |
"format": "html", | |
"x-label": { | |
"default": "Body" | |
}, | |
"type": "string" | |
}, | |
"c_carousel-images": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Carousel Images List" | |
}, | |
"type": "array" | |
}, | |
"c_carouselInterval": { | |
"format": "int32", | |
"x-label": { | |
"default": "Carousel Interval (seconds)" | |
}, | |
"minimum": 1.0, | |
"type": "integer" | |
}, | |
"c_carouselType": { | |
"enum": [ | |
"default", | |
"orderConfirmation", | |
"orderHistoryCarousel", | |
"addToBagModal", | |
"cartRecommendationsCarousel" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Default" | |
}, | |
{ | |
"default": "Order Confirmation" | |
}, | |
{ | |
"default": "Order History" | |
}, | |
{ | |
"default": "Add To Bag Modal" | |
}, | |
{ | |
"default": "Cart Recommendations" | |
} | |
], | |
"x-label": { | |
"default": "Carousel Type" | |
}, | |
"type": "string" | |
}, | |
"c_catchAllBackgroundImageAnchor": { | |
"enum": [ | |
"left", | |
"right", | |
"center" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Right" | |
}, | |
{ | |
"default": "Center" | |
} | |
], | |
"x-label": { | |
"default": "Catch All Background Image Anchor" | |
}, | |
"type": "string" | |
}, | |
"c_catchAllMainContainerStyle": { | |
"enum": [ | |
"light-version", | |
"dark-version" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Light Version" | |
}, | |
{ | |
"default": "Dark Version" | |
} | |
], | |
"x-label": { | |
"default": "Catch All Main Container Style" | |
}, | |
"type": "string" | |
}, | |
"c_catchAllRegionsListStyle": { | |
"enum": [ | |
"regions-left-anchor", | |
"regions-right-anchor", | |
"regions-center-anchor" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Regions Left Anchor" | |
}, | |
{ | |
"default": "Regions Right Anchor" | |
}, | |
{ | |
"default": "Regions Center Anchor" | |
} | |
], | |
"x-label": { | |
"default": "Catch All Regions List Style" | |
}, | |
"type": "string" | |
}, | |
"c_content-arrangement": { | |
"description": "Position Content within its content block", | |
"enum": [ | |
"left", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Content Arrangement" | |
}, | |
"type": "string" | |
}, | |
"c_content-position-horizontal": { | |
"description": "Where in the content asset should the text content sit?\r\nOptions are: Left, Center, Right", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Content Position Horizontal" | |
}, | |
"type": "string" | |
}, | |
"c_content-position-horizontal-mobile": { | |
"description": "Where in the content asset should the text content sit on mobile?\r\nOptions are: Left, Center, Right", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Content Position Horizontal (Mobile)" | |
}, | |
"type": "string" | |
}, | |
"c_content-position-vertical": { | |
"description": "Where in the content asset should the text content sit?\r\nOptions are: Top, Middle, Bottom", | |
"enum": [ | |
"top", | |
"middle", | |
"bottom" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Top" | |
}, | |
{ | |
"default": "Middle" | |
}, | |
{ | |
"default": "Bottom" | |
} | |
], | |
"x-label": { | |
"default": "Content Position Vertical" | |
}, | |
"type": "string" | |
}, | |
"c_content-position-vertical-mobile": { | |
"description": "Where in the content asset should the text content sit on mobile?\r\nOptions are: Top, Middle, Bottom", | |
"enum": [ | |
"top", | |
"middle", | |
"bottom" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Top" | |
}, | |
{ | |
"default": "Middle" | |
}, | |
{ | |
"default": "Bottom" | |
} | |
], | |
"x-label": { | |
"default": "Content Position Vertical (Mobile)" | |
}, | |
"type": "string" | |
}, | |
"c_content-text-alignment": { | |
"description": "How is the text horizontally aligned within its boundaries?\r\nOptions are: Left, Center, Right", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Content Text Alignment" | |
}, | |
"type": "string" | |
}, | |
"c_content-text-alignment-mobile": { | |
"description": "How is the text horizontally aligned within its boundaries on mobile?\r\nOptions are: Left, Center, Right", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Content Text Alignment (Mobile)" | |
}, | |
"type": "string" | |
}, | |
"c_copy-text": { | |
"description": "Copy Text", | |
"format": "text", | |
"x-label": { | |
"default": "Copy Text" | |
}, | |
"type": "string" | |
}, | |
"c_copy-text-1": { | |
"format": "text", | |
"x-label": { | |
"default": "Copy Text 1" | |
}, | |
"type": "string" | |
}, | |
"c_copy-text-1-mobile": { | |
"description": "Copy Text (Mobile)", | |
"format": "text", | |
"x-label": { | |
"default": "Copy Text (Mobile)" | |
}, | |
"type": "string" | |
}, | |
"c_copy-text-2": { | |
"format": "text", | |
"x-label": { | |
"default": "Copy Text 2" | |
}, | |
"type": "string" | |
}, | |
"c_copy-text-3": { | |
"format": "text", | |
"x-label": { | |
"default": "Copy Text 3" | |
}, | |
"type": "string" | |
}, | |
"c_copy-text-4": { | |
"format": "text", | |
"x-label": { | |
"default": "Copy Text 4" | |
}, | |
"type": "string" | |
}, | |
"c_copy-text-5": { | |
"format": "text", | |
"x-label": { | |
"default": "Copy Text 5" | |
}, | |
"type": "string" | |
}, | |
"c_copy-text-6": { | |
"format": "text", | |
"x-label": { | |
"default": "Copy Text 6" | |
}, | |
"type": "string" | |
}, | |
"c_copy-text-mobile": { | |
"description": "Copy Text (Mobile)", | |
"format": "text", | |
"x-label": { | |
"default": "Copy Text (Mobile)" | |
}, | |
"type": "string" | |
}, | |
"c_cta-markup-1": { | |
"description": "CTA additional value to handle the HTML content", | |
"format": "html", | |
"x-label": { | |
"default": "CTA Additional Markup 1" | |
}, | |
"type": "string" | |
}, | |
"c_cta-markup-2": { | |
"description": "CTA additional value to handle the HTML content", | |
"format": "html", | |
"x-label": { | |
"default": "CTA Additional Markup 2" | |
}, | |
"type": "string" | |
}, | |
"c_cta-markup-3": { | |
"description": "CTA additional value to handle the HTML content", | |
"format": "html", | |
"x-label": { | |
"default": "CTA Additional Markup 3" | |
}, | |
"type": "string" | |
}, | |
"c_cta-markup-4": { | |
"description": "CTA additional value to handle the HTML content", | |
"format": "html", | |
"x-label": { | |
"default": "CTA Additional Markup 4" | |
}, | |
"type": "string" | |
}, | |
"c_cta-markup-5": { | |
"description": "CTA additional value to handle the HTML content", | |
"format": "html", | |
"x-label": { | |
"default": "CTA Additional Markup 5" | |
}, | |
"type": "string" | |
}, | |
"c_cta-markup-6": { | |
"description": "CTA additional value to handle the HTML content", | |
"format": "html", | |
"x-label": { | |
"default": "CTA Additional Markup 6" | |
}, | |
"type": "string" | |
}, | |
"c_cta-markup-7": { | |
"description": "CTA additional value to handle the HTML content", | |
"format": "html", | |
"x-label": { | |
"default": "CTA Additional Markup 7" | |
}, | |
"type": "string" | |
}, | |
"c_cta-markup-8": { | |
"description": "CTA additional value to handle the HTML content", | |
"format": "html", | |
"x-label": { | |
"default": "CTA Additional Markup 8" | |
}, | |
"type": "string" | |
}, | |
"c_cta-newtab-1": { | |
"description": "Set to true to open the link in a new tab", | |
"x-label": { | |
"default": "CTA New Tab 1" | |
}, | |
"type": "boolean" | |
}, | |
"c_cta-newtab-2": { | |
"description": "Set to true to open the link in a new tab", | |
"x-label": { | |
"default": "CTA New Tab 2" | |
}, | |
"type": "boolean" | |
}, | |
"c_cta-newtab-3": { | |
"description": "Set to true to open the link in a new tab", | |
"x-label": { | |
"default": "CTA New Tab 3" | |
}, | |
"type": "boolean" | |
}, | |
"c_cta-newtab-4": { | |
"description": "Set to true to open the link in a new tab", | |
"x-label": { | |
"default": "CTA New Tab 4" | |
}, | |
"type": "boolean" | |
}, | |
"c_cta-newtab-5": { | |
"description": "Set to true to open the link in a new tab", | |
"x-label": { | |
"default": "CTA New Tab 5" | |
}, | |
"type": "boolean" | |
}, | |
"c_cta-newtab-6": { | |
"description": "Set to true to open the link in a new tab", | |
"x-label": { | |
"default": "CTA New Tab 6" | |
}, | |
"type": "boolean" | |
}, | |
"c_cta-newtab-7": { | |
"description": "Set to true to open the link in a new tab", | |
"x-label": { | |
"default": "CTA New Tab 7" | |
}, | |
"type": "boolean" | |
}, | |
"c_cta-newtab-8": { | |
"description": "Set to true to open the link in a new tab", | |
"x-label": { | |
"default": "CTA New Tab 8" | |
}, | |
"type": "boolean" | |
}, | |
"c_cta-params-1": { | |
"description": "String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 1" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-1-localized": { | |
"description": "Localized String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 1 Localized" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-2": { | |
"description": "String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 2" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-2-localized": { | |
"description": "Localized String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 2 Localized" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-3": { | |
"description": "String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 3" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-3-localized": { | |
"description": "Localized String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 3 Localized" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-4": { | |
"description": "String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 4" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-4-localized": { | |
"description": "Localized String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 4 Localized" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-5": { | |
"description": "String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 5" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-5-localized": { | |
"description": "Localized String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 5 Localized" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-6": { | |
"description": "String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 6" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-6-localized": { | |
"description": "Localized String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 6 Localized" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-7": { | |
"description": "String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 7" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-7-localized": { | |
"description": "Localized String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 7 Localized" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-8": { | |
"description": "String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 8" | |
}, | |
"type": "string" | |
}, | |
"c_cta-params-8-localized": { | |
"description": "Localized String of URL parameters to append to the URL", | |
"x-label": { | |
"default": "CTA Params 8 Localized" | |
}, | |
"type": "string" | |
}, | |
"c_cta-position": { | |
"description": "Select the position of the CTA`s", | |
"enum": [ | |
"next-to", | |
"beneath-left", | |
"beneath-center", | |
"beneath-right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Next to text" | |
}, | |
{ | |
"default": "Beneath Left" | |
}, | |
{ | |
"default": "Beneath Center" | |
}, | |
{ | |
"default": "Beneath Right" | |
} | |
], | |
"x-label": { | |
"default": "CTA Position" | |
}, | |
"type": "string" | |
}, | |
"c_cta-style-1": { | |
"description": "Button style", | |
"enum": [ | |
"primary", | |
"secondary", | |
"primary-black", | |
"primary-white", | |
"outline-primary", | |
"outline-black", | |
"outline-white", | |
"link-black", | |
"link-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Primary - Gold Background / Light Gold Hover" | |
}, | |
{ | |
"default": "Secondary - Black Background / White Hover" | |
}, | |
{ | |
"default": "Solid - Black / Light Black" | |
}, | |
{ | |
"default": "Solid - White / Light White" | |
}, | |
{ | |
"default": "Outline - Grey" | |
}, | |
{ | |
"default": "Outline - Black" | |
}, | |
{ | |
"default": "Outline - White" | |
}, | |
{ | |
"default": "Underline Text - Black" | |
}, | |
{ | |
"default": "Underline Text - White" | |
} | |
], | |
"x-label": { | |
"default": "CTA Style 1" | |
}, | |
"type": "string" | |
}, | |
"c_cta-style-2": { | |
"description": "Button style", | |
"enum": [ | |
"primary", | |
"secondary", | |
"primary-black", | |
"primary-white", | |
"outline-primary", | |
"outline-black", | |
"outline-white", | |
"link-black", | |
"link-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Primary - Gold Background / Light Gold Hover" | |
}, | |
{ | |
"default": "Secondary - Black Background / White Hover" | |
}, | |
{ | |
"default": "Solid - Black / Light Black" | |
}, | |
{ | |
"default": "Solid - White / Light White" | |
}, | |
{ | |
"default": "Outline - Grey" | |
}, | |
{ | |
"default": "Outline - Black" | |
}, | |
{ | |
"default": "Outline - White" | |
}, | |
{ | |
"default": "Underline Text - Black" | |
}, | |
{ | |
"default": "Underline Text - White" | |
} | |
], | |
"x-label": { | |
"default": "CTA Style 2" | |
}, | |
"type": "string" | |
}, | |
"c_cta-style-3": { | |
"description": "Button style", | |
"enum": [ | |
"primary", | |
"secondary", | |
"primary-black", | |
"primary-white", | |
"outline-primary", | |
"outline-black", | |
"outline-white", | |
"link-black", | |
"link-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Primary - Gold Background / Light Gold Hover" | |
}, | |
{ | |
"default": "Secondary - Black Background / White Hover" | |
}, | |
{ | |
"default": "Solid - Black / Light Black" | |
}, | |
{ | |
"default": "Solid - White / Light White" | |
}, | |
{ | |
"default": "Outline - Grey" | |
}, | |
{ | |
"default": "Outline - Black" | |
}, | |
{ | |
"default": "Outline - White" | |
}, | |
{ | |
"default": "Underline Text - Black" | |
}, | |
{ | |
"default": "Underline Text - White" | |
} | |
], | |
"x-label": { | |
"default": "CTA Style 3" | |
}, | |
"type": "string" | |
}, | |
"c_cta-style-4": { | |
"description": "Button style", | |
"enum": [ | |
"primary", | |
"secondary", | |
"primary-black", | |
"primary-white", | |
"outline-primary", | |
"outline-black", | |
"outline-white", | |
"link-black", | |
"link-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Primary - Gold Background / Light Gold Hover" | |
}, | |
{ | |
"default": "Secondary - Black Background / White Hover" | |
}, | |
{ | |
"default": "Solid - Black / Light Black" | |
}, | |
{ | |
"default": "Solid - White / Light White" | |
}, | |
{ | |
"default": "Outline - Grey" | |
}, | |
{ | |
"default": "Outline - Black" | |
}, | |
{ | |
"default": "Outline - White" | |
}, | |
{ | |
"default": "Underline Text - Black" | |
}, | |
{ | |
"default": "Underline Text - White" | |
} | |
], | |
"x-label": { | |
"default": "CTA Style 4" | |
}, | |
"type": "string" | |
}, | |
"c_cta-style-5": { | |
"description": "Button style", | |
"enum": [ | |
"primary", | |
"secondary", | |
"primary-black", | |
"primary-white", | |
"outline-primary", | |
"outline-black", | |
"outline-white", | |
"link-black", | |
"link-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Primary - Gold Background / Light Gold Hover" | |
}, | |
{ | |
"default": "Secondary - Black Background / White Hover" | |
}, | |
{ | |
"default": "Solid - Black / Light Black" | |
}, | |
{ | |
"default": "Solid - White / Light White" | |
}, | |
{ | |
"default": "Outline - Grey" | |
}, | |
{ | |
"default": "Outline - Black" | |
}, | |
{ | |
"default": "Outline - White" | |
}, | |
{ | |
"default": "Underline Text - Black" | |
}, | |
{ | |
"default": "Underline Text - White" | |
} | |
], | |
"x-label": { | |
"default": "CTA Style 5" | |
}, | |
"type": "string" | |
}, | |
"c_cta-style-6": { | |
"description": "Button style", | |
"enum": [ | |
"primary", | |
"secondary", | |
"primary-black", | |
"primary-white", | |
"outline-primary", | |
"outline-black", | |
"outline-white", | |
"link-black", | |
"link-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Primary - Gold Background / Light Gold Hover" | |
}, | |
{ | |
"default": "Secondary - Black Background / White Hover" | |
}, | |
{ | |
"default": "Solid - Black / Light Black" | |
}, | |
{ | |
"default": "Solid - White / Light White" | |
}, | |
{ | |
"default": "Outline - Grey" | |
}, | |
{ | |
"default": "Outline - Black" | |
}, | |
{ | |
"default": "Outline - White" | |
}, | |
{ | |
"default": "Underline Text - Black" | |
}, | |
{ | |
"default": "Underline Text - White" | |
} | |
], | |
"x-label": { | |
"default": "CTA Style 6" | |
}, | |
"type": "string" | |
}, | |
"c_cta-style-7": { | |
"description": "Button style", | |
"enum": [ | |
"primary", | |
"secondary", | |
"primary-black", | |
"primary-white", | |
"outline-primary", | |
"outline-black", | |
"outline-white", | |
"link-black", | |
"link-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Primary - Gold Background / Light Gold Hover" | |
}, | |
{ | |
"default": "Secondary - Black Background / White Hover" | |
}, | |
{ | |
"default": "Solid - Black / Light Black" | |
}, | |
{ | |
"default": "Solid - White / Light White" | |
}, | |
{ | |
"default": "Outline - Grey" | |
}, | |
{ | |
"default": "Outline - Black" | |
}, | |
{ | |
"default": "Outline - White" | |
}, | |
{ | |
"default": "Underline Text - Black" | |
}, | |
{ | |
"default": "Underline Text - White" | |
} | |
], | |
"x-label": { | |
"default": "CTA Style 7" | |
}, | |
"type": "string" | |
}, | |
"c_cta-style-8": { | |
"description": "Button style", | |
"enum": [ | |
"primary", | |
"secondary", | |
"primary-black", | |
"primary-white", | |
"outline-primary", | |
"outline-black", | |
"outline-white", | |
"link-black", | |
"link-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Primary - Gold Background / Light Gold Hover" | |
}, | |
{ | |
"default": "Secondary - Black Background / White Hover" | |
}, | |
{ | |
"default": "Solid - Black / Light Black" | |
}, | |
{ | |
"default": "Solid - White / Light White" | |
}, | |
{ | |
"default": "Outline - Grey" | |
}, | |
{ | |
"default": "Outline - Black" | |
}, | |
{ | |
"default": "Outline - White" | |
}, | |
{ | |
"default": "Underline Text - Black" | |
}, | |
{ | |
"default": "Underline Text - White" | |
} | |
], | |
"x-label": { | |
"default": "CTA Style 8" | |
}, | |
"type": "string" | |
}, | |
"c_cta-style-mobile-1": { | |
"description": "Button style", | |
"enum": [ | |
"primary", | |
"secondary", | |
"primary-black", | |
"primary-white", | |
"outline-primary", | |
"outline-black", | |
"outline-white", | |
"link-black", | |
"link-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Primary - Gold Background / Light Gold Hover" | |
}, | |
{ | |
"default": "Secondary - Black Background / White Hover" | |
}, | |
{ | |
"default": "Solid - Black / Light Black" | |
}, | |
{ | |
"default": "Solid - White / Light White" | |
}, | |
{ | |
"default": "Outline - Grey" | |
}, | |
{ | |
"default": "Outline - Black" | |
}, | |
{ | |
"default": "Outline - White" | |
}, | |
{ | |
"default": "Underline Text - Black" | |
}, | |
{ | |
"default": "Underline Text - White" | |
} | |
], | |
"x-label": { | |
"default": "CTA Style Mobile 1" | |
}, | |
"type": "string" | |
}, | |
"c_cta-style-mobile-2": { | |
"description": "Button style", | |
"enum": [ | |
"primary", | |
"secondary", | |
"primary-black", | |
"primary-white", | |
"outline-primary", | |
"outline-black", | |
"outline-white", | |
"link-black", | |
"link-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Primary - Gold Background / Light Gold Hover" | |
}, | |
{ | |
"default": "Secondary - Black Background / White Hover" | |
}, | |
{ | |
"default": "Solid - Black / Light Black" | |
}, | |
{ | |
"default": "Solid - White / Light White" | |
}, | |
{ | |
"default": "Outline - Grey" | |
}, | |
{ | |
"default": "Outline - Black" | |
}, | |
{ | |
"default": "Outline - White" | |
}, | |
{ | |
"default": "Underline Text - Black" | |
}, | |
{ | |
"default": "Underline Text - White" | |
} | |
], | |
"x-label": { | |
"default": "CTA Style Mobile 2" | |
}, | |
"type": "string" | |
}, | |
"c_cta-style-mobile-3": { | |
"description": "Button style", | |
"enum": [ | |
"primary", | |
"secondary", | |
"primary-black", | |
"primary-white", | |
"outline-primary", | |
"outline-black", | |
"outline-white", | |
"link-black", | |
"link-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Primary - Gold Background / Light Gold Hover" | |
}, | |
{ | |
"default": "Secondary - Black Background / White Hover" | |
}, | |
{ | |
"default": "Solid - Black / Light Black" | |
}, | |
{ | |
"default": "Solid - White / Light White" | |
}, | |
{ | |
"default": "Outline - Grey" | |
}, | |
{ | |
"default": "Outline - Black" | |
}, | |
{ | |
"default": "Outline - White" | |
}, | |
{ | |
"default": "Underline Text - Black" | |
}, | |
{ | |
"default": "Underline Text - White" | |
} | |
], | |
"x-label": { | |
"default": "CTA Style Mobile 3" | |
}, | |
"type": "string" | |
}, | |
"c_cta-style-mobile-4": { | |
"description": "Button style", | |
"enum": [ | |
"primary", | |
"secondary", | |
"primary-black", | |
"primary-white", | |
"outline-primary", | |
"outline-black", | |
"outline-white", | |
"link-black", | |
"link-white" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Primary - Gold Background / Light Gold Hover" | |
}, | |
{ | |
"default": "Secondary - Black Background / White Hover" | |
}, | |
{ | |
"default": "Solid - Black / Light Black" | |
}, | |
{ | |
"default": "Solid - White / Light White" | |
}, | |
{ | |
"default": "Outline - Grey" | |
}, | |
{ | |
"default": "Outline - Black" | |
}, | |
{ | |
"default": "Outline - White" | |
}, | |
{ | |
"default": "Underline Text - Black" | |
}, | |
{ | |
"default": "Underline Text - White" | |
} | |
], | |
"x-label": { | |
"default": "CTA Style Mobile 4" | |
}, | |
"type": "string" | |
}, | |
"c_cta-text-1": { | |
"description": "Text for call to action (CTA) link", | |
"x-label": { | |
"default": "CTA Text 1" | |
}, | |
"type": "string" | |
}, | |
"c_cta-text-2": { | |
"description": "Text for call to action (CTA) link", | |
"x-label": { | |
"default": "CTA Text 2" | |
}, | |
"type": "string" | |
}, | |
"c_cta-text-3": { | |
"description": "Text for call to action (CTA) link", | |
"x-label": { | |
"default": "CTA Text 3" | |
}, | |
"type": "string" | |
}, | |
"c_cta-text-4": { | |
"description": "Text for call to action (CTA) link", | |
"x-label": { | |
"default": "CTA Text 4" | |
}, | |
"type": "string" | |
}, | |
"c_cta-text-5": { | |
"description": "Text for call to action (CTA) link", | |
"x-label": { | |
"default": "CTA Text 5" | |
}, | |
"type": "string" | |
}, | |
"c_cta-text-6": { | |
"description": "Text for call to action (CTA) link", | |
"x-label": { | |
"default": "CTA Text 6" | |
}, | |
"type": "string" | |
}, | |
"c_cta-text-7": { | |
"description": "Text for call to action (CTA) link", | |
"x-label": { | |
"default": "CTA Text 7" | |
}, | |
"type": "string" | |
}, | |
"c_cta-text-8": { | |
"description": "Text for call to action (CTA) link", | |
"x-label": { | |
"default": "CTA Text 8" | |
}, | |
"type": "string" | |
}, | |
"c_cta-type-1": { | |
"description": "Link type can be:\r\nProduct\r\nCategory\r\nContent\r\nAbsolute", | |
"enum": [ | |
"0", | |
"1", | |
"2", | |
"3" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Product" | |
}, | |
{ | |
"default": "Category" | |
}, | |
{ | |
"default": "Content" | |
}, | |
{ | |
"default": "Absolute" | |
} | |
], | |
"x-label": { | |
"default": "CTA Type 1" | |
}, | |
"type": "string" | |
}, | |
"c_cta-type-2": { | |
"description": "Link type can be:\r\nProduct\r\nCategory\r\nContent\r\nAbsolute", | |
"enum": [ | |
"0", | |
"1", | |
"2", | |
"3" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Product" | |
}, | |
{ | |
"default": "Category" | |
}, | |
{ | |
"default": "Content" | |
}, | |
{ | |
"default": "Absolute" | |
} | |
], | |
"x-label": { | |
"default": "CTA Type 2" | |
}, | |
"type": "string" | |
}, | |
"c_cta-type-3": { | |
"description": "Link type can be:\r\nProduct\r\nCategory\r\nContent\r\nAbsolute", | |
"enum": [ | |
"0", | |
"1", | |
"2", | |
"3" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Product" | |
}, | |
{ | |
"default": "Category" | |
}, | |
{ | |
"default": "Content" | |
}, | |
{ | |
"default": "Absolute" | |
} | |
], | |
"x-label": { | |
"default": "CTA Type 3" | |
}, | |
"type": "string" | |
}, | |
"c_cta-type-4": { | |
"description": "Link type can be:\r\nProduct\r\nCategory\r\nContent\r\nAbsolute", | |
"enum": [ | |
"0", | |
"1", | |
"2", | |
"3" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Product" | |
}, | |
{ | |
"default": "Category" | |
}, | |
{ | |
"default": "Content" | |
}, | |
{ | |
"default": "Absolute" | |
} | |
], | |
"x-label": { | |
"default": "CTA Type 4" | |
}, | |
"type": "string" | |
}, | |
"c_cta-type-5": { | |
"description": "Link type can be:\r\nProduct\r\nCategory\r\nContent\r\nAbsolute", | |
"enum": [ | |
"0", | |
"1", | |
"2", | |
"3" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Product" | |
}, | |
{ | |
"default": "Category" | |
}, | |
{ | |
"default": "Content" | |
}, | |
{ | |
"default": "Absolute" | |
} | |
], | |
"x-label": { | |
"default": "CTA Type 5" | |
}, | |
"type": "string" | |
}, | |
"c_cta-type-6": { | |
"description": "Link type can be:\r\nProduct\r\nCategory\r\nContent\r\nAbsolute", | |
"enum": [ | |
"0", | |
"1", | |
"2", | |
"3" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Product" | |
}, | |
{ | |
"default": "Category" | |
}, | |
{ | |
"default": "Content" | |
}, | |
{ | |
"default": "Absolute" | |
} | |
], | |
"x-label": { | |
"default": "CTA Type 6" | |
}, | |
"type": "string" | |
}, | |
"c_cta-type-7": { | |
"description": "Link type can be:\r\nProduct\r\nCategory\r\nContent\r\nAbsolute", | |
"enum": [ | |
"0", | |
"1", | |
"2", | |
"3" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Product" | |
}, | |
{ | |
"default": "Category" | |
}, | |
{ | |
"default": "Content" | |
}, | |
{ | |
"default": "Absolute" | |
} | |
], | |
"x-label": { | |
"default": "CTA Type 7" | |
}, | |
"type": "string" | |
}, | |
"c_cta-type-8": { | |
"description": "Link type can be:\r\nProduct\r\nCategory\r\nContent\r\nAbsolute", | |
"enum": [ | |
"0", | |
"1", | |
"2", | |
"3" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Product" | |
}, | |
{ | |
"default": "Category" | |
}, | |
{ | |
"default": "Content" | |
}, | |
{ | |
"default": "Absolute" | |
} | |
], | |
"x-label": { | |
"default": "CTA Type 8" | |
}, | |
"type": "string" | |
}, | |
"c_cta-value-1": { | |
"description": "CTA Value to match the type:\r\nProduct ID\r\nCategory ID\r\nContent ID\r\nURL String", | |
"x-label": { | |
"default": "CTA Value 1" | |
}, | |
"type": "string" | |
}, | |
"c_cta-value-2": { | |
"description": "CTA Value to match the type:\r\nProduct ID\r\nCategory ID\r\nContent ID\r\nURL String", | |
"x-label": { | |
"default": "CTA Value 2" | |
}, | |
"type": "string" | |
}, | |
"c_cta-value-3": { | |
"description": "CTA Value to match the type:\r\nProduct ID\r\nCategory ID\r\nContent ID\r\nURL String", | |
"x-label": { | |
"default": "CTA Value 3" | |
}, | |
"type": "string" | |
}, | |
"c_cta-value-4": { | |
"description": "CTA Value to match the type:\r\nProduct ID\r\nCategory ID\r\nContent ID\r\nURL String", | |
"x-label": { | |
"default": "CTA Value 4" | |
}, | |
"type": "string" | |
}, | |
"c_cta-value-5": { | |
"description": "CTA Value to match the type:\r\nProduct ID\r\nCategory ID\r\nContent ID\r\nURL String", | |
"x-label": { | |
"default": "CTA Value 5" | |
}, | |
"type": "string" | |
}, | |
"c_cta-value-6": { | |
"description": "CTA Value to match the type:\r\nProduct ID\r\nCategory ID\r\nContent ID\r\nURL String", | |
"x-label": { | |
"default": "CTA Value 6" | |
}, | |
"type": "string" | |
}, | |
"c_cta-value-7": { | |
"description": "CTA Value to match the type:\r\nProduct ID\r\nCategory ID\r\nContent ID\r\nURL String", | |
"x-label": { | |
"default": "CTA Value 7" | |
}, | |
"type": "string" | |
}, | |
"c_cta-value-8": { | |
"description": "CTA Value to match the type:\r\nProduct ID\r\nCategory ID\r\nContent ID\r\nURL String", | |
"x-label": { | |
"default": "CTA Value 8" | |
}, | |
"type": "string" | |
}, | |
"c_customCSSFile": { | |
"description": "Use this attribute to apply custom styles for this content asset.", | |
"x-label": { | |
"default": "Custom CSS File" | |
}, | |
"type": "string" | |
}, | |
"c_details-text": { | |
"format": "text", | |
"x-label": { | |
"default": "Details text" | |
}, | |
"type": "string" | |
}, | |
"c_disable-eight-ctas-on-mobile": { | |
"x-label": { | |
"default": "Disable Eight Ctas on mobile/tablet" | |
}, | |
"type": "boolean" | |
}, | |
"c_disableCarouselAutoRotation": { | |
"x-label": { | |
"default": "Disable Carousel Auto Rotation" | |
}, | |
"type": "boolean" | |
}, | |
"c_display-main-badge": { | |
"x-label": { | |
"default": "Show Main Product Badge" | |
}, | |
"type": "boolean" | |
}, | |
"c_display-oos-badge": { | |
"x-label": { | |
"default": "Show OOS Product Badge" | |
}, | |
"type": "boolean" | |
}, | |
"c_display-percentage-badge": { | |
"x-label": { | |
"default": "Show Precentage Product Badge" | |
}, | |
"type": "boolean" | |
}, | |
"c_display-promo-message": { | |
"x-label": { | |
"default": "Show Promotion Callout message" | |
}, | |
"type": "boolean" | |
}, | |
"c_enable-tile-padding": { | |
"x-label": { | |
"default": "Enable Tile Padding" | |
}, | |
"type": "boolean" | |
}, | |
"c_followFacebookLink": { | |
"description": "facebook link in Follow Puma content asset", | |
"x-label": { | |
"default": "Follow Puma Facebook Link" | |
}, | |
"type": "string" | |
}, | |
"c_followImage": { | |
"description": "image for follow puma content asset", | |
"x-label": { | |
"default": "Follow Puma Image" | |
}, | |
"type": "string" | |
}, | |
"c_followTitle": { | |
"description": "title text for follow puma content asset", | |
"x-label": { | |
"default": "Follow Puma Title" | |
}, | |
"type": "string" | |
}, | |
"c_followTwitterLink": { | |
"description": "twitter content asset link found in Follow Puma Content assets\n ", | |
"x-label": { | |
"default": "Follow Puma Twitter Link" | |
}, | |
"type": "string" | |
}, | |
"c_font-size": { | |
"enum": [ | |
"1.125rem", | |
"1rem", | |
"0.875rem", | |
"0.75rem" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "18px" | |
}, | |
{ | |
"default": "16px" | |
}, | |
{ | |
"default": "14px" | |
}, | |
{ | |
"default": "12px" | |
} | |
], | |
"x-label": { | |
"default": "Font Size" | |
}, | |
"type": "string" | |
}, | |
"c_footnote-text": { | |
"description": "Footnote Text", | |
"format": "text", | |
"x-label": { | |
"default": "Footnote Text" | |
}, | |
"type": "string" | |
}, | |
"c_footnote-text-mobile": { | |
"description": "Footnote Text (Mobile)", | |
"format": "text", | |
"x-label": { | |
"default": "Footnote Text (Mobile)" | |
}, | |
"type": "string" | |
}, | |
"c_gccContentImageUrl": { | |
"description": "add image url as a reference for T.com linguists", | |
"x-label": { | |
"default": "GlobalLink image url" | |
}, | |
"type": "string" | |
}, | |
"c_gccLastSubmitted": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Sent for translation on" | |
}, | |
"type": "string" | |
}, | |
"c_gccLastTranslated": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Translations imported on" | |
}, | |
"type": "string" | |
}, | |
"c_gccStatus": { | |
"description": "This attribute is used by GCC.", | |
"enum": [ | |
"Ready", | |
"Sent", | |
"Imported" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Ready to Send" | |
}, | |
{ | |
"default": "In Progress" | |
}, | |
{ | |
"default": "Translated" | |
} | |
], | |
"x-label": { | |
"default": "GlobalLink Status" | |
}, | |
"type": "string" | |
}, | |
"c_gccSubmissionName": { | |
"description": "This attribute is used to store the gccSubmissionName information locale-specific.", | |
"x-label": { | |
"default": "GCC Submission Name" | |
}, | |
"type": "string" | |
}, | |
"c_header-text": { | |
"description": "Header Text", | |
"format": "text", | |
"x-label": { | |
"default": "Header Text" | |
}, | |
"type": "string" | |
}, | |
"c_header-text-1": { | |
"x-label": { | |
"default": "Header Text 1" | |
}, | |
"type": "string" | |
}, | |
"c_header-text-1-mobile": { | |
"description": "Header Text (Mobile)", | |
"format": "text", | |
"x-label": { | |
"default": "Header Text (Mobile)" | |
}, | |
"type": "string" | |
}, | |
"c_header-text-2": { | |
"x-label": { | |
"default": "Header Text 2" | |
}, | |
"type": "string" | |
}, | |
"c_header-text-3": { | |
"x-label": { | |
"default": "Header Text 3" | |
}, | |
"type": "string" | |
}, | |
"c_header-text-4": { | |
"x-label": { | |
"default": "Header Text 4" | |
}, | |
"type": "string" | |
}, | |
"c_header-text-5": { | |
"x-label": { | |
"default": "Header Text 5" | |
}, | |
"type": "string" | |
}, | |
"c_header-text-6": { | |
"x-label": { | |
"default": "Header Text 6" | |
}, | |
"type": "string" | |
}, | |
"c_header-text-mobile": { | |
"description": "Header Text (Mobile)", | |
"format": "text", | |
"x-label": { | |
"default": "Header Text (Mobile)" | |
}, | |
"type": "string" | |
}, | |
"c_hero-content-order": { | |
"description": "Determine the order of the hero content\r\nHeader\r\nCopy\r\nFootnote \r\nLogo\r\nCTAs", | |
"enum": [ | |
"lhcbf", | |
"lchbf", | |
"hcfbl" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Logo, Header, Copy, CTAs, Footnote" | |
}, | |
{ | |
"default": "Logo, Copy, Header, CTAs, Footnote" | |
}, | |
{ | |
"default": "Header, Copy, Footnote, CTAs, Logo" | |
} | |
], | |
"x-label": { | |
"default": "Hero Content Order" | |
}, | |
"type": "string" | |
}, | |
"c_hero-content-order-mobile": { | |
"description": "Determine the order of the hero content for mobile\r\nHeader\r\nCopy\r\nFootnote \r\nLogo\r\nCTAs", | |
"enum": [ | |
"lhcbf", | |
"lchbf", | |
"hcfbl" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Logo, Header, Copy, CTAs, Footnote" | |
}, | |
{ | |
"default": "Logo, Copy, Header, CTAs, Footnote" | |
}, | |
{ | |
"default": "Header, Copy, Footnote, CTAs, Logo" | |
} | |
], | |
"x-label": { | |
"default": "Hero Content Order (Mobile)" | |
}, | |
"type": "string" | |
}, | |
"c_heroContentReplaceAssetID": { | |
"x-label": { | |
"default": "Content Replace Asset ID" | |
}, | |
"type": "string" | |
}, | |
"c_heroContentReplaceDate": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Content Replace Date" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-anchor-1": { | |
"x-label": { | |
"default": "Hotspot anchor 1" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-anchor-2": { | |
"x-label": { | |
"default": "Hotspot anchor 2" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-anchor-3": { | |
"x-label": { | |
"default": "Hotspot anchor 3" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-anchor-4": { | |
"x-label": { | |
"default": "Hotspot anchor 4" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-content-align-1": { | |
"description": "Determine the Hotspot Content Alignment. Default value is center, if nothing else specified.", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Hotspot Content Align 1" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-content-align-2": { | |
"description": "Determine the Hotspot Content Alignment. Default value is center, if nothing else specified.", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Hotspot Content Align 2" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-content-align-3": { | |
"description": "Determine the Hotspot Content Alignment. Default value is center, if nothing else specified.", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Hotspot Content Align 3" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-content-align-4": { | |
"description": "Determine the Hotspot Content Alignment. Default value is center, if nothing else specified.", | |
"enum": [ | |
"left", | |
"center", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Center" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Hotspot Content Align 4" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-content-body-1": { | |
"format": "text", | |
"x-label": { | |
"default": "Hotspot Content Body 1" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-content-body-2": { | |
"format": "text", | |
"x-label": { | |
"default": "Hotspot Content Body 2" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-content-body-3": { | |
"format": "text", | |
"x-label": { | |
"default": "Hotspot Content Body 3" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-content-body-4": { | |
"format": "text", | |
"x-label": { | |
"default": "Hotspot Content Body 4" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-content-header-1": { | |
"description": "Header Content Text for this Hotspot. Will appear with Hotspot Body and Image", | |
"format": "text", | |
"x-label": { | |
"default": "Hotspot Content Header 1" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-content-header-2": { | |
"description": "Header Content Text for this Hotspot. Will appear with Hotspot Body and Image", | |
"format": "text", | |
"x-label": { | |
"default": "Hotspot Content Header 2" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-content-header-3": { | |
"description": "Header Content Text for this Hotspot. Will appear with Hotspot Body and Image", | |
"format": "text", | |
"x-label": { | |
"default": "Hotspot Content Header 3" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-content-header-4": { | |
"description": "Header Content Text for this Hotspot. Will appear with Hotspot Body and Image", | |
"format": "text", | |
"x-label": { | |
"default": "Hotspot Content Header 4" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-horizontal-1": { | |
"description": "Vertical position within the content asset to show the hotspot", | |
"format": "double", | |
"x-label": { | |
"default": "Hotspot Horizontal Position 1" | |
}, | |
"maximum": 100.0, | |
"type": "number" | |
}, | |
"c_hotspot-horizontal-2": { | |
"description": "Vertical position within the content asset to show the hotspot", | |
"format": "double", | |
"x-label": { | |
"default": "Hotspot Horizontal Position 2" | |
}, | |
"maximum": 100.0, | |
"type": "number" | |
}, | |
"c_hotspot-horizontal-3": { | |
"description": "Vertical position within the content asset to show the hotspot", | |
"format": "double", | |
"x-label": { | |
"default": "Hotspot Horizontal Position 3" | |
}, | |
"maximum": 100.0, | |
"type": "number" | |
}, | |
"c_hotspot-horizontal-4": { | |
"description": "Vertical position within the content asset to show the hotspot", | |
"format": "double", | |
"x-label": { | |
"default": "Hotspot Horizontal Position 4" | |
}, | |
"maximum": 100.0, | |
"type": "number" | |
}, | |
"c_hotspot-product-1": { | |
"description": "Product ID of product to show in the hotspot flyout", | |
"x-label": { | |
"default": "Hotspot Product 1" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-product-2": { | |
"description": "Product ID of product to show in the hotspot flyout", | |
"x-label": { | |
"default": "Hotspot Product 2" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-product-3": { | |
"description": "Product ID of product to show in the hotspot flyout", | |
"x-label": { | |
"default": "Hotspot Product 3" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-product-4": { | |
"description": "Product ID of product to show in the hotspot flyout", | |
"x-label": { | |
"default": "Hotspot Product 4" | |
}, | |
"type": "string" | |
}, | |
"c_hotspot-vertical-1": { | |
"description": "Vertical position within the content asset to show the hotspot", | |
"format": "double", | |
"x-label": { | |
"default": "Hotspot Vertical Position 1" | |
}, | |
"maximum": 100.0, | |
"type": "number" | |
}, | |
"c_hotspot-vertical-2": { | |
"description": "Vertical position within the content asset to show the hotspot", | |
"format": "double", | |
"x-label": { | |
"default": "Hotspot Vertical Position 2" | |
}, | |
"maximum": 100.0, | |
"type": "number" | |
}, | |
"c_hotspot-vertical-3": { | |
"description": "Vertical position within the content asset to show the hotspot", | |
"format": "double", | |
"x-label": { | |
"default": "Hotspot Vertical Position 3" | |
}, | |
"maximum": 100.0, | |
"type": "number" | |
}, | |
"c_hotspot-vertical-4": { | |
"description": "Vertical position within the content asset to show the hotspot", | |
"format": "double", | |
"x-label": { | |
"default": "Hotspot Vertical Position 4" | |
}, | |
"maximum": 100.0, | |
"type": "number" | |
}, | |
"c_isCarousel": { | |
"x-label": { | |
"default": "Enable Carousel" | |
}, | |
"type": "boolean" | |
}, | |
"c_kop-sub-title": { | |
"x-label": { | |
"default": "KOP Subtitle" | |
}, | |
"type": "string" | |
}, | |
"c_kop-title": { | |
"x-label": { | |
"default": "Kop Title" | |
}, | |
"type": "string" | |
}, | |
"c_kopassetid": { | |
"x-label": { | |
"default": "KOP Asset ID" | |
}, | |
"type": "string" | |
}, | |
"c_kopassetidlist": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "KOP Content Asset ID List" | |
}, | |
"type": "array" | |
}, | |
"c_kopbackgroundcolor": { | |
"description": "Six character hexadecimal color code.", | |
"x-label": { | |
"default": "Background Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_layout-position-horizontal": { | |
"enum": [ | |
"left", | |
"right" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Left" | |
}, | |
{ | |
"default": "Right" | |
} | |
], | |
"x-label": { | |
"default": "Layout Position Horizontal" | |
}, | |
"type": "string" | |
}, | |
"c_linePadding": { | |
"enum": [ | |
"1.375rem", | |
"1.125rem", | |
"0.875rem" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "22px" | |
}, | |
{ | |
"default": "18px" | |
}, | |
{ | |
"default": "14px" | |
} | |
], | |
"x-label": { | |
"default": "Line Padding" | |
}, | |
"type": "string" | |
}, | |
"c_media-disable-on-mob-tab-1": { | |
"description": "Set to true to disable media on tablet/mobile", | |
"x-label": { | |
"default": "Disable on tablet/mobile 1" | |
}, | |
"type": "boolean" | |
}, | |
"c_media-disable-on-mob-tab-2": { | |
"description": "Set to true to disable media on tablet/mobile", | |
"x-label": { | |
"default": "Disable on tablet/mobile 2" | |
}, | |
"type": "boolean" | |
}, | |
"c_media-disable-on-mob-tab-3": { | |
"description": "Set to true to disable media on tablet/mobile", | |
"x-label": { | |
"default": "Disable on tablet/mobile 3" | |
}, | |
"type": "boolean" | |
}, | |
"c_media-disable-on-mob-tab-4": { | |
"description": "Set to true to disable media on tablet/mobile", | |
"x-label": { | |
"default": "Disable on tablet/mobile 4" | |
}, | |
"type": "boolean" | |
}, | |
"c_media-disable-on-mob-tab-5": { | |
"description": "Set to true to disable media on tablet/mobile", | |
"x-label": { | |
"default": "Disable on tablet/mobile 5" | |
}, | |
"type": "boolean" | |
}, | |
"c_media-disable-on-mob-tab-6": { | |
"description": "Set to true to disable media on tablet/mobile", | |
"x-label": { | |
"default": "Disable on tablet/mobile 6" | |
}, | |
"type": "boolean" | |
}, | |
"c_media-disable-on-mob-tab-7": { | |
"description": "Set to true to disable media on tablet/mobile", | |
"x-label": { | |
"default": "Disable on tablet/mobile 7" | |
}, | |
"type": "boolean" | |
}, | |
"c_media-disable-on-mob-tab-8": { | |
"description": "Set to true to disable media on tablet/mobile", | |
"x-label": { | |
"default": "Disable on tablet/mobile 8" | |
}, | |
"type": "boolean" | |
}, | |
"c_media-image-alt-1": { | |
"description": "Alt text for Media Image 1", | |
"x-label": { | |
"default": "Media Image Alt Text 1" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-alt-2": { | |
"description": "Alt text for Media Image 1", | |
"x-label": { | |
"default": "Media Image Alt Text 2" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-alt-3": { | |
"description": "Alt text for Media Image 3", | |
"x-label": { | |
"default": "Media Image Alt Text 3" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-alt-4": { | |
"description": "Alt text for Media Image 4", | |
"x-label": { | |
"default": "Media Image Alt Text 4" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-alt-5": { | |
"description": "Alt text for Media Image 5", | |
"x-label": { | |
"default": "Media Image Alt Text 5" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-alt-6": { | |
"description": "Alt text for Media Image 6", | |
"x-label": { | |
"default": "Media Image Alt Text 6" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-alt-7": { | |
"description": "Alt text for Media Image 7", | |
"x-label": { | |
"default": "Media Image Alt Text 7" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-alt-8": { | |
"description": "Alt text for Media Image 8 (tablet)", | |
"x-label": { | |
"default": "Media Image Alt Text 8" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-pisa-1": { | |
"description": "Media Image 1 from the PISA media service", | |
"x-label": { | |
"default": "Media Image (PISA) 1" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-pisa-2": { | |
"description": "Media Image 2 from the PISA media service", | |
"x-label": { | |
"default": "Media Image (PISA) 2" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-pisa-3": { | |
"description": "Media Image 3 from the PISA media service", | |
"x-label": { | |
"default": "Media Image (PISA) 3" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-pisa-4": { | |
"description": "Media Image 4 from the PISA media service", | |
"x-label": { | |
"default": "Media Image (PISA) 4" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-pisa-5": { | |
"description": "Media Image 5 from the PISA media service", | |
"x-label": { | |
"default": "Media Image (PISA) 5" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-pisa-6": { | |
"description": "Media Image 6 from the PISA media service", | |
"x-label": { | |
"default": "Media Image (PISA) 6" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-pisa-7": { | |
"description": "Media Image 7 from the PISA media service", | |
"x-label": { | |
"default": "Media Image (PISA) 7" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-pisa-8": { | |
"description": "Media Image 8 from the PISA media service (tablet)", | |
"x-label": { | |
"default": "Media Image (PISA) 8" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-sf-1": { | |
"description": "Media Image 1 from the internal SFCC library", | |
"x-label": { | |
"default": "Media Image (SalesForce) 1" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-sf-2": { | |
"description": "Media Image 2 from the internal SFCC library", | |
"x-label": { | |
"default": "Media Image (SalesForce) 2" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-sf-3": { | |
"description": "Media Image 3 from the internal SFCC library", | |
"x-label": { | |
"default": "Media Image (SalesForce) 3" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-sf-4": { | |
"description": "Media Image 4 from the internal SFCC library", | |
"x-label": { | |
"default": "Media Image (SalesForce) 4" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-sf-5": { | |
"description": "Media Image 5 from the internal SFCC library", | |
"x-label": { | |
"default": "Media Image (SalesForce) 5" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-sf-6": { | |
"description": "Media Image 6 from the internal SFCC library", | |
"x-label": { | |
"default": "Media Image (SalesForce) 6" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-sf-7": { | |
"description": "Media Image 7 from the internal SFCC library", | |
"x-label": { | |
"default": "Media Image (SalesForce) 7" | |
}, | |
"type": "string" | |
}, | |
"c_media-image-sf-8": { | |
"description": "Media Image 8 from the internal SFCC library (tablet)", | |
"x-label": { | |
"default": "Media Image (SalesForce) 8" | |
}, | |
"type": "string" | |
}, | |
"c_media-video-1": { | |
"description": "Supports PISA video URL or YouTube video ID.\r\nURL of PISA image. MPEG-4/H.264 is preferred as it is supported in all browsers.\r\nYouTube videos will be played in an embedded player.", | |
"x-label": { | |
"default": "Media Video 1" | |
}, | |
"type": "string" | |
}, | |
"c_media-video-2": { | |
"description": "Supports PISA video URL or YouTube video ID.\r\nURL of PISA image. MPEG-4/H.264 is preferred as it is supported in all browsers.\r\nYouTube videos will be played in an embedded player.", | |
"x-label": { | |
"default": "Media Video 2" | |
}, | |
"type": "string" | |
}, | |
"c_media-video-3": { | |
"description": "Supports PISA video URL or YouTube video ID.\r\nURL of PISA image. MPEG-4/H.264 is preferred as it is supported in all browsers.\r\nYouTube videos will be played in an embedded player.", | |
"x-label": { | |
"default": "Media Video 3" | |
}, | |
"type": "string" | |
}, | |
"c_media-video-4": { | |
"description": "Supports PISA video URL or YouTube video ID.\r\nURL of PISA image. MPEG-4/H.264 is preferred as it is supported in all browsers.\r\nYouTube videos will be played in an embedded player.", | |
"x-label": { | |
"default": "Media Video 4" | |
}, | |
"type": "string" | |
}, | |
"c_media-video-5": { | |
"description": "Supports PISA video URL or YouTube video ID.\r\nURL of PISA image. MPEG-4/H.264 is preferred as it is supported in all browsers.\r\nYouTube videos will be played in an embedded player.", | |
"x-label": { | |
"default": "Media Video 5" | |
}, | |
"type": "string" | |
}, | |
"c_media-video-6": { | |
"description": "Supports PISA video URL or YouTube video ID.\r\nURL of PISA image. MPEG-4/H.264 is preferred as it is supported in all browsers.\r\nYouTube videos will be played in an embedded player.", | |
"x-label": { | |
"default": "Media Video 6" | |
}, | |
"type": "string" | |
}, | |
"c_media-video-7": { | |
"description": "Supports PISA video URL or YouTube video ID.\r\nURL of PISA image. MPEG-4/H.264 is preferred as it is supported in all browsers.\r\nYouTube videos will be played in an embedded player.", | |
"x-label": { | |
"default": "Media Video 7" | |
}, | |
"type": "string" | |
}, | |
"c_media-video-8": { | |
"description": "Supports PISA video URL or YouTube video ID.\r\nURL of PISA image. MPEG-4/H.264 is preferred as it is supported in all browsers.\r\nYouTube videos will be played in an embedded player.", | |
"x-label": { | |
"default": "Media Video 8" | |
}, | |
"type": "string" | |
}, | |
"c_media-video-options-1": { | |
"description": "Select the video options for this video", | |
"items": { | |
"enum": [ | |
"controls", | |
"autoplay", | |
"loop", | |
"muted" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Controls" | |
}, | |
{ | |
"default": "Autoplay" | |
}, | |
{ | |
"default": "Loop" | |
}, | |
{ | |
"default": "Muted" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Media Video Options 1" | |
}, | |
"type": "array" | |
}, | |
"c_media-video-options-2": { | |
"description": "Select the video options for this video", | |
"items": { | |
"enum": [ | |
"controls", | |
"autoplay", | |
"loop", | |
"muted" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Controls" | |
}, | |
{ | |
"default": "Autoplay" | |
}, | |
{ | |
"default": "Loop" | |
}, | |
{ | |
"default": "Muted" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Media Video Options 2" | |
}, | |
"type": "array" | |
}, | |
"c_media-video-options-3": { | |
"description": "Select the video options for this video", | |
"items": { | |
"enum": [ | |
"controls", | |
"autoplay", | |
"loop", | |
"muted" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Controls" | |
}, | |
{ | |
"default": "Autoplay" | |
}, | |
{ | |
"default": "Loop" | |
}, | |
{ | |
"default": "Muted" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Media Video Options 3" | |
}, | |
"type": "array" | |
}, | |
"c_media-video-options-4": { | |
"description": "Select the video options for this video", | |
"items": { | |
"enum": [ | |
"controls", | |
"autoplay", | |
"loop", | |
"muted" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Controls" | |
}, | |
{ | |
"default": "Autoplay" | |
}, | |
{ | |
"default": "Loop" | |
}, | |
{ | |
"default": "Muted" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Media Video Options 4" | |
}, | |
"type": "array" | |
}, | |
"c_media-video-options-5": { | |
"description": "Select the video options for this video", | |
"items": { | |
"enum": [ | |
"controls", | |
"autoplay", | |
"loop", | |
"muted" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Controls" | |
}, | |
{ | |
"default": "Autoplay" | |
}, | |
{ | |
"default": "Loop" | |
}, | |
{ | |
"default": "Muted" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Media Video Options 5" | |
}, | |
"type": "array" | |
}, | |
"c_media-video-options-6": { | |
"description": "Select the video options for this video", | |
"items": { | |
"enum": [ | |
"controls", | |
"autoplay", | |
"loop", | |
"muted" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Controls" | |
}, | |
{ | |
"default": "Autoplay" | |
}, | |
{ | |
"default": "Loop" | |
}, | |
{ | |
"default": "Muted" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Media Video Options 6" | |
}, | |
"type": "array" | |
}, | |
"c_media-video-options-7": { | |
"description": "Select the video options for this video", | |
"items": { | |
"enum": [ | |
"controls", | |
"autoplay", | |
"loop", | |
"muted" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Controls" | |
}, | |
{ | |
"default": "Autoplay" | |
}, | |
{ | |
"default": "Loop" | |
}, | |
{ | |
"default": "Muted" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Media Video Options 7" | |
}, | |
"type": "array" | |
}, | |
"c_media-video-options-8": { | |
"description": "Select the video options for this video", | |
"items": { | |
"enum": [ | |
"controls", | |
"autoplay", | |
"loop", | |
"muted" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Controls" | |
}, | |
{ | |
"default": "Autoplay" | |
}, | |
{ | |
"default": "Loop" | |
}, | |
{ | |
"default": "Muted" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Media Video Options 8" | |
}, | |
"type": "array" | |
}, | |
"c_media-video-pisa-1": { | |
"description": "URL of PISA image. MPEG-4/H.264 is preferred as it is supported in all browsers.", | |
"x-label": { | |
"default": "Media Video PISA 1" | |
}, | |
"type": "string" | |
}, | |
"c_menu-category-id": { | |
"description": "Parent category ID. Displays sub category links.", | |
"x-label": { | |
"default": "Menu Category ID" | |
}, | |
"type": "string" | |
}, | |
"c_omniturePageName": { | |
"x-label": { | |
"default": "Omniture Page Name" | |
}, | |
"type": "string" | |
}, | |
"c_oneLinkNoTx": { | |
"description": "OneLinkNoTx is used to exclude text from the translation process.\n ", | |
"x-label": { | |
"default": "Exclude From OneLink Translation" | |
}, | |
"type": "boolean" | |
}, | |
"c_overlay-content-text": { | |
"description": "When set to true, overlays the content text to an image background on Desktop.", | |
"x-label": { | |
"default": "Overlay Content Text on Desktop" | |
}, | |
"type": "boolean" | |
}, | |
"c_overlay-content-text-mobile": { | |
"description": "When set to true, overlays the content text to an image background on Mobile.", | |
"x-label": { | |
"default": "Overlay Content Text on Mobile" | |
}, | |
"type": "boolean" | |
}, | |
"c_playlist-id": { | |
"description": "Video Playlist ID for Video Carousel (takes preference over Video Ids)", | |
"x-label": { | |
"default": "Video Playlist ID" | |
}, | |
"type": "string" | |
}, | |
"c_pmcBgImage": { | |
"x-label": { | |
"default": "Background Image" | |
}, | |
"type": "string" | |
}, | |
"c_pmcBgImageBack": { | |
"x-label": { | |
"default": "Background Image Back" | |
}, | |
"type": "string" | |
}, | |
"c_pmcBgImageBackPisa": { | |
"x-label": { | |
"default": "Background Image Back PISA URL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_pmcBgImageBackScene7": { | |
"x-label": { | |
"default": "Background Image Back Scene7" | |
}, | |
"type": "string" | |
}, | |
"c_pmcBgImagePisa": { | |
"x-label": { | |
"default": "Background Image PISA URL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_pmcBgImageScene7": { | |
"x-label": { | |
"default": "Background Image Scene7" | |
}, | |
"type": "string" | |
}, | |
"c_pmcCTACopyBack": { | |
"x-label": { | |
"default": "Back Slide CTA Copy" | |
}, | |
"type": "string" | |
}, | |
"c_pmcCTACopyStatic": { | |
"x-label": { | |
"default": "CTA Copy" | |
}, | |
"type": "string" | |
}, | |
"c_pmcCTAUrlBack": { | |
"format": "html", | |
"x-label": { | |
"default": "CTA Url" | |
}, | |
"type": "string" | |
}, | |
"c_pmcCTAUrlStatic": { | |
"format": "html", | |
"x-label": { | |
"default": "CTA Url" | |
}, | |
"type": "string" | |
}, | |
"c_pmcHeadline": { | |
"x-label": { | |
"default": "Headline" | |
}, | |
"type": "string" | |
}, | |
"c_pmcHeadlineBackSlide": { | |
"x-label": { | |
"default": "Back Slide Headline" | |
}, | |
"type": "string" | |
}, | |
"c_pmcShowTextCTABack": { | |
"x-label": { | |
"default": "Display Back CTA as Text" | |
}, | |
"type": "boolean" | |
}, | |
"c_pmcSubheadlineFrontSlide": { | |
"x-label": { | |
"default": "Subheadline Front Slide (optional)" | |
}, | |
"type": "string" | |
}, | |
"c_pmcSubheadlineStatic": { | |
"x-label": { | |
"default": "Subheadline" | |
}, | |
"type": "string" | |
}, | |
"c_pmcVideoContentAssetID": { | |
"x-label": { | |
"default": "Video Content Asset ID" | |
}, | |
"type": "string" | |
}, | |
"c_product-carousel-category": { | |
"x-label": { | |
"default": "Category for Product Carousel" | |
}, | |
"type": "string" | |
}, | |
"c_product-id": { | |
"description": "Master Product ID", | |
"x-label": { | |
"default": "Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_productGroupFeatures": { | |
"description": "List of Product Features, in this format: PisaImageURL | FeatureTitle\n | FeatureDescription for example: http://pisaimages.azureedge.net/image/cobra-pdp-feature/|Super\n Lift Power|This club will really make your balls fly\n ", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Product Group Features" | |
}, | |
"type": "array" | |
}, | |
"c_products": { | |
"description": "Master or Variant IDs accepted", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Product IDs" | |
}, | |
"type": "array" | |
}, | |
"c_promo-tile-assignments": { | |
"description": "Promo Tile KOP content asset ID", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Promo Tile Assignments" | |
}, | |
"type": "array" | |
}, | |
"c_promo-tile-display": { | |
"description": "Display options for promo tile.", | |
"enum": [ | |
"single-width", | |
"double-width" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Single Width" | |
}, | |
{ | |
"default": "Double Width" | |
} | |
], | |
"x-label": { | |
"default": "Promo Tile Display" | |
}, | |
"type": "string" | |
}, | |
"c_promo-tile-flip-id": { | |
"description": "ID of another promo tile to display on the back of this tile.", | |
"x-label": { | |
"default": "Promo Tile Flip ID" | |
}, | |
"type": "string" | |
}, | |
"c_promoTileFrom": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Promo Tile From" | |
}, | |
"type": "string" | |
}, | |
"c_promoTileTo": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Promo Tile To" | |
}, | |
"type": "string" | |
}, | |
"c_regionURL": { | |
"description": "Anchor text used for locale", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Region URL" | |
}, | |
"type": "array" | |
}, | |
"c_releasedate": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Release Date" | |
}, | |
"type": "string" | |
}, | |
"c_select-collections-category": { | |
"x-label": { | |
"default": "Parent category for Shop Collections" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightCTA1CategoryID": { | |
"x-label": { | |
"default": "CTA 1 CategoryID" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightCTA1ProductID": { | |
"x-label": { | |
"default": "CTA 1 ProductID" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightCTA1Text": { | |
"x-label": { | |
"default": "CTA 1 Text" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightCTA1URL": { | |
"format": "html", | |
"x-label": { | |
"default": "CTA 1 URL" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightCTA2CategoryID": { | |
"x-label": { | |
"default": "CTA 2 CategoryID" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightCTA2ProductID": { | |
"x-label": { | |
"default": "CTA 2 ProductID" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightCTA2Text": { | |
"x-label": { | |
"default": "CTA 2 Text" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightCTA2URL": { | |
"format": "html", | |
"x-label": { | |
"default": "CTA 2 URL" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightCTALayout": { | |
"enum": [ | |
"vertical", | |
"horizontal" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Vertical" | |
}, | |
{ | |
"default": "Horizontal" | |
} | |
], | |
"x-label": { | |
"default": "Spotlight CTA Layout" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightCopy": { | |
"x-label": { | |
"default": "Spotlight Copy" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightCopyHEXColor": { | |
"x-label": { | |
"default": "Spotlight Copy Color" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightHeadline": { | |
"x-label": { | |
"default": "Spotlight Headline" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightHeadlineHEXColor": { | |
"x-label": { | |
"default": "Spotlight Headline Color" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightImage1": { | |
"x-label": { | |
"default": "Spotlight Image Left" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightImage2": { | |
"x-label": { | |
"default": "Spotlight Image Right" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightLayout": { | |
"enum": [ | |
"vertical", | |
"horizontal" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Vertical" | |
}, | |
{ | |
"default": "Horizontal" | |
} | |
], | |
"x-label": { | |
"default": "Spotlight Layout" | |
}, | |
"type": "string" | |
}, | |
"c_spotlightbackgroundHEXColor": { | |
"x-label": { | |
"default": "Spotlight Background Color" | |
}, | |
"type": "string" | |
}, | |
"c_text-color": { | |
"description": "Six character hexadecimal color code.", | |
"x-label": { | |
"default": "Text Color" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_text-color-mobile": { | |
"description": "Six character hexadecimal color code.", | |
"x-label": { | |
"default": "Text Color (Mobile)" | |
}, | |
"pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", | |
"type": "string" | |
}, | |
"c_thumbnail": { | |
"x-label": { | |
"default": "Thumbnail" | |
}, | |
"type": "string" | |
}, | |
"c_video-full-bleed": { | |
"description": "Display Video at full width", | |
"x-label": { | |
"default": "Full Bleed" | |
}, | |
"type": "boolean" | |
}, | |
"c_video-hero-text-position": { | |
"description": "Select the position of the video text", | |
"enum": [ | |
"Overlay", | |
"Beneath" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Overlay" | |
}, | |
{ | |
"default": "Beneath" | |
} | |
], | |
"x-label": { | |
"default": "Text Position" | |
}, | |
"type": "string" | |
}, | |
"c_video-ids": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Video IDs List" | |
}, | |
"type": "array" | |
}, | |
"c_video-show-thumbnails": { | |
"description": "Display Thumbnails carousel", | |
"x-label": { | |
"default": "Show Thumbnails" | |
}, | |
"type": "boolean" | |
}, | |
"c_visualFilterCategoryID": { | |
"x-label": { | |
"default": "Visual Filter Category ID" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterHeaderBgImage": { | |
"x-label": { | |
"default": "Visual Filter Header Background Image" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterHeaderBgImagePisaURL": { | |
"x-label": { | |
"default": "Visual Filter Header Background Image PISA URL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_visualFilterHeaderBgImageScene7": { | |
"x-label": { | |
"default": "Visual Filter Header Background Image Scene7" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterHeaderCTA": { | |
"format": "html", | |
"x-label": { | |
"default": "Visual Filter Header Call To Action Copy" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterHeaderHeadline": { | |
"format": "html", | |
"x-label": { | |
"default": "Visual Filter Header Headline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement1Copy": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Copy" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement1Headline": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Headline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement1Image": { | |
"x-label": { | |
"default": "Visual Filter Image" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement1ImagePisaURL": { | |
"x-label": { | |
"default": "Visual Filter Image PISA URL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_visualFilterRefinement1ImageScene7": { | |
"x-label": { | |
"default": "Visual Filter Image Scene7" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement1Prefn1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Name" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement1Prefv1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Value" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement1Subheadline": { | |
"format": "html", | |
"x-label": { | |
"default": "Visual Filter Subheadline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement2Copy": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Copy" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement2Headline": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Headline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement2Image": { | |
"x-label": { | |
"default": "Visual Filter Image" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement2ImagePisaURL": { | |
"x-label": { | |
"default": "Visual Filter Image PISA URL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_visualFilterRefinement2ImageScene7": { | |
"x-label": { | |
"default": "Visual Filter Image Scene7" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement2Prefn1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Name" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement2Prefv1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Value" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement2Subheadline": { | |
"format": "html", | |
"x-label": { | |
"default": "Visual Filter Subheadline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement3Copy": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Copy" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement3Headline": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Headline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement3Image": { | |
"x-label": { | |
"default": "Visual Filter Image" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement3ImagePisaURL": { | |
"x-label": { | |
"default": "Visual Filter Image PISA URL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_visualFilterRefinement3ImageScene7": { | |
"x-label": { | |
"default": "Visual Filter Image Scene7" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement3Prefn1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Name" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement3Prefv1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Value" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement3Subheadline": { | |
"format": "html", | |
"x-label": { | |
"default": "Visual Filter Subheadline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement4Copy": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Copy" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement4Headline": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Headline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement4Image": { | |
"x-label": { | |
"default": "Visual Filter Image" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement4ImagePisaURL": { | |
"x-label": { | |
"default": "Visual Filter Image PISA URL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_visualFilterRefinement4ImageScene7": { | |
"x-label": { | |
"default": "Visual Filter Image Scene7" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement4Prefn1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Name" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement4Prefv1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Value" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement4Subheadline": { | |
"format": "html", | |
"x-label": { | |
"default": "Visual Filter Subheadline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement5Copy": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Copy" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement5Headline": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Headline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement5Image": { | |
"x-label": { | |
"default": "Visual Filter Image" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement5ImagePisaURL": { | |
"x-label": { | |
"default": "Visual Filter Image PISA URL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_visualFilterRefinement5ImageScene7": { | |
"x-label": { | |
"default": "Visual Filter Image Scene7" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement5Prefn1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Name" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement5Prefv1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Value" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement5Subheadline": { | |
"format": "html", | |
"x-label": { | |
"default": "Visual Filter Subheadline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement6Copy": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Copy" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement6Headline": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Headline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement6Image": { | |
"x-label": { | |
"default": "Visual Filter Image" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement6ImagePisaURL": { | |
"x-label": { | |
"default": "Visual Filter Image PISA URL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_visualFilterRefinement6ImageScene7": { | |
"x-label": { | |
"default": "Visual Filter Image Scene7" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement6Prefn1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Name" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement6Prefv1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Value" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement6Subheadline": { | |
"x-label": { | |
"default": "Visual Filter Subheadline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement7Copy": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Copy" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement7Headline": { | |
"format": "text", | |
"x-label": { | |
"default": "Visual Filter Headline" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement7Image": { | |
"x-label": { | |
"default": "Visual Filter Image" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement7ImagePisaURL": { | |
"x-label": { | |
"default": "Visual Filter Image PISA URL" | |
}, | |
"pattern": "/^(https?:\/\/)?([\\da-z\\.-]+)\\.([a-z\\.]{2,6})([\/\\w \\.-]*)*\/?$/", | |
"type": "string" | |
}, | |
"c_visualFilterRefinement7ImageScene7": { | |
"x-label": { | |
"default": "Visual Filter Image Scene7" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement7Prefn1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Name" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement7Prefv1": { | |
"x-label": { | |
"default": "Visual Filter Refinement Filter Value" | |
}, | |
"type": "string" | |
}, | |
"c_visualFilterRefinement7Subheadline": { | |
"x-label": { | |
"default": "Visual Filter Subheadline" | |
}, | |
"type": "string" | |
}, | |
"c_wcAddTopMargin": { | |
"description": "Add additional top margin to slide the content under.", | |
"x-label": { | |
"default": "Add top margin" | |
}, | |
"type": "boolean" | |
}, | |
"description": { | |
"description": "The localized content asset description.", | |
"x-label": { | |
"default": "Description" | |
}, | |
"type": "string" | |
}, | |
"id": { | |
"description": "The id of the content asset.", | |
"x-label": { | |
"default": "ID" | |
}, | |
"maxLength": 256, | |
"minLength": 1, | |
"type": "string" | |
}, | |
"name": { | |
"description": "The localized content asset name.", | |
"x-label": { | |
"default": "Name" | |
}, | |
"type": "string" | |
}, | |
"page_description": { | |
"description": "The localized content asset page description.", | |
"x-label": { | |
"default": "Page Description" | |
}, | |
"type": "string" | |
}, | |
"page_keywords": { | |
"description": "The localized content asset page description.", | |
"x-label": { | |
"default": "Page Keywords" | |
}, | |
"type": "string" | |
}, | |
"page_title": { | |
"description": "The localized content asset page title.", | |
"x-label": { | |
"default": "Page Title" | |
}, | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"c_FeatureRowHeadline", | |
"c_FeatureRowImageRectangular", | |
"c_FeatureRowImageSquare", | |
"c_SpinnerPID", | |
"c_catchAllBackgroundImageAnchor", | |
"c_catchAllMainContainerStyle", | |
"c_catchAllRegionsListStyle", | |
"id" | |
] | |
}, | |
"content_folder": { | |
"description": "Document representing a content folder.", | |
"properties": { | |
"c_customCSSFile": { | |
"description": "Use this attribute to apply custom styles for this category.", | |
"x-label": { | |
"default": "Custom CSS File" | |
}, | |
"type": "string" | |
}, | |
"c_gccLastSubmitted": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Sent for translation on" | |
}, | |
"type": "string" | |
}, | |
"c_gccLastTranslated": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Translations imported on" | |
}, | |
"type": "string" | |
}, | |
"c_gccStatus": { | |
"description": "This attribute is used by GCC.", | |
"enum": [ | |
"Ready", | |
"Sent", | |
"Imported" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Ready to Send" | |
}, | |
{ | |
"default": "In Progress" | |
}, | |
{ | |
"default": "Translated" | |
} | |
], | |
"x-label": { | |
"default": "GlobalLink Status" | |
}, | |
"type": "string" | |
}, | |
"c_gccSubmissionName": { | |
"description": "This attribute is used to store the gccSubmissionName information locale-specific.", | |
"x-label": { | |
"default": "GCC Submission Name" | |
}, | |
"type": "string" | |
}, | |
"description": { | |
"description": "The localized content folder description.", | |
"x-label": { | |
"default": "Description" | |
}, | |
"type": "string" | |
}, | |
"folders": { | |
"description": "The array of content subfolders. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/content_folder" | |
}, | |
"type": "array" | |
}, | |
"id": { | |
"description": "The id of the content folder.", | |
"x-label": { | |
"default": "ID" | |
}, | |
"maxLength": 256, | |
"minLength": 1, | |
"type": "string" | |
}, | |
"name": { | |
"description": "The localized content folder name.", | |
"x-label": { | |
"default": "Name" | |
}, | |
"type": "string" | |
}, | |
"page_description": { | |
"description": "The localized content folder page description.", | |
"x-label": { | |
"default": "Page Description" | |
}, | |
"type": "string" | |
}, | |
"page_keywords": { | |
"description": "The localized content folder page description.", | |
"x-label": { | |
"default": "Page Keywords" | |
}, | |
"type": "string" | |
}, | |
"page_title": { | |
"description": "The localized content folder page title.", | |
"x-label": { | |
"default": "Page Title" | |
}, | |
"type": "string" | |
}, | |
"parent_folder_id": { | |
"description": "The id of the parent content folder.", | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"id" | |
] | |
}, | |
"content_folder_result": { | |
"description": "Result document containing an array of content folders.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"description": "The array of content folder documents.", | |
"items": { | |
"$ref": "#/definitions/content_folder" | |
}, | |
"type": "array" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"content_result": { | |
"description": "Result document containing an array of content assets.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"description": "The array of content assets.", | |
"items": { | |
"$ref": "#/definitions/content" | |
}, | |
"type": "array" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"content_search_refinement": { | |
"description": "Document representing a search refinement attribute.", | |
"properties": { | |
"attribute_id": { | |
"description": "The id of the search refinement attribute. In the case of an attribute refinement, this is the\n attribute id. Custom attributes are marked by the prefix \"c_\".", | |
"type": "string" | |
}, | |
"label": { | |
"description": "The localized label of the refinement.", | |
"type": "string" | |
}, | |
"values": { | |
"description": "The sorted array of refinement values. The array can be empty.", | |
"items": { | |
"$ref": "#/definitions/content_search_refinement_value" | |
}, | |
"type": "array" | |
} | |
}, | |
"required": [ | |
"attribute_id" | |
] | |
}, | |
"content_search_refinement_value": { | |
"description": "Document representing a search refinement value.", | |
"properties": { | |
"description": { | |
"description": "The localized description of the refinement value.", | |
"type": "string" | |
}, | |
"hit_count": { | |
"description": "The number of search hits (0 or more) when selecting the refinement value.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"label": { | |
"description": "The localized label of the refinement value.", | |
"type": "string" | |
}, | |
"presentation_id": { | |
"description": "The optional presentation id associated with the refinement value.\n The presentation id can be used, for example, to associate an id with\n an HTML widget.", | |
"type": "string" | |
}, | |
"value": { | |
"description": "The refinement value. In the case of an attribute refinement, this is the bucket,\n the attribute value, or a value range. In the case of a content folder refinement,\n this is the folder id.", | |
"type": "string" | |
}, | |
"values": { | |
"description": "The array of hierarchical refinement values. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/content_search_refinement_value" | |
}, | |
"type": "array" | |
} | |
} | |
}, | |
"content_search_result": { | |
"description": "Document representing a content search result.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"items": { | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"hits": { | |
"description": "The sorted array of search hits. Can be empty.", | |
"items": { | |
"$ref": "#/definitions/content" | |
}, | |
"type": "array" | |
}, | |
"next": { | |
"description": "The URL of the next result page.", | |
"type": "string" | |
}, | |
"previous": { | |
"description": "The URL of the previous result page.", | |
"type": "string" | |
}, | |
"query": { | |
"description": "The query String that was searched for.", | |
"type": "string" | |
}, | |
"refinements": { | |
"description": "The sorted array of search refinements. Can be empty.", | |
"items": { | |
"$ref": "#/definitions/content_search_refinement" | |
}, | |
"type": "array" | |
}, | |
"selected_refinements": { | |
"additionalProperties": { | |
"type": "string" | |
}, | |
"description": "Map of selected refinement attribute id/value(s) pairs. The sorting order is the same like in request URL.", | |
"type": "object" | |
}, | |
"start": { | |
"description": "The zero-based index of the first search hit to include in the result.", | |
"format": "int32", | |
"minimum": 0, | |
"type": "integer" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"coupon_item": { | |
"description": "Document representing a coupon item.", | |
"properties": { | |
"code": { | |
"description": "The coupon code.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"coupon_item_id": { | |
"description": "The coupon item id.", | |
"type": "string" | |
}, | |
"status_code": { | |
"description": "The status of the coupon item.", | |
"enum": [ | |
"coupon_code_already_in_basket", | |
"coupon_code_already_redeemed", | |
"coupon_code_unknown", | |
"coupon_disabled", | |
"redemption_limit_exceeded", | |
"customer_redemption_limit_exceeded", | |
"timeframe_redemption_limit_exceeded", | |
"no_active_promotion", | |
"coupon_already_in_basket", | |
"no_applicable_promotion", | |
"applied", | |
"adhoc" | |
], | |
"type": "string" | |
}, | |
"valid": { | |
"description": "A flag indicating whether the coupon item is valid. A coupon line item is valid if\n the status code is 'applied' or 'no_applicable_promotion'.", | |
"type": "boolean" | |
} | |
}, | |
"required": [ | |
"code" | |
] | |
}, | |
"custom_object": { | |
"description": "Document representing a custom object that contains all defined custom attributes for its\n object type.", | |
"properties": { | |
"key_property": { | |
"description": "The name of the key property for the custom object.", | |
"type": "string" | |
}, | |
"key_value_integer": { | |
"description": "The id of the custom object when the type of the key is Integer.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"key_value_string": { | |
"description": "The id of the custom object when the type of the key is String.", | |
"type": "string" | |
}, | |
"object_type": { | |
"description": "The id of the object type.", | |
"maxLength": 256, | |
"type": "string" | |
} | |
} | |
}, | |
"customer": { | |
"description": "Document representing a customer.", | |
"properties": { | |
"addresses": { | |
"description": "The customer's addresses.", | |
"items": { | |
"$ref": "#/definitions/customer_address" | |
}, | |
"x-label": { | |
"default": "Addresses" | |
}, | |
"type": "array" | |
}, | |
"auth_type": { | |
"description": "The customer's authorization type (indicates if the customer is a guest\n or a registered customer).", | |
"enum": [ | |
"guest", | |
"registered" | |
], | |
"x-label": { | |
"default": "Auth Type" | |
}, | |
"type": "string" | |
}, | |
"birthday": { | |
"description": "The customer's birthday.", | |
"format": "date", | |
"x-label": { | |
"default": "Birthday" | |
}, | |
"type": "string" | |
}, | |
"c_CAmigrationMigrated": { | |
"x-label": { | |
"default": "Migrated To CA" | |
}, | |
"type": "boolean" | |
}, | |
"c_CAmigrationScanned": { | |
"x-label": { | |
"default": "Scanned for CA Migration" | |
}, | |
"type": "boolean" | |
}, | |
"c_PayPalBAID": { | |
"description": "Using this ID simplifies the checkout process using reference\n transactions\n ", | |
"x-label": { | |
"default": "PayPal BAID assigned after Reference Transaction" | |
}, | |
"type": "string" | |
}, | |
"c_accountLockedEmailSent": { | |
"description": "Check if customer get email with locked status", | |
"x-label": { | |
"default": "Account Locked Email Sent" | |
}, | |
"type": "boolean" | |
}, | |
"c_billingAgreementID": { | |
"description": "The Billing Agreement ID of the customer in PayPal", | |
"x-label": { | |
"default": "PayPal Billing Agreement ID" | |
}, | |
"type": "string" | |
}, | |
"c_bvDisplayName": { | |
"x-label": { | |
"default": "Name to appear in public Bazaarvoice reviews" | |
}, | |
"type": "string" | |
}, | |
"c_cardType": { | |
"x-label": { | |
"default": "Card Type" | |
}, | |
"type": "string" | |
}, | |
"c_currentCustomerCreditGC": { | |
"x-label": { | |
"default": "Current Customer Credit GC" | |
}, | |
"type": "string" | |
}, | |
"c_customerCreditBalance": { | |
"format": "double", | |
"x-label": { | |
"default": "Customer Credit Balance" | |
}, | |
"type": "number" | |
}, | |
"c_customerCreditGCHistory": { | |
"format": "text", | |
"x-label": { | |
"default": "Customer Credit GC History" | |
}, | |
"type": "string" | |
}, | |
"c_dataShouldBePurged": { | |
"enum": [ | |
"true", | |
"false" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Yes" | |
}, | |
{ | |
"default": "No" | |
} | |
], | |
"x-label": { | |
"default": "Customer data should be purged" | |
}, | |
"type": "string" | |
}, | |
"c_encryptedPassword": { | |
"x-label": { | |
"default": "Encrypted Password" | |
}, | |
"type": "string" | |
}, | |
"c_familyStatus": { | |
"x-label": { | |
"default": "Family Status" | |
}, | |
"type": "string" | |
}, | |
"c_firstNamePronunciation": { | |
"x-label": { | |
"default": "First Name Pronunciation" | |
}, | |
"type": "string" | |
}, | |
"c_gaID": { | |
"description": "gaID", | |
"x-label": { | |
"default": "Customer Ga Id" | |
}, | |
"type": "string" | |
}, | |
"c_inflowCodeOnRegistration": { | |
"description": "The specified codes assigned to each transition source. It could be used for marketing feed, SFCC promotion terms.", | |
"x-label": { | |
"default": "Inflow code on registration" | |
}, | |
"type": "string" | |
}, | |
"c_isExported": { | |
"x-label": { | |
"default": "Is Exported?" | |
}, | |
"type": "boolean" | |
}, | |
"c_isLegacy": { | |
"description": "Check is Legacy Customer or not", | |
"x-label": { | |
"default": "Is Legacy" | |
}, | |
"type": "boolean" | |
}, | |
"c_isSleeping": { | |
"description": "Check Customer is Sleeping or not", | |
"x-label": { | |
"default": "Is Sleeping" | |
}, | |
"type": "boolean" | |
}, | |
"c_lastAddressModified": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Last Address Modified" | |
}, | |
"type": "string" | |
}, | |
"c_lastNamePronunciation": { | |
"x-label": { | |
"default": "Last Name Pronunciation" | |
}, | |
"type": "string" | |
}, | |
"c_migrationMigrated": { | |
"x-label": { | |
"default": "Migrated To GB" | |
}, | |
"type": "boolean" | |
}, | |
"c_migrationScanned": { | |
"x-label": { | |
"default": "Scanned for GB Migration" | |
}, | |
"type": "boolean" | |
}, | |
"c_narvarSMSSubscription": { | |
"x-label": { | |
"default": "Narvar SMS Subscription" | |
}, | |
"type": "boolean" | |
}, | |
"c_newsletterSubscription": { | |
"x-label": { | |
"default": "Newsletter Subscription" | |
}, | |
"type": "boolean" | |
}, | |
"c_passwordHash": { | |
"description": "(for RU site only)", | |
"x-label": { | |
"default": "Password Hash" | |
}, | |
"type": "string" | |
}, | |
"c_passwordResetRateLimiterLog": { | |
"format": "text", | |
"x-label": { | |
"default": "Password Reset Rate Limiter Log" | |
}, | |
"type": "string" | |
}, | |
"c_phoneSubscription": { | |
"x-label": { | |
"default": "Phone Subscription" | |
}, | |
"type": "boolean" | |
}, | |
"c_rusDataUID": { | |
"x-label": { | |
"default": "rusDataUID" | |
}, | |
"type": "string" | |
}, | |
"c_solvencyDate": { | |
"description": "The last time the Solvency Check was performed", | |
"format": "date-time", | |
"x-label": { | |
"default": "Solvency Date" | |
}, | |
"type": "string" | |
}, | |
"c_solvencyHash": { | |
"description": "The hash of the last Solvency Request sent through", | |
"x-label": { | |
"default": "Solvency Hash" | |
}, | |
"type": "string" | |
}, | |
"c_solvencyResponse": { | |
"description": "The Response object for the last Solvency Request peformed\n ", | |
"format": "text", | |
"x-label": { | |
"default": "Solvency Response" | |
}, | |
"type": "string" | |
}, | |
"c_syncedToMailChimp": { | |
"description": "Flag for job to query", | |
"x-label": { | |
"default": "Synced to mailchimp" | |
}, | |
"type": "boolean" | |
}, | |
"company_name": { | |
"description": "The customer's company name.", | |
"x-label": { | |
"default": "Company" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"creation_date": { | |
"description": "Returns the value of attribute 'creationDate'.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Creation Date" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"customer_id": { | |
"description": "The customer's number (id). Both registered and guest customers have a\n customer id.", | |
"x-label": { | |
"default": "UUID" | |
}, | |
"maxLength": 28, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"customer_no": { | |
"description": "The customer's number (id). Only a registered customer has a customer\n number.", | |
"x-label": { | |
"default": "Customer No." | |
}, | |
"maxLength": 100, | |
"type": "string" | |
}, | |
"email": { | |
"description": "The customer's email address.", | |
"format": "email", | |
"x-label": { | |
"default": "Email" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"enabled": { | |
"description": "A flag indicating whether this customer is is enabled and can log in.", | |
"x-label": { | |
"default": "Enabled" | |
}, | |
"type": "boolean" | |
}, | |
"fax": { | |
"description": "The customer's fax number. The length is restricted to 32 characters.", | |
"x-label": { | |
"default": "Fax Number" | |
}, | |
"maxLength": 32, | |
"type": "string" | |
}, | |
"first_name": { | |
"description": "The customer's first name.", | |
"x-label": { | |
"default": "First Name" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"gender": { | |
"description": "The customer's gender.", | |
"enum": [ | |
1, | |
2 | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Male" | |
}, | |
{ | |
"default": "Female" | |
} | |
], | |
"format": "int32", | |
"x-label": { | |
"default": "Gender" | |
}, | |
"type": "integer" | |
}, | |
"hashed_login": { | |
"description": "The customer's hashed LoginId which is used for activity tracking for logged in customers in conjunction with\n visitId. This field is READ-ONLY", | |
"x-label": { | |
"default": "User Id" | |
}, | |
"type": "string" | |
}, | |
"job_title": { | |
"description": "The customer's job title.", | |
"x-label": { | |
"default": "Job Title" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"last_login_time": { | |
"description": "The time when the customer last logged in.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Last Login Time" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"last_modified": { | |
"description": "Returns the value of attribute 'lastModified'.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Last Modified" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"last_name": { | |
"description": "The customer's last name.", | |
"x-label": { | |
"default": "Last Name" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"last_visit_time": { | |
"description": "The time when the customer last visited.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Last Visit Time" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"login": { | |
"description": "The customer's login.", | |
"x-label": { | |
"default": "Login" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"note": { | |
"description": "The customer's note.", | |
"x-label": { | |
"default": "Note" | |
}, | |
"type": "string" | |
}, | |
"payment_instruments": { | |
"description": "The customer's payment instruments.", | |
"items": { | |
"$ref": "#/definitions/customer_payment_instrument" | |
}, | |
"x-label": { | |
"default": "Payment Instruments" | |
}, | |
"type": "array" | |
}, | |
"phone_business": { | |
"description": "The customer's business phone number.", | |
"x-label": { | |
"default": "Business Phone" | |
}, | |
"maxLength": 32, | |
"type": "string" | |
}, | |
"phone_home": { | |
"description": "The customer's home phone number.", | |
"x-label": { | |
"default": "Home Phone" | |
}, | |
"maxLength": 32, | |
"type": "string" | |
}, | |
"phone_mobile": { | |
"description": "The customer's mobile phone number.", | |
"x-label": { | |
"default": "Mobile Phone" | |
}, | |
"maxLength": 32, | |
"type": "string" | |
}, | |
"preferred_locale": { | |
"description": "The customer's preferred locale.", | |
"x-label": { | |
"default": "Preferred Locale" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"previous_login_time": { | |
"description": "The time when the customer logged in previously.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Previous Login Time" | |
}, | |
"type": "string" | |
}, | |
"previous_visit_time": { | |
"description": "The time when the customer last visited the store.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Previous Visit Time" | |
}, | |
"type": "string" | |
}, | |
"salutation": { | |
"description": "The salutation to use for the customer.", | |
"x-label": { | |
"default": "Salutation" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"second_name": { | |
"description": "The customer's second name.", | |
"x-label": { | |
"default": "Second Name" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"suffix": { | |
"description": "The customer's suffix (for example, \"Jr.\" or \"Sr.\").", | |
"x-label": { | |
"default": "Name Suffix" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"title": { | |
"description": "The customer's title (for example, \"Mrs\" or \"Mr\").", | |
"x-label": { | |
"default": "Title" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"visit_id": { | |
"description": "The customer's visitId. This field is READ-ONLY", | |
"x-label": { | |
"default": "Visit Id" | |
}, | |
"type": "string" | |
} | |
} | |
}, | |
"customer_address": { | |
"description": "Document representing a customer address.", | |
"properties": { | |
"address1": { | |
"description": "The first address.", | |
"x-label": { | |
"default": "Address 1" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"address2": { | |
"description": "The second address.", | |
"x-label": { | |
"default": "Address 2" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"address_id": { | |
"description": "The id of the address as specified by account owner.", | |
"x-label": { | |
"default": "Address ID" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"c_DeltavistaScoringDate": { | |
"format": "date", | |
"x-label": { | |
"default": "Deltavista Scoring Date" | |
}, | |
"type": "string" | |
}, | |
"c_DeltavistaScoringResult": { | |
"x-label": { | |
"default": "Deltavista Scoring Result" | |
}, | |
"type": "string" | |
}, | |
"c_addressFieldID": { | |
"description": "(for RU site only)", | |
"x-label": { | |
"default": "ID of address field from service" | |
}, | |
"type": "string" | |
}, | |
"c_avsDate": { | |
"format": "date", | |
"x-label": { | |
"default": "FedEx AVS Date" | |
}, | |
"type": "string" | |
}, | |
"c_avsResponse": { | |
"x-label": { | |
"default": "FedEx AVS Response" | |
}, | |
"type": "string" | |
}, | |
"c_birthdate": { | |
"format": "date", | |
"x-label": { | |
"default": "Birthday" | |
}, | |
"type": "string" | |
}, | |
"c_district": { | |
"x-label": { | |
"default": "District" | |
}, | |
"type": "string" | |
}, | |
"c_extPostalCode": { | |
"x-label": { | |
"default": "Extended Postal Code" | |
}, | |
"type": "string" | |
}, | |
"c_firstNamePronunciation": { | |
"x-label": { | |
"default": "First Name Pronunciation" | |
}, | |
"type": "string" | |
}, | |
"c_geCityRegion": { | |
"description": "City Region", | |
"x-label": { | |
"default": "City Region" | |
}, | |
"type": "string" | |
}, | |
"c_houseNumber": { | |
"x-label": { | |
"default": "House Number" | |
}, | |
"type": "string" | |
}, | |
"c_lastNamePronunciation": { | |
"x-label": { | |
"default": "Last Name Pronunciation" | |
}, | |
"type": "string" | |
}, | |
"c_radialAVSValidated": { | |
"x-label": { | |
"default": "Radial AVS Validated" | |
}, | |
"type": "boolean" | |
}, | |
"c_shortPostalCode": { | |
"x-label": { | |
"default": "Short Postal Code" | |
}, | |
"type": "string" | |
}, | |
"c_streetName": { | |
"x-label": { | |
"default": "Street Name" | |
}, | |
"type": "string" | |
}, | |
"c_streetNo": { | |
"x-label": { | |
"default": "Street Number" | |
}, | |
"type": "string" | |
}, | |
"city": { | |
"description": "The city.", | |
"x-label": { | |
"default": "City" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"company_name": { | |
"description": "The company name.", | |
"x-label": { | |
"default": "Company" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"country_code": { | |
"description": "The two-letter ISO 3166-1 (Alpha-2) country code.", | |
"enum": [ | |
"US", | |
"CA", | |
"DE", | |
"BE", | |
"ES", | |
"NL", | |
"CZ", | |
"EE", | |
"HU", | |
"IE", | |
"IT", | |
"LV", | |
"PL", | |
"PT", | |
"SI", | |
"SK", | |
"GR", | |
"AT", | |
"LU", | |
"DK", | |
"FI", | |
"SE", | |
"CH", | |
"FR", | |
"GB", | |
"BG", | |
"HR", | |
"LT", | |
"RO", | |
"KR", | |
"PH", | |
"TH" | |
], | |
"x-enum-labels": [ | |
{ | |
"de": "USA", | |
"default": "United States", | |
"it": "Stati Uniti", | |
"fr": "États-Unis", | |
"es": "Estados Unidos" | |
}, | |
{ | |
"de": "Kanada", | |
"default": "Canada", | |
"it": "Canada", | |
"fr": "Canada", | |
"es": "Canadá" | |
}, | |
{ | |
"it-IT": "Germania", | |
"de": "Deutschland", | |
"default": "Germany", | |
"ko": "독일", | |
"it": "Germania", | |
"fr": "Allemagne", | |
"pl": "Niemcy", | |
"es": "Alemania", | |
"nl": "Duitsland" | |
}, | |
{ | |
"de": "Belgien", | |
"default": "Belgium", | |
"it": "Belgio", | |
"fr": "Belgique", | |
"pl": "Belgia", | |
"es": "Bélgica", | |
"nl": "België" | |
}, | |
{ | |
"de": "Spanien", | |
"default": "Spain", | |
"it": "Spagna", | |
"fr": "Espagne", | |
"pl": "Hiszpania", | |
"es": "España", | |
"nl": "Spanje" | |
}, | |
{ | |
"de": "Niederlande", | |
"default": "Netherlands", | |
"it": "Olanda", | |
"fr": "Pays-Bas", | |
"pl": "Holandia", | |
"es": "Países Bajos", | |
"nl": "Nederland" | |
}, | |
{ | |
"de": "Tschechische Republik", | |
"default": "Czech Republic", | |
"it": "Repubblica Ceca", | |
"fr": "République Tchèque", | |
"pl": "Czechy", | |
"es": "República Checa", | |
"nl": "Tsjechië" | |
}, | |
{ | |
"de": "Estland", | |
"default": "Estonia", | |
"it": "Estonia", | |
"fr": "Estonie", | |
"pl": "Estonia", | |
"es": "Estonia", | |
"nl": "Estland" | |
}, | |
{ | |
"de": "Ungarn", | |
"default": "Hungary", | |
"it": "Ungheria", | |
"fr": "Hongrie", | |
"pl": "Węgry", | |
"es": "Hungría", | |
"nl": "Hongarije" | |
}, | |
{ | |
"de": "Irland", | |
"default": "Ireland", | |
"it": "Irlanda", | |
"fr": "Irlande", | |
"pl": "Irlandia", | |
"es": "Irlanda", | |
"nl": "Ierland" | |
}, | |
{ | |
"de": "Italien", | |
"default": "Italy", | |
"it": "Italia", | |
"fr": "Italie", | |
"pl": "Włochy", | |
"es": "Italia", | |
"nl": "Italië" | |
}, | |
{ | |
"de": "Lettland", | |
"default": "Latvia", | |
"it": "Lettonia", | |
"fr": "Lettonie", | |
"pl": "Łotwa", | |
"es": "Letonia", | |
"nl": "Letland" | |
}, | |
{ | |
"de": "Polen", | |
"default": "Poland", | |
"it": "Polonia", | |
"fr": "Pologne", | |
"pl": "Polska", | |
"es": "Polonia", | |
"nl": "Polen" | |
}, | |
{ | |
"de": "Portugal", | |
"default": "Portugal", | |
"it": "Portogallo", | |
"fr": "Portugal", | |
"pl": "Portugalia", | |
"es": "Portugal", | |
"nl": "Portugal" | |
}, | |
{ | |
"de": "Slowenien", | |
"default": "Slovenia", | |
"it": "Slovenia", | |
"fr": "Slovénie", | |
"pl": "Słowenia", | |
"es": "Eslovenia", | |
"nl": "Slovenië" | |
}, | |
{ | |
"de": "Slowakei", | |
"default": "Slovakia", | |
"it": "Slovacchia", | |
"fr": "Slovaquie", | |
"pl": "Słowacja", | |
"es": "Eslovaquia", | |
"nl": "Slowakije" | |
}, | |
{ | |
"de": "Griechenland", | |
"default": "Greece", | |
"it": "Grecia", | |
"fr": "Grèce", | |
"pl": "Grecja", | |
"es": "Grecia", | |
"nl": "Griekenland" | |
}, | |
{ | |
"de": "Österreich", | |
"default": "Austria", | |
"it": "Austria", | |
"fr": "Autriche", | |
"pl": "Austria", | |
"es": "Austria", | |
"nl": "Oostenrijk" | |
}, | |
{ | |
"de": "Luxemburg", | |
"default": "Luxembourg", | |
"it": "Lussemburgo", | |
"fr": "Luxembourg", | |
"pl": "Luksemburg", | |
"es": "Luxemburgo", | |
"nl": "Luxemburg" | |
}, | |
{ | |
"de": "Dänemark", | |
"default": "Denmark", | |
"it": "Danimarca", | |
"fr": "Danemark", | |
"pl": "Dania", | |
"es": "Dinamarca", | |
"nl": "Denemarken" | |
}, | |
{ | |
"de": "Finnland", | |
"default": "Finland", | |
"it": "Finlandia", | |
"fr": "Finlande", | |
"pl": "Finlandia", | |
"es": "Finlandia", | |
"nl": "Finland" | |
}, | |
{ | |
"de": "Schweden", | |
"default": "Sweden", | |
"it": "Svezia", | |
"fr": "Suède", | |
"pl": "Szwecja", | |
"es": "Suecia", | |
"nl": "Zweden" | |
}, | |
{ | |
"de": "Schweiz", | |
"default": "Switzerland", | |
"it": "Svizzera", | |
"fr": "Suisse", | |
"pl": "Szwajcaria", | |
"es": "Suiza", | |
"nl": "Zwitserland" | |
}, | |
{ | |
"de": "Frankreich", | |
"default": "France", | |
"it": "Francia", | |
"fr": "France", | |
"pl": "Francja", | |
"es": "Francia", | |
"nl": "Frankrijk" | |
}, | |
{ | |
"de": "Vereinigtes Königreich (UK)", | |
"default": "United Kingdom", | |
"it": "Regno Unito", | |
"fr": "Royaume-Uni", | |
"pl": "Wielka Brytania", | |
"es": "Reino Unido", | |
"nl": "Verenigd Koninkrijk" | |
}, | |
{ | |
"de": "Bulgarien", | |
"default": "Bulgaria", | |
"it": "Bulgaria", | |
"fr": "Bulgarie", | |
"pl": "Bułgaria", | |
"es": "Bulgaria", | |
"nl": "Bulgarije" | |
}, | |
{ | |
"de": "Kroatien", | |
"default": "Croatia", | |
"it": "Croazia", | |
"fr": "Croatie", | |
"pl": "Chorwacja", | |
"es": "Croacia", | |
"nl": "Kroatië" | |
}, | |
{ | |
"de": "Italien", | |
"default": "Lithuania", | |
"it": "Lituania", | |
"fr": "Lituanie", | |
"pl": "Litwa", | |
"es": "Lituania", | |
"nl": "Litouwen" | |
}, | |
{ | |
"de": "Romänien", | |
"default": "Romania", | |
"it": "Romania", | |
"fr": "Roumanie", | |
"pl": "Rumunia", | |
"es": "Rumanía", | |
"nl": "Roemenië" | |
}, | |
{ | |
"default": "대한민국" | |
}, | |
{ | |
"default": "Philippines" | |
}, | |
{ | |
"default": "Thailand", | |
"th-TH": "ประเทศไทย" | |
} | |
], | |
"x-label": { | |
"default": "Country" | |
}, | |
"maxLength": 2, | |
"type": "string" | |
}, | |
"creation_date": { | |
"description": "Returns the value of attribute 'creationDate'.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Creation Date" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"first_name": { | |
"description": "The first name.", | |
"x-label": { | |
"default": "First Name" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"full_name": { | |
"description": "The full name.", | |
"x-label": { | |
"default": "Full Name" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"job_title": { | |
"description": "The job title.", | |
"x-label": { | |
"default": "Job Title" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"last_modified": { | |
"description": "Returns the value of attribute 'lastModified'.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Last Modified" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"last_name": { | |
"description": "The last name.", | |
"x-label": { | |
"default": "Last Name" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"phone": { | |
"description": "The phone number.", | |
"x-label": { | |
"default": "Contact Phone" | |
}, | |
"maxLength": 32, | |
"type": "string" | |
}, | |
"post_box": { | |
"description": "The post box.", | |
"x-label": { | |
"default": "Post Box" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"postal_code": { | |
"description": "The postal code.", | |
"x-label": { | |
"default": "Postal Code" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"preferred": { | |
"description": "The preferred attribute.", | |
"x-label": { | |
"default": "Preferred" | |
}, | |
"type": "boolean" | |
}, | |
"salutation": { | |
"description": "The salutation.", | |
"x-label": { | |
"default": "Salutation" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"second_name": { | |
"description": "The second name.", | |
"x-label": { | |
"default": "Second Name" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"state_code": { | |
"description": "The state code.", | |
"x-label": { | |
"default": "State" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"suffix": { | |
"description": "The suffix.", | |
"x-label": { | |
"default": "Suffix" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"suite": { | |
"description": "The suite.", | |
"x-label": { | |
"default": "Suite No." | |
}, | |
"maxLength": 32, | |
"type": "string" | |
}, | |
"title": { | |
"description": "The title.", | |
"x-label": { | |
"default": "Title" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
} | |
} | |
}, | |
"customer_address_link": { | |
"description": "* Result document of product list addresses.", | |
"properties": { | |
"address_id": { | |
"description": "The id of the address.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"link": { | |
"description": "The target of the link.", | |
"type": "string" | |
}, | |
"title": { | |
"description": "The link title.", | |
"type": "string" | |
} | |
} | |
}, | |
"customer_address_result": { | |
"description": "Result document containing an array of customer addresses.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"description": "The array of customer address documents.", | |
"items": { | |
"$ref": "#/definitions/customer_address" | |
}, | |
"type": "array" | |
}, | |
"next": { | |
"description": "The URL of the next result page.", | |
"type": "string" | |
}, | |
"previous": { | |
"description": "The URL of the previous result page.", | |
"type": "string" | |
}, | |
"select": { | |
"description": "", | |
"type": "string" | |
}, | |
"start": { | |
"description": "The zero-based index of the first search hit to include in the result.", | |
"format": "int32", | |
"minimum": 0, | |
"type": "integer" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"customer_info": { | |
"description": "Document representing information used to identify a customer.", | |
"properties": { | |
"c_CAmigrationMigrated": { | |
"x-label": { | |
"default": "Migrated To CA" | |
}, | |
"type": "boolean" | |
}, | |
"c_CAmigrationScanned": { | |
"x-label": { | |
"default": "Scanned for CA Migration" | |
}, | |
"type": "boolean" | |
}, | |
"c_PayPalBAID": { | |
"description": "Using this ID simplifies the checkout process using reference\n transactions\n ", | |
"x-label": { | |
"default": "PayPal BAID assigned after Reference Transaction" | |
}, | |
"type": "string" | |
}, | |
"c_accountLockedEmailSent": { | |
"description": "Check if customer get email with locked status", | |
"x-label": { | |
"default": "Account Locked Email Sent" | |
}, | |
"type": "boolean" | |
}, | |
"c_billingAgreementID": { | |
"description": "The Billing Agreement ID of the customer in PayPal", | |
"x-label": { | |
"default": "PayPal Billing Agreement ID" | |
}, | |
"type": "string" | |
}, | |
"c_bvDisplayName": { | |
"x-label": { | |
"default": "Name to appear in public Bazaarvoice reviews" | |
}, | |
"type": "string" | |
}, | |
"c_cardType": { | |
"x-label": { | |
"default": "Card Type" | |
}, | |
"type": "string" | |
}, | |
"c_currentCustomerCreditGC": { | |
"x-label": { | |
"default": "Current Customer Credit GC" | |
}, | |
"type": "string" | |
}, | |
"c_customerCreditBalance": { | |
"format": "double", | |
"x-label": { | |
"default": "Customer Credit Balance" | |
}, | |
"type": "number" | |
}, | |
"c_customerCreditGCHistory": { | |
"format": "text", | |
"x-label": { | |
"default": "Customer Credit GC History" | |
}, | |
"type": "string" | |
}, | |
"c_dataShouldBePurged": { | |
"enum": [ | |
"true", | |
"false" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Yes" | |
}, | |
{ | |
"default": "No" | |
} | |
], | |
"x-label": { | |
"default": "Customer data should be purged" | |
}, | |
"type": "string" | |
}, | |
"c_encryptedPassword": { | |
"x-label": { | |
"default": "Encrypted Password" | |
}, | |
"type": "string" | |
}, | |
"c_familyStatus": { | |
"x-label": { | |
"default": "Family Status" | |
}, | |
"type": "string" | |
}, | |
"c_firstNamePronunciation": { | |
"x-label": { | |
"default": "First Name Pronunciation" | |
}, | |
"type": "string" | |
}, | |
"c_gaID": { | |
"description": "gaID", | |
"x-label": { | |
"default": "Customer Ga Id" | |
}, | |
"type": "string" | |
}, | |
"c_inflowCodeOnRegistration": { | |
"description": "The specified codes assigned to each transition source. It could be used for marketing feed, SFCC promotion terms.", | |
"x-label": { | |
"default": "Inflow code on registration" | |
}, | |
"type": "string" | |
}, | |
"c_isExported": { | |
"x-label": { | |
"default": "Is Exported?" | |
}, | |
"type": "boolean" | |
}, | |
"c_isLegacy": { | |
"description": "Check is Legacy Customer or not", | |
"x-label": { | |
"default": "Is Legacy" | |
}, | |
"type": "boolean" | |
}, | |
"c_isSleeping": { | |
"description": "Check Customer is Sleeping or not", | |
"x-label": { | |
"default": "Is Sleeping" | |
}, | |
"type": "boolean" | |
}, | |
"c_lastAddressModified": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Last Address Modified" | |
}, | |
"type": "string" | |
}, | |
"c_lastNamePronunciation": { | |
"x-label": { | |
"default": "Last Name Pronunciation" | |
}, | |
"type": "string" | |
}, | |
"c_migrationMigrated": { | |
"x-label": { | |
"default": "Migrated To GB" | |
}, | |
"type": "boolean" | |
}, | |
"c_migrationScanned": { | |
"x-label": { | |
"default": "Scanned for GB Migration" | |
}, | |
"type": "boolean" | |
}, | |
"c_narvarSMSSubscription": { | |
"x-label": { | |
"default": "Narvar SMS Subscription" | |
}, | |
"type": "boolean" | |
}, | |
"c_newsletterSubscription": { | |
"x-label": { | |
"default": "Newsletter Subscription" | |
}, | |
"type": "boolean" | |
}, | |
"c_passwordHash": { | |
"description": "(for RU site only)", | |
"x-label": { | |
"default": "Password Hash" | |
}, | |
"type": "string" | |
}, | |
"c_passwordResetRateLimiterLog": { | |
"format": "text", | |
"x-label": { | |
"default": "Password Reset Rate Limiter Log" | |
}, | |
"type": "string" | |
}, | |
"c_phoneSubscription": { | |
"x-label": { | |
"default": "Phone Subscription" | |
}, | |
"type": "boolean" | |
}, | |
"c_rusDataUID": { | |
"x-label": { | |
"default": "rusDataUID" | |
}, | |
"type": "string" | |
}, | |
"c_solvencyDate": { | |
"description": "The last time the Solvency Check was performed", | |
"format": "date-time", | |
"x-label": { | |
"default": "Solvency Date" | |
}, | |
"type": "string" | |
}, | |
"c_solvencyHash": { | |
"description": "The hash of the last Solvency Request sent through", | |
"x-label": { | |
"default": "Solvency Hash" | |
}, | |
"type": "string" | |
}, | |
"c_solvencyResponse": { | |
"description": "The Response object for the last Solvency Request peformed\n ", | |
"format": "text", | |
"x-label": { | |
"default": "Solvency Response" | |
}, | |
"type": "string" | |
}, | |
"c_syncedToMailChimp": { | |
"description": "Flag for job to query", | |
"x-label": { | |
"default": "Synced to mailchimp" | |
}, | |
"type": "boolean" | |
}, | |
"customer_id": { | |
"description": "The customer's number (id).", | |
"maxLength": 100, | |
"type": "string" | |
}, | |
"customer_name": { | |
"description": "", | |
"type": "string" | |
}, | |
"customer_no": { | |
"description": "The customer's number (id).", | |
"x-label": { | |
"default": "Customer No." | |
}, | |
"maxLength": 100, | |
"type": "string" | |
}, | |
"email": { | |
"description": "The customer's email address.", | |
"format": "email", | |
"x-label": { | |
"default": "Email" | |
}, | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"email" | |
] | |
}, | |
"customer_order_result": { | |
"description": "Result document containing an array of customer orders.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"description": "The array of customer order documents.", | |
"items": { | |
"$ref": "#/definitions/order" | |
}, | |
"type": "array" | |
}, | |
"next": { | |
"description": "The URL of the next result page.", | |
"type": "string" | |
}, | |
"previous": { | |
"description": "The URL of the previous result page.", | |
"type": "string" | |
}, | |
"select": { | |
"description": "The fields that you want to select.", | |
"type": "string" | |
}, | |
"start": { | |
"description": "The zero-based index of the first search hit to include in the result.", | |
"format": "int32", | |
"minimum": 0, | |
"type": "integer" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"customer_payment_card_request": { | |
"description": "Document representing a customer payment card request.", | |
"properties": { | |
"card_type": { | |
"description": "The payment card type (for example, 'Visa').", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"credit_card_expired": { | |
"description": "A flag indicating if the credit card is expired.", | |
"type": "boolean" | |
}, | |
"credit_card_token": { | |
"description": "A credit card token. If a credit card is tokenized, the token can be used to look up the credit card data at the\n token store.", | |
"type": "string" | |
}, | |
"expiration_month": { | |
"description": "The month when the payment card expires.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"expiration_year": { | |
"description": "The year when the payment card expires.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"holder": { | |
"description": "The payment card holder.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"issue_number": { | |
"description": "The payment card issue number.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"number": { | |
"description": "The payment card number.", | |
"maxLength": 4000, | |
"type": "string" | |
}, | |
"valid_from_month": { | |
"description": "The payment card valid from month.", | |
"format": "int32", | |
"maximum": 12, | |
"minimum": 1, | |
"type": "integer" | |
}, | |
"valid_from_year": { | |
"description": "The payment card valid from year.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"customer_payment_instrument": { | |
"description": "Document representing a customer payment instrument.", | |
"properties": { | |
"bank_routing_number": { | |
"description": "The bank routing number.", | |
"x-label": { | |
"default": "Bank Routing Number" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"c_adyenCreditCardType": { | |
"description": "Adyen Credit card type", | |
"x-label": { | |
"default": "adyenCreditCardType" | |
}, | |
"type": "string" | |
}, | |
"c_adyenPaymentData": { | |
"description": "adyenPaymentData", | |
"format": "text", | |
"x-label": { | |
"default": "adyenPaymentData" | |
}, | |
"type": "string" | |
}, | |
"c_cardName": { | |
"x-label": { | |
"default": "Card Name" | |
}, | |
"type": "string" | |
}, | |
"c_defaultCard": { | |
"x-label": { | |
"default": "Default Card" | |
}, | |
"type": "boolean" | |
}, | |
"c_paymentOperatorCCBrand": { | |
"x-label": { | |
"default": "PaymentOperator CC Brand", | |
"zh-CN": "Computop 信用卡品牌" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorCCExpiry": { | |
"x-label": { | |
"default": "PaymentOperator CC Expiry date", | |
"zh-CN": "Computop 信用卡有效期" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorCCIssuer": { | |
"x-label": { | |
"default": "PaymentOperator CC Issuer", | |
"zh-CN": "Computop 信用卡发卡行" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorCCNr": { | |
"x-label": { | |
"default": "PaymentOperator Pseudo card number", | |
"zh-CN": "Computop 虚拟卡号" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorOTAccBank": { | |
"x-label": { | |
"default": "PaymentOperator online transfer bank name" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorOTAccIBAN": { | |
"x-label": { | |
"default": "PaymentOperator online transfer bank account number" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorOTAccOwner": { | |
"x-label": { | |
"default": "PaymentOperator online transfer account owner" | |
}, | |
"type": "string" | |
}, | |
"c_subscriptionID": { | |
"x-label": { | |
"default": "CYBS subscriptionID" | |
}, | |
"type": "string" | |
}, | |
"creation_date": { | |
"description": "Returns the value of attribute 'creationDate'.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Creation Date" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"last_modified": { | |
"description": "Returns the value of attribute 'lastModified'.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Last Modified" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"masked_gift_certificate_code": { | |
"description": "The masked gift certificate code.", | |
"type": "string" | |
}, | |
"payment_bank_account": { | |
"$ref": "#/definitions/payment_bank_account", | |
"description": "The payment bank account." | |
}, | |
"payment_card": { | |
"$ref": "#/definitions/payment_card", | |
"description": "The payment card." | |
}, | |
"payment_instrument_id": { | |
"description": "The payment instrument ID.", | |
"type": "string" | |
}, | |
"payment_method_id": { | |
"description": "The payment method id. Optional if a customer payment instrument id is specified.", | |
"maxLength": 256, | |
"type": "string" | |
} | |
} | |
}, | |
"customer_payment_instrument_request": { | |
"description": "Document representing a customer payment instrument request.", | |
"properties": { | |
"bank_routing_number": { | |
"description": "The bank routing number.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"gift_certificate_code": { | |
"description": "The gift certificate code.", | |
"x-label": { | |
"default": "Gift Code" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"payment_bank_account": { | |
"$ref": "#/definitions/payment_bank_account_request", | |
"description": "The payment bank account request data." | |
}, | |
"payment_card": { | |
"$ref": "#/definitions/customer_payment_card_request", | |
"description": "The customer payment card." | |
}, | |
"payment_method_id": { | |
"description": "The payment method id. Optional if a customer payment instrument id is specified.", | |
"maxLength": 256, | |
"type": "string" | |
} | |
} | |
}, | |
"customer_payment_instrument_result": { | |
"description": "Document representing a customer payment instrument result. The payment data contained is masked where needed for security purposes.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"description": "The customer payment instruments list.", | |
"items": { | |
"$ref": "#/definitions/customer_payment_instrument" | |
}, | |
"type": "array" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"customer_product_list": { | |
"description": "Document representing a customer product List.", | |
"properties": { | |
"co_registrant": { | |
"$ref": "#/definitions/customer_product_list_registrant", | |
"description": "The coRegistrant of this product list." | |
}, | |
"creation_date": { | |
"description": "Returns the value of attribute 'creationDate'.", | |
"format": "date-time", | |
"type": "string" | |
}, | |
"current_shipping_address_link": { | |
"$ref": "#/definitions/customer_address_link", | |
"description": "The resource link to the current shipping address of this customer product list." | |
}, | |
"customer_product_list_items": { | |
"description": "The list of customer product list items.", | |
"items": { | |
"$ref": "#/definitions/customer_product_list_item" | |
}, | |
"type": "array" | |
}, | |
"description": { | |
"description": "The description of this product list.", | |
"type": "string" | |
}, | |
"event": { | |
"$ref": "#/definitions/product_list_event", | |
"description": "The event of this product list." | |
}, | |
"id": { | |
"description": "The id of this product list.", | |
"minLength": 1, | |
"type": "string" | |
}, | |
"items_link": { | |
"$ref": "#/definitions/customer_product_list_item_link", | |
"description": "The resource link to the items of this customer product list." | |
}, | |
"last_modified": { | |
"description": "Returns the value of attribute 'lastModified'.", | |
"format": "date-time", | |
"type": "string" | |
}, | |
"name": { | |
"description": "The name of this product list.", | |
"type": "string" | |
}, | |
"post_event_shipping_address_link": { | |
"$ref": "#/definitions/customer_address_link", | |
"description": "The resource link to the post event shipping address of this customer product list." | |
}, | |
"product_list_shipping_address": { | |
"$ref": "#/definitions/product_list_shipping_address", | |
"description": "The abbreviated shipping address of this product list representing what anonymous user can see." | |
}, | |
"public": { | |
"description": "Indicates whether the owner made this product list available for access by other customers.", | |
"type": "boolean" | |
}, | |
"registrant": { | |
"$ref": "#/definitions/customer_product_list_registrant", | |
"description": "The registrant of this product list." | |
}, | |
"shipping_address_link": { | |
"$ref": "#/definitions/customer_address_link", | |
"description": "The resource link to the shipping address of this customer product list." | |
}, | |
"type": { | |
"description": "The type of the product list.", | |
"enum": [ | |
"wish_list", | |
"gift_registry", | |
"shopping_list", | |
"custom_1", | |
"custom_2", | |
"custom_3" | |
], | |
"type": "string" | |
} | |
} | |
}, | |
"customer_product_list_item": { | |
"description": "Document representing a customer product list item.", | |
"properties": { | |
"id": { | |
"description": "The id of this product list item.", | |
"type": "string" | |
}, | |
"priority": { | |
"description": "The priority of the item.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"product": { | |
"$ref": "#/definitions/product", | |
"description": "The product item" | |
}, | |
"product_details_link": { | |
"$ref": "#/definitions/product_simple_link", | |
"description": "A link to the product." | |
}, | |
"product_id": { | |
"description": "The id of the product.", | |
"type": "string" | |
}, | |
"public": { | |
"description": "Is this product list item available for access by other customers?", | |
"type": "boolean" | |
}, | |
"purchased_quantity": { | |
"description": "The quantity of products already purchased.", | |
"format": "double", | |
"type": "number" | |
}, | |
"quantity": { | |
"description": "The quantity of this product list item.", | |
"format": "double", | |
"minimum": 0.0, | |
"type": "number" | |
}, | |
"type": { | |
"description": "The type of the item.", | |
"enum": [ | |
"product", | |
"gift_certificate" | |
], | |
"type": "string" | |
} | |
} | |
}, | |
"customer_product_list_item_link": { | |
"description": "Document representing a customer product list item link.", | |
"properties": { | |
"link": { | |
"description": "The target of the link.", | |
"type": "string" | |
}, | |
"title": { | |
"description": "The link title.", | |
"type": "string" | |
} | |
} | |
}, | |
"customer_product_list_item_purchase": { | |
"description": "Document representing a customer product list item purchase.", | |
"properties": { | |
"id": { | |
"description": "The id of this purchase.", | |
"type": "string" | |
}, | |
"order_no": { | |
"description": "The order number of this purchase.", | |
"type": "string" | |
}, | |
"product_list_item_id": { | |
"description": "The id of the product list item this purchase relates to.", | |
"type": "string" | |
}, | |
"purchaser_name": { | |
"description": "The name of the purchaser.", | |
"type": "string" | |
}, | |
"quantity": { | |
"description": "The quantity of this product list item purchased.", | |
"format": "double", | |
"minimum": 0.0, | |
"type": "number" | |
} | |
} | |
}, | |
"customer_product_list_item_purchase_result": { | |
"description": "Document representing a customer product list purchases result.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"description": "The customer product list item purchases.", | |
"items": { | |
"$ref": "#/definitions/customer_product_list_item_purchase" | |
}, | |
"type": "array" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"customer_product_list_item_result": { | |
"description": "Document representing a customer product list items result.", | |
"properties": { | |
"count": { | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"description": "The customer product list items.", | |
"items": { | |
"$ref": "#/definitions/customer_product_list_item" | |
}, | |
"type": "array" | |
}, | |
"next": { | |
"description": "The URL of the next result page.", | |
"type": "string" | |
}, | |
"previous": { | |
"description": "The URL of the previous result page.", | |
"type": "string" | |
}, | |
"start": { | |
"description": "The zero-based index of the first search hit to include in the result.", | |
"format": "int32", | |
"minimum": 0, | |
"type": "integer" | |
}, | |
"total": { | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"customer_product_list_registrant": { | |
"description": "Document representing a customer product list registrant.", | |
"properties": { | |
"email": { | |
"description": "The email of the registrant.", | |
"type": "string" | |
}, | |
"first_name": { | |
"description": "The first name of the registrant.", | |
"type": "string" | |
}, | |
"last_name": { | |
"description": "The last name of the registrant.", | |
"type": "string" | |
}, | |
"role": { | |
"description": "The role of the registrant.", | |
"type": "string" | |
} | |
} | |
}, | |
"customer_product_list_result": { | |
"description": "Document representing a customer product lists result.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"description": "The customer product lists.", | |
"items": { | |
"$ref": "#/definitions/customer_product_list" | |
}, | |
"type": "array" | |
}, | |
"next": { | |
"type": "string" | |
}, | |
"previous": { | |
"type": "string" | |
}, | |
"start": { | |
"format": "int32", | |
"minimum": 0, | |
"type": "integer" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"customer_registration": { | |
"description": "Document representing the registration information for a customer.", | |
"properties": { | |
"customer": { | |
"$ref": "#/definitions/customer", | |
"description": "The customer registration information.\n The mandatory properties for registration are login, last name and email." | |
}, | |
"password": { | |
"description": "The password to authorize.", | |
"maxLength": 4096, | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"customer" | |
] | |
}, | |
"customers_ext_profile": { | |
"properties": { | |
"authentication_provider_id": { | |
"description": "", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"creation_date": { | |
"format": "date-time", | |
"type": "string" | |
}, | |
"customer_id": { | |
"description": "", | |
"maxLength": 28, | |
"type": "string" | |
}, | |
"email": { | |
"description": "", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"external_id": { | |
"description": "", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"first_name": { | |
"description": "", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"last_modified": { | |
"format": "date-time", | |
"type": "string" | |
}, | |
"last_name": { | |
"description": "", | |
"maxLength": 256, | |
"type": "string" | |
} | |
} | |
}, | |
"discount": { | |
"description": "Document representing a discount that was ", | |
"properties": { | |
"amount": { | |
"description": "The amount that is used with the amount and fixed price types.", | |
"format": "double", | |
"type": "number" | |
}, | |
"percentage": { | |
"description": "The percentage that is used with percentage types.", | |
"format": "double", | |
"type": "number" | |
}, | |
"price_book_id": { | |
"description": "The price book id that is used with some types.", | |
"type": "string" | |
}, | |
"type": { | |
"description": "The type of discount.", | |
"enum": [ | |
"percentage", | |
"fixed_price", | |
"amount", | |
"free", | |
"price_book_price", | |
"bonus", | |
"total_fixed_price", | |
"bonus_choice", | |
"percentage_off_options" | |
], | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"type" | |
] | |
}, | |
"discount_request": { | |
"description": "Document representing a discount to be applied to a custom price adjustment. The properties ", | |
"properties": { | |
"type": { | |
"description": "The type of discount.", | |
"enum": [ | |
"percentage", | |
"fixed_price", | |
"amount" | |
], | |
"type": "string" | |
}, | |
"value": { | |
"description": "The amount of the discount.", | |
"format": "double", | |
"type": "number" | |
} | |
}, | |
"required": [ | |
"type", | |
"value" | |
] | |
}, | |
"filter": { | |
"description": "Document representing a filter.\n " | |
}, | |
"filtered_query": { | |
"description": "A filtered query allows to filter the result of a (possibly complex) query using a (possibly complex) filter.\n ", | |
"properties": { | |
"filter": { | |
"$ref": "#/definitions/filter", | |
"description": "The (possibly complex) filter object.", | |
"x-sub_types": { | |
"range_filter": "#/definitions/range_filter", | |
"bool_filter": "#/definitions/bool_filter", | |
"query_filter": "#/definitions/query_filter", | |
"term_filter": "#/definitions/term_filter", | |
"range2_filter": "#/definitions/range2_filter" | |
} | |
}, | |
"query": { | |
"$ref": "#/definitions/query", | |
"description": "The query object.", | |
"x-sub_types": { | |
"nested_query": "#/definitions/nested_query", | |
"filtered_query": "#/definitions/filtered_query", | |
"text_query": "#/definitions/text_query", | |
"match_all_query": "#/definitions/match_all_query", | |
"term_query": "#/definitions/term_query", | |
"bool_query": "#/definitions/bool_query" | |
} | |
} | |
}, | |
"required": [ | |
"filter", | |
"query" | |
] | |
}, | |
"gift_certificate": { | |
"description": "Document representing a gift certificate.", | |
"properties": { | |
"amount": { | |
"description": "The gift certificate original amount.", | |
"format": "double", | |
"type": "number" | |
}, | |
"balance": { | |
"description": "The gift certificate balance.", | |
"format": "double", | |
"type": "number" | |
}, | |
"c_adminTransactionHistory": { | |
"format": "text", | |
"x-label": { | |
"default": "Admin Transaction History" | |
}, | |
"type": "string" | |
}, | |
"c_customerCreditGiftCertificate": { | |
"x-label": { | |
"default": "Customer Credit Gift Certificate" | |
}, | |
"type": "boolean" | |
}, | |
"description": { | |
"description": "The gift certificate description.", | |
"x-label": { | |
"default": "Description" | |
}, | |
"type": "string" | |
}, | |
"enabled": { | |
"description": "Is the gift certificate is enabled?", | |
"x-label": { | |
"default": "Enabled" | |
}, | |
"type": "boolean" | |
}, | |
"masked_gift_certificate_code": { | |
"description": "The masked gift certificate code.", | |
"x-label": { | |
"default": "Gift Certificate Code" | |
}, | |
"type": "string" | |
}, | |
"merchant_id": { | |
"description": "The merchant ID.", | |
"x-label": { | |
"default": "Merchant ID" | |
}, | |
"type": "string" | |
}, | |
"message": { | |
"description": "The message.", | |
"x-label": { | |
"default": "Message" | |
}, | |
"type": "string" | |
}, | |
"recipient_email": { | |
"description": "The recipient email.", | |
"x-label": { | |
"default": "Recipient Email" | |
}, | |
"type": "string" | |
}, | |
"recipient_name": { | |
"description": "The recipient name.", | |
"x-label": { | |
"default": "Recipient Name" | |
}, | |
"type": "string" | |
}, | |
"sender_name": { | |
"description": "The sender name.", | |
"x-label": { | |
"default": "Sender Name" | |
}, | |
"type": "string" | |
}, | |
"status": { | |
"description": "The gift certificate status.", | |
"enum": [ | |
"pending", | |
"issued", | |
"partially_redeemed", | |
"redeemed" | |
], | |
"x-label": { | |
"default": "Status" | |
}, | |
"type": "string" | |
} | |
} | |
}, | |
"gift_certificate_item": { | |
"description": "A gift certificate item.", | |
"properties": { | |
"amount": { | |
"description": "The certificate item amount.", | |
"format": "double", | |
"type": "number" | |
}, | |
"c_gcInitialCurrency": { | |
"x-label": { | |
"default": "Currency code while add to cart" | |
}, | |
"type": "string" | |
}, | |
"c_radialGiftCardProductId": { | |
"x-label": { | |
"default": "Radial Gift Card Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_radialLineItemTaxXML": { | |
"description": "The XML information that comes back from the tax call for the line item. This data needs to be preserved so it can be later used for the order creation webservice call.", | |
"format": "text", | |
"x-label": { | |
"default": "Radial LineItem Tax XML" | |
}, | |
"type": "string" | |
}, | |
"c_radialMerchandiseTaxes": { | |
"format": "text", | |
"x-label": { | |
"default": "Radial Merchandise Taxes" | |
}, | |
"type": "string" | |
}, | |
"c_radialShippingTaxes": { | |
"format": "text", | |
"x-label": { | |
"default": "Radial Shipping Taxes" | |
}, | |
"type": "string" | |
}, | |
"gift_certificate_item_id": { | |
"description": "Id used to identify this item", | |
"type": "string" | |
}, | |
"message": { | |
"description": "The certificate's message.", | |
"x-label": { | |
"default": "Message" | |
}, | |
"maxLength": 4000, | |
"type": "string" | |
}, | |
"recipient_email": { | |
"description": "The recipient's email.", | |
"x-label": { | |
"default": "Recipient Email" | |
}, | |
"minLength": 1, | |
"type": "string" | |
}, | |
"recipient_name": { | |
"description": "The recipient's name.", | |
"x-label": { | |
"default": "Recipient Name" | |
}, | |
"type": "string" | |
}, | |
"sender_name": { | |
"description": "The sender's name.", | |
"x-label": { | |
"default": "Sender Name" | |
}, | |
"type": "string" | |
}, | |
"shipment_id": { | |
"description": "The shipment id.", | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"amount", | |
"recipient_email" | |
] | |
}, | |
"gift_certificate_request": { | |
"description": "Document representing a gift certificate request data.", | |
"properties": { | |
"gift_certificate_code": { | |
"description": "The gift certificate code.", | |
"type": "string" | |
} | |
} | |
}, | |
"image": { | |
"properties": { | |
"alt": { | |
"type": "string" | |
}, | |
"dis_base_link": { | |
"type": "string" | |
}, | |
"link": { | |
"minLength": 1, | |
"type": "string" | |
}, | |
"title": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"link" | |
] | |
}, | |
"image_group": { | |
"description": "Document representing an image group containing a list of images for a particular view type and an optional variation value.", | |
"properties": { | |
"images": { | |
"description": "The images of the image group.", | |
"items": { | |
"$ref": "#/definitions/image" | |
}, | |
"type": "array" | |
}, | |
"variation_attributes": { | |
"description": "Returns a list of variation attributes applying to this image group.", | |
"items": { | |
"$ref": "#/definitions/variation_attribute" | |
}, | |
"type": "array" | |
}, | |
"view_type": { | |
"description": "The image view type.", | |
"type": "string" | |
} | |
} | |
}, | |
"inventory": { | |
"description": "Document representing inventory information of the current product for a particular inventory list.", | |
"properties": { | |
"ats": { | |
"description": "The ats of the product. If it is infinity, the return value is 999999. The value can be overwritten by the\n OCAPI setting 'product.inventory.ats.max_threshold'.", | |
"format": "double", | |
"type": "number" | |
}, | |
"backorderable": { | |
"description": "A flag indicating whether the product is back orderable.", | |
"type": "boolean" | |
}, | |
"id": { | |
"description": "The inventory id.", | |
"type": "string" | |
}, | |
"in_stock_date": { | |
"description": "A flag indicating the date when the product will be in stock.", | |
"format": "date-time", | |
"type": "string" | |
}, | |
"orderable": { | |
"description": "A flag indicating whether at least one of products is available to sell.", | |
"type": "boolean" | |
}, | |
"preorderable": { | |
"description": "A flag indicating whether the product is pre orderable.", | |
"type": "boolean" | |
}, | |
"stock_level": { | |
"description": "The stock level of the product. If it is infinity, the return value is 999999. The value can be overwritten by the\n OCAPI setting 'product.inventory.stock_level.max_threshold'.", | |
"format": "double", | |
"type": "number" | |
} | |
}, | |
"required": [ | |
"id" | |
] | |
}, | |
"locale": { | |
"description": "Document that describes a single locale.", | |
"properties": { | |
"country": { | |
"description": "The uppercase ISO 3166 2-letter country/region code for this Locale.\n If no country has been specified for this Locale, this value is an empty string.", | |
"type": "string" | |
}, | |
"default": { | |
"description": "Flag that is true if this locale is the default to use if a locale is not specified.", | |
"type": "boolean" | |
}, | |
"display_country": { | |
"description": "The display name of this Locale's country, in this Locale's language,\n not in the session locale's language.\n If no country has been specified for this Locale, this value is an empty string.", | |
"type": "string" | |
}, | |
"display_language": { | |
"description": "The display name of this Locale's language, in this Locale's language,\n not in the session locale's language.\n If no country has been specified for this Locale, this value is an empty string.", | |
"type": "string" | |
}, | |
"display_name": { | |
"description": "The display name of this Locale, in this Locale's language,\n not in the session locale's language.\n If no display name has been specified for this Locale, this value is an empty string.", | |
"type": "string" | |
}, | |
"id": { | |
"description": "The identifier of the Locale. Combines the\n language and the country key, concatenated with \"-\". For example: \"en-US\". \n This attribute is the primary key of the class.", | |
"type": "string" | |
}, | |
"iso3_country": { | |
"description": "The uppercase ISO 3166 3-letter country/region code for this Locale.\n If no country has been specified for this Locale, this value is an empty string.", | |
"type": "string" | |
}, | |
"iso3_language": { | |
"description": "The 3-letter ISO 639 language code for this Locale.\n If no language has been specified for this Locale, this value is an empty string.", | |
"type": "string" | |
}, | |
"language": { | |
"description": "The lowercase ISO 639 language code for this Locale.\n If no language has been specified for this Locale, this value is an empty string.", | |
"type": "string" | |
}, | |
"name": { | |
"description": "The display name of the Locale. Uses the current\n request locale to localize the value.", | |
"type": "string" | |
} | |
} | |
}, | |
"master": { | |
"properties": { | |
"link": { | |
"type": "string" | |
}, | |
"master_id": { | |
"maxLength": 100, | |
"minLength": 1, | |
"type": "string" | |
}, | |
"orderable": { | |
"type": "boolean" | |
}, | |
"price": { | |
"format": "double", | |
"type": "number" | |
}, | |
"price_max": { | |
"format": "double", | |
"type": "number" | |
}, | |
"price_per_unit": { | |
"format": "double", | |
"type": "number" | |
}, | |
"price_per_unit_max": { | |
"format": "double", | |
"type": "number" | |
}, | |
"prices": { | |
"additionalProperties": { | |
"format": "double", | |
"type": "number" | |
}, | |
"type": "object" | |
} | |
}, | |
"required": [ | |
"master_id" | |
] | |
}, | |
"match_all_query": { | |
"description": "A match all query simply matches all documents (namespace and document type). This query comes in\n handy if you just want to filter a search result or really do not have any constraints.\n\n " | |
}, | |
"nested_query": { | |
"description": "A nested query queries nested documents that are part of a larger document. The classical example is a\n product master with variants (in one big document) where you want to constrain a search to masters that have\n variants that match multiple constraints (like color = blue AND size = M).\n This query is not compatible with some search types. \n ", | |
"properties": { | |
"path": { | |
"description": "", | |
"type": "string" | |
}, | |
"query": { | |
"$ref": "#/definitions/query", | |
"description": "", | |
"x-sub_types": { | |
"nested_query": "#/definitions/nested_query", | |
"filtered_query": "#/definitions/filtered_query", | |
"text_query": "#/definitions/text_query", | |
"match_all_query": "#/definitions/match_all_query", | |
"term_query": "#/definitions/term_query", | |
"bool_query": "#/definitions/bool_query" | |
} | |
}, | |
"score_mode": { | |
"description": "", | |
"enum": [ | |
"avg", | |
"total", | |
"max", | |
"none" | |
], | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"path", | |
"query" | |
] | |
}, | |
"note": { | |
"description": "Document representing a note to an object.", | |
"properties": { | |
"created_by": { | |
"description": "The author of the note.", | |
"type": "string" | |
}, | |
"creation_date": { | |
"description": "The creation date of the note.", | |
"format": "date-time", | |
"type": "string" | |
}, | |
"id": { | |
"description": "The ID of the note.", | |
"type": "string" | |
}, | |
"subject": { | |
"description": "The note's subject.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"text": { | |
"description": "The note's text.", | |
"maxLength": 4000, | |
"type": "string" | |
} | |
} | |
}, | |
"notes_result": { | |
"description": "A result of a note request.\n\n Contains notes for an object - for example, for a basket.", | |
"properties": { | |
"notes": { | |
"description": "The notes for an object.", | |
"items": { | |
"$ref": "#/definitions/note" | |
}, | |
"type": "array" | |
} | |
} | |
}, | |
"option": { | |
"description": "Document representing a product option.", | |
"properties": { | |
"description": { | |
"description": "The localized description of the option.", | |
"type": "string" | |
}, | |
"id": { | |
"description": "The id of the option.", | |
"maxLength": 100, | |
"minLength": 1, | |
"type": "string" | |
}, | |
"image": { | |
"description": "The URL to the option image.", | |
"type": "string" | |
}, | |
"name": { | |
"description": "The localized name of the option.", | |
"type": "string" | |
}, | |
"values": { | |
"description": "The array of option values. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/option_value" | |
}, | |
"type": "array" | |
} | |
}, | |
"required": [ | |
"id" | |
] | |
}, | |
"option_item": { | |
"description": "Document representing an option item.", | |
"properties": { | |
"adjusted_tax": { | |
"description": "The tax of the product item after adjustments applying.", | |
"format": "double", | |
"type": "number" | |
}, | |
"base_price": { | |
"description": "The base price for the line item, which is the\n price of the unit before applying adjustments, in the purchase\n currency. The base price may be net or gross of tax depending\n on the configured taxation policy.", | |
"format": "double", | |
"type": "number" | |
}, | |
"bonus_discount_line_item_id": { | |
"description": "The id of the bonus discount line item this bonus product relates to.", | |
"type": "string" | |
}, | |
"bonus_product_line_item": { | |
"description": "A flag indicating whether the product item is a bonus.", | |
"type": "boolean" | |
}, | |
"bundled_product_items": { | |
"description": "The array of bundled product items. Can be empty.", | |
"items": { | |
"$ref": "#/definitions/product_item" | |
}, | |
"type": "array" | |
}, | |
"gift": { | |
"description": "Returns true if the item is a gift.", | |
"type": "boolean" | |
}, | |
"gift_message": { | |
"description": "The gift message.", | |
"type": "string" | |
}, | |
"inventory_id": { | |
"description": "The inventory list id associated with this item.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"item_id": { | |
"description": "The item identifier. Use this to identify an item when updating the item quantity or creating a custom price\n adjustment for an item.", | |
"type": "string" | |
}, | |
"item_text": { | |
"description": "The text describing the item in more detail.", | |
"type": "string" | |
}, | |
"option_id": { | |
"description": "The id of the option.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"option_items": { | |
"description": "The array of option items. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/option_item" | |
}, | |
"type": "array" | |
}, | |
"option_value_id": { | |
"description": "The id of the option value.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"price": { | |
"description": "The price of the line item before applying any adjustments. If the line item is based on net pricing\n then the net price is returned. If the line item is based on gross\n pricing then the gross price is returned.", | |
"format": "double", | |
"type": "number" | |
}, | |
"price_adjustments": { | |
"description": "Array of price adjustments. Can be empty.", | |
"items": { | |
"$ref": "#/definitions/price_adjustment" | |
}, | |
"type": "array" | |
}, | |
"price_after_item_discount": { | |
"description": "The price of the product line item after applying all product-level\n adjustments. For net pricing the adjusted net price is returned. For gross pricing, the adjusted\n gross price is returned.", | |
"format": "double", | |
"type": "number" | |
}, | |
"price_after_order_discount": { | |
"description": "The price of this product line item after considering all\n dependent price adjustments and prorating all order-level\n price adjustments. For net pricing the net price is returned. For gross\n pricing, the gross price is returned.", | |
"format": "double", | |
"type": "number" | |
}, | |
"product_id": { | |
"description": "", | |
"maxLength": 100, | |
"type": "string" | |
}, | |
"product_list_item": { | |
"$ref": "#/definitions/product_list_item_reference", | |
"description": "" | |
}, | |
"product_name": { | |
"description": "The name of the product.", | |
"type": "string" | |
}, | |
"quantity": { | |
"description": "The quantity of the products represented by this item.", | |
"format": "double", | |
"maximum": 999.0, | |
"minimum": 0.0, | |
"type": "number" | |
}, | |
"shipment_id": { | |
"description": "The id of the shipment which includes the product item.", | |
"type": "string" | |
}, | |
"shipping_item_id": { | |
"description": "The reference to the related shipping item if it exists. This is the case if for example when a surcharge is\n defined for individual products using a particular a shipping method.", | |
"type": "string" | |
}, | |
"tax": { | |
"description": "The tax of the product item before adjustments applying.", | |
"format": "double", | |
"type": "number" | |
}, | |
"tax_basis": { | |
"description": "The price used to calculate the tax for this product item.", | |
"format": "double", | |
"type": "number" | |
}, | |
"tax_class_id": { | |
"description": "The tax class ID for the product item or null\n if no tax class ID is associated with the product item.", | |
"type": "string" | |
}, | |
"tax_rate": { | |
"description": "The tax rate, which is the decimal tax rate to be applied\n to the product represented by this item.", | |
"format": "double", | |
"type": "number" | |
} | |
}, | |
"required": [ | |
"option_id", | |
"option_value_id" | |
] | |
}, | |
"option_value": { | |
"description": "Document representing an option value.", | |
"properties": { | |
"default": { | |
"description": "A flag indicating whether this option value is the default one.", | |
"type": "boolean" | |
}, | |
"id": { | |
"description": "The id of the option value.", | |
"maxLength": 100, | |
"minLength": 1, | |
"type": "string" | |
}, | |
"name": { | |
"description": "The localized name of the option value.", | |
"type": "string" | |
}, | |
"price": { | |
"description": "The effective price of this option value.", | |
"format": "double", | |
"type": "number" | |
} | |
}, | |
"required": [ | |
"id" | |
] | |
}, | |
"order": { | |
"description": "Document representing an order.", | |
"properties": { | |
"adjusted_merchandize_total_tax": { | |
"description": "The products tax after discounts applying in purchase currency.\n\n Adjusted merchandize prices represent the sum of product prices before\n services such as shipping have been added, but after adjustment from\n promotions have been added.", | |
"format": "double", | |
"type": "number" | |
}, | |
"adjusted_shipping_total_tax": { | |
"description": "The tax of all shipping line items of the line item container after\n shipping adjustments have been applied.", | |
"format": "double", | |
"type": "number" | |
}, | |
"billing_address": { | |
"$ref": "#/definitions/order_address", | |
"description": "The billing address. This property is part of basket checkout information only." | |
}, | |
"bonus_discount_line_items": { | |
"description": "The bonus discount line items of the line item container.", | |
"items": { | |
"$ref": "#/definitions/bonus_discount_line_item" | |
}, | |
"type": "array" | |
}, | |
"c_Adyen_CustomerEmail": { | |
"description": "Confirmation email to shopper", | |
"format": "text", | |
"x-label": { | |
"default": "Adyen Customer email" | |
}, | |
"type": "string" | |
}, | |
"c_Adyen_donationAmount": { | |
"description": "Amount donated via Adyen Giving", | |
"format": "text", | |
"x-label": { | |
"default": "Adyen donation amount" | |
}, | |
"type": "string" | |
}, | |
"c_Adyen_eventCode": { | |
"description": "AUTHORISATION, CANCELLATION, REFUND", | |
"x-label": { | |
"default": "eventCode" | |
}, | |
"type": "string" | |
}, | |
"c_Adyen_paymentMethod": { | |
"description": "paymentMethod used by shopper", | |
"x-label": { | |
"default": "paymentMethod" | |
}, | |
"type": "string" | |
}, | |
"c_Adyen_pspReference": { | |
"description": "Internal Adyen ID", | |
"x-label": { | |
"default": "pspReference" | |
}, | |
"type": "string" | |
}, | |
"c_Adyen_value": { | |
"description": "Amount paid (divide by 100)", | |
"x-label": { | |
"default": "Amount" | |
}, | |
"type": "string" | |
}, | |
"c_OrderCancelDate": { | |
"x-label": { | |
"default": "OrderCancelDate" | |
}, | |
"type": "string" | |
}, | |
"c_OrderCancelProducts": { | |
"x-label": { | |
"default": "OrderCancelProducts" | |
}, | |
"type": "string" | |
}, | |
"c_OrderCancelReason": { | |
"x-label": { | |
"default": "OrderCancelReason" | |
}, | |
"type": "string" | |
}, | |
"c_OrderDeliveredDate": { | |
"x-label": { | |
"default": "OrderDeliveredDate" | |
}, | |
"type": "string" | |
}, | |
"c_OrderOMSProCancelStatus": { | |
"x-label": { | |
"default": "OrderOMSProCancelStatus" | |
}, | |
"type": "string" | |
}, | |
"c_OrderOMSProReturnStatus": { | |
"x-label": { | |
"default": "OrderOMSProReturnStatus" | |
}, | |
"type": "string" | |
}, | |
"c_OrderOMSProStatus": { | |
"x-label": { | |
"default": "OrderOMSProStatus" | |
}, | |
"type": "string" | |
}, | |
"c_OrderReturnDate": { | |
"x-label": { | |
"default": "OrderReturnDate" | |
}, | |
"type": "string" | |
}, | |
"c_OrderReturnExchangeJSON": { | |
"format": "text", | |
"type": "string" | |
}, | |
"c_OrderReturnProducts": { | |
"x-label": { | |
"default": "OrderReturnProducts" | |
}, | |
"type": "string" | |
}, | |
"c_OrderReturnReason": { | |
"x-label": { | |
"default": "OrderReturnReason" | |
}, | |
"type": "string" | |
}, | |
"c_OrderShipDate": { | |
"x-label": { | |
"default": "OrderShipDate" | |
}, | |
"type": "string" | |
}, | |
"c_RadialJavascriptData": { | |
"description": "Radial Fraud Device ID", | |
"x-label": { | |
"default": "Radial Fraud Device ID" | |
}, | |
"type": "string" | |
}, | |
"c_RadialOrderContext": { | |
"format": "text", | |
"x-label": { | |
"default": "RadialOrderContext" | |
}, | |
"type": "string" | |
}, | |
"c_RadialTaxCallSuccess": { | |
"x-label": { | |
"default": "Radial Tax Call Success" | |
}, | |
"type": "string" | |
}, | |
"c_RadialTaxTransactionId": { | |
"x-label": { | |
"default": "Radial Tax Transaction Id" | |
}, | |
"type": "string" | |
}, | |
"c_agentUser": { | |
"description": "Customer Service Agent who placed the order", | |
"x-label": { | |
"default": "Agent User" | |
}, | |
"type": "string" | |
}, | |
"c_amazonAuthorizationID": { | |
"x-label": { | |
"default": "Amazon Pay Authorization ID" | |
}, | |
"type": "string" | |
}, | |
"c_amazonAuthorizationStatus": { | |
"x-label": { | |
"default": "Amazon Pay Authorization Status" | |
}, | |
"type": "string" | |
}, | |
"c_amazonCaptureID": { | |
"x-label": { | |
"default": "Amazon Pay Capture Id" | |
}, | |
"type": "string" | |
}, | |
"c_amazonCaptureStatus": { | |
"x-label": { | |
"default": "Amazon Pay Capture Status" | |
}, | |
"type": "string" | |
}, | |
"c_amazonLastAuthorized": { | |
"description": "Last authorized timestamp for AmazonPay", | |
"format": "date-time", | |
"x-label": { | |
"default": "Amazon Pay Last Authorized" | |
}, | |
"type": "string" | |
}, | |
"c_amazonOrderReferenceID": { | |
"x-label": { | |
"default": "Amazon Pay Order Reference ID" | |
}, | |
"type": "string" | |
}, | |
"c_amazonOrderReferenceStatus": { | |
"x-label": { | |
"default": "Amazon Pay OrderReference Status" | |
}, | |
"type": "string" | |
}, | |
"c_apIsAfterpayOrder": { | |
"description": "Determines if this is an Afterpay order", | |
"x-label": { | |
"default": "Afterpay Payment Method" | |
}, | |
"type": "boolean" | |
}, | |
"c_appOrder": { | |
"description": "Used as an identifier on reporting to differentiate between , mobile app based orders and web orders.", | |
"x-label": { | |
"default": "appOrder" | |
}, | |
"type": "boolean" | |
}, | |
"c_bvSentInPPEFeed": { | |
"x-label": { | |
"default": "Whether order already sent in Bazaarvoice PPE feed or not" | |
}, | |
"type": "boolean" | |
}, | |
"c_cancellationEmailSentDate": { | |
"description": "Logs the datetime the cancellation email is sent. Null/empty until\n then.\n ", | |
"format": "date-time", | |
"x-label": { | |
"default": "Cancellation Email Sent Date" | |
}, | |
"type": "string" | |
}, | |
"c_capillaryDailyExportFlag": { | |
"x-label": { | |
"default": "Capillary Daily Export Flag" | |
}, | |
"type": "boolean" | |
}, | |
"c_capillaryRegularExportFlag": { | |
"x-label": { | |
"default": "Capillary Regular Export Flag" | |
}, | |
"type": "boolean" | |
}, | |
"c_cooperationStatus": { | |
"type": "string" | |
}, | |
"c_dataPurged": { | |
"description": "(for Russian site only)", | |
"x-label": { | |
"default": "Order Data Purged" | |
}, | |
"type": "boolean" | |
}, | |
"c_exchangeDeadlineDate": { | |
"description": "Exchange Deadline Date", | |
"format": "date-time", | |
"x-label": { | |
"default": "Exchange Deadline Date" | |
}, | |
"type": "string" | |
}, | |
"c_exportedOrderFeed": { | |
"description": "for RU site only", | |
"x-label": { | |
"default": "Order feed was exported" | |
}, | |
"type": "boolean" | |
}, | |
"c_externalPaymentInfo": { | |
"description": "JSON string of payment transactions for Feige", | |
"x-label": { | |
"default": "External Payment Info" | |
}, | |
"type": "string" | |
}, | |
"c_extoleApproveSentStatus": { | |
"description": "true if Extole Status Update call was made", | |
"x-label": { | |
"default": "Is Extole Approve Status Sent" | |
}, | |
"type": "boolean" | |
}, | |
"c_failedCustomOrderStatus": { | |
"description": "Export Failed Order Custom Status", | |
"x-label": { | |
"default": "Export Failed Order Custom Status" | |
}, | |
"type": "string" | |
}, | |
"c_failedOrderStatus": { | |
"x-label": { | |
"default": "Failed order status" | |
}, | |
"type": "boolean" | |
}, | |
"c_failedcustomOrderStatus": { | |
"description": "Export Failed Order Custom Status", | |
"x-label": { | |
"default": "Export Failed Order Custom Status" | |
}, | |
"type": "string" | |
}, | |
"c_forterDecision": { | |
"enum": [ | |
"NOT_SENT", | |
"APPROVED", | |
"DECLINED", | |
"NOT_REVIEWED", | |
"FAILED", | |
"ERROR" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Not sent" | |
}, | |
{ | |
"default": "Approved" | |
}, | |
{ | |
"default": "Declined" | |
}, | |
{ | |
"default": "Not reviewed" | |
}, | |
{ | |
"default": "Failed" | |
}, | |
{ | |
"default": "Error" | |
} | |
], | |
"x-label": { | |
"default": "Forter decision" | |
}, | |
"type": "string" | |
}, | |
"c_forterOrderLink": { | |
"description": "Forter Order Link", | |
"x-label": { | |
"default": "Forter Order Link" | |
}, | |
"type": "string" | |
}, | |
"c_forterOrderStatus": { | |
"description": "Order Status when the last forter call was made", | |
"format": "int32", | |
"x-label": { | |
"default": "Forter Order Status" | |
}, | |
"type": "integer" | |
}, | |
"c_forterRemoteStatusRequest": { | |
"enum": [ | |
0, | |
3, | |
4, | |
5, | |
6, | |
7, | |
8 | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "PROCESSING" | |
}, | |
{ | |
"default": "PROCESSING" | |
}, | |
{ | |
"default": "PROCESSING" | |
}, | |
{ | |
"default": "COMPLETED" | |
}, | |
{ | |
"default": "CANCELED_BY_MERCHANT" | |
}, | |
{ | |
"default": "CANCELED_BY_MERCHANT" | |
}, | |
{ | |
"default": "CANCELED_BY_MERCHANT" | |
} | |
], | |
"format": "int32", | |
"x-label": { | |
"default": "Mapping to Forter statuses according the order status" | |
}, | |
"type": "integer" | |
}, | |
"c_forterRetryNumber": { | |
"description": "Store the first 6 digits to be able to retry the request to forter if there was a timeout in the checkout request.", | |
"x-label": { | |
"default": "Retry number" | |
}, | |
"type": "string" | |
}, | |
"c_forterTokenCookie": { | |
"x-label": { | |
"default": "Forter Token Cookie" | |
}, | |
"type": "string" | |
}, | |
"c_forterUserAgent": { | |
"x-label": { | |
"default": "Forter User Agent" | |
}, | |
"type": "string" | |
}, | |
"c_geAllowDirectCommunicationFromMerchant": { | |
"description": "Indicates if the end customer has opted on Global-e checkout to receive direct communication from the Merchant.", | |
"x-label": { | |
"default": "Allow Direct Communication from Merchant" | |
}, | |
"type": "boolean" | |
}, | |
"c_geAllowEmailsFromMerchant": { | |
"description": "Indicates if the end customer has opted on Global-e checkout to receive emails from the Merchant.", | |
"x-label": { | |
"default": "Allow Emails from Merchant" | |
}, | |
"type": "boolean" | |
}, | |
"c_geBarCode": { | |
"x-label": { | |
"default": "Global-e BarCode" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingAddress1": { | |
"description": "Address line 1", | |
"x-label": { | |
"default": "address 1" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingAddress2": { | |
"description": "Address line 2", | |
"x-label": { | |
"default": "address 2" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingCity": { | |
"description": "City name", | |
"x-label": { | |
"default": "city" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingCityRegion": { | |
"description": "Billing City Region", | |
"x-label": { | |
"default": "City Region" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingCompany": { | |
"description": "Company name", | |
"x-label": { | |
"default": "company" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingCountryCode": { | |
"description": "2-char ISO country code", | |
"x-label": { | |
"default": "country code" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingCountryName": { | |
"description": "Country name", | |
"x-label": { | |
"default": "country name" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingEmail": { | |
"description": "E-mail address", | |
"x-label": { | |
"default": "email" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingFax": { | |
"description": "Fax", | |
"x-label": { | |
"default": "fax" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingFirstName": { | |
"description": "First name", | |
"x-label": { | |
"default": "first name" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingLastName": { | |
"description": "Last name", | |
"x-label": { | |
"default": "Last name" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingMiddleName": { | |
"description": "Middle name", | |
"x-label": { | |
"default": "middle name" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingPhone1": { | |
"description": "Phone 1", | |
"x-label": { | |
"default": "phone 1" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingPhone2": { | |
"description": "Phone 2", | |
"x-label": { | |
"default": "phone 2" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingSalutation": { | |
"description": "Salutation", | |
"x-label": { | |
"default": "salutation" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingStateCode": { | |
"description": "State code", | |
"x-label": { | |
"default": "state code" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingStateOrProvince": { | |
"description": "State or province", | |
"x-label": { | |
"default": "state or province" | |
}, | |
"type": "string" | |
}, | |
"c_geBillingZip": { | |
"description": "Zip code", | |
"x-label": { | |
"default": "Zip" | |
}, | |
"type": "string" | |
}, | |
"c_geCartId": { | |
"description": "Identifier of the cart on the Merchant’s site originally specified in geMerchantCartToken argument for SendCart method for the cart converted to this order on Global-e", | |
"x-label": { | |
"default": "Cart ID" | |
}, | |
"type": "string" | |
}, | |
"c_geCartToken": { | |
"description": "The token exchanged within the SendCart API call to display the Global-e checkout iframe.", | |
"x-label": { | |
"default": "Global-e Cart Token" | |
}, | |
"type": "string" | |
}, | |
"c_geCashOnDeliveryFee": { | |
"description": "Additional charge paid by the end customer when “Cash on Delivery” payment method has been selected.", | |
"format": "double", | |
"x-label": { | |
"default": "CashOnDeliveryFee" | |
}, | |
"type": "number" | |
}, | |
"c_geCcfPrice": { | |
"description": "Customs Clearance Fees (CCF), in the merchant currency", | |
"format": "double", | |
"x-label": { | |
"default": "CCF Price" | |
}, | |
"type": "number" | |
}, | |
"c_geConsignmentFee": { | |
"description": "Consignment fee paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.", | |
"format": "double", | |
"x-label": { | |
"default": "Consignment Fee" | |
}, | |
"type": "number" | |
}, | |
"c_geCurrencyCode": { | |
"description": "3-char ISO currency code for the order being posted. By default this is set to the original Merchant’s currency", | |
"x-label": { | |
"default": "Global-e Currency Code" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingAddress1": { | |
"description": "Address1", | |
"x-label": { | |
"default": "Address1" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingAddress2": { | |
"description": "Address2", | |
"x-label": { | |
"default": "Address2" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingCity": { | |
"description": "City", | |
"x-label": { | |
"default": "City" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingCityRegion": { | |
"description": "Customer Billing City Region", | |
"x-label": { | |
"default": "City Region" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingCompany": { | |
"description": "Company", | |
"x-label": { | |
"default": "Company" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingCountryCode": { | |
"description": "Country code", | |
"x-label": { | |
"default": "Country code" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingCountryName": { | |
"description": "Country name", | |
"x-label": { | |
"default": "Country name" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingEmail": { | |
"description": "Email", | |
"x-label": { | |
"default": "Email" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingFax": { | |
"description": "Fax", | |
"x-label": { | |
"default": "Fax" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingFirstName": { | |
"description": "First name", | |
"x-label": { | |
"default": "First name" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingLastName": { | |
"description": "Last name", | |
"x-label": { | |
"default": "Last name" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingMiddleName": { | |
"description": "Middle name", | |
"x-label": { | |
"default": "Middle name" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingPhone1": { | |
"description": "Phone1", | |
"x-label": { | |
"default": "Phone1" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingPhone2": { | |
"description": "Phone2", | |
"x-label": { | |
"default": "Phone2" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingSalutation": { | |
"description": "Salutation", | |
"x-label": { | |
"default": "Salutation" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingStateCode": { | |
"description": "State code", | |
"x-label": { | |
"default": "State code" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingStateOrProvince": { | |
"description": "State or province", | |
"x-label": { | |
"default": "State or province" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerBillingZip": { | |
"description": "Zip", | |
"x-label": { | |
"default": "Zip" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerComments": { | |
"description": "Comments text entered by the end customer in Global-e checkout", | |
"format": "text", | |
"x-label": { | |
"default": "Customer Comments" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerCurrencyCode": { | |
"description": "3-char ISO code for the currency selected by the end customer for the order payment", | |
"x-label": { | |
"default": "Customer Currency Code" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingAddress1": { | |
"description": "Address1", | |
"x-label": { | |
"default": "Address1" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingAddress2": { | |
"description": "Address2", | |
"x-label": { | |
"default": "Address2" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingCity": { | |
"description": "City", | |
"x-label": { | |
"default": "City" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingCityRegion": { | |
"description": "Customer Shipping City Region", | |
"x-label": { | |
"default": "City Region" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingCompany": { | |
"description": "Company", | |
"x-label": { | |
"default": "Company" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingCountryCode": { | |
"description": "Country code", | |
"x-label": { | |
"default": "Country code" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingCountryName": { | |
"description": "Country name", | |
"x-label": { | |
"default": "Country name" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingEmail": { | |
"description": "Email", | |
"x-label": { | |
"default": "Email" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingFax": { | |
"description": "Fax", | |
"x-label": { | |
"default": "Fax" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingFirstName": { | |
"description": "First name", | |
"x-label": { | |
"default": "First name" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingLastName": { | |
"description": "Last name", | |
"x-label": { | |
"default": "Last name" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingMiddleName": { | |
"description": "Middle name", | |
"x-label": { | |
"default": "Middle name" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingPhone1": { | |
"description": "Phone1", | |
"x-label": { | |
"default": "Phone1" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingPhone2": { | |
"description": "Phone2", | |
"x-label": { | |
"default": "Phone2" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingSalutation": { | |
"description": "Salutation", | |
"x-label": { | |
"default": "Salutation" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingStateCode": { | |
"description": "State code", | |
"x-label": { | |
"default": "State code" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingStateOrProvince": { | |
"description": "State or province", | |
"x-label": { | |
"default": "State or province" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerShippingZip": { | |
"description": "Zip", | |
"x-label": { | |
"default": "Zip" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerUSSalesTax": { | |
"description": "Sales tax value for USA in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice.", | |
"format": "double", | |
"x-label": { | |
"default": "Sales tax value for USA" | |
}, | |
"type": "number" | |
}, | |
"c_geDeliveryDaysFrom": { | |
"description": "Minimum number of days for delivery to the end customer for the selected shipping method.", | |
"format": "int32", | |
"x-label": { | |
"default": "Delivery Days From" | |
}, | |
"type": "integer" | |
}, | |
"c_geDeliveryDaysTo": { | |
"description": "Maximum number of days for delivery to the end customer for the selected shipping method.", | |
"format": "int32", | |
"x-label": { | |
"default": "Delivery Days To" | |
}, | |
"type": "integer" | |
}, | |
"c_geDeliveryStoreId": { | |
"description": "Delivery Store ID", | |
"x-label": { | |
"default": "Delivery Store ID" | |
}, | |
"type": "string" | |
}, | |
"c_geDiscountedShippingPriceMerchantCurrency": { | |
"description": "The shipping price paid by the customer converted to the merchant’s currency. Total Shipping price reducing Order Discounts (InternationalDetails.DiscountedShippingPrice price converted to the merchant currency)", | |
"format": "double", | |
"x-label": { | |
"default": "Discounted Shipping Price In Merchant Currency" | |
}, | |
"type": "number" | |
}, | |
"c_geDoNotChargeVat": { | |
"description": "Indicates if the end customer hasn’t been charged VAT in Global-e checkout, as specified in doNotChargeVAT argument for SendCart method for the cart converted to this order on Global-e", | |
"x-label": { | |
"default": "Do Not Charge VAT" | |
}, | |
"type": "boolean" | |
}, | |
"c_geDutiesAndTaxesSubsidy": { | |
"description": "Value of Duties and Taxes subsidized as part of product price in Merchant’s Currency", | |
"format": "double", | |
"x-label": { | |
"default": "Duties And Taxes Subsidy" | |
}, | |
"type": "number" | |
}, | |
"c_geDutiesGuaranteed": { | |
"description": "Indicates if the end customer has selected the “guaranteed duties and taxes” option.", | |
"x-label": { | |
"default": "Is Duties Guaranteed" | |
}, | |
"type": "boolean" | |
}, | |
"c_geFreeShippingCouponCode": { | |
"description": "Merchant’s free shipping coupon code applied by the end customer, as specified in FreeShippingCouponCode argument for SendCart method for the cart converted to this order on Global-e", | |
"x-label": { | |
"default": "Free Shipping Coupon Code" | |
}, | |
"type": "string" | |
}, | |
"c_geInternationalNonProductTotalSubsidy": { | |
"description": "Order DTSubsidy on Customer currency.", | |
"format": "double", | |
"x-label": { | |
"default": "Order DTSubsidy on Customer currency" | |
}, | |
"type": "number" | |
}, | |
"c_geIsFreeShipping": { | |
"description": "Indicates if the Merchant offers free international shipping to the end customer, as specified in IsFreeShipping argument for SendCart method for the cart converted to this order on Global-e", | |
"x-label": { | |
"default": "Is Free Shipping" | |
}, | |
"type": "boolean" | |
}, | |
"c_geIsReplacementOrder": { | |
"description": "Indicates if the order is replacement", | |
"x-label": { | |
"default": "Is Replacement Order" | |
}, | |
"type": "boolean" | |
}, | |
"c_geIsSplitOrder": { | |
"description": "Indicates if the order should be handled as split order (i.e. without consolidation)", | |
"x-label": { | |
"default": "Is Split Order" | |
}, | |
"type": "boolean" | |
}, | |
"c_geLoyaltyCode": { | |
"description": "Loyalty code applicable to the Merchant’s site entered by the end customer in Global-e checkout", | |
"x-label": { | |
"default": "Loyalty Code" | |
}, | |
"type": "string" | |
}, | |
"c_geLoyaltyPointsEarned": { | |
"description": "Number of loyalty points to be earned for this purchase by the end customer on the Merchant’s site, as specified in loyaltyPointsEarned argument for SendCart method for the cart converted to this order on Global-e", | |
"format": "double", | |
"x-label": { | |
"default": "Loyalty Points Earned" | |
}, | |
"type": "number" | |
}, | |
"c_geLoyaltyPointsSpent": { | |
"description": "Number of loyalty points spent for this purchase. The existing loyalty points handling procedure must be applied to the end customer’s user account. Therefore, “Loyalty points” type discount must not be applied to the order directly, but can be used for the display purposes elsewhere in the system (i.e in end user’s My Account page)", | |
"format": "double", | |
"x-label": { | |
"default": "Loyalty Points Spent" | |
}, | |
"type": "number" | |
}, | |
"c_geMerchantShippingVATRate": { | |
"description": "Merchant Shipping VAT rate. This rate is applied on the shipping cost between Global-e and a Merchant.", | |
"format": "double", | |
"x-label": { | |
"default": "Merchant Shipping VAT Rate" | |
}, | |
"type": "number" | |
}, | |
"c_geNonProductTotalSubsidy": { | |
"description": "Order DTSubsidy on Merchant currency.", | |
"format": "double", | |
"x-label": { | |
"default": "Order DTSubsidy on Merchant currency" | |
}, | |
"type": "number" | |
}, | |
"c_geOrderCreationSource": { | |
"description": "Order Creation Sourse", | |
"format": "int32", | |
"x-label": { | |
"default": "Order Creation Sourse" | |
}, | |
"type": "integer" | |
}, | |
"c_geOrderDeliveryDate": { | |
"x-label": { | |
"default": "Global-e Order Delivery Date" | |
}, | |
"type": "string" | |
}, | |
"c_geOrderDocuments": { | |
"description": "The order documents received from Global-e", | |
"format": "text", | |
"x-label": { | |
"default": "Order Documents" | |
}, | |
"type": "string" | |
}, | |
"c_geOrderNumber": { | |
"description": "Global-e order unique identifier", | |
"x-label": { | |
"default": "Global-e Order Number" | |
}, | |
"type": "string" | |
}, | |
"c_geOrderTrackingNumber": { | |
"description": "Tracking number used by the selected international shipping method for this order.", | |
"x-label": { | |
"default": "Order Tracking Number" | |
}, | |
"type": "string" | |
}, | |
"c_geOrderTrackingUrl": { | |
"description": "Full tracking URL including OrderTrackingNumber used by the selected international shipping method for this order.", | |
"x-label": { | |
"default": "Order Tracking URL" | |
}, | |
"type": "string" | |
}, | |
"c_geOrderWaybillNumber": { | |
"description": "Waybill number used by the selected international shipping method for this order", | |
"x-label": { | |
"default": "Order Waybill Number" | |
}, | |
"type": "string" | |
}, | |
"c_geOriginalMerchantInternalOrderNumber": { | |
"description": "InternalOrderId returned from SendOrderToMerchant call for the Original order", | |
"x-label": { | |
"default": "Original Order Merchant Internal Order Number" | |
}, | |
"type": "string" | |
}, | |
"c_geOriginalMerchantOrderNumber": { | |
"description": "OrderId returned from SendOrderToMerchant call for the Original order", | |
"x-label": { | |
"default": "Original Order Merchant Order Number" | |
}, | |
"type": "string" | |
}, | |
"c_geOriginalOrderNumber": { | |
"description": "Global-e order unique identifier for the Original order", | |
"x-label": { | |
"default": "Original Order Global-e Order Number" | |
}, | |
"type": "string" | |
}, | |
"c_geOtCurrencyCode": { | |
"description": "Currency of the onetime voucher code used to place the order", | |
"x-label": { | |
"default": "OT Currency Code" | |
}, | |
"type": "string" | |
}, | |
"c_geOtVoucherAmount": { | |
"description": "Amount taken off the voucher when applicable", | |
"format": "double", | |
"x-label": { | |
"default": "OT Voucher Amount" | |
}, | |
"type": "number" | |
}, | |
"c_geOtVoucherCode": { | |
"description": "Onetime voucher code used to place the order", | |
"x-label": { | |
"default": "OT Voucher Code" | |
}, | |
"type": "string" | |
}, | |
"c_gePaymentJson": { | |
"format": "text", | |
"x-label": { | |
"default": "Perform Payment JSON" | |
}, | |
"type": "string" | |
}, | |
"c_gePaymentMethodCode": { | |
"description": "Code denoting the selected payment method as defined on the Merchant’s site (to be mapped on Global-e side). If this payment method doesn’t exist on the Merchant’s site, the internal Global-e payment method code will be specified instead.", | |
"x-label": { | |
"default": "Payment method code" | |
}, | |
"type": "string" | |
}, | |
"c_gePaymentMethodName": { | |
"description": "Name of the selected payment method.", | |
"x-label": { | |
"default": "Payment method name" | |
}, | |
"type": "string" | |
}, | |
"c_gePdAddress1": { | |
"description": "PD Address1", | |
"x-label": { | |
"default": "PD Address1" | |
}, | |
"type": "string" | |
}, | |
"c_gePdAddress2": { | |
"description": "PD Address2", | |
"x-label": { | |
"default": "PD Address2" | |
}, | |
"type": "string" | |
}, | |
"c_gePdCardNumber": { | |
"description": "PD Card Number", | |
"format": "password", | |
"x-label": { | |
"default": "PD Card Number" | |
}, | |
"type": "string" | |
}, | |
"c_gePdCity": { | |
"description": "PD City", | |
"x-label": { | |
"default": "PD City" | |
}, | |
"type": "string" | |
}, | |
"c_gePdCountryCode": { | |
"description": "PD Country code", | |
"x-label": { | |
"default": "PD Country code" | |
}, | |
"type": "string" | |
}, | |
"c_gePdCountryName": { | |
"description": "PD Country name", | |
"x-label": { | |
"default": "PD Country name" | |
}, | |
"type": "string" | |
}, | |
"c_gePdCvvNumber": { | |
"description": "PD CVV Number", | |
"format": "password", | |
"x-label": { | |
"default": "PD CVV Number" | |
}, | |
"type": "string" | |
}, | |
"c_gePdEmail": { | |
"description": "PD Email", | |
"x-label": { | |
"default": "PD Email" | |
}, | |
"type": "string" | |
}, | |
"c_gePdExpirationDate": { | |
"description": "PD Expiration Date", | |
"format": "password", | |
"x-label": { | |
"default": "PD Expiration Date" | |
}, | |
"type": "string" | |
}, | |
"c_gePdFax": { | |
"description": "PD Fax", | |
"x-label": { | |
"default": "PD Fax" | |
}, | |
"type": "string" | |
}, | |
"c_gePdOwnerFirstName": { | |
"description": "PD Owner first name", | |
"x-label": { | |
"default": "PD Owner first name" | |
}, | |
"type": "string" | |
}, | |
"c_gePdOwnerLastName": { | |
"description": "PD Owner last name", | |
"x-label": { | |
"default": "PD Owner last name" | |
}, | |
"type": "string" | |
}, | |
"c_gePdOwnerName": { | |
"description": "PD Owner name", | |
"x-label": { | |
"default": "PD Owner name" | |
}, | |
"type": "string" | |
}, | |
"c_gePdPaymentMethodCode": { | |
"description": "PD Payment method code", | |
"x-label": { | |
"default": "PD Payment method code" | |
}, | |
"type": "string" | |
}, | |
"c_gePdPaymentMethodName": { | |
"description": "PD Payment method name", | |
"x-label": { | |
"default": "PD Payment method name" | |
}, | |
"type": "string" | |
}, | |
"c_gePdPaymentMethodTypeCode": { | |
"description": "PD Payment method type code", | |
"x-label": { | |
"default": "PD Payment method type code" | |
}, | |
"type": "string" | |
}, | |
"c_gePdPhone1": { | |
"description": "PD Phone1", | |
"x-label": { | |
"default": "PD Phone1" | |
}, | |
"type": "string" | |
}, | |
"c_gePdPhone2": { | |
"description": "PD Phone2", | |
"x-label": { | |
"default": "PD Phone2" | |
}, | |
"type": "string" | |
}, | |
"c_gePdStateCode": { | |
"description": "PD State code", | |
"x-label": { | |
"default": "PD State code" | |
}, | |
"type": "string" | |
}, | |
"c_gePdStateOrProvince": { | |
"description": "PD State or province", | |
"x-label": { | |
"default": "PD State or province" | |
}, | |
"type": "string" | |
}, | |
"c_gePdZip": { | |
"description": "PD Zip", | |
"x-label": { | |
"default": "PD Zip" | |
}, | |
"type": "string" | |
}, | |
"c_gePrePayOffered": { | |
"description": "Indicates if the prepayment option for duties and taxes was offered to the customer", | |
"x-label": { | |
"default": "PrePay Offered" | |
}, | |
"type": "boolean" | |
}, | |
"c_gePriceCoefficientRate": { | |
"description": "CountryCoefficient rate applied to the prices in this order", | |
"format": "double", | |
"x-label": { | |
"default": "Price Coefficient Rate" | |
}, | |
"type": "number" | |
}, | |
"c_geReceivedOrderStatusUpdates": { | |
"description": "The set of strings of the statuses received from Global-e", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Order Status Updates received from Global-e" | |
}, | |
"type": "array" | |
}, | |
"c_geRefundNotificationJson": { | |
"format": "text", | |
"x-label": { | |
"default": "Refund Notification JSON" | |
}, | |
"type": "string" | |
}, | |
"c_geRemoteAreaSurcharge": { | |
"description": "Remote area surcharge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.", | |
"format": "double", | |
"x-label": { | |
"default": "Remote Area Surcharge" | |
}, | |
"type": "number" | |
}, | |
"c_geRoundingRate": { | |
"description": "Average conversion rate applied to the prices paid by the end customer, when calculating the prices paid by Global-e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors", | |
"x-label": { | |
"default": "Global-e Rounding Rate" | |
}, | |
"type": "string" | |
}, | |
"c_geSameDayDispatch": { | |
"description": "Indicates if the end customer has requested “Same Day Dispatch” on Global-e checkout", | |
"x-label": { | |
"default": "Same Day Dispatch" | |
}, | |
"type": "boolean" | |
}, | |
"c_geSameDayDispatchCost": { | |
"description": "Cost of “Same Day Dispatch” option (if selected by the end customer on Global-e checkout), in the currency denoted by CurrencyCode. This value is NOT included in TotalShippingPrice.", | |
"format": "double", | |
"x-label": { | |
"default": "Same Day Dispatch Cost" | |
}, | |
"type": "number" | |
}, | |
"c_geSendCartJson": { | |
"format": "text", | |
"x-label": { | |
"default": "Global-e Send Cart JSON" | |
}, | |
"type": "string" | |
}, | |
"c_geSendOrderDispatchUpdate": { | |
"description": "If Yes - globale-update-order-dispatch Job will take this Order and send the UpdateOrderDispatchV2 API request to Global-e", | |
"x-label": { | |
"default": "Send Update Order Dispatch to Global-e" | |
}, | |
"type": "boolean" | |
}, | |
"c_geSendOrderRefund": { | |
"description": "If Yes - globale-create-order-refund Job will take this Order and send the CreateOrderRefund API request to Global-e", | |
"x-label": { | |
"default": "Send Create Order Refund to Global-e" | |
}, | |
"type": "boolean" | |
}, | |
"c_geSendOrderRmaUpdate": { | |
"description": "If Yes - globale-update-order-rma Job will take this Order and send the UpdateRMA API request to Global-e", | |
"x-label": { | |
"default": "Send Order RMA Update to Global-e" | |
}, | |
"type": "boolean" | |
}, | |
"c_geSendOrderStatusUpdate": { | |
"description": "If Yes - globale-update-order-status Job will take this Order and send the UpdateOrderStatus API request to Global-e", | |
"x-label": { | |
"default": "Send Order Status Update to Global-e" | |
}, | |
"type": "boolean" | |
}, | |
"c_geSendOrderToMerchantJson": { | |
"format": "text", | |
"x-label": { | |
"default": "Send Order to Merchant JSON" | |
}, | |
"type": "string" | |
}, | |
"c_geSendRmaToMerchantJson": { | |
"format": "text", | |
"x-label": { | |
"default": "Send RMA to Merchant JSON" | |
}, | |
"type": "string" | |
}, | |
"c_geSentOrderDispatchUpdates": { | |
"description": "The set of strings of the Update Order Dispatch requests and it's dates sent to Global-e", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Update Order Dispatch sent to Global-e" | |
}, | |
"type": "array" | |
}, | |
"c_geSentOrderRefunds": { | |
"description": "The set of strings of the refund requests and it's dates sent to Global-e", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Create Order Refunds sent to Global-e" | |
}, | |
"type": "array" | |
}, | |
"c_geSentOrderStatusUpdates": { | |
"description": "The set of strings of the statuses and it's dates sent to Global-e", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Order Status Updates sent to Global-e" | |
}, | |
"type": "array" | |
}, | |
"c_geShippingAddress1": { | |
"description": "Shipping Address line 1", | |
"x-label": { | |
"default": "Shipping Address 1" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingAddress2": { | |
"description": "Shipping Address line 2", | |
"x-label": { | |
"default": "Shipping Address 2" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingCity": { | |
"description": "Shipping City name", | |
"x-label": { | |
"default": "Shipping City" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingCityRegion": { | |
"description": "Shipping City Region", | |
"x-label": { | |
"default": "City Region" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingCompany": { | |
"description": "Shipping Company name", | |
"x-label": { | |
"default": "Shipping Company" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingCountryCode": { | |
"description": "Shipping Country code", | |
"x-label": { | |
"default": "Shipping Country code" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingCountryName": { | |
"description": "Shipping Country name", | |
"x-label": { | |
"default": "Shipping Country name" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingEmail": { | |
"description": "Shipping Email address", | |
"x-label": { | |
"default": "Shipping Email" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingFax": { | |
"description": "Shipping Fax", | |
"x-label": { | |
"default": "Shipping Fax" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingFirstName": { | |
"description": "Shipping First name", | |
"x-label": { | |
"default": "Shipping FIrst name" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingLastName": { | |
"description": "Shipping Last name", | |
"x-label": { | |
"default": "Shipping Last name" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingMethodCode": { | |
"description": "Code denoting the selected international shipping method as defined on the Merchant’s site (to be mapped on Global-e side). If this international shipping method doesn’t exist on the Merchant’s site, the internal Global-e shipping method code will be specified instead", | |
"x-label": { | |
"default": "Shipping Method Code" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingMethodName": { | |
"description": "Name of the selected international shipping method.", | |
"x-label": { | |
"default": "Shipping Method Name" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingMethodStatusCode": { | |
"description": "Code denoting the selected shipping status as defined on the Merchant’s site (to be mapped on Global-e side). If this shipping status doesn’t exist on the Merchant’s site, the internal Global-e shipping status code will be specified instead.", | |
"x-label": { | |
"default": "Shipping Method Status Code" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingMethodStatusName": { | |
"description": "Name of the shipping status", | |
"x-label": { | |
"default": "Shipping Method Status Name" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingMethodTypeCode": { | |
"description": "Code denoting the selected international shipping method type as defined on the Merchant’s site (to be mapped on Global-e side). If this international shipping method type doesn’t exist on the Merchant’s site, the internal Global-e shipping method type code will be specified instead.", | |
"x-label": { | |
"default": "Shipping Method Type Code" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingMethodTypeName": { | |
"description": "Name of the selected international shipping method type.", | |
"x-label": { | |
"default": "Shipping Method Type Name" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingMiddleName": { | |
"description": "Shipping Middle name", | |
"x-label": { | |
"default": "Shipping Middle name" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingPhone1": { | |
"description": "Shipping Phone 1", | |
"x-label": { | |
"default": "Shipping Phone 1" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingPhone2": { | |
"description": "Shipping Phone 2", | |
"x-label": { | |
"default": "Shipping Phone 2" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingSalutation": { | |
"description": "Shipping Salutation", | |
"x-label": { | |
"default": "Shipping Salutation" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingStateCode": { | |
"description": "Shipping State code", | |
"x-label": { | |
"default": "Shipping State code" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingStateOrProvince": { | |
"description": "Shipping State or province", | |
"x-label": { | |
"default": "Shipping State or province" | |
}, | |
"type": "string" | |
}, | |
"c_geShippingSubsidy": { | |
"description": "Shipping Subsidy", | |
"format": "double", | |
"x-label": { | |
"default": "Shipping Subsidy" | |
}, | |
"type": "number" | |
}, | |
"c_geShippingVATRate": { | |
"description": "Shipping VAT rate for customer. This rate is applied on the shipping cost.", | |
"format": "double", | |
"x-label": { | |
"default": "Shipping VAT Rate" | |
}, | |
"type": "number" | |
}, | |
"c_geShippingZip": { | |
"description": "Shipping Zip code", | |
"x-label": { | |
"default": "Shipping Zip" | |
}, | |
"type": "string" | |
}, | |
"c_geSizeOverchargeValue": { | |
"description": "Oversized items charge paid by the end customer in the currency denoted by CurrencyCode. This value is included in TotalShippingPrice.", | |
"format": "double", | |
"x-label": { | |
"default": "Size Overcharge Value" | |
}, | |
"type": "number" | |
}, | |
"c_geStatusCode": { | |
"description": "Code denoting the order status on the Merchant’s site (to be mapped on Global-e side)", | |
"x-label": { | |
"default": "Order Status Code" | |
}, | |
"type": "string" | |
}, | |
"c_geSuppressPersonalInformation": { | |
"description": "Is Suppress Personal Information (GDPR)", | |
"x-label": { | |
"default": "Is Suppress Personal Information (GDPR)" | |
}, | |
"type": "boolean" | |
}, | |
"c_geTotalCcfPrice": { | |
"description": "Total Customs Clearance Fees value in the currency denoted by CurrencyCode. This value is included in TotalDutiesPrice.", | |
"format": "double", | |
"x-label": { | |
"default": "Total CCF Price" | |
}, | |
"type": "number" | |
}, | |
"c_geTotalCustomerDiscounts": { | |
"description": "Total customer discounts for Cart and Loyalty type discounts", | |
"format": "double", | |
"x-label": { | |
"default": "Total Customer Discounts" | |
}, | |
"type": "number" | |
}, | |
"c_geTotalDiscountedShippingPrice": { | |
"description": "The price paid by customer in local currency. Total Shipping price reducing Order Discounts International price.", | |
"format": "double", | |
"x-label": { | |
"default": "Total Discounted Shipping Price" | |
}, | |
"type": "number" | |
}, | |
"c_geTotalDutiesAndTaxesPrice": { | |
"description": "Total Duties & Taxes value including Customs Clearance Fees, in the merchant currency. This amount is the total amount, regardless whether customer or the merchant paid it.", | |
"format": "double", | |
"x-label": { | |
"default": "Total Duties and Taxes Price in Merchant Currency" | |
}, | |
"type": "number" | |
}, | |
"c_geTotalDutiesPaidByCustomerPrice": { | |
"description": "The Duties paid by customer (in merchant currency) for Duties as they were shown in checkout.", | |
"format": "double", | |
"x-label": { | |
"default": "Total Duties Paid By Customer" | |
}, | |
"type": "number" | |
}, | |
"c_geTotalDutiesPrice": { | |
"description": "Total Duties & Taxes value including Customs Clearance Fees, in the currency denoted by CurrencyCode", | |
"format": "double", | |
"x-label": { | |
"default": "Total Duties Price" | |
}, | |
"type": "number" | |
}, | |
"c_geTotalPrice": { | |
"description": "Total order price in the currency denoted by CurrencyCode", | |
"format": "double", | |
"x-label": { | |
"default": "Total Price" | |
}, | |
"type": "number" | |
}, | |
"c_geTotalProductsNetPrice": { | |
"description": "Value of products after deduction of duties and taxes subsidies in Merchant’s Currency", | |
"format": "double", | |
"x-label": { | |
"default": "Total Products Net Price" | |
}, | |
"type": "number" | |
}, | |
"c_geTotalShippingPrice": { | |
"description": "Total shipping price in the currency denoted by CurrencyCode", | |
"format": "double", | |
"x-label": { | |
"default": "Total Shipping Price" | |
}, | |
"type": "number" | |
}, | |
"c_geTotalVatAmount": { | |
"description": "Amount of VAT paid by the customer to Global-e", | |
"format": "double", | |
"x-label": { | |
"default": "Total VAT Amount" | |
}, | |
"type": "number" | |
}, | |
"c_geTransactionCurrencyCode": { | |
"description": "3-char ISO code for the currency actually used for the current order payment. TransactionCurrencyCode may differ from CurrencyCode if the currency selected by the end customer could not be used with the selected payment method", | |
"x-label": { | |
"default": "Transaction Currency Code" | |
}, | |
"type": "string" | |
}, | |
"c_geTransactionTotalPrice": { | |
"description": "Total order price actually paid by the end customer in the currency denoted by TransactionCurrencyCode", | |
"format": "double", | |
"x-label": { | |
"default": "Transaction Total Price" | |
}, | |
"type": "number" | |
}, | |
"c_geUSSalesTax": { | |
"description": "Sales tax value for USA in the merchant currency. This value is included in TotalDutiesAndTaxesPrice.", | |
"format": "double", | |
"x-label": { | |
"default": "Sales tax value for USA" | |
}, | |
"type": "number" | |
}, | |
"c_geUpdateOrderStatusJson": { | |
"format": "text", | |
"x-label": { | |
"default": "Update Order Status JSON" | |
}, | |
"type": "string" | |
}, | |
"c_geUpdateRmaJson": { | |
"format": "text", | |
"x-label": { | |
"default": "Update RMA JSON" | |
}, | |
"type": "string" | |
}, | |
"c_geUpdateShippingStatusJson": { | |
"format": "text", | |
"x-label": { | |
"default": "Update Shipping Status JSON" | |
}, | |
"type": "string" | |
}, | |
"c_gmoAccessID": { | |
"x-label": { | |
"default": "GMO Access ID" | |
}, | |
"type": "string" | |
}, | |
"c_gmoAccessPass": { | |
"x-label": { | |
"default": "GMO Access Pass" | |
}, | |
"type": "string" | |
}, | |
"c_gmoFinalProcessingDate": { | |
"format": "date-time", | |
"x-label": { | |
"default": "GMO Final Processing Date" | |
}, | |
"type": "string" | |
}, | |
"c_gmoIsAuthorization": { | |
"x-label": { | |
"default": "GMO Check Autorization" | |
}, | |
"type": "boolean" | |
}, | |
"c_inStockDate": { | |
"description": "The expected in-stock date of the products in the Basket", | |
"format": "date", | |
"x-label": { | |
"default": "In-Stock Date" | |
}, | |
"type": "string" | |
}, | |
"c_inStockStatus": { | |
"description": "One of INSTOCK, PREORDER, BACKORDER, OUTOFSTOCK, or MIXED\r\n IN_STOCK = All products in the Basket are in-stock\r\n PREORDER = All products in the Basket are preorder with the same in-stock date\r\n BACKORDER = All products in the Basket are backorder with the same in-stock date\r\n NOT_AVAILABLE = All products in the Basket are out of stock with no preorder/backorder handling\r\n MIXED = Any combination of product availabilities, including preorder/backorder products with different in-stock dates", | |
"enum": [ | |
"IN_STOCK", | |
"PREORDER", | |
"BACKORDER", | |
"NOT_AVAILABLE", | |
"MIXED" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "IN_STOCK" | |
}, | |
{ | |
"default": "PREORDER" | |
}, | |
{ | |
"default": "BACKORDER" | |
}, | |
{ | |
"default": "NOT_AVAILABLE" | |
}, | |
{ | |
"default": "MIXED" | |
} | |
], | |
"x-label": { | |
"default": "In-Stock Status" | |
}, | |
"type": "string" | |
}, | |
"c_instore": { | |
"x-label": { | |
"default": "In store" | |
}, | |
"type": "boolean" | |
}, | |
"c_isCancelled": { | |
"x-label": { | |
"default": "Cancelled order" | |
}, | |
"type": "boolean" | |
}, | |
"c_isCyberSourcePaymentMethod": { | |
"x-label": { | |
"default": "CyberSource Payment Method" | |
}, | |
"type": "boolean" | |
}, | |
"c_isFiegeOrderReturned": { | |
"x-label": { | |
"default": "Is Order Returned?" | |
}, | |
"type": "boolean" | |
}, | |
"c_isReturned": { | |
"x-label": { | |
"default": "Returned order" | |
}, | |
"type": "boolean" | |
}, | |
"c_motionPointOrder": { | |
"type": "boolean" | |
}, | |
"c_narvarApiCallFailedCount": { | |
"format": "int32", | |
"x-label": { | |
"default": "Narvar Failed Attempts" | |
}, | |
"type": "integer" | |
}, | |
"c_narvarApiLastCall": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Last Successful API call to Narvar" | |
}, | |
"type": "string" | |
}, | |
"c_noShippingRequired": { | |
"x-label": { | |
"default": "No shipping required" | |
}, | |
"type": "boolean" | |
}, | |
"c_notesAndHistory": { | |
"description": "This attribute is used to store all notes and order events that have\n to be exported to Lifetime.\n ", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Notes and History" | |
}, | |
"type": "array" | |
}, | |
"c_opluxEventID": { | |
"description": "Set the Event ID issued by OPLUX", | |
"x-label": { | |
"default": "OPLUX Event ID" | |
}, | |
"type": "string" | |
}, | |
"c_opluxScreeningResult": { | |
"description": "Set the screening results returned from OPLUX\r\n・NG (Fraudulent order detected)\r\n・OK (Not a fraudulent order)\r\n・REVIEW (Reviewing for fraudulent orders)\r\n・SERVICE_DISABLED (OPLUX service is disabled)", | |
"enum": [ | |
"NG", | |
"OK", | |
"REVIEW", | |
"SERVICE_DISABLED" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Fraudulent order detected" | |
}, | |
{ | |
"default": "Not a fraudulent order" | |
}, | |
{ | |
"default": "Reviewing for fraudulent orders" | |
}, | |
{ | |
"default": "OPLUX service is disabled" | |
} | |
], | |
"x-label": { | |
"default": "OPLUX Screening Result" | |
}, | |
"type": "string" | |
}, | |
"c_orderCreationInstanceTime": { | |
"x-label": { | |
"default": "Order Creation Instance Time" | |
}, | |
"type": "string" | |
}, | |
"c_orderReturnCounter": { | |
"description": "We want to keep the original order number as a part of the RMA number, while keeping it unique. So we will append this number to the original order number", | |
"format": "int32", | |
"x-label": { | |
"default": "Order Return Counter" | |
}, | |
"type": "integer" | |
}, | |
"c_orderType": { | |
"x-label": { | |
"default": "Order Type" | |
}, | |
"type": "string" | |
}, | |
"c_payUCardCategory": { | |
"x-label": { | |
"default": "PayU Card Category" | |
}, | |
"type": "string" | |
}, | |
"c_payUField6": { | |
"description": "payU Field6", | |
"x-label": { | |
"default": "payU Field6" | |
}, | |
"type": "string" | |
}, | |
"c_payUMode": { | |
"description": "payU Mode", | |
"x-label": { | |
"default": "payU Mode" | |
}, | |
"type": "string" | |
}, | |
"c_payUPayId": { | |
"x-label": { | |
"default": "PayU Pay ID" | |
}, | |
"type": "string" | |
}, | |
"c_payUTxnid": { | |
"description": "PayU Transaction ID", | |
"x-label": { | |
"default": "PayU Transaction ID" | |
}, | |
"type": "string" | |
}, | |
"c_payUUnmappedStatus": { | |
"x-label": { | |
"default": "PayU Unmapped Status" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorLogs": { | |
"format": "text", | |
"x-label": { | |
"default": "paymentOperatorLogs" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorPayID": { | |
"description": "saves PayID for later referencing of paymorrow transaction", | |
"x-label": { | |
"default": "Payment Operator Pay ID" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorPayUCodeExt": { | |
"x-label": { | |
"default": "PaymentOperator PayU CodeExt" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorPayUErrorText": { | |
"x-label": { | |
"default": "PaymentOperator PayU ErrorText" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorPaymentData": { | |
"x-label": { | |
"default": "PaymentOperator Payment Data", | |
"zh-CN": "Computop 支付数据" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorRefNr": { | |
"x-label": { | |
"default": "Payment Operator RefNr" | |
}, | |
"type": "string" | |
}, | |
"c_paypayAccessID": { | |
"description": "Stores the AccessID returned by EntryTranPaypay", | |
"x-label": { | |
"default": "PayPay Access ID" | |
}, | |
"type": "string" | |
}, | |
"c_paypayAccessPass": { | |
"description": "Stores the AccessPass returned by EntryTranPaypay", | |
"x-label": { | |
"default": "PayPay Access Pass" | |
}, | |
"type": "string" | |
}, | |
"c_paypayAsyncResultNoticed": { | |
"description": "Updated true if async payment result is noticed from GMO", | |
"x-label": { | |
"default": "PayPay Async Result Noticed" | |
}, | |
"type": "boolean" | |
}, | |
"c_paypayFalsificationDetected": { | |
"description": "Updated true if falsification is detected", | |
"x-label": { | |
"default": "PayPay Falsification Detected" | |
}, | |
"type": "boolean" | |
}, | |
"c_paypayIsAlisAllocationFailed": { | |
"description": "Updated true if Alis Stock Allocation Failed", | |
"x-label": { | |
"default": "Is Alis Stock Allocation Failed" | |
}, | |
"type": "boolean" | |
}, | |
"c_paypayPaymentStatus": { | |
"description": "Set the Status received by the PayPay result notification program", | |
"enum": [ | |
"UNPROCESSED", | |
"REQSUCCESS", | |
"AUTHPROCESS", | |
"AUTH", | |
"SALES", | |
"REQSALES", | |
"CAPTURE", | |
"CANCEL", | |
"RETURN", | |
"PAYFAIL", | |
"EXPIRED", | |
"REQPUSH", | |
"PUSHCANCEL", | |
"PUSHEXPIRED" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "UNPROCESSED" | |
}, | |
{ | |
"default": "REQSUCCESS" | |
}, | |
{ | |
"default": "AUTHPROCESS" | |
}, | |
{ | |
"default": "AUTH" | |
}, | |
{ | |
"default": "SALES" | |
}, | |
{ | |
"default": "REQSALES" | |
}, | |
{ | |
"default": "CAPTURE" | |
}, | |
{ | |
"default": "CANCEL" | |
}, | |
{ | |
"default": "RETURN" | |
}, | |
{ | |
"default": "PAYFAIL" | |
}, | |
{ | |
"default": "EXPIRED" | |
}, | |
{ | |
"default": "REQPUSH" | |
}, | |
{ | |
"default": "PUSHCANCEL" | |
}, | |
{ | |
"default": "PUSHEXPIRED" | |
} | |
], | |
"x-label": { | |
"default": "PayPay Payment Status" | |
}, | |
"type": "string" | |
}, | |
"c_promotionMediumNo": { | |
"description": "custom field for Feige, should always be \"PUMA\"", | |
"x-label": { | |
"default": "Promotion Medium Number" | |
}, | |
"type": "string" | |
}, | |
"c_radialCustomerLoginAttempts": { | |
"description": "Radial Customer Failed Login Attempts", | |
"format": "int32", | |
"x-label": { | |
"default": "Radial Customer Failed Login Attempts" | |
}, | |
"type": "integer" | |
}, | |
"c_radialDeviceFingerprint": { | |
"x-label": { | |
"default": "Radial Device Fingerprint" | |
}, | |
"type": "string" | |
}, | |
"c_radialFraudBrowserAccept": { | |
"description": "Radial Fraud Browser Accept", | |
"x-label": { | |
"default": "Radial Fraud Browser Accept" | |
}, | |
"type": "string" | |
}, | |
"c_radialFraudBrowserAcceptCharset": { | |
"description": "Radial Fraud Browser Accept Charset", | |
"x-label": { | |
"default": "Radial Fraud Browser Accept Charset" | |
}, | |
"type": "string" | |
}, | |
"c_radialFraudBrowserAcceptEncoding": { | |
"description": "Radial Fraud Browser Accept Encoding", | |
"x-label": { | |
"default": "Radial Fraud Browser Accept Encoding" | |
}, | |
"type": "string" | |
}, | |
"c_radialFraudBrowserConnection": { | |
"description": "Radial Fraud Browser Connection", | |
"x-label": { | |
"default": "Radial Fraud Browser Connection" | |
}, | |
"type": "string" | |
}, | |
"c_radialFraudBrowserCookie": { | |
"description": "Radial Fraud Browser Cookie", | |
"x-label": { | |
"default": "Radial Fraud Browser Cookie" | |
}, | |
"type": "string" | |
}, | |
"c_radialFraudBrowserID": { | |
"description": "Radial Fraud Browser ID", | |
"x-label": { | |
"default": "Radial Fraud Browser ID" | |
}, | |
"type": "string" | |
}, | |
"c_radialFraudBrowserIdLanguageCode": { | |
"description": "Radial Fraud Browser Id Language Code", | |
"x-label": { | |
"default": "Radial Fraud Browser Id Language Code" | |
}, | |
"type": "string" | |
}, | |
"c_radialFraudBrowserReferer": { | |
"description": "Radial Fraud Browser Referer", | |
"x-label": { | |
"default": "Radial Fraud Browser Referer" | |
}, | |
"type": "string" | |
}, | |
"c_radialFraudBrowserSessionId": { | |
"description": "Radial Fraud Browser Session Id", | |
"x-label": { | |
"default": "Radial Fraud Browser Session Id" | |
}, | |
"type": "string" | |
}, | |
"c_radialFraudCustomerIPAddress": { | |
"description": "Radial Fraud Customer IP Address", | |
"x-label": { | |
"default": "Radial Fraud Customer IP Address" | |
}, | |
"type": "string" | |
}, | |
"c_radialFraudDeviceID": { | |
"description": "Radial Fraud Device ID", | |
"x-label": { | |
"default": "Radial Fraud Device ID" | |
}, | |
"type": "string" | |
}, | |
"c_radialFraudRawCookie": { | |
"description": "Radial Fraud Raw Cookie", | |
"x-label": { | |
"default": "Radial Fraud Raw Cookie" | |
}, | |
"type": "string" | |
}, | |
"c_radialFraudTimeSpentOnSite": { | |
"description": "Radial Fraud Time Spent On Site", | |
"x-label": { | |
"default": "Radial Fraud Time Spent On Site" | |
}, | |
"type": "string" | |
}, | |
"c_radialInventoryReservationID": { | |
"description": "This data needs to be preserved so it can be later used for the order creation webservice call.", | |
"x-label": { | |
"default": "Radial LineItem Inventory Reservation ID" | |
}, | |
"type": "string" | |
}, | |
"c_radialOrderCreateLastRetryDate": { | |
"description": "The last date and time an order was retried for Radial order creation.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Radial Order Create Last Retry Date" | |
}, | |
"type": "string" | |
}, | |
"c_radialOrderCreateRetryCount": { | |
"description": "This custom attribute gets incremented with each order creation retry run and allows to keep track of the order retries. Compared with the site preferences set maximum, the count can stop the retries.", | |
"format": "int32", | |
"x-label": { | |
"default": "Radial OrderCreate Retry Count" | |
}, | |
"type": "integer" | |
}, | |
"c_radialOrderCreateStatus": { | |
"description": "The status of Radial order creation service response.", | |
"enum": [ | |
"OK", | |
"FAILED", | |
"RETRY" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "OK" | |
}, | |
{ | |
"default": "FAILED" | |
}, | |
{ | |
"default": "RETRY" | |
} | |
], | |
"x-label": { | |
"default": "Radial Order Create Status" | |
}, | |
"type": "string" | |
}, | |
"c_radialOrderStatus": { | |
"description": "The status of Radial order history service response.", | |
"enum": [ | |
"processed", | |
"shipped", | |
"partiallyshipped", | |
"returned", | |
"partiallyreturned", | |
"beingprocessed", | |
"cancelled", | |
"partiallycancelled" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Being Processed" | |
}, | |
{ | |
"default": "Shipped" | |
}, | |
{ | |
"default": "Partially Shipped" | |
}, | |
{ | |
"default": "Returned" | |
}, | |
{ | |
"default": "Partially Returned" | |
}, | |
{ | |
"default": "Processing" | |
}, | |
{ | |
"default": "Cancelled" | |
}, | |
{ | |
"default": "Partially Cancelled" | |
} | |
], | |
"x-label": { | |
"default": "Radial Order Status" | |
}, | |
"type": "string" | |
}, | |
"c_radialPTFStatus": { | |
"x-label": { | |
"default": "Radial PTF Status" | |
}, | |
"type": "string" | |
}, | |
"c_radialResponseDescription": { | |
"description": "Radial Response Description.", | |
"x-label": { | |
"default": "Radial Response Description" | |
}, | |
"type": "string" | |
}, | |
"c_radialResponseStatus": { | |
"description": "Radial Response Status.", | |
"x-label": { | |
"default": "Radial Response Status" | |
}, | |
"type": "string" | |
}, | |
"c_radialTaxCallSuccess": { | |
"x-label": { | |
"default": "Radial Tax Call Success" | |
}, | |
"type": "string" | |
}, | |
"c_radialTaxTransactionId": { | |
"x-label": { | |
"default": "Radial Tax Transaction Id" | |
}, | |
"type": "string" | |
}, | |
"c_radialWalletType": { | |
"description": "Contains the wallet type to be sent to Radial.", | |
"x-label": { | |
"default": "Radial Wallet Type" | |
}, | |
"type": "string" | |
}, | |
"c_refundInformation": { | |
"description": "Refund detail information as JSON format", | |
"format": "text", | |
"x-label": { | |
"default": "Refund information" | |
}, | |
"type": "string" | |
}, | |
"c_refundPaymentMethod": { | |
"description": "Payment method actually used for refund", | |
"enum": [ | |
"COD", | |
"AMAZON_PAY", | |
"CREDIT_CARD", | |
"PAY_PAY" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Cash on delivery" | |
}, | |
{ | |
"default": "Amazon Pay" | |
}, | |
{ | |
"default": "Credit card" | |
}, | |
{ | |
"default": "Paypay payment" | |
} | |
], | |
"x-label": { | |
"default": "Refund payment method" | |
}, | |
"type": "string" | |
}, | |
"c_refundStatus": { | |
"description": "Statues for refund", | |
"enum": [ | |
"REFUNDED", | |
"EXCLUDED", | |
"REQUIRED_TO_PROCESS", | |
"API_ERROR" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Already refund processed" | |
}, | |
{ | |
"default": "Excluded from refund target" | |
}, | |
{ | |
"default": "Required to refund process for payment gate way" | |
}, | |
{ | |
"default": "Error is occurred while refund API call" | |
} | |
], | |
"x-label": { | |
"default": "Refund status" | |
}, | |
"type": "string" | |
}, | |
"c_refundType": { | |
"description": "Type of refund for this order", | |
"enum": [ | |
"PARTIAL", | |
"ALL" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Partial refund" | |
}, | |
{ | |
"default": "All refund" | |
} | |
], | |
"x-label": { | |
"default": "Refund type" | |
}, | |
"type": "string" | |
}, | |
"c_returnDeadlineDate": { | |
"description": "Return Deadline Date", | |
"format": "date-time", | |
"x-label": { | |
"default": "Return Deadline Date" | |
}, | |
"type": "string" | |
}, | |
"c_returnRuleID": { | |
"description": "Represents Return Rule ID", | |
"x-label": { | |
"default": "Return Rule ID" | |
}, | |
"type": "string" | |
}, | |
"c_returnShippingAddress": { | |
"format": "text", | |
"x-label": { | |
"default": "Return shipping address" | |
}, | |
"type": "string" | |
}, | |
"c_returnShippingMethod": { | |
"x-label": { | |
"default": "Return shipping methods" | |
}, | |
"type": "string" | |
}, | |
"c_returnStatus": { | |
"description": "Represents Order Return status. There are three statuses: NO_RETURN, PARTIAL_RETURN or FULL_RETURN", | |
"enum": [ | |
"NO_RETURN", | |
"PARTIAL_RETURN", | |
"FULL_RETURN" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "No Return" | |
}, | |
{ | |
"default": "Partial Return" | |
}, | |
{ | |
"default": "Full Return" | |
} | |
], | |
"x-label": { | |
"default": "Return Status" | |
}, | |
"type": "string" | |
}, | |
"c_reused": { | |
"x-label": { | |
"default": "Reuse order" | |
}, | |
"type": "boolean" | |
}, | |
"c_reusedWithSameCard": { | |
"x-label": { | |
"default": "Reuse order (same card)" | |
}, | |
"type": "boolean" | |
}, | |
"c_rssBasketTotalGrossPrice": { | |
"x-label": { | |
"default": "rssBasketTotalGrossPrice" | |
}, | |
"type": "string" | |
}, | |
"c_rssClientTransactionID": { | |
"x-label": { | |
"default": "rssClientTransactionID" | |
}, | |
"type": "string" | |
}, | |
"c_rssError": { | |
"x-label": { | |
"default": "rssError" | |
}, | |
"type": "string" | |
}, | |
"c_rssInvalidAddress": { | |
"x-label": { | |
"default": "rssInvalidAddress" | |
}, | |
"type": "boolean" | |
}, | |
"c_rssResultCode": { | |
"x-label": { | |
"default": "rssResultCode" | |
}, | |
"type": "string" | |
}, | |
"c_rssToken": { | |
"x-label": { | |
"default": "rssToken" | |
}, | |
"type": "string" | |
}, | |
"c_salesIdentifier": { | |
"description": "secondary attribute to primary, that identifies platform / location", | |
"x-label": { | |
"default": "Sales Identifier" | |
}, | |
"type": "string" | |
}, | |
"c_salesSource": { | |
"description": "primary attribute that identifies where sale originated", | |
"enum": [ | |
"web", | |
"app", | |
"store", | |
"magicmirror" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Web" | |
}, | |
{ | |
"default": "App" | |
}, | |
{ | |
"default": "Store" | |
}, | |
{ | |
"default": "Magic Mirror" | |
} | |
], | |
"x-label": { | |
"default": "Sales Source" | |
}, | |
"type": "string" | |
}, | |
"c_simplResponseData": { | |
"x-label": { | |
"default": "Simpl Response Data" | |
}, | |
"type": "string" | |
}, | |
"c_simplTransactionId": { | |
"x-label": { | |
"default": "Simpl Transaction Id" | |
}, | |
"type": "string" | |
}, | |
"c_storeAssociateID": { | |
"description": "The associates ID - corresponds with login code ", | |
"x-label": { | |
"default": "storeAssociateID" | |
}, | |
"type": "string" | |
}, | |
"c_storeDevice": { | |
"description": "The device the order was placed on (kiosk|tablet|customer)", | |
"x-label": { | |
"default": "storeDevice" | |
}, | |
"type": "string" | |
}, | |
"c_storeEmail": { | |
"description": "The store email address", | |
"x-label": { | |
"default": "storeEmail" | |
}, | |
"type": "string" | |
}, | |
"c_storeID": { | |
"description": "The store ID placeing the order", | |
"x-label": { | |
"default": "storeID" | |
}, | |
"type": "string" | |
}, | |
"c_storeOrderResultCode": { | |
"x-label": { | |
"default": "StoreOrder ResultCode" | |
}, | |
"type": "string" | |
}, | |
"c_updatedPaymentStatusOnOplux": { | |
"description": "Whether updated payment status on O-PLUX", | |
"x-label": { | |
"default": "Updated Payment Status on O-PLUX", | |
"ja-JP": "Updated Payment Status on O-PLUX" | |
}, | |
"type": "boolean" | |
}, | |
"c_wirecardParentTransactionID": { | |
"x-label": { | |
"default": "Wirecard Parent Transaction ID" | |
}, | |
"type": "string" | |
}, | |
"c_wirecardRequestID": { | |
"x-label": { | |
"default": "Wirecard Request ID" | |
}, | |
"type": "string" | |
}, | |
"c_wirecardTransactions": { | |
"format": "text", | |
"x-label": { | |
"default": "Wirecard Transactions" | |
}, | |
"type": "string" | |
}, | |
"channel_type": { | |
"description": "The sales channel for the order.", | |
"enum": [ | |
"storefront", | |
"callcenter", | |
"marketplace", | |
"dss", | |
"store", | |
"pinterest", | |
"twitter", | |
"facebookads", | |
"subscriptions", | |
"onlinereservation", | |
"customerservicecenter", | |
"instagramcommerce" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Storefront" | |
}, | |
{ | |
"default": "Call Center" | |
}, | |
{ | |
"default": "Marketplace" | |
}, | |
{ | |
"default": "DSS" | |
}, | |
{ | |
"default": "Store" | |
}, | |
{ | |
"default": "Pinterest" | |
}, | |
{ | |
"default": "Twitter" | |
}, | |
{ | |
"default": "Facebook Ads" | |
}, | |
{ | |
"default": "Subscriptions" | |
}, | |
{ | |
"default": "Online Reservation" | |
}, | |
{ | |
"default": "Customer Service Center" | |
}, | |
{ | |
"default": "Instagram Commerce" | |
} | |
], | |
"x-label": { | |
"default": "Channel Type" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"confirmation_status": { | |
"description": "The confirmation status of the order.", | |
"enum": [ | |
"not_confirmed", | |
"confirmed" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "NOTCONFIRMED" | |
}, | |
{ | |
"default": "CONFIRMED" | |
} | |
], | |
"x-label": { | |
"default": "Confirmation Status" | |
}, | |
"type": "string" | |
}, | |
"coupon_items": { | |
"description": "The sorted array of coupon items. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/coupon_item" | |
}, | |
"type": "array" | |
}, | |
"created_by": { | |
"description": "The name of the user who created the order.", | |
"x-label": { | |
"default": "Created By" | |
}, | |
"type": "string" | |
}, | |
"creation_date": { | |
"description": "Returns the value of attribute 'creationDate'.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Creation Date" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"currency": { | |
"description": "The ISO 4217 mnemonic code of the currency.", | |
"type": "string" | |
}, | |
"customer_info": { | |
"$ref": "#/definitions/customer_info", | |
"description": "The customer information for logged in customers. This property is part of basket checkout information only." | |
}, | |
"customer_name": { | |
"description": "The name of the customer associated with this order.", | |
"x-label": { | |
"default": "Customer Name" | |
}, | |
"type": "string" | |
}, | |
"export_status": { | |
"description": "The export status of the order.", | |
"enum": [ | |
"not_exported", | |
"exported", | |
"ready", | |
"failed" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "NOTEXPORTED" | |
}, | |
{ | |
"default": "EXPORTED" | |
}, | |
{ | |
"default": "EXPORTREADY" | |
}, | |
{ | |
"default": "EXPORTFAILED" | |
} | |
], | |
"x-label": { | |
"default": "Export Status" | |
}, | |
"type": "string" | |
}, | |
"external_order_status": { | |
"description": "The external status of the order.", | |
"x-label": { | |
"default": "External Order Status" | |
}, | |
"type": "string" | |
}, | |
"gift_certificate_items": { | |
"description": "The sorted array of gift certificate line items. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/gift_certificate_item" | |
}, | |
"type": "array" | |
}, | |
"global_party_id": { | |
"description": "globalPartyId is managed by Customer 360. Its value can be changed.", | |
"type": "string" | |
}, | |
"guest": { | |
"description": "The registration status of the customer.", | |
"type": "boolean" | |
}, | |
"last_modified": { | |
"description": "Returns the value of attribute 'lastModified'.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Last Modified" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"merchandize_total_tax": { | |
"description": "The products total tax in purchase currency.\n\n Merchandize total prices represent the sum of product prices before\n services such as shipping or adjustment from promotions have\n been added.", | |
"format": "double", | |
"type": "number" | |
}, | |
"notes": { | |
"$ref": "#/definitions/simple_link", | |
"description": "The notes for the line item container." | |
}, | |
"order_no": { | |
"description": "The order number of the order.", | |
"x-label": { | |
"default": "Order No." | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"order_price_adjustments": { | |
"description": "The array of order level price adjustments. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/price_adjustment" | |
}, | |
"type": "array" | |
}, | |
"order_token": { | |
"description": "The order token used to secure the lookup of an order on base of the plain order number. The order token contains\n only URL safe characters.", | |
"type": "string" | |
}, | |
"order_total": { | |
"description": "The total price of the order, including products, shipping and tax. This property is part of basket checkout\n information only.", | |
"format": "double", | |
"x-label": { | |
"default": "Order Total" | |
}, | |
"type": "number" | |
}, | |
"payment_instruments": { | |
"description": "The payment instruments list for the order.", | |
"items": { | |
"$ref": "#/definitions/order_payment_instrument" | |
}, | |
"type": "array" | |
}, | |
"payment_status": { | |
"description": "The payment status of the order.", | |
"enum": [ | |
"not_paid", | |
"part_paid", | |
"paid" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "NOTPAID" | |
}, | |
{ | |
"default": "PARTPAID" | |
}, | |
{ | |
"default": "PAID" | |
} | |
], | |
"x-label": { | |
"default": "Payment Status" | |
}, | |
"type": "string" | |
}, | |
"product_items": { | |
"description": "The sorted array of product items (up to a maximum of 50 items). This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/product_item" | |
}, | |
"type": "array" | |
}, | |
"product_sub_total": { | |
"description": "The total price of all product items after all product discounts.\n Depending on taxation policy the returned price is net or gross.", | |
"format": "double", | |
"type": "number" | |
}, | |
"product_total": { | |
"description": "The total price of all product items after all product and order discounts.\n Depending on taxation policy the returned price is net or gross.", | |
"format": "double", | |
"type": "number" | |
}, | |
"shipments": { | |
"description": "The array of shipments. This property is part of basket checkout information only.", | |
"items": { | |
"$ref": "#/definitions/shipment" | |
}, | |
"type": "array" | |
}, | |
"shipping_items": { | |
"description": "The sorted array of shipping items. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/shipping_item" | |
}, | |
"type": "array" | |
}, | |
"shipping_status": { | |
"description": "The shipping status of the order.", | |
"enum": [ | |
"not_shipped", | |
"part_shipped", | |
"shipped" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "NOTSHIPPED" | |
}, | |
{ | |
"default": "PARTSHIPPED" | |
}, | |
{ | |
"default": "SHIPPED" | |
} | |
], | |
"x-label": { | |
"default": "Shipping Status" | |
}, | |
"type": "string" | |
}, | |
"shipping_total": { | |
"description": "The total shipping price of the order after all shipping discounts. Excludes tax if taxation policy is net. Includes\n tax if taxation policy is gross. This property is part of basket checkout information only.", | |
"format": "double", | |
"type": "number" | |
}, | |
"shipping_total_tax": { | |
"description": "The tax of all shipping line items of the line item container before\n shipping adjustments have been applied.", | |
"format": "double", | |
"type": "number" | |
}, | |
"site_id": { | |
"description": "The site where the order resides.", | |
"x-label": { | |
"default": "Site Id" | |
}, | |
"type": "string" | |
}, | |
"source_code": { | |
"description": "Gets the source code assigned to this basket.", | |
"x-label": { | |
"default": "Source Code" | |
}, | |
"type": "string" | |
}, | |
"status": { | |
"description": "The status of the order.", | |
"enum": [ | |
"created", | |
"new", | |
"open", | |
"completed", | |
"cancelled", | |
"replaced", | |
"failed" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "CREATED" | |
}, | |
{ | |
"default": "NEW" | |
}, | |
{ | |
"default": "OPEN" | |
}, | |
{ | |
"default": "COMPLETED" | |
}, | |
{ | |
"default": "CANCELLED" | |
}, | |
{ | |
"default": "REPLACED" | |
}, | |
{ | |
"default": "FAILED" | |
} | |
], | |
"x-label": { | |
"default": "Status" | |
}, | |
"type": "string" | |
}, | |
"tax_total": { | |
"description": "The total tax amount of the order. This property is part of basket checkout information only.", | |
"format": "double", | |
"type": "number" | |
}, | |
"taxation": { | |
"description": "The taxation the line item container is based on.", | |
"enum": [ | |
"gross", | |
"net" | |
], | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"c_forterDecision" | |
] | |
}, | |
"order_address": { | |
"description": "Document representing an order address.", | |
"properties": { | |
"address1": { | |
"description": "The first address.", | |
"x-label": { | |
"default": "Address 1" | |
}, | |
"type": "string" | |
}, | |
"address2": { | |
"description": "The second address.", | |
"x-label": { | |
"default": "Address 2" | |
}, | |
"type": "string" | |
}, | |
"c_alternatePhone": { | |
"x-label": { | |
"default": "Alternate Phone" | |
}, | |
"type": "string" | |
}, | |
"c_avsDate": { | |
"format": "date", | |
"x-label": { | |
"default": "FedEx AVS Date" | |
}, | |
"type": "string" | |
}, | |
"c_avsResponse": { | |
"x-label": { | |
"default": "FedEx AVS Response" | |
}, | |
"type": "string" | |
}, | |
"c_birthdate": { | |
"format": "date", | |
"x-label": { | |
"default": "Birth Date" | |
}, | |
"type": "string" | |
}, | |
"c_district": { | |
"x-label": { | |
"default": "District" | |
}, | |
"type": "string" | |
}, | |
"c_email": { | |
"x-label": { | |
"default": "Email Address" | |
}, | |
"type": "string" | |
}, | |
"c_extPostalCode": { | |
"x-label": { | |
"default": "Extended Postal Code" | |
}, | |
"type": "string" | |
}, | |
"c_firstNamePronunciation": { | |
"x-label": { | |
"default": "First Name Pronunciation" | |
}, | |
"type": "string" | |
}, | |
"c_geCityRegion": { | |
"description": "City Region", | |
"x-label": { | |
"default": "City Region" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerTaxId": { | |
"description": "Customer Tax number provided at checkout as required for clearance into certain markets", | |
"x-label": { | |
"default": "Customer Tax number" | |
}, | |
"type": "string" | |
}, | |
"c_geDeliveryStoreId": { | |
"description": "Code denoting the Merchant’s store specified by the customer for “ship to shop” shipping destination (to be mapped on Global-e side)", | |
"x-label": { | |
"default": "Delivery Store ID" | |
}, | |
"type": "string" | |
}, | |
"c_geVATRegistrationNumber": { | |
"description": "Customer VAT registration Number if provided in cart / checkout or Global-e importer entity registration number for relevant markets (eg. Switzerland)", | |
"x-label": { | |
"default": "Customer VAT registration Number" | |
}, | |
"type": "string" | |
}, | |
"c_houseNumber": { | |
"x-label": { | |
"default": "House Number" | |
}, | |
"type": "string" | |
}, | |
"c_lastNamePronunciation": { | |
"x-label": { | |
"default": "Last Name Pronunciation" | |
}, | |
"type": "string" | |
}, | |
"c_originalStateCode": { | |
"description": "The selected state code before mapping to an external armed forces state code", | |
"x-label": { | |
"default": "Original State Code" | |
}, | |
"type": "string" | |
}, | |
"c_paypalAddressStatus": { | |
"description": "valid values are none, confirmed, unconfirmed", | |
"x-label": { | |
"default": "PayPal Address Status" | |
}, | |
"type": "string" | |
}, | |
"c_phoneForPopStation": { | |
"x-label": { | |
"default": "Phone For Pop Station" | |
}, | |
"type": "string" | |
}, | |
"c_radialAVSValidated": { | |
"x-label": { | |
"default": "Radial AVS Validated" | |
}, | |
"type": "boolean" | |
}, | |
"c_remarks": { | |
"x-label": { | |
"default": "Remarks" | |
}, | |
"type": "string" | |
}, | |
"c_rssClientCommunicationID": { | |
"x-label": { | |
"default": "RiskCheck call client communication ID" | |
}, | |
"type": "string" | |
}, | |
"c_rssResultCode": { | |
"x-label": { | |
"default": "RiskCheck call result code" | |
}, | |
"type": "string" | |
}, | |
"c_shortPostalCode": { | |
"x-label": { | |
"default": "Short Postal Code" | |
}, | |
"type": "string" | |
}, | |
"c_streetName": { | |
"x-label": { | |
"default": "Street Name" | |
}, | |
"type": "string" | |
}, | |
"city": { | |
"description": "The city.", | |
"x-label": { | |
"default": "City" | |
}, | |
"type": "string" | |
}, | |
"company_name": { | |
"description": "The company name.", | |
"x-label": { | |
"default": "Company" | |
}, | |
"type": "string" | |
}, | |
"country_code": { | |
"description": "The two-letter ISO 3166-1 (Alpha-2) country code.", | |
"enum": [ | |
"AT", | |
"BE", | |
"CH", | |
"FR", | |
"GB", | |
"US", | |
"CA", | |
"DE", | |
"ES", | |
"NL", | |
"CZ", | |
"EE", | |
"HU", | |
"IE", | |
"IT", | |
"LV", | |
"PL", | |
"PT", | |
"SI", | |
"SK", | |
"GR", | |
"LU", | |
"DK", | |
"FI", | |
"SE", | |
"BG", | |
"HR", | |
"LT", | |
"RO", | |
"JP", | |
"KR", | |
"PH", | |
"TH" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Austria" | |
}, | |
{ | |
"default": "Switzerland" | |
}, | |
{ | |
"default": "France" | |
}, | |
{ | |
"default": "Great Britain" | |
}, | |
{ | |
"default": "United States" | |
}, | |
{ | |
"default": "Canada" | |
}, | |
{ | |
"de": "Deutschland", | |
"default": "Germany" | |
}, | |
{ | |
"default": "Ireland" | |
}, | |
{ | |
"default": "Denmark" | |
}, | |
{ | |
"default": "Finland" | |
}, | |
{ | |
"default": "Sweden" | |
}, | |
{ | |
"default": "Japan" | |
}, | |
{ | |
"default": "대한민국" | |
}, | |
{ | |
"default": "Philippines" | |
}, | |
{ | |
"default": "Thailand", | |
"th-TH": "ประเทศไทย" | |
} | |
], | |
"x-label": { | |
"default": "Country" | |
}, | |
"type": "string" | |
}, | |
"first_name": { | |
"description": "The first name.", | |
"x-label": { | |
"default": "First Name" | |
}, | |
"type": "string" | |
}, | |
"full_name": { | |
"description": "The full name.", | |
"x-label": { | |
"default": "Full Name" | |
}, | |
"type": "string" | |
}, | |
"id": { | |
"description": "Id used to identify this address", | |
"type": "string" | |
}, | |
"job_title": { | |
"description": "The job title.", | |
"x-label": { | |
"default": "Job Title" | |
}, | |
"type": "string" | |
}, | |
"last_name": { | |
"description": "The last name.", | |
"x-label": { | |
"default": "Last Name" | |
}, | |
"type": "string" | |
}, | |
"phone": { | |
"description": "The phone number.", | |
"x-label": { | |
"default": "Contact Phone" | |
}, | |
"type": "string" | |
}, | |
"post_box": { | |
"description": "The post box.", | |
"x-label": { | |
"default": "Post Box" | |
}, | |
"type": "string" | |
}, | |
"postal_code": { | |
"description": "The postal code.", | |
"x-label": { | |
"default": "Postal Code" | |
}, | |
"type": "string" | |
}, | |
"salutation": { | |
"description": "The salutation.", | |
"x-label": { | |
"default": "Salutation" | |
}, | |
"type": "string" | |
}, | |
"second_name": { | |
"description": "The second name.", | |
"x-label": { | |
"default": "Second Name" | |
}, | |
"type": "string" | |
}, | |
"state_code": { | |
"description": "The state code.", | |
"x-label": { | |
"default": "State" | |
}, | |
"type": "string" | |
}, | |
"suffix": { | |
"description": "The suffix.", | |
"x-label": { | |
"default": "Suffix" | |
}, | |
"type": "string" | |
}, | |
"suite": { | |
"description": "The suite.", | |
"x-label": { | |
"default": "Suite No." | |
}, | |
"type": "string" | |
}, | |
"title": { | |
"description": "The title.", | |
"x-label": { | |
"default": "Title" | |
}, | |
"type": "string" | |
} | |
} | |
}, | |
"order_payment_card_request": { | |
"description": "Document representing an order payment card request.", | |
"properties": { | |
"card_type": { | |
"description": "", | |
"x-label": { | |
"default": "Credit Card Type" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"credit_card_expired": { | |
"description": "A flag indicating if the credit card is expired.", | |
"type": "boolean" | |
}, | |
"credit_card_token": { | |
"description": "", | |
"type": "string" | |
}, | |
"expiration_month": { | |
"description": "", | |
"format": "int32", | |
"x-label": { | |
"default": "Credit Card Expiration Month" | |
}, | |
"type": "integer" | |
}, | |
"expiration_year": { | |
"description": "", | |
"format": "int32", | |
"x-label": { | |
"default": "Credit Card Expiration Year" | |
}, | |
"type": "integer" | |
}, | |
"holder": { | |
"description": "", | |
"x-label": { | |
"default": "Credit Card Holder" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"issue_number": { | |
"description": "", | |
"x-label": { | |
"default": "Credit Card Issue Number" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"number": { | |
"description": "", | |
"x-label": { | |
"default": "Credit Card Number" | |
}, | |
"maxLength": 4000, | |
"type": "string" | |
}, | |
"security_code": { | |
"description": "The security code for the payment card.", | |
"x-label": { | |
"default": "CVC" | |
}, | |
"maxLength": 4, | |
"type": "string" | |
}, | |
"valid_from_month": { | |
"description": "", | |
"format": "int32", | |
"x-label": { | |
"default": "Credit Card Valid From Month" | |
}, | |
"maximum": 12, | |
"minimum": 1, | |
"type": "integer" | |
}, | |
"valid_from_year": { | |
"description": "", | |
"format": "int32", | |
"x-label": { | |
"default": "Credit Card Valid From Year" | |
}, | |
"type": "integer" | |
} | |
} | |
}, | |
"order_payment_instrument": { | |
"description": "Document representing an order payment instrument.", | |
"properties": { | |
"amount": { | |
"description": "The payment transaction amount.", | |
"format": "double", | |
"type": "number" | |
}, | |
"authorization_status": { | |
"$ref": "#/definitions/status", | |
"description": "The authorization status of the payment transaction." | |
}, | |
"bank_routing_number": { | |
"description": "The bank routing number.", | |
"x-label": { | |
"default": "Bank Routing Number" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"c_ComputopCode": { | |
"x-label": { | |
"default": "Computop code" | |
}, | |
"type": "string" | |
}, | |
"c_ComputopStatus": { | |
"x-label": { | |
"default": "Computop status" | |
}, | |
"type": "string" | |
}, | |
"c_adyenAction": { | |
"description": "Action data from payment response", | |
"x-label": { | |
"default": "adyenAction" | |
}, | |
"type": "string" | |
}, | |
"c_adyenAdditionalPaymentData": { | |
"description": "Additional data for payment method", | |
"x-label": { | |
"default": "adyenAdditionalPaymentData" | |
}, | |
"type": "string" | |
}, | |
"c_adyenIssuerName": { | |
"description": "Selected issuer name", | |
"x-label": { | |
"default": "adyenIssuerName" | |
}, | |
"type": "string" | |
}, | |
"c_adyenPaymentData": { | |
"description": "Adyen PaymentData 3D Secure", | |
"format": "text", | |
"x-label": { | |
"default": "adyenPaymentData" | |
}, | |
"type": "string" | |
}, | |
"c_adyenPaymentMethod": { | |
"description": "paymentMethod used by shopper", | |
"x-label": { | |
"default": "adyenPaymentMethod" | |
}, | |
"type": "string" | |
}, | |
"c_ambassadorCardNumber": { | |
"x-label": { | |
"default": "Ambassador Card Number" | |
}, | |
"type": "string" | |
}, | |
"c_ambassadorCardPin": { | |
"x-label": { | |
"default": "Ambassador Card Pin" | |
}, | |
"type": "string" | |
}, | |
"c_authorize_net_authorization": { | |
"x-label": { | |
"default": "Authorize.net Authorization response" | |
}, | |
"type": "string" | |
}, | |
"c_authorize_net_authorization_json": { | |
"x-label": { | |
"default": "Authorize.net Authorization response" | |
}, | |
"type": "string" | |
}, | |
"c_authorize_net_capture": { | |
"x-label": { | |
"default": "Authorize.net Capture response" | |
}, | |
"type": "string" | |
}, | |
"c_authorize_net_void": { | |
"x-label": { | |
"default": "Authorize.net Void response" | |
}, | |
"type": "string" | |
}, | |
"c_avsCodeRaw": { | |
"x-label": { | |
"default": "avsCodeRaw" | |
}, | |
"type": "string" | |
}, | |
"c_callId": { | |
"x-label": { | |
"default": "callId" | |
}, | |
"type": "string" | |
}, | |
"c_cardArtFileName": { | |
"x-label": { | |
"default": "cardArtFileName" | |
}, | |
"type": "string" | |
}, | |
"c_cardArtHeight": { | |
"x-label": { | |
"default": "cardArtHeight" | |
}, | |
"type": "string" | |
}, | |
"c_cardArtWidth": { | |
"x-label": { | |
"default": "cardArtWidth" | |
}, | |
"type": "string" | |
}, | |
"c_cavv": { | |
"x-label": { | |
"default": "cavv" | |
}, | |
"type": "string" | |
}, | |
"c_creditCardSeq": { | |
"x-label": { | |
"default": "Credit Card Seq" | |
}, | |
"type": "string" | |
}, | |
"c_creditCardToken": { | |
"x-label": { | |
"default": "Credit Card Token" | |
}, | |
"type": "string" | |
}, | |
"c_creditCardToken1": { | |
"x-label": { | |
"default": "Add new card token" | |
}, | |
"type": "string" | |
}, | |
"c_creditHolderName": { | |
"x-label": { | |
"default": "Credit Card Holder Name" | |
}, | |
"type": "string" | |
}, | |
"c_eciRaw": { | |
"x-label": { | |
"default": "eciRaw" | |
}, | |
"type": "string" | |
}, | |
"c_externalCardType": { | |
"x-label": { | |
"default": "External Card Type" | |
}, | |
"type": "string" | |
}, | |
"c_memberIsSaveCard": { | |
"x-label": { | |
"default": "Member is save card" | |
}, | |
"type": "boolean" | |
}, | |
"c_naverPaymentMethod": { | |
"x-label": { | |
"default": "Naver Payment Method" | |
}, | |
"type": "string" | |
}, | |
"c_paresStatus": { | |
"x-label": { | |
"default": "paresStatus" | |
}, | |
"type": "string" | |
}, | |
"c_paresTimeStamp": { | |
"x-label": { | |
"default": "paresTimeStamp" | |
}, | |
"type": "string" | |
}, | |
"c_payPalAddressStatus": { | |
"x-label": { | |
"default": "Paypal Address Status" | |
}, | |
"type": "string" | |
}, | |
"c_payPalPayerStatus": { | |
"x-label": { | |
"default": "Paypal Payer Status" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorCCBrand": { | |
"x-label": { | |
"default": "PaymentOperator CC Brand", | |
"zh-CN": "Computop 信用卡品牌" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorCCExpiry": { | |
"x-label": { | |
"default": "PaymentOperator CC Expiry date", | |
"zh-CN": "Computop 信用卡有效期" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorCCIssuer": { | |
"x-label": { | |
"default": "PaymentOperator CC Issuer", | |
"zh-CN": "Computop 信用卡发卡行" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorCCNr": { | |
"x-label": { | |
"default": "PaymentOperator Pseudo card number", | |
"zh-CN": "Computop 虚拟卡号" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorECInterestAmount": { | |
"x-label": { | |
"default": "PaymentOperator easyCredit interest amount" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorECTechnicalTransactionID": { | |
"x-label": { | |
"default": "PaymentOperator easyCredit technical transaction ID" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorECTransactionID": { | |
"x-label": { | |
"default": "PaymentOperator easyCredit transaction ID" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorOTAccBank": { | |
"x-label": { | |
"default": "PaymentOperator online transfer bank name", | |
"zh-CN": "Computop 在线转账银行名称" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorOTAccIBAN": { | |
"x-label": { | |
"default": "PaymentOperator online transfer bank account number", | |
"zh-CN": "Computop 在线转账银行帐号" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorOTAccOwner": { | |
"x-label": { | |
"default": "PaymentOperator online transfer account owner", | |
"zh-CN": "Computop 在线转帐帐户持有人" | |
}, | |
"type": "string" | |
}, | |
"c_paypalAuthID": { | |
"x-label": { | |
"default": "PayPal Auth ID" | |
}, | |
"type": "string" | |
}, | |
"c_paypalOrigination": { | |
"x-label": { | |
"default": "PayPal Origination" | |
}, | |
"type": "string" | |
}, | |
"c_paypalPayerID": { | |
"x-label": { | |
"default": "PayPal Payer ID" | |
}, | |
"type": "string" | |
}, | |
"c_paypalPayerStatus": { | |
"description": "valid values are verified or unverified", | |
"x-label": { | |
"default": "PayPal Payer Status" | |
}, | |
"type": "string" | |
}, | |
"c_paypalPaymentAction": { | |
"x-label": { | |
"default": "PayPal Payment Action" | |
}, | |
"type": "string" | |
}, | |
"c_paypalToken": { | |
"description": "Needed for proper NVP Paypal Transactions", | |
"x-label": { | |
"default": "PayPal Token" | |
}, | |
"type": "string" | |
}, | |
"c_paypalTransactionID": { | |
"x-label": { | |
"default": "PayPal Transaction ID" | |
}, | |
"type": "string" | |
}, | |
"c_radialApplePayEvent": { | |
"description": "Temporarily stores the event information in order to facilitate the Apple Pay integration with Radial.", | |
"format": "text", | |
"x-label": { | |
"default": "Apple Pay Event" | |
}, | |
"type": "string" | |
}, | |
"c_radialApplePayExpirationMonth": { | |
"x-label": { | |
"default": "Radial Apple Pay Expiration Month" | |
}, | |
"type": "string" | |
}, | |
"c_radialApplePayExpirationYear": { | |
"x-label": { | |
"default": "Radial Apple Pay Expiration Year" | |
}, | |
"type": "string" | |
}, | |
"c_radialApplePayTransactionId": { | |
"description": "Unique transaction ID for Apple Pay transactions.", | |
"x-label": { | |
"default": "Apple Pay Transaction ID" | |
}, | |
"type": "string" | |
}, | |
"c_radialGiftCardNumber": { | |
"x-label": { | |
"default": "Radial Gift Card Number" | |
}, | |
"type": "string" | |
}, | |
"c_radialGiftCardPinCode": { | |
"x-label": { | |
"default": "Radial Gift Card Pin Code" | |
}, | |
"type": "string" | |
}, | |
"c_radialMaskedGiftCardNumber": { | |
"x-label": { | |
"default": "Radial Masked Gift Card Number" | |
}, | |
"type": "string" | |
}, | |
"c_radialPayPalTransactionId": { | |
"description": "Radial PayPal Transaction Id", | |
"x-label": { | |
"default": "Radial PayPal Transaction Id" | |
}, | |
"type": "string" | |
}, | |
"c_radialPaymentToken": { | |
"x-label": { | |
"default": "Radial Gift Card Token" | |
}, | |
"type": "string" | |
}, | |
"c_radialPaypalEmail": { | |
"x-label": { | |
"default": "Radial Paypal Email" | |
}, | |
"type": "string" | |
}, | |
"c_radialPaypalPayerID": { | |
"x-label": { | |
"default": "Radial Paypal Payer ID" | |
}, | |
"type": "string" | |
}, | |
"c_radialPaypalToken": { | |
"description": "Radial Paypal Token", | |
"x-label": { | |
"default": "Radial Paypal Token" | |
}, | |
"type": "string" | |
}, | |
"c_riskAdvice": { | |
"x-label": { | |
"default": "riskAdvice" | |
}, | |
"type": "string" | |
}, | |
"c_riskScore": { | |
"x-label": { | |
"default": "riskScore" | |
}, | |
"type": "string" | |
}, | |
"c_savecard": { | |
"x-label": { | |
"default": "savecard" | |
}, | |
"type": "boolean" | |
}, | |
"c_svsGiftCardNumber": { | |
"x-label": { | |
"default": "SVS Gift Card Number" | |
}, | |
"type": "string" | |
}, | |
"c_svsGiftCardPinCode": { | |
"x-label": { | |
"default": "SVS Gift Card Pin Code" | |
}, | |
"type": "string" | |
}, | |
"c_svsMaskedGiftCardNumber": { | |
"x-label": { | |
"default": "SVS Masked Gift Card Number" | |
}, | |
"type": "string" | |
}, | |
"c_vcDecryptReasonCode": { | |
"x-label": { | |
"default": "vcDecryptReasonCode" | |
}, | |
"type": "string" | |
}, | |
"c_vcDecryptRequestId": { | |
"x-label": { | |
"default": "vcDecryptRequestId" | |
}, | |
"type": "string" | |
}, | |
"c_veresEnrolled": { | |
"x-label": { | |
"default": "veresEnrolled" | |
}, | |
"type": "string" | |
}, | |
"c_veresTimeStamp": { | |
"x-label": { | |
"default": "veresTimeStamp" | |
}, | |
"type": "string" | |
}, | |
"c_xid": { | |
"x-label": { | |
"default": "xid" | |
}, | |
"type": "string" | |
}, | |
"masked_gift_certificate_code": { | |
"description": "The masked gift certificate code.", | |
"type": "string" | |
}, | |
"payment_bank_account": { | |
"$ref": "#/definitions/payment_bank_account", | |
"description": "The payment bank account." | |
}, | |
"payment_card": { | |
"$ref": "#/definitions/payment_card", | |
"description": "The payment card." | |
}, | |
"payment_instrument_id": { | |
"description": "The payment instrument ID.", | |
"type": "string" | |
}, | |
"payment_method_id": { | |
"description": "The payment method id. Optional if a customer payment instrument id is specified.", | |
"maxLength": 256, | |
"type": "string" | |
} | |
} | |
}, | |
"order_payment_instrument_request": { | |
"description": "Document representing an order payment instrument request.", | |
"properties": { | |
"amount": { | |
"description": "The payment transaction amount.", | |
"format": "double", | |
"x-label": { | |
"default": "Amount" | |
}, | |
"type": "number" | |
}, | |
"bank_routing_number": { | |
"description": "The bank routing number.", | |
"x-label": { | |
"default": "Bank Routing Number" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"c_ComputopCode": { | |
"x-label": { | |
"default": "Computop code" | |
}, | |
"type": "string" | |
}, | |
"c_ComputopStatus": { | |
"x-label": { | |
"default": "Computop status" | |
}, | |
"type": "string" | |
}, | |
"c_adyenAction": { | |
"description": "Action data from payment response", | |
"x-label": { | |
"default": "adyenAction" | |
}, | |
"type": "string" | |
}, | |
"c_adyenAdditionalPaymentData": { | |
"description": "Additional data for payment method", | |
"x-label": { | |
"default": "adyenAdditionalPaymentData" | |
}, | |
"type": "string" | |
}, | |
"c_adyenIssuerName": { | |
"description": "Selected issuer name", | |
"x-label": { | |
"default": "adyenIssuerName" | |
}, | |
"type": "string" | |
}, | |
"c_adyenPaymentData": { | |
"description": "Adyen PaymentData 3D Secure", | |
"format": "text", | |
"x-label": { | |
"default": "adyenPaymentData" | |
}, | |
"type": "string" | |
}, | |
"c_adyenPaymentMethod": { | |
"description": "paymentMethod used by shopper", | |
"x-label": { | |
"default": "adyenPaymentMethod" | |
}, | |
"type": "string" | |
}, | |
"c_ambassadorCardNumber": { | |
"x-label": { | |
"default": "Ambassador Card Number" | |
}, | |
"type": "string" | |
}, | |
"c_ambassadorCardPin": { | |
"x-label": { | |
"default": "Ambassador Card Pin" | |
}, | |
"type": "string" | |
}, | |
"c_authorize_net_authorization": { | |
"x-label": { | |
"default": "Authorize.net Authorization response" | |
}, | |
"type": "string" | |
}, | |
"c_authorize_net_authorization_json": { | |
"x-label": { | |
"default": "Authorize.net Authorization response" | |
}, | |
"type": "string" | |
}, | |
"c_authorize_net_capture": { | |
"x-label": { | |
"default": "Authorize.net Capture response" | |
}, | |
"type": "string" | |
}, | |
"c_authorize_net_void": { | |
"x-label": { | |
"default": "Authorize.net Void response" | |
}, | |
"type": "string" | |
}, | |
"c_avsCodeRaw": { | |
"x-label": { | |
"default": "avsCodeRaw" | |
}, | |
"type": "string" | |
}, | |
"c_callId": { | |
"x-label": { | |
"default": "callId" | |
}, | |
"type": "string" | |
}, | |
"c_cardArtFileName": { | |
"x-label": { | |
"default": "cardArtFileName" | |
}, | |
"type": "string" | |
}, | |
"c_cardArtHeight": { | |
"x-label": { | |
"default": "cardArtHeight" | |
}, | |
"type": "string" | |
}, | |
"c_cardArtWidth": { | |
"x-label": { | |
"default": "cardArtWidth" | |
}, | |
"type": "string" | |
}, | |
"c_cavv": { | |
"x-label": { | |
"default": "cavv" | |
}, | |
"type": "string" | |
}, | |
"c_creditCardSeq": { | |
"x-label": { | |
"default": "Credit Card Seq" | |
}, | |
"type": "string" | |
}, | |
"c_creditCardToken": { | |
"x-label": { | |
"default": "Credit Card Token" | |
}, | |
"type": "string" | |
}, | |
"c_creditCardToken1": { | |
"x-label": { | |
"default": "Add new card token" | |
}, | |
"type": "string" | |
}, | |
"c_creditHolderName": { | |
"x-label": { | |
"default": "Credit Card Holder Name" | |
}, | |
"type": "string" | |
}, | |
"c_eciRaw": { | |
"x-label": { | |
"default": "eciRaw" | |
}, | |
"type": "string" | |
}, | |
"c_externalCardType": { | |
"x-label": { | |
"default": "External Card Type" | |
}, | |
"type": "string" | |
}, | |
"c_memberIsSaveCard": { | |
"x-label": { | |
"default": "Member is save card" | |
}, | |
"type": "boolean" | |
}, | |
"c_naverPaymentMethod": { | |
"x-label": { | |
"default": "Naver Payment Method" | |
}, | |
"type": "string" | |
}, | |
"c_paresStatus": { | |
"x-label": { | |
"default": "paresStatus" | |
}, | |
"type": "string" | |
}, | |
"c_paresTimeStamp": { | |
"x-label": { | |
"default": "paresTimeStamp" | |
}, | |
"type": "string" | |
}, | |
"c_payPalAddressStatus": { | |
"x-label": { | |
"default": "Paypal Address Status" | |
}, | |
"type": "string" | |
}, | |
"c_payPalPayerStatus": { | |
"x-label": { | |
"default": "Paypal Payer Status" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorCCBrand": { | |
"x-label": { | |
"default": "PaymentOperator CC Brand", | |
"zh-CN": "Computop 信用卡品牌" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorCCExpiry": { | |
"x-label": { | |
"default": "PaymentOperator CC Expiry date", | |
"zh-CN": "Computop 信用卡有效期" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorCCIssuer": { | |
"x-label": { | |
"default": "PaymentOperator CC Issuer", | |
"zh-CN": "Computop 信用卡发卡行" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorCCNr": { | |
"x-label": { | |
"default": "PaymentOperator Pseudo card number", | |
"zh-CN": "Computop 虚拟卡号" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorECInterestAmount": { | |
"x-label": { | |
"default": "PaymentOperator easyCredit interest amount" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorECTechnicalTransactionID": { | |
"x-label": { | |
"default": "PaymentOperator easyCredit technical transaction ID" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorECTransactionID": { | |
"x-label": { | |
"default": "PaymentOperator easyCredit transaction ID" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorOTAccBank": { | |
"x-label": { | |
"default": "PaymentOperator online transfer bank name", | |
"zh-CN": "Computop 在线转账银行名称" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorOTAccIBAN": { | |
"x-label": { | |
"default": "PaymentOperator online transfer bank account number", | |
"zh-CN": "Computop 在线转账银行帐号" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorOTAccOwner": { | |
"x-label": { | |
"default": "PaymentOperator online transfer account owner", | |
"zh-CN": "Computop 在线转帐帐户持有人" | |
}, | |
"type": "string" | |
}, | |
"c_paypalAuthID": { | |
"x-label": { | |
"default": "PayPal Auth ID" | |
}, | |
"type": "string" | |
}, | |
"c_paypalOrigination": { | |
"x-label": { | |
"default": "PayPal Origination" | |
}, | |
"type": "string" | |
}, | |
"c_paypalPayerID": { | |
"x-label": { | |
"default": "PayPal Payer ID" | |
}, | |
"type": "string" | |
}, | |
"c_paypalPayerStatus": { | |
"description": "valid values are verified or unverified", | |
"x-label": { | |
"default": "PayPal Payer Status" | |
}, | |
"type": "string" | |
}, | |
"c_paypalPaymentAction": { | |
"x-label": { | |
"default": "PayPal Payment Action" | |
}, | |
"type": "string" | |
}, | |
"c_paypalToken": { | |
"description": "Needed for proper NVP Paypal Transactions", | |
"x-label": { | |
"default": "PayPal Token" | |
}, | |
"type": "string" | |
}, | |
"c_paypalTransactionID": { | |
"x-label": { | |
"default": "PayPal Transaction ID" | |
}, | |
"type": "string" | |
}, | |
"c_radialApplePayEvent": { | |
"description": "Temporarily stores the event information in order to facilitate the Apple Pay integration with Radial.", | |
"format": "text", | |
"x-label": { | |
"default": "Apple Pay Event" | |
}, | |
"type": "string" | |
}, | |
"c_radialApplePayExpirationMonth": { | |
"x-label": { | |
"default": "Radial Apple Pay Expiration Month" | |
}, | |
"type": "string" | |
}, | |
"c_radialApplePayExpirationYear": { | |
"x-label": { | |
"default": "Radial Apple Pay Expiration Year" | |
}, | |
"type": "string" | |
}, | |
"c_radialApplePayTransactionId": { | |
"description": "Unique transaction ID for Apple Pay transactions.", | |
"x-label": { | |
"default": "Apple Pay Transaction ID" | |
}, | |
"type": "string" | |
}, | |
"c_radialGiftCardNumber": { | |
"x-label": { | |
"default": "Radial Gift Card Number" | |
}, | |
"type": "string" | |
}, | |
"c_radialGiftCardPinCode": { | |
"x-label": { | |
"default": "Radial Gift Card Pin Code" | |
}, | |
"type": "string" | |
}, | |
"c_radialMaskedGiftCardNumber": { | |
"x-label": { | |
"default": "Radial Masked Gift Card Number" | |
}, | |
"type": "string" | |
}, | |
"c_radialPayPalTransactionId": { | |
"description": "Radial PayPal Transaction Id", | |
"x-label": { | |
"default": "Radial PayPal Transaction Id" | |
}, | |
"type": "string" | |
}, | |
"c_radialPaymentToken": { | |
"x-label": { | |
"default": "Radial Gift Card Token" | |
}, | |
"type": "string" | |
}, | |
"c_radialPaypalEmail": { | |
"x-label": { | |
"default": "Radial Paypal Email" | |
}, | |
"type": "string" | |
}, | |
"c_radialPaypalPayerID": { | |
"x-label": { | |
"default": "Radial Paypal Payer ID" | |
}, | |
"type": "string" | |
}, | |
"c_radialPaypalToken": { | |
"description": "Radial Paypal Token", | |
"x-label": { | |
"default": "Radial Paypal Token" | |
}, | |
"type": "string" | |
}, | |
"c_riskAdvice": { | |
"x-label": { | |
"default": "riskAdvice" | |
}, | |
"type": "string" | |
}, | |
"c_riskScore": { | |
"x-label": { | |
"default": "riskScore" | |
}, | |
"type": "string" | |
}, | |
"c_savecard": { | |
"x-label": { | |
"default": "savecard" | |
}, | |
"type": "boolean" | |
}, | |
"c_svsGiftCardNumber": { | |
"x-label": { | |
"default": "SVS Gift Card Number" | |
}, | |
"type": "string" | |
}, | |
"c_svsGiftCardPinCode": { | |
"x-label": { | |
"default": "SVS Gift Card Pin Code" | |
}, | |
"type": "string" | |
}, | |
"c_svsMaskedGiftCardNumber": { | |
"x-label": { | |
"default": "SVS Masked Gift Card Number" | |
}, | |
"type": "string" | |
}, | |
"c_vcDecryptReasonCode": { | |
"x-label": { | |
"default": "vcDecryptReasonCode" | |
}, | |
"type": "string" | |
}, | |
"c_vcDecryptRequestId": { | |
"x-label": { | |
"default": "vcDecryptRequestId" | |
}, | |
"type": "string" | |
}, | |
"c_veresEnrolled": { | |
"x-label": { | |
"default": "veresEnrolled" | |
}, | |
"type": "string" | |
}, | |
"c_veresTimeStamp": { | |
"x-label": { | |
"default": "veresTimeStamp" | |
}, | |
"type": "string" | |
}, | |
"c_xid": { | |
"x-label": { | |
"default": "xid" | |
}, | |
"type": "string" | |
}, | |
"create_customer_payment_instrument": { | |
"description": "A flag indicating whether a related customer payment instrument should be created. The CustomerPaymentInstrument\n is only created when the OrderPaymentInstrument was authorized successfully.", | |
"type": "boolean" | |
}, | |
"customer_payment_instrument_id": { | |
"description": "The id of a customer payment instrument.", | |
"type": "string" | |
}, | |
"gift_certificate_code": { | |
"description": "The gift certificate code.", | |
"x-label": { | |
"default": "Gift Code" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"payment_bank_account": { | |
"$ref": "#/definitions/payment_bank_account_request", | |
"description": "The payment bank account request data." | |
}, | |
"payment_card": { | |
"$ref": "#/definitions/order_payment_card_request", | |
"description": "The payment card." | |
}, | |
"payment_method_id": { | |
"description": "The payment method id. Optional if a customer payment instrument id is specified.", | |
"maxLength": 256, | |
"type": "string" | |
} | |
} | |
}, | |
"order_search_hit": { | |
"description": "Document representing an order search hit.", | |
"properties": { | |
"data": { | |
"$ref": "#/definitions/order", | |
"description": "" | |
}, | |
"relevance": { | |
"description": "The hit's relevance score.", | |
"format": "double", | |
"type": "number" | |
} | |
} | |
}, | |
"order_search_request": { | |
"description": "Document representing an order search request.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents", | |
"format": "int32", | |
"maximum": 200, | |
"minimum": 1, | |
"type": "integer" | |
}, | |
"db_start_record_": { | |
"description": "The zero-based index of the record that we want to start with, used to optimize special handling", | |
"format": "int32", | |
"minimum": 0, | |
"type": "integer" | |
}, | |
"expand": { | |
"description": "List of expansions to be applied to each search results. Expands are optional", | |
"items": { | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"query": { | |
"$ref": "#/definitions/query", | |
"description": "The query to apply", | |
"x-sub_types": { | |
"nested_query": "#/definitions/nested_query", | |
"filtered_query": "#/definitions/filtered_query", | |
"text_query": "#/definitions/text_query", | |
"match_all_query": "#/definitions/match_all_query", | |
"term_query": "#/definitions/term_query", | |
"bool_query": "#/definitions/bool_query" | |
} | |
}, | |
"select": { | |
"description": "The field to be selected.", | |
"type": "string" | |
}, | |
"sorts": { | |
"description": "The list of sort clauses configured for the search request. Sort clauses are optional.", | |
"items": { | |
"$ref": "#/definitions/sort" | |
}, | |
"type": "array" | |
}, | |
"start": { | |
"description": "The zero-based index of the first search hit to include in the result.", | |
"format": "int32", | |
"minimum": 0, | |
"type": "integer" | |
} | |
}, | |
"required": [ | |
"query" | |
] | |
}, | |
"order_search_result": { | |
"description": "Document representing an order search result.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"items": { | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"db_start_record_": { | |
"description": "The zero-based index of the record that we want to start with, used to optimize special handling", | |
"format": "int32", | |
"minimum": 0, | |
"type": "integer" | |
}, | |
"expand": { | |
"description": "List of expansions to be applied to each search results. Expands are optional", | |
"items": { | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"hits": { | |
"description": "The sorted array of search hits. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/order_search_hit" | |
}, | |
"type": "array" | |
}, | |
"next": { | |
"$ref": "#/definitions/result_page", | |
"description": "The URL of the next result page." | |
}, | |
"previous": { | |
"$ref": "#/definitions/result_page", | |
"description": "The URL of the previous result page." | |
}, | |
"query": { | |
"$ref": "#/definitions/query", | |
"description": "The query passed into the search", | |
"x-sub_types": { | |
"nested_query": "#/definitions/nested_query", | |
"filtered_query": "#/definitions/filtered_query", | |
"text_query": "#/definitions/text_query", | |
"match_all_query": "#/definitions/match_all_query", | |
"term_query": "#/definitions/term_query", | |
"bool_query": "#/definitions/bool_query" | |
} | |
}, | |
"select": { | |
"description": "The fields that you want to select.", | |
"type": "string" | |
}, | |
"sorts": { | |
"description": "The list of sort clauses configured for the search request. Sort clauses are optional.", | |
"items": { | |
"$ref": "#/definitions/sort" | |
}, | |
"type": "array" | |
}, | |
"start": { | |
"description": "The zero-based index of the first search hit to include in the result.", | |
"format": "int32", | |
"minimum": 0, | |
"type": "integer" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"password_change_request": { | |
"description": "Document representing a password change request.", | |
"properties": { | |
"current_password": { | |
"description": "The customer's current password.", | |
"maxLength": 4096, | |
"type": "string" | |
}, | |
"password": { | |
"description": "The customer's new password.", | |
"maxLength": 4096, | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"current_password", | |
"password" | |
] | |
}, | |
"password_reset": { | |
"description": "Document representing a password reset request.", | |
"properties": { | |
"identification": { | |
"description": "The customer's login or the customer's email depending on the type value.", | |
"type": "string" | |
}, | |
"type": { | |
"description": "The type of customer identification.", | |
"enum": [ | |
"email", | |
"login" | |
], | |
"type": "string" | |
} | |
} | |
}, | |
"path_record": { | |
"description": "Document representing most basic info (id and name) of a category or catalog.", | |
"properties": { | |
"id": { | |
"description": "The id of the category path.", | |
"x-label": { | |
"default": "ID" | |
}, | |
"type": "string" | |
}, | |
"name": { | |
"description": "The name of the category path.", | |
"x-label": { | |
"default": "Name" | |
}, | |
"type": "string" | |
} | |
} | |
}, | |
"payment_bank_account": { | |
"description": "Document representing a payment bank account.", | |
"properties": { | |
"drivers_license_last_digits": { | |
"description": "The last 4 characters of the decrypted driver's license number of the bank account associated with this payment\n instrument.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"drivers_license_state_code": { | |
"description": "The driver license state code.", | |
"x-label": { | |
"default": "Bank Account Drivers License State" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"holder": { | |
"description": "The holder of the bank account.", | |
"x-label": { | |
"default": "Bank Account Holder" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"masked_drivers_license": { | |
"description": "The decrypted driver's license number of the bank account with all but the last 4 characters replaced with a '*'\n character.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"masked_number": { | |
"description": "The bank account masked number.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"number_last_digits": { | |
"description": "The last digits of the bank account number.", | |
"maxLength": 256, | |
"type": "string" | |
} | |
} | |
}, | |
"payment_bank_account_request": { | |
"description": "Document representing a payment bank account request.", | |
"properties": { | |
"drivers_license": { | |
"description": "The drivers license.", | |
"x-label": { | |
"default": "Bank Account Drivers License" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"drivers_license_state_code": { | |
"description": "The driver license state code.", | |
"x-label": { | |
"default": "Bank Account Drivers License State" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"holder": { | |
"description": "The holder of the bank account.", | |
"x-label": { | |
"default": "Bank Account Holder" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"number": { | |
"description": "The payment bank account number.", | |
"x-label": { | |
"default": "Bank Account Number" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
} | |
} | |
}, | |
"payment_card": { | |
"description": "Document representing a payment card.", | |
"properties": { | |
"c_csEnablePayerAuthentication": { | |
"x-label": { | |
"default": "Enable Payer Authenticaton" | |
}, | |
"type": "boolean" | |
}, | |
"c_externalCardType": { | |
"x-label": { | |
"default": "External Card Type" | |
}, | |
"type": "string" | |
}, | |
"c_wirecardCardType": { | |
"x-label": { | |
"default": "Wirecard Card Type" | |
}, | |
"type": "string" | |
}, | |
"c_wirecardTransactionType": { | |
"x-label": { | |
"default": "Wirecard Transaction Type" | |
}, | |
"type": "string" | |
}, | |
"card_type": { | |
"description": "The payment card type (for example, 'Visa').", | |
"x-label": { | |
"default": "Type" | |
}, | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"credit_card_expired": { | |
"description": "A flag indicating if the credit card is expired.", | |
"type": "boolean" | |
}, | |
"credit_card_token": { | |
"description": "A credit card token. If a credit card is tokenized, the token can be used to look up the credit card data at the\n token store.", | |
"type": "string" | |
}, | |
"expiration_month": { | |
"description": "The month when the payment card expires.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"expiration_year": { | |
"description": "The year when the payment card expires.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"holder": { | |
"description": "The payment card holder.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"issue_number": { | |
"description": "The payment card issue number.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"masked_number": { | |
"description": "The masked credit card number.", | |
"maxLength": 4000, | |
"type": "string" | |
}, | |
"number_last_digits": { | |
"description": "The last digits of credit card number.", | |
"maxLength": 4000, | |
"type": "string" | |
}, | |
"valid_from_month": { | |
"description": "The payment card valid from month.", | |
"format": "int32", | |
"maximum": 12, | |
"minimum": 1, | |
"type": "integer" | |
}, | |
"valid_from_year": { | |
"description": "The payment card valid from year.", | |
"format": "int32", | |
"type": "integer" | |
} | |
}, | |
"required": [ | |
"c_csEnablePayerAuthentication" | |
] | |
}, | |
"payment_card_spec": { | |
"description": "Document representing the specification for a payment card.\n ", | |
"properties": { | |
"card_type": { | |
"description": "The type of the payment card.", | |
"type": "string" | |
}, | |
"checksum_verification_enabled": { | |
"description": "A flag indicating whether the card number is verified using the Luhn checksum algorithm.", | |
"type": "boolean" | |
}, | |
"description": { | |
"description": "The localized description of the payment card.", | |
"type": "string" | |
}, | |
"image": { | |
"description": "The URL to the image that represents the payment card.", | |
"type": "string" | |
}, | |
"name": { | |
"description": "The localized name of the payment card.", | |
"type": "string" | |
}, | |
"number_lengths": { | |
"description": "The sorted list of number lengths (individual lengths as well as\n length ranges).", | |
"items": { | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"number_prefixes": { | |
"description": "The sorted list of number prefixes (individual prefixes as well\n as prefix ranges).", | |
"items": { | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"security_code_length": { | |
"description": "The length of the security code for this card.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"payment_method": { | |
"description": "Document representing a payment method.", | |
"properties": { | |
"cards": { | |
"description": "The sorted array of payment cards (included only when the system payment method is CREDIT_CARD).", | |
"items": { | |
"$ref": "#/definitions/payment_card_spec" | |
}, | |
"type": "array" | |
}, | |
"description": { | |
"description": "The localized description of the payment method or card.", | |
"type": "string" | |
}, | |
"id": { | |
"description": "The id of the payment method or card.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"image": { | |
"description": "The URL to the image that represents the payment method or card.", | |
"type": "string" | |
}, | |
"name": { | |
"description": "The localized name of the payment method or card.", | |
"type": "string" | |
}, | |
"payment_processor_id": { | |
"description": "The payment processor ID.", | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"id" | |
] | |
}, | |
"payment_method_result": { | |
"description": "Result document of payment methods applicable for a basket.", | |
"properties": { | |
"applicable_payment_methods": { | |
"description": "The applicable payment methods.", | |
"items": { | |
"$ref": "#/definitions/payment_method" | |
}, | |
"type": "array" | |
} | |
} | |
}, | |
"price_adjustment": { | |
"description": "Document representing a price adjustment within a basket or order. Price adjustments\n can be assigned at the order, product, or shipping level. They can be created by the\n promotion engine (if the custom flag is set to false) or can be added by custom logic (if the custom\n flag is set to true). For custom price adjustments created by a user, the manual flag should be\n set to true; this is always the case for price adjustments created using OCAPI.\n ", | |
"properties": { | |
"applied_discount": { | |
"$ref": "#/definitions/discount", | |
"description": "A price adjustment that provides details of the discount that was applied.\n This is null for custom price adjustments created\n without discount details." | |
}, | |
"c_geCouponCode": { | |
"description": "Merchant’s coupon code used for this discount (applicable to coupon-based discounts only)", | |
"x-label": { | |
"default": "Coupon Code" | |
}, | |
"type": "string" | |
}, | |
"c_geDescription": { | |
"description": "Discount Description", | |
"x-label": { | |
"default": "Discount Description" | |
}, | |
"type": "string" | |
}, | |
"c_geDiscountCode": { | |
"description": "Discount code originally specified in Discount.DiscountCode property of the respective discount in SendCart method for the cart converted to this order on Global-e.", | |
"x-label": { | |
"default": "Discount Code" | |
}, | |
"type": "string" | |
}, | |
"c_geDiscountType": { | |
"description": "Discount type (“Cart”, “Shipping”, etc.), as defined in DiscountTypeOptions enumeration described in Discount class in this document.", | |
"format": "int32", | |
"x-label": { | |
"default": "Discount Type" | |
}, | |
"type": "integer" | |
}, | |
"c_geInternationalPrice": { | |
"description": "Discount value in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion and IncludeVAT handling.", | |
"format": "double", | |
"x-label": { | |
"default": "International Price" | |
}, | |
"type": "number" | |
}, | |
"c_geLocalVatRate": { | |
"description": "VAT rate that would be applied to this discount if the order was placed by the local customer. This value must be specified if UseCountryVAT for the current Country is TRUE and therefore VATRate property actually denotes the VAT for the target country.", | |
"format": "double", | |
"x-label": { | |
"default": "Local VAT Rate" | |
}, | |
"type": "number" | |
}, | |
"c_geLoyaltyVoucherCode": { | |
"description": "Loyalty Voucher code originally specified in Discount.LoyaltyVoucherCode property of the respective discount in SendCart method for the cart converted to this order on Global-e.", | |
"x-label": { | |
"default": "Loyalty Voucher Code" | |
}, | |
"type": "string" | |
}, | |
"c_geName": { | |
"description": "Discount textual description", | |
"x-label": { | |
"default": "Discount Name" | |
}, | |
"type": "string" | |
}, | |
"c_geOriginalPriceAdjustmentPrice": { | |
"description": "Original Price Adjustment Price", | |
"format": "double", | |
"x-label": { | |
"default": "Original Price Adjustment Price" | |
}, | |
"type": "number" | |
}, | |
"c_gePrice": { | |
"description": "Discount value in currency defined in CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant.", | |
"format": "double", | |
"x-label": { | |
"default": "Price" | |
}, | |
"type": "number" | |
}, | |
"c_geVatRate": { | |
"description": "VAT rate applied to this discount", | |
"format": "double", | |
"x-label": { | |
"default": "VAT Rate" | |
}, | |
"type": "number" | |
}, | |
"c_promotionOMSCalloutMsg": { | |
"format": "text", | |
"x-label": { | |
"default": "Promotion OMS Callout Message" | |
}, | |
"type": "string" | |
}, | |
"coupon_code": { | |
"description": "The coupon code that triggered the promotion, provided\n the price adjustment was created as the result of a promotion\n being triggered by a coupon.", | |
"type": "string" | |
}, | |
"created_by": { | |
"description": "The user who created the price adjustment.", | |
"type": "string" | |
}, | |
"creation_date": { | |
"description": "Returns the value of attribute 'creationDate'.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Creation Date" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"custom": { | |
"description": "A flag indicating whether this price adjustment was created by custom logic. This flag is\n set to true unless the price adjustment was created by the promotion engine.", | |
"type": "boolean" | |
}, | |
"item_text": { | |
"description": "The text describing the item in more detail.", | |
"x-label": { | |
"default": "Item Text" | |
}, | |
"type": "string" | |
}, | |
"last_modified": { | |
"description": "Returns the value of attribute 'lastModified'.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Last Modified" | |
}, | |
"readOnly": true, | |
"type": "string" | |
}, | |
"manual": { | |
"description": "A flag indicating whether this price adjustment was created in a manual process.\n \n For custom price adjustments created using the shop API, this always\n returns true. Using the scripting API, however, it is possible to set this to true\n or false, according to the use case.", | |
"type": "boolean" | |
}, | |
"price": { | |
"description": "The adjustment price.", | |
"format": "double", | |
"type": "number" | |
}, | |
"price_adjustment_id": { | |
"description": "The price adjustment id (uuid).", | |
"type": "string" | |
}, | |
"promotion_id": { | |
"description": "The id of the related promotion. Custom price adjustments\n can be assigned any promotion id so long it is not\n used by a price adjustment belonging to the same item\n and is not used by promotion defined in the promotion engine.\n If not specified, a promotion id is generated.", | |
"type": "string" | |
}, | |
"promotion_link": { | |
"description": "The URL addressing the related promotion.", | |
"type": "string" | |
}, | |
"reason_code": { | |
"description": "The reason why this price adjustment was made.", | |
"enum": [ | |
"PRICE_MATCH", | |
"BACKORDER", | |
"EVEN_EXCHANGE" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Price Match" | |
}, | |
{ | |
"default": "Backorder" | |
}, | |
{ | |
"default": "Even Exchange" | |
} | |
], | |
"x-label": { | |
"default": "Reason Code" | |
}, | |
"type": "string" | |
} | |
} | |
}, | |
"price_adjustment_limit": { | |
"description": "\n Document representing a price adjustment limit.\n ", | |
"properties": { | |
"amount": { | |
"description": "The value for the currency or null if no currency value is specified.", | |
"format": "double", | |
"type": "number" | |
}, | |
"currency": { | |
"description": "Returns the currency of the Price Adjustment Limit or null if not applicable.\n \n Will be null if this is a percent limit only.\n \n Price adjustment limits can be given up to a fixed amount (unit=a currency unit).", | |
"type": "string" | |
}, | |
"percent": { | |
"description": "Returns percentage value of the Price Adjustment Limit or null if not applicable.\n \n Will be null if this is a currency limit only.\n ", | |
"format": "double", | |
"type": "number" | |
}, | |
"type": { | |
"description": "The Price Adjustment Limit type - ITEM, SHIPPING or ORDER. It identifies the level at which the Price Adjustment\n is applicable.", | |
"enum": [ | |
"item", | |
"shipping", | |
"order" | |
], | |
"type": "string" | |
} | |
} | |
}, | |
"price_adjustment_limits": { | |
"description": "Document representing a list of PriceAdjustmentLimit items.\n It returns all the price adjustment limits for a particular user\n across various Access Roles.", | |
"properties": { | |
"limits": { | |
"description": "The list of price adjustment limits applicable for a user across all roles.", | |
"items": { | |
"$ref": "#/definitions/price_adjustment_limit" | |
}, | |
"type": "array" | |
} | |
} | |
}, | |
"price_adjustment_request": { | |
"description": "Document representing a price adjustment request.\n ", | |
"properties": { | |
"c_geCouponCode": { | |
"description": "Merchant’s coupon code used for this discount (applicable to coupon-based discounts only)", | |
"x-label": { | |
"default": "Coupon Code" | |
}, | |
"type": "string" | |
}, | |
"c_geDescription": { | |
"description": "Discount Description", | |
"x-label": { | |
"default": "Discount Description" | |
}, | |
"type": "string" | |
}, | |
"c_geDiscountCode": { | |
"description": "Discount code originally specified in Discount.DiscountCode property of the respective discount in SendCart method for the cart converted to this order on Global-e.", | |
"x-label": { | |
"default": "Discount Code" | |
}, | |
"type": "string" | |
}, | |
"c_geDiscountType": { | |
"description": "Discount type (“Cart”, “Shipping”, etc.), as defined in DiscountTypeOptions enumeration described in Discount class in this document.", | |
"format": "int32", | |
"x-label": { | |
"default": "Discount Type" | |
}, | |
"type": "integer" | |
}, | |
"c_geInternationalPrice": { | |
"description": "Discount value in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion and IncludeVAT handling.", | |
"format": "double", | |
"x-label": { | |
"default": "International Price" | |
}, | |
"type": "number" | |
}, | |
"c_geLocalVatRate": { | |
"description": "VAT rate that would be applied to this discount if the order was placed by the local customer. This value must be specified if UseCountryVAT for the current Country is TRUE and therefore VATRate property actually denotes the VAT for the target country.", | |
"format": "double", | |
"x-label": { | |
"default": "Local VAT Rate" | |
}, | |
"type": "number" | |
}, | |
"c_geLoyaltyVoucherCode": { | |
"description": "Loyalty Voucher code originally specified in Discount.LoyaltyVoucherCode property of the respective discount in SendCart method for the cart converted to this order on Global-e.", | |
"x-label": { | |
"default": "Loyalty Voucher Code" | |
}, | |
"type": "string" | |
}, | |
"c_geName": { | |
"description": "Discount textual description", | |
"x-label": { | |
"default": "Discount Name" | |
}, | |
"type": "string" | |
}, | |
"c_geOriginalPriceAdjustmentPrice": { | |
"description": "Original Price Adjustment Price", | |
"format": "double", | |
"x-label": { | |
"default": "Original Price Adjustment Price" | |
}, | |
"type": "number" | |
}, | |
"c_gePrice": { | |
"description": "Discount value in currency defined in CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant.", | |
"format": "double", | |
"x-label": { | |
"default": "Price" | |
}, | |
"type": "number" | |
}, | |
"c_geVatRate": { | |
"description": "VAT rate applied to this discount", | |
"format": "double", | |
"x-label": { | |
"default": "VAT Rate" | |
}, | |
"type": "number" | |
}, | |
"c_promotionOMSCalloutMsg": { | |
"format": "text", | |
"x-label": { | |
"default": "Promotion OMS Callout Message" | |
}, | |
"type": "string" | |
}, | |
"discount": { | |
"$ref": "#/definitions/discount_request", | |
"description": "A discount that you can specify instead of a price.\n When defining a discount, you must specify a type and\n a value." | |
}, | |
"item_id": { | |
"description": "The item to which the price adjustment should be added, depending on the specified level.\n If the level is 'order', you need not specify an item id. If 'shipping', specify the uuid\n of the shipping item. If 'product', specify the uuid of the product item.", | |
"type": "string" | |
}, | |
"item_text": { | |
"description": "The text describing the item in more detail.", | |
"x-label": { | |
"default": "Item Text" | |
}, | |
"type": "string" | |
}, | |
"level": { | |
"description": "The level at which the adjustment is applied. When a product or shipping\n level is specified, you must also specify the item id.", | |
"enum": [ | |
"product", | |
"shipping", | |
"order" | |
], | |
"type": "string" | |
}, | |
"promotion_id": { | |
"description": "The id of the related promotion. Custom price adjustments\n can be assigned any promotion id so long it is not\n used by a price adjustment belonging to the same item\n and is not used by promotion defined in the promotion engine.\n If not specified, a promotion id is generated.", | |
"type": "string" | |
}, | |
"reason_code": { | |
"description": "The reason why this price adjustment was made.", | |
"enum": [ | |
"PRICE_MATCH", | |
"BACKORDER", | |
"EVEN_EXCHANGE" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Price Match" | |
}, | |
{ | |
"default": "Backorder" | |
}, | |
{ | |
"default": "Even Exchange" | |
} | |
], | |
"x-label": { | |
"default": "Reason Code" | |
}, | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"level" | |
] | |
}, | |
"product": { | |
"description": "Document representing a product.", | |
"properties": { | |
"brand": { | |
"description": "The product's brand.", | |
"x-label": { | |
"default": "Brand" | |
}, | |
"type": "string" | |
}, | |
"bundled_products": { | |
"description": "The array of all bundled products of this product.", | |
"items": { | |
"$ref": "#/definitions/bundled_product" | |
}, | |
"type": "array" | |
}, | |
"c_ConfigureCustomization": { | |
"description": "Custom option tracking configure options", | |
"x-label": { | |
"default": "Configure Option" | |
}, | |
"type": "string" | |
}, | |
"c_HTMLLongDescription": { | |
"format": "html", | |
"x-label": { | |
"default": "HTML Long Description" | |
}, | |
"type": "string" | |
}, | |
"c_HidePDPDescription": { | |
"x-label": { | |
"default": "Hide PDP Description" | |
}, | |
"type": "boolean" | |
}, | |
"c_HidePDPMaterialCare": { | |
"x-label": { | |
"default": "Hide PDP MaterialCare" | |
}, | |
"type": "boolean" | |
}, | |
"c_HidePDPShippingReturn": { | |
"x-label": { | |
"default": "Hide PDP ShippingReturn" | |
}, | |
"type": "boolean" | |
}, | |
"c_PDPMasterCanonicalOverride": { | |
"description": "PDPs will render master product URL in place or variant URL for\n canonical links.\n ", | |
"x-label": { | |
"default": "Master Product Canonical URL Override" | |
}, | |
"type": "boolean" | |
}, | |
"c_RunnerType": { | |
"x-label": { | |
"default": "Runner Type" | |
}, | |
"type": "string" | |
}, | |
"c_ShippingReturnAssetID": { | |
"description": "Shipping Return Content Asset ID Override for default.", | |
"x-label": { | |
"default": "Shipping Return Asset ID" | |
}, | |
"type": "string" | |
}, | |
"c_StyliticsProductTags": { | |
"x-label": { | |
"default": "Stylitics Product Tags" | |
}, | |
"type": "string" | |
}, | |
"c_USP": { | |
"x-label": { | |
"default": "USP" | |
}, | |
"type": "string" | |
}, | |
"c_UsageType": { | |
"items": { | |
"enum": [ | |
"Jogging", | |
"Everyday running", | |
"Multi-sport", | |
"Racing" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Jogging" | |
}, | |
{ | |
"default": "Everyday running" | |
}, | |
{ | |
"default": "Multi-sport" | |
}, | |
{ | |
"default": "Racing" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Usage Type" | |
}, | |
"type": "array" | |
}, | |
"c_VertexTaxCode": { | |
"x-label": { | |
"default": "Vertex Tax Code" | |
}, | |
"type": "string" | |
}, | |
"c_actualLiveDate": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Actual Live Date" | |
}, | |
"type": "string" | |
}, | |
"c_ageCode": { | |
"x-label": { | |
"default": "Age Code" | |
}, | |
"type": "string" | |
}, | |
"c_ageGroup": { | |
"x-label": { | |
"default": "Age Group" | |
}, | |
"type": "string" | |
}, | |
"c_agegroupCode": { | |
"x-label": { | |
"default": "Age Group Code" | |
}, | |
"type": "string" | |
}, | |
"c_agegroupName": { | |
"x-label": { | |
"default": "Age Group Name" | |
}, | |
"type": "string" | |
}, | |
"c_allowedCountries": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Allowed Countries" | |
}, | |
"type": "array" | |
}, | |
"c_animalParts": { | |
"x-label": { | |
"default": "Animal Parts" | |
}, | |
"type": "boolean" | |
}, | |
"c_apparelLength": { | |
"x-label": { | |
"default": "Apparel Length" | |
}, | |
"type": "string" | |
}, | |
"c_appliedCustomerGroup": { | |
"x-label": { | |
"default": "Applied Customer Group" | |
}, | |
"type": "string" | |
}, | |
"c_articleType": { | |
"x-label": { | |
"default": "Article Type" | |
}, | |
"type": "string" | |
}, | |
"c_articleTypeCode": { | |
"x-label": { | |
"default": "Article Type Code" | |
}, | |
"type": "string" | |
}, | |
"c_availableForInStorePickup": { | |
"description": "Signals if there are inventory lists for brick-and-mortar stores associated with this product.", | |
"x-label": { | |
"default": "Available for In Store Pickup" | |
}, | |
"type": "boolean" | |
}, | |
"c_availableForShipToStore": { | |
"description": "the storefront will display STS options in PDP if this is set to true ", | |
"x-label": { | |
"default": "Ship To Store" | |
}, | |
"type": "boolean" | |
}, | |
"c_avgNoOfMilesPerKm": { | |
"x-label": { | |
"default": "Average No. of Miles/Kilometers" | |
}, | |
"type": "string" | |
}, | |
"c_badge": { | |
"description": "Product Badge displayed in Product Grid tile", | |
"enum": [ | |
"new", | |
"sale", | |
"web-exclusive", | |
"best-seller", | |
"top-rated", | |
"most-favorited", | |
"customize", | |
"exclusive", | |
"online-exclusive", | |
"worn-by-selena", | |
"worn-by-cara", | |
"limited-edition", | |
"personalise", | |
"black-friday-deal", | |
"cyber-monday-deal", | |
"singles-day-special", | |
"christmas-deal", | |
"worn-by-adriana-lima", | |
"10-percent", | |
"15-percent", | |
"20-percent", | |
"25-percent", | |
"30-percent", | |
"40-percent", | |
"50-percent", | |
"puma-store-exclusive", | |
"re-stock", | |
"puma-select", | |
"worn-by-sara", | |
"worn-by-virat", | |
"worn-by-mary", | |
"sustainable", | |
"recycled-materials", | |
"worn-by-lewis-hamilton", | |
"worn-by-cristina-pedroche", | |
"worn-by-pamela-reif", | |
"special-offer", | |
"last-chance", | |
"special-price", | |
"unisex", | |
"designed-by-selena", | |
"designed-by-cristina-pedroche", | |
"designed-by-adriana-lima", | |
"trending", | |
"big-and-tall", | |
"plus-size", | |
"shop-the-model", | |
"sustainable-material", | |
"vegan", | |
"organic-cotton", | |
"bio-based", | |
"recycled" | |
], | |
"x-enum-labels": [ | |
{ | |
"de": "Neu", | |
"default": "New", | |
"fr": "Nouveau" | |
}, | |
{ | |
"default": "Sale", | |
"fr": "Promo" | |
}, | |
{ | |
"default": "オンライン限定", | |
"fr": "Exclusivité Web" | |
}, | |
{ | |
"default": "Best Seller", | |
"fr": "Best seller", | |
"ja-JP": "ベストセラー" | |
}, | |
{ | |
"default": "Top Rated", | |
"fr": "Mieux noté" | |
}, | |
{ | |
"default": "Most Favorited", | |
"fr": "Favori", | |
"ja-JP": "おすすめ" | |
}, | |
{ | |
"default": "Customize", | |
"ja-JP": "カスタマイズ" | |
}, | |
{ | |
"de": "Exklusiv", | |
"default": "Exclusive", | |
"it": "ESCLUSIVO", | |
"fr": "EXCLUSIF", | |
"pl": "EKSKLUZYWNY", | |
"es": "EXCLUSIVO", | |
"nl": "EXCLUSIEF" | |
}, | |
{ | |
"de": "Exklusiv online", | |
"default": "Online Exclusive", | |
"fr": "Exclusivité web" | |
}, | |
{ | |
"de": "Getragen von Selena", | |
"default": "Worn by Selena", | |
"fr": "Porté par Selena" | |
}, | |
{ | |
"de": "Getragen von Cara", | |
"default": "Worn by Cara", | |
"fr": "Porté par Cara" | |
}, | |
{ | |
"de": "Limitiert", | |
"default": "Limited Edition", | |
"fr": "Édition limitée" | |
}, | |
{ | |
"de": "Personalisieren", | |
"default": "Personalise", | |
"en-CA": "Personalize", | |
"en-US": "Personalize", | |
"it": "Personalizza", | |
"fr": "Personnaliser", | |
"pl": "Spersonalizuj", | |
"es": "Personalizar", | |
"nl": "Personalisieren" | |
}, | |
{ | |
"de": "Black Friday Angebot", | |
"default": "Black Friday Deal", | |
"fr": "Bon plan Black Friday" | |
}, | |
{ | |
"de": "Cyber Monday Angebot", | |
"default": "Cyber Monday Deal", | |
"fr": "Bon plan Cyber Monday" | |
}, | |
{ | |
"de": "Singles Day Special", | |
"default": "Singles Day Special", | |
"fr": "Bon plan Singles Day" | |
}, | |
{ | |
"de": "Weihnachtsangebot", | |
"default": "Christmas Deal", | |
"fr": "Bon plan Noël" | |
}, | |
{ | |
"de": "Getragen von Adriana Lima", | |
"default": "Worn by Adriana Lima", | |
"fr": "Porté par Adriana Lima" | |
}, | |
{ | |
"default": "10%" | |
}, | |
{ | |
"default": "15%" | |
}, | |
{ | |
"default": "20%" | |
}, | |
{ | |
"default": "25%" | |
}, | |
{ | |
"default": "30%" | |
}, | |
{ | |
"default": "40%" | |
}, | |
{ | |
"default": "50%" | |
}, | |
{ | |
"default": "Puma Retail Store Limited", | |
"ja-JP": "プーマ直営店限定" | |
}, | |
{ | |
"default": "Restock", | |
"ja-JP": "再入荷" | |
}, | |
{ | |
"default": "PUMA SELECT" | |
}, | |
{ | |
"default": "Worn by Sara" | |
}, | |
{ | |
"default": "Worn by Virat" | |
}, | |
{ | |
"default": "Worn by Mary" | |
}, | |
{ | |
"de": "Nachhaltig", | |
"default": "Sustainability", | |
"pt": "Sustentável", | |
"it": "Prodotto sostenibile", | |
"fr": "Éco-responsable", | |
"pl": "Równowaga ekologiczna", | |
"da": "Bæredygtigt", | |
"es": "Sostenible" | |
}, | |
{ | |
"de": "Recyceltes Material", | |
"default": "Recycled Materials", | |
"pt": "Materiais reciclados", | |
"it": "Materiali riciclati", | |
"fr": "Matériaux recyclés", | |
"pl": "Powtórnie przetworzone materiały", | |
"da": "Genbrugsmaterialer", | |
"es": "Materiales reciclados" | |
}, | |
{ | |
"de": "Getragen von Lewis Hamilton", | |
"default": "Worn by Lewis Hamilton", | |
"it": "Indossato da Lewis Hamilton", | |
"fr": "Porté par Lewis Hamilton", | |
"pl": "Polecane przez Lewisa Hamiltona", | |
"es": "Llevado por Lewis Hamilton", | |
"nl": "Gedragen door Lewis Hamilton" | |
}, | |
{ | |
"de": "Getragen von Cristina Pedroche", | |
"default": "Worn by Cristina Pedroche", | |
"it": "Indossato da Cristina Pedroche", | |
"fr": "Porté par Cristina Pedroche", | |
"pl": "Polecane przez Cristinę Pedroche", | |
"es": "Llevado por Cristina Pedroche", | |
"nl": "Gedragen door Cristina Pedroche" | |
}, | |
{ | |
"de": "Getragen von Pamela Reif", | |
"default": "Worn by Pamela Reif", | |
"it": "Indossato da Pamela Reif", | |
"fr": "Porté par Pamela Reif", | |
"pl": "Polecane przez Pamelę Reif", | |
"es": "Llevado por Pamela Reif", | |
"nl": "Gedragen door Pamela Reif" | |
}, | |
{ | |
"de": "Sonderangebot", | |
"default": "Special Offer", | |
"it": "Offerta speciale", | |
"fr": "Offre spéciale", | |
"pl": "Specjalna oferta", | |
"es": "Oferta especial", | |
"nl": "Speciale aanbieding" | |
}, | |
{ | |
"de": "Letzte Chance", | |
"default": "Last Chance", | |
"it": "Ultima occasione", | |
"fr": "Dernière chance", | |
"pl": "Ostatnia szansa", | |
"es": "Última oportunidad", | |
"nl": "Laatste kans" | |
}, | |
{ | |
"de": "Sonderpreis", | |
"default": "Special Price", | |
"it": "Prezzo speciale", | |
"fr": "Prix spécial", | |
"pl": "Specjalna cena", | |
"es": "Precio especial", | |
"nl": "Speciale prijs" | |
}, | |
{ | |
"de": "Unisex", | |
"default": "Unisex", | |
"it": "Unisex", | |
"fr": "Unisexe", | |
"pl": "Unisex", | |
"es": "Unisex", | |
"nl": "Uniseks model" | |
}, | |
{ | |
"de": "Designt von Selena", | |
"default": "Designed by Selena", | |
"it": "Una creazione di Selena", | |
"fr": "Dessiné par Selena", | |
"pl": "Zaprojektowane przez Selenę", | |
"es": "Diseñado por Selena", | |
"nl": "Ontworpen door Selena" | |
}, | |
{ | |
"de": "Designt von Cristina Pedroche", | |
"default": "Designed by Cristina Pedroche", | |
"it": "Una creazione di Cristina Pedroche", | |
"fr": "Dessiné par Cristina Pedroche", | |
"pl": "Zaprojektowane przez Cristinę Pedroche", | |
"es": "Diseñado por Cristina Pedroche", | |
"nl": "Ontworpen door Cristina Pedroche" | |
}, | |
{ | |
"de": "Designt von Adriana Lima", | |
"default": "Designed by Adriana Lima", | |
"it": "Una creazione di Adriana Lima", | |
"fr": "Dessiné par Adriana Lima", | |
"pl": "Zaprojektowane przez Adrianę Limę", | |
"es": "Diseñado por Adriana Lima", | |
"nl": "Ontworpen door Adriana Lima" | |
}, | |
{ | |
"de": "Im Trend", | |
"default": "Trending", | |
"it": "Tendenza", | |
"fr": "Tendance", | |
"pl": "Popularne", | |
"es": "Tendencia", | |
"nl": "Trending" | |
}, | |
{ | |
"default": "Big & Tall" | |
}, | |
{ | |
"default": "Plus Size" | |
}, | |
{ | |
"default": "Shop the Look" | |
}, | |
{ | |
"de": "Nachhaltiges Material", | |
"default": "Sustainable Material", | |
"it": "Materiale sostenibile", | |
"fr": "Matériel durable", | |
"pl": "Ekologiczny materiał", | |
"es": "Material sostenible", | |
"ja-JP": "サステナブル素材", | |
"nl": "Duurzaam materiaal" | |
}, | |
{ | |
"de": "Vegan", | |
"default": "Vegan", | |
"it": "Vegano", | |
"fr": "Vegan", | |
"pl": "Wegańskie", | |
"es": "Vegano", | |
"ja-JP": "ビーガン", | |
"nl": "Veganistisch" | |
}, | |
{ | |
"de": "Biobaumwolle", | |
"default": "Organic Cotton", | |
"it": "Cotone organico", | |
"fr": "Coton biologique", | |
"pl": "Bawełna ekologiczna", | |
"es": "Algodón orgánico", | |
"ja-JP": "オーガニックコットン使用", | |
"nl": "Biologisch katoen" | |
}, | |
{ | |
"de": "Auf Bio-Basis", | |
"default": "Bio-Based", | |
"it": "Biologico", | |
"fr": "Biosourcé", | |
"pl": "Biologiczne", | |
"es": "Biológico", | |
"ja-JP": "バイオ素材使用", | |
"nl": "Biogebaseerd" | |
}, | |
{ | |
"de": "Recycelt", | |
"default": "Recycled", | |
"it": "Riciclato", | |
"fr": "Recyclé", | |
"pl": "Z recyklingu", | |
"es": "Reciclado", | |
"ja-JP": "リサイクル素材使用", | |
"nl": "Gerecycled" | |
} | |
], | |
"x-label": { | |
"default": "Product Badge" | |
}, | |
"type": "string" | |
}, | |
"c_badgeCollection": { | |
"description": "Product Collection image name. Image hosted on Scene7.", | |
"x-label": { | |
"default": "Product Collection Badge" | |
}, | |
"type": "string" | |
}, | |
"c_bagSize": { | |
"x-label": { | |
"default": "Bag size" | |
}, | |
"type": "string" | |
}, | |
"c_batteryLife": { | |
"x-label": { | |
"default": "Battery Life" | |
}, | |
"type": "string" | |
}, | |
"c_batteryType": { | |
"x-label": { | |
"default": "Battery Type" | |
}, | |
"type": "string" | |
}, | |
"c_bootType": { | |
"description": "Type of Boot for search refinement.", | |
"items": { | |
"enum": [ | |
"0010", | |
"0020", | |
"0030", | |
"0040", | |
"0050", | |
"0060", | |
"0070" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Winter" | |
}, | |
{ | |
"default": "Waterproof" | |
}, | |
{ | |
"default": "Classic" | |
}, | |
{ | |
"default": "Ankle & Mid" | |
}, | |
{ | |
"default": "Tall" | |
}, | |
{ | |
"default": "6\"" | |
}, | |
{ | |
"default": "Casual" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Boot Type" | |
}, | |
"type": "array" | |
}, | |
"c_bottomType": { | |
"description": "Bottom type for search refinement", | |
"items": { | |
"enum": [ | |
"0010", | |
"0020", | |
"0030", | |
"0040", | |
"0050", | |
"0060", | |
"0070", | |
"0080" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Khakis" | |
}, | |
{ | |
"default": "Denim" | |
}, | |
{ | |
"default": "Dress" | |
}, | |
{ | |
"default": "Casual" | |
}, | |
{ | |
"default": "Shorts" | |
}, | |
{ | |
"default": "Work" | |
}, | |
{ | |
"default": "Cargo" | |
}, | |
{ | |
"default": "Fleece" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Bottom Type" | |
}, | |
"type": "array" | |
}, | |
"c_bvAverageRating": { | |
"x-label": { | |
"default": "Bazaarvoice Average Rating" | |
}, | |
"type": "string" | |
}, | |
"c_bvRatingRange": { | |
"x-label": { | |
"default": "Bazaarvoice Rating Range" | |
}, | |
"type": "string" | |
}, | |
"c_bvReviewCount": { | |
"x-label": { | |
"default": "Bazaarvoice Review Count" | |
}, | |
"type": "string" | |
}, | |
"c_bvSmartSEOFile": { | |
"x-label": { | |
"default": "Bazaarvoice Smart SEO Filename" | |
}, | |
"type": "string" | |
}, | |
"c_careInstructions": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Care Instructions" | |
}, | |
"type": "array" | |
}, | |
"c_careSymbol": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Care Symbol" | |
}, | |
"type": "array" | |
}, | |
"c_classCode": { | |
"x-label": { | |
"default": "Class Code" | |
}, | |
"type": "string" | |
}, | |
"c_classID": { | |
"x-label": { | |
"default": "Class ID" | |
}, | |
"type": "string" | |
}, | |
"c_className": { | |
"x-label": { | |
"default": "Class Name" | |
}, | |
"type": "string" | |
}, | |
"c_collection": { | |
"x-label": { | |
"default": "Collection" | |
}, | |
"type": "string" | |
}, | |
"c_color": { | |
"description": "Product color used for variation attribute", | |
"x-label": { | |
"ru-RU": "цвет", | |
"default": "Color", | |
"fr": "Couleur" | |
}, | |
"type": "string" | |
}, | |
"c_colorCode": { | |
"x-label": { | |
"default": "Color Code" | |
}, | |
"type": "string" | |
}, | |
"c_colorDescription": { | |
"x-label": { | |
"default": "Color Description" | |
}, | |
"type": "string" | |
}, | |
"c_colorName": { | |
"x-label": { | |
"default": "Color Name" | |
}, | |
"type": "string" | |
}, | |
"c_consoleWarranty": { | |
"x-label": { | |
"default": "Extended Warranty" | |
}, | |
"type": "string" | |
}, | |
"c_copyFeatureBulletPoint": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Copy Feature Bullet Point" | |
}, | |
"type": "array" | |
}, | |
"c_cushioningLevel": { | |
"format": "int32", | |
"x-label": { | |
"default": "Cushioning Level" | |
}, | |
"maximum": 5.0, | |
"minimum": 1.0, | |
"type": "integer" | |
}, | |
"c_customCSSFile": { | |
"description": "Use this attribute to apply custom styles for this product.", | |
"x-label": { | |
"default": "Custom CSS File" | |
}, | |
"type": "string" | |
}, | |
"c_deprioritizeOnPLP": { | |
"x-label": { | |
"default": "Deprioritize on PLP" | |
}, | |
"type": "boolean" | |
}, | |
"c_deptCode": { | |
"x-label": { | |
"default": "Department Code" | |
}, | |
"type": "string" | |
}, | |
"c_deptName": { | |
"x-label": { | |
"default": "Department Name" | |
}, | |
"type": "string" | |
}, | |
"c_detailBulletPoint": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Detail Bullet Point" | |
}, | |
"type": "array" | |
}, | |
"c_digitalCameraFeatures": { | |
"items": { | |
"enum": [ | |
"0010", | |
"0020", | |
"0030", | |
"0040", | |
"0050", | |
"0060", | |
"0070", | |
"0080", | |
"0090", | |
"0100", | |
"0110", | |
"0120", | |
"0130", | |
"0140", | |
"0150", | |
"0160", | |
"0170", | |
"0180", | |
"0190", | |
"0200", | |
"0210", | |
"0220", | |
"0230", | |
"0240", | |
"0250", | |
"0260", | |
"0270", | |
"0280" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Built In Flash" | |
}, | |
{ | |
"default": "HD Video" | |
}, | |
{ | |
"default": "GPS Geo Tagging" | |
}, | |
{ | |
"default": "Variable Self Timer" | |
}, | |
{ | |
"default": "Image Optimizer" | |
}, | |
{ | |
"default": "Stop Motion Video" | |
}, | |
{ | |
"default": "Self Cleaning" | |
}, | |
{ | |
"default": "Pro Performance" | |
}, | |
{ | |
"default": "51 Area Autofocus" | |
}, | |
{ | |
"default": "Super Fast Startup" | |
}, | |
{ | |
"default": "Easy to Learn" | |
}, | |
{ | |
"default": "Wide Angle Optical Zoom" | |
}, | |
{ | |
"default": "Manual Controls" | |
}, | |
{ | |
"default": "Wired LAN" | |
}, | |
{ | |
"default": "GPS Enabled" | |
}, | |
{ | |
"default": "In Camera Red Eye Reduction" | |
}, | |
{ | |
"default": "Large LCD" | |
}, | |
{ | |
"default": "Optical Zoom" | |
}, | |
{ | |
"default": "Anti-Shake" | |
}, | |
{ | |
"default": "Touch Screen" | |
}, | |
{ | |
"default": "Image Stabilization" | |
}, | |
{ | |
"default": "Fast Shutter" | |
}, | |
{ | |
"default": "Slim" | |
}, | |
{ | |
"default": "35mm Full Frame Sensor" | |
}, | |
{ | |
"default": "Wide Angle|Continuous Shooting" | |
}, | |
{ | |
"default": "Continuous Shooting" | |
}, | |
{ | |
"default": "ISO 1600" | |
}, | |
{ | |
"default": "Red Eye Reduction" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Digital Camera Features" | |
}, | |
"type": "array" | |
}, | |
"c_digitalCameraPixels": { | |
"x-label": { | |
"default": "Digital Camera Pixels" | |
}, | |
"type": "string" | |
}, | |
"c_digitalCameraType": { | |
"x-label": { | |
"default": "Digital Camera Type" | |
}, | |
"type": "string" | |
}, | |
"c_digitalCameraWarranty": { | |
"x-label": { | |
"default": "Extended Warranty" | |
}, | |
"type": "string" | |
}, | |
"c_dimDepth": { | |
"x-label": { | |
"default": "Depth" | |
}, | |
"type": "string" | |
}, | |
"c_dimHeight": { | |
"x-label": { | |
"default": "Height" | |
}, | |
"type": "string" | |
}, | |
"c_dimWeight": { | |
"x-label": { | |
"default": "Weight" | |
}, | |
"type": "string" | |
}, | |
"c_dimWidth": { | |
"x-label": { | |
"default": "Width" | |
}, | |
"type": "string" | |
}, | |
"c_dimensions": { | |
"x-label": { | |
"default": "Dimensions" | |
}, | |
"type": "string" | |
}, | |
"c_disableSizeGroup": { | |
"description": "Disables size grouping for just this product. Must be set at the master level.", | |
"x-label": { | |
"default": "Disable Size Group" | |
}, | |
"type": "boolean" | |
}, | |
"c_discountPercentage": { | |
"format": "int32", | |
"x-label": { | |
"default": "Discount Percentage" | |
}, | |
"type": "integer" | |
}, | |
"c_discountRate": { | |
"format": "double", | |
"x-label": { | |
"default": "Discount Rate" | |
}, | |
"type": "number" | |
}, | |
"c_displayName": { | |
"x-label": { | |
"default": "Display Name" | |
}, | |
"type": "string" | |
}, | |
"c_displaySize": { | |
"x-label": { | |
"default": "Display Size" | |
}, | |
"type": "string" | |
}, | |
"c_displaycontrolOutOfStock": { | |
"description": "Controls the Display of Out Of Stock Products", | |
"enum": [ | |
"soldout", | |
"comingsoon", | |
"backsoon", | |
"presale", | |
"none" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Sold Out" | |
}, | |
{ | |
"default": "Coming Soon" | |
}, | |
{ | |
"default": "Coming Back" | |
}, | |
{ | |
"default": "Pre-Sale" | |
}, | |
{ | |
"default": "None" | |
} | |
], | |
"x-label": { | |
"default": "Out Of Stock - Display Control" | |
}, | |
"type": "string" | |
}, | |
"c_displaycontrolOutOfStockDateTimeFrom": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Out Of Stock - Display Control Date Time From" | |
}, | |
"type": "string" | |
}, | |
"c_displaycontrolOutOfStockDateTimeTo": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Out Of Stock - Display Control Date Time To" | |
}, | |
"type": "string" | |
}, | |
"c_dropshipItem": { | |
"description": "Marks the product as dropship item", | |
"x-label": { | |
"default": "Dropship item" | |
}, | |
"type": "boolean" | |
}, | |
"c_enableLiveChat": { | |
"description": "Enable Online Live Chat on PDP", | |
"x-label": { | |
"default": "Online Chat on PDP" | |
}, | |
"type": "boolean" | |
}, | |
"c_exchangeRuleID": { | |
"description": "Represents Return Rule ID", | |
"x-label": { | |
"default": "Exchange Rule ID" | |
}, | |
"type": "string" | |
}, | |
"c_fabricsType": { | |
"x-label": { | |
"default": "Fabrics Type" | |
}, | |
"type": "string" | |
}, | |
"c_fastener": { | |
"x-label": { | |
"default": "Fastener" | |
}, | |
"type": "string" | |
}, | |
"c_fit": { | |
"x-label": { | |
"default": "Fit" | |
}, | |
"type": "string" | |
}, | |
"c_fitOptions": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Fit Options" | |
}, | |
"type": "array" | |
}, | |
"c_fluidConfigureDefaultRecipeID": { | |
"description": "Default Recipe ID for the custom product. Leave blank if there is no default recipe", | |
"x-label": { | |
"default": "Fluid Configure Default Recipe ID" | |
}, | |
"type": "string" | |
}, | |
"c_fluidConfigureEnabled": { | |
"enum": [ | |
"true", | |
"false" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "yes" | |
}, | |
{ | |
"default": "no" | |
} | |
], | |
"x-label": { | |
"default": "Enable Fluid Configure" | |
}, | |
"type": "string" | |
}, | |
"c_fluidConfigureHidePDPDescription": { | |
"x-label": { | |
"default": "Configure Hide PDP Description" | |
}, | |
"type": "boolean" | |
}, | |
"c_fluidConfigureHidePDPMaterialCare": { | |
"x-label": { | |
"default": "Configure Hide PDP Material Care" | |
}, | |
"type": "boolean" | |
}, | |
"c_fluidConfigureHidePDPShippingReturn": { | |
"x-label": { | |
"default": "Configure Hide PDP Shipping Return" | |
}, | |
"type": "boolean" | |
}, | |
"c_fluidConfigureProductID": { | |
"description": "ID of the product within the Fluid Configure Platform", | |
"x-label": { | |
"default": "Fluid Configure Product ID" | |
}, | |
"type": "string" | |
}, | |
"c_franchise": { | |
"x-label": { | |
"default": "Franchise" | |
}, | |
"type": "string" | |
}, | |
"c_gameGenre": { | |
"items": { | |
"enum": [ | |
"Action", | |
"Educational", | |
"Kids", | |
"Racing", | |
"Role-Playing", | |
"Sports", | |
"Strategy" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Action" | |
}, | |
{ | |
"default": "Educational" | |
}, | |
{ | |
"default": "Kids" | |
}, | |
{ | |
"default": "Racing" | |
}, | |
{ | |
"default": "Role-Playing" | |
}, | |
{ | |
"default": "Sports" | |
}, | |
{ | |
"default": "Strategy" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Genre" | |
}, | |
"type": "array" | |
}, | |
"c_gameRating": { | |
"x-label": { | |
"default": "Game Rating" | |
}, | |
"type": "string" | |
}, | |
"c_gameSystemType": { | |
"x-label": { | |
"default": "Gaming System" | |
}, | |
"type": "string" | |
}, | |
"c_gccFlagForTranslation": { | |
"description": "Site Specific flag", | |
"x-label": { | |
"default": "Submit to GlobalLink" | |
}, | |
"type": "boolean" | |
}, | |
"c_gccLastSubmitted": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Sent for translation on" | |
}, | |
"type": "string" | |
}, | |
"c_gccLastTranslated": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Translations imported on" | |
}, | |
"type": "string" | |
}, | |
"c_gccStatus": { | |
"description": "This attribute is used by GCC.", | |
"enum": [ | |
"Ready", | |
"Sent", | |
"Imported" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Ready to Send" | |
}, | |
{ | |
"default": "In Progress" | |
}, | |
{ | |
"default": "Translated" | |
} | |
], | |
"x-label": { | |
"default": "GlobalLink Status" | |
}, | |
"type": "string" | |
}, | |
"c_gccSubmissionName": { | |
"description": "This attribute is used to store the gccSubmissionName information locale-specific.", | |
"x-label": { | |
"default": "GCC Submission Name" | |
}, | |
"type": "string" | |
}, | |
"c_geIsForbidden": { | |
"x-label": { | |
"default": "Global-e Is Forbidden" | |
}, | |
"type": "boolean" | |
}, | |
"c_geIsGiftCard": { | |
"x-label": { | |
"default": "Is Globale Gift Card" | |
}, | |
"type": "boolean" | |
}, | |
"c_geRestrictedCountries": { | |
"x-label": { | |
"default": "Global-e RestrictedCountries" | |
}, | |
"type": "string" | |
}, | |
"c_geVatRates": { | |
"format": "text", | |
"x-label": { | |
"default": "Global-e Vat Rates" | |
}, | |
"type": "string" | |
}, | |
"c_gender": { | |
"x-label": { | |
"default": "Gender" | |
}, | |
"type": "string" | |
}, | |
"c_genderCode": { | |
"x-label": { | |
"default": "Gender Code" | |
}, | |
"type": "string" | |
}, | |
"c_genderCodeCHN": { | |
"x-label": { | |
"default": "Gender Code CHN" | |
}, | |
"type": "string" | |
}, | |
"c_genderName": { | |
"x-label": { | |
"default": "Gender Name" | |
}, | |
"type": "string" | |
}, | |
"c_giftCardType": { | |
"x-label": { | |
"default": "Gift Card Type" | |
}, | |
"type": "string" | |
}, | |
"c_gpsFeatures": { | |
"items": { | |
"enum": [ | |
"0010", | |
"0020", | |
"0030", | |
"0040", | |
"0050", | |
"0060", | |
"0070", | |
"0080", | |
"0090", | |
"0100", | |
"0110", | |
"0120", | |
"0130", | |
"0140", | |
"0150", | |
"0160", | |
"0170", | |
"0180", | |
"0190", | |
"0200", | |
"0210", | |
"0230" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Preloaded" | |
}, | |
{ | |
"default": "Voice Prompts" | |
}, | |
{ | |
"default": "3D" | |
}, | |
{ | |
"default": "Touch Screen" | |
}, | |
{ | |
"default": "FM Traffic" | |
}, | |
{ | |
"default": "MSN Direct" | |
}, | |
{ | |
"default": "MP3 Player" | |
}, | |
{ | |
"default": "Picture Viewer" | |
}, | |
{ | |
"default": "Bluetooth®" | |
}, | |
{ | |
"default": "Speech Recognition" | |
}, | |
{ | |
"default": "XM Navtraffic" | |
}, | |
{ | |
"default": "Waterproof" | |
}, | |
{ | |
"default": "Motorcycle Ready" | |
}, | |
{ | |
"default": "Lunar Tracking" | |
}, | |
{ | |
"default": "Wrist Wear" | |
}, | |
{ | |
"default": "Barometer" | |
}, | |
{ | |
"default": "Compass" | |
}, | |
{ | |
"default": "Geocaching" | |
}, | |
{ | |
"default": "Jeppesen Enabled" | |
}, | |
{ | |
"default": "Built-in HIS" | |
}, | |
{ | |
"default": "Auto Logbook" | |
}, | |
{ | |
"default": "Automotive Friendly" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "GPS Features" | |
}, | |
"type": "array" | |
}, | |
"c_gpsType": { | |
"items": { | |
"enum": [ | |
"0010", | |
"0020", | |
"0030", | |
"0040" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Automotive" | |
}, | |
{ | |
"default": "Personal" | |
}, | |
{ | |
"default": "Outdoor" | |
}, | |
{ | |
"default": "Aviation" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "GPS Type" | |
}, | |
"type": "array" | |
}, | |
"c_gpsWarranty": { | |
"x-label": { | |
"default": "Extended Warranty" | |
}, | |
"type": "string" | |
}, | |
"c_hand": { | |
"x-label": { | |
"default": "Hand/Shaft Material/Shaft Flex" | |
}, | |
"type": "string" | |
}, | |
"c_handType": { | |
"description": "Golf hand", | |
"x-label": { | |
"default": "Hand" | |
}, | |
"type": "string" | |
}, | |
"c_heelToToeDrop": { | |
"format": "double", | |
"x-label": { | |
"default": "Heel-to-toe drop" | |
}, | |
"type": "number" | |
}, | |
"c_heelType": { | |
"x-label": { | |
"default": "Heel type" | |
}, | |
"type": "string" | |
}, | |
"c_hood": { | |
"x-label": { | |
"default": "Hood" | |
}, | |
"type": "string" | |
}, | |
"c_htscode": { | |
"x-label": { | |
"default": "HTSCode" | |
}, | |
"type": "string" | |
}, | |
"c_imageAspectRatio": { | |
"x-label": { | |
"default": "Image Aspect Ratio" | |
}, | |
"type": "string" | |
}, | |
"c_includeInDeltaFeed": { | |
"x-label": { | |
"default": "Include In Delta Feed" | |
}, | |
"type": "boolean" | |
}, | |
"c_inputTextOnButton": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Input Text On Button" | |
}, | |
"type": "array" | |
}, | |
"c_isAutomatedNewArrival": { | |
"description": "Will be displayed in the respective new arrivals category if automation is enabled", | |
"x-label": { | |
"default": "New Arrival (Automated)" | |
}, | |
"type": "boolean" | |
}, | |
"c_isAutomatedNewArrivalSiteSpecific": { | |
"description": "Will be displayed in the respective new arrivals category if automation is enabled", | |
"x-label": { | |
"default": "New Arrival (Automated) (Site Specific)" | |
}, | |
"type": "boolean" | |
}, | |
"c_isFeatured": { | |
"x-label": { | |
"default": "is Featured?" | |
}, | |
"type": "string" | |
}, | |
"c_isGiftCard": { | |
"x-label": { | |
"default": "Is gift card" | |
}, | |
"type": "boolean" | |
}, | |
"c_isNeededToBeUnsearchable": { | |
"description": "To update product searchable flag to false", | |
"x-label": { | |
"default": "Searchable Flag Disabled?" | |
}, | |
"type": "boolean" | |
}, | |
"c_isNew": { | |
"description": "Will be displayed in the respective new arrivals category regardless if automation is enabled", | |
"x-label": { | |
"default": "New Arrival?" | |
}, | |
"type": "boolean" | |
}, | |
"c_isNewtest": { | |
"description": "This indiciates if the product is a new arrival.", | |
"x-label": { | |
"default": "New Arrival?" | |
}, | |
"type": "boolean" | |
}, | |
"c_isSale": { | |
"description": "This is the help text. It is used for sorting rules.", | |
"x-label": { | |
"default": "On sale?" | |
}, | |
"type": "boolean" | |
}, | |
"c_isSaleNA": { | |
"description": "Helps sort and refine on North America sites", | |
"x-label": { | |
"default": "On sale? (NA Sites)" | |
}, | |
"type": "boolean" | |
}, | |
"c_keywordTags": { | |
"description": "Japan keyword tag search", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Tags" | |
}, | |
"type": "array" | |
}, | |
"c_keywords": { | |
"x-label": { | |
"default": "Keywords" | |
}, | |
"type": "string" | |
}, | |
"c_kidsAge": { | |
"description": "Kids Age used for search refinements", | |
"enum": [ | |
"0010", | |
"0020", | |
"0030", | |
"0040", | |
"0050", | |
"0060", | |
"0070" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Infant (0-1 yr)" | |
}, | |
{ | |
"default": "Toddler (1-5 yrs)" | |
}, | |
{ | |
"default": "Youth (5-9 yrs)" | |
}, | |
{ | |
"default": "Junior (9-12 yrs)" | |
}, | |
{ | |
"default": "Newborn (1-6 mths)" | |
}, | |
{ | |
"default": "Infant (9 mnths - 3 yrs)" | |
}, | |
{ | |
"default": "Junior (4-12 yrs)" | |
} | |
], | |
"x-label": { | |
"default": "Age" | |
}, | |
"type": "string" | |
}, | |
"c_leatherType": { | |
"description": "Leather type", | |
"x-label": { | |
"default": "Leather Type" | |
}, | |
"type": "string" | |
}, | |
"c_length": { | |
"description": "This attribute is used for mens and womens pants lengths.", | |
"x-label": { | |
"default": "Length" | |
}, | |
"type": "string" | |
}, | |
"c_lensAperture": { | |
"x-label": { | |
"default": "Lens Aperture" | |
}, | |
"type": "string" | |
}, | |
"c_limitedShippingCountries": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Limited Shipping Countries" | |
}, | |
"type": "array" | |
}, | |
"c_lineName": { | |
"x-label": { | |
"default": "Line Name" | |
}, | |
"type": "string" | |
}, | |
"c_liner": { | |
"x-label": { | |
"default": "Liner" | |
}, | |
"type": "string" | |
}, | |
"c_lining": { | |
"description": "Lining", | |
"x-label": { | |
"default": "Lining" | |
}, | |
"type": "string" | |
}, | |
"c_liningPrimary": { | |
"x-label": { | |
"default": "Lining Primary" | |
}, | |
"type": "string" | |
}, | |
"c_loft": { | |
"x-label": { | |
"default": "Loft or Set Comp" | |
}, | |
"type": "string" | |
}, | |
"c_mainColor": { | |
"x-label": { | |
"default": "Main Color" | |
}, | |
"type": "string" | |
}, | |
"c_mainColorID": { | |
"x-label": { | |
"default": "Main Color ID" | |
}, | |
"type": "string" | |
}, | |
"c_mainMaterialOfShell": { | |
"x-label": { | |
"default": "Main Material Of Shell" | |
}, | |
"type": "string" | |
}, | |
"c_manufacturerAddress": { | |
"description": "Holds semi colon ; separated data, it is displayed on PDP product information section", | |
"format": "text", | |
"x-label": { | |
"default": "Manufacturer Information" | |
}, | |
"type": "string" | |
}, | |
"c_material": { | |
"format": "html", | |
"x-label": { | |
"default": "Material" | |
}, | |
"type": "string" | |
}, | |
"c_materialComposition": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Material Composition Details" | |
}, | |
"type": "array" | |
}, | |
"c_materialTest": { | |
"items": { | |
"enum": [ | |
"cotton", | |
"wool", | |
"polyester" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Cotton" | |
}, | |
{ | |
"default": "Wool" | |
}, | |
{ | |
"default": "Polyester" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Material" | |
}, | |
"type": "array" | |
}, | |
"c_maxOrderQty": { | |
"format": "double", | |
"x-label": { | |
"default": "Maximum Order Quantity" | |
}, | |
"type": "number" | |
}, | |
"c_maxOrderQuantity": { | |
"format": "double", | |
"x-label": { | |
"default": "Maximum Order Quantity" | |
}, | |
"minimum": 1.0, | |
"type": "number" | |
}, | |
"c_mediaFormat": { | |
"description": "Media Format", | |
"items": { | |
"enum": [ | |
"0010", | |
"0020", | |
"0030", | |
"0040", | |
"0050", | |
"0060", | |
"0070", | |
"0080", | |
"0090", | |
"0100" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "MP3" | |
}, | |
{ | |
"default": "WMA" | |
}, | |
{ | |
"default": "JPEG" | |
}, | |
{ | |
"default": "WAV" | |
}, | |
{ | |
"default": "FM Tuner" | |
}, | |
{ | |
"default": "AAC" | |
}, | |
{ | |
"default": "WMP" | |
}, | |
{ | |
"default": "MPEG4" | |
}, | |
{ | |
"default": "AVC" | |
}, | |
{ | |
"default": "ASP" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Media Format" | |
}, | |
"type": "array" | |
}, | |
"c_memorySize": { | |
"description": "Memory Size", | |
"x-label": { | |
"default": "Memory Size" | |
}, | |
"type": "string" | |
}, | |
"c_memoryType": { | |
"items": { | |
"enum": [ | |
"0010", | |
"0020", | |
"0030", | |
"0040", | |
"0050", | |
"0060", | |
"0070", | |
"0080", | |
"0090" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "SD" | |
}, | |
{ | |
"default": "Memory Stick Pro DUO" | |
}, | |
{ | |
"default": "Compact Flash" | |
}, | |
{ | |
"default": "MMC" | |
}, | |
{ | |
"default": "SDHC" | |
}, | |
{ | |
"default": "CF Card" | |
}, | |
{ | |
"default": "External Media" | |
}, | |
{ | |
"default": "Micro SD" | |
}, | |
{ | |
"default": "Garmin Data Card" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Memory Type" | |
}, | |
"type": "array" | |
}, | |
"c_messageFrom": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Special Message From" | |
}, | |
"type": "string" | |
}, | |
"c_messageTo": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Special Message To" | |
}, | |
"type": "string" | |
}, | |
"c_midSole": { | |
"x-label": { | |
"default": "Midsole" | |
}, | |
"type": "string" | |
}, | |
"c_midsolePrimary": { | |
"x-label": { | |
"default": "Midsole Primary" | |
}, | |
"type": "string" | |
}, | |
"c_modelBust": { | |
"x-label": { | |
"default": "Model Bust" | |
}, | |
"type": "string" | |
}, | |
"c_modelChest": { | |
"x-label": { | |
"default": "Model Chest" | |
}, | |
"type": "string" | |
}, | |
"c_modelHeight": { | |
"x-label": { | |
"default": "Model Height" | |
}, | |
"type": "string" | |
}, | |
"c_modelHip": { | |
"x-label": { | |
"default": "Model Hip" | |
}, | |
"type": "string" | |
}, | |
"c_modelHips": { | |
"x-label": { | |
"default": "Model Hip" | |
}, | |
"type": "string" | |
}, | |
"c_modelSampleSize": { | |
"x-label": { | |
"default": "Model Sample Size" | |
}, | |
"type": "string" | |
}, | |
"c_modelWaist": { | |
"x-label": { | |
"default": "Model Waist" | |
}, | |
"type": "string" | |
}, | |
"c_musicStorage": { | |
"x-label": { | |
"default": "Music Storage" | |
}, | |
"type": "string" | |
}, | |
"c_myCustomizerEnabled": { | |
"description": "myCustomizerEnabled", | |
"x-label": { | |
"default": "myCustomizer Enabled" | |
}, | |
"type": "boolean" | |
}, | |
"c_myCustomizerStartPoint": { | |
"description": "myCustomizer Starting Point", | |
"x-label": { | |
"default": "myCustomizer Starting Point" | |
}, | |
"type": "string" | |
}, | |
"c_myCustomizeriframeId": { | |
"description": "myCustomizer iframe Id", | |
"x-label": { | |
"default": "myCustomizer iframe Id" | |
}, | |
"type": "string" | |
}, | |
"c_neck": { | |
"x-label": { | |
"default": "Neck" | |
}, | |
"type": "string" | |
}, | |
"c_onlyAsBonusProduct": { | |
"x-label": { | |
"default": "Only As Bonus Product" | |
}, | |
"type": "boolean" | |
}, | |
"c_opticalZoom": { | |
"x-label": { | |
"default": "Optical Zoom" | |
}, | |
"type": "string" | |
}, | |
"c_outSole": { | |
"x-label": { | |
"default": "Outsole" | |
}, | |
"type": "string" | |
}, | |
"c_outerwearType": { | |
"description": "Type of Outerwear for search refinement", | |
"enum": [ | |
"0010", | |
"0020", | |
"0030", | |
"0040", | |
"0050", | |
"0060", | |
"0070", | |
"0080" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Waterproof" | |
}, | |
{ | |
"default": "Jackets" | |
}, | |
{ | |
"default": "Vest" | |
}, | |
{ | |
"default": "Pants" | |
}, | |
{ | |
"default": "Casual" | |
}, | |
{ | |
"default": "Sweater" | |
}, | |
{ | |
"default": "Outdoor" | |
}, | |
{ | |
"default": "Fleece" | |
} | |
], | |
"x-label": { | |
"default": "Outerwear Type" | |
}, | |
"type": "string" | |
}, | |
"c_outsolePrimary": { | |
"x-label": { | |
"default": "Outsole Primary" | |
}, | |
"type": "string" | |
}, | |
"c_pattern": { | |
"x-label": { | |
"default": "Colorway Pattern" | |
}, | |
"type": "string" | |
}, | |
"c_paymentOperatorPaymorrowCategory": { | |
"enum": [ | |
"BEAUTY", | |
"DIY", | |
"GARDEN", | |
"TOYS", | |
"HOBBY", | |
"BOOKS", | |
"MAGAZINES", | |
"MUSIC", | |
"HEALTH", | |
"OTCDRUGS", | |
"PRESCRIPTIONDRUGS", | |
"WHITEWARE", | |
"CLOTHING", | |
"FASHION", | |
"SHOES", | |
"ACCESSORIES", | |
"FOOD", | |
"BEVERAGES", | |
"ALCOHOL", | |
"FURNITURE", | |
"DECORATION", | |
"ART", | |
"ANTIQUES", | |
"TOOLS", | |
"MISC", | |
"ELECTRONICS", | |
"LAPTOPS", | |
"COMPUTERS", | |
"CAMERAS", | |
"FLATSCREENS", | |
"SOFTWARE", | |
"COMPUTERGAMES", | |
"STATIONERY", | |
"OFFICESUPPLIES", | |
"CARACCESSORIES", | |
"BIKEACCESSORIES", | |
"WATCHES", | |
"JEWELRY", | |
"PETSUPPLIES", | |
"GIFTS", | |
"RELIGIOUS", | |
"FLOWERS", | |
"NICHE", | |
"CRAFT", | |
"WEDDING", | |
"SPORTS", | |
"ETHNIC", | |
"TOBACCO", | |
"PHOTOGRAPHY", | |
"TICKETS", | |
"MOVIES" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Parfümerie, Beauty" | |
}, | |
{ | |
"default": "Heimwerker" | |
}, | |
{ | |
"default": "Garten" | |
}, | |
{ | |
"default": "Spielwaren" | |
}, | |
{ | |
"default": "Hobby & Freizeit" | |
}, | |
{ | |
"default": "Bücher" | |
}, | |
{ | |
"default": "Zeitschriften" | |
}, | |
{ | |
"default": "Musik CDs, Platten etc. (nur physisch)" | |
}, | |
{ | |
"default": "Gesundheitsartikel" | |
}, | |
{ | |
"default": "Arzneimittel (nicht rezeptpflichtig)" | |
}, | |
{ | |
"default": "Arzneimittel (verschreibungspflichtig)" | |
}, | |
{ | |
"default": "Haushaltsgeräte" | |
}, | |
{ | |
"default": "Kleidung, Textilien" | |
}, | |
{ | |
"default": "Markenmode (Armani, )" | |
}, | |
{ | |
"default": "Schuhe" | |
}, | |
{ | |
"default": "Accessoires" | |
}, | |
{ | |
"default": "Lebensmittel" | |
}, | |
{ | |
"default": "Getränke (nicht alkoholisch)" | |
}, | |
{ | |
"default": "Getränke (alkoholisch)" | |
}, | |
{ | |
"default": "Möbel" | |
}, | |
{ | |
"default": "Dekorationsartikel" | |
}, | |
{ | |
"default": "Kunst" | |
}, | |
{ | |
"default": "Antiquitäten" | |
}, | |
{ | |
"default": "Werkzeuge" | |
}, | |
{ | |
"default": "Sonstiges" | |
}, | |
{ | |
"default": "Consumer Electronic" | |
}, | |
{ | |
"default": "Notebooks / Laptops / Netbooks etc." | |
}, | |
{ | |
"default": "Computer / Workstation etc." | |
}, | |
{ | |
"default": "Kameras" | |
}, | |
{ | |
"default": "Flachbildschirme" | |
}, | |
{ | |
"default": "Computer Software" | |
}, | |
{ | |
"default": "Computer Spiele / Video Spiele" | |
}, | |
{ | |
"default": "Schreibwaren" | |
}, | |
{ | |
"default": "Sonstiger Bürobedarf" | |
}, | |
{ | |
"default": "Autozubehör" | |
}, | |
{ | |
"default": "Motorradzubehör" | |
}, | |
{ | |
"default": "Uhren" | |
}, | |
{ | |
"default": "Schmuck" | |
}, | |
{ | |
"default": "Heimtierbedarf" | |
}, | |
{ | |
"default": "Geschenkartikel" | |
}, | |
{ | |
"default": "Religionsartikel" | |
}, | |
{ | |
"default": "Blumen / Pflanzen" | |
}, | |
{ | |
"default": "Nischenprodukte" | |
}, | |
{ | |
"default": "Handwerksprodukte" | |
}, | |
{ | |
"default": "Hochzeitsartikel" | |
}, | |
{ | |
"default": "Sportartikel" | |
}, | |
{ | |
"default": "Ethnische Produkte" | |
}, | |
{ | |
"default": "Tabakprodukte" | |
}, | |
{ | |
"default": "Fotografie" | |
}, | |
{ | |
"default": "Eintrittskarten etc." | |
}, | |
{ | |
"default": "Filme (DVD, Videokassetten)" | |
} | |
], | |
"x-label": { | |
"default": "accepted paymorrow categories" | |
}, | |
"type": "string" | |
}, | |
"c_pdpPositionOneSlotID": { | |
"enum": [ | |
"none", | |
"pdp-position-one-slot-1", | |
"pdp-position-one-slot-2", | |
"pdp-position-one-slot-3" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "None" | |
}, | |
{ | |
"default": "PDP Position One Slot 1" | |
}, | |
{ | |
"default": "PDP Position One Slot 2" | |
}, | |
{ | |
"default": "PDP Position One Slot 3" | |
} | |
], | |
"x-label": { | |
"default": "PDP Position One SlotID" | |
}, | |
"type": "string" | |
}, | |
"c_pdpPositionTwoSlotID": { | |
"enum": [ | |
"none", | |
"pdp-position-two-slot-1", | |
"pdp-position-two-slot-2", | |
"pdp-position-two-slot-3" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "None" | |
}, | |
{ | |
"default": "PDP Position Two Slot 1" | |
}, | |
{ | |
"default": "PDP Position Two Slot 2" | |
}, | |
{ | |
"default": "PDP Position Two Slot 3" | |
} | |
], | |
"x-label": { | |
"default": "PDP Position Two SlotID" | |
}, | |
"type": "string" | |
}, | |
"c_percentageDiscountBadge": { | |
"x-label": { | |
"default": "Percentage Discount Badge" | |
}, | |
"type": "string" | |
}, | |
"c_pisaAlternateView": { | |
"description": "Alternate / hover view", | |
"enum": [ | |
"fv", | |
"bv", | |
"bv02", | |
"sv01", | |
"sv02", | |
"sv03", | |
"sv04", | |
"dt01", | |
"dt02", | |
"dt03", | |
"dt04", | |
"mod01", | |
"mod02", | |
"mod03", | |
"mod04", | |
"mod05", | |
"mod06" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Front View" | |
}, | |
{ | |
"default": "Back View" | |
}, | |
{ | |
"default": "Back View 02" | |
}, | |
{ | |
"default": "Side View 01" | |
}, | |
{ | |
"default": "Side View 02" | |
}, | |
{ | |
"default": "Side View 03" | |
}, | |
{ | |
"default": "Side View 04" | |
}, | |
{ | |
"default": "Detail View 01" | |
}, | |
{ | |
"default": "Detail View 02" | |
}, | |
{ | |
"default": "Detail View 03" | |
}, | |
{ | |
"default": "Detail View 04" | |
}, | |
{ | |
"default": "Model View 01" | |
}, | |
{ | |
"default": "Model View 02" | |
}, | |
{ | |
"default": "Model View 03" | |
}, | |
{ | |
"default": "Model View 04" | |
}, | |
{ | |
"default": "Model View 05" | |
}, | |
{ | |
"default": "Model View 06" | |
} | |
], | |
"x-label": { | |
"default": "PISA Alternate/Hover View" | |
}, | |
"type": "string" | |
}, | |
"c_pisaDefaultView": { | |
"enum": [ | |
"fv", | |
"bv", | |
"bv02", | |
"sv01", | |
"sv02", | |
"sv03", | |
"sv04", | |
"dt01", | |
"dt02", | |
"dt03", | |
"dt04", | |
"mod01", | |
"mod02", | |
"mod03", | |
"mod04", | |
"mod05", | |
"mod06" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Front View" | |
}, | |
{ | |
"default": "Back View" | |
}, | |
{ | |
"default": "Back View 02" | |
}, | |
{ | |
"default": "Side View 01" | |
}, | |
{ | |
"default": "Side View 02" | |
}, | |
{ | |
"default": "Side View 03" | |
}, | |
{ | |
"default": "Side View 04" | |
}, | |
{ | |
"default": "Detail View 01" | |
}, | |
{ | |
"default": "Detail View 02" | |
}, | |
{ | |
"default": "Detail View 03" | |
}, | |
{ | |
"default": "Detail View 04" | |
}, | |
{ | |
"default": "Model View 01" | |
}, | |
{ | |
"default": "Model View 02" | |
}, | |
{ | |
"default": "Model View 03" | |
}, | |
{ | |
"default": "Model View 04" | |
}, | |
{ | |
"default": "Model View 05" | |
}, | |
{ | |
"default": "Model View 06" | |
} | |
], | |
"x-label": { | |
"default": "PISA Default Image View" | |
}, | |
"type": "string" | |
}, | |
"c_pocketType": { | |
"x-label": { | |
"default": "Pocket Type" | |
}, | |
"type": "string" | |
}, | |
"c_portableAudioType": { | |
"items": { | |
"enum": [ | |
"0010", | |
"0020", | |
"0030" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Audio" | |
}, | |
{ | |
"default": "Video" | |
}, | |
{ | |
"default": "Internet" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Portable Audio Type" | |
}, | |
"type": "array" | |
}, | |
"c_productDivision": { | |
"x-label": { | |
"default": "Product Division" | |
}, | |
"type": "string" | |
}, | |
"c_productGroupAssetID": { | |
"description": "Product Group Content Asset ID for KOP configuration", | |
"x-label": { | |
"default": "Product Group Content Asset ID" | |
}, | |
"type": "string" | |
}, | |
"c_productGroupCGID": { | |
"description": "Product Group Category ID for KOP configuration", | |
"x-label": { | |
"default": "Product Group Category ID" | |
}, | |
"type": "string" | |
}, | |
"c_productHeight": { | |
"format": "double", | |
"x-label": { | |
"default": "Product Height" | |
}, | |
"type": "number" | |
}, | |
"c_productKopAboveProductStoryAssetIDs": { | |
"description": "Assign Thirds, Hero, Overlap, and Product Group Features KOP assets.", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Product KOP Asset IDs (Above product story)" | |
}, | |
"type": "array" | |
}, | |
"c_productKopAssetIDs": { | |
"description": "Assign Thirds, Hero, Overlap, and Product Group Features KOP assets.", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Product KOP Asset IDs" | |
}, | |
"type": "array" | |
}, | |
"c_productLength": { | |
"format": "double", | |
"x-label": { | |
"default": "Product Length" | |
}, | |
"type": "number" | |
}, | |
"c_productVideos": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Product Videos" | |
}, | |
"type": "array" | |
}, | |
"c_productWeight": { | |
"format": "double", | |
"x-label": { | |
"default": "Product Weight" | |
}, | |
"type": "number" | |
}, | |
"c_productWidth": { | |
"format": "double", | |
"x-label": { | |
"default": "Product Width" | |
}, | |
"type": "number" | |
}, | |
"c_productdivCode": { | |
"x-label": { | |
"default": "Product Division Code" | |
}, | |
"type": "string" | |
}, | |
"c_productdivName": { | |
"x-label": { | |
"default": "Product Division Name" | |
}, | |
"type": "string" | |
}, | |
"c_profile": { | |
"x-label": { | |
"default": "Profile" | |
}, | |
"type": "string" | |
}, | |
"c_promoExcluded": { | |
"x-label": { | |
"default": "Promo Excluded" | |
}, | |
"type": "boolean" | |
}, | |
"c_promoExclusion": { | |
"x-label": { | |
"default": "Promotion exclusion" | |
}, | |
"type": "boolean" | |
}, | |
"c_pumaTechnology": { | |
"items": { | |
"enum": [ | |
"evoKNIT", | |
"Hybrid", | |
"NRGY", | |
"ProFoam", | |
"Netfit", | |
"FuseFit", | |
"EverFit", | |
"PROPULSION", | |
"PROPLATE", | |
"SPEEDTRACTION", | |
"Disc Fit", | |
"SoftFoam", | |
"Puretex", | |
"warmCELL", | |
"windCELL", | |
"dryCELL", | |
"stormCELL", | |
"thermo-R+", | |
"Lycra", | |
"Runner ID", | |
"duraBASE", | |
"duoCELL", | |
"RAPIDAGILITY", | |
"RAPIDSPRINT", | |
"X-Bionic" | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Puma Technology" | |
}, | |
"type": "array" | |
}, | |
"c_radialInventoryThreshold": { | |
"description": "Threshold for when to do the real time inventory call", | |
"format": "int32", | |
"x-label": { | |
"default": "Radial Inventory Threshold" | |
}, | |
"type": "integer" | |
}, | |
"c_recipeId": { | |
"x-label": { | |
"default": "Recipe ID" | |
}, | |
"type": "string" | |
}, | |
"c_refinementBra": { | |
"enum": [ | |
"Low Impact", | |
"Medium Impact", | |
"High Impact" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Low Impact" | |
}, | |
{ | |
"default": "Medium Impact" | |
}, | |
{ | |
"default": "High Impact" | |
} | |
], | |
"x-label": { | |
"default": "Refinement Bra" | |
}, | |
"type": "string" | |
}, | |
"c_refinementCollection": { | |
"description": "Add Collection search filters to this product.", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Collection Refinements" | |
}, | |
"type": "array" | |
}, | |
"c_refinementColor": { | |
"enum": [ | |
"black", | |
"blue", | |
"green", | |
"red", | |
"orange", | |
"pink", | |
"purple", | |
"white", | |
"yellow", | |
"grey", | |
"beige", | |
"miscellaneous", | |
"brown", | |
"navy" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Black" | |
}, | |
{ | |
"default": "Blue" | |
}, | |
{ | |
"default": "Green" | |
}, | |
{ | |
"default": "Red" | |
}, | |
{ | |
"default": "Orange" | |
}, | |
{ | |
"default": "Pink" | |
}, | |
{ | |
"default": "Purple" | |
}, | |
{ | |
"default": "White" | |
}, | |
{ | |
"default": "Yellow" | |
}, | |
{ | |
"default": "Grey" | |
}, | |
{ | |
"default": "Beige" | |
}, | |
{ | |
"default": "Miscellaneous" | |
}, | |
{ | |
"default": "Brown" | |
}, | |
{ | |
"default": "Navy" | |
} | |
], | |
"x-label": { | |
"default": "Refinement Color" | |
}, | |
"type": "string" | |
}, | |
"c_refinementCushioningLevel": { | |
"x-label": { | |
"default": "Refinement Cushioning Level" | |
}, | |
"type": "string" | |
}, | |
"c_refinementHTD": { | |
"x-label": { | |
"default": "Refinement HTD" | |
}, | |
"type": "string" | |
}, | |
"c_refinementLevel": { | |
"x-label": { | |
"default": "Refinement Level" | |
}, | |
"type": "string" | |
}, | |
"c_refinementShoeType": { | |
"x-label": { | |
"default": "Refinement Shoe Type" | |
}, | |
"type": "string" | |
}, | |
"c_refinementSilo": { | |
"x-label": { | |
"default": "Refinement Silo" | |
}, | |
"type": "string" | |
}, | |
"c_refinementSpecialFeature": { | |
"x-label": { | |
"default": "Refinement Special Feature" | |
}, | |
"type": "string" | |
}, | |
"c_refinementSport": { | |
"description": "Add Sport search filters to this product.", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Sport Refinements" | |
}, | |
"type": "array" | |
}, | |
"c_refinementSurface": { | |
"x-label": { | |
"default": "Refinement Surface" | |
}, | |
"type": "string" | |
}, | |
"c_refinementSurfaceRunning": { | |
"x-label": { | |
"default": "Refinement Surface Running" | |
}, | |
"type": "string" | |
}, | |
"c_refinementWeight": { | |
"x-label": { | |
"default": "Refinement Weight" | |
}, | |
"type": "string" | |
}, | |
"c_removableSole": { | |
"x-label": { | |
"default": "Removable sole" | |
}, | |
"type": "boolean" | |
}, | |
"c_resolution": { | |
"x-label": { | |
"default": "Resolution" | |
}, | |
"type": "string" | |
}, | |
"c_restrictedCountries": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Restricted Countries" | |
}, | |
"type": "array" | |
}, | |
"c_restrictedStates": { | |
"description": "A comma-separated list of State or Province codes that this product cannot be purchased in or shipped to", | |
"x-label": { | |
"default": "Restricted States" | |
}, | |
"type": "string" | |
}, | |
"c_retailOnly": { | |
"x-label": { | |
"default": "Retail Only" | |
}, | |
"type": "boolean" | |
}, | |
"c_returnRuleID": { | |
"description": "Represents Return Rule ID", | |
"x-label": { | |
"default": "Return Rule ID" | |
}, | |
"type": "string" | |
}, | |
"c_sandalType": { | |
"description": "Type of Sandal for search refinement", | |
"enum": [ | |
"0010", | |
"0020", | |
"0030" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Sport" | |
}, | |
{ | |
"default": "Casual" | |
}, | |
{ | |
"default": "Thong" | |
} | |
], | |
"x-label": { | |
"default": "Sandal Type" | |
}, | |
"type": "string" | |
}, | |
"c_scene7AlternateView": { | |
"enum": [ | |
"_01", | |
"_02", | |
"_03" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "_01" | |
}, | |
{ | |
"default": "_02" | |
}, | |
{ | |
"default": "_03" | |
} | |
], | |
"x-label": { | |
"default": "Scene7 Alternate Hover View" | |
}, | |
"type": "string" | |
}, | |
"c_scene7DefaultView": { | |
"description": "Scene7 Default Image View to override Site Preference\r\n \r\n Image views: _01, _02, _03, _04, _05\r\n Default: _01\n ", | |
"enum": [ | |
"_01", | |
"_02", | |
"_03", | |
"_04", | |
"_05" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "_01" | |
}, | |
{ | |
"default": "_02" | |
}, | |
{ | |
"default": "_03" | |
}, | |
{ | |
"default": "_04" | |
}, | |
{ | |
"default": "_05" | |
} | |
], | |
"x-label": { | |
"default": "Scene7 Default Image View" | |
}, | |
"type": "string" | |
}, | |
"c_season": { | |
"x-label": { | |
"default": "Season" | |
}, | |
"type": "string" | |
}, | |
"c_selectCode": { | |
"x-label": { | |
"default": "SELECT Sort Code" | |
}, | |
"type": "string" | |
}, | |
"c_selectExclusion": { | |
"x-label": { | |
"default": "SELECT exclusion" | |
}, | |
"type": "boolean" | |
}, | |
"c_selectName": { | |
"x-label": { | |
"default": "SELECT Sort Name" | |
}, | |
"type": "string" | |
}, | |
"c_shaftFlex": { | |
"description": "Golf shaft flex", | |
"x-label": { | |
"default": "Shaft Flex" | |
}, | |
"type": "string" | |
}, | |
"c_shaftMaterial": { | |
"description": "Golf shaft material", | |
"x-label": { | |
"default": "Shaft Material" | |
}, | |
"type": "string" | |
}, | |
"c_sheets": { | |
"description": "test attribute", | |
"items": { | |
"enum": [ | |
"value1", | |
"value2", | |
"value3" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Value 1" | |
}, | |
{ | |
"default": "Value 2" | |
}, | |
{ | |
"default": "Value 3" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Sheets" | |
}, | |
"type": "array" | |
}, | |
"c_shippingAndReturnsAssetID": { | |
"x-label": { | |
"default": "Free shipping and returns asset ID" | |
}, | |
"type": "string" | |
}, | |
"c_shoeFinderActivity": { | |
"items": { | |
"enum": [ | |
0, | |
1, | |
2 | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Mostly weights" | |
}, | |
{ | |
"default": "I mix it up" | |
}, | |
{ | |
"default": "Mostly cardio" | |
} | |
], | |
"format": "int32", | |
"type": "integer" | |
}, | |
"x-label": { | |
"default": "Shoe Finder Activity" | |
}, | |
"type": "array" | |
}, | |
"c_shoeFinderCushion": { | |
"items": { | |
"enum": [ | |
0, | |
1, | |
2 | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Minimal" | |
}, | |
{ | |
"default": "Average" | |
}, | |
{ | |
"default": "Extra" | |
} | |
], | |
"format": "int32", | |
"type": "integer" | |
}, | |
"x-label": { | |
"default": "Shoe Finder Cushioning" | |
}, | |
"type": "array" | |
}, | |
"c_shoeFinderDistance": { | |
"items": { | |
"enum": [ | |
0, | |
1, | |
2 | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "0 - 10 miles" | |
}, | |
{ | |
"default": "10 - 20 miles" | |
}, | |
{ | |
"default": "20+ miles" | |
} | |
], | |
"format": "int32", | |
"type": "integer" | |
}, | |
"x-label": { | |
"default": "Shoe Finder Distance" | |
}, | |
"type": "array" | |
}, | |
"c_shoeFinderSupport": { | |
"items": { | |
"enum": [ | |
0, | |
1, | |
2 | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Minimal" | |
}, | |
{ | |
"default": "Average" | |
}, | |
{ | |
"default": "Extra" | |
} | |
], | |
"format": "int32", | |
"type": "integer" | |
}, | |
"x-label": { | |
"default": "Shoe Finder Support" | |
}, | |
"type": "array" | |
}, | |
"c_shoePronation": { | |
"x-label": { | |
"default": "Shoe pronation" | |
}, | |
"type": "string" | |
}, | |
"c_shoeType": { | |
"description": "Type of Shoe for search refinements", | |
"enum": [ | |
"0010", | |
"0020", | |
"0030", | |
"0040", | |
"0050", | |
"0060", | |
"0070", | |
"0080", | |
"0090", | |
"0100", | |
"0110" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Chukka" | |
}, | |
{ | |
"default": "Lace Up" | |
}, | |
{ | |
"default": "Slip On" | |
}, | |
{ | |
"default": "Clog" | |
}, | |
{ | |
"default": "Boat" | |
}, | |
{ | |
"default": "Oxford" | |
}, | |
{ | |
"default": "Loafer" | |
}, | |
{ | |
"default": "Waterproof" | |
}, | |
{ | |
"default": "Flats" | |
}, | |
{ | |
"default": "Ballerina" | |
}, | |
{ | |
"default": "Heeled" | |
} | |
], | |
"x-label": { | |
"default": "Shoe Type" | |
}, | |
"type": "string" | |
}, | |
"c_shortDescription": { | |
"x-label": { | |
"default": "Short Description" | |
}, | |
"type": "string" | |
}, | |
"c_size": { | |
"description": "This attribute is used for all footwear, apparel and accessory sizing for men, women and kids products.", | |
"x-label": { | |
"ru-RU": "РАЗМЕР", | |
"default": "Size", | |
"fr": "Taille" | |
}, | |
"type": "string" | |
}, | |
"c_sizeGuide": { | |
"description": "Enter the ID of the content asset you would like to use for this\n product's Size Guide. If a Size Guide is not found here, the PDP will default to using this\n product's category size guide.\n ", | |
"x-label": { | |
"default": "Size Guide (Content Asset ID)" | |
}, | |
"type": "string" | |
}, | |
"c_sizeSpecTable": { | |
"description": "Size table contents, with each cell delimited by a pipe I and each row\n a separate string.\r\n First string: Title row\r\n Subsequent strings: Body rows\n ", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Size Table" | |
}, | |
"type": "array" | |
}, | |
"c_sizeSpecTableImp": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Size Table Imperial Measures" | |
}, | |
"type": "array" | |
}, | |
"c_sizeValue": { | |
"description": "Localizable size value for reference", | |
"x-label": { | |
"default": "Size Value" | |
}, | |
"type": "string" | |
}, | |
"c_sizesortID": { | |
"x-label": { | |
"default": "Size Sort ID" | |
}, | |
"type": "string" | |
}, | |
"c_sizetableNumber": { | |
"x-label": { | |
"default": "Size Table" | |
}, | |
"type": "string" | |
}, | |
"c_skinConcern": { | |
"items": { | |
"enum": [ | |
"dryTight", | |
"comprehensive", | |
"liftingLossFirm" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Dry, Tight Skin" | |
}, | |
{ | |
"default": "Comprehensive Protection" | |
}, | |
{ | |
"default": "Lifting & Loss of Firmness" | |
} | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Skin Concern" | |
}, | |
"type": "array" | |
}, | |
"c_sleeves": { | |
"x-label": { | |
"default": "Sleeves" | |
}, | |
"type": "string" | |
}, | |
"c_sockType": { | |
"x-label": { | |
"default": "Sock Type" | |
}, | |
"type": "string" | |
}, | |
"c_sockliner": { | |
"x-label": { | |
"default": "Sockliner" | |
}, | |
"type": "string" | |
}, | |
"c_socklinerPrimary": { | |
"x-label": { | |
"default": "Sockliner Primary" | |
}, | |
"type": "string" | |
}, | |
"c_soldOut": { | |
"description": "product active soldout badge flag", | |
"x-label": { | |
"default": "Sold Out" | |
}, | |
"type": "boolean" | |
}, | |
"c_sortID": { | |
"x-label": { | |
"default": "sortID" | |
}, | |
"type": "string" | |
}, | |
"c_specTable1Content": { | |
"description": "The specification table contents, with each cell delimited by a pipe |\n and each row a separate string.\r\n First string: Title row\r\n Subsequent strings: Body rows\n ", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Club Specification Table 1 Content" | |
}, | |
"type": "array" | |
}, | |
"c_specTable1Images": { | |
"description": "Set of Scene7 image ids", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Club Specification Table 1 Scene7 Images" | |
}, | |
"type": "array" | |
}, | |
"c_specTable1Title": { | |
"description": "Title for Cobra Golf golf club specification table", | |
"x-label": { | |
"default": "Club Specification Table 1 Title" | |
}, | |
"type": "string" | |
}, | |
"c_specTable2Content": { | |
"description": "The specification table 2 contents, with each cell delimited by a pipe\n | and each row a separate string.\r\n First string: Title row\r\n Subsequent strings: Body rows\n ", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Club Specification Table 2 Content" | |
}, | |
"type": "array" | |
}, | |
"c_specTable2Images": { | |
"description": "Scene7 image ids", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Club Specification Table 2 Scene7 Images" | |
}, | |
"type": "array" | |
}, | |
"c_specTable2Title": { | |
"description": "Title for specification table 2", | |
"x-label": { | |
"default": "Club Specification Table 2 Title" | |
}, | |
"type": "string" | |
}, | |
"c_specTable3Content": { | |
"description": "The specification table 3 contents, with each cell delimited by a pipe\n | and each row a separate string.\r\n First string: Title row\r\n Subsequent strings: Body rows\n ", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Club Specification Table 3 Content" | |
}, | |
"type": "array" | |
}, | |
"c_specTable3Images": { | |
"description": "Scene7 image ids", | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Club Specification Table 3 Scene7 Images" | |
}, | |
"type": "array" | |
}, | |
"c_specTable3Title": { | |
"description": "Title for specification table 3", | |
"x-label": { | |
"default": "Club Specification Table 3 Title" | |
}, | |
"type": "string" | |
}, | |
"c_specialFeature": { | |
"x-label": { | |
"default": "Special Feature" | |
}, | |
"type": "string" | |
}, | |
"c_specialMessage": { | |
"x-label": { | |
"default": "Special Message content asset ID" | |
}, | |
"type": "string" | |
}, | |
"c_specialMessageEnabled": { | |
"x-label": { | |
"default": "Special Message Enabled" | |
}, | |
"type": "boolean" | |
}, | |
"c_sportCode": { | |
"x-label": { | |
"default": "Sport Code" | |
}, | |
"type": "string" | |
}, | |
"c_sportName": { | |
"x-label": { | |
"default": "Sport Name" | |
}, | |
"type": "string" | |
}, | |
"c_sportType": { | |
"x-label": { | |
"default": "Sport type" | |
}, | |
"type": "string" | |
}, | |
"c_staffExclusion": { | |
"x-label": { | |
"default": "Staff Exclusion" | |
}, | |
"type": "boolean" | |
}, | |
"c_styleLogo": { | |
"x-label": { | |
"default": "Style Logo" | |
}, | |
"type": "string" | |
}, | |
"c_styleNumber": { | |
"description": "PUMA Style Number: ######_##\r\n \r\n (6) digit style number + (2) digit color code\n ", | |
"x-label": { | |
"ru-RU": "Артикул", | |
"default": "Style Number" | |
}, | |
"type": "string" | |
}, | |
"c_subcatCode": { | |
"x-label": { | |
"default": "Subcategory Code" | |
}, | |
"type": "string" | |
}, | |
"c_subcatID": { | |
"x-label": { | |
"default": "Subcategory ID" | |
}, | |
"type": "string" | |
}, | |
"c_subcatName": { | |
"x-label": { | |
"default": "Subcategory Name" | |
}, | |
"type": "string" | |
}, | |
"c_supportlevelbra": { | |
"x-label": { | |
"default": "Bra Support Level" | |
}, | |
"type": "string" | |
}, | |
"c_surface": { | |
"x-label": { | |
"default": "Surface" | |
}, | |
"type": "string" | |
}, | |
"c_sustainability": { | |
"x-label": { | |
"default": "Sustainability" | |
}, | |
"type": "string" | |
}, | |
"c_tabDescription": { | |
"format": "html", | |
"x-label": { | |
"default": "Description" | |
}, | |
"type": "string" | |
}, | |
"c_tabDetails": { | |
"format": "html", | |
"x-label": { | |
"default": "Details" | |
}, | |
"type": "string" | |
}, | |
"c_team": { | |
"x-label": { | |
"default": "Team" | |
}, | |
"type": "string" | |
}, | |
"c_technicalDeviceCompartmentSize": { | |
"x-label": { | |
"default": "Technical Device Compartment Size" | |
}, | |
"type": "string" | |
}, | |
"c_technology": { | |
"x-label": { | |
"default": "Technology" | |
}, | |
"type": "string" | |
}, | |
"c_technologyName": { | |
"x-label": { | |
"default": "Technology Name" | |
}, | |
"type": "string" | |
}, | |
"c_technologyPurpose": { | |
"items": { | |
"enum": [ | |
"comfort and support", | |
"performance focus", | |
"temperature control", | |
"weather protection" | |
], | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Technology Purpose" | |
}, | |
"type": "array" | |
}, | |
"c_test": { | |
"format": "html", | |
"x-label": { | |
"default": "test" | |
}, | |
"type": "string" | |
}, | |
"c_toeType": { | |
"x-label": { | |
"default": "Toe Type" | |
}, | |
"type": "string" | |
}, | |
"c_topType": { | |
"description": "Type of tops in clothing", | |
"x-label": { | |
"default": "Top Type" | |
}, | |
"type": "string" | |
}, | |
"c_trouserRise": { | |
"x-label": { | |
"default": "Trouser Rise" | |
}, | |
"type": "string" | |
}, | |
"c_tvSignalFormat": { | |
"x-label": { | |
"default": "TV Signal Format" | |
}, | |
"type": "string" | |
}, | |
"c_tvSize": { | |
"x-label": { | |
"default": "Size" | |
}, | |
"type": "string" | |
}, | |
"c_tvType": { | |
"enum": [ | |
"0010", | |
"0020", | |
"0030", | |
"0040" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Plasma" | |
}, | |
{ | |
"default": "LCD" | |
}, | |
{ | |
"default": "DLP" | |
}, | |
{ | |
"default": "Projection" | |
} | |
], | |
"x-label": { | |
"default": "TV Type" | |
}, | |
"type": "string" | |
}, | |
"c_tvWarranty": { | |
"x-label": { | |
"default": "Extended Warranty" | |
}, | |
"type": "string" | |
}, | |
"c_upper": { | |
"x-label": { | |
"default": "Upper" | |
}, | |
"type": "string" | |
}, | |
"c_upperPrimary": { | |
"x-label": { | |
"default": "Upper Primary" | |
}, | |
"type": "string" | |
}, | |
"c_vegan": { | |
"x-label": { | |
"default": "Vegan" | |
}, | |
"type": "string" | |
}, | |
"c_videoStorage": { | |
"x-label": { | |
"default": "Video Storage" | |
}, | |
"type": "string" | |
}, | |
"c_volume": { | |
"format": "double", | |
"x-label": { | |
"default": "Volume" | |
}, | |
"type": "number" | |
}, | |
"c_waist": { | |
"description": "Attribute used for apparel waist sizing.", | |
"x-label": { | |
"default": "Waist" | |
}, | |
"type": "string" | |
}, | |
"c_width": { | |
"description": "This attribute is used for shoe widths for mens, womens and kids.", | |
"x-label": { | |
"default": "Width" | |
}, | |
"type": "string" | |
}, | |
"currency": { | |
"description": "The ISO 4217 mnemonic code of the currency.", | |
"type": "string" | |
}, | |
"ean": { | |
"description": "The European Article Number.", | |
"x-label": { | |
"default": "EAN" | |
}, | |
"type": "string" | |
}, | |
"fetch_date": { | |
"format": "int32", | |
"type": "integer" | |
}, | |
"id": { | |
"description": "The id (SKU) of the product.", | |
"x-label": { | |
"default": "ID", | |
"en": "SKUAGE" | |
}, | |
"maxLength": 100, | |
"minLength": 1, | |
"type": "string" | |
}, | |
"image_groups": { | |
"description": "The array of product image groups.", | |
"items": { | |
"$ref": "#/definitions/image_group" | |
}, | |
"type": "array" | |
}, | |
"inventories": { | |
"description": "The array of product inventories explicitly requested via 'inventory_ids' query parameter. This property\n is only returned in context of the 'availability' expansion.", | |
"items": { | |
"$ref": "#/definitions/inventory" | |
}, | |
"type": "array" | |
}, | |
"inventory": { | |
"$ref": "#/definitions/inventory", | |
"description": "The site default inventory information. This property is only\n returned in context of the 'availability' expansion." | |
}, | |
"long_description": { | |
"description": "The localized product long description.", | |
"format": "html", | |
"x-label": { | |
"default": "Product Details" | |
}, | |
"type": "string" | |
}, | |
"manufacturer_name": { | |
"description": "The products manufacturer name.", | |
"x-label": { | |
"default": "Manufacturer" | |
}, | |
"type": "string" | |
}, | |
"manufacturer_sku": { | |
"description": "The products manufacturer sku.", | |
"x-label": { | |
"default": "Manufacturer Product ID" | |
}, | |
"type": "string" | |
}, | |
"master": { | |
"$ref": "#/definitions/master", | |
"description": "The master product information. Only for types master, variation group and variant." | |
}, | |
"min_order_quantity": { | |
"description": "The minimum order quantity for this product.", | |
"format": "double", | |
"x-label": { | |
"default": "Minimum Order Quantity" | |
}, | |
"type": "number" | |
}, | |
"name": { | |
"description": "The localized product name.", | |
"x-label": { | |
"default": "Name" | |
}, | |
"type": "string" | |
}, | |
"options": { | |
"description": "The array of product options. This array can be empty. Only for type option.", | |
"items": { | |
"$ref": "#/definitions/option" | |
}, | |
"type": "array" | |
}, | |
"page_description": { | |
"description": "The localized products page description.", | |
"x-label": { | |
"default": "Page Description" | |
}, | |
"type": "string" | |
}, | |
"page_keywords": { | |
"description": "The localized products page description.", | |
"x-label": { | |
"default": "Page Keywords" | |
}, | |
"type": "string" | |
}, | |
"page_title": { | |
"description": "The localized products page title.", | |
"x-label": { | |
"default": "Page Title" | |
}, | |
"type": "string" | |
}, | |
"price": { | |
"description": "The sales price of the product. In case of complex products like master or set this is the minimum price of\n related child products.", | |
"format": "double", | |
"type": "number" | |
}, | |
"price_max": { | |
"description": "The maximum sales of related child products in case of complex products like master or set.", | |
"format": "double", | |
"type": "number" | |
}, | |
"price_per_unit": { | |
"description": "The sales price per unit of the product. In case of complex products like master or set this is the minimum price\n per unit of related child products.", | |
"format": "double", | |
"type": "number" | |
}, | |
"price_per_unit_max": { | |
"description": "The maximum sales price per unit of related child products in case of complex products like master or set.", | |
"format": "double", | |
"type": "number" | |
}, | |
"prices": { | |
"additionalProperties": { | |
"format": "double", | |
"type": "number" | |
}, | |
"description": "The prices map with price book ids and their values.", | |
"type": "object" | |
}, | |
"primary_category_id": { | |
"description": "The id of the products primary category.", | |
"type": "string" | |
}, | |
"product_links": { | |
"description": "The array of source and target products links information.", | |
"items": { | |
"$ref": "#/definitions/product_link" | |
}, | |
"type": "array" | |
}, | |
"product_promotions": { | |
"description": "The array of active customer product promotions for this product. This array can be empty.\n Coupon promotions are not returned in this array.", | |
"items": { | |
"$ref": "#/definitions/product_promotion" | |
}, | |
"type": "array" | |
}, | |
"recommendations": { | |
"description": "Returns a list of recommendations.", | |
"items": { | |
"$ref": "#/definitions/recommendation" | |
}, | |
"type": "array" | |
}, | |
"set_products": { | |
"description": "The array of set products of this product.", | |
"items": { | |
"$ref": "#/definitions/product" | |
}, | |
"type": "array" | |
}, | |
"short_description": { | |
"description": "The localized product short description.", | |
"format": "html", | |
"x-label": { | |
"default": "Description" | |
}, | |
"type": "string" | |
}, | |
"step_quantity": { | |
"description": "The steps in which the order amount of the product can be\n increased.", | |
"format": "double", | |
"x-label": { | |
"default": "Step Quantity" | |
}, | |
"type": "number" | |
}, | |
"type": { | |
"$ref": "#/definitions/product_type", | |
"description": "The product type information. Can be one or multiple of the following values: item,master,variation_group,variant,bundle,set." | |
}, | |
"unit": { | |
"description": "The sales unit of the product.", | |
"x-label": { | |
"default": "Sales Unit" | |
}, | |
"type": "string" | |
}, | |
"unit_measure": { | |
"description": "The unitMeasure of the product.", | |
"x-label": { | |
"default": "Unit Measure" | |
}, | |
"type": "string" | |
}, | |
"unit_quantity": { | |
"description": "", | |
"format": "double", | |
"x-label": { | |
"default": "Unit Quantity" | |
}, | |
"type": "number" | |
}, | |
"upc": { | |
"description": "The Universal Product Code.", | |
"x-label": { | |
"default": "UPC" | |
}, | |
"type": "string" | |
}, | |
"valid_from": { | |
"description": "The time when product is valid from.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Online From" | |
}, | |
"type": "string" | |
}, | |
"valid_to": { | |
"description": "The time when product is valid to.", | |
"format": "date-time", | |
"x-label": { | |
"default": "Online To" | |
}, | |
"type": "string" | |
}, | |
"variants": { | |
"description": "The array of actual variants. This array can be empty. Only for types master, variation group and variant.", | |
"items": { | |
"$ref": "#/definitions/variant" | |
}, | |
"type": "array" | |
}, | |
"variation_attributes": { | |
"description": "Sorted array of variation attributes information. This array can be empty. Only for types master,\n variation group and variant.", | |
"items": { | |
"$ref": "#/definitions/variation_attribute" | |
}, | |
"type": "array" | |
}, | |
"variation_groups": { | |
"description": "The array of actual variation groups. This array can be empty. Only for types master, variation group and variant.", | |
"items": { | |
"$ref": "#/definitions/variation_group" | |
}, | |
"type": "array" | |
}, | |
"variation_values": { | |
"additionalProperties": { | |
"type": "string" | |
}, | |
"description": "The actual variation attribute id - value pairs. Only for type variant and\n variation group.", | |
"type": "object" | |
} | |
}, | |
"required": [ | |
"id" | |
] | |
}, | |
"product_details_link": { | |
"description": "Document representing a link to the resource for product details.", | |
"properties": { | |
"link": { | |
"description": "The target of the link.", | |
"type": "string" | |
}, | |
"product_description": { | |
"description": "The description of the product.", | |
"type": "string" | |
}, | |
"product_id": { | |
"description": "The id of the product.", | |
"type": "string" | |
}, | |
"product_name": { | |
"description": "The name of the product.", | |
"type": "string" | |
}, | |
"title": { | |
"description": "The link title.", | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"product_id" | |
] | |
}, | |
"product_item": { | |
"description": "Document representing a product item.", | |
"properties": { | |
"adjusted_tax": { | |
"description": "The tax of the product item after adjustments applying.", | |
"format": "double", | |
"type": "number" | |
}, | |
"base_price": { | |
"description": "The base price for the line item, which is the\n price of the unit before applying adjustments, in the purchase\n currency. The base price may be net or gross of tax depending\n on the configured taxation policy.", | |
"format": "double", | |
"type": "number" | |
}, | |
"bonus_discount_line_item_id": { | |
"description": "The id of the bonus discount line item this bonus product relates to.", | |
"type": "string" | |
}, | |
"bonus_product_line_item": { | |
"description": "A flag indicating whether the product item is a bonus.", | |
"type": "boolean" | |
}, | |
"bundled_product_items": { | |
"description": "The array of bundled product items. Can be empty.", | |
"items": { | |
"$ref": "#/definitions/product_item" | |
}, | |
"type": "array" | |
}, | |
"c_OrderOMSProTrackingNumber": { | |
"x-label": { | |
"default": "OrderOMSProTrackingNumber" | |
}, | |
"type": "string" | |
}, | |
"c_RadialDuty": { | |
"format": "double", | |
"x-label": { | |
"default": "Radial Duty" | |
}, | |
"type": "number" | |
}, | |
"c_allPriceAdjustments": { | |
"format": "text", | |
"x-label": { | |
"default": "All price adjustments" | |
}, | |
"type": "string" | |
}, | |
"c_bonusProductLineItemUUID": { | |
"description": "This represents the UUID of the product line item that holds the qualifying product.", | |
"x-label": { | |
"default": "Bonus Product Line Item UUID" | |
}, | |
"type": "string" | |
}, | |
"c_cancelCMA": { | |
"description": "Cancellation Reference Number", | |
"x-label": { | |
"default": "cancelCMA" | |
}, | |
"type": "string" | |
}, | |
"c_cancelDate": { | |
"description": "Cancel created datetime", | |
"x-label": { | |
"default": "cancelDate" | |
}, | |
"type": "string" | |
}, | |
"c_cancelQuantity": { | |
"description": "Quantity that Order items cancelled", | |
"x-label": { | |
"default": "cancelQuantity" | |
}, | |
"type": "string" | |
}, | |
"c_cancelQuantityOMS": { | |
"x-label": { | |
"default": "cancelQuantityOMS" | |
}, | |
"type": "string" | |
}, | |
"c_cancelReason": { | |
"description": "Cancel Reason", | |
"x-label": { | |
"default": "cancelReason" | |
}, | |
"type": "string" | |
}, | |
"c_cancelStatus": { | |
"description": "Cancel Status", | |
"x-label": { | |
"default": "cancelStatus" | |
}, | |
"type": "string" | |
}, | |
"c_colorCode": { | |
"x-label": { | |
"default": "Color Code" | |
}, | |
"type": "string" | |
}, | |
"c_customImageURL": { | |
"description": "URL used in relation to the PLI to override system default image URL.\n Must be fully qualified URL with Protocol, Domain, Path & Parameters.\n ", | |
"x-label": { | |
"default": "Custom Image URL" | |
}, | |
"type": "string" | |
}, | |
"c_customProductName": { | |
"description": "Custom Name String to override product line item name display.\n ", | |
"x-label": { | |
"default": "Custom Product Name" | |
}, | |
"type": "string" | |
}, | |
"c_customProductPrice": { | |
"description": "Price as defined from Configure API lookup request.", | |
"format": "double", | |
"x-label": { | |
"default": "Custom Product Price" | |
}, | |
"type": "number" | |
}, | |
"c_customProductURL": { | |
"description": "The URL containing the recipeID that will recreate the configured\n product PDP.\n ", | |
"x-label": { | |
"default": "Custom Product URL" | |
}, | |
"type": "string" | |
}, | |
"c_discountedPrice": { | |
"format": "double", | |
"x-label": { | |
"default": "Discounted price" | |
}, | |
"type": "number" | |
}, | |
"c_edgeTrackingNumber": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Edge Tracking Number" | |
}, | |
"type": "array" | |
}, | |
"c_fluidConfigureImageURL": { | |
"x-label": { | |
"default": "Fluid Configure Image URL" | |
}, | |
"type": "string" | |
}, | |
"c_fluidConfigureLargeImageURL": { | |
"x-label": { | |
"default": "Fluid Configure Large Image URL" | |
}, | |
"type": "string" | |
}, | |
"c_fluidConfigureNameText": { | |
"description": "Name that should be printed of configured product", | |
"x-label": { | |
"default": "Fluid Configure Name Text" | |
}, | |
"type": "string" | |
}, | |
"c_fluidConfigureNumberText": { | |
"description": "Number that should be printed in configured product", | |
"x-label": { | |
"default": "Fluid Configure Number Text" | |
}, | |
"type": "string" | |
}, | |
"c_fluidConfigurePrice": { | |
"x-label": { | |
"default": "Fluid Configure Price" | |
}, | |
"type": "string" | |
}, | |
"c_fluidConfigurePriceArray": { | |
"x-label": { | |
"default": "Fluid Configure Price Array" | |
}, | |
"type": "string" | |
}, | |
"c_fluidConfigureQuantity": { | |
"x-label": { | |
"default": "Fluid Configure Quantity" | |
}, | |
"type": "string" | |
}, | |
"c_fluidConfigureRecipeID": { | |
"x-label": { | |
"default": "Fluid Configure Recipe ID" | |
}, | |
"type": "string" | |
}, | |
"c_fluidConfigureResourceURL": { | |
"x-label": { | |
"default": "Fluid Configure Resource URL" | |
}, | |
"type": "string" | |
}, | |
"c_fromStoreId": { | |
"description": "Links the store to the product line item for grouping shipments in the checkout process.", | |
"x-label": { | |
"default": "From Store ID" | |
}, | |
"type": "string" | |
}, | |
"c_geBackOrderDate": { | |
"description": "Estimated date for the backordered item to be in stock", | |
"x-label": { | |
"default": "Back Order Date" | |
}, | |
"type": "string" | |
}, | |
"c_geCartItemId": { | |
"description": "Identifier of the cart item on the Merchant’s site originally specified in Product.CartItemId property of the respective product in SendCart method for the cart converted to this order on Global-e.", | |
"x-label": { | |
"default": "Cart item ID" | |
}, | |
"type": "string" | |
}, | |
"c_geCartItemOptionId": { | |
"description": "Identifier of the child cart item “option” on the Merchant’s site originally specified in Product.CartItemOptionId property of the respective product in SendCart method for the cart converted to this order on Global-e.", | |
"x-label": { | |
"default": "Cart item option ID" | |
}, | |
"type": "string" | |
}, | |
"c_geCustomerVATRate": { | |
"description": "Customer VAT Rate applied to this product", | |
"format": "double", | |
"x-label": { | |
"default": "Customer VAT Rate" | |
}, | |
"type": "number" | |
}, | |
"c_geDiscountedPrice": { | |
"description": "The product value in merchant currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as pre-calculated value for returned product’s refund.", | |
"format": "double", | |
"x-label": { | |
"default": "Discounted Price" | |
}, | |
"type": "number" | |
}, | |
"c_geDiscountedPriceForCustoms": { | |
"description": "Product price in merchant currency reflects the price after Reverse D&T calculation", | |
"format": "double", | |
"x-label": { | |
"default": "Original Discounted Price for Customs" | |
}, | |
"type": "number" | |
}, | |
"c_geInternationalDiscountedPrice": { | |
"description": "The product value in customer currency after deducting all product and cart level discounts from the price. Product level discounts will be fully deducted from the respective product’s price and cart discounts will be prorated over all products according to the remaining value. This value can be used as pre-calculated value for returned product’s refund.", | |
"format": "double", | |
"x-label": { | |
"default": "International Discounted Price" | |
}, | |
"type": "number" | |
}, | |
"c_geInternationalDiscountedPriceForCustoms": { | |
"description": "Product price in customer currency reflects the price after Reverse D&T calculation", | |
"format": "double", | |
"x-label": { | |
"default": "International Discounted Price for Customs" | |
}, | |
"type": "number" | |
}, | |
"c_geInternationalDiscountedPriceInMerchantCurrency": { | |
"description": "International Discounted Price in merchant currency", | |
"format": "double", | |
"x-label": { | |
"default": "International Discounted Price in merchant currency" | |
}, | |
"type": "number" | |
}, | |
"c_geInternationalListPrice": { | |
"description": "Single product list price in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable) and IncludeVAT handling", | |
"format": "double", | |
"x-label": { | |
"default": "International List Price" | |
}, | |
"type": "number" | |
}, | |
"c_geInternationalPrice": { | |
"description": "Single product final sale price in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable) and IncludeVAT handling", | |
"format": "double", | |
"x-label": { | |
"default": "International Price" | |
}, | |
"type": "number" | |
}, | |
"c_geInternationalProductSubsidy": { | |
"description": "Product DTSubsidy on Buyer currency", | |
"format": "double", | |
"x-label": { | |
"default": "Product DTSubsidy on Buyer currency" | |
}, | |
"type": "number" | |
}, | |
"c_geIsBackOrdered": { | |
"description": "Boolean specifying if the product was ordered as a backed ordered item", | |
"x-label": { | |
"default": "Is Back Ordered" | |
}, | |
"type": "boolean" | |
}, | |
"c_geIsGiftCard": { | |
"x-label": { | |
"default": "Is Globale Gift Card" | |
}, | |
"type": "boolean" | |
}, | |
"c_geLineItemInternationalPrice": { | |
"description": "Line item (product in ordered quantity) price in end customer’s currency (specified in InternationalDetails.CurrencyCode property for the respective Merchant.Order), after applying country coefficient, FX conversion, rounding rule (if applicable) and IncludeVAT handling. If not specified, should be deemed equal to “InternationalPrice * Quantity”. If specified, should take preference over InternationalPrice.", | |
"format": "double", | |
"x-label": { | |
"default": "Line Item International Price" | |
}, | |
"type": "number" | |
}, | |
"c_geListPrice": { | |
"description": "Single product List price in currency defined in geCurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant", | |
"format": "double", | |
"x-label": { | |
"default": "Original List Price" | |
}, | |
"type": "number" | |
}, | |
"c_geOriginalPriceBookTotalPrice": { | |
"description": "Original Price Book Total Price", | |
"format": "double", | |
"x-label": { | |
"default": "Original Price Book Total Price" | |
}, | |
"type": "number" | |
}, | |
"c_geParentCartItemId": { | |
"description": "Identifier of the current item’s parent cart item on the Merchant’s site originally specified in Product.ParentCartItemId property of the respective product in SendCart method for the cart converted to this order on Global-e.", | |
"x-label": { | |
"default": "Parent cart item ID" | |
}, | |
"type": "string" | |
}, | |
"c_gePrice": { | |
"description": "Single product final sale price in currency defined in geCurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant", | |
"format": "double", | |
"x-label": { | |
"default": "Price" | |
}, | |
"type": "number" | |
}, | |
"c_gePriceBeforeGlobaleDiscount": { | |
"description": "Single product price in currency defined in CurrencyCode property of the respective Merchant.Order object for the order being submitted to the Merchant, before applying any per-product Global-e discounts (such as per-product Shipping discounts). If no Global-e discount was applied, PriceBeforeGlobalEDiscount is equal to Price.", | |
"format": "double", | |
"x-label": { | |
"default": "Price Before Global-e Discount (DEPRECATED)" | |
}, | |
"type": "number" | |
}, | |
"c_gePriceBeforeRoundingRate": { | |
"description": "Price BeforeRounding Rate", | |
"format": "double", | |
"x-label": { | |
"default": "Price BeforeRounding Rate" | |
}, | |
"type": "number" | |
}, | |
"c_geProductSubsidy": { | |
"description": "Product DTSubsidy on Merchant currency", | |
"format": "double", | |
"x-label": { | |
"default": "Product DTSubsidy on Merchant currency" | |
}, | |
"type": "number" | |
}, | |
"c_geRoundingRate": { | |
"description": "Conversion rate applied to this product’s price paid by the end customer, when calculating the prices paid by Global-e to the Merchant in the original Merchant’s currency. This rate includes “FX conversion” and “marketing rounding” factors.", | |
"x-label": { | |
"default": "Global-e Rounding Rate" | |
}, | |
"type": "string" | |
}, | |
"c_geVatRate": { | |
"description": "VAT rate applied to this product", | |
"format": "double", | |
"x-label": { | |
"default": "VAT Rate" | |
}, | |
"type": "number" | |
}, | |
"c_imageURL": { | |
"description": "\n ", | |
"x-label": { | |
"default": "Image URL for Radial" | |
}, | |
"type": "string" | |
}, | |
"c_increffStatus": { | |
"enum": [ | |
"CANCELLED", | |
"RETURN_INITIATED", | |
"RETURN_PICKED", | |
"RETURN_COMPLETED" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Cancelled" | |
}, | |
{ | |
"default": "Return Initiated" | |
}, | |
{ | |
"default": "Return Received" | |
}, | |
{ | |
"default": "Return Complete" | |
} | |
], | |
"x-label": { | |
"default": "Increff Status" | |
}, | |
"type": "string" | |
}, | |
"c_increffTrackingNumber": { | |
"x-label": { | |
"default": "Increff Tracking Number" | |
}, | |
"type": "string" | |
}, | |
"c_itemDiscounts": { | |
"format": "double", | |
"x-label": { | |
"default": "Item Discounts" | |
}, | |
"type": "number" | |
}, | |
"c_myCustomizationCost": { | |
"description": "myCustomizationCost", | |
"x-label": { | |
"default": "myCustomization Cost" | |
}, | |
"type": "string" | |
}, | |
"c_myCustomizerImageURL": { | |
"description": "myCustomizer Image URL", | |
"x-label": { | |
"default": "myCustomizer Image URL" | |
}, | |
"type": "string" | |
}, | |
"c_myCustomizerLargeImageURL": { | |
"description": "myCustomizer Large Image URL", | |
"x-label": { | |
"default": "myCustomizer Large Image URL" | |
}, | |
"type": "string" | |
}, | |
"c_myCustomizerNameText": { | |
"description": "myCustomizer Name Text", | |
"x-label": { | |
"default": "myCustomizer Name Text" | |
}, | |
"type": "string" | |
}, | |
"c_myCustomizerNumberText": { | |
"description": "myCustomizer Number Text", | |
"x-label": { | |
"default": "myCustomizer Number Text" | |
}, | |
"type": "string" | |
}, | |
"c_myCustomizerPrice": { | |
"description": "myCustomizerPrice", | |
"x-label": { | |
"default": "myCustomizer Price" | |
}, | |
"type": "string" | |
}, | |
"c_myCustomizerQuantity": { | |
"description": "myCustomizer Quantity", | |
"x-label": { | |
"default": "myCustomizer Quantity" | |
}, | |
"type": "string" | |
}, | |
"c_myCustomizerRecipeID": { | |
"description": "myCustomizer RecipeID", | |
"x-label": { | |
"default": "myCustomizer RecipeID" | |
}, | |
"type": "string" | |
}, | |
"c_name": { | |
"description": "Custom Jersey configured name.", | |
"x-label": { | |
"default": "Configure Name" | |
}, | |
"type": "string" | |
}, | |
"c_number": { | |
"description": "Custom Jersey configured number.", | |
"x-label": { | |
"default": "Configure Number" | |
}, | |
"type": "string" | |
}, | |
"c_perso1": { | |
"description": "Place holder attribute for future personalizations.", | |
"x-label": { | |
"default": "Personalization 1" | |
}, | |
"type": "string" | |
}, | |
"c_perso2": { | |
"description": "Place holder attribute for future personalizations.", | |
"x-label": { | |
"default": "Personalization 2" | |
}, | |
"type": "string" | |
}, | |
"c_perso3": { | |
"description": "Place holder attribute for future personalizations.", | |
"x-label": { | |
"default": "Personalization 3" | |
}, | |
"type": "string" | |
}, | |
"c_perso4": { | |
"description": "Place holder attribute for future personalizations.", | |
"x-label": { | |
"default": "Personalization 4" | |
}, | |
"type": "string" | |
}, | |
"c_perso5": { | |
"description": "Place holder attribute for future personalizations.", | |
"x-label": { | |
"default": "Personalization 5" | |
}, | |
"type": "string" | |
}, | |
"c_preOrderUUID": { | |
"description": "this custom attribute captures the original product line item uuid before it is part of an placed order", | |
"x-label": { | |
"default": "pre order uuid" | |
}, | |
"type": "string" | |
}, | |
"c_productURL": { | |
"description": "\n ", | |
"x-label": { | |
"default": "Custom Product URL for Radial" | |
}, | |
"type": "string" | |
}, | |
"c_radialDuty": { | |
"format": "double", | |
"x-label": { | |
"default": "Radial Duty" | |
}, | |
"type": "number" | |
}, | |
"c_radialLineItemEstDeliveryDate": { | |
"description": "The XML information that comes back from the inventory details call for the line item. This data needs to be preserved so it can be later used for the order creation webservice call.", | |
"format": "text", | |
"x-label": { | |
"default": "Radial LineItem Estimated Delivery Date" | |
}, | |
"type": "string" | |
}, | |
"c_radialLineItemReservationID": { | |
"description": "This data needs to be preserved so it can be later used for the order creation webservice call.", | |
"x-label": { | |
"default": "Radial LineItem Inventory Reservation ID" | |
}, | |
"type": "string" | |
}, | |
"c_radialLineItemTaxXML": { | |
"description": "The XML information that comes back from the tax call for the line item. This data needs to be preserved so it can be later used for the order creation webservice call.", | |
"format": "text", | |
"x-label": { | |
"default": "Radial LineItem Tax XML" | |
}, | |
"type": "string" | |
}, | |
"c_radialLineNumber": { | |
"x-label": { | |
"default": "Radial Line Number" | |
}, | |
"type": "string" | |
}, | |
"c_radialMerchandiseTaxes": { | |
"format": "text", | |
"x-label": { | |
"default": "Radial Merchandise Taxes" | |
}, | |
"type": "string" | |
}, | |
"c_radialPTFAdjustmentAmt": { | |
"format": "double", | |
"x-label": { | |
"default": "Radial PTF Adjustment Amt" | |
}, | |
"type": "number" | |
}, | |
"c_radialPTFAdjustmentTaxAmt": { | |
"format": "double", | |
"x-label": { | |
"default": "Radial PTF Adjustment Tax Amt" | |
}, | |
"type": "number" | |
}, | |
"c_radialPTFLastUpdatedDate": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Radial PTF Las tUpdated Date" | |
}, | |
"type": "string" | |
}, | |
"c_radialPTFOMSStatus": { | |
"enum": [ | |
"SHIPPED", | |
"CANCELLED", | |
"RETURNED", | |
"ADJUSTED" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "SHIPPED" | |
}, | |
{ | |
"default": "CANCELLED" | |
}, | |
{ | |
"default": "RETURNED" | |
}, | |
{ | |
"default": "ADJUSTED" | |
} | |
], | |
"x-label": { | |
"default": "Radial PTF OMS Status" | |
}, | |
"type": "string" | |
}, | |
"c_radialPTFProcessingStep": { | |
"x-label": { | |
"default": "Radial PTF Processing Step" | |
}, | |
"type": "string" | |
}, | |
"c_radialPTFRetryCount": { | |
"format": "double", | |
"x-label": { | |
"default": "Radial PTF Retry Count" | |
}, | |
"type": "number" | |
}, | |
"c_radialPTFStatus": { | |
"enum": [ | |
"OK", | |
"RETRY", | |
"FAILED" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "OK" | |
}, | |
{ | |
"default": "RETRY" | |
}, | |
{ | |
"default": "FAILED" | |
} | |
], | |
"x-label": { | |
"default": "Radial PTF Status" | |
}, | |
"type": "string" | |
}, | |
"c_radialShippedDate": { | |
"x-label": { | |
"default": "Radial Shipped Date" | |
}, | |
"type": "string" | |
}, | |
"c_radialShippingStatus": { | |
"description": "The status of Radial order detail service response.", | |
"enum": [ | |
"beingprocessed", | |
"shipped", | |
"partiallyshipped", | |
"returned", | |
"partiallyreturned", | |
"exchanged", | |
"partiallyexchanged" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Being Processed" | |
}, | |
{ | |
"default": "Shipped" | |
}, | |
{ | |
"default": "Partially Shipped" | |
}, | |
{ | |
"default": "Returned" | |
}, | |
{ | |
"default": "Partially Returned" | |
}, | |
{ | |
"default": "Exchanged" | |
}, | |
{ | |
"default": "Partially Exchanged" | |
} | |
], | |
"x-label": { | |
"default": "Radial Shipping Status" | |
}, | |
"type": "string" | |
}, | |
"c_radialShippingTaxes": { | |
"format": "text", | |
"x-label": { | |
"default": "Radial Shipping Taxes" | |
}, | |
"type": "string" | |
}, | |
"c_radialStoreType": { | |
"description": "This is a pivot attribute that is used to distinguish between ISPU and STS items it should only ever have three values: [BLANK]|ISPU|STS.", | |
"x-label": { | |
"default": "Radial Store Type" | |
}, | |
"type": "string" | |
}, | |
"c_radialTrackingNumbers": { | |
"items": { | |
"type": "string" | |
}, | |
"x-label": { | |
"default": "Radial Tracking Numbers" | |
}, | |
"type": "array" | |
}, | |
"c_recipeId": { | |
"description": "Represents the configured product Recipe. The PDP for a configured\n product can be recreated using this value.\n ", | |
"x-label": { | |
"default": "Configure RecipeID" | |
}, | |
"type": "string" | |
}, | |
"c_returnCMA": { | |
"description": "Return Reference Number", | |
"x-label": { | |
"default": "returnCMA" | |
}, | |
"type": "string" | |
}, | |
"c_returnDate": { | |
"description": "Cancel created datetime", | |
"x-label": { | |
"default": "returnDate" | |
}, | |
"type": "string" | |
}, | |
"c_returnOrderItemQty": { | |
"format": "int32", | |
"x-label": { | |
"default": "Returned Quantity" | |
}, | |
"type": "integer" | |
}, | |
"c_returnQuantity": { | |
"description": "Quantity that Order items returned", | |
"format": "double", | |
"x-label": { | |
"default": "returnQuantity" | |
}, | |
"type": "number" | |
}, | |
"c_returnReason": { | |
"description": "Return Reason", | |
"enum": [ | |
"198", | |
"R09", | |
"R07", | |
"R06", | |
"R05", | |
"R04", | |
"R03", | |
"R02", | |
"R01", | |
"R10", | |
"R11" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Refund w/o return" | |
}, | |
{ | |
"default": "Wrong image or/and information vs delivered product" | |
}, | |
{ | |
"default": "Wrong article delivered" | |
}, | |
{ | |
"default": "Arrived too late" | |
}, | |
{ | |
"default": "Did not like Item" | |
}, | |
{ | |
"default": "Quality defect" | |
}, | |
{ | |
"default": "Ordered several items as selection" | |
}, | |
{ | |
"default": "Article too big" | |
}, | |
{ | |
"default": "Article too small" | |
}, | |
{ | |
"default": "Failed Delivery" | |
}, | |
{ | |
"default": "Lost in transit" | |
} | |
], | |
"x-label": { | |
"default": "returnReason" | |
}, | |
"type": "string" | |
}, | |
"c_returnStatus": { | |
"description": "Return Status", | |
"x-label": { | |
"default": "returnStatus" | |
}, | |
"type": "string" | |
}, | |
"c_shippedItems": { | |
"description": "value store how many items were shipped", | |
"format": "double", | |
"x-label": { | |
"default": "Shipped Items" | |
}, | |
"type": "number" | |
}, | |
"c_shippingStatus": { | |
"description": "define over all status of shipment per product line item", | |
"x-label": { | |
"default": "Shipping Status" | |
}, | |
"type": "string" | |
}, | |
"c_size": { | |
"x-label": { | |
"default": "Size" | |
}, | |
"type": "string" | |
}, | |
"gift": { | |
"description": "Returns true if the item is a gift.", | |
"x-label": { | |
"default": "Is A Gift" | |
}, | |
"type": "boolean" | |
}, | |
"gift_message": { | |
"description": "The gift message.", | |
"x-label": { | |
"default": "Gift Message" | |
}, | |
"type": "string" | |
}, | |
"inventory_id": { | |
"description": "The inventory list id associated with this item.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"item_id": { | |
"description": "The item identifier. Use this to identify an item when updating the item quantity or creating a custom price\n adjustment for an item.", | |
"type": "string" | |
}, | |
"item_text": { | |
"description": "The text describing the item in more detail.", | |
"type": "string" | |
}, | |
"option_items": { | |
"description": "The array of option items. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/option_item" | |
}, | |
"type": "array" | |
}, | |
"price": { | |
"description": "The price of the line item before applying any adjustments. If the line item is based on net pricing\n then the net price is returned. If the line item is based on gross\n pricing then the gross price is returned.", | |
"format": "double", | |
"type": "number" | |
}, | |
"price_adjustments": { | |
"description": "Array of price adjustments. Can be empty.", | |
"items": { | |
"$ref": "#/definitions/price_adjustment" | |
}, | |
"type": "array" | |
}, | |
"price_after_item_discount": { | |
"description": "The price of the product line item after applying all product-level\n adjustments. For net pricing the adjusted net price is returned. For gross pricing, the adjusted\n gross price is returned.", | |
"format": "double", | |
"type": "number" | |
}, | |
"price_after_order_discount": { | |
"description": "The price of this product line item after considering all\n dependent price adjustments and prorating all order-level\n price adjustments. For net pricing the net price is returned. For gross\n pricing, the gross price is returned.", | |
"format": "double", | |
"type": "number" | |
}, | |
"product_id": { | |
"description": "", | |
"maxLength": 100, | |
"type": "string" | |
}, | |
"product_list_item": { | |
"$ref": "#/definitions/product_list_item_reference", | |
"description": "" | |
}, | |
"product_name": { | |
"description": "The name of the product.", | |
"type": "string" | |
}, | |
"quantity": { | |
"description": "The quantity of the products represented by this item.", | |
"format": "double", | |
"maximum": 999.0, | |
"minimum": 0.0, | |
"type": "number" | |
}, | |
"shipment_id": { | |
"description": "The id of the shipment which includes the product item.", | |
"type": "string" | |
}, | |
"shipping_item_id": { | |
"description": "The reference to the related shipping item if it exists. This is the case if for example when a surcharge is\n defined for individual products using a particular a shipping method.", | |
"type": "string" | |
}, | |
"tax": { | |
"description": "The tax of the product item before adjustments applying.", | |
"format": "double", | |
"type": "number" | |
}, | |
"tax_basis": { | |
"description": "The price used to calculate the tax for this product item.", | |
"format": "double", | |
"type": "number" | |
}, | |
"tax_class_id": { | |
"description": "The tax class ID for the product item or null\n if no tax class ID is associated with the product item.", | |
"type": "string" | |
}, | |
"tax_rate": { | |
"description": "The tax rate, which is the decimal tax rate to be applied\n to the product represented by this item.", | |
"format": "double", | |
"type": "number" | |
} | |
}, | |
"required": [ | |
"quantity" | |
] | |
}, | |
"product_link": { | |
"description": "Document representing a link between two products. It contains the id of the source and target products, the type of\n product link, and URLs to retrieve product data.", | |
"properties": { | |
"source_product_id": { | |
"description": "The semantic id of the product from which this product link is coming.", | |
"type": "string" | |
}, | |
"source_product_link": { | |
"description": "The URL addressing the product from which this product link is coming.", | |
"type": "string" | |
}, | |
"target_product_id": { | |
"description": "The semantic id of the product to which this product link is pointing.", | |
"type": "string" | |
}, | |
"target_product_link": { | |
"description": "The URL addressing the product to which this product link is pointing.", | |
"type": "string" | |
}, | |
"type": { | |
"description": "The type of this product link.", | |
"enum": [ | |
"cross_sell", | |
"replacement", | |
"up_sell", | |
"accessory", | |
"newer_version", | |
"alt_orderunit", | |
"spare_part", | |
"other" | |
], | |
"type": "string" | |
} | |
} | |
}, | |
"product_list_event": { | |
"description": "Document representing a product list event.", | |
"properties": { | |
"city": { | |
"description": "The city where the event takes place.", | |
"type": "string" | |
}, | |
"country": { | |
"description": "The country where the event takes place.", | |
"type": "string" | |
}, | |
"date": { | |
"description": "The date when the event takes place.", | |
"format": "date-time", | |
"type": "string" | |
}, | |
"state": { | |
"description": "The federal state where the event takes place.", | |
"type": "string" | |
}, | |
"type": { | |
"description": "Type of the event to celebrate.", | |
"type": "string" | |
} | |
} | |
}, | |
"product_list_item_reference": { | |
"properties": { | |
"id": { | |
"description": "The id of the product list item.", | |
"type": "string" | |
}, | |
"priority": { | |
"format": "int32", | |
"type": "integer" | |
}, | |
"product_details_link": { | |
"$ref": "#/definitions/product_details_link" | |
}, | |
"product_list": { | |
"$ref": "#/definitions/product_list_link", | |
"description": "The link of the product list, the item is assigned" | |
}, | |
"public": { | |
"type": "boolean" | |
}, | |
"purchased_quantity": { | |
"format": "double", | |
"type": "number" | |
}, | |
"quantity": { | |
"format": "double", | |
"minimum": 0.0, | |
"type": "number" | |
}, | |
"type": { | |
"enum": [ | |
"product", | |
"gift_certificate" | |
], | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"id" | |
] | |
}, | |
"product_list_link": { | |
"description": "Document representing a link to a product list.", | |
"properties": { | |
"description": { | |
"description": "The description of this product list.", | |
"type": "string" | |
}, | |
"link": { | |
"description": "The target of the link.", | |
"type": "string" | |
}, | |
"name": { | |
"description": "The name of this product list.", | |
"type": "string" | |
}, | |
"public": { | |
"description": "A flag indicating whether the owner made this product list available for access\n by other customers.", | |
"type": "boolean" | |
}, | |
"title": { | |
"description": "The link title.", | |
"type": "string" | |
}, | |
"type": { | |
"description": "The type of the product list.", | |
"enum": [ | |
"wish_list", | |
"gift_registry", | |
"shopping_list", | |
"custom_1", | |
"custom_2", | |
"custom_3" | |
], | |
"type": "string" | |
} | |
} | |
}, | |
"product_list_registrant": { | |
"description": "\n Document representing a product list registrant.\n ", | |
"properties": { | |
"first_name": { | |
"description": "The first name of the registrant.", | |
"type": "string" | |
}, | |
"last_name": { | |
"description": "The last name of the registrant.", | |
"type": "string" | |
}, | |
"role": { | |
"description": "The role of the registrant.", | |
"type": "string" | |
} | |
} | |
}, | |
"product_list_shipping_address": { | |
"description": "Document representing a product list shipping address.", | |
"properties": { | |
"address_id": { | |
"description": "The id of this address.", | |
"minLength": 1, | |
"type": "string" | |
}, | |
"city": { | |
"description": "The city of this address.", | |
"type": "string" | |
}, | |
"first_name": { | |
"description": "The first name of this address.", | |
"type": "string" | |
}, | |
"last_name": { | |
"description": "The last name of this address.", | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"address_id" | |
] | |
}, | |
"product_promotion": { | |
"description": "Document representing a product promotion.", | |
"properties": { | |
"callout_msg": { | |
"description": "The localized call-out message of the promotion.", | |
"x-label": { | |
"default": "callout message" | |
}, | |
"type": "string" | |
}, | |
"link": { | |
"description": "The URL addressing the promotion.", | |
"x-label": { | |
"default": "link" | |
}, | |
"type": "string" | |
}, | |
"promotion_id": { | |
"description": "The unique id of the promotion.", | |
"x-label": { | |
"default": "promotion id" | |
}, | |
"type": "string" | |
}, | |
"promotional_price": { | |
"description": "The promotional price for this product.", | |
"format": "double", | |
"x-label": { | |
"default": "promotional price" | |
}, | |
"type": "number" | |
} | |
} | |
}, | |
"product_ref": { | |
"description": "Document representing a product reference.", | |
"properties": { | |
"id": { | |
"description": "The ID of the product reference.", | |
"type": "string" | |
}, | |
"link": { | |
"description": "The link to the product reference.", | |
"maxLength": 100, | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"id", | |
"link" | |
] | |
}, | |
"product_result": { | |
"description": "Result document containing an array of products.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"description": "The array of product documents.", | |
"items": { | |
"$ref": "#/definitions/product" | |
}, | |
"type": "array" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"product_search_hit": { | |
"description": "Document representing a product search hit.", | |
"properties": { | |
"currency": { | |
"description": "The ISO 4217 mnemonic code of the currency.", | |
"type": "string" | |
}, | |
"hit_type": { | |
"description": "The type information for the search hit.", | |
"type": "string" | |
}, | |
"image": { | |
"$ref": "#/definitions/image", | |
"description": "The first image of the product hit for the configured viewtype.", | |
"x-label": { | |
"default": "Standard Image" | |
} | |
}, | |
"link": { | |
"description": "The URL addressing the product.", | |
"type": "string" | |
}, | |
"orderable": { | |
"description": "A flag indicating whether the product is orderable.", | |
"type": "boolean" | |
}, | |
"price": { | |
"description": "The sales price of the product. In case of complex products like master or set this is the minimum price of\n related child products.", | |
"format": "double", | |
"type": "number" | |
}, | |
"price_max": { | |
"description": "The maximum sales of related child products in case of complex products like master or set.", | |
"format": "double", | |
"type": "number" | |
}, | |
"price_per_unit": { | |
"description": "The sales price per unit of the product. In case of complex products like master or set this is the minimum price\n per unit of related child products.", | |
"format": "double", | |
"type": "number" | |
}, | |
"price_per_unit_max": { | |
"description": "The maximum sales price per unit of related child products in case of complex products like master or set.", | |
"format": "double", | |
"type": "number" | |
}, | |
"prices": { | |
"additionalProperties": { | |
"format": "double", | |
"type": "number" | |
}, | |
"description": "The prices map with price book ids and their values.", | |
"type": "object" | |
}, | |
"product_id": { | |
"description": "The id (SKU) of the product.", | |
"x-label": { | |
"default": "ID", | |
"en": "SKUAGE" | |
}, | |
"type": "string" | |
}, | |
"product_name": { | |
"description": "The localized name of the product.", | |
"x-label": { | |
"default": "Name" | |
}, | |
"type": "string" | |
}, | |
"product_type": { | |
"$ref": "#/definitions/product_type", | |
"description": "The type information for the product." | |
}, | |
"represented_product": { | |
"$ref": "#/definitions/product_ref", | |
"description": "The first represented product." | |
}, | |
"represented_products": { | |
"description": "All the represented products.", | |
"items": { | |
"$ref": "#/definitions/product_ref" | |
}, | |
"type": "array" | |
}, | |
"variation_attributes": { | |
"description": "The array of represented variation attributes (for the master product only). This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/variation_attribute" | |
}, | |
"type": "array" | |
} | |
} | |
}, | |
"product_search_refinement": { | |
"description": "Document representing a product search refinement attribute.", | |
"properties": { | |
"attribute_id": { | |
"description": "The id of the search refinement attribute. In the case of an attribute refinement, this is the attribute id.\n Custom attributes are marked by the prefix \"c_\" (for example, \"c_refinementColor\"). In the case of a\n category refinement, the id must be \"cgid\". In the case of a price refinement, the id must be \"price\".", | |
"type": "string" | |
}, | |
"label": { | |
"description": "The localized label of the refinement.", | |
"type": "string" | |
}, | |
"values": { | |
"description": "The sorted array of refinement values. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/product_search_refinement_value" | |
}, | |
"type": "array" | |
} | |
}, | |
"required": [ | |
"attribute_id" | |
] | |
}, | |
"product_search_refinement_value": { | |
"description": "Document representing a product search refinement value.", | |
"properties": { | |
"description": { | |
"description": "The localized description of the refinement value.", | |
"type": "string" | |
}, | |
"hit_count": { | |
"description": "The number of search hits when selecting the refinement value. Can be 0.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"label": { | |
"description": "The localized label of the refinement value.", | |
"type": "string" | |
}, | |
"presentation_id": { | |
"description": "The optional presentation id associated with the refinement value.\n The presentation id can be used, for example, to associate an id with\n an HTML widget.", | |
"type": "string" | |
}, | |
"value": { | |
"description": "The refinement value. In the case of an attribute refinement, this is the bucket,\n the attribute value, or a value range. In the case of a category refinement, this is the\n category id. In the case of a price refinement,k this is the price range. Ranges are\n enclosed by parentheses and separated by \"..\"; for example, \"(100..999)\" and \"(Aa..Fa)\"\n are valid ranges.", | |
"type": "string" | |
}, | |
"values": { | |
"description": "The array of hierarchical refinement values. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/product_search_refinement_value" | |
}, | |
"type": "array" | |
} | |
} | |
}, | |
"product_search_result": { | |
"description": "Document representing a product search result.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"items": { | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"fetch_date": { | |
"format": "int32", | |
"type": "integer" | |
}, | |
"hits": { | |
"description": "The sorted array of search hits. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/product_search_hit" | |
}, | |
"type": "array" | |
}, | |
"next": { | |
"description": "The URL of the next result page.", | |
"type": "string" | |
}, | |
"previous": { | |
"description": "The URL of the previous result page.", | |
"type": "string" | |
}, | |
"query": { | |
"description": "The query String that was searched for.", | |
"type": "string" | |
}, | |
"refinements": { | |
"description": "The sorted array of search refinements. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/product_search_refinement" | |
}, | |
"type": "array" | |
}, | |
"search_phrase_suggestions": { | |
"$ref": "#/definitions/suggestion", | |
"description": "The suggestion given by the system for the submitted search phrase." | |
}, | |
"selected_refinements": { | |
"additionalProperties": { | |
"type": "string" | |
}, | |
"description": "A map of selected refinement attribute id/value(s) pairs. The sorting order is the same as in request URL.", | |
"type": "object" | |
}, | |
"selected_sorting_option": { | |
"description": "The id of the applied sorting option.", | |
"type": "string" | |
}, | |
"sorting_options": { | |
"description": "The sorted array of search sorting options. This array can be empty.", | |
"items": { | |
"$ref": "#/definitions/product_search_sorting_option" | |
}, | |
"type": "array" | |
}, | |
"start": { | |
"description": "The zero-based index of the first search hit to include in the result.", | |
"format": "int32", | |
"minimum": 0, | |
"type": "integer" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"product_search_sorting_option": { | |
"description": "Document representing a product search sorting option.", | |
"properties": { | |
"id": { | |
"description": "The id of the sorting option.", | |
"type": "string" | |
}, | |
"label": { | |
"description": "The localized label of the sorting option.", | |
"type": "string" | |
} | |
} | |
}, | |
"product_simple_link": { | |
"description": "Document representing a link to a product.", | |
"properties": { | |
"link": { | |
"description": "The target of the link.", | |
"type": "string" | |
}, | |
"title": { | |
"description": "The link title.", | |
"type": "string" | |
} | |
} | |
}, | |
"product_type": { | |
"description": "Document representing a product type.", | |
"properties": { | |
"bundle": { | |
"description": "A flag indicating whether the product is a bundle.", | |
"type": "boolean" | |
}, | |
"item": { | |
"description": "A flag indicating whether the product is a standard item.", | |
"type": "boolean" | |
}, | |
"master": { | |
"description": "A flag indicating whether the product is a master.", | |
"type": "boolean" | |
}, | |
"option": { | |
"description": "A flag indicating whether the product is an option.", | |
"type": "boolean" | |
}, | |
"set": { | |
"description": "A flag indicating whether the product is a set.", | |
"type": "boolean" | |
}, | |
"variant": { | |
"description": "A flag indicating whether the product is a variant.", | |
"type": "boolean" | |
}, | |
"variation_group": { | |
"description": "A flag indicating whether the product is a variation group.", | |
"type": "boolean" | |
} | |
} | |
}, | |
"promotion": { | |
"description": "Document representing a promotion.", | |
"properties": { | |
"c_additionalCalloutMsg": { | |
"description": "The message is displayed before the coupon is added to the cart.", | |
"x-label": { | |
"default": "Additional Callout Message" | |
}, | |
"type": "string" | |
}, | |
"c_excludeColors": { | |
"description": "Example Format : Black|Red|Green and values should be exact match of \"color\" product attribute", | |
"format": "text", | |
"x-label": { | |
"default": "Exclude colors" | |
}, | |
"type": "string" | |
}, | |
"c_gccLastSubmitted": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Sent for translation on" | |
}, | |
"type": "string" | |
}, | |
"c_gccLastTranslated": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Translations imported on" | |
}, | |
"type": "string" | |
}, | |
"c_gccStatus": { | |
"description": "This attribute is used by GCC.", | |
"enum": [ | |
"Ready", | |
"Sent", | |
"Imported" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Ready to Send" | |
}, | |
{ | |
"default": "In Progress" | |
}, | |
{ | |
"default": "Translated" | |
} | |
], | |
"x-label": { | |
"default": "GlobalLink Status" | |
}, | |
"type": "string" | |
}, | |
"c_gccSubmissionName": { | |
"description": "This attribute is used to store the gccSubmissionName information locale-specific.", | |
"x-label": { | |
"default": "GCC Submission Name" | |
}, | |
"type": "string" | |
}, | |
"c_geDiscountType": { | |
"description": "Please help Global-e to identify the Promotion Discount Type properly.\r\nIt helps to calculate Promotional Price properly on Storefront.", | |
"enum": [ | |
"AMOUNT", | |
"BONUS", | |
"BONUS_CHOICE", | |
"FIXED_PRICE", | |
"FREE", | |
"PERCENTAGE", | |
"PRICE_BOOK_PRICE", | |
"TOTAL_FIXED_PRICE" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "TYPE_AMOUNT" | |
}, | |
{ | |
"default": "TYPE_BONUS" | |
}, | |
{ | |
"default": "TYPE_BONUS_CHOICE" | |
}, | |
{ | |
"default": "TYPE_FIXED_PRICE" | |
}, | |
{ | |
"default": "TYPE_FREE" | |
}, | |
{ | |
"default": "TYPE_PERCENTAGE" | |
}, | |
{ | |
"default": "TYPE_PRICEBOOK_PRICE" | |
}, | |
{ | |
"default": "TYPE_TOTAL_FIXED_PRICE" | |
} | |
], | |
"x-label": { | |
"default": "Promotion Discount Type" | |
}, | |
"type": "string" | |
}, | |
"c_geDoNotConvert": { | |
"description": "For example: \"get -10 off\" - will do -10 off on end-customer Price.\r\nApplicable only for the following Promotion Discount Types: AMOUNT, FIXED_PRICE, PRICE_BOOK_PRICE, TOTAL_FIXED_PRICE.", | |
"x-label": { | |
"default": "Do not Convert Promotional Discount" | |
}, | |
"type": "boolean" | |
}, | |
"c_geLoyaltyPromotion": { | |
"description": "If it is Global-e Loyalty Promotion - then Global-e cartridge will treat this Promotion as special promotion in SendCart API.", | |
"x-label": { | |
"default": "Global-e Loyalty Promotion" | |
}, | |
"type": "boolean" | |
}, | |
"c_gePromotion": { | |
"description": "Is applicable to Global-e:\r\nANY\r\nFIXED_PRICES_ONLY\r\nDYNAMIC_PRICES_ONLY\r\nSHIPPING", | |
"enum": [ | |
"ANY", | |
"FIXED_PRICE", | |
"DYNAMIC_PRICE" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Dynamic and/or Fixed Price Countries" | |
}, | |
{ | |
"default": "Fixed Price Country Only" | |
}, | |
{ | |
"default": "Dynamic Price Country Only" | |
} | |
], | |
"x-label": { | |
"default": "Is applicable to Global-e" | |
}, | |
"type": "string" | |
}, | |
"c_isChoiceOfBonusProductsPromotion": { | |
"description": "Used in the storefront to to check if the promotion is choice of bonus product promotion", | |
"x-label": { | |
"default": "Is Choice of bonus product promotion" | |
}, | |
"type": "boolean" | |
}, | |
"c_noPopupForGWP": { | |
"description": "Used in the storefront to to check if the promotion should not show the GWP popup", | |
"x-label": { | |
"default": "No Pop Up Needed for this GWP" | |
}, | |
"type": "boolean" | |
}, | |
"c_omsCalloutMsg": { | |
"format": "text", | |
"x-label": { | |
"default": "OMS Callout Message" | |
}, | |
"type": "string" | |
}, | |
"callout_msg": { | |
"description": "The localized call-out message of the promotion.", | |
"format": "html", | |
"x-label": { | |
"default": "Callout Message" | |
}, | |
"type": "string" | |
}, | |
"currency": { | |
"description": "The currency that a promotion can be applied to. A null value means that the promotion applies to all allowed\n currencies.", | |
"type": "string" | |
}, | |
"details": { | |
"description": "The localized detailed description of the promotion.", | |
"format": "html", | |
"x-label": { | |
"default": "Promotion Details" | |
}, | |
"type": "string" | |
}, | |
"discounted_products_link": { | |
"description": "An optional product search link. Product promotions that are marked searchable provide a product search link with the promotion id as\n refinement.", | |
"type": "string" | |
}, | |
"end_date": { | |
"description": "The end date of the promotion. This property follows the ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ . The time\n zone of the date time is always UTC.", | |
"format": "date-time", | |
"type": "string" | |
}, | |
"id": { | |
"description": "The unique id of the promotion.", | |
"x-label": { | |
"default": "ID" | |
}, | |
"type": "string" | |
}, | |
"image": { | |
"description": "The URL to the promotion image.", | |
"x-label": { | |
"default": "Image" | |
}, | |
"type": "string" | |
}, | |
"name": { | |
"description": "The localized name of the promotion.", | |
"x-label": { | |
"default": "Name" | |
}, | |
"type": "string" | |
}, | |
"start_date": { | |
"description": "The start date of the promotion. This property follows the ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ. The\n time zone of the date time is always UTC.", | |
"format": "date-time", | |
"type": "string" | |
} | |
} | |
}, | |
"promotion_link": { | |
"description": "Document representing a promotion link.", | |
"properties": { | |
"c_additionalCalloutMsg": { | |
"description": "The message is displayed before the coupon is added to the cart.", | |
"x-label": { | |
"default": "Additional Callout Message" | |
}, | |
"type": "string" | |
}, | |
"c_excludeColors": { | |
"description": "Example Format : Black|Red|Green and values should be exact match of \"color\" product attribute", | |
"format": "text", | |
"x-label": { | |
"default": "Exclude colors" | |
}, | |
"type": "string" | |
}, | |
"c_gccLastSubmitted": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Sent for translation on" | |
}, | |
"type": "string" | |
}, | |
"c_gccLastTranslated": { | |
"format": "date-time", | |
"x-label": { | |
"default": "Translations imported on" | |
}, | |
"type": "string" | |
}, | |
"c_gccStatus": { | |
"description": "This attribute is used by GCC.", | |
"enum": [ | |
"Ready", | |
"Sent", | |
"Imported" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Ready to Send" | |
}, | |
{ | |
"default": "In Progress" | |
}, | |
{ | |
"default": "Translated" | |
} | |
], | |
"x-label": { | |
"default": "GlobalLink Status" | |
}, | |
"type": "string" | |
}, | |
"c_gccSubmissionName": { | |
"description": "This attribute is used to store the gccSubmissionName information locale-specific.", | |
"x-label": { | |
"default": "GCC Submission Name" | |
}, | |
"type": "string" | |
}, | |
"c_geDiscountType": { | |
"description": "Please help Global-e to identify the Promotion Discount Type properly.\r\nIt helps to calculate Promotional Price properly on Storefront.", | |
"enum": [ | |
"AMOUNT", | |
"BONUS", | |
"BONUS_CHOICE", | |
"FIXED_PRICE", | |
"FREE", | |
"PERCENTAGE", | |
"PRICE_BOOK_PRICE", | |
"TOTAL_FIXED_PRICE" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "TYPE_AMOUNT" | |
}, | |
{ | |
"default": "TYPE_BONUS" | |
}, | |
{ | |
"default": "TYPE_BONUS_CHOICE" | |
}, | |
{ | |
"default": "TYPE_FIXED_PRICE" | |
}, | |
{ | |
"default": "TYPE_FREE" | |
}, | |
{ | |
"default": "TYPE_PERCENTAGE" | |
}, | |
{ | |
"default": "TYPE_PRICEBOOK_PRICE" | |
}, | |
{ | |
"default": "TYPE_TOTAL_FIXED_PRICE" | |
} | |
], | |
"x-label": { | |
"default": "Promotion Discount Type" | |
}, | |
"type": "string" | |
}, | |
"c_geDoNotConvert": { | |
"description": "For example: \"get -10 off\" - will do -10 off on end-customer Price.\r\nApplicable only for the following Promotion Discount Types: AMOUNT, FIXED_PRICE, PRICE_BOOK_PRICE, TOTAL_FIXED_PRICE.", | |
"x-label": { | |
"default": "Do not Convert Promotional Discount" | |
}, | |
"type": "boolean" | |
}, | |
"c_geLoyaltyPromotion": { | |
"description": "If it is Global-e Loyalty Promotion - then Global-e cartridge will treat this Promotion as special promotion in SendCart API.", | |
"x-label": { | |
"default": "Global-e Loyalty Promotion" | |
}, | |
"type": "boolean" | |
}, | |
"c_gePromotion": { | |
"description": "Is applicable to Global-e:\r\nANY\r\nFIXED_PRICES_ONLY\r\nDYNAMIC_PRICES_ONLY\r\nSHIPPING", | |
"enum": [ | |
"ANY", | |
"FIXED_PRICE", | |
"DYNAMIC_PRICE" | |
], | |
"x-enum-labels": [ | |
{ | |
"default": "Dynamic and/or Fixed Price Countries" | |
}, | |
{ | |
"default": "Fixed Price Country Only" | |
}, | |
{ | |
"default": "Dynamic Price Country Only" | |
} | |
], | |
"x-label": { | |
"default": "Is applicable to Global-e" | |
}, | |
"type": "string" | |
}, | |
"c_isChoiceOfBonusProductsPromotion": { | |
"description": "Used in the storefront to to check if the promotion is choice of bonus product promotion", | |
"x-label": { | |
"default": "Is Choice of bonus product promotion" | |
}, | |
"type": "boolean" | |
}, | |
"c_noPopupForGWP": { | |
"description": "Used in the storefront to to check if the promotion should not show the GWP popup", | |
"x-label": { | |
"default": "No Pop Up Needed for this GWP" | |
}, | |
"type": "boolean" | |
}, | |
"c_omsCalloutMsg": { | |
"format": "text", | |
"x-label": { | |
"default": "OMS Callout Message" | |
}, | |
"type": "string" | |
}, | |
"callout_msg": { | |
"description": "The localized call-out message of the promotion.", | |
"format": "html", | |
"x-label": { | |
"default": "Callout Message" | |
}, | |
"type": "string" | |
}, | |
"link": { | |
"type": "string" | |
}, | |
"name": { | |
"description": "The localized name of the promotion.", | |
"x-label": { | |
"default": "Name" | |
}, | |
"type": "string" | |
}, | |
"promotion_id": { | |
"description": "The unique id of the promotion.", | |
"x-label": { | |
"default": "ID" | |
}, | |
"type": "string" | |
}, | |
"title": { | |
"type": "string" | |
} | |
} | |
}, | |
"promotion_result": { | |
"description": "Result document containing an array of promotions.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"description": "The array of promotion documents.", | |
"items": { | |
"$ref": "#/definitions/promotion" | |
}, | |
"type": "array" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"public_product_list": { | |
"properties": { | |
"co_registrant": { | |
"$ref": "#/definitions/product_list_registrant", | |
"description": "The coRegistrant of this product list." | |
}, | |
"creation_date": { | |
"description": "Returns the value of attribute 'creationDate'.", | |
"format": "date-time", | |
"type": "string" | |
}, | |
"description": { | |
"description": "The description of this product list.", | |
"type": "string" | |
}, | |
"event": { | |
"$ref": "#/definitions/product_list_event", | |
"description": "The event of this product list." | |
}, | |
"id": { | |
"description": "The id of this product list.", | |
"minLength": 1, | |
"type": "string" | |
}, | |
"items_link": { | |
"$ref": "#/definitions/product_simple_link", | |
"description": "The resource link to the items of this product list." | |
}, | |
"last_modified": { | |
"description": "Returns the value of attribute 'lastModified'.", | |
"format": "date-time", | |
"type": "string" | |
}, | |
"name": { | |
"description": "The name of this product list.", | |
"type": "string" | |
}, | |
"product_list_items": { | |
"description": "The product list items", | |
"items": { | |
"$ref": "#/definitions/public_product_list_item" | |
}, | |
"type": "array" | |
}, | |
"product_list_shipping_address": { | |
"$ref": "#/definitions/product_list_shipping_address", | |
"description": "The abbreviated shipping address of this product list representing what anonymous user can see." | |
}, | |
"public": { | |
"description": "Indicates whether the owner made this product list available for access by other customers.", | |
"type": "boolean" | |
}, | |
"registrant": { | |
"$ref": "#/definitions/product_list_registrant", | |
"description": "The registrant of this product list." | |
}, | |
"type": { | |
"description": "The type of the product list.", | |
"enum": [ | |
"wish_list", | |
"gift_registry", | |
"shopping_list", | |
"custom_1", | |
"custom_2", | |
"custom_3" | |
], | |
"type": "string" | |
} | |
} | |
}, | |
"public_product_list_item": { | |
"description": "Document representing a product list item.", | |
"properties": { | |
"id": { | |
"description": "The id of this product list item.", | |
"type": "string" | |
}, | |
"priority": { | |
"description": "The priority of the item.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"product": { | |
"$ref": "#/definitions/product", | |
"description": "The product item" | |
}, | |
"product_details_link": { | |
"$ref": "#/definitions/product_simple_link", | |
"description": "A link to the product." | |
}, | |
"type": { | |
"description": "The type of the item.", | |
"enum": [ | |
"product", | |
"gift_certificate" | |
], | |
"type": "string" | |
} | |
} | |
}, | |
"public_product_list_item_result": { | |
"description": "Result document containing an array of product list items.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"description": "The array of product list item documents.", | |
"items": { | |
"$ref": "#/definitions/public_product_list_item" | |
}, | |
"type": "array" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"public_product_list_link": { | |
"description": "Document representing a link to a public product list.", | |
"properties": { | |
"description": { | |
"description": "The description of this product list.", | |
"type": "string" | |
}, | |
"link": { | |
"description": "The target of the link.", | |
"type": "string" | |
}, | |
"name": { | |
"description": "The name of this product list.", | |
"type": "string" | |
}, | |
"title": { | |
"description": "The link title.", | |
"type": "string" | |
}, | |
"type": { | |
"description": "The type of the product list.", | |
"enum": [ | |
"wish_list", | |
"gift_registry", | |
"shopping_list", | |
"custom_1", | |
"custom_2", | |
"custom_3" | |
], | |
"type": "string" | |
} | |
} | |
}, | |
"public_product_list_result": { | |
"description": "Result document containing an array of public product list links.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"data": { | |
"description": "The array of product list link documents.", | |
"items": { | |
"$ref": "#/definitions/public_product_list_link" | |
}, | |
"type": "array" | |
}, | |
"total": { | |
"description": "The total number of documents.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"query": { | |
"description": "Document representing a query. A query contains a set of objects that define criteria\n used to select records. A query can contain one of the following:\n" | |
}, | |
"query_filter": { | |
"description": "Document representing a query filter. A query filter wraps any query and allows it to be used as a filter.\n ", | |
"properties": { | |
"query": { | |
"$ref": "#/definitions/query", | |
"description": "The query to use as a filter.", | |
"x-sub_types": { | |
"nested_query": "#/definitions/nested_query", | |
"filtered_query": "#/definitions/filtered_query", | |
"text_query": "#/definitions/text_query", | |
"match_all_query": "#/definitions/match_all_query", | |
"term_query": "#/definitions/term_query", | |
"bool_query": "#/definitions/bool_query" | |
} | |
} | |
}, | |
"required": [ | |
"query" | |
] | |
}, | |
"range2_filter": { | |
"description": "Document representing a range compare with range filter, named Range2Filter.", | |
"properties": { | |
"filter_mode": { | |
"description": "Compare mode: overlap, containing, or contained. If not specified, the default is overlap.", | |
"enum": [ | |
"overlap", | |
"containing", | |
"contained" | |
], | |
"type": "string" | |
}, | |
"from_field": { | |
"description": "The field name of the field that starts the first range.", | |
"type": "string" | |
}, | |
"from_inclusive": { | |
"description": "Indicates whether the lower bound of the second range is inclusive. If not specified, the default is true. Set to false to make the lower bound exclusive.", | |
"type": "boolean" | |
}, | |
"from_value": { | |
"description": "The lower bound of the second range. If not specified, the range is open-ended with respect to the lower bound. You can't leave both the lower and upper bounds open-ended.", | |
"type": "object" | |
}, | |
"to_field": { | |
"description": "The field name of the field that ends the first range.", | |
"type": "string" | |
}, | |
"to_inclusive": { | |
"description": "Indicates whether the upper bound of the second range is inclusive. If not specified, the default is true. Set to false to make the lower bound exclusive.", | |
"type": "boolean" | |
}, | |
"to_value": { | |
"description": "The upper bound of the second range. If not specified, the range is open-ended with respect to the upper bound. You can't leave both the upper and lower bounds open-ended.", | |
"type": "object" | |
} | |
}, | |
"required": [ | |
"from_field", | |
"to_field" | |
] | |
}, | |
"range_filter": { | |
"description": "Document representing a range filter.\n ", | |
"properties": { | |
"field": { | |
"description": "The search field.", | |
"type": "string" | |
}, | |
"from": { | |
"description": "The lower bound of the filter range. If not specified, the range is open-ended with respect to the lower bound. You can't leave both the lower and upper bounds open-ended.", | |
"type": "object" | |
}, | |
"from_inclusive": { | |
"description": "Indicates whether the lower bound of the range is inclusive. If not specified, the default is true. Set to false to make the lower bound exclusive.", | |
"type": "boolean" | |
}, | |
"to": { | |
"description": "The upper bound of the filter range. If not specified, the range is open-ended with respect to the upper bound. You can't leave both the upper and lower bounds open-ended.", | |
"type": "object" | |
}, | |
"to_inclusive": { | |
"description": "Indicates whether the upper bound of the range is inclusive. If not specified, the default is true. Set to false to made the upper bound exclusive.", | |
"type": "boolean" | |
} | |
}, | |
"required": [ | |
"field" | |
] | |
}, | |
"recommendation": { | |
"description": "Document representing a product recommendation.", | |
"properties": { | |
"callout_msg": { | |
"description": "The localized callout message of the recommendation.", | |
"format": "html", | |
"x-label": { | |
"default": "Callout Message" | |
}, | |
"type": "string" | |
}, | |
"image": { | |
"$ref": "#/definitions/image", | |
"description": "The image of the recommendation.", | |
"x-label": { | |
"default": "Standard Image" | |
} | |
}, | |
"long_description": { | |
"description": "The localized long description of the recommendation.", | |
"format": "html", | |
"x-label": { | |
"default": "Long Description" | |
}, | |
"type": "string" | |
}, | |
"name": { | |
"description": "The localized name of the recommendation.", | |
"x-label": { | |
"default": "Name" | |
}, | |
"type": "string" | |
}, | |
"recommendation_type": { | |
"$ref": "#/definitions/recommendation_type", | |
"description": "The recommendation type of the recommendation.", | |
"x-label": { | |
"default": "Recommendation Type" | |
} | |
}, | |
"recommended_item_id": { | |
"description": "The recommended item id of the recommendation.", | |
"type": "string" | |
}, | |
"recommended_item_link": { | |
"description": "The recommended item link of the recommendation.", | |
"type": "string" | |
}, | |
"short_description": { | |
"description": "The localized short description of the recommendation.", | |
"format": "html", | |
"x-label": { | |
"default": "Short Description" | |
}, | |
"type": "string" | |
} | |
} | |
}, | |
"recommendation_type": { | |
"description": "Document representing a recommendation type.", | |
"properties": { | |
"display_value": { | |
"description": "The localized display value of the recommendation type.", | |
"type": "string" | |
}, | |
"value": { | |
"description": "The value of the recommendation type.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"reset_password_request": { | |
"properties": { | |
"login": { | |
"description": "The login id of the customer.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"new_password": { | |
"description": "The new password for the customer.", | |
"maxLength": 4096, | |
"type": "string" | |
}, | |
"reset_token": { | |
"description": "The password reset token for the customer.", | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"new_password" | |
] | |
}, | |
"reset_password_token_request": { | |
"properties": { | |
"login": { | |
"description": "The login id of the customer.", | |
"maxLength": 256, | |
"type": "string" | |
} | |
} | |
}, | |
"reset_password_token_result": { | |
"properties": { | |
"email": { | |
"description": "The email address of the customer.", | |
"type": "string" | |
}, | |
"expires_in_minutes": { | |
"description": "The password reset token expire time in minutes.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"login": { | |
"description": "The login id of the customer.", | |
"maxLength": 256, | |
"type": "string" | |
}, | |
"reset_token": { | |
"description": "The password reset token for the customer.", | |
"type": "string" | |
} | |
} | |
}, | |
"result_page": { | |
"description": "Data that can be used to get the next and previous page of a Data API results object.", | |
"properties": { | |
"count": { | |
"description": "The number of returned documents.", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"db_start_record_": { | |
"description": "The zero-based index of the record that we want to start with, used to optimize special handling", | |
"format": "int32", | |
"type": "integer" | |
}, | |
"start": { | |
"description": "The zero-based index of the first search hit to include in the result.", | |
"format": "int32", | |
"type": "integer" | |
} | |
} | |
}, | |
"shipment": { | |
"description": "Document representing a shipment.", | |
"properties": { | |
"adjusted_merchandize_total_tax": { | |
"description": "The products tax after discounts applying in purchase currency. Adjusted merchandize prices represent the sum of\n product prices before services such as shipping have been added, but after adjustment from promotions have been\n added.\n\n Note that order level adjustments are considered if Discount Taxation preference is set to\n \"Tax Products and Shipping Only Based on Adjusted Price\".", | |
"format": "double", | |
"type": "number" | |
}, | |
"adjusted_shipping_total_tax": { | |
"description": "The tax of all shipping line items of the line item container after shipping adjustments have been applied.", | |
"format": "double", | |
"type": "number" | |
}, | |
"c_deliveryCode": { | |
"x-label": { | |
"default": "Delivery Code" | |
}, | |
"type": "string" | |
}, | |
"c_deliveryDate": { | |
"x-label": { | |
"default": "Delivery Date" | |
}, | |
"type": "string" | |
}, | |
"c_deliveryTimeCode": { | |
"description": "Time interval code, e.g. \"1\", customer chose for Sagaway scheduled\n delivery.\n ", | |
"x-label": { | |
"default": "Delivery Time Code" | |
}, | |
"type": "string" | |
}, | |
"c_deliveryTimeDisplayText": { | |
"description": "Time interval display text, e.g. \"8:00 to 12:00\", customer chose for\n Sagaway scheduled delivery.\n ", | |
"x-label": { | |
"default": "Delivery Time Display Text" | |
}, | |
"type": "string" | |
}, | |
"c_edgeCarrierServiceCode": { | |
"x-label": { | |
"default": "Edge Carrier Service Code" | |
}, | |
"type": "string" | |
}, | |
"c_fromStoreId": { | |
"description": "Used to map the shipment to a brick and mortar store.", | |
"x-label": { | |
"default": "Pickup Store ID" | |
}, | |
"type": "string" | |
}, | |
"c_isPOPStationShipping": { | |
"x-label": { | |
"default": "POPStation Shipping " | |
}, | |
"type": "boolean" | |
}, | |
"c_message": { | |
"description": "Shipment Message from Arvato", | |
"x-label": { | |
"default": "Message" | |
}, | |
"type": "string" | |
}, | |
"c_narvarSMSNotification": { | |
"type": "boolean" | |
}, | |
"c_popStationKioskId": { |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment