Jump to

• Request
• Response

getScheduledOrder

get

/ccstore/v1/scheduledOrders/{id}

Get Scheduled Order. It will return the scheduled order based on scheduled order id.Optionally takes the X-CCOrganization header to specify current Organization context of logged in user.This endpoint returns the order details irrespective of organization ID passed in request header. If user doesn't belong to order's organization, then the user has no access to order.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The id of the Scheduled order.

Query Parameters

• orderDetails(optional): boolean
  Order Details of Scheduled Order.

Header Parameters

• X-CCOrganization(optional): string
  Current organization context of the logged in user

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getScheduledOrder_response

Type: object

Show Source

• createDate(optional): string
  The create date of the Scheduled order.
• endDate(optional): string
  The end date of the Scheduled order.
• id(optional): string
  The id of the Scheduled order.
• name(optional): string
  The name of the Scheduled order.
• nextScheduledRun(optional): string
  The next scheduled run of the Scheduled order.
• profileId(optional): string
  The profile id of the user of Scheduled order.
• schedule(optional): object schedule
  The schedule of the Scheduled order.
• scheduleType(optional): string
  The schedule type of the Scheduled order.
• startDate(optional): string
  The start date of the Scheduled order.
• state(optional): string
  The status of the Scheduled order.
• templateOrder(optional): object templateOrder
  The Order of the Scheduled order.
• templateOrderId(optional): string
  The template order id of the Scheduled order.

