This event will be called if approval check from webhook is enabled from admin's approval setting page.
Root Schema : checkOrderApprovalWebhook_request
Type: object
This event will be called if approval check from webhook is enabled from admin's approval setting page.
Show Source
{
"description":"This event will be called if approval check from webhook is enabled from admin's approval setting page.",
"properties":{
"request":{
"type":"object",
"properties":{
"shippingGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
},
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
},
"shippingGroupId":{
"description":"The shipping Group id",
"type":"string",
"example":"sg1234"
},
"store":{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
},
"type":{
"description":"the shippingGroup type",
"type":"string",
"example":"inStorePickupShippingGroup"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"1231231234"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":0
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"integer",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"integer",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"salePrice":{
"description":"The sale price",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
},
"secondaryCurrencyCode":{
"description":"Secondary currencyCode",
"type":"string"
},
"creationTime":{
"description":"The creation time of the order.",
"type":"number"
},
"orderId":{
"description":"The ID of the order.",
"type":"string"
},
"creationSiteId":{
"description":"The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.",
"type":"string"
},
"dynamicProperties":{
"description":"the value of the dynamic Properties",
"type":"array",
"items":{
"type":"object"
}
},
"isItemPriceOverrideAllowed":{
"type":"boolean"
},
"profile":{
"type":"object",
"properties":{
"favoriteStores":{
"type":"array",
"items":{
"type":"object"
}
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"catalog":{
"description":"This is a read only attribute added for 'Account Based Commerce', this is the ID of the catalog that is associated with the organization to which this user is associated",
"type":"string"
},
"allowPartialShipment":{
"type":"boolean"
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"securityStatus":{
"type":"integer"
},
"parentOrganization":{
"description":"This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type":"object",
"properties":{
"name":{
"description":"the name of the parent organization",
"type":"string"
},
"repositoryId":{
"description":"the id of the parent organization",
"type":"string"
},
"description":{
"description":"Description of the Organization",
"type":"string"
},
"active":{
"description":"the status of the parent organization. Should be true or false",
"type":"boolean"
},
"shippingAddress":{
"description":"Default shipping address of the organization",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"id":{
"description":"the id of the parent organization",
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the organization",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
}
},
"shippingSurchargePriceList":{
"description":"The shipping surcharge price list for this user",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
}
}
},
"purchaseLists":{
"type":"array",
"items":{
"type":"object"
}
},
"profileType":{
"description":"This attribute is added for account based commerce, It's value is 'b2b_user'",
"type":"string"
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
},
"lastPurchaseAmount":{
"type":"integer"
},
"registrationDate":{
"type":"string"
},
"sessionOrganization":{
"type":"object",
"items":{
"type":"object",
"properties":{
"id":{
"description":"get the organization id",
"type":"string"
}
}
}
},
"lifetimeAOV":{
"type":"integer"
},
"id":{
"description":"get the shopper profile with id",
"type":"string"
},
"ancestors":{
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"get the ancestor's organization id",
"type":"string"
}
}
}
},
"derivedSalePriceList":{
"description":"The derived sale price list from the user's parent organization",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
}
}
},
"homeAddress":{
"description":"Home address which is set on the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"customerContactId":{
"description":"The external customer contact id",
"type":"string"
},
"taxExempt":{
"description":"Indicates tax exemption status.True or False",
"type":"boolean"
},
"contract":{
"type":"object"
},
"active":{
"description":"the user status of the profile. Should be true or false",
"type":"boolean"
},
"abandonedOrderCount":{
"type":"integer"
},
"firstName":{
"description":"the first name of the profile",
"type":"string"
},
"emailStatus":{
"type":"string"
},
"derivedApprovalRequired":{
"description":"Profile level approval required enable/disable",
"type":"boolean"
},
"expressCheckout":{
"type":"boolean"
},
"currentOrganization":{
"type":"object",
"items":{
"type":"object",
"properties":{
"id":{
"description":"get the current organization id",
"type":"string"
}
}
}
},
"secondaryOrganizations":{
"description":"List of secondary organizations associated to profile. It will be empty always. Secondary Organizations associated to the profile can be fetched using organization endpoints",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
},
"name":{
"description":"the name of the organization",
"type":"string"
},
"description":{
"description":"Description of the organization",
"type":"string"
},
"active":{
"description":"the status of the organization. Should be true or false",
"type":"boolean"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
}
}
},
"shippingAddresses":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"derivedPriceListGroup":{
"type":"object"
},
"lastName":{
"description":"the last name of the profile",
"type":"string"
},
"gender":{
"type":"string"
},
"roles":{
"description":"List of user roles.",
"type":"array",
"items":{
"type":"object",
"properties":{
"function":{
"description":"Function of the role which can be admin or buyer.",
"type":"string"
},
"relativeTo":{
"description":"organization ID of the role",
"type":"object",
"properties":{
"id":{
"description":"Organization ID of the role to be assigned",
"type":"string"
}
}
},
"repositoryId":{
"description":"Repository id of the role.",
"type":"string"
}
}
}
},
"approvers":{
"type":"array",
"items":{
"type":"object"
}
},
"numberOfOrders":{
"type":"integer"
},
"login":{
"description":"login of the user",
"type":"string"
},
"priceList":{
"type":"object"
},
"derivedBillingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"lifetimeSpend":{
"type":"integer"
},
"member":{
"type":"boolean"
},
"derivedCatalog":{
"type":"object"
},
"salePriceList":{
"type":"object"
},
"activePromotions":{
"type":"array",
"items":{
"type":"object"
}
},
"email":{
"description":"the email address of the profile",
"type":"string"
},
"siteProperties":{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"site":{
"description":"The site data",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string"
}
}
}
}
},
"comments":{
"type":"array",
"items":{
"type":"string"
}
},
"receiveEmail":{
"description":"this is site specific email marketing flag. can be yes or no",
"type":"string"
},
"priceListGroup":{
"description":"The associated price list group for this user",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
}
}
},
"allSecondaryAddresses":{
"description":"List of all shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"allApprovers":{
"description":"list of all the approvers",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the apporver",
"type":"string"
},
"firstName":{
"description":"the first name of the approver",
"type":"string"
},
"middleName":{
"description":"the middle name of the approver",
"type":"string"
}
}
}
},
"currentLocation":{
"type":"string"
},
"derivedShippingAddress":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"abandonedOrders":{
"type":"array",
"items":{
"type":"object"
}
},
"derivedPriceList":{
"type":"object"
}
}
},
"orderStatus":{
"description":"The order status.",
"type":"string"
},
"cartName":{
"description":"Cart name for this order.",
"type":"string"
},
"creationDate":{
"description":"The order creation date.",
"type":"string"
},
"locale":{
"description":"the locale of the request/response",
"type":"string"
},
"orderProfileId":{
"description":"The profile id on the order.",
"type":"string"
},
"priceInfo":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" The secondary currency tax amount.",
"type":"number"
},
"amount":{
"type":"number"
},
"total":{
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":" The secondary currency shipping amount.",
"type":"number"
},
"shipping":{
"type":"number"
},
"secondaryCurrencyTotal":{
"description":" The secondary currency total amount.",
"type":"number"
},
"primaryCurrencyTotal":{
"description":" The primary currency total amount.",
"type":"number"
},
"shippingSurchargeValue":{
"type":"number"
},
"tax":{
"type":"number"
},
"subTotal":{
"type":"number"
},
"currencyCode":{
"type":"string"
},
"totalWithoutTax":{
"type":"number"
}
}
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The list of all the coupons with the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"integer"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"integer"
}
}
},
"pricingMessages":{
"type":"object"
},
"exchangeRate":{
"description":"exchangeRate",
"type":"number"
},
"organization":{
"description":"The organization related property object",
"type":"object",
"properties":{
"taxReferenceNumber":{
"description":"Tax Reference Number of the Organization",
"type":"string"
},
"siteOrganizationProperties":{
"description":"Site Organization Properties",
"type":"object",
"properties":{
"site":{
"description":"Site information",
"type":"object",
"properties":{
"approvalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"contract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"delegateApprovalManagement":{
"description":"This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.",
"type":"boolean"
},
"useExternalApprovalWebhook":{
"description":"Flag to enable/disable Order Approval check from External Webhook",
"type":"boolean"
},
"orderPriceLimit":{
"description":"Its order limit value for the organization, if order limit is more than this value then approval is needed for the order",
"type":"number"
}
}
}
}
},
"childOrganizations":{
"type":"array",
"items":{
"type":"object"
}
},
"delegateApprovalManagement":{
"description":"This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.",
"type":"boolean"
},
"approvers":{
"type":"array",
"items":{
"type":"object"
}
},
"externalOrganizationId":{
"description":"External id of the organization.",
"type":"string"
},
"type":{
"description":"Type for Organization",
"type":"string"
},
"derivedBillingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"customerType":{
"description":"Customer Type for Organization",
"type":"string"
},
"derivedContract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"id":{
"description":"Id of the Organization",
"type":"string"
},
"dunsNumber":{
"description":"DUNS Number for Organization. Should be 9 digit number",
"type":"string"
},
"derivedTaxReferenceNumber":{
"description":"Derived taxReferenceNumber of the Organization",
"type":"string"
},
"derivedDunsNumber":{
"description":"Derived dunsNumber of the Organization",
"type":"string"
},
"contract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"derivedCustomerType":{
"description":"Derived customer type of the Organization",
"type":"string"
},
"active":{
"description":"Active status of an Organization. Should be true or false. By default the value is set to true",
"type":"boolean"
},
"allApprovers":{
"description":"list of all the approvers",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the apporver",
"type":"string"
},
"firstName":{
"description":"the first name of the approver",
"type":"string"
},
"middleName":{
"description":"the middle name of the approver",
"type":"string"
}
}
}
},
"derivedType":{
"description":"Derived type of the Organization",
"type":"string"
},
"derivedShippingAddress":{
"description":"The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.",
"type":"object",
"properties":{
"country":{
"description":"the country of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the company address",
"type":"string"
},
"address2":{
"description":"the address2 of the address",
"type":"string"
},
"city":{
"description":"the city of the address",
"type":"string"
},
"address1":{
"description":"the address1 of the address",
"type":"string"
},
"companyName":{
"description":"the company name shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the address",
"type":"string"
},
"state":{
"description":"the state of the address",
"type":"string"
}
}
},
"derivedApprovalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"approvalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"name":{
"description":"The name for Organization",
"type":"string"
},
"ancestorOrganizations":{
"description":"List of ancestors for the Organization",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the organization.",
"type":"string"
},
"name":{
"description":"Name of the organization.",
"type":"string"
},
"active":{
"description":"Active flag of the organization.",
"type":"boolean"
},
"id":{
"description":"Id of the organization.",
"type":"string"
}
}
}
},
"useExternalApprovalWebhook":{
"description":"Flag to enable/disable Order Approval check from External Webhook",
"type":"boolean"
},
"billingAddress":{
"description":"The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.",
"type":"object",
"properties":{
"country":{
"description":"the country of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the address",
"type":"string"
},
"address2":{
"description":"the address2 of the address",
"type":"string"
},
"city":{
"description":"the city of the address",
"type":"string"
},
"address1":{
"description":"the address1 of the address",
"type":"string"
},
"companyName":{
"description":"the company name of the address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the address",
"type":"string"
},
"state":{
"description":"the state of the address",
"type":"string"
}
}
},
"contacts":{
"type":"array",
"items":{
"type":"object"
}
}
}
},
"shoppingCart":{
"type":"object",
"properties":{
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"numberOfItems":{
"type":"integer"
},
"items":{
"description":"The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"type":"number"
},
"displayName":{
"type":"string"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"childItems":{
"description":"Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
}
}
}
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"listPrice":{
"type":"number"
}
}
}
}
}
},
"giftWithPurchaseInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"number"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the order was placed.",
"type":"string"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"giftWithPurchaseOrderMarkers":{
"type":"array",
"items":{
"type":"object"
}
}
}
}
}
}
Nested Schema : request
Type: object
Show Source
{
"type":"object",
"properties":{
"shippingGroups":{
"type":"array",
"items":{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
},
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
},
"shippingGroupId":{
"description":"The shipping Group id",
"type":"string",
"example":"sg1234"
},
"store":{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
},
"type":{
"description":"the shippingGroup type",
"type":"string",
"example":"inStorePickupShippingGroup"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"1231231234"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":0
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"integer",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"integer",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"salePrice":{
"description":"The sale price",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
},
"secondaryCurrencyCode":{
"description":"Secondary currencyCode",
"type":"string"
},
"creationTime":{
"description":"The creation time of the order.",
"type":"number"
},
"orderId":{
"description":"The ID of the order.",
"type":"string"
},
"creationSiteId":{
"description":"The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.",
"type":"string"
},
"dynamicProperties":{
"description":"the value of the dynamic Properties",
"type":"array",
"items":{
"type":"object"
}
},
"isItemPriceOverrideAllowed":{
"type":"boolean"
},
"profile":{
"type":"object",
"properties":{
"favoriteStores":{
"type":"array",
"items":{
"type":"object"
}
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"catalog":{
"description":"This is a read only attribute added for 'Account Based Commerce', this is the ID of the catalog that is associated with the organization to which this user is associated",
"type":"string"
},
"allowPartialShipment":{
"type":"boolean"
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"securityStatus":{
"type":"integer"
},
"parentOrganization":{
"description":"This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type":"object",
"properties":{
"name":{
"description":"the name of the parent organization",
"type":"string"
},
"repositoryId":{
"description":"the id of the parent organization",
"type":"string"
},
"description":{
"description":"Description of the Organization",
"type":"string"
},
"active":{
"description":"the status of the parent organization. Should be true or false",
"type":"boolean"
},
"shippingAddress":{
"description":"Default shipping address of the organization",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"id":{
"description":"the id of the parent organization",
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the organization",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
}
},
"shippingSurchargePriceList":{
"description":"The shipping surcharge price list for this user",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
}
}
},
"purchaseLists":{
"type":"array",
"items":{
"type":"object"
}
},
"profileType":{
"description":"This attribute is added for account based commerce, It's value is 'b2b_user'",
"type":"string"
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
},
"lastPurchaseAmount":{
"type":"integer"
},
"registrationDate":{
"type":"string"
},
"sessionOrganization":{
"type":"object",
"items":{
"type":"object",
"properties":{
"id":{
"description":"get the organization id",
"type":"string"
}
}
}
},
"lifetimeAOV":{
"type":"integer"
},
"id":{
"description":"get the shopper profile with id",
"type":"string"
},
"ancestors":{
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"get the ancestor's organization id",
"type":"string"
}
}
}
},
"derivedSalePriceList":{
"description":"The derived sale price list from the user's parent organization",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
}
}
},
"homeAddress":{
"description":"Home address which is set on the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"customerContactId":{
"description":"The external customer contact id",
"type":"string"
},
"taxExempt":{
"description":"Indicates tax exemption status.True or False",
"type":"boolean"
},
"contract":{
"type":"object"
},
"active":{
"description":"the user status of the profile. Should be true or false",
"type":"boolean"
},
"abandonedOrderCount":{
"type":"integer"
},
"firstName":{
"description":"the first name of the profile",
"type":"string"
},
"emailStatus":{
"type":"string"
},
"derivedApprovalRequired":{
"description":"Profile level approval required enable/disable",
"type":"boolean"
},
"expressCheckout":{
"type":"boolean"
},
"currentOrganization":{
"type":"object",
"items":{
"type":"object",
"properties":{
"id":{
"description":"get the current organization id",
"type":"string"
}
}
}
},
"secondaryOrganizations":{
"description":"List of secondary organizations associated to profile. It will be empty always. Secondary Organizations associated to the profile can be fetched using organization endpoints",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
},
"name":{
"description":"the name of the organization",
"type":"string"
},
"description":{
"description":"Description of the organization",
"type":"string"
},
"active":{
"description":"the status of the organization. Should be true or false",
"type":"boolean"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
}
}
},
"shippingAddresses":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"derivedPriceListGroup":{
"type":"object"
},
"lastName":{
"description":"the last name of the profile",
"type":"string"
},
"gender":{
"type":"string"
},
"roles":{
"description":"List of user roles.",
"type":"array",
"items":{
"type":"object",
"properties":{
"function":{
"description":"Function of the role which can be admin or buyer.",
"type":"string"
},
"relativeTo":{
"description":"organization ID of the role",
"type":"object",
"properties":{
"id":{
"description":"Organization ID of the role to be assigned",
"type":"string"
}
}
},
"repositoryId":{
"description":"Repository id of the role.",
"type":"string"
}
}
}
},
"approvers":{
"type":"array",
"items":{
"type":"object"
}
},
"numberOfOrders":{
"type":"integer"
},
"login":{
"description":"login of the user",
"type":"string"
},
"priceList":{
"type":"object"
},
"derivedBillingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"lifetimeSpend":{
"type":"integer"
},
"member":{
"type":"boolean"
},
"derivedCatalog":{
"type":"object"
},
"salePriceList":{
"type":"object"
},
"activePromotions":{
"type":"array",
"items":{
"type":"object"
}
},
"email":{
"description":"the email address of the profile",
"type":"string"
},
"siteProperties":{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"site":{
"description":"The site data",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string"
}
}
}
}
},
"comments":{
"type":"array",
"items":{
"type":"string"
}
},
"receiveEmail":{
"description":"this is site specific email marketing flag. can be yes or no",
"type":"string"
},
"priceListGroup":{
"description":"The associated price list group for this user",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
}
}
},
"allSecondaryAddresses":{
"description":"List of all shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"allApprovers":{
"description":"list of all the approvers",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the apporver",
"type":"string"
},
"firstName":{
"description":"the first name of the approver",
"type":"string"
},
"middleName":{
"description":"the middle name of the approver",
"type":"string"
}
}
}
},
"currentLocation":{
"type":"string"
},
"derivedShippingAddress":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"abandonedOrders":{
"type":"array",
"items":{
"type":"object"
}
},
"derivedPriceList":{
"type":"object"
}
}
},
"orderStatus":{
"description":"The order status.",
"type":"string"
},
"cartName":{
"description":"Cart name for this order.",
"type":"string"
},
"creationDate":{
"description":"The order creation date.",
"type":"string"
},
"locale":{
"description":"the locale of the request/response",
"type":"string"
},
"orderProfileId":{
"description":"The profile id on the order.",
"type":"string"
},
"priceInfo":{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" The secondary currency tax amount.",
"type":"number"
},
"amount":{
"type":"number"
},
"total":{
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":" The secondary currency shipping amount.",
"type":"number"
},
"shipping":{
"type":"number"
},
"secondaryCurrencyTotal":{
"description":" The secondary currency total amount.",
"type":"number"
},
"primaryCurrencyTotal":{
"description":" The primary currency total amount.",
"type":"number"
},
"shippingSurchargeValue":{
"type":"number"
},
"tax":{
"type":"number"
},
"subTotal":{
"type":"number"
},
"currencyCode":{
"type":"string"
},
"totalWithoutTax":{
"type":"number"
}
}
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The list of all the coupons with the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"integer"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"integer"
}
}
},
"pricingMessages":{
"type":"object"
},
"exchangeRate":{
"description":"exchangeRate",
"type":"number"
},
"organization":{
"description":"The organization related property object",
"type":"object",
"properties":{
"taxReferenceNumber":{
"description":"Tax Reference Number of the Organization",
"type":"string"
},
"siteOrganizationProperties":{
"description":"Site Organization Properties",
"type":"object",
"properties":{
"site":{
"description":"Site information",
"type":"object",
"properties":{
"approvalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"contract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"delegateApprovalManagement":{
"description":"This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.",
"type":"boolean"
},
"useExternalApprovalWebhook":{
"description":"Flag to enable/disable Order Approval check from External Webhook",
"type":"boolean"
},
"orderPriceLimit":{
"description":"Its order limit value for the organization, if order limit is more than this value then approval is needed for the order",
"type":"number"
}
}
}
}
},
"childOrganizations":{
"type":"array",
"items":{
"type":"object"
}
},
"delegateApprovalManagement":{
"description":"This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.",
"type":"boolean"
},
"approvers":{
"type":"array",
"items":{
"type":"object"
}
},
"externalOrganizationId":{
"description":"External id of the organization.",
"type":"string"
},
"type":{
"description":"Type for Organization",
"type":"string"
},
"derivedBillingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"customerType":{
"description":"Customer Type for Organization",
"type":"string"
},
"derivedContract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"id":{
"description":"Id of the Organization",
"type":"string"
},
"dunsNumber":{
"description":"DUNS Number for Organization. Should be 9 digit number",
"type":"string"
},
"derivedTaxReferenceNumber":{
"description":"Derived taxReferenceNumber of the Organization",
"type":"string"
},
"derivedDunsNumber":{
"description":"Derived dunsNumber of the Organization",
"type":"string"
},
"contract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"derivedCustomerType":{
"description":"Derived customer type of the Organization",
"type":"string"
},
"active":{
"description":"Active status of an Organization. Should be true or false. By default the value is set to true",
"type":"boolean"
},
"allApprovers":{
"description":"list of all the approvers",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the apporver",
"type":"string"
},
"firstName":{
"description":"the first name of the approver",
"type":"string"
},
"middleName":{
"description":"the middle name of the approver",
"type":"string"
}
}
}
},
"derivedType":{
"description":"Derived type of the Organization",
"type":"string"
},
"derivedShippingAddress":{
"description":"The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.",
"type":"object",
"properties":{
"country":{
"description":"the country of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the company address",
"type":"string"
},
"address2":{
"description":"the address2 of the address",
"type":"string"
},
"city":{
"description":"the city of the address",
"type":"string"
},
"address1":{
"description":"the address1 of the address",
"type":"string"
},
"companyName":{
"description":"the company name shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the address",
"type":"string"
},
"state":{
"description":"the state of the address",
"type":"string"
}
}
},
"derivedApprovalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"approvalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"name":{
"description":"The name for Organization",
"type":"string"
},
"ancestorOrganizations":{
"description":"List of ancestors for the Organization",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the organization.",
"type":"string"
},
"name":{
"description":"Name of the organization.",
"type":"string"
},
"active":{
"description":"Active flag of the organization.",
"type":"boolean"
},
"id":{
"description":"Id of the organization.",
"type":"string"
}
}
}
},
"useExternalApprovalWebhook":{
"description":"Flag to enable/disable Order Approval check from External Webhook",
"type":"boolean"
},
"billingAddress":{
"description":"The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.",
"type":"object",
"properties":{
"country":{
"description":"the country of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the address",
"type":"string"
},
"address2":{
"description":"the address2 of the address",
"type":"string"
},
"city":{
"description":"the city of the address",
"type":"string"
},
"address1":{
"description":"the address1 of the address",
"type":"string"
},
"companyName":{
"description":"the company name of the address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the address",
"type":"string"
},
"state":{
"description":"the state of the address",
"type":"string"
}
}
},
"contacts":{
"type":"array",
"items":{
"type":"object"
}
}
}
},
"shoppingCart":{
"type":"object",
"properties":{
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"numberOfItems":{
"type":"integer"
},
"items":{
"description":"The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"type":"number"
},
"displayName":{
"type":"string"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"childItems":{
"description":"Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
}
}
}
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"listPrice":{
"type":"number"
}
}
}
}
}
},
"giftWithPurchaseInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"number"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the order was placed.",
"type":"string"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"giftWithPurchaseOrderMarkers":{
"type":"array",
"items":{
"type":"object"
}
}
}
}
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
{
"description":"The discount information.",
"type":"object",
"properties":{
"orderCouponsMap":{
"description":"The list of all the coupons with the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"integer"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"integer"
}
}
}
Nested Schema : dynamicProperties
Type: array
the value of the dynamic Properties
Show Source
{
"description":"the value of the dynamic Properties",
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : giftWithPurchaseInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"number"
}
}
}
}
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : organization
Type: object
The organization related property object
Show Source
{
"description":"The organization related property object",
"type":"object",
"properties":{
"taxReferenceNumber":{
"description":"Tax Reference Number of the Organization",
"type":"string"
},
"siteOrganizationProperties":{
"description":"Site Organization Properties",
"type":"object",
"properties":{
"site":{
"description":"Site information",
"type":"object",
"properties":{
"approvalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"contract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"delegateApprovalManagement":{
"description":"This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.",
"type":"boolean"
},
"useExternalApprovalWebhook":{
"description":"Flag to enable/disable Order Approval check from External Webhook",
"type":"boolean"
},
"orderPriceLimit":{
"description":"Its order limit value for the organization, if order limit is more than this value then approval is needed for the order",
"type":"number"
}
}
}
}
},
"childOrganizations":{
"type":"array",
"items":{
"type":"object"
}
},
"delegateApprovalManagement":{
"description":"This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.",
"type":"boolean"
},
"approvers":{
"type":"array",
"items":{
"type":"object"
}
},
"externalOrganizationId":{
"description":"External id of the organization.",
"type":"string"
},
"type":{
"description":"Type for Organization",
"type":"string"
},
"derivedBillingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"customerType":{
"description":"Customer Type for Organization",
"type":"string"
},
"derivedContract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"id":{
"description":"Id of the Organization",
"type":"string"
},
"dunsNumber":{
"description":"DUNS Number for Organization. Should be 9 digit number",
"type":"string"
},
"derivedTaxReferenceNumber":{
"description":"Derived taxReferenceNumber of the Organization",
"type":"string"
},
"derivedDunsNumber":{
"description":"Derived dunsNumber of the Organization",
"type":"string"
},
"contract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"derivedCustomerType":{
"description":"Derived customer type of the Organization",
"type":"string"
},
"active":{
"description":"Active status of an Organization. Should be true or false. By default the value is set to true",
"type":"boolean"
},
"allApprovers":{
"description":"list of all the approvers",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the apporver",
"type":"string"
},
"firstName":{
"description":"the first name of the approver",
"type":"string"
},
"middleName":{
"description":"the middle name of the approver",
"type":"string"
}
}
}
},
"derivedType":{
"description":"Derived type of the Organization",
"type":"string"
},
"derivedShippingAddress":{
"description":"The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.",
"type":"object",
"properties":{
"country":{
"description":"the country of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the company address",
"type":"string"
},
"address2":{
"description":"the address2 of the address",
"type":"string"
},
"city":{
"description":"the city of the address",
"type":"string"
},
"address1":{
"description":"the address1 of the address",
"type":"string"
},
"companyName":{
"description":"the company name shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the address",
"type":"string"
},
"state":{
"description":"the state of the address",
"type":"string"
}
}
},
"derivedApprovalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"approvalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"name":{
"description":"The name for Organization",
"type":"string"
},
"ancestorOrganizations":{
"description":"List of ancestors for the Organization",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the organization.",
"type":"string"
},
"name":{
"description":"Name of the organization.",
"type":"string"
},
"active":{
"description":"Active flag of the organization.",
"type":"boolean"
},
"id":{
"description":"Id of the organization.",
"type":"string"
}
}
}
},
"useExternalApprovalWebhook":{
"description":"Flag to enable/disable Order Approval check from External Webhook",
"type":"boolean"
},
"billingAddress":{
"description":"The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.",
"type":"object",
"properties":{
"country":{
"description":"the country of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the address",
"type":"string"
},
"address2":{
"description":"the address2 of the address",
"type":"string"
},
"city":{
"description":"the city of the address",
"type":"string"
},
"address1":{
"description":"the address1 of the address",
"type":"string"
},
"companyName":{
"description":"the company name of the address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the address",
"type":"string"
},
"state":{
"description":"the state of the address",
"type":"string"
}
}
},
"contacts":{
"type":"array",
"items":{
"type":"object"
}
}
}
}
Nested Schema : priceInfo
Type: object
Show Source
{
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" The secondary currency tax amount.",
"type":"number"
},
"amount":{
"type":"number"
},
"total":{
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":" The secondary currency shipping amount.",
"type":"number"
},
"shipping":{
"type":"number"
},
"secondaryCurrencyTotal":{
"description":" The secondary currency total amount.",
"type":"number"
},
"primaryCurrencyTotal":{
"description":" The primary currency total amount.",
"type":"number"
},
"shippingSurchargeValue":{
"type":"number"
},
"tax":{
"type":"number"
},
"subTotal":{
"type":"number"
},
"currencyCode":{
"type":"string"
},
"totalWithoutTax":{
"type":"number"
}
}
}
Nested Schema : pricingMessages
Type: object
Nested Schema : profile
Type: object
Show Source
{
"type":"object",
"properties":{
"favoriteStores":{
"type":"array",
"items":{
"type":"object"
}
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"catalog":{
"description":"This is a read only attribute added for 'Account Based Commerce', this is the ID of the catalog that is associated with the organization to which this user is associated",
"type":"string"
},
"allowPartialShipment":{
"type":"boolean"
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"securityStatus":{
"type":"integer"
},
"parentOrganization":{
"description":"This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type":"object",
"properties":{
"name":{
"description":"the name of the parent organization",
"type":"string"
},
"repositoryId":{
"description":"the id of the parent organization",
"type":"string"
},
"description":{
"description":"Description of the Organization",
"type":"string"
},
"active":{
"description":"the status of the parent organization. Should be true or false",
"type":"boolean"
},
"shippingAddress":{
"description":"Default shipping address of the organization",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"id":{
"description":"the id of the parent organization",
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the organization",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
}
},
"shippingSurchargePriceList":{
"description":"The shipping surcharge price list for this user",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
}
}
},
"purchaseLists":{
"type":"array",
"items":{
"type":"object"
}
},
"profileType":{
"description":"This attribute is added for account based commerce, It's value is 'b2b_user'",
"type":"string"
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
},
"lastPurchaseAmount":{
"type":"integer"
},
"registrationDate":{
"type":"string"
},
"sessionOrganization":{
"type":"object",
"items":{
"type":"object",
"properties":{
"id":{
"description":"get the organization id",
"type":"string"
}
}
}
},
"lifetimeAOV":{
"type":"integer"
},
"id":{
"description":"get the shopper profile with id",
"type":"string"
},
"ancestors":{
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"get the ancestor's organization id",
"type":"string"
}
}
}
},
"derivedSalePriceList":{
"description":"The derived sale price list from the user's parent organization",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
}
}
},
"homeAddress":{
"description":"Home address which is set on the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"customerContactId":{
"description":"The external customer contact id",
"type":"string"
},
"taxExempt":{
"description":"Indicates tax exemption status.True or False",
"type":"boolean"
},
"contract":{
"type":"object"
},
"active":{
"description":"the user status of the profile. Should be true or false",
"type":"boolean"
},
"abandonedOrderCount":{
"type":"integer"
},
"firstName":{
"description":"the first name of the profile",
"type":"string"
},
"emailStatus":{
"type":"string"
},
"derivedApprovalRequired":{
"description":"Profile level approval required enable/disable",
"type":"boolean"
},
"expressCheckout":{
"type":"boolean"
},
"currentOrganization":{
"type":"object",
"items":{
"type":"object",
"properties":{
"id":{
"description":"get the current organization id",
"type":"string"
}
}
}
},
"secondaryOrganizations":{
"description":"List of secondary organizations associated to profile. It will be empty always. Secondary Organizations associated to the profile can be fetched using organization endpoints",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
},
"name":{
"description":"the name of the organization",
"type":"string"
},
"description":{
"description":"Description of the organization",
"type":"string"
},
"active":{
"description":"the status of the organization. Should be true or false",
"type":"boolean"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
}
}
},
"shippingAddresses":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"derivedPriceListGroup":{
"type":"object"
},
"lastName":{
"description":"the last name of the profile",
"type":"string"
},
"gender":{
"type":"string"
},
"roles":{
"description":"List of user roles.",
"type":"array",
"items":{
"type":"object",
"properties":{
"function":{
"description":"Function of the role which can be admin or buyer.",
"type":"string"
},
"relativeTo":{
"description":"organization ID of the role",
"type":"object",
"properties":{
"id":{
"description":"Organization ID of the role to be assigned",
"type":"string"
}
}
},
"repositoryId":{
"description":"Repository id of the role.",
"type":"string"
}
}
}
},
"approvers":{
"type":"array",
"items":{
"type":"object"
}
},
"numberOfOrders":{
"type":"integer"
},
"login":{
"description":"login of the user",
"type":"string"
},
"priceList":{
"type":"object"
},
"derivedBillingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"lifetimeSpend":{
"type":"integer"
},
"member":{
"type":"boolean"
},
"derivedCatalog":{
"type":"object"
},
"salePriceList":{
"type":"object"
},
"activePromotions":{
"type":"array",
"items":{
"type":"object"
}
},
"email":{
"description":"the email address of the profile",
"type":"string"
},
"siteProperties":{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"site":{
"description":"The site data",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string"
}
}
}
}
},
"comments":{
"type":"array",
"items":{
"type":"string"
}
},
"receiveEmail":{
"description":"this is site specific email marketing flag. can be yes or no",
"type":"string"
},
"priceListGroup":{
"description":"The associated price list group for this user",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
}
}
},
"allSecondaryAddresses":{
"description":"List of all shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"allApprovers":{
"description":"list of all the approvers",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the apporver",
"type":"string"
},
"firstName":{
"description":"the first name of the approver",
"type":"string"
},
"middleName":{
"description":"the middle name of the approver",
"type":"string"
}
}
}
},
"currentLocation":{
"type":"string"
},
"derivedShippingAddress":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"abandonedOrders":{
"type":"array",
"items":{
"type":"object"
}
},
"derivedPriceList":{
"type":"object"
}
}
}
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
}
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile
Show Source
{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
Nested Schema : shippingGroups
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
},
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
},
"shippingGroupId":{
"description":"The shipping Group id",
"type":"string",
"example":"sg1234"
},
"store":{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
},
"type":{
"description":"the shippingGroup type",
"type":"string",
"example":"inStorePickupShippingGroup"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"1231231234"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":0
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"integer",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"integer",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"salePrice":{
"description":"The sale price",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
}
Nested Schema : shoppingCart
Type: object
Show Source
{
"type":"object",
"properties":{
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"numberOfItems":{
"type":"integer"
},
"items":{
"description":"The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"type":"number"
},
"displayName":{
"type":"string"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"childItems":{
"description":"Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
}
}
}
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"listPrice":{
"type":"number"
}
}
}
}
}
}
Nested Schema : orderCouponsMap
Type: array
The list of all the coupons with the order.
Show Source
{
"description":"The list of all the coupons with the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"number"
}
}
}
Nested Schema : items
Type: object
Nested Schema : allApprovers
Type: array
list of all the approvers
Show Source
{
"description":"list of all the approvers",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the apporver",
"type":"string"
},
"firstName":{
"description":"the first name of the approver",
"type":"string"
},
"middleName":{
"description":"the middle name of the approver",
"type":"string"
}
}
}
}
Nested Schema : ancestorOrganizations
Type: array
List of ancestors for the Organization
Show Source
{
"description":"List of ancestors for the Organization",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the organization.",
"type":"string"
},
"name":{
"description":"Name of the organization.",
"type":"string"
},
"active":{
"description":"Active flag of the organization.",
"type":"boolean"
},
"id":{
"description":"Id of the organization.",
"type":"string"
}
}
}
}
Nested Schema : approvers
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : billingAddress
Type: object
The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.
Show Source
{
"description":"The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.",
"type":"object",
"properties":{
"country":{
"description":"the country of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the address",
"type":"string"
},
"address2":{
"description":"the address2 of the address",
"type":"string"
},
"city":{
"description":"the city of the address",
"type":"string"
},
"address1":{
"description":"the address1 of the address",
"type":"string"
},
"companyName":{
"description":"the company name of the address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the address",
"type":"string"
},
"state":{
"description":"the state of the address",
"type":"string"
}
}
}
Nested Schema : childOrganizations
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : contacts
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : contract
Type: object
Contract
Show Source
{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
}
Nested Schema : derivedBillingAddress
Type: object
Default billing address of the profile
Show Source
{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
Nested Schema : derivedContract
Type: object
Contract
Show Source
{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
}
Nested Schema : derivedShippingAddress
Type: object
The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.
Show Source
{
"description":"The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.",
"type":"object",
"properties":{
"country":{
"description":"the country of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the company address",
"type":"string"
},
"address2":{
"description":"the address2 of the address",
"type":"string"
},
"city":{
"description":"the city of the address",
"type":"string"
},
"address1":{
"description":"the address1 of the address",
"type":"string"
},
"companyName":{
"description":"the company name shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the address",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the address",
"type":"string"
},
"state":{
"description":"the state of the address",
"type":"string"
}
}
}
Nested Schema : siteOrganizationProperties
Type: object
Site Organization Properties
Show Source
{
"description":"Site Organization Properties",
"type":"object",
"properties":{
"site":{
"description":"Site information",
"type":"object",
"properties":{
"approvalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"contract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"delegateApprovalManagement":{
"description":"This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.",
"type":"boolean"
},
"useExternalApprovalWebhook":{
"description":"Flag to enable/disable Order Approval check from External Webhook",
"type":"boolean"
},
"orderPriceLimit":{
"description":"Its order limit value for the organization, if order limit is more than this value then approval is needed for the order",
"type":"number"
}
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the apporver",
"type":"string"
},
"firstName":{
"description":"the first name of the approver",
"type":"string"
},
"middleName":{
"description":"the middle name of the approver",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the organization.",
"type":"string"
},
"name":{
"description":"Name of the organization.",
"type":"string"
},
"active":{
"description":"Active flag of the organization.",
"type":"boolean"
},
"id":{
"description":"Id of the organization.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
}
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
}
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
}
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
}
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
}
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
}
Nested Schema : site
Type: object
Site information
Show Source
{
"description":"Site information",
"type":"object",
"properties":{
"approvalRequired":{
"description":"Approval flag is required for the organization, by default it is set to false",
"type":"boolean"
},
"contract":{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
},
"delegateApprovalManagement":{
"description":"This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.",
"type":"boolean"
},
"useExternalApprovalWebhook":{
"description":"Flag to enable/disable Order Approval check from External Webhook",
"type":"boolean"
},
"orderPriceLimit":{
"description":"Its order limit value for the organization, if order limit is more than this value then approval is needed for the order",
"type":"number"
}
}
}
Nested Schema : contract
Type: object
Contract
Show Source
{
"description":"Contract",
"type":"object",
"properties":{
"endDate":{
"description":"Contract end date time stamp",
"type":"string"
},
"terms":{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
},
"catalog":{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
},
"displayName":{
"description":"Name of the contract",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of the contract",
"type":"string"
},
"description":{
"description":"Description for contract",
"type":"string"
},
"priceListGroup":{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
},
"creationDate":{
"description":"Contract creation date time stamp",
"type":"string"
},
"startDate":{
"description":"Contract start date time stamp",
"type":"string"
},
"externalContractReference":{
"description":"External contract reference",
"type":"string"
}
}
}
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
{
"description":"Catalog associated with contract",
"type":"object",
"properties":{
"displayName":{
"description":"Name of the catalog",
"type":"string"
},
"id":{
"description":"id of the catalog",
"type":"string"
},
"status":{
"type":"string"
}
}
}
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
{
"description":"Price ListGroup associated with contract",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository Id of the price list group",
"type":"string"
}
}
}
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
{
"description":"Terms and Conditions",
"type":"object",
"properties":{
"terms":{
"description":"Terms and Conditions",
"type":"string"
},
"repositoryId":{
"description":"Repository Id of terms and conditions",
"type":"string"
}
}
}
Nested Schema : abandonedOrders
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : activePromotions
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : allApprovers
Type: array
list of all the approvers
Show Source
{
"description":"list of all the approvers",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the apporver",
"type":"string"
},
"firstName":{
"description":"the first name of the approver",
"type":"string"
},
"middleName":{
"description":"the middle name of the approver",
"type":"string"
}
}
}
}
Nested Schema : allSecondaryAddresses
Type: array
List of all shipping addresses associated with profile.
Show Source
{
"description":"List of all shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
}
Nested Schema : ancestors
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"get the ancestor's organization id",
"type":"string"
}
}
}
}
Nested Schema : approvers
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : comments
Type: array
Show Source
{
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : contract
Type: object
Nested Schema : currentOrganization
Type: object
Show Source
{
"type":"object",
"items":{
"type":"object",
"properties":{
"id":{
"description":"get the current organization id",
"type":"string"
}
}
}
}
Nested Schema : derivedBillingAddress
Type: object
Default billing address of the profile
Show Source
{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
Nested Schema : derivedCatalog
Type: object
Nested Schema : derivedPriceList
Type: object
Nested Schema : derivedPriceListGroup
Type: object
Nested Schema : derivedSalePriceList
Type: object
The derived sale price list from the user's parent organization
Show Source
{
"description":"The derived sale price list from the user's parent organization",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
}
}
}
Nested Schema : derivedShippingAddress
Type: array
List of shipping addresses associated with profile.
Show Source
{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
}
Nested Schema : favoriteStores
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : homeAddress
Type: object
Home address which is set on the profile
Show Source
{
"description":"Home address which is set on the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
Show Source
{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
}
Nested Schema : parentOrganization
Type: object
This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated
Show Source
{
"description":"This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type":"object",
"properties":{
"name":{
"description":"the name of the parent organization",
"type":"string"
},
"repositoryId":{
"description":"the id of the parent organization",
"type":"string"
},
"description":{
"description":"Description of the Organization",
"type":"string"
},
"active":{
"description":"the status of the parent organization. Should be true or false",
"type":"boolean"
},
"shippingAddress":{
"description":"Default shipping address of the organization",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"id":{
"description":"the id of the parent organization",
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the organization",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
}
}
Nested Schema : priceList
Type: object
Nested Schema : priceListGroup
Type: object
The associated price list group for this user
Show Source
{
"description":"The associated price list group for this user",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
}
}
}
Nested Schema : purchaseLists
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object"
}
}
Nested Schema : roles
Type: array
List of user roles.
Show Source
{
"description":"List of user roles.",
"type":"array",
"items":{
"type":"object",
"properties":{
"function":{
"description":"Function of the role which can be admin or buyer.",
"type":"string"
},
"relativeTo":{
"description":"organization ID of the role",
"type":"object",
"properties":{
"id":{
"description":"Organization ID of the role to be assigned",
"type":"string"
}
}
},
"repositoryId":{
"description":"Repository id of the role.",
"type":"string"
}
}
}
}
Nested Schema : salePriceList
Type: object
Nested Schema : secondaryAddresses
Type: array
List of shipping addresses associated with profile.
Show Source
{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
}
Nested Schema : secondaryOrganizations
Type: array
List of secondary organizations associated to profile. It will be empty always. Secondary Organizations associated to the profile can be fetched using organization endpoints
Show Source
{
"description":"List of secondary organizations associated to profile. It will be empty always. Secondary Organizations associated to the profile can be fetched using organization endpoints",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
},
"name":{
"description":"the name of the organization",
"type":"string"
},
"description":{
"description":"Description of the organization",
"type":"string"
},
"active":{
"description":"the status of the organization. Should be true or false",
"type":"boolean"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
}
}
}
Nested Schema : sessionOrganization
Type: object
Show Source
{
"type":"object",
"items":{
"type":"object",
"properties":{
"id":{
"description":"get the organization id",
"type":"string"
}
}
}
}
Nested Schema : shippingAddresses
Type: object
Default shipping address of the profile
Show Source
{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
Nested Schema : shippingSurchargePriceList
Type: object
The shipping surcharge price list for this user
Show Source
{
"description":"The shipping surcharge price list for this user",
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
}
}
}
Nested Schema : siteProperties
Type: object
The site related properties for the profile
Show Source
{
"description":"The site related properties for the profile",
"type":"object",
"properties":{
"site":{
"description":"The site data",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string"
}
}
}
}
}
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the apporver",
"type":"string"
},
"firstName":{
"description":"the first name of the approver",
"type":"string"
},
"middleName":{
"description":"the middle name of the approver",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"get the ancestor's organization id",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"get the current organization id",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
Nested Schema : billingAddress
Type: object
Default billing address of the organization
Show Source
{
"description":"Default billing address of the organization",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
Nested Schema : secondaryAddresses
Type: array
List of shipping addresses associated with profile.
Show Source
{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
}
Nested Schema : shippingAddress
Type: object
Default shipping address of the organization
Show Source
{
"description":"Default shipping address of the organization",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"function":{
"description":"Function of the role which can be admin or buyer.",
"type":"string"
},
"relativeTo":{
"description":"organization ID of the role",
"type":"object",
"properties":{
"id":{
"description":"Organization ID of the role to be assigned",
"type":"string"
}
}
},
"repositoryId":{
"description":"Repository id of the role.",
"type":"string"
}
}
}
Nested Schema : relativeTo
Type: object
organization ID of the role
Show Source
{
"description":"organization ID of the role",
"type":"object",
"properties":{
"id":{
"description":"Organization ID of the role to be assigned",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"externalAddressId":{
"description":"External ID of the address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"repositoryId":{
"description":"Repository ID",
"type":"string"
},
"name":{
"description":"the name of the organization",
"type":"string"
},
"description":{
"description":"Description of the organization",
"type":"string"
},
"active":{
"description":"the status of the organization. Should be true or false",
"type":"boolean"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
}
}
Nested Schema : billingAddress
Type: object
Default billing address of the profile
Show Source
{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
Nested Schema : secondaryAddresses
Type: array
List of shipping addresses associated with profile.
Show Source
{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
}
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile
Show Source
{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"get the organization id",
"type":"string"
}
}
}
Nested Schema : site
Type: object
The site data
Show Source
{
"description":"The site data",
"type":"object",
"properties":{
"GDPRProfileP13nConsentDate":{
"description":"The date on which GDPR personalization consent was granted by the user.",
"type":"string"
},
"GDPRProfileP13nConsentGranted":{
"description":"If user has given consent for his/her profile information to be used for personalization purposes.",
"type":"boolean"
},
"receiveEmail":{
"description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
"type":"string"
},
"receiveEmailDate":{
"description":"The date on which email marketing consent was granted by the user.",
"type":"string"
}
}
}
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Show Source
{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"taxPriceInfo":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
},
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"Muir"
},
"itemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding items property is truncated. The value for this field will always be true if present",
"type":"boolean"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
},
"shippingGroupId":{
"description":"The shipping Group id",
"type":"string",
"example":"sg1234"
},
"store":{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
},
"type":{
"description":"the shippingGroup type",
"type":"string",
"example":"inStorePickupShippingGroup"
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"John"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"1231231234"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":0
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"integer",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"integer",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
},
"items":{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"salePrice":{
"description":"The sale price",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
{
"description":"The discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"orderCouponsMap":{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":0
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
},
"orderDiscount":{
"description":"The order discount.",
"type":"integer",
"example":0
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"integer",
"example":5.6
},
"orderImplicitDiscountList":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
},
"unclaimedCouponsMap":{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
},
"claimedCouponMultiPromotions":{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
}
}
Nested Schema : items
Type: array
Show Source
{
"type":"array",
"items":{
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"salePrice":{
"description":"The sale price",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
}
Nested Schema : priceInfo
Type: object
The price information.
Show Source
{
"description":"The price information.",
"type":"object",
"properties":{
"amount":{
"description":"The total order amount.",
"type":"number",
"example":24.99
},
"total":{
"description":"The order total.",
"type":"number",
"example":47.93
},
"lkpValExcludingFreeShip":{
"description":"The total shipping cost excluding items with free shipping.",
"type":"number",
"example":0
},
"shipping":{
"description":"The total shipping cost.",
"type":"number",
"example":14.95
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products",
"type":"number",
"example":0
},
"tax":{
"description":"The total tax amount.",
"type":"number",
"example":7.99
},
"subTotal":{
"description":"Sub-total.",
"type":"number",
"example":24.99
},
"currencyCode":{
"description":"The currency code.",
"type":"string",
"example":"USD"
},
"totalWithoutTax":{
"description":"The total amount without tax.",
"type":"number",
"example":39.49
}
}
}
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
}
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string",
"example":"Muir"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string",
"example":"Cambridge"
},
"address1":{
"description":"Address snippet.",
"type":"string",
"example":"1 main st"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string",
"example":"oracle"
},
"postalCode":{
"description":"Postal code.",
"type":"string",
"example":1122
},
"jobTitle":{
"description":"Job title.",
"type":"string",
"example":"manager"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string",
"example":"John"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string",
"example":1111111111
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string",
"example":"Morgan"
},
"state":{
"description":"State.",
"type":"string",
"example":"MA"
},
"email":{
"description":"Email address.",
"type":"string",
"example":"john.muir@oracle.com"
}
}
}
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"shippingTax":{
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"taxCode":{
"type":"string"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"type":"string"
}
}
}
Nested Schema : store
Type: object
The store is present in the request if the type is inStorePickupShippingGroup.
Show Source
{
"description":"The store is present in the request if the type is inStorePickupShippingGroup.",
"type":"object",
"properties":{
"country":{
"description":"The country of the store",
"type":"string",
"example":"USA"
},
"hours":{
"description":"The store's opening hours.",
"type":"string",
"example":"Mon - Sat 10AM - 7PM Sun 11AM - 6 PM"
},
"address3":{
"description":"Address line 3 of store.",
"type":"string",
"example":"Main Street"
},
"address2":{
"description":"Address line 2 of store.",
"type":"string",
"example":"4th Floor"
},
"city":{
"description":"The store's city.",
"type":"string",
"example":"Boston"
},
"address1":{
"description":"Address line 1 of store.",
"type":"string",
"example":"One Beacon Street"
},
"stateAddress":{
"description":"The store's state address.",
"type":"string",
"example":"MA"
},
"county":{
"description":"The store's county",
"type":"string",
"example":"MA"
},
"phoneNumber":{
"description":"The store's phone number.",
"type":"string",
"example":"(617) 386-1201"
},
"locationId":{
"description":"The store's location Id.",
"type":"string",
"example":"Boston138"
},
"name":{
"description":"The store's name.",
"type":"string",
"example":"Boston Store #138"
},
"faxNumber":{
"description":"Fax number.",
"type":"string",
"example":"(617) 386-1200"
},
"postCode":{
"description":"The store's post code.",
"type":"string",
"example":"2108"
},
"email":{
"description":"The store's email address.",
"type":"string",
"example":"store138@example.com"
}
}
}
Nested Schema : taxPriceInfo
Type: object
The shipping address details.
Show Source
{
"description":"The shipping address details.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"taxAmount in secondaryCurrency",
"type":"number",
"example":0
},
"cityTax":{
"description":"City Tax",
"type":"number",
"example":3.9
},
"amount":{
"description":"The total order amount.",
"type":"number",
"example":5.99
},
"valueAddedTax":{
"description":"Value Added Tax.",
"type":"number",
"example":0
},
"countyTax":{
"description":"County Tax.",
"type":"number",
"example":0
},
"isTaxIncluded":{
"description":"If Tax is included?",
"type":"boolean",
"example":false
},
"miscTax":{
"description":"Misc Tax.",
"type":"number",
"example":1.87
},
"districtTax":{
"description":"District Tax.",
"type":"number",
"example":0
},
"stateTax":{
"description":"State Tax.",
"type":"number",
"example":3.9
},
"countryTax":{
"description":"Country Tax.",
"type":"number",
"example":0
}
}
}
Nested Schema : claimedCouponMultiPromotions
Type: object
Show Source
{
"type":"object",
"properties":{
"promotions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : orderCouponsMap
Type: array
The list of all the coupons with the order
Show Source
{
"description":"The list of all the coupons with the order",
"type":"array",
"items":{
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":0
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
}
Nested Schema : orderImplicitDiscountList
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
Nested Schema : unclaimedCouponMultiPromotions
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
},
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : unclaimedCouponsMap
Type: object
Show Source
{
"type":"object",
"properties":{
"couponCode":{
"type":"string",
"example":"CPN123"
}
}
}
Nested Schema : promotions
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"totalAdjustment":{
"type":"integer",
"example":0
},
"secondaryCurrencyTotalAdjustment":{
"type":"integer",
"example":0
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"properties":{
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":false
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":0
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string",
"example":"promo123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"Detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PROMO1"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions)",
"type":"boolean",
"example":true
},
"promotionLevel":{
"description":"promotion level - order or item",
"type":"string",
"example":"order"
},
"totalAdjustment":{
"description":"The total adjustment.",
"type":"string",
"example":5.6
},
"promotionDesc":{
"type":"string",
"example":"the order related promotion"
},
"secondaryCurrencyTotalAdjustment":{
"description":"The total adjustment for secondary currency",
"type":"string",
"example":0
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
Nested Schema : promotionInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"long desc of promotion"
},
"promotionName":{
"type":"string",
"example":"PRMName"
},
"promotionLevel":{
"type":"string",
"example":"order"
},
"totalAdjustment":{
"type":"integer",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"description of the promotion"
},
"promotionID":{
"type":"string",
"example":"PRM123"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"properties":{
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number",
"example":24.99
},
"returnedQuantity":{
"type":"integer",
"example":0
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
},
"shippingSurchargeValue":{
"description":"Extra handling cost for shipping the product.",
"type":"number",
"example":0
},
"availabilityDate":{
"format":"date-time",
"description":"The availability date for preOrdered/backOrdered quantity.",
"type":"string",
"example":"2018-06-13T18:09:53.493Z"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number",
"example":0
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
},
"preOrderQuantity":{
"description":"The pre ordered quantity included.",
"type":"integer",
"example":0
},
"childItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
},
"configuratorId":{
"type":"string"
},
"commerceItemId":{
"description":"Commerce Item ID for this commerce item.",
"type":"string",
"example":"ci123545"
},
"price":{
"type":"number",
"example":24.99
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean",
"example":false
},
"actionCode":{
"description":"The action code that has been set on the item by the third party system.",
"type":"string"
},
"commerceId":{
"description":"Commerce ID for this commerce item.",
"type":"string",
"example":"ci12343"
},
"stateDetailsAsUser":{
"type":"string",
"example":"details of shippingItem"
},
"unitPrice":{
"type":"number",
"example":24.99
},
"amount":{
"description":"The monetary amount.",
"type":"number",
"example":24.99
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer",
"example":1
},
"productId":{
"description":"The ID of the product.",
"type":"string",
"example":"product_9e"
},
"salePrice":{
"description":"The sale price",
"type":"number",
"example":0
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string",
"example":"2018-05-19T13:00:00.000Z"
},
"catRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string",
"example":"Sku_9F"
},
"discountInfo":{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"backOrderQuantity":{
"description":"The back ordered quantity included.",
"type":"integer",
"example":0
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number",
"example":24.99
},
"status":{
"type":"string",
"example":"INITIAL"
}
}
}
Nested Schema : childItems
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
}
}
}
Nested Schema : detailedItemPriceInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
}
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
Nested Schema : discountInfo
Type: array
Whether this item is discounted.
Show Source
{
"description":"Whether this item is discounted.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
}
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
}
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a third party system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a third party system.",
"type":"array",
"items":{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
}
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"discounted":{
"type":"boolean",
"example":false
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number",
"example":0
},
"amount":{
"type":"number",
"example":24.99
},
"quantity":{
"type":"integer",
"example":1
},
"tax":{
"type":"number",
"example":0
},
"orderDiscountShare":{
"type":"integer",
"example":0
},
"detailedUnitPrice":{
"type":"number",
"example":24.99
},
"currencyCode":{
"type":"string",
"example":"USD"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"type":"string",
"example":"detailed desc of promotion"
},
"promotionName":{
"type":"string",
"example":"Promotion BAC"
},
"external":{
"description":"if promotion is external",
"type":"boolean",
"example":false
},
"coupon":{
"type":"string",
"example":"CPN123"
},
"promotionLevel":{
"type":"string",
"example":"item"
},
"totalAdjustment":{
"type":"string",
"example":0
},
"promotionDesc":{
"type":"string",
"example":"promotion desc"
},
"promotionId":{
"type":"string",
"example":"PRM123"
},
"giftWithPurchaseDiscountInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
}
}
Nested Schema : giftWithPurchaseDiscountInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"gitWithPurchaseDetail":{
"type":"string",
"example":"details of gift"
},
"gitWithPurchaseIdentifier":{
"type":"integer",
"example":1223344
},
"giftWithPurchaseType":{
"description":"the gift type.For example product or sku",
"type":"string",
"example":"product"
},
"promotionDesc":{
"type":"string",
"example":"GWP Promotion description"
},
"promotionId":{
"type":"string",
"example":"PRM1234"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string",
"example":11502
},
"label":{
"description":"The dynamic property label.",
"type":"string",
"example":"dyn_prop"
},
"value":{
"description":"The dynamic property value.",
"type":"string",
"example":12
}
}
}
Nested Schema : items
Type: object
Show Source
{
"properties":{
"values":{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the third party system.",
"type":"string"
}
}
}
Nested Schema : values
Type: object
The map values associated with an externalData item.
Show Source
{
"description":"The map values associated with an externalData item.",
"type":"object",
"properties":{
"value":{
"description":"Map value defined by external system.",
"type":"string"
},
"key":{
"description":"Map key defined by external system.",
"type":"string"
}
}
}
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Show Source
{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
Nested Schema : items
Type: array
The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
{
"description":"The array of products in the shopping cart. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"type":"number"
},
"displayName":{
"type":"string"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"childItems":{
"description":"Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
}
}
}
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"listPrice":{
"type":"number"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"primaryThumbImageURL":{
"type":"string"
},
"rawTotalPrice":{
"type":"number"
},
"displayName":{
"type":"string"
},
"dynamicProperties":{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
},
"shippingSurchargeValue":{
"type":"integer"
},
"description":{
"type":"string"
},
"discountAmount":{
"type":"number"
},
"isItemValid":{
"type":"boolean"
},
"childItems":{
"description":"Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
}
}
}
},
"configuratorId":{
"type":"string"
},
"externalPrice":{
"type":"number"
},
"price":{
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"childItemsIsTruncated":{
"description":"This property will be added to the webhook payload only if the corresponding childItems property is truncated. The value for this field will be true always if present",
"type":"boolean"
},
"onSale":{
"type":"boolean"
},
"id":{
"type":"string"
},
"unitPrice":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"productId":{
"type":"string"
},
"salePrice":{
"type":"number"
},
"detailedItemPriceInfo":{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"externalPriceQuantity":{
"type":"integer"
},
"catRefId":{
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"listPrice":{
"type":"number"
}
}
}
Nested Schema : childItems
Type: array
Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
{
"description":"Represents the child commerce items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
"type":"array",
"items":{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
}
}
}
}
Nested Schema : detailedItemPriceInfo
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
}
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
}
Nested Schema : dynamicProperties
Type: array
List of dynamic properties at line item level.
Show Source
{
"description":"List of dynamic properties at line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
}
Nested Schema : orderDiscountInfos
Type: array
Array of order promotions affecting this item.
Show Source
{
"description":"Array of order promotions affecting this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
}
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}
Map of shopper input keys to values
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"addOnItem":{
"description":"Whether this child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
}
}
}
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"discounted":{
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":" tax amount in secondaryCurrency",
"type":"number"
},
"amount":{
"type":"number"
},
"quantity":{
"type":"integer"
},
"tax":{
"type":"number"
},
"orderDiscountShare":{
"type":"integer"
},
"detailedUnitPrice":{
"type":"number"
},
"currencyCode":{
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The dynamic property id.",
"type":"string"
},
"label":{
"description":"The dynamic property label.",
"type":"string"
},
"value":{
"description":"The dynamic property value.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
Nested Schema : couponCodes
Type: array
One or more coupon codes used to grant the order promotion providing the discount.
Show Source
{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}