{
    "properties":{
        "schedule":{
            "description":"The schedule of the Scheduled order.",
            "type":"object",
            "properties":{
                "period":{
                    "description":"The period of repeating of the Periodic Scheduled order in milliseconds.",
                    "type":"integer"
                },
                "delay":{
                    "description":"The delay of the first scheduled run after start date of the Periodic Scheduled order in milliseconds.",
                    "type":"integer"
                },
                "selectedDates":{
                    "description":"The selected dates in a month in year for the Scheduled order.",
                    "type":"array",
                    "items":{
                        "type":"integer"
                    }
                },
                "weeksInMonth":{
                    "description":"The weeks in month of the Scheduled order.",
                    "type":"array",
                    "items":{
                        "type":"integer"
                    }
                },
                "interval":{
                    "description":"The interval in term of number of days of the Scheduled order.",
                    "type":"integer"
                },
                "monthsInYear":{
                    "description":"The months in year of the Scheduled order.",
                    "type":"array",
                    "items":{
                        "type":"integer"
                    }
                },
                "daysOfWeek":{
                    "description":"The days of week of the Scheduled order.",
                    "type":"array",
                    "items":{
                        "type":"integer"
                    }
                },
                "occurenceInDay":{
                    "description":"The occurence in day on the Scheduled order.",
                    "type":"integer"
                }
            }
        },
        "templateOrderId":{
            "description":"The template order id of the Scheduled order.",
            "type":"string"
        },
        "scheduleType":{
            "description":"The schedule type of the Scheduled order.",
            "type":"string"
        },
        "endDate":{
            "description":"The end date of the Scheduled order.",
            "type":"string"
        },
        "templateOrder":{
            "description":"The Order of the Scheduled order.",
            "type":"object",
            "properties":{
                "shippingGroups":{
                    "description":"The shipping groups for the order.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "taxPriceInfo":{
                                "description":"The shipping tax price info details.",
                                "type":"object",
                                "properties":{
                                    "cityTax":{
                                        "description":"The shipping group subtotal.",
                                        "type":"number"
                                    },
                                    "amount":{
                                        "description":"The shipping method amount.",
                                        "type":"number"
                                    },
                                    "valueAddedTax":{
                                        "description":"The value added tax .",
                                        "type":"number"
                                    },
                                    "countyTax":{
                                        "description":"The county tax amount.",
                                        "type":"number"
                                    },
                                    "isTaxIncluded":{
                                        "description":"Flag that states whether is tax included.",
                                        "type":"boolean"
                                    },
                                    "miscTax":{
                                        "description":"The miscellaneous tax amount.",
                                        "type":"string"
                                    },
                                    "districtTax":{
                                        "description":"The shipping method applied to the order.",
                                        "type":"string"
                                    },
                                    "stateTax":{
                                        "description":"The shipping method tax amount.",
                                        "type":"number"
                                    },
                                    "countryTax":{
                                        "description":"The country tax total.",
                                        "type":"number"
                                    }
                                }
                            },
                            "priceInfo":{
                                "description":"The shipping group price information.",
                                "type":"object",
                                "properties":{
                                    "amount":{
                                        "description":"The shipping method amount.",
                                        "type":"number"
                                    },
                                    "total":{
                                        "description":"The total cost of shipping.",
                                        "type":"number"
                                    },
                                    "shipping":{
                                        "description":"The shipping amount.",
                                        "type":"number"
                                    },
                                    "shippingSurchargeValue":{
                                        "description":"The shipping surcharge value amount.",
                                        "type":"number"
                                    },
                                    "tax":{
                                        "description":"The shipping method tax amount.",
                                        "type":"number"
                                    },
                                    "subTotal":{
                                        "description":"The shipping group subtotal.",
                                        "type":"number"
                                    },
                                    "currencyCode":{
                                        "description":"The shipping method amount.",
                                        "type":"string"
                                    },
                                    "totalWithoutTax":{
                                        "description":"The shipping items total.",
                                        "type":"number"
                                    }
                                }
                            },
                            "discountInfo":{
                                "description":"The shipping group price information.",
                                "type":"object",
                                "properties":{
                                    "orderDiscount":{
                                        "description":"The orderDiscount.",
                                        "type":"number"
                                    },
                                    "shippingDiscount":{
                                        "description":"The shipping discount.",
                                        "type":"number"
                                    },
                                    "discountDescList":{
                                        "description":"The list of all the order discounts.",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "promotionLevel":{
                                                    "description":"The promotion level.",
                                                    "type":"string"
                                                },
                                                "coupon":{
                                                    "description":"The coupon code.",
                                                    "type":"string"
                                                },
                                                "promotionDesc":{
                                                    "description":"The promotion description.",
                                                    "type":"string"
                                                },
                                                "promotionId":{
                                                    "description":"The promotion id.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "shipOnDate":{
                                "description":"The ship on date in ISO format.",
                                "type":"string"
                            },
                            "actualShipDate":{
                                "description":"The actual ship date in ISO format.",
                                "type":"string"
                            },
                            "shippingMethod":{
                                "description":"The shipping method details.",
                                "type":"object",
                                "properties":{
                                    "shippingTax":{
                                        "description":"The shipping tax.",
                                        "type":"number"
                                    },
                                    "cost":{
                                        "description":"The total cost of shipping.",
                                        "type":"number"
                                    },
                                    "value":{
                                        "description":"The shipping method applied to the order.",
                                        "type":"string"
                                    },
                                    "shippingMethodDescription":{
                                        "description":"The description of the shipping method.",
                                        "type":"string"
                                    }
                                }
                            },
                            "shippingGroupId":{
                                "description":"The shipping group ID.",
                                "type":"string"
                            },
                            "shippingAddress":{
                                "description":"The shipping address details.",
                                "type":"object",
                                "properties":{
                                    "lastName":{
                                        "description":"Last name.",
                                        "type":"string"
                                    },
                                    "country":{
                                        "description":"Country.",
                                        "type":"string"
                                    },
                                    "address3":{
                                        "description":"Address snippet.",
                                        "type":"string"
                                    },
                                    "address2":{
                                        "description":"Address snippet.",
                                        "type":"string"
                                    },
                                    "city":{
                                        "description":"City.",
                                        "type":"string"
                                    },
                                    "prefix":{
                                        "description":"Name prefix.",
                                        "type":"string"
                                    },
                                    "address1":{
                                        "description":"Address snippet.",
                                        "type":"string"
                                    },
                                    "postalCode":{
                                        "description":"Postal code.",
                                        "type":"string"
                                    },
                                    "jobTitle":{
                                        "description":"Job title.",
                                        "type":"string"
                                    },
                                    "companyName":{
                                        "description":"Company name.",
                                        "type":"string"
                                    },
                                    "county":{
                                        "description":"County.",
                                        "type":"string"
                                    },
                                    "suffix":{
                                        "description":"Name suffix.",
                                        "type":"string"
                                    },
                                    "selectedCountry":{
                                        "description":"Country code.",
                                        "type":"string"
                                    },
                                    "firstName":{
                                        "description":"First name.",
                                        "type":"string"
                                    },
                                    "phoneNumber":{
                                        "description":"Phone number.",
                                        "type":"string"
                                    },
                                    "faxNumber":{
                                        "description":"Fax number.",
                                        "type":"string"
                                    },
                                    "alias":{
                                        "description":"Address alias.",
                                        "type":"string"
                                    },
                                    "middleName":{
                                        "description":"Middle name.",
                                        "type":"string"
                                    },
                                    "state":{
                                        "description":"State.",
                                        "type":"string"
                                    },
                                    "selectedState":{
                                        "description":"State code.",
                                        "type":"string"
                                    },
                                    "email":{
                                        "description":"Email address.",
                                        "type":"string"
                                    },
                                    "state_ISOCode":{
                                        "description":"State ISO code.",
                                        "type":"string"
                                    }
                                }
                            },
                            "submittedDate":{
                                "description":"The submitted date in ISO format.",
                                "type":"string"
                            },
                            "trackingNumber":{
                                "description":"The tracking number.",
                                "type":"string"
                            },
                            "items":{
                                "description":"The array of products in the shipping group.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "unitPrice":{
                                            "description":"The unit price.",
                                            "type":"number"
                                        },
                                        "primaryImageTitle":{
                                            "description":"Primary Image Title.",
                                            "type":"string"
                                        },
                                        "primaryThumbImageURL":{
                                            "description":"Primary Thumb Image URL.",
                                            "type":"string"
                                        },
                                        "quantity":{
                                            "description":"The quantity of the product in this shipping group.",
                                            "type":"integer"
                                        },
                                        "productId":{
                                            "description":"ID of the product in the cart.",
                                            "type":"string"
                                        },
                                        "rawTotalPrice":{
                                            "description":"Raw Total Price.",
                                            "type":"string"
                                        },
                                        "salePrice":{
                                            "description":"Sale Price.",
                                            "type":"string"
                                        },
                                        "displayName":{
                                            "description":"Display Name.",
                                            "type":"string"
                                        },
                                        "detailedItemPriceInfo":{
                                            "description":"Detailed Item Price Information.",
                                            "type":"object",
                                            "properties":{
                                                "discounted":{
                                                    "description":"Is this item discounted.",
                                                    "type":"boolean"
                                                },
                                                "amount":{
                                                    "description":"The amount.",
                                                    "type":"number"
                                                },
                                                "quantity":{
                                                    "description":"The quantity.",
                                                    "type":"number"
                                                },
                                                "tax":{
                                                    "description":"The tax amount.",
                                                    "type":"number"
                                                },
                                                "orderDiscountShare":{
                                                    "description":"The order Discount Share.",
                                                    "type":"number"
                                                },
                                                "detailedUnitPrice":{
                                                    "description":"Detailed Unit Price.",
                                                    "type":"number"
                                                },
                                                "currencyCode":{
                                                    "description":"The currency code.",
                                                    "type":"string"
                                                }
                                            }
                                        },
                                        "shippingSurchargeValue":{
                                            "description":"shipping surcharge value.",
                                            "type":"number"
                                        },
                                        "discountAmount":{
                                            "description":"The discount amount.",
                                            "type":"string"
                                        },
                                        "active":{
                                            "description":"UIs this product active.",
                                            "type":"boolean"
                                        },
                                        "catRefId":{
                                            "description":"The category to which the product belongs.",
                                            "type":"string"
                                        },
                                        "skuProperties":{
                                            "description":"Sku properties Information",
                                            "type":"array",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "propertyType":{
                                                        "description":"Type that indicates whether it is a base or a custom SKU property,",
                                                        "type":"string"
                                                    },
                                                    "name":{
                                                        "description":"Name of the Dynamic SKU Property.",
                                                        "type":"string"
                                                    },
                                                    "id":{
                                                        "description":"ID of the Dynamic SKU Property.",
                                                        "type":"string"
                                                    },
                                                    "value":{
                                                        "description":"Value of the Dynamic SKU Property.",
                                                        "type":"string"
                                                    }
                                                }
                                            }
                                        },
                                        "route":{
                                            "description":"route.",
                                            "type":"string"
                                        },
                                        "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"
                                                    }
                                                }
                                            }
                                        },
                                        "onSale":{
                                            "description":"Indicates whether the price is for an item that is on sale.",
                                            "type":"boolean"
                                        },
                                        "primaryImageAltText":{
                                            "description":"Primary Image Alternative Text.",
                                            "type":"string"
                                        },
                                        "listPrice":{
                                            "description":"List Price.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "status":{
                                "description":"The shipping group status.",
                                "type":"string"
                            }
                        }
                    }
                },
                "creationTime":{
                    "description":"The creation time in long seconds.",
                    "type":"number"
                },
                "lastModifiedDate":{
                    "description":"The order recent modified date in ISO format.",
                    "type":"string"
                },
                "dynamicProperties":{
                    "description":"Read-only list of dynamic properties for the order along with meta-data.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"The ID of the dynamic property.",
                                "type":"string"
                            },
                            "value":{
                                "description":"The value of the dynamic property.",
                                "type":"string"
                            }
                        }
                    }
                },
                "shippingMethod":{
                    "description":"The shipping method details for the order.",
                    "type":"object",
                    "properties":{
                        "cost":{
                            "description":"The total cost of shipping.",
                            "type":"number"
                        },
                        "value":{
                            "description":"The shipping method applied to the order.",
                            "type":"string"
                        }
                    }
                },
                "payments":{
                    "description":"Payment details for the order, including additional properties specific to the payment type.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "PONumber":{
                                "description":"Purchase order number for invoice payment. Payment type:invoice",
                                "type":"string"
                            },
                            "paymentGroupId":{
                                "description":"Payment group id.",
                                "type":"string"
                            },
                            "savedCardId":{
                                "description":"Id of the saved card associated with the payment group.",
                                "type":"string"
                            },
                            "amount":{
                                "description":"Amount authorized from the payment group.",
                                "type":"number"
                            },
                            "balance":{
                                "description":"Total available balance on the gift card.",
                                "type":"number"
                            },
                            "gatewayName":{
                                "description":"Payment gateway name. e.g. chaseCreditCard.",
                                "type":"string"
                            },
                            "giftCardNumber":{
                                "description":"Gift card number.",
                                "type":"string"
                            },
                            "paymentMethod":{
                                "description":"Payment method. e.g. physicalGiftCard/ creditCard.",
                                "type":"string"
                            },
                            "uiIntervention":{
                                "description":"This decides whether the client has to do some intervention for payment. e.g. SOP.",
                                "type":"string"
                            },
                            "isAmountRemaining":{
                                "description":"A boolean to decide if more payment can be made from this payment group.",
                                "type":"boolean"
                            },
                            "paymentState":{
                                "description":"The state of the payment group. e.g. AUTHORIZED.",
                                "type":"string"
                            },
                            "maskedCardNumber":{
                                "description":"Masked gift card number.",
                                "type":"string"
                            }
                        }
                    }
                },
                "orderStatus":{
                    "description":"Status of the order.",
                    "type":"string"
                },
                "priceListGroup":{
                    "description":"The price list group object.",
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"Repository ID of the price list group.",
                            "type":"string"
                        }
                    }
                },
                "shoppingCart/order":{
                    "description":"The shopping-cart or order contents of the current order.",
                    "type":"object",
                    "properties":{
                        "items":{
                            "description":"The array of products in the shopping cart.",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "unitPrice":{
                                        "description":"The unit price of the product.",
                                        "type":"integer"
                                    },
                                    "quantity":{
                                        "description":"The quantity of the product.",
                                        "type":"integer"
                                    },
                                    "rawTotalPrice":{
                                        "description":"The raw price of the product.",
                                        "type":"integer"
                                    },
                                    "productId":{
                                        "description":"ID of the product in the cart.",
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "description":"The name of the product.",
                                        "type":"string"
                                    },
                                    "giftWithPurchaseCommerceItemMarkers":{
                                        "description":"The array of giftWithPurchaseCommerceItemMarkers.",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "remainingQuantity":{
                                                    "description":"The quantity of the commerce item that is not affected by gift with purchase.",
                                                    "type":"number"
                                                },
                                                "selectedQuantity":{
                                                    "description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
                                                    "type":"number"
                                                },
                                                "data":{
                                                    "description":"The gift hash code for this gift with purchase promotion.",
                                                    "type":"integer"
                                                },
                                                "automaticQuantity":{
                                                    "description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
                                                    "type":"number"
                                                },
                                                "value":{
                                                    "description":"The gift with purchase promotion id.",
                                                    "type":"string"
                                                },
                                                "targetedQuantity":{
                                                    "description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
                                                    "type":"number"
                                                },
                                                "key":{
                                                    "description":"atg.gwp",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "active":{
                                        "description":"active or not.",
                                        "type":"boolean"
                                    },
                                    "externalPriceQuantity":{
                                        "description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
                                        "type":"integer"
                                    },
                                    "catRefId":{
                                        "description":"The category to which the product belongs.",
                                        "type":"string"
                                    },
                                    "externalPrice":{
                                        "description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
                                        "type":"number"
                                    },
                                    "skuProperties":{
                                        "description":"Sku properties Information",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "propertyType":{
                                                    "description":"Type that indicates whether it is a base or a custom SKU property,",
                                                    "type":"string"
                                                },
                                                "name":{
                                                    "description":"Name of the Dynamic SKU Property.",
                                                    "type":"string"
                                                },
                                                "id":{
                                                    "description":"ID of the Dynamic SKU Property.",
                                                    "type":"string"
                                                },
                                                "value":{
                                                    "description":"Value of the Dynamic SKU Property.",
                                                    "type":"string"
                                                }
                                            }
                                        }
                                    },
                                    "discountInfo":{
                                        "description":"The discount information.",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "promotionLevel":{
                                                    "description":"The promotion level.",
                                                    "type":"string"
                                                },
                                                "coupon":{
                                                    "description":"The coupon ID.",
                                                    "type":"string"
                                                },
                                                "totalAdjustment":{
                                                    "description":"Total adjustment by the promotion.",
                                                    "type":"number"
                                                },
                                                "promotionDesc":{
                                                    "description":"The promotion description.",
                                                    "type":"string"
                                                },
                                                "promotionId":{
                                                    "description":"The promotion ID.",
                                                    "type":"string"
                                                },
                                                "giftWithPurchaseDiscountInfo":{
                                                    "description":"The gift information.",
                                                    "type":"array",
                                                    "items":{
                                                        "type":"object",
                                                        "properties":{
                                                            "giftWithPurchaseChoicesAvailable":{
                                                                "description":"If this gift with purchase has multiple gift choices.",
                                                                "type":"boolean"
                                                            },
                                                            "giftWithPurchaseQuantity":{
                                                                "description":"The quantity that is gift quantity",
                                                                "type":"number"
                                                            },
                                                            "giftWithPurchaseIdentifier":{
                                                                "description":"The gift hash code for this gift with purchase promotion.",
                                                                "type":"integer"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "price":{
                                        "description":"The actual price of the product.",
                                        "type":"integer"
                                    },
                                    "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"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "creationDate":{
                    "description":"The creation date in ISO format.",
                    "type":"string"
                },
                "submittedDate":{
                    "description":"The order submitted date in ISO format.",
                    "type":"string"
                },
                "uuid":{
                    "description":"The unique ID for the order.",
                    "type":"string"
                },
                "orderProfileId":{
                    "description":"The profile-id of the order.",
                    "type":"string"
                },
                "paymentGroupId":{
                    "description":"The payment group ID used for the order.",
                    "type":"string"
                },
                "priceInfo":{
                    "description":"The price information.",
                    "type":"object",
                    "properties":{
                        "amount":{
                            "description":"The total order amount.",
                            "type":"number"
                        },
                        "total":{
                            "description":"The order total.",
                            "type":"number"
                        },
                        "shipping":{
                            "description":"The total shipping cost.",
                            "type":"number"
                        },
                        "shippingSurchargeValue":{
                            "description":"Extra handling costs for shipping the products.",
                            "type":"number"
                        },
                        "tax":{
                            "description":"The total tax amount.",
                            "type":"number"
                        },
                        "subTotal":{
                            "description":"Sub-total.",
                            "type":"number"
                        },
                        "currencyCode":{
                            "description":"The currency code.",
                            "type":"string"
                        }
                    }
                },
                "discountInfo":{
                    "description":"The discount information.",
                    "type":"object",
                    "properties":{
                        "unclaimedCouponMultiPromotions":{
                            "description":"The coupons that were not claimed",
                            "type":"object",
                            "properties":{
                                "couponCode":{
                                    "description":"Coupon Code, corresponding to which some promotions were not applied",
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "promotionLevel":{
                                                "description":"The promotion level.",
                                                "type":"string"
                                            },
                                            "promotionDesc":{
                                                "description":"Promotion description.",
                                                "type":"string"
                                            },
                                            "promotionId":{
                                                "description":"The Id of the promotion.",
                                                "type":"string"
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "orderCouponsMap":{
                            "description":"The coupons that were claimed.",
                            "type":"object",
                            "properties":{
                                "couponCode":{
                                    "description":"Coupon Code.",
                                    "type":"object",
                                    "properties":{
                                        "promotionLongDesc":{
                                            "description":"The description of the promotion.",
                                            "type":"string"
                                        },
                                        "promotionName":{
                                            "description":"The display name of the promotion.",
                                            "type":"string"
                                        },
                                        "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":"Total adjustment caused by the promotion.",
                                            "type":"number"
                                        },
                                        "promotionDesc":{
                                            "description":"Description of the promotion. Retained for backward compatibility.",
                                            "type":"string"
                                        },
                                        "promotionId":{
                                            "description":"The Id of the promotion.",
                                            "type":"string"
                                        }
                                    }
                                }
                            }
                        },
                        "orderDiscount":{
                            "description":"The order discount.",
                            "type":"number"
                        },
                        "shippingDiscount":{
                            "description":"The shipping discount.",
                            "type":"number"
                        },
                        "orderImplicitDiscountList":{
                            "description":"The implicit order discounts with the order.",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "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"
                                    }
                                }
                            }
                        },
                        "unclaimedCouponsMap":{
                            "description":"The unclaimed coupons with the order.",
                            "type":"object",
                            "properties":{
                                "couponCode":{
                                    "description":"Coupon Code, corresponding to which some promotions were not applied",
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "promotionLevel":{
                                                "description":"The promotion level.",
                                                "type":"string"
                                            },
                                            "promotionDesc":{
                                                "description":"Promotion description.",
                                                "type":"string"
                                            },
                                            "promotionId":{
                                                "description":"The Id of the promotion.",
                                                "type":"string"
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "claimedCouponMultiPromotions":{
                            "description":"The coupons that were claimed.",
                            "type":"object",
                            "properties":{
                                "couponCode":{
                                    "description":"Coupon Code, corresponding to which promotions were applied",
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "promotionLevel":{
                                                "description":"The promotion level.",
                                                "type":"string"
                                            },
                                            "totalAdjustment":{
                                                "description":"Total adjustment caused by the promotion.",
                                                "type":"number"
                                            },
                                            "promotionDesc":{
                                                "description":"Promotion description.",
                                                "type":"string"
                                            },
                                            "promotionId":{
                                                "description":"The Id of the promotion.",
                                                "type":"string"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "trackingInfo":{
                    "description":"Tracking Information for the Order.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "carrierName":{
                                "description":"Carrier Name for Tracking.",
                                "type":"string"
                            },
                            "carrierUrl":{
                                "description":"Carrier URL for Tracking.",
                                "type":"string"
                            },
                            "carrierId":{
                                "description":"Carrier Id for Tracking.",
                                "type":"string"
                            },
                            "trackingNumber":{
                                "description":"Tracking Number.",
                                "type":"string"
                            }
                        }
                    }
                },
                "giftWithPurchaseInfo":{
                    "description":"The gift information.",
                    "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":"integer"
                            }
                        }
                    }
                },
                "orderLocale":{
                    "description":"The locale in which order submitted.",
                    "type":"string"
                },
                "shippingAddress":{
                    "description":"The shipping address details.",
                    "type":"object",
                    "properties":{
                        "lastName":{
                            "description":"Last name.",
                            "type":"string"
                        },
                        "country":{
                            "description":"Country.",
                            "type":"string"
                        },
                        "address3":{
                            "description":"Address snippet.",
                            "type":"string"
                        },
                        "address2":{
                            "description":"Address snippet.",
                            "type":"string"
                        },
                        "city":{
                            "description":"City.",
                            "type":"string"
                        },
                        "prefix":{
                            "description":"Name prefix.",
                            "type":"string"
                        },
                        "address1":{
                            "description":"Address snippet.",
                            "type":"string"
                        },
                        "postalCode":{
                            "description":"Postal code.",
                            "type":"string"
                        },
                        "jobTitle":{
                            "description":"Job title.",
                            "type":"string"
                        },
                        "companyName":{
                            "description":"Company name.",
                            "type":"string"
                        },
                        "county":{
                            "description":"County.",
                            "type":"string"
                        },
                        "suffix":{
                            "description":"Name suffix.",
                            "type":"string"
                        },
                        "selectedCountry":{
                            "description":"Country code.",
                            "type":"string"
                        },
                        "firstName":{
                            "description":"First name.",
                            "type":"string"
                        },
                        "phoneNumber":{
                            "description":"Phone number.",
                            "type":"string"
                        },
                        "faxNumber":{
                            "description":"Fax number.",
                            "type":"string"
                        },
                        "alias":{
                            "description":"Address alias.",
                            "type":"string"
                        },
                        "middleName":{
                            "description":"Middle name.",
                            "type":"string"
                        },
                        "state":{
                            "description":"State.",
                            "type":"string"
                        },
                        "selectedState":{
                            "description":"State code.",
                            "type":"string"
                        },
                        "email":{
                            "description":"Email address.",
                            "type":"string"
                        },
                        "state_ISOCode":{
                            "description":"State ISO code.",
                            "type":"string"
                        }
                    }
                },
                "id":{
                    "description":"The order ID.",
                    "type":"string"
                },
                "billingAddress":{
                    "description":"The billing address details.",
                    "type":"object",
                    "properties":{
                        "lastName":{
                            "description":"Last name.",
                            "type":"string"
                        },
                        "country":{
                            "description":"Country.",
                            "type":"string"
                        },
                        "address3":{
                            "description":"Address snippet.",
                            "type":"string"
                        },
                        "address2":{
                            "description":"Address snippet.",
                            "type":"string"
                        },
                        "city":{
                            "description":"City.",
                            "type":"string"
                        },
                        "prefix":{
                            "description":"Name prefix.",
                            "type":"string"
                        },
                        "address1":{
                            "description":"Address snippet.",
                            "type":"string"
                        },
                        "postalCode":{
                            "description":"Postal code.",
                            "type":"string"
                        },
                        "jobTitle":{
                            "description":"Job title.",
                            "type":"string"
                        },
                        "companyName":{
                            "description":"Company name.",
                            "type":"string"
                        },
                        "county":{
                            "description":"County.",
                            "type":"string"
                        },
                        "suffix":{
                            "description":"Name suffix.",
                            "type":"string"
                        },
                        "selectedCountry":{
                            "description":"Country code.",
                            "type":"string"
                        },
                        "firstName":{
                            "description":"First name.",
                            "type":"string"
                        },
                        "phoneNumber":{
                            "description":"Phone number.",
                            "type":"string"
                        },
                        "faxNumber":{
                            "description":"Fax number.",
                            "type":"string"
                        },
                        "alias":{
                            "description":"Address alias.",
                            "type":"string"
                        },
                        "middleName":{
                            "description":"Middle name.",
                            "type":"string"
                        },
                        "state":{
                            "description":"State.",
                            "type":"string"
                        },
                        "selectedState":{
                            "description":"State code.",
                            "type":"string"
                        },
                        "email":{
                            "description":"Email address.",
                            "type":"string"
                        },
                        "state_ISOCode":{
                            "description":"State ISO code.",
                            "type":"string"
                        }
                    }
                },
                "quoteInfo":{
                    "description":"the quote information of the order",
                    "type":"object",
                    "properties":{
                        "providerNote":{
                            "description":"the provider note for the quoted order",
                            "type":"string"
                        },
                        "notes":{
                            "description":"the notes (history) for the order",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "requestDate/quoteDate/rejectionDate":{
                                        "description":"the request/quote/rejection date for the note",
                                        "type":"number"
                                    },
                                    "profileType":{
                                        "description":"the profile type of the user that requested the quote",
                                        "type":"string"
                                    },
                                    "profileId":{
                                        "description":"the profile id of the user",
                                        "type":"string"
                                    },
                                    "requesterNote/providerNote/rejectionNote":{
                                        "description":"the requester/provider/rejection note",
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "rejectionDate":{
                            "description":"rejection date of the quoted order",
                            "type":"string"
                        },
                        "requestDate":{
                            "description":"the date when the quote was requested in ISO format",
                            "type":"string"
                        },
                        "errorInfo":{
                            "description":"the array of errors, if any",
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "externalId":{
                            "description":"the external id for the quote",
                            "type":"string"
                        },
                        "rejectionNote":{
                            "description":"the rejection note for an order whose quote has been rejected by user",
                            "type":"string"
                        },
                        "quoteDate":{
                            "description":"the date the order was quoted in milliseconds",
                            "type":"number"
                        },
                        "expirationDate":{
                            "description":"the expiration date of the quoted order, if any",
                            "type":"string"
                        }
                    }
                },
                "giftWithPurchaseOrderMarkers":{
                    "description":"gift with purchase order marker information",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "quantity":{
                                "description":"The total quantity of sku for this gift selection.",
                                "type":"number"
                            },
                            "selectedQuantity":{
                                "description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
                                "type":"integer"
                            },
                            "removedQuantity":{
                                "description":"The amount of free quantity that has since been manually removed by a Shopper.",
                                "type":"number"
                            },
                            "data":{
                                "description":"Gift hash code to track which gift selection in the promotion this is.  It allows the commerce item marker to link to this one.",
                                "type":"integer"
                            },
                            "autoRemove":{
                                "description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
                                "type":"boolean"
                            },
                            "giftDetail":{
                                "description":"String identifying the free gift, usually the repository id of the gift type.",
                                "type":"string"
                            },
                            "automaticQuantity":{
                                "description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
                                "type":"number"
                            },
                            "giftType":{
                                "description":"The type of the gift. (sku, product)",
                                "type":"string"
                            },
                            "failedQuantity":{
                                "description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.",
                                "type":"number"
                            },
                            "value":{
                                "description":"The gift with purchase promotion id",
                                "type":"string"
                            },
                            "targetedQuantity":{
                                "description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
                                "type":"number"
                            },
                            "key":{
                                "description":"atg.gwp",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "profileId":{
            "description":"The profile id of the user of Scheduled order.",
            "type":"string"
        },
        "name":{
            "description":"The name of the Scheduled order.",
            "type":"string"
        },
        "nextScheduledRun":{
            "description":"The next scheduled run of the Scheduled order.",
            "type":"string"
        },
        "id":{
            "description":"The id of the Scheduled order.",
            "type":"string"
        },
        "state":{
            "description":"The status of the Scheduled order.",
            "type":"string"
        },
        "startDate":{
            "description":"The start date of the Scheduled order.",
            "type":"string"
        },
        "createDate":{
            "description":"The create date of the Scheduled order.",
            "type":"string"
        }
    }
}

Nested Schema : schedule

Type: object

The schedule of the Scheduled order.

Show Source

• daysOfWeek(optional): array daysOfWeek
  The days of week of the Scheduled order.
• delay(optional): integer
  The delay of the first scheduled run after start date of the Periodic Scheduled order in milliseconds.
• interval(optional): integer
  The interval in term of number of days of the Scheduled order.
• monthsInYear(optional): array monthsInYear
  The months in year of the Scheduled order.
• occurenceInDay(optional): integer
  The occurence in day on the Scheduled order.
• period(optional): integer
  The period of repeating of the Periodic Scheduled order in milliseconds.
• selectedDates(optional): array selectedDates
  The selected dates in a month in year for the Scheduled order.
• weeksInMonth(optional): array weeksInMonth
  The weeks in month of the Scheduled order.

{
    "description":"The schedule of the Scheduled order.",
    "type":"object",
    "properties":{
        "period":{
            "description":"The period of repeating of the Periodic Scheduled order in milliseconds.",
            "type":"integer"
        },
        "delay":{
            "description":"The delay of the first scheduled run after start date of the Periodic Scheduled order in milliseconds.",
            "type":"integer"
        },
        "selectedDates":{
            "description":"The selected dates in a month in year for the Scheduled order.",
            "type":"array",
            "items":{
                "type":"integer"
            }
        },
        "weeksInMonth":{
            "description":"The weeks in month of the Scheduled order.",
            "type":"array",
            "items":{
                "type":"integer"
            }
        },
        "interval":{
            "description":"The interval in term of number of days of the Scheduled order.",
            "type":"integer"
        },
        "monthsInYear":{
            "description":"The months in year of the Scheduled order.",
            "type":"array",
            "items":{
                "type":"integer"
            }
        },
        "daysOfWeek":{
            "description":"The days of week of the Scheduled order.",
            "type":"array",
            "items":{
                "type":"integer"
            }
        },
        "occurenceInDay":{
            "description":"The occurence in day on the Scheduled order.",
            "type":"integer"
        }
    }
}

Nested Schema : templateOrder

Type: object

The Order of the Scheduled order.

Show Source

• billingAddress(optional): object billingAddress
  The billing address details.
• creationDate(optional): string
  The creation date in ISO format.
• creationTime(optional): number
  The creation time in long seconds.
• discountInfo(optional): object discountInfo
  The discount information.
• dynamicProperties(optional): array dynamicProperties
  Read-only list of dynamic properties for the order along with meta-data.
• giftWithPurchaseInfo(optional): array giftWithPurchaseInfo
  The gift information.
• giftWithPurchaseOrderMarkers(optional): array giftWithPurchaseOrderMarkers
  gift with purchase order marker information
• id(optional): string
  The order ID.
• lastModifiedDate(optional): string
  The order recent modified date in ISO format.
• orderLocale(optional): string
  The locale in which order submitted.
• orderProfileId(optional): string
  The profile-id of the order.
• orderStatus(optional): string
  Status of the order.
• paymentGroupId(optional): string
  The payment group ID used for the order.
• payments(optional): array payments
  Payment details for the order, including additional properties specific to the payment type.
• priceInfo(optional): object priceInfo
  The price information.
• priceListGroup(optional): object priceListGroup
  The price list group object.
• quoteInfo(optional): object quoteInfo
  the quote information of the order
• shippingAddress(optional): object shippingAddress
  The shipping address details.
• shippingGroups(optional): array shippingGroups
  The shipping groups for the order.
• shippingMethod(optional): object shippingMethod
  The shipping method details for the order.
• shoppingCart/order(optional): object shoppingCart/order
  The shopping-cart or order contents of the current order.
• submittedDate(optional): string
  The order submitted date in ISO format.
• trackingInfo(optional): array trackingInfo
  Tracking Information for the Order.
• uuid(optional): string
  The unique ID for the order.

{
    "description":"The Order of the Scheduled order.",
    "type":"object",
    "properties":{
        "shippingGroups":{
            "description":"The shipping groups for the order.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "taxPriceInfo":{
                        "description":"The shipping tax price info details.",
                        "type":"object",
                        "properties":{
                            "cityTax":{
                                "description":"The shipping group subtotal.",
                                "type":"number"
                            },
                            "amount":{
                                "description":"The shipping method amount.",
                                "type":"number"
                            },
                            "valueAddedTax":{
                                "description":"The value added tax .",
                                "type":"number"
                            },
                            "countyTax":{
                                "description":"The county tax amount.",
                                "type":"number"
                            },
                            "isTaxIncluded":{
                                "description":"Flag that states whether is tax included.",
                                "type":"boolean"
                            },
                            "miscTax":{
                                "description":"The miscellaneous tax amount.",
                                "type":"string"
                            },
                            "districtTax":{
                                "description":"The shipping method applied to the order.",
                                "type":"string"
                            },
                            "stateTax":{
                                "description":"The shipping method tax amount.",
                                "type":"number"
                            },
                            "countryTax":{
                                "description":"The country tax total.",
                                "type":"number"
                            }
                        }
                    },
                    "priceInfo":{
                        "description":"The shipping group price information.",
                        "type":"object",
                        "properties":{
                            "amount":{
                                "description":"The shipping method amount.",
                                "type":"number"
                            },
                            "total":{
                                "description":"The total cost of shipping.",
                                "type":"number"
                            },
                            "shipping":{
                                "description":"The shipping amount.",
                                "type":"number"
                            },
                            "shippingSurchargeValue":{
                                "description":"The shipping surcharge value amount.",
                                "type":"number"
                            },
                            "tax":{
                                "description":"The shipping method tax amount.",
                                "type":"number"
                            },
                            "subTotal":{
                                "description":"The shipping group subtotal.",
                                "type":"number"
                            },
                            "currencyCode":{
                                "description":"The shipping method amount.",
                                "type":"string"
                            },
                            "totalWithoutTax":{
                                "description":"The shipping items total.",
                                "type":"number"
                            }
                        }
                    },
                    "discountInfo":{
                        "description":"The shipping group price information.",
                        "type":"object",
                        "properties":{
                            "orderDiscount":{
                                "description":"The orderDiscount.",
                                "type":"number"
                            },
                            "shippingDiscount":{
                                "description":"The shipping discount.",
                                "type":"number"
                            },
                            "discountDescList":{
                                "description":"The list of all the order discounts.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "promotionLevel":{
                                            "description":"The promotion level.",
                                            "type":"string"
                                        },
                                        "coupon":{
                                            "description":"The coupon code.",
                                            "type":"string"
                                        },
                                        "promotionDesc":{
                                            "description":"The promotion description.",
                                            "type":"string"
                                        },
                                        "promotionId":{
                                            "description":"The promotion id.",
                                            "type":"string"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "shipOnDate":{
                        "description":"The ship on date in ISO format.",
                        "type":"string"
                    },
                    "actualShipDate":{
                        "description":"The actual ship date in ISO format.",
                        "type":"string"
                    },
                    "shippingMethod":{
                        "description":"The shipping method details.",
                        "type":"object",
                        "properties":{
                            "shippingTax":{
                                "description":"The shipping tax.",
                                "type":"number"
                            },
                            "cost":{
                                "description":"The total cost of shipping.",
                                "type":"number"
                            },
                            "value":{
                                "description":"The shipping method applied to the order.",
                                "type":"string"
                            },
                            "shippingMethodDescription":{
                                "description":"The description of the shipping method.",
                                "type":"string"
                            }
                        }
                    },
                    "shippingGroupId":{
                        "description":"The shipping group ID.",
                        "type":"string"
                    },
                    "shippingAddress":{
                        "description":"The shipping address details.",
                        "type":"object",
                        "properties":{
                            "lastName":{
                                "description":"Last name.",
                                "type":"string"
                            },
                            "country":{
                                "description":"Country.",
                                "type":"string"
                            },
                            "address3":{
                                "description":"Address snippet.",
                                "type":"string"
                            },
                            "address2":{
                                "description":"Address snippet.",
                                "type":"string"
                            },
                            "city":{
                                "description":"City.",
                                "type":"string"
                            },
                            "prefix":{
                                "description":"Name prefix.",
                                "type":"string"
                            },
                            "address1":{
                                "description":"Address snippet.",
                                "type":"string"
                            },
                            "postalCode":{
                                "description":"Postal code.",
                                "type":"string"
                            },
                            "jobTitle":{
                                "description":"Job title.",
                                "type":"string"
                            },
                            "companyName":{
                                "description":"Company name.",
                                "type":"string"
                            },
                            "county":{
                                "description":"County.",
                                "type":"string"
                            },
                            "suffix":{
                                "description":"Name suffix.",
                                "type":"string"
                            },
                            "selectedCountry":{
                                "description":"Country code.",
                                "type":"string"
                            },
                            "firstName":{
                                "description":"First name.",
                                "type":"string"
                            },
                            "phoneNumber":{
                                "description":"Phone number.",
                                "type":"string"
                            },
                            "faxNumber":{
                                "description":"Fax number.",
                                "type":"string"
                            },
                            "alias":{
                                "description":"Address alias.",
                                "type":"string"
                            },
                            "middleName":{
                                "description":"Middle name.",
                                "type":"string"
                            },
                            "state":{
                                "description":"State.",
                                "type":"string"
                            },
                            "selectedState":{
                                "description":"State code.",
                                "type":"string"
                            },
                            "email":{
                                "description":"Email address.",
                                "type":"string"
                            },
                            "state_ISOCode":{
                                "description":"State ISO code.",
                                "type":"string"
                            }
                        }
                    },
                    "submittedDate":{
                        "description":"The submitted date in ISO format.",
                        "type":"string"
                    },
                    "trackingNumber":{
                        "description":"The tracking number.",
                        "type":"string"
                    },
                    "items":{
                        "description":"The array of products in the shipping group.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "unitPrice":{
                                    "description":"The unit price.",
                                    "type":"number"
                                },
                                "primaryImageTitle":{
                                    "description":"Primary Image Title.",
                                    "type":"string"
                                },
                                "primaryThumbImageURL":{
                                    "description":"Primary Thumb Image URL.",
                                    "type":"string"
                                },
                                "quantity":{
                                    "description":"The quantity of the product in this shipping group.",
                                    "type":"integer"
                                },
                                "productId":{
                                    "description":"ID of the product in the cart.",
                                    "type":"string"
                                },
                                "rawTotalPrice":{
                                    "description":"Raw Total Price.",
                                    "type":"string"
                                },
                                "salePrice":{
                                    "description":"Sale Price.",
                                    "type":"string"
                                },
                                "displayName":{
                                    "description":"Display Name.",
                                    "type":"string"
                                },
                                "detailedItemPriceInfo":{
                                    "description":"Detailed Item Price Information.",
                                    "type":"object",
                                    "properties":{
                                        "discounted":{
                                            "description":"Is this item discounted.",
                                            "type":"boolean"
                                        },
                                        "amount":{
                                            "description":"The amount.",
                                            "type":"number"
                                        },
                                        "quantity":{
                                            "description":"The quantity.",
                                            "type":"number"
                                        },
                                        "tax":{
                                            "description":"The tax amount.",
                                            "type":"number"
                                        },
                                        "orderDiscountShare":{
                                            "description":"The order Discount Share.",
                                            "type":"number"
                                        },
                                        "detailedUnitPrice":{
                                            "description":"Detailed Unit Price.",
                                            "type":"number"
                                        },
                                        "currencyCode":{
                                            "description":"The currency code.",
                                            "type":"string"
                                        }
                                    }
                                },
                                "shippingSurchargeValue":{
                                    "description":"shipping surcharge value.",
                                    "type":"number"
                                },
                                "discountAmount":{
                                    "description":"The discount amount.",
                                    "type":"string"
                                },
                                "active":{
                                    "description":"UIs this product active.",
                                    "type":"boolean"
                                },
                                "catRefId":{
                                    "description":"The category to which the product belongs.",
                                    "type":"string"
                                },
                                "skuProperties":{
                                    "description":"Sku properties Information",
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "propertyType":{
                                                "description":"Type that indicates whether it is a base or a custom SKU property,",
                                                "type":"string"
                                            },
                                            "name":{
                                                "description":"Name of the Dynamic SKU Property.",
                                                "type":"string"
                                            },
                                            "id":{
                                                "description":"ID of the Dynamic SKU Property.",
                                                "type":"string"
                                            },
                                            "value":{
                                                "description":"Value of the Dynamic SKU Property.",
                                                "type":"string"
                                            }
                                        }
                                    }
                                },
                                "route":{
                                    "description":"route.",
                                    "type":"string"
                                },
                                "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"
                                            }
                                        }
                                    }
                                },
                                "onSale":{
                                    "description":"Indicates whether the price is for an item that is on sale.",
                                    "type":"boolean"
                                },
                                "primaryImageAltText":{
                                    "description":"Primary Image Alternative Text.",
                                    "type":"string"
                                },
                                "listPrice":{
                                    "description":"List Price.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "status":{
                        "description":"The shipping group status.",
                        "type":"string"
                    }
                }
            }
        },
        "creationTime":{
            "description":"The creation time in long seconds.",
            "type":"number"
        },
        "lastModifiedDate":{
            "description":"The order recent modified date in ISO format.",
            "type":"string"
        },
        "dynamicProperties":{
            "description":"Read-only list of dynamic properties for the order along with meta-data.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The ID of the dynamic property.",
                        "type":"string"
                    },
                    "value":{
                        "description":"The value of the dynamic property.",
                        "type":"string"
                    }
                }
            }
        },
        "shippingMethod":{
            "description":"The shipping method details for the order.",
            "type":"object",
            "properties":{
                "cost":{
                    "description":"The total cost of shipping.",
                    "type":"number"
                },
                "value":{
                    "description":"The shipping method applied to the order.",
                    "type":"string"
                }
            }
        },
        "payments":{
            "description":"Payment details for the order, including additional properties specific to the payment type.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PONumber":{
                        "description":"Purchase order number for invoice payment. Payment type:invoice",
                        "type":"string"
                    },
                    "paymentGroupId":{
                        "description":"Payment group id.",
                        "type":"string"
                    },
                    "savedCardId":{
                        "description":"Id of the saved card associated with the payment group.",
                        "type":"string"
                    },
                    "amount":{
                        "description":"Amount authorized from the payment group.",
                        "type":"number"
                    },
                    "balance":{
                        "description":"Total available balance on the gift card.",
                        "type":"number"
                    },
                    "gatewayName":{
                        "description":"Payment gateway name. e.g. chaseCreditCard.",
                        "type":"string"
                    },
                    "giftCardNumber":{
                        "description":"Gift card number.",
                        "type":"string"
                    },
                    "paymentMethod":{
                        "description":"Payment method. e.g. physicalGiftCard/ creditCard.",
                        "type":"string"
                    },
                    "uiIntervention":{
                        "description":"This decides whether the client has to do some intervention for payment. e.g. SOP.",
                        "type":"string"
                    },
                    "isAmountRemaining":{
                        "description":"A boolean to decide if more payment can be made from this payment group.",
                        "type":"boolean"
                    },
                    "paymentState":{
                        "description":"The state of the payment group. e.g. AUTHORIZED.",
                        "type":"string"
                    },
                    "maskedCardNumber":{
                        "description":"Masked gift card number.",
                        "type":"string"
                    }
                }
            }
        },
        "orderStatus":{
            "description":"Status of the order.",
            "type":"string"
        },
        "priceListGroup":{
            "description":"The price list group object.",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository ID of the price list group.",
                    "type":"string"
                }
            }
        },
        "shoppingCart/order":{
            "description":"The shopping-cart or order contents of the current order.",
            "type":"object",
            "properties":{
                "items":{
                    "description":"The array of products in the shopping cart.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "unitPrice":{
                                "description":"The unit price of the product.",
                                "type":"integer"
                            },
                            "quantity":{
                                "description":"The quantity of the product.",
                                "type":"integer"
                            },
                            "rawTotalPrice":{
                                "description":"The raw price of the product.",
                                "type":"integer"
                            },
                            "productId":{
                                "description":"ID of the product in the cart.",
                                "type":"string"
                            },
                            "displayName":{
                                "description":"The name of the product.",
                                "type":"string"
                            },
                            "giftWithPurchaseCommerceItemMarkers":{
                                "description":"The array of giftWithPurchaseCommerceItemMarkers.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "remainingQuantity":{
                                            "description":"The quantity of the commerce item that is not affected by gift with purchase.",
                                            "type":"number"
                                        },
                                        "selectedQuantity":{
                                            "description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
                                            "type":"number"
                                        },
                                        "data":{
                                            "description":"The gift hash code for this gift with purchase promotion.",
                                            "type":"integer"
                                        },
                                        "automaticQuantity":{
                                            "description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
                                            "type":"number"
                                        },
                                        "value":{
                                            "description":"The gift with purchase promotion id.",
                                            "type":"string"
                                        },
                                        "targetedQuantity":{
                                            "description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
                                            "type":"number"
                                        },
                                        "key":{
                                            "description":"atg.gwp",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "active":{
                                "description":"active or not.",
                                "type":"boolean"
                            },
                            "externalPriceQuantity":{
                                "description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
                                "type":"integer"
                            },
                            "catRefId":{
                                "description":"The category to which the product belongs.",
                                "type":"string"
                            },
                            "externalPrice":{
                                "description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
                                "type":"number"
                            },
                            "skuProperties":{
                                "description":"Sku properties Information",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "propertyType":{
                                            "description":"Type that indicates whether it is a base or a custom SKU property,",
                                            "type":"string"
                                        },
                                        "name":{
                                            "description":"Name of the Dynamic SKU Property.",
                                            "type":"string"
                                        },
                                        "id":{
                                            "description":"ID of the Dynamic SKU Property.",
                                            "type":"string"
                                        },
                                        "value":{
                                            "description":"Value of the Dynamic SKU Property.",
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "discountInfo":{
                                "description":"The discount information.",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "promotionLevel":{
                                            "description":"The promotion level.",
                                            "type":"string"
                                        },
                                        "coupon":{
                                            "description":"The coupon ID.",
                                            "type":"string"
                                        },
                                        "totalAdjustment":{
                                            "description":"Total adjustment by the promotion.",
                                            "type":"number"
                                        },
                                        "promotionDesc":{
                                            "description":"The promotion description.",
                                            "type":"string"
                                        },
                                        "promotionId":{
                                            "description":"The promotion ID.",
                                            "type":"string"
                                        },
                                        "giftWithPurchaseDiscountInfo":{
                                            "description":"The gift information.",
                                            "type":"array",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "giftWithPurchaseChoicesAvailable":{
                                                        "description":"If this gift with purchase has multiple gift choices.",
                                                        "type":"boolean"
                                                    },
                                                    "giftWithPurchaseQuantity":{
                                                        "description":"The quantity that is gift quantity",
                                                        "type":"number"
                                                    },
                                                    "giftWithPurchaseIdentifier":{
                                                        "description":"The gift hash code for this gift with purchase promotion.",
                                                        "type":"integer"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "price":{
                                "description":"The actual price of the product.",
                                "type":"integer"
                            },
                            "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"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "creationDate":{
            "description":"The creation date in ISO format.",
            "type":"string"
        },
        "submittedDate":{
            "description":"The order submitted date in ISO format.",
            "type":"string"
        },
        "uuid":{
            "description":"The unique ID for the order.",
            "type":"string"
        },
        "orderProfileId":{
            "description":"The profile-id of the order.",
            "type":"string"
        },
        "paymentGroupId":{
            "description":"The payment group ID used for the order.",
            "type":"string"
        },
        "priceInfo":{
            "description":"The price information.",
            "type":"object",
            "properties":{
                "amount":{
                    "description":"The total order amount.",
                    "type":"number"
                },
                "total":{
                    "description":"The order total.",
                    "type":"number"
                },
                "shipping":{
                    "description":"The total shipping cost.",
                    "type":"number"
                },
                "shippingSurchargeValue":{
                    "description":"Extra handling costs for shipping the products.",
                    "type":"number"
                },
                "tax":{
                    "description":"The total tax amount.",
                    "type":"number"
                },
                "subTotal":{
                    "description":"Sub-total.",
                    "type":"number"
                },
                "currencyCode":{
                    "description":"The currency code.",
                    "type":"string"
                }
            }
        },
        "discountInfo":{
            "description":"The discount information.",
            "type":"object",
            "properties":{
                "unclaimedCouponMultiPromotions":{
                    "description":"The coupons that were not claimed",
                    "type":"object",
                    "properties":{
                        "couponCode":{
                            "description":"Coupon Code, corresponding to which some promotions were not applied",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "promotionLevel":{
                                        "description":"The promotion level.",
                                        "type":"string"
                                    },
                                    "promotionDesc":{
                                        "description":"Promotion description.",
                                        "type":"string"
                                    },
                                    "promotionId":{
                                        "description":"The Id of the promotion.",
                                        "type":"string"
                                    }
                                }
                            }
                        }
                    }
                },
                "orderCouponsMap":{
                    "description":"The coupons that were claimed.",
                    "type":"object",
                    "properties":{
                        "couponCode":{
                            "description":"Coupon Code.",
                            "type":"object",
                            "properties":{
                                "promotionLongDesc":{
                                    "description":"The description of the promotion.",
                                    "type":"string"
                                },
                                "promotionName":{
                                    "description":"The display name of the promotion.",
                                    "type":"string"
                                },
                                "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":"Total adjustment caused by the promotion.",
                                    "type":"number"
                                },
                                "promotionDesc":{
                                    "description":"Description of the promotion. Retained for backward compatibility.",
                                    "type":"string"
                                },
                                "promotionId":{
                                    "description":"The Id of the promotion.",
                                    "type":"string"
                                }
                            }
                        }
                    }
                },
                "orderDiscount":{
                    "description":"The order discount.",
                    "type":"number"
                },
                "shippingDiscount":{
                    "description":"The shipping discount.",
                    "type":"number"
                },
                "orderImplicitDiscountList":{
                    "description":"The implicit order discounts with the order.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "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"
                            }
                        }
                    }
                },
                "unclaimedCouponsMap":{
                    "description":"The unclaimed coupons with the order.",
                    "type":"object",
                    "properties":{
                        "couponCode":{
                            "description":"Coupon Code, corresponding to which some promotions were not applied",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "promotionLevel":{
                                        "description":"The promotion level.",
                                        "type":"string"
                                    },
                                    "promotionDesc":{
                                        "description":"Promotion description.",
                                        "type":"string"
                                    },
                                    "promotionId":{
                                        "description":"The Id of the promotion.",
                                        "type":"string"
                                    }
                                }
                            }
                        }
                    }
                },
                "claimedCouponMultiPromotions":{
                    "description":"The coupons that were claimed.",
                    "type":"object",
                    "properties":{
                        "couponCode":{
                            "description":"Coupon Code, corresponding to which promotions were applied",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "promotionLevel":{
                                        "description":"The promotion level.",
                                        "type":"string"
                                    },
                                    "totalAdjustment":{
                                        "description":"Total adjustment caused by the promotion.",
                                        "type":"number"
                                    },
                                    "promotionDesc":{
                                        "description":"Promotion description.",
                                        "type":"string"
                                    },
                                    "promotionId":{
                                        "description":"The Id of the promotion.",
                                        "type":"string"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "trackingInfo":{
            "description":"Tracking Information for the Order.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "carrierName":{
                        "description":"Carrier Name for Tracking.",
                        "type":"string"
                    },
                    "carrierUrl":{
                        "description":"Carrier URL for Tracking.",
                        "type":"string"
                    },
                    "carrierId":{
                        "description":"Carrier Id for Tracking.",
                        "type":"string"
                    },
                    "trackingNumber":{
                        "description":"Tracking Number.",
                        "type":"string"
                    }
                }
            }
        },
        "giftWithPurchaseInfo":{
            "description":"The gift information.",
            "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":"integer"
                    }
                }
            }
        },
        "orderLocale":{
            "description":"The locale in which order submitted.",
            "type":"string"
        },
        "shippingAddress":{
            "description":"The shipping address details.",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"Last name.",
                    "type":"string"
                },
                "country":{
                    "description":"Country.",
                    "type":"string"
                },
                "address3":{
                    "description":"Address snippet.",
                    "type":"string"
                },
                "address2":{
                    "description":"Address snippet.",
                    "type":"string"
                },
                "city":{
                    "description":"City.",
                    "type":"string"
                },
                "prefix":{
                    "description":"Name prefix.",
                    "type":"string"
                },
                "address1":{
                    "description":"Address snippet.",
                    "type":"string"
                },
                "postalCode":{
                    "description":"Postal code.",
                    "type":"string"
                },
                "jobTitle":{
                    "description":"Job title.",
                    "type":"string"
                },
                "companyName":{
                    "description":"Company name.",
                    "type":"string"
                },
                "county":{
                    "description":"County.",
                    "type":"string"
                },
                "suffix":{
                    "description":"Name suffix.",
                    "type":"string"
                },
                "selectedCountry":{
                    "description":"Country code.",
                    "type":"string"
                },
                "firstName":{
                    "description":"First name.",
                    "type":"string"
                },
                "phoneNumber":{
                    "description":"Phone number.",
                    "type":"string"
                },
                "faxNumber":{
                    "description":"Fax number.",
                    "type":"string"
                },
                "alias":{
                    "description":"Address alias.",
                    "type":"string"
                },
                "middleName":{
                    "description":"Middle name.",
                    "type":"string"
                },
                "state":{
                    "description":"State.",
                    "type":"string"
                },
                "selectedState":{
                    "description":"State code.",
                    "type":"string"
                },
                "email":{
                    "description":"Email address.",
                    "type":"string"
                },
                "state_ISOCode":{
                    "description":"State ISO code.",
                    "type":"string"
                }
            }
        },
        "id":{
            "description":"The order ID.",
            "type":"string"
        },
        "billingAddress":{
            "description":"The billing address details.",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"Last name.",
                    "type":"string"
                },
                "country":{
                    "description":"Country.",
                    "type":"string"
                },
                "address3":{
                    "description":"Address snippet.",
                    "type":"string"
                },
                "address2":{
                    "description":"Address snippet.",
                    "type":"string"
                },
                "city":{
                    "description":"City.",
                    "type":"string"
                },
                "prefix":{
                    "description":"Name prefix.",
                    "type":"string"
                },
                "address1":{
                    "description":"Address snippet.",
                    "type":"string"
                },
                "postalCode":{
                    "description":"Postal code.",
                    "type":"string"
                },
                "jobTitle":{
                    "description":"Job title.",
                    "type":"string"
                },
                "companyName":{
                    "description":"Company name.",
                    "type":"string"
                },
                "county":{
                    "description":"County.",
                    "type":"string"
                },
                "suffix":{
                    "description":"Name suffix.",
                    "type":"string"
                },
                "selectedCountry":{
                    "description":"Country code.",
                    "type":"string"
                },
                "firstName":{
                    "description":"First name.",
                    "type":"string"
                },
                "phoneNumber":{
                    "description":"Phone number.",
                    "type":"string"
                },
                "faxNumber":{
                    "description":"Fax number.",
                    "type":"string"
                },
                "alias":{
                    "description":"Address alias.",
                    "type":"string"
                },
                "middleName":{
                    "description":"Middle name.",
                    "type":"string"
                },
                "state":{
                    "description":"State.",
                    "type":"string"
                },
                "selectedState":{
                    "description":"State code.",
                    "type":"string"
                },
                "email":{
                    "description":"Email address.",
                    "type":"string"
                },
                "state_ISOCode":{
                    "description":"State ISO code.",
                    "type":"string"
                }
            }
        },
        "quoteInfo":{
            "description":"the quote information of the order",
            "type":"object",
            "properties":{
                "providerNote":{
                    "description":"the provider note for the quoted order",
                    "type":"string"
                },
                "notes":{
                    "description":"the notes (history) for the order",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "requestDate/quoteDate/rejectionDate":{
                                "description":"the request/quote/rejection date for the note",
                                "type":"number"
                            },
                            "profileType":{
                                "description":"the profile type of the user that requested the quote",
                                "type":"string"
                            },
                            "profileId":{
                                "description":"the profile id of the user",
                                "type":"string"
                            },
                            "requesterNote/providerNote/rejectionNote":{
                                "description":"the requester/provider/rejection note",
                                "type":"string"
                            }
                        }
                    }
                },
                "rejectionDate":{
                    "description":"rejection date of the quoted order",
                    "type":"string"
                },
                "requestDate":{
                    "description":"the date when the quote was requested in ISO format",
                    "type":"string"
                },
                "errorInfo":{
                    "description":"the array of errors, if any",
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "externalId":{
                    "description":"the external id for the quote",
                    "type":"string"
                },
                "rejectionNote":{
                    "description":"the rejection note for an order whose quote has been rejected by user",
                    "type":"string"
                },
                "quoteDate":{
                    "description":"the date the order was quoted in milliseconds",
                    "type":"number"
                },
                "expirationDate":{
                    "description":"the expiration date of the quoted order, if any",
                    "type":"string"
                }
            }
        },
        "giftWithPurchaseOrderMarkers":{
            "description":"gift with purchase order marker information",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "quantity":{
                        "description":"The total quantity of sku for this gift selection.",
                        "type":"number"
                    },
                    "selectedQuantity":{
                        "description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
                        "type":"integer"
                    },
                    "removedQuantity":{
                        "description":"The amount of free quantity that has since been manually removed by a Shopper.",
                        "type":"number"
                    },
                    "data":{
                        "description":"Gift hash code to track which gift selection in the promotion this is.  It allows the commerce item marker to link to this one.",
                        "type":"integer"
                    },
                    "autoRemove":{
                        "description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
                        "type":"boolean"
                    },
                    "giftDetail":{
                        "description":"String identifying the free gift, usually the repository id of the gift type.",
                        "type":"string"
                    },
                    "automaticQuantity":{
                        "description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
                        "type":"number"
                    },
                    "giftType":{
                        "description":"The type of the gift. (sku, product)",
                        "type":"string"
                    },
                    "failedQuantity":{
                        "description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.",
                        "type":"number"
                    },
                    "value":{
                        "description":"The gift with purchase promotion id",
                        "type":"string"
                    },
                    "targetedQuantity":{
                        "description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
                        "type":"number"
                    },
                    "key":{
                        "description":"atg.gwp",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : daysOfWeek

Type: array

The days of week of the Scheduled order.

Show Source

• Array of: integer

{
    "description":"The days of week of the Scheduled order.",
    "type":"array",
    "items":{
        "type":"integer"
    }
}

Nested Schema : monthsInYear

Type: array

The months in year of the Scheduled order.

Show Source

• Array of: integer

{
    "description":"The months in year of the Scheduled order.",
    "type":"array",
    "items":{
        "type":"integer"
    }
}

Nested Schema : selectedDates

Type: array

The selected dates in a month in year for the Scheduled order.

Show Source

• Array of: integer

{
    "description":"The selected dates in a month in year for the Scheduled order.",
    "type":"array",
    "items":{
        "type":"integer"
    }
}

Nested Schema : weeksInMonth

Type: array

The weeks in month of the Scheduled order.

Show Source

• Array of: integer

{
    "description":"The weeks in month of the Scheduled order.",
    "type":"array",
    "items":{
        "type":"integer"
    }
}

Nested Schema : billingAddress

Type: object

The billing address details.

Show Source

• address1(optional): string
  Address snippet.
• address2(optional): string
  Address snippet.
• address3(optional): string
  Address snippet.
• alias(optional): string
  Address alias.
• city(optional): string
  City.
• companyName(optional): string
  Company name.
• country(optional): string
  Country.
• county(optional): string
  County.
• email(optional): string
  Email address.
• faxNumber(optional): string
  Fax number.
• firstName(optional): string
  First name.
• jobTitle(optional): string
  Job title.
• lastName(optional): string
  Last name.
• middleName(optional): string
  Middle name.
• phoneNumber(optional): string
  Phone number.
• postalCode(optional): string
  Postal code.
• prefix(optional): string
  Name prefix.
• selectedCountry(optional): string
  Country code.
• selectedState(optional): string
  State code.
• state(optional): string
  State.
• state_ISOCode(optional): string
  State ISO code.
• suffix(optional): string
  Name suffix.

{
    "description":"The billing address details.",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"Last name.",
            "type":"string"
        },
        "country":{
            "description":"Country.",
            "type":"string"
        },
        "address3":{
            "description":"Address snippet.",
            "type":"string"
        },
        "address2":{
            "description":"Address snippet.",
            "type":"string"
        },
        "city":{
            "description":"City.",
            "type":"string"
        },
        "prefix":{
            "description":"Name prefix.",
            "type":"string"
        },
        "address1":{
            "description":"Address snippet.",
            "type":"string"
        },
        "postalCode":{
            "description":"Postal code.",
            "type":"string"
        },
        "jobTitle":{
            "description":"Job title.",
            "type":"string"
        },
        "companyName":{
            "description":"Company name.",
            "type":"string"
        },
        "county":{
            "description":"County.",
            "type":"string"
        },
        "suffix":{
            "description":"Name suffix.",
            "type":"string"
        },
        "selectedCountry":{
            "description":"Country code.",
            "type":"string"
        },
        "firstName":{
            "description":"First name.",
            "type":"string"
        },
        "phoneNumber":{
            "description":"Phone number.",
            "type":"string"
        },
        "faxNumber":{
            "description":"Fax number.",
            "type":"string"
        },
        "alias":{
            "description":"Address alias.",
            "type":"string"
        },
        "middleName":{
            "description":"Middle name.",
            "type":"string"
        },
        "state":{
            "description":"State.",
            "type":"string"
        },
        "selectedState":{
            "description":"State code.",
            "type":"string"
        },
        "email":{
            "description":"Email address.",
            "type":"string"
        },
        "state_ISOCode":{
            "description":"State ISO code.",
            "type":"string"
        }
    }
}

Nested Schema : discountInfo

Type: object

The discount information.

Show Source

• claimedCouponMultiPromotions(optional): object claimedCouponMultiPromotions
  The coupons that were claimed.
• orderCouponsMap(optional): object orderCouponsMap
  The coupons that were claimed.
• orderDiscount(optional): number
  The order discount.
• orderImplicitDiscountList(optional): array orderImplicitDiscountList
  The implicit order discounts with the order.
• shippingDiscount(optional): number
  The shipping discount.
• unclaimedCouponMultiPromotions(optional): object unclaimedCouponMultiPromotions
  The coupons that were not claimed
• unclaimedCouponsMap(optional): object unclaimedCouponsMap
  The unclaimed coupons with the order.

{
    "description":"The discount information.",
    "type":"object",
    "properties":{
        "unclaimedCouponMultiPromotions":{
            "description":"The coupons that were not claimed",
            "type":"object",
            "properties":{
                "couponCode":{
                    "description":"Coupon Code, corresponding to which some promotions were not applied",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "promotionLevel":{
                                "description":"The promotion level.",
                                "type":"string"
                            },
                            "promotionDesc":{
                                "description":"Promotion description.",
                                "type":"string"
                            },
                            "promotionId":{
                                "description":"The Id of the promotion.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "orderCouponsMap":{
            "description":"The coupons that were claimed.",
            "type":"object",
            "properties":{
                "couponCode":{
                    "description":"Coupon Code.",
                    "type":"object",
                    "properties":{
                        "promotionLongDesc":{
                            "description":"The description of the promotion.",
                            "type":"string"
                        },
                        "promotionName":{
                            "description":"The display name of the promotion.",
                            "type":"string"
                        },
                        "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":"Total adjustment caused by the promotion.",
                            "type":"number"
                        },
                        "promotionDesc":{
                            "description":"Description of the promotion. Retained for backward compatibility.",
                            "type":"string"
                        },
                        "promotionId":{
                            "description":"The Id of the promotion.",
                            "type":"string"
                        }
                    }
                }
            }
        },
        "orderDiscount":{
            "description":"The order discount.",
            "type":"number"
        },
        "shippingDiscount":{
            "description":"The shipping discount.",
            "type":"number"
        },
        "orderImplicitDiscountList":{
            "description":"The implicit order discounts with the order.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "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"
                    }
                }
            }
        },
        "unclaimedCouponsMap":{
            "description":"The unclaimed coupons with the order.",
            "type":"object",
            "properties":{
                "couponCode":{
                    "description":"Coupon Code, corresponding to which some promotions were not applied",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "promotionLevel":{
                                "description":"The promotion level.",
                                "type":"string"
                            },
                            "promotionDesc":{
                                "description":"Promotion description.",
                                "type":"string"
                            },
                            "promotionId":{
                                "description":"The Id of the promotion.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "claimedCouponMultiPromotions":{
            "description":"The coupons that were claimed.",
            "type":"object",
            "properties":{
                "couponCode":{
                    "description":"Coupon Code, corresponding to which promotions were applied",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "promotionLevel":{
                                "description":"The promotion level.",
                                "type":"string"
                            },
                            "totalAdjustment":{
                                "description":"Total adjustment caused by the promotion.",
                                "type":"number"
                            },
                            "promotionDesc":{
                                "description":"Promotion description.",
                                "type":"string"
                            },
                            "promotionId":{
                                "description":"The Id of the promotion.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : dynamicProperties

Type: array

Read-only list of dynamic properties for the order along with meta-data.

Show Source

• Array of: object items

{
    "description":"Read-only list of dynamic properties for the order along with meta-data.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"The ID of the dynamic property.",
                "type":"string"
            },
            "value":{
                "description":"The value of the dynamic property.",
                "type":"string"
            }
        }
    }
}

Nested Schema : giftWithPurchaseInfo

Type: array

The gift information.

Show Source

• Array of: object items

{
    "description":"The gift information.",
    "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":"integer"
            }
        }
    }
}

Nested Schema : giftWithPurchaseOrderMarkers

Type: array

gift with purchase order marker information

Show Source

• Array of: object items

{
    "description":"gift with purchase order marker information",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "quantity":{
                "description":"The total quantity of sku for this gift selection.",
                "type":"number"
            },
            "selectedQuantity":{
                "description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
                "type":"integer"
            },
            "removedQuantity":{
                "description":"The amount of free quantity that has since been manually removed by a Shopper.",
                "type":"number"
            },
            "data":{
                "description":"Gift hash code to track which gift selection in the promotion this is.  It allows the commerce item marker to link to this one.",
                "type":"integer"
            },
            "autoRemove":{
                "description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
                "type":"boolean"
            },
            "giftDetail":{
                "description":"String identifying the free gift, usually the repository id of the gift type.",
                "type":"string"
            },
            "automaticQuantity":{
                "description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
                "type":"number"
            },
            "giftType":{
                "description":"The type of the gift. (sku, product)",
                "type":"string"
            },
            "failedQuantity":{
                "description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.",
                "type":"number"
            },
            "value":{
                "description":"The gift with purchase promotion id",
                "type":"string"
            },
            "targetedQuantity":{
                "description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
                "type":"number"
            },
            "key":{
                "description":"atg.gwp",
                "type":"string"
            }
        }
    }
}

Nested Schema : payments

Type: array

Payment details for the order, including additional properties specific to the payment type.

Show Source

• Array of: object items

{
    "description":"Payment details for the order, including additional properties specific to the payment type.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PONumber":{
                "description":"Purchase order number for invoice payment. Payment type:invoice",
                "type":"string"
            },
            "paymentGroupId":{
                "description":"Payment group id.",
                "type":"string"
            },
            "savedCardId":{
                "description":"Id of the saved card associated with the payment group.",
                "type":"string"
            },
            "amount":{
                "description":"Amount authorized from the payment group.",
                "type":"number"
            },
            "balance":{
                "description":"Total available balance on the gift card.",
                "type":"number"
            },
            "gatewayName":{
                "description":"Payment gateway name. e.g. chaseCreditCard.",
                "type":"string"
            },
            "giftCardNumber":{
                "description":"Gift card number.",
                "type":"string"
            },
            "paymentMethod":{
                "description":"Payment method. e.g. physicalGiftCard/ creditCard.",
                "type":"string"
            },
            "uiIntervention":{
                "description":"This decides whether the client has to do some intervention for payment. e.g. SOP.",
                "type":"string"
            },
            "isAmountRemaining":{
                "description":"A boolean to decide if more payment can be made from this payment group.",
                "type":"boolean"
            },
            "paymentState":{
                "description":"The state of the payment group. e.g. AUTHORIZED.",
                "type":"string"
            },
            "maskedCardNumber":{
                "description":"Masked gift card number.",
                "type":"string"
            }
        }
    }
}

Nested Schema : priceInfo

Type: object

The price information.

Show Source

• amount(optional): number
  The total order amount.
• currencyCode(optional): string
  The currency code.
• shipping(optional): number
  The total shipping cost.
• shippingSurchargeValue(optional): number
  Extra handling costs for shipping the products.
• subTotal(optional): number
  Sub-total.
• tax(optional): number
  The total tax amount.
• total(optional): number
  The order total.

{
    "description":"The price information.",
    "type":"object",
    "properties":{
        "amount":{
            "description":"The total order amount.",
            "type":"number"
        },
        "total":{
            "description":"The order total.",
            "type":"number"
        },
        "shipping":{
            "description":"The total shipping cost.",
            "type":"number"
        },
        "shippingSurchargeValue":{
            "description":"Extra handling costs for shipping the products.",
            "type":"number"
        },
        "tax":{
            "description":"The total tax amount.",
            "type":"number"
        },
        "subTotal":{
            "description":"Sub-total.",
            "type":"number"
        },
        "currencyCode":{
            "description":"The currency code.",
            "type":"string"
        }
    }
}

Nested Schema : priceListGroup

Type: object

The price list group object.

Show Source

• repositoryId(optional): string
  Repository ID of the price list group.

{
    "description":"The price list group object.",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of the price list group.",
            "type":"string"
        }
    }
}

Nested Schema : quoteInfo

Type: object

the quote information of the order

Show Source

• errorInfo(optional): array errorInfo
  the array of errors, if any
• expirationDate(optional): string
  the expiration date of the quoted order, if any
• externalId(optional): string
  the external id for the quote
• notes(optional): array notes
  the notes (history) for the order
• providerNote(optional): string
  the provider note for the quoted order
• quoteDate(optional): number
  the date the order was quoted in milliseconds
• rejectionDate(optional): string
  rejection date of the quoted order
• rejectionNote(optional): string
  the rejection note for an order whose quote has been rejected by user
• requestDate(optional): string
  the date when the quote was requested in ISO format

{
    "description":"the quote information of the order",
    "type":"object",
    "properties":{
        "providerNote":{
            "description":"the provider note for the quoted order",
            "type":"string"
        },
        "notes":{
            "description":"the notes (history) for the order",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "requestDate/quoteDate/rejectionDate":{
                        "description":"the request/quote/rejection date for the note",
                        "type":"number"
                    },
                    "profileType":{
                        "description":"the profile type of the user that requested the quote",
                        "type":"string"
                    },
                    "profileId":{
                        "description":"the profile id of the user",
                        "type":"string"
                    },
                    "requesterNote/providerNote/rejectionNote":{
                        "description":"the requester/provider/rejection note",
                        "type":"string"
                    }
                }
            }
        },
        "rejectionDate":{
            "description":"rejection date of the quoted order",
            "type":"string"
        },
        "requestDate":{
            "description":"the date when the quote was requested in ISO format",
            "type":"string"
        },
        "errorInfo":{
            "description":"the array of errors, if any",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "externalId":{
            "description":"the external id for the quote",
            "type":"string"
        },
        "rejectionNote":{
            "description":"the rejection note for an order whose quote has been rejected by user",
            "type":"string"
        },
        "quoteDate":{
            "description":"the date the order was quoted in milliseconds",
            "type":"number"
        },
        "expirationDate":{
            "description":"the expiration date of the quoted order, if any",
            "type":"string"
        }
    }
}

Nested Schema : shippingAddress

Type: object

The shipping address details.

Show Source

• address1(optional): string
  Address snippet.
• address2(optional): string
  Address snippet.
• address3(optional): string
  Address snippet.
• alias(optional): string
  Address alias.
• city(optional): string
  City.
• companyName(optional): string
  Company name.
• country(optional): string
  Country.
• county(optional): string
  County.
• email(optional): string
  Email address.
• faxNumber(optional): string
  Fax number.
• firstName(optional): string
  First name.
• jobTitle(optional): string
  Job title.
• lastName(optional): string
  Last name.
• middleName(optional): string
  Middle name.
• phoneNumber(optional): string
  Phone number.
• postalCode(optional): string
  Postal code.
• prefix(optional): string
  Name prefix.
• selectedCountry(optional): string
  Country code.
• selectedState(optional): string
  State code.
• state(optional): string
  State.
• state_ISOCode(optional): string
  State ISO code.
• suffix(optional): string
  Name suffix.

{
    "description":"The shipping address details.",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"Last name.",
            "type":"string"
        },
        "country":{
            "description":"Country.",
            "type":"string"
        },
        "address3":{
            "description":"Address snippet.",
            "type":"string"
        },
        "address2":{
            "description":"Address snippet.",
            "type":"string"
        },
        "city":{
            "description":"City.",
            "type":"string"
        },
        "prefix":{
            "description":"Name prefix.",
            "type":"string"
        },
        "address1":{
            "description":"Address snippet.",
            "type":"string"
        },
        "postalCode":{
            "description":"Postal code.",
            "type":"string"
        },
        "jobTitle":{
            "description":"Job title.",
            "type":"string"
        },
        "companyName":{
            "description":"Company name.",
            "type":"string"
        },
        "county":{
            "description":"County.",
            "type":"string"
        },
        "suffix":{
            "description":"Name suffix.",
            "type":"string"
        },
        "selectedCountry":{
            "description":"Country code.",
            "type":"string"
        },
        "firstName":{
            "description":"First name.",
            "type":"string"
        },
        "phoneNumber":{
            "description":"Phone number.",
            "type":"string"
        },
        "faxNumber":{
            "description":"Fax number.",
            "type":"string"
        },
        "alias":{
            "description":"Address alias.",
            "type":"string"
        },
        "middleName":{
            "description":"Middle name.",
            "type":"string"
        },
        "state":{
            "description":"State.",
            "type":"string"
        },
        "selectedState":{
            "description":"State code.",
            "type":"string"
        },
        "email":{
            "description":"Email address.",
            "type":"string"
        },
        "state_ISOCode":{
            "description":"State ISO code.",
            "type":"string"
        }
    }
}

Nested Schema : shippingGroups

Type: array

The shipping groups for the order.

Show Source

• Array of: object items

{
    "description":"The shipping groups for the order.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "taxPriceInfo":{
                "description":"The shipping tax price info details.",
                "type":"object",
                "properties":{
                    "cityTax":{
                        "description":"The shipping group subtotal.",
                        "type":"number"
                    },
                    "amount":{
                        "description":"The shipping method amount.",
                        "type":"number"
                    },
                    "valueAddedTax":{
                        "description":"The value added tax .",
                        "type":"number"
                    },
                    "countyTax":{
                        "description":"The county tax amount.",
                        "type":"number"
                    },
                    "isTaxIncluded":{
                        "description":"Flag that states whether is tax included.",
                        "type":"boolean"
                    },
                    "miscTax":{
                        "description":"The miscellaneous tax amount.",
                        "type":"string"
                    },
                    "districtTax":{
                        "description":"The shipping method applied to the order.",
                        "type":"string"
                    },
                    "stateTax":{
                        "description":"The shipping method tax amount.",
                        "type":"number"
                    },
                    "countryTax":{
                        "description":"The country tax total.",
                        "type":"number"
                    }
                }
            },
            "priceInfo":{
                "description":"The shipping group price information.",
                "type":"object",
                "properties":{
                    "amount":{
                        "description":"The shipping method amount.",
                        "type":"number"
                    },
                    "total":{
                        "description":"The total cost of shipping.",
                        "type":"number"
                    },
                    "shipping":{
                        "description":"The shipping amount.",
                        "type":"number"
                    },
                    "shippingSurchargeValue":{
                        "description":"The shipping surcharge value amount.",
                        "type":"number"
                    },
                    "tax":{
                        "description":"The shipping method tax amount.",
                        "type":"number"
                    },
                    "subTotal":{
                        "description":"The shipping group subtotal.",
                        "type":"number"
                    },
                    "currencyCode":{
                        "description":"The shipping method amount.",
                        "type":"string"
                    },
                    "totalWithoutTax":{
                        "description":"The shipping items total.",
                        "type":"number"
                    }
                }
            },
            "discountInfo":{
                "description":"The shipping group price information.",
                "type":"object",
                "properties":{
                    "orderDiscount":{
                        "description":"The orderDiscount.",
                        "type":"number"
                    },
                    "shippingDiscount":{
                        "description":"The shipping discount.",
                        "type":"number"
                    },
                    "discountDescList":{
                        "description":"The list of all the order discounts.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "promotionLevel":{
                                    "description":"The promotion level.",
                                    "type":"string"
                                },
                                "coupon":{
                                    "description":"The coupon code.",
                                    "type":"string"
                                },
                                "promotionDesc":{
                                    "description":"The promotion description.",
                                    "type":"string"
                                },
                                "promotionId":{
                                    "description":"The promotion id.",
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            },
            "shipOnDate":{
                "description":"The ship on date in ISO format.",
                "type":"string"
            },
            "actualShipDate":{
                "description":"The actual ship date in ISO format.",
                "type":"string"
            },
            "shippingMethod":{
                "description":"The shipping method details.",
                "type":"object",
                "properties":{
                    "shippingTax":{
                        "description":"The shipping tax.",
                        "type":"number"
                    },
                    "cost":{
                        "description":"The total cost of shipping.",
                        "type":"number"
                    },
                    "value":{
                        "description":"The shipping method applied to the order.",
                        "type":"string"
                    },
                    "shippingMethodDescription":{
                        "description":"The description of the shipping method.",
                        "type":"string"
                    }
                }
            },
            "shippingGroupId":{
                "description":"The shipping group ID.",
                "type":"string"
            },
            "shippingAddress":{
                "description":"The shipping address details.",
                "type":"object",
                "properties":{
                    "lastName":{
                        "description":"Last name.",
                        "type":"string"
                    },
                    "country":{
                        "description":"Country.",
                        "type":"string"
                    },
                    "address3":{
                        "description":"Address snippet.",
                        "type":"string"
                    },
                    "address2":{
                        "description":"Address snippet.",
                        "type":"string"
                    },
                    "city":{
                        "description":"City.",
                        "type":"string"
                    },
                    "prefix":{
                        "description":"Name prefix.",
                        "type":"string"
                    },
                    "address1":{
                        "description":"Address snippet.",
                        "type":"string"
                    },
                    "postalCode":{
                        "description":"Postal code.",
                        "type":"string"
                    },
                    "jobTitle":{
                        "description":"Job title.",
                        "type":"string"
                    },
                    "companyName":{
                        "description":"Company name.",
                        "type":"string"
                    },
                    "county":{
                        "description":"County.",
                        "type":"string"
                    },
                    "suffix":{
                        "description":"Name suffix.",
                        "type":"string"
                    },
                    "selectedCountry":{
                        "description":"Country code.",
                        "type":"string"
                    },
                    "firstName":{
                        "description":"First name.",
                        "type":"string"
                    },
                    "phoneNumber":{
                        "description":"Phone number.",
                        "type":"string"
                    },
                    "faxNumber":{
                        "description":"Fax number.",
                        "type":"string"
                    },
                    "alias":{
                        "description":"Address alias.",
                        "type":"string"
                    },
                    "middleName":{
                        "description":"Middle name.",
                        "type":"string"
                    },
                    "state":{
                        "description":"State.",
                        "type":"string"
                    },
                    "selectedState":{
                        "description":"State code.",
                        "type":"string"
                    },
                    "email":{
                        "description":"Email address.",
                        "type":"string"
                    },
                    "state_ISOCode":{
                        "description":"State ISO code.",
                        "type":"string"
                    }
                }
            },
            "submittedDate":{
                "description":"The submitted date in ISO format.",
                "type":"string"
            },
            "trackingNumber":{
                "description":"The tracking number.",
                "type":"string"
            },
            "items":{
                "description":"The array of products in the shipping group.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "unitPrice":{
                            "description":"The unit price.",
                            "type":"number"
                        },
                        "primaryImageTitle":{
                            "description":"Primary Image Title.",
                            "type":"string"
                        },
                        "primaryThumbImageURL":{
                            "description":"Primary Thumb Image URL.",
                            "type":"string"
                        },
                        "quantity":{
                            "description":"The quantity of the product in this shipping group.",
                            "type":"integer"
                        },
                        "productId":{
                            "description":"ID of the product in the cart.",
                            "type":"string"
                        },
                        "rawTotalPrice":{
                            "description":"Raw Total Price.",
                            "type":"string"
                        },
                        "salePrice":{
                            "description":"Sale Price.",
                            "type":"string"
                        },
                        "displayName":{
                            "description":"Display Name.",
                            "type":"string"
                        },
                        "detailedItemPriceInfo":{
                            "description":"Detailed Item Price Information.",
                            "type":"object",
                            "properties":{
                                "discounted":{
                                    "description":"Is this item discounted.",
                                    "type":"boolean"
                                },
                                "amount":{
                                    "description":"The amount.",
                                    "type":"number"
                                },
                                "quantity":{
                                    "description":"The quantity.",
                                    "type":"number"
                                },
                                "tax":{
                                    "description":"The tax amount.",
                                    "type":"number"
                                },
                                "orderDiscountShare":{
                                    "description":"The order Discount Share.",
                                    "type":"number"
                                },
                                "detailedUnitPrice":{
                                    "description":"Detailed Unit Price.",
                                    "type":"number"
                                },
                                "currencyCode":{
                                    "description":"The currency code.",
                                    "type":"string"
                                }
                            }
                        },
                        "shippingSurchargeValue":{
                            "description":"shipping surcharge value.",
                            "type":"number"
                        },
                        "discountAmount":{
                            "description":"The discount amount.",
                            "type":"string"
                        },
                        "active":{
                            "description":"UIs this product active.",
                            "type":"boolean"
                        },
                        "catRefId":{
                            "description":"The category to which the product belongs.",
                            "type":"string"
                        },
                        "skuProperties":{
                            "description":"Sku properties Information",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "propertyType":{
                                        "description":"Type that indicates whether it is a base or a custom SKU property,",
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"Name of the Dynamic SKU Property.",
                                        "type":"string"
                                    },
                                    "id":{
                                        "description":"ID of the Dynamic SKU Property.",
                                        "type":"string"
                                    },
                                    "value":{
                                        "description":"Value of the Dynamic SKU Property.",
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "route":{
                            "description":"route.",
                            "type":"string"
                        },
                        "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"
                                    }
                                }
                            }
                        },
                        "onSale":{
                            "description":"Indicates whether the price is for an item that is on sale.",
                            "type":"boolean"
                        },
                        "primaryImageAltText":{
                            "description":"Primary Image Alternative Text.",
                            "type":"string"
                        },
                        "listPrice":{
                            "description":"List Price.",
                            "type":"string"
                        }
                    }
                }
            },
            "status":{
                "description":"The shipping group status.",
                "type":"string"
            }
        }
    }
}

Nested Schema : shippingMethod

Type: object

The shipping method details for the order.

Show Source

• cost(optional): number
  The total cost of shipping.
• value(optional): string
  The shipping method applied to the order.

{
    "description":"The shipping method details for the order.",
    "type":"object",
    "properties":{
        "cost":{
            "description":"The total cost of shipping.",
            "type":"number"
        },
        "value":{
            "description":"The shipping method applied to the order.",
            "type":"string"
        }
    }
}

Nested Schema : shoppingCart/order

Type: object

The shopping-cart or order contents of the current order.

Show Source

• items(optional): array items
  The array of products in the shopping cart.

{
    "description":"The shopping-cart or order contents of the current order.",
    "type":"object",
    "properties":{
        "items":{
            "description":"The array of products in the shopping cart.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "unitPrice":{
                        "description":"The unit price of the product.",
                        "type":"integer"
                    },
                    "quantity":{
                        "description":"The quantity of the product.",
                        "type":"integer"
                    },
                    "rawTotalPrice":{
                        "description":"The raw price of the product.",
                        "type":"integer"
                    },
                    "productId":{
                        "description":"ID of the product in the cart.",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"The name of the product.",
                        "type":"string"
                    },
                    "giftWithPurchaseCommerceItemMarkers":{
                        "description":"The array of giftWithPurchaseCommerceItemMarkers.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "remainingQuantity":{
                                    "description":"The quantity of the commerce item that is not affected by gift with purchase.",
                                    "type":"number"
                                },
                                "selectedQuantity":{
                                    "description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
                                    "type":"number"
                                },
                                "data":{
                                    "description":"The gift hash code for this gift with purchase promotion.",
                                    "type":"integer"
                                },
                                "automaticQuantity":{
                                    "description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
                                    "type":"number"
                                },
                                "value":{
                                    "description":"The gift with purchase promotion id.",
                                    "type":"string"
                                },
                                "targetedQuantity":{
                                    "description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
                                    "type":"number"
                                },
                                "key":{
                                    "description":"atg.gwp",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "active":{
                        "description":"active or not.",
                        "type":"boolean"
                    },
                    "externalPriceQuantity":{
                        "description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
                        "type":"integer"
                    },
                    "catRefId":{
                        "description":"The category to which the product belongs.",
                        "type":"string"
                    },
                    "externalPrice":{
                        "description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
                        "type":"number"
                    },
                    "skuProperties":{
                        "description":"Sku properties Information",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "propertyType":{
                                    "description":"Type that indicates whether it is a base or a custom SKU property,",
                                    "type":"string"
                                },
                                "name":{
                                    "description":"Name of the Dynamic SKU Property.",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"ID of the Dynamic SKU Property.",
                                    "type":"string"
                                },
                                "value":{
                                    "description":"Value of the Dynamic SKU Property.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "discountInfo":{
                        "description":"The discount information.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "promotionLevel":{
                                    "description":"The promotion level.",
                                    "type":"string"
                                },
                                "coupon":{
                                    "description":"The coupon ID.",
                                    "type":"string"
                                },
                                "totalAdjustment":{
                                    "description":"Total adjustment by the promotion.",
                                    "type":"number"
                                },
                                "promotionDesc":{
                                    "description":"The promotion description.",
                                    "type":"string"
                                },
                                "promotionId":{
                                    "description":"The promotion ID.",
                                    "type":"string"
                                },
                                "giftWithPurchaseDiscountInfo":{
                                    "description":"The gift information.",
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "giftWithPurchaseChoicesAvailable":{
                                                "description":"If this gift with purchase has multiple gift choices.",
                                                "type":"boolean"
                                            },
                                            "giftWithPurchaseQuantity":{
                                                "description":"The quantity that is gift quantity",
                                                "type":"number"
                                            },
                                            "giftWithPurchaseIdentifier":{
                                                "description":"The gift hash code for this gift with purchase promotion.",
                                                "type":"integer"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "price":{
                        "description":"The actual price of the product.",
                        "type":"integer"
                    },
                    "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"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : trackingInfo

Type: array

Tracking Information for the Order.

Show Source

• Array of: object items

{
    "description":"Tracking Information for the Order.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "carrierName":{
                "description":"Carrier Name for Tracking.",
                "type":"string"
            },
            "carrierUrl":{
                "description":"Carrier URL for Tracking.",
                "type":"string"
            },
            "carrierId":{
                "description":"Carrier Id for Tracking.",
                "type":"string"
            },
            "trackingNumber":{
                "description":"Tracking Number.",
                "type":"string"
            }
        }
    }
}

Nested Schema : claimedCouponMultiPromotions

Type: object

The coupons that were claimed.

Show Source

• couponCode(optional): array couponCode
  Coupon Code, corresponding to which promotions were applied

{
    "description":"The coupons that were claimed.",
    "type":"object",
    "properties":{
        "couponCode":{
            "description":"Coupon Code, corresponding to which promotions were applied",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "promotionLevel":{
                        "description":"The promotion level.",
                        "type":"string"
                    },
                    "totalAdjustment":{
                        "description":"Total adjustment caused by the promotion.",
                        "type":"number"
                    },
                    "promotionDesc":{
                        "description":"Promotion description.",
                        "type":"string"
                    },
                    "promotionId":{
                        "description":"The Id of the promotion.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : orderCouponsMap

Type: object

The coupons that were claimed.

Show Source

• couponCode(optional): object couponCode
  Coupon Code.

{
    "description":"The coupons that were claimed.",
    "type":"object",
    "properties":{
        "couponCode":{
            "description":"Coupon Code.",
            "type":"object",
            "properties":{
                "promotionLongDesc":{
                    "description":"The description of the promotion.",
                    "type":"string"
                },
                "promotionName":{
                    "description":"The display name of the promotion.",
                    "type":"string"
                },
                "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":"Total adjustment caused by the promotion.",
                    "type":"number"
                },
                "promotionDesc":{
                    "description":"Description of the promotion. Retained for backward compatibility.",
                    "type":"string"
                },
                "promotionId":{
                    "description":"The Id of the promotion.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : orderImplicitDiscountList

Type: array

The implicit order discounts with the order.

Show Source

• Array of: object items

{
    "description":"The implicit order discounts with the order.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "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 : unclaimedCouponMultiPromotions

Type: object

The coupons that were not claimed

Show Source

• couponCode(optional): array couponCode
  Coupon Code, corresponding to which some promotions were not applied

{
    "description":"The coupons that were not claimed",
    "type":"object",
    "properties":{
        "couponCode":{
            "description":"Coupon Code, corresponding to which some promotions were not applied",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "promotionLevel":{
                        "description":"The promotion level.",
                        "type":"string"
                    },
                    "promotionDesc":{
                        "description":"Promotion description.",
                        "type":"string"
                    },
                    "promotionId":{
                        "description":"The Id of the promotion.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : unclaimedCouponsMap

Type: object

The unclaimed coupons with the order.

Show Source

• couponCode(optional): array couponCode
  Coupon Code, corresponding to which some promotions were not applied

{
    "description":"The unclaimed coupons with the order.",
    "type":"object",
    "properties":{
        "couponCode":{
            "description":"Coupon Code, corresponding to which some promotions were not applied",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "promotionLevel":{
                        "description":"The promotion level.",
                        "type":"string"
                    },
                    "promotionDesc":{
                        "description":"Promotion description.",
                        "type":"string"
                    },
                    "promotionId":{
                        "description":"The Id of the promotion.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : couponCode

Type: array

Coupon Code, corresponding to which promotions were applied

Show Source

• Array of: object items

{
    "description":"Coupon Code, corresponding to which promotions were applied",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "promotionLevel":{
                "description":"The promotion level.",
                "type":"string"
            },
            "totalAdjustment":{
                "description":"Total adjustment caused by the promotion.",
                "type":"number"
            },
            "promotionDesc":{
                "description":"Promotion description.",
                "type":"string"
            },
            "promotionId":{
                "description":"The Id of the promotion.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• promotionDesc(optional): string
  Promotion description.
• promotionId(optional): string
  The Id of the promotion.
• promotionLevel(optional): string
  The promotion level.
• totalAdjustment(optional): number
  Total adjustment caused by the promotion.

{
    "type":"object",
    "properties":{
        "promotionLevel":{
            "description":"The promotion level.",
            "type":"string"
        },
        "totalAdjustment":{
            "description":"Total adjustment caused by the promotion.",
            "type":"number"
        },
        "promotionDesc":{
            "description":"Promotion description.",
            "type":"string"
        },
        "promotionId":{
            "description":"The Id of the promotion.",
            "type":"string"
        }
    }
}

Nested Schema : couponCode

Type: object

Coupon Code.

Show Source

• external(optional): boolean
  States whether this promotion was applied by an external system (only present on external promotions).
• promotionDesc(optional): string
  Description of the promotion. Retained for backward compatibility.
• promotionId(optional): string
  The Id of the promotion.
• promotionLevel(optional): string
  The promotion level.
• promotionLongDesc(optional): string
  The description of the promotion.
• promotionName(optional): string
  The display name of the promotion.
• totalAdjustment(optional): number
  Total adjustment caused by the promotion.

{
    "description":"Coupon Code.",
    "type":"object",
    "properties":{
        "promotionLongDesc":{
            "description":"The description of the promotion.",
            "type":"string"
        },
        "promotionName":{
            "description":"The display name of the promotion.",
            "type":"string"
        },
        "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":"Total adjustment caused by the promotion.",
            "type":"number"
        },
        "promotionDesc":{
            "description":"Description of the promotion. Retained for backward compatibility.",
            "type":"string"
        },
        "promotionId":{
            "description":"The Id of the promotion.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• promotionDesc(optional): string
  The promotion description.
• promotionId(optional): string
  The promotion ID.
• promotionLevel(optional): string
  The promotion level.
• totalAdjustment(optional): string
  The total adjustment.

{
    "type":"object",
    "properties":{
        "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 : couponCode

Type: array

Coupon Code, corresponding to which some promotions were not applied

Show Source

• Array of: object items

{
    "description":"Coupon Code, corresponding to which some promotions were not applied",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "promotionLevel":{
                "description":"The promotion level.",
                "type":"string"
            },
            "promotionDesc":{
                "description":"Promotion description.",
                "type":"string"
            },
            "promotionId":{
                "description":"The Id of the promotion.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• promotionDesc(optional): string
  Promotion description.
• promotionId(optional): string
  The Id of the promotion.
• promotionLevel(optional): string
  The promotion level.

{
    "type":"object",
    "properties":{
        "promotionLevel":{
            "description":"The promotion level.",
            "type":"string"
        },
        "promotionDesc":{
            "description":"Promotion description.",
            "type":"string"
        },
        "promotionId":{
            "description":"The Id of the promotion.",
            "type":"string"
        }
    }
}

Nested Schema : couponCode

Type: array

Coupon Code, corresponding to which some promotions were not applied

Show Source

• Array of: object items

{
    "description":"Coupon Code, corresponding to which some promotions were not applied",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "promotionLevel":{
                "description":"The promotion level.",
                "type":"string"
            },
            "promotionDesc":{
                "description":"Promotion description.",
                "type":"string"
            },
            "promotionId":{
                "description":"The Id of the promotion.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• promotionDesc(optional): string
  Promotion description.
• promotionId(optional): string
  The Id of the promotion.
• promotionLevel(optional): string
  The promotion level.

{
    "type":"object",
    "properties":{
        "promotionLevel":{
            "description":"The promotion level.",
            "type":"string"
        },
        "promotionDesc":{
            "description":"Promotion description.",
            "type":"string"
        },
        "promotionId":{
            "description":"The Id of the promotion.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  The ID of the dynamic property.
• value(optional): string
  The value of the dynamic property.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID of the dynamic property.",
            "type":"string"
        },
        "value":{
            "description":"The value of the dynamic property.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• giftWithPurchaseDetail(optional): string
  String identifying the free gift, usually the repository id of the gift type.
• giftWithPurchaseIdentifier(optional): integer
  An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
• giftWithPurchaseQuantityAvailableForSelection(optional): number
  gift quantity available for selection
• giftWithPurchaseType(optional): string
  The type of the gift. (sku, product)
• promotionId(optional): string
  The gift with purchase promotion id

{
    "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":"integer"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• automaticQuantity(optional): number
  The quantity of free sku for this gift selection that has already been auto added to the order.
• autoRemove(optional): boolean
  Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
• data(optional): integer
  Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
• failedQuantity(optional): number
  The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
• giftDetail(optional): string
  String identifying the free gift, usually the repository id of the gift type.
• giftType(optional): string
  The type of the gift. (sku, product)
• key(optional): string
  atg.gwp
• quantity(optional): number
  The total quantity of sku for this gift selection.
• removedQuantity(optional): number
  The amount of free quantity that has since been manually removed by a Shopper.
• selectedQuantity(optional): integer
  The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
• targetedQuantity(optional): number
  The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
• value(optional): string
  The gift with purchase promotion id

{
    "type":"object",
    "properties":{
        "quantity":{
            "description":"The total quantity of sku for this gift selection.",
            "type":"number"
        },
        "selectedQuantity":{
            "description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
            "type":"integer"
        },
        "removedQuantity":{
            "description":"The amount of free quantity that has since been manually removed by a Shopper.",
            "type":"number"
        },
        "data":{
            "description":"Gift hash code to track which gift selection in the promotion this is.  It allows the commerce item marker to link to this one.",
            "type":"integer"
        },
        "autoRemove":{
            "description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
            "type":"boolean"
        },
        "giftDetail":{
            "description":"String identifying the free gift, usually the repository id of the gift type.",
            "type":"string"
        },
        "automaticQuantity":{
            "description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
            "type":"number"
        },
        "giftType":{
            "description":"The type of the gift. (sku, product)",
            "type":"string"
        },
        "failedQuantity":{
            "description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.",
            "type":"number"
        },
        "value":{
            "description":"The gift with purchase promotion id",
            "type":"string"
        },
        "targetedQuantity":{
            "description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
            "type":"number"
        },
        "key":{
            "description":"atg.gwp",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  Amount authorized from the payment group.
• balance(optional): number
  Total available balance on the gift card.
• gatewayName(optional): string
  Payment gateway name. e.g. chaseCreditCard.
• giftCardNumber(optional): string
  Gift card number.
• isAmountRemaining(optional): boolean
  A boolean to decide if more payment can be made from this payment group.
• maskedCardNumber(optional): string
  Masked gift card number.
• paymentGroupId(optional): string
  Payment group id.
• paymentMethod(optional): string
  Payment method. e.g. physicalGiftCard/ creditCard.
• paymentState(optional): string
  The state of the payment group. e.g. AUTHORIZED.
• PONumber(optional): string
  Purchase order number for invoice payment. Payment type:invoice
• savedCardId(optional): string
  Id of the saved card associated with the payment group.
• uiIntervention(optional): string
  This decides whether the client has to do some intervention for payment. e.g. SOP.

{
    "type":"object",
    "properties":{
        "PONumber":{
            "description":"Purchase order number for invoice payment. Payment type:invoice",
            "type":"string"
        },
        "paymentGroupId":{
            "description":"Payment group id.",
            "type":"string"
        },
        "savedCardId":{
            "description":"Id of the saved card associated with the payment group.",
            "type":"string"
        },
        "amount":{
            "description":"Amount authorized from the payment group.",
            "type":"number"
        },
        "balance":{
            "description":"Total available balance on the gift card.",
            "type":"number"
        },
        "gatewayName":{
            "description":"Payment gateway name. e.g. chaseCreditCard.",
            "type":"string"
        },
        "giftCardNumber":{
            "description":"Gift card number.",
            "type":"string"
        },
        "paymentMethod":{
            "description":"Payment method. e.g. physicalGiftCard/ creditCard.",
            "type":"string"
        },
        "uiIntervention":{
            "description":"This decides whether the client has to do some intervention for payment. e.g. SOP.",
            "type":"string"
        },
        "isAmountRemaining":{
            "description":"A boolean to decide if more payment can be made from this payment group.",
            "type":"boolean"
        },
        "paymentState":{
            "description":"The state of the payment group. e.g. AUTHORIZED.",
            "type":"string"
        },
        "maskedCardNumber":{
            "description":"Masked gift card number.",
            "type":"string"
        }
    }
}

Nested Schema : errorInfo

Type: array

the array of errors, if any

Show Source

• Array of: string

{
    "description":"the array of errors, if any",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : notes

Type: array

the notes (history) for the order

Show Source

• Array of: object items

{
    "description":"the notes (history) for the order",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "requestDate/quoteDate/rejectionDate":{
                "description":"the request/quote/rejection date for the note",
                "type":"number"
            },
            "profileType":{
                "description":"the profile type of the user that requested the quote",
                "type":"string"
            },
            "profileId":{
                "description":"the profile id of the user",
                "type":"string"
            },
            "requesterNote/providerNote/rejectionNote":{
                "description":"the requester/provider/rejection note",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• profileId(optional): string
  the profile id of the user
• profileType(optional): string
  the profile type of the user that requested the quote
• requestDate/quoteDate/rejectionDate(optional): number
  the request/quote/rejection date for the note
• requesterNote/providerNote/rejectionNote(optional): string
  the requester/provider/rejection note

{
    "type":"object",
    "properties":{
        "requestDate/quoteDate/rejectionDate":{
            "description":"the request/quote/rejection date for the note",
            "type":"number"
        },
        "profileType":{
            "description":"the profile type of the user that requested the quote",
            "type":"string"
        },
        "profileId":{
            "description":"the profile id of the user",
            "type":"string"
        },
        "requesterNote/providerNote/rejectionNote":{
            "description":"the requester/provider/rejection note",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• actualShipDate(optional): string
  The actual ship date in ISO format.
• discountInfo(optional): object discountInfo
  The shipping group price information.
• items(optional): array items
  The array of products in the shipping group.
• priceInfo(optional): object priceInfo
  The shipping group price information.
• shipOnDate(optional): string
  The ship on date in ISO format.
• shippingAddress(optional): object shippingAddress
  The shipping address details.
• shippingGroupId(optional): string
  The shipping group ID.
• shippingMethod(optional): object shippingMethod
  The shipping method details.
• status(optional): string
  The shipping group status.
• submittedDate(optional): string
  The submitted date in ISO format.
• taxPriceInfo(optional): object taxPriceInfo
  The shipping tax price info details.
• trackingNumber(optional): string
  The tracking number.

{
    "type":"object",
    "properties":{
        "taxPriceInfo":{
            "description":"The shipping tax price info details.",
            "type":"object",
            "properties":{
                "cityTax":{
                    "description":"The shipping group subtotal.",
                    "type":"number"
                },
                "amount":{
                    "description":"The shipping method amount.",
                    "type":"number"
                },
                "valueAddedTax":{
                    "description":"The value added tax .",
                    "type":"number"
                },
                "countyTax":{
                    "description":"The county tax amount.",
                    "type":"number"
                },
                "isTaxIncluded":{
                    "description":"Flag that states whether is tax included.",
                    "type":"boolean"
                },
                "miscTax":{
                    "description":"The miscellaneous tax amount.",
                    "type":"string"
                },
                "districtTax":{
                    "description":"The shipping method applied to the order.",
                    "type":"string"
                },
                "stateTax":{
                    "description":"The shipping method tax amount.",
                    "type":"number"
                },
                "countryTax":{
                    "description":"The country tax total.",
                    "type":"number"
                }
            }
        },
        "priceInfo":{
            "description":"The shipping group price information.",
            "type":"object",
            "properties":{
                "amount":{
                    "description":"The shipping method amount.",
                    "type":"number"
                },
                "total":{
                    "description":"The total cost of shipping.",
                    "type":"number"
                },
                "shipping":{
                    "description":"The shipping amount.",
                    "type":"number"
                },
                "shippingSurchargeValue":{
                    "description":"The shipping surcharge value amount.",
                    "type":"number"
                },
                "tax":{
                    "description":"The shipping method tax amount.",
                    "type":"number"
                },
                "subTotal":{
                    "description":"The shipping group subtotal.",
                    "type":"number"
                },
                "currencyCode":{
                    "description":"The shipping method amount.",
                    "type":"string"
                },
                "totalWithoutTax":{
                    "description":"The shipping items total.",
                    "type":"number"
                }
            }
        },
        "discountInfo":{
            "description":"The shipping group price information.",
            "type":"object",
            "properties":{
                "orderDiscount":{
                    "description":"The orderDiscount.",
                    "type":"number"
                },
                "shippingDiscount":{
                    "description":"The shipping discount.",
                    "type":"number"
                },
                "discountDescList":{
                    "description":"The list of all the order discounts.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "promotionLevel":{
                                "description":"The promotion level.",
                                "type":"string"
                            },
                            "coupon":{
                                "description":"The coupon code.",
                                "type":"string"
                            },
                            "promotionDesc":{
                                "description":"The promotion description.",
                                "type":"string"
                            },
                            "promotionId":{
                                "description":"The promotion id.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "shipOnDate":{
            "description":"The ship on date in ISO format.",
            "type":"string"
        },
        "actualShipDate":{
            "description":"The actual ship date in ISO format.",
            "type":"string"
        },
        "shippingMethod":{
            "description":"The shipping method details.",
            "type":"object",
            "properties":{
                "shippingTax":{
                    "description":"The shipping tax.",
                    "type":"number"
                },
                "cost":{
                    "description":"The total cost of shipping.",
                    "type":"number"
                },
                "value":{
                    "description":"The shipping method applied to the order.",
                    "type":"string"
                },
                "shippingMethodDescription":{
                    "description":"The description of the shipping method.",
                    "type":"string"
                }
            }
        },
        "shippingGroupId":{
            "description":"The shipping group ID.",
            "type":"string"
        },
        "shippingAddress":{
            "description":"The shipping address details.",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"Last name.",
                    "type":"string"
                },
                "country":{
                    "description":"Country.",
                    "type":"string"
                },
                "address3":{
                    "description":"Address snippet.",
                    "type":"string"
                },
                "address2":{
                    "description":"Address snippet.",
                    "type":"string"
                },
                "city":{
                    "description":"City.",
                    "type":"string"
                },
                "prefix":{
                    "description":"Name prefix.",
                    "type":"string"
                },
                "address1":{
                    "description":"Address snippet.",
                    "type":"string"
                },
                "postalCode":{
                    "description":"Postal code.",
                    "type":"string"
                },
                "jobTitle":{
                    "description":"Job title.",
                    "type":"string"
                },
                "companyName":{
                    "description":"Company name.",
                    "type":"string"
                },
                "county":{
                    "description":"County.",
                    "type":"string"
                },
                "suffix":{
                    "description":"Name suffix.",
                    "type":"string"
                },
                "selectedCountry":{
                    "description":"Country code.",
                    "type":"string"
                },
                "firstName":{
                    "description":"First name.",
                    "type":"string"
                },
                "phoneNumber":{
                    "description":"Phone number.",
                    "type":"string"
                },
                "faxNumber":{
                    "description":"Fax number.",
                    "type":"string"
                },
                "alias":{
                    "description":"Address alias.",
                    "type":"string"
                },
                "middleName":{
                    "description":"Middle name.",
                    "type":"string"
                },
                "state":{
                    "description":"State.",
                    "type":"string"
                },
                "selectedState":{
                    "description":"State code.",
                    "type":"string"
                },
                "email":{
                    "description":"Email address.",
                    "type":"string"
                },
                "state_ISOCode":{
                    "description":"State ISO code.",
                    "type":"string"
                }
            }
        },
        "submittedDate":{
            "description":"The submitted date in ISO format.",
            "type":"string"
        },
        "trackingNumber":{
            "description":"The tracking number.",
            "type":"string"
        },
        "items":{
            "description":"The array of products in the shipping group.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "unitPrice":{
                        "description":"The unit price.",
                        "type":"number"
                    },
                    "primaryImageTitle":{
                        "description":"Primary Image Title.",
                        "type":"string"
                    },
                    "primaryThumbImageURL":{
                        "description":"Primary Thumb Image URL.",
                        "type":"string"
                    },
                    "quantity":{
                        "description":"The quantity of the product in this shipping group.",
                        "type":"integer"
                    },
                    "productId":{
                        "description":"ID of the product in the cart.",
                        "type":"string"
                    },
                    "rawTotalPrice":{
                        "description":"Raw Total Price.",
                        "type":"string"
                    },
                    "salePrice":{
                        "description":"Sale Price.",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Display Name.",
                        "type":"string"
                    },
                    "detailedItemPriceInfo":{
                        "description":"Detailed Item Price Information.",
                        "type":"object",
                        "properties":{
                            "discounted":{
                                "description":"Is this item discounted.",
                                "type":"boolean"
                            },
                            "amount":{
                                "description":"The amount.",
                                "type":"number"
                            },
                            "quantity":{
                                "description":"The quantity.",
                                "type":"number"
                            },
                            "tax":{
                                "description":"The tax amount.",
                                "type":"number"
                            },
                            "orderDiscountShare":{
                                "description":"The order Discount Share.",
                                "type":"number"
                            },
                            "detailedUnitPrice":{
                                "description":"Detailed Unit Price.",
                                "type":"number"
                            },
                            "currencyCode":{
                                "description":"The currency code.",
                                "type":"string"
                            }
                        }
                    },
                    "shippingSurchargeValue":{
                        "description":"shipping surcharge value.",
                        "type":"number"
                    },
                    "discountAmount":{
                        "description":"The discount amount.",
                        "type":"string"
                    },
                    "active":{
                        "description":"UIs this product active.",
                        "type":"boolean"
                    },
                    "catRefId":{
                        "description":"The category to which the product belongs.",
                        "type":"string"
                    },
                    "skuProperties":{
                        "description":"Sku properties Information",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "propertyType":{
                                    "description":"Type that indicates whether it is a base or a custom SKU property,",
                                    "type":"string"
                                },
                                "name":{
                                    "description":"Name of the Dynamic SKU Property.",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"ID of the Dynamic SKU Property.",
                                    "type":"string"
                                },
                                "value":{
                                    "description":"Value of the Dynamic SKU Property.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "route":{
                        "description":"route.",
                        "type":"string"
                    },
                    "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"
                                }
                            }
                        }
                    },
                    "onSale":{
                        "description":"Indicates whether the price is for an item that is on sale.",
                        "type":"boolean"
                    },
                    "primaryImageAltText":{
                        "description":"Primary Image Alternative Text.",
                        "type":"string"
                    },
                    "listPrice":{
                        "description":"List Price.",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The shipping group status.",
            "type":"string"
        }
    }
}

Nested Schema : discountInfo

Type: object

The shipping group price information.

Show Source

• discountDescList(optional): array discountDescList
  The list of all the order discounts.
• orderDiscount(optional): number
  The orderDiscount.
• shippingDiscount(optional): number
  The shipping discount.

{
    "description":"The shipping group price information.",
    "type":"object",
    "properties":{
        "orderDiscount":{
            "description":"The orderDiscount.",
            "type":"number"
        },
        "shippingDiscount":{
            "description":"The shipping discount.",
            "type":"number"
        },
        "discountDescList":{
            "description":"The list of all the order discounts.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "promotionLevel":{
                        "description":"The promotion level.",
                        "type":"string"
                    },
                    "coupon":{
                        "description":"The coupon code.",
                        "type":"string"
                    },
                    "promotionDesc":{
                        "description":"The promotion description.",
                        "type":"string"
                    },
                    "promotionId":{
                        "description":"The promotion id.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The array of products in the shipping group.

Show Source

• Array of: object items

{
    "description":"The array of products in the shipping group.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "unitPrice":{
                "description":"The unit price.",
                "type":"number"
            },
            "primaryImageTitle":{
                "description":"Primary Image Title.",
                "type":"string"
            },
            "primaryThumbImageURL":{
                "description":"Primary Thumb Image URL.",
                "type":"string"
            },
            "quantity":{
                "description":"The quantity of the product in this shipping group.",
                "type":"integer"
            },
            "productId":{
                "description":"ID of the product in the cart.",
                "type":"string"
            },
            "rawTotalPrice":{
                "description":"Raw Total Price.",
                "type":"string"
            },
            "salePrice":{
                "description":"Sale Price.",
                "type":"string"
            },
            "displayName":{
                "description":"Display Name.",
                "type":"string"
            },
            "detailedItemPriceInfo":{
                "description":"Detailed Item Price Information.",
                "type":"object",
                "properties":{
                    "discounted":{
                        "description":"Is this item discounted.",
                        "type":"boolean"
                    },
                    "amount":{
                        "description":"The amount.",
                        "type":"number"
                    },
                    "quantity":{
                        "description":"The quantity.",
                        "type":"number"
                    },
                    "tax":{
                        "description":"The tax amount.",
                        "type":"number"
                    },
                    "orderDiscountShare":{
                        "description":"The order Discount Share.",
                        "type":"number"
                    },
                    "detailedUnitPrice":{
                        "description":"Detailed Unit Price.",
                        "type":"number"
                    },
                    "currencyCode":{
                        "description":"The currency code.",
                        "type":"string"
                    }
                }
            },
            "shippingSurchargeValue":{
                "description":"shipping surcharge value.",
                "type":"number"
            },
            "discountAmount":{
                "description":"The discount amount.",
                "type":"string"
            },
            "active":{
                "description":"UIs this product active.",
                "type":"boolean"
            },
            "catRefId":{
                "description":"The category to which the product belongs.",
                "type":"string"
            },
            "skuProperties":{
                "description":"Sku properties Information",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "propertyType":{
                            "description":"Type that indicates whether it is a base or a custom SKU property,",
                            "type":"string"
                        },
                        "name":{
                            "description":"Name of the Dynamic SKU Property.",
                            "type":"string"
                        },
                        "id":{
                            "description":"ID of the Dynamic SKU Property.",
                            "type":"string"
                        },
                        "value":{
                            "description":"Value of the Dynamic SKU Property.",
                            "type":"string"
                        }
                    }
                }
            },
            "route":{
                "description":"route.",
                "type":"string"
            },
            "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"
                        }
                    }
                }
            },
            "onSale":{
                "description":"Indicates whether the price is for an item that is on sale.",
                "type":"boolean"
            },
            "primaryImageAltText":{
                "description":"Primary Image Alternative Text.",
                "type":"string"
            },
            "listPrice":{
                "description":"List Price.",
                "type":"string"
            }
        }
    }
}

Nested Schema : priceInfo

Type: object

The shipping group price information.

Show Source

• amount(optional): number
  The shipping method amount.
• currencyCode(optional): string
  The shipping method amount.
• shipping(optional): number
  The shipping amount.
• shippingSurchargeValue(optional): number
  The shipping surcharge value amount.
• subTotal(optional): number
  The shipping group subtotal.
• tax(optional): number
  The shipping method tax amount.
• total(optional): number
  The total cost of shipping.
• totalWithoutTax(optional): number
  The shipping items total.

{
    "description":"The shipping group price information.",
    "type":"object",
    "properties":{
        "amount":{
            "description":"The shipping method amount.",
            "type":"number"
        },
        "total":{
            "description":"The total cost of shipping.",
            "type":"number"
        },
        "shipping":{
            "description":"The shipping amount.",
            "type":"number"
        },
        "shippingSurchargeValue":{
            "description":"The shipping surcharge value amount.",
            "type":"number"
        },
        "tax":{
            "description":"The shipping method tax amount.",
            "type":"number"
        },
        "subTotal":{
            "description":"The shipping group subtotal.",
            "type":"number"
        },
        "currencyCode":{
            "description":"The shipping method amount.",
            "type":"string"
        },
        "totalWithoutTax":{
            "description":"The shipping items total.",
            "type":"number"
        }
    }
}

Nested Schema : shippingAddress

Type: object

The shipping address details.

Show Source

• address1(optional): string
  Address snippet.
• address2(optional): string
  Address snippet.
• address3(optional): string
  Address snippet.
• alias(optional): string
  Address alias.
• city(optional): string
  City.
• companyName(optional): string
  Company name.
• country(optional): string
  Country.
• county(optional): string
  County.
• email(optional): string
  Email address.
• faxNumber(optional): string
  Fax number.
• firstName(optional): string
  First name.
• jobTitle(optional): string
  Job title.
• lastName(optional): string
  Last name.
• middleName(optional): string
  Middle name.
• phoneNumber(optional): string
  Phone number.
• postalCode(optional): string
  Postal code.
• prefix(optional): string
  Name prefix.
• selectedCountry(optional): string
  Country code.
• selectedState(optional): string
  State code.
• state(optional): string
  State.
• state_ISOCode(optional): string
  State ISO code.
• suffix(optional): string
  Name suffix.

{
    "description":"The shipping address details.",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"Last name.",
            "type":"string"
        },
        "country":{
            "description":"Country.",
            "type":"string"
        },
        "address3":{
            "description":"Address snippet.",
            "type":"string"
        },
        "address2":{
            "description":"Address snippet.",
            "type":"string"
        },
        "city":{
            "description":"City.",
            "type":"string"
        },
        "prefix":{
            "description":"Name prefix.",
            "type":"string"
        },
        "address1":{
            "description":"Address snippet.",
            "type":"string"
        },
        "postalCode":{
            "description":"Postal code.",
            "type":"string"
        },
        "jobTitle":{
            "description":"Job title.",
            "type":"string"
        },
        "companyName":{
            "description":"Company name.",
            "type":"string"
        },
        "county":{
            "description":"County.",
            "type":"string"
        },
        "suffix":{
            "description":"Name suffix.",
            "type":"string"
        },
        "selectedCountry":{
            "description":"Country code.",
            "type":"string"
        },
        "firstName":{
            "description":"First name.",
            "type":"string"
        },
        "phoneNumber":{
            "description":"Phone number.",
            "type":"string"
        },
        "faxNumber":{
            "description":"Fax number.",
            "type":"string"
        },
        "alias":{
            "description":"Address alias.",
            "type":"string"
        },
        "middleName":{
            "description":"Middle name.",
            "type":"string"
        },
        "state":{
            "description":"State.",
            "type":"string"
        },
        "selectedState":{
            "description":"State code.",
            "type":"string"
        },
        "email":{
            "description":"Email address.",
            "type":"string"
        },
        "state_ISOCode":{
            "description":"State ISO code.",
            "type":"string"
        }
    }
}

Nested Schema : shippingMethod

Type: object

The shipping method details.

Show Source

• cost(optional): number
  The total cost of shipping.
• shippingMethodDescription(optional): string
  The description of the shipping method.
• shippingTax(optional): number
  The shipping tax.
• value(optional): string
  The shipping method applied to the order.

{
    "description":"The shipping method details.",
    "type":"object",
    "properties":{
        "shippingTax":{
            "description":"The shipping tax.",
            "type":"number"
        },
        "cost":{
            "description":"The total cost of shipping.",
            "type":"number"
        },
        "value":{
            "description":"The shipping method applied to the order.",
            "type":"string"
        },
        "shippingMethodDescription":{
            "description":"The description of the shipping method.",
            "type":"string"
        }
    }
}

Nested Schema : taxPriceInfo

Type: object

The shipping tax price info details.

Show Source

• amount(optional): number
  The shipping method amount.
• cityTax(optional): number
  The shipping group subtotal.
• countryTax(optional): number
  The country tax total.
• countyTax(optional): number
  The county tax amount.
• districtTax(optional): string
  The shipping method applied to the order.
• isTaxIncluded(optional): boolean
  Flag that states whether is tax included.
• miscTax(optional): string
  The miscellaneous tax amount.
• stateTax(optional): number
  The shipping method tax amount.
• valueAddedTax(optional): number
  The value added tax .

{
    "description":"The shipping tax price info details.",
    "type":"object",
    "properties":{
        "cityTax":{
            "description":"The shipping group subtotal.",
            "type":"number"
        },
        "amount":{
            "description":"The shipping method amount.",
            "type":"number"
        },
        "valueAddedTax":{
            "description":"The value added tax .",
            "type":"number"
        },
        "countyTax":{
            "description":"The county tax amount.",
            "type":"number"
        },
        "isTaxIncluded":{
            "description":"Flag that states whether is tax included.",
            "type":"boolean"
        },
        "miscTax":{
            "description":"The miscellaneous tax amount.",
            "type":"string"
        },
        "districtTax":{
            "description":"The shipping method applied to the order.",
            "type":"string"
        },
        "stateTax":{
            "description":"The shipping method tax amount.",
            "type":"number"
        },
        "countryTax":{
            "description":"The country tax total.",
            "type":"number"
        }
    }
}

Nested Schema : discountDescList

Type: array

The list of all the order discounts.

Show Source

• Array of: object items

{
    "description":"The list of all the order discounts.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "promotionLevel":{
                "description":"The promotion level.",
                "type":"string"
            },
            "coupon":{
                "description":"The coupon code.",
                "type":"string"
            },
            "promotionDesc":{
                "description":"The promotion description.",
                "type":"string"
            },
            "promotionId":{
                "description":"The promotion id.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• coupon(optional): string
  The coupon code.
• promotionDesc(optional): string
  The promotion description.
• promotionId(optional): string
  The promotion id.
• promotionLevel(optional): string
  The promotion level.

{
    "type":"object",
    "properties":{
        "promotionLevel":{
            "description":"The promotion level.",
            "type":"string"
        },
        "coupon":{
            "description":"The coupon code.",
            "type":"string"
        },
        "promotionDesc":{
            "description":"The promotion description.",
            "type":"string"
        },
        "promotionId":{
            "description":"The promotion id.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• active(optional): boolean
  UIs this product active.
• catRefId(optional): string
  The category to which the product belongs.
• detailedItemPriceInfo(optional): object detailedItemPriceInfo
  Detailed Item Price Information.
• discountAmount(optional): string
  The discount amount.
• displayName(optional): string
  Display Name.
• listPrice(optional): string
  List Price.
• onSale(optional): boolean
  Indicates whether the price is for an item that is on sale.
• primaryImageAltText(optional): string
  Primary Image Alternative Text.
• primaryImageTitle(optional): string
  Primary Image Title.
• primaryThumbImageURL(optional): string
  Primary Thumb Image URL.
• productId(optional): string
  ID of the product in the cart.
• quantity(optional): integer
  The quantity of the product in this shipping group.
• rawTotalPrice(optional): string
  Raw Total Price.
• route(optional): string
  route.
• salePrice(optional): string
  Sale Price.
• shippingSurchargeValue(optional): number
  shipping surcharge value.
• skuProperties(optional): array skuProperties
  Sku properties Information
• unitPrice(optional): number
  The unit price.
• variant(optional): array variant
  List of variants for the product.

{
    "type":"object",
    "properties":{
        "unitPrice":{
            "description":"The unit price.",
            "type":"number"
        },
        "primaryImageTitle":{
            "description":"Primary Image Title.",
            "type":"string"
        },
        "primaryThumbImageURL":{
            "description":"Primary Thumb Image URL.",
            "type":"string"
        },
        "quantity":{
            "description":"The quantity of the product in this shipping group.",
            "type":"integer"
        },
        "productId":{
            "description":"ID of the product in the cart.",
            "type":"string"
        },
        "rawTotalPrice":{
            "description":"Raw Total Price.",
            "type":"string"
        },
        "salePrice":{
            "description":"Sale Price.",
            "type":"string"
        },
        "displayName":{
            "description":"Display Name.",
            "type":"string"
        },
        "detailedItemPriceInfo":{
            "description":"Detailed Item Price Information.",
            "type":"object",
            "properties":{
                "discounted":{
                    "description":"Is this item discounted.",
                    "type":"boolean"
                },
                "amount":{
                    "description":"The amount.",
                    "type":"number"
                },
                "quantity":{
                    "description":"The quantity.",
                    "type":"number"
                },
                "tax":{
                    "description":"The tax amount.",
                    "type":"number"
                },
                "orderDiscountShare":{
                    "description":"The order Discount Share.",
                    "type":"number"
                },
                "detailedUnitPrice":{
                    "description":"Detailed Unit Price.",
                    "type":"number"
                },
                "currencyCode":{
                    "description":"The currency code.",
                    "type":"string"
                }
            }
        },
        "shippingSurchargeValue":{
            "description":"shipping surcharge value.",
            "type":"number"
        },
        "discountAmount":{
            "description":"The discount amount.",
            "type":"string"
        },
        "active":{
            "description":"UIs this product active.",
            "type":"boolean"
        },
        "catRefId":{
            "description":"The category to which the product belongs.",
            "type":"string"
        },
        "skuProperties":{
            "description":"Sku properties Information",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "propertyType":{
                        "description":"Type that indicates whether it is a base or a custom SKU property,",
                        "type":"string"
                    },
                    "name":{
                        "description":"Name of the Dynamic SKU Property.",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the Dynamic SKU Property.",
                        "type":"string"
                    },
                    "value":{
                        "description":"Value of the Dynamic SKU Property.",
                        "type":"string"
                    }
                }
            }
        },
        "route":{
            "description":"route.",
            "type":"string"
        },
        "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"
                    }
                }
            }
        },
        "onSale":{
            "description":"Indicates whether the price is for an item that is on sale.",
            "type":"boolean"
        },
        "primaryImageAltText":{
            "description":"Primary Image Alternative Text.",
            "type":"string"
        },
        "listPrice":{
            "description":"List Price.",
            "type":"string"
        }
    }
}

Nested Schema : detailedItemPriceInfo

Type: object

Detailed Item Price Information.

Show Source

• amount(optional): number
  The amount.
• currencyCode(optional): string
  The currency code.
• detailedUnitPrice(optional): number
  Detailed Unit Price.
• discounted(optional): boolean
  Is this item discounted.
• orderDiscountShare(optional): number
  The order Discount Share.
• quantity(optional): number
  The quantity.
• tax(optional): number
  The tax amount.

{
    "description":"Detailed Item Price Information.",
    "type":"object",
    "properties":{
        "discounted":{
            "description":"Is this item discounted.",
            "type":"boolean"
        },
        "amount":{
            "description":"The amount.",
            "type":"number"
        },
        "quantity":{
            "description":"The quantity.",
            "type":"number"
        },
        "tax":{
            "description":"The tax amount.",
            "type":"number"
        },
        "orderDiscountShare":{
            "description":"The order Discount Share.",
            "type":"number"
        },
        "detailedUnitPrice":{
            "description":"Detailed Unit Price.",
            "type":"number"
        },
        "currencyCode":{
            "description":"The currency code.",
            "type":"string"
        }
    }
}

Nested Schema : skuProperties

Type: array

Sku properties Information

Show Source

• Array of: object items

{
    "description":"Sku properties Information",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "propertyType":{
                "description":"Type that indicates whether it is a base or a custom SKU property,",
                "type":"string"
            },
            "name":{
                "description":"Name of the Dynamic SKU Property.",
                "type":"string"
            },
            "id":{
                "description":"ID of the Dynamic SKU Property.",
                "type":"string"
            },
            "value":{
                "description":"Value of the Dynamic SKU Property.",
                "type":"string"
            }
        }
    }
}

Nested Schema : variant

Type: array

List of variants for the product.

Show Source

• Array of: object items

{
    "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

• id(optional): string
  ID of the Dynamic SKU Property.
• name(optional): string
  Name of the Dynamic SKU Property.
• propertyType(optional): string
  Type that indicates whether it is a base or a custom SKU property,
• value(optional): string
  Value of the Dynamic SKU Property.

{
    "type":"object",
    "properties":{
        "propertyType":{
            "description":"Type that indicates whether it is a base or a custom SKU property,",
            "type":"string"
        },
        "name":{
            "description":"Name of the Dynamic SKU Property.",
            "type":"string"
        },
        "id":{
            "description":"ID of the Dynamic SKU Property.",
            "type":"string"
        },
        "value":{
            "description":"Value of the Dynamic SKU Property.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• optionName(optional): string
  The variant option name.
• optionValue(optional): string
  The variant option value.

{
    "type":"object",
    "properties":{
        "optionValue":{
            "description":"The variant option value.",
            "type":"string"
        },
        "optionName":{
            "description":"The variant option name.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

The array of products in the shopping cart.

Show Source

• Array of: object items

{
    "description":"The array of products in the shopping cart.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "unitPrice":{
                "description":"The unit price of the product.",
                "type":"integer"
            },
            "quantity":{
                "description":"The quantity of the product.",
                "type":"integer"
            },
            "rawTotalPrice":{
                "description":"The raw price of the product.",
                "type":"integer"
            },
            "productId":{
                "description":"ID of the product in the cart.",
                "type":"string"
            },
            "displayName":{
                "description":"The name of the product.",
                "type":"string"
            },
            "giftWithPurchaseCommerceItemMarkers":{
                "description":"The array of giftWithPurchaseCommerceItemMarkers.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "remainingQuantity":{
                            "description":"The quantity of the commerce item that is not affected by gift with purchase.",
                            "type":"number"
                        },
                        "selectedQuantity":{
                            "description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
                            "type":"number"
                        },
                        "data":{
                            "description":"The gift hash code for this gift with purchase promotion.",
                            "type":"integer"
                        },
                        "automaticQuantity":{
                            "description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
                            "type":"number"
                        },
                        "value":{
                            "description":"The gift with purchase promotion id.",
                            "type":"string"
                        },
                        "targetedQuantity":{
                            "description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
                            "type":"number"
                        },
                        "key":{
                            "description":"atg.gwp",
                            "type":"string"
                        }
                    }
                }
            },
            "active":{
                "description":"active or not.",
                "type":"boolean"
            },
            "externalPriceQuantity":{
                "description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
                "type":"integer"
            },
            "catRefId":{
                "description":"The category to which the product belongs.",
                "type":"string"
            },
            "externalPrice":{
                "description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
                "type":"number"
            },
            "skuProperties":{
                "description":"Sku properties Information",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "propertyType":{
                            "description":"Type that indicates whether it is a base or a custom SKU property,",
                            "type":"string"
                        },
                        "name":{
                            "description":"Name of the Dynamic SKU Property.",
                            "type":"string"
                        },
                        "id":{
                            "description":"ID of the Dynamic SKU Property.",
                            "type":"string"
                        },
                        "value":{
                            "description":"Value of the Dynamic SKU Property.",
                            "type":"string"
                        }
                    }
                }
            },
            "discountInfo":{
                "description":"The discount information.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "promotionLevel":{
                            "description":"The promotion level.",
                            "type":"string"
                        },
                        "coupon":{
                            "description":"The coupon ID.",
                            "type":"string"
                        },
                        "totalAdjustment":{
                            "description":"Total adjustment by the promotion.",
                            "type":"number"
                        },
                        "promotionDesc":{
                            "description":"The promotion description.",
                            "type":"string"
                        },
                        "promotionId":{
                            "description":"The promotion ID.",
                            "type":"string"
                        },
                        "giftWithPurchaseDiscountInfo":{
                            "description":"The gift information.",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "giftWithPurchaseChoicesAvailable":{
                                        "description":"If this gift with purchase has multiple gift choices.",
                                        "type":"boolean"
                                    },
                                    "giftWithPurchaseQuantity":{
                                        "description":"The quantity that is gift quantity",
                                        "type":"number"
                                    },
                                    "giftWithPurchaseIdentifier":{
                                        "description":"The gift hash code for this gift with purchase promotion.",
                                        "type":"integer"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "price":{
                "description":"The actual price of the product.",
                "type":"integer"
            },
            "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"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• active(optional): boolean
  active or not.
• catRefId(optional): string
  The category to which the product belongs.
• discountInfo(optional): array discountInfo
  The discount information.
• displayName(optional): string
  The name of the product.
• externalPrice(optional): number
  A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
• externalPriceQuantity(optional): integer
  The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
• giftWithPurchaseCommerceItemMarkers(optional): array giftWithPurchaseCommerceItemMarkers
  The array of giftWithPurchaseCommerceItemMarkers.
• price(optional): integer
  The actual price of the product.
• productId(optional): string
  ID of the product in the cart.
• quantity(optional): integer
  The quantity of the product.
• rawTotalPrice(optional): integer
  The raw price of the product.
• skuProperties(optional): array skuProperties
  Sku properties Information
• unitPrice(optional): integer
  The unit price of the product.
• variant(optional): array variant
  List of variants for the product.

{
    "type":"object",
    "properties":{
        "unitPrice":{
            "description":"The unit price of the product.",
            "type":"integer"
        },
        "quantity":{
            "description":"The quantity of the product.",
            "type":"integer"
        },
        "rawTotalPrice":{
            "description":"The raw price of the product.",
            "type":"integer"
        },
        "productId":{
            "description":"ID of the product in the cart.",
            "type":"string"
        },
        "displayName":{
            "description":"The name of the product.",
            "type":"string"
        },
        "giftWithPurchaseCommerceItemMarkers":{
            "description":"The array of giftWithPurchaseCommerceItemMarkers.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "remainingQuantity":{
                        "description":"The quantity of the commerce item that is not affected by gift with purchase.",
                        "type":"number"
                    },
                    "selectedQuantity":{
                        "description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
                        "type":"number"
                    },
                    "data":{
                        "description":"The gift hash code for this gift with purchase promotion.",
                        "type":"integer"
                    },
                    "automaticQuantity":{
                        "description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
                        "type":"number"
                    },
                    "value":{
                        "description":"The gift with purchase promotion id.",
                        "type":"string"
                    },
                    "targetedQuantity":{
                        "description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
                        "type":"number"
                    },
                    "key":{
                        "description":"atg.gwp",
                        "type":"string"
                    }
                }
            }
        },
        "active":{
            "description":"active or not.",
            "type":"boolean"
        },
        "externalPriceQuantity":{
            "description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
            "type":"integer"
        },
        "catRefId":{
            "description":"The category to which the product belongs.",
            "type":"string"
        },
        "externalPrice":{
            "description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
            "type":"number"
        },
        "skuProperties":{
            "description":"Sku properties Information",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "propertyType":{
                        "description":"Type that indicates whether it is a base or a custom SKU property,",
                        "type":"string"
                    },
                    "name":{
                        "description":"Name of the Dynamic SKU Property.",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the Dynamic SKU Property.",
                        "type":"string"
                    },
                    "value":{
                        "description":"Value of the Dynamic SKU Property.",
                        "type":"string"
                    }
                }
            }
        },
        "discountInfo":{
            "description":"The discount information.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "promotionLevel":{
                        "description":"The promotion level.",
                        "type":"string"
                    },
                    "coupon":{
                        "description":"The coupon ID.",
                        "type":"string"
                    },
                    "totalAdjustment":{
                        "description":"Total adjustment by the promotion.",
                        "type":"number"
                    },
                    "promotionDesc":{
                        "description":"The promotion description.",
                        "type":"string"
                    },
                    "promotionId":{
                        "description":"The promotion ID.",
                        "type":"string"
                    },
                    "giftWithPurchaseDiscountInfo":{
                        "description":"The gift information.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "giftWithPurchaseChoicesAvailable":{
                                    "description":"If this gift with purchase has multiple gift choices.",
                                    "type":"boolean"
                                },
                                "giftWithPurchaseQuantity":{
                                    "description":"The quantity that is gift quantity",
                                    "type":"number"
                                },
                                "giftWithPurchaseIdentifier":{
                                    "description":"The gift hash code for this gift with purchase promotion.",
                                    "type":"integer"
                                }
                            }
                        }
                    }
                }
            }
        },
        "price":{
            "description":"The actual price of the product.",
            "type":"integer"
        },
        "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"
                    }
                }
            }
        }
    }
}

Nested Schema : discountInfo

Type: array

The discount information.

Show Source

• Array of: object items

{
    "description":"The discount information.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "promotionLevel":{
                "description":"The promotion level.",
                "type":"string"
            },
            "coupon":{
                "description":"The coupon ID.",
                "type":"string"
            },
            "totalAdjustment":{
                "description":"Total adjustment by the promotion.",
                "type":"number"
            },
            "promotionDesc":{
                "description":"The promotion description.",
                "type":"string"
            },
            "promotionId":{
                "description":"The promotion ID.",
                "type":"string"
            },
            "giftWithPurchaseDiscountInfo":{
                "description":"The gift information.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "giftWithPurchaseChoicesAvailable":{
                            "description":"If this gift with purchase has multiple gift choices.",
                            "type":"boolean"
                        },
                        "giftWithPurchaseQuantity":{
                            "description":"The quantity that is gift quantity",
                            "type":"number"
                        },
                        "giftWithPurchaseIdentifier":{
                            "description":"The gift hash code for this gift with purchase promotion.",
                            "type":"integer"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : giftWithPurchaseCommerceItemMarkers

Type: array

The array of giftWithPurchaseCommerceItemMarkers.

Show Source

• Array of: object items

{
    "description":"The array of giftWithPurchaseCommerceItemMarkers.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "remainingQuantity":{
                "description":"The quantity of the commerce item that is not affected by gift with purchase.",
                "type":"number"
            },
            "selectedQuantity":{
                "description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
                "type":"number"
            },
            "data":{
                "description":"The gift hash code for this gift with purchase promotion.",
                "type":"integer"
            },
            "automaticQuantity":{
                "description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
                "type":"number"
            },
            "value":{
                "description":"The gift with purchase promotion id.",
                "type":"string"
            },
            "targetedQuantity":{
                "description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
                "type":"number"
            },
            "key":{
                "description":"atg.gwp",
                "type":"string"
            }
        }
    }
}

Nested Schema : skuProperties

Type: array

Sku properties Information

Show Source

• Array of: object items

{
    "description":"Sku properties Information",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "propertyType":{
                "description":"Type that indicates whether it is a base or a custom SKU property,",
                "type":"string"
            },
            "name":{
                "description":"Name of the Dynamic SKU Property.",
                "type":"string"
            },
            "id":{
                "description":"ID of the Dynamic SKU Property.",
                "type":"string"
            },
            "value":{
                "description":"Value of the Dynamic SKU Property.",
                "type":"string"
            }
        }
    }
}

Nested Schema : variant

Type: array

List of variants for the product.

Show Source

• Array of: object items

{
    "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

• coupon(optional): string
  The coupon ID.
• giftWithPurchaseDiscountInfo(optional): array giftWithPurchaseDiscountInfo
  The gift information.
• promotionDesc(optional): string
  The promotion description.
• promotionId(optional): string
  The promotion ID.
• promotionLevel(optional): string
  The promotion level.
• totalAdjustment(optional): number
  Total adjustment by the promotion.

{
    "type":"object",
    "properties":{
        "promotionLevel":{
            "description":"The promotion level.",
            "type":"string"
        },
        "coupon":{
            "description":"The coupon ID.",
            "type":"string"
        },
        "totalAdjustment":{
            "description":"Total adjustment by the promotion.",
            "type":"number"
        },
        "promotionDesc":{
            "description":"The promotion description.",
            "type":"string"
        },
        "promotionId":{
            "description":"The promotion ID.",
            "type":"string"
        },
        "giftWithPurchaseDiscountInfo":{
            "description":"The gift information.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "giftWithPurchaseChoicesAvailable":{
                        "description":"If this gift with purchase has multiple gift choices.",
                        "type":"boolean"
                    },
                    "giftWithPurchaseQuantity":{
                        "description":"The quantity that is gift quantity",
                        "type":"number"
                    },
                    "giftWithPurchaseIdentifier":{
                        "description":"The gift hash code for this gift with purchase promotion.",
                        "type":"integer"
                    }
                }
            }
        }
    }
}

Nested Schema : giftWithPurchaseDiscountInfo

Type: array

The gift information.

Show Source

• Array of: object items

{
    "description":"The gift information.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "giftWithPurchaseChoicesAvailable":{
                "description":"If this gift with purchase has multiple gift choices.",
                "type":"boolean"
            },
            "giftWithPurchaseQuantity":{
                "description":"The quantity that is gift quantity",
                "type":"number"
            },
            "giftWithPurchaseIdentifier":{
                "description":"The gift hash code for this gift with purchase promotion.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• giftWithPurchaseChoicesAvailable(optional): boolean
  If this gift with purchase has multiple gift choices.
• giftWithPurchaseIdentifier(optional): integer
  The gift hash code for this gift with purchase promotion.
• giftWithPurchaseQuantity(optional): number
  The quantity that is gift quantity

{
    "type":"object",
    "properties":{
        "giftWithPurchaseChoicesAvailable":{
            "description":"If this gift with purchase has multiple gift choices.",
            "type":"boolean"
        },
        "giftWithPurchaseQuantity":{
            "description":"The quantity that is gift quantity",
            "type":"number"
        },
        "giftWithPurchaseIdentifier":{
            "description":"The gift hash code for this gift with purchase promotion.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• automaticQuantity(optional): number
  The quantity of the free gift that this commerce item is making free and was auto added by pricing.
• data(optional): integer
  The gift hash code for this gift with purchase promotion.
• key(optional): string
  atg.gwp
• remainingQuantity(optional): number
  The quantity of the commerce item that is not affected by gift with purchase.
• selectedQuantity(optional): number
  The quantity of the free gift that this commerce item is making free and was selected by the shopper.
• targetedQuantity(optional): number
  The quantity of the free gift that this commerce item is making free and was targeted by pricing.
• value(optional): string
  The gift with purchase promotion id.

{
    "type":"object",
    "properties":{
        "remainingQuantity":{
            "description":"The quantity of the commerce item that is not affected by gift with purchase.",
            "type":"number"
        },
        "selectedQuantity":{
            "description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
            "type":"number"
        },
        "data":{
            "description":"The gift hash code for this gift with purchase promotion.",
            "type":"integer"
        },
        "automaticQuantity":{
            "description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
            "type":"number"
        },
        "value":{
            "description":"The gift with purchase promotion id.",
            "type":"string"
        },
        "targetedQuantity":{
            "description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
            "type":"number"
        },
        "key":{
            "description":"atg.gwp",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  ID of the Dynamic SKU Property.
• name(optional): string
  Name of the Dynamic SKU Property.
• propertyType(optional): string
  Type that indicates whether it is a base or a custom SKU property,
• value(optional): string
  Value of the Dynamic SKU Property.

{
    "type":"object",
    "properties":{
        "propertyType":{
            "description":"Type that indicates whether it is a base or a custom SKU property,",
            "type":"string"
        },
        "name":{
            "description":"Name of the Dynamic SKU Property.",
            "type":"string"
        },
        "id":{
            "description":"ID of the Dynamic SKU Property.",
            "type":"string"
        },
        "value":{
            "description":"Value of the Dynamic SKU Property.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• optionName(optional): string
  The variant option name.
• optionValue(optional): string
  The variant option value.

{
    "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

• carrierId(optional): string
  Carrier Id for Tracking.
• carrierName(optional): string
  Carrier Name for Tracking.
• carrierUrl(optional): string
  Carrier URL for Tracking.
• trackingNumber(optional): string
  Tracking Number.

{
    "type":"object",
    "properties":{
        "carrierName":{
            "description":"Carrier Name for Tracking.",
            "type":"string"
        },
        "carrierUrl":{
            "description":"Carrier URL for Tracking.",
            "type":"string"
        },
        "carrierId":{
            "description":"Carrier Id for Tracking.",
            "type":"string"
        },
        "trackingNumber":{
            "description":"Tracking Number.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "schedule":{
        "weeksInMonth":[
            "1",
            "2",
            "3"
        ],
        "monthsInYear":[
            "1",
            "2"
        ],
        "daysOfWeek":[
            "1",
            "2",
            "3"
        ]
    },
    "templateOrderId":"o10001",
    "scheduleType":"calendar",
    "endDate":"10/01/2017",
    "profileId":"user1",
    "name":"testScheduleOrder",
    "nextScheduledRun":"10/02/2015",
    "Id":"sch001",
    "state":"active",
    "startDate":"10/01/2015",
    "createDate":"9/01/2015"
}

Default Response

The error response. In case of any failure in external tax or external shipping webhooks, the errors returned in the webhook response payload get added to the errors property in this endpoint???s error response.

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top