| POST | /purchase/basket | Create Basket |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class CreateBasket
{
/**
* Brand Trigram of the intended order
*/
@ApiMember(Description="Brand Trigram of the intended order", IsRequired=true)
var brand:String? = null
/**
* Pos Code for the intended order e.g. ES03-10415-01
*/
@ApiMember(Description="Pos Code for the intended order e.g. ES03-10415-01", IsRequired=true)
var posCode:String? = null
/**
* Customer Reference
*/
@ApiMember(Description="Customer Reference", IsRequired=true)
var customerReference:String? = null
/**
* Additional Notes regarding the order
*/
@ApiMember(Description="Additional Notes regarding the order", IsRequired=true)
var notes:String? = null
/**
* List of Articles to be added in the basket
*/
@ApiMember(Description="List of Articles to be added in the basket")
var orderItems:ArrayList<BasketItem> = ArrayList<BasketItem>()
/**
* Brand Context ID
*/
@ApiMember(Description="Brand Context ID")
var boosterContextId:String? = null
}
open class BasketItem
{
/**
* Reference ID of the article/product
*/
@ApiMember(Description="Reference ID of the article/product", IsRequired=true)
var articleCode:String? = null
/**
* Desired quantity of the article
*/
@ApiMember(Description="Desired quantity of the article")
var quantity:Int? = null
/**
* Strap definition
*/
@ApiMember(Description="Strap definition")
var strap:BasketStrapItem? = null
}
open class BasketStrapItem
{
/**
* Article reference
*/
@ApiMember(Description="Article reference")
var speakingArticleCode:String? = null
/**
* Buckle type Description
*/
@ApiMember(Description="Buckle type Description")
var buckleTypeDescription:String? = null
/**
* Buckle type
*/
@ApiMember(Description="Buckle type")
var buckleTypeCode:String? = null
/**
* watch 6 Length
*/
@ApiMember(Description="watch 6 Length")
var watch6Length:Int? = null
/**
* watch 12 Length
*/
@ApiMember(Description="watch 12 Length")
var watch12Length:Int? = null
/**
* Article Material Code
*/
@ApiMember(Description="Article Material Code")
var materialCode:String? = null
/**
* Article Material Description
*/
@ApiMember(Description="Article Material Description")
var materialDescription:String? = null
/**
* Article Color Code
*/
@ApiMember(Description="Article Color Code")
var colorCode:String? = null
/**
* Article Color Description
*/
@ApiMember(Description="Article Color Description")
var colorDescription:String? = null
/**
* Buckle Witdh
*/
@ApiMember(Description="Buckle Witdh")
var buckleWidth:String? = null
/**
* Article Lining Code
*/
@ApiMember(Description="Article Lining Code")
var liningCode:String? = null
/**
* Article Lining Description
*/
@ApiMember(Description="Article Lining Description")
var liningDescription:String? = null
/**
* Article Stitching Code
*/
@ApiMember(Description="Article Stitching Code")
var stitchingCode:String? = null
/**
* Article Stitching Description
*/
@ApiMember(Description="Article Stitching Description")
var stitchingDescription:String? = null
/**
* Article Edge Code
*/
@ApiMember(Description="Article Edge Code")
var edgeCode:String? = null
/**
* Article Edge Description
*/
@ApiMember(Description="Article Edge Description")
var edgeDescription:String? = null
/**
* Article Padding Code
*/
@ApiMember(Description="Article Padding Code")
var paddingCode:String? = null
/**
* Article Padding Description
*/
@ApiMember(Description="Article Padding Description")
var paddingDescription:String? = null
/**
* Article Speciality Code
*/
@ApiMember(Description="Article Speciality Code")
var specialtyCode:String? = null
/**
* Article Speciality Description
*/
@ApiMember(Description="Article Speciality Description")
var specialtyDescription:String? = null
/**
* Nuancier Code
*/
@ApiMember(Description="Nuancier Code")
var nuancierCode:String? = null
/**
* Strap Vip Order
*/
@ApiMember(Description="Strap Vip Order")
var isStrapVipOrder:Boolean? = null
}
open class CreateBasketResponse
{
/**
* ID of the newly created Purchase Order / Basket
*/
@ApiMember(Description="ID of the newly created Purchase Order / Basket", IsRequired=true)
var purchaseOrderId:Int? = null
/**
* Validation results of each basket item
*/
@ApiMember(Description="Validation results of each basket item")
var validationResults:ArrayList<BasketItemResponse> = ArrayList<BasketItemResponse>()
}
open class BasketItemResponse
{
/**
* Line number of the article
*/
@ApiMember(Description="Line number of the article")
var line:Int? = null
/**
* Reference ID of the article/product
*/
@ApiMember(Description="Reference ID of the article/product")
var articleCode:String? = null
/**
* Old reference ID of the article/product
*/
@ApiMember(Description="Old reference ID of the article/product")
var oldArticleCode:String? = null
/**
* Quantity of the article
*/
@ApiMember(Description="Quantity of the article")
var quantity:Int? = null
/**
* Delivery date of the article
*/
@ApiMember(Description="Delivery date of the article")
var deliveryDate:Date? = null
/**
* Strap definition
*/
@ApiMember(Description="Strap definition")
var strap:BasketStrapItem? = null
/**
* Errors for the article
*/
@ApiMember(Description="Errors for the article")
var errors:ArrayList<String> = ArrayList<String>()
/**
* Warnings for the article
*/
@ApiMember(Description="Warnings for the article")
var warnings:ArrayList<String> = ArrayList<String>()
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /purchase/basket HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateBasket xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Purchase.ServiceModel">
<boosterContextId>String</boosterContextId>
<brand>String</brand>
<customerReference>String</customerReference>
<notes>String</notes>
<orderItems>
<BasketItem>
<articleCode>String</articleCode>
<quantity>0</quantity>
<strap xmlns:d4p1="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Purchase.ServiceModel.SharedModels">
<d4p1:buckleTypeCode>String</d4p1:buckleTypeCode>
<d4p1:buckleTypeDescription>String</d4p1:buckleTypeDescription>
<d4p1:buckleWidth>String</d4p1:buckleWidth>
<d4p1:colorCode>String</d4p1:colorCode>
<d4p1:colorDescription>String</d4p1:colorDescription>
<d4p1:edgeCode>String</d4p1:edgeCode>
<d4p1:edgeDescription>String</d4p1:edgeDescription>
<d4p1:isStrapVipOrder>false</d4p1:isStrapVipOrder>
<d4p1:liningCode>String</d4p1:liningCode>
<d4p1:liningDescription>String</d4p1:liningDescription>
<d4p1:materialCode>String</d4p1:materialCode>
<d4p1:materialDescription>String</d4p1:materialDescription>
<d4p1:nuancierCode>String</d4p1:nuancierCode>
<d4p1:paddingCode>String</d4p1:paddingCode>
<d4p1:paddingDescription>String</d4p1:paddingDescription>
<d4p1:speakingArticleCode>String</d4p1:speakingArticleCode>
<d4p1:specialtyCode>String</d4p1:specialtyCode>
<d4p1:specialtyDescription>String</d4p1:specialtyDescription>
<d4p1:stitchingCode>String</d4p1:stitchingCode>
<d4p1:stitchingDescription>String</d4p1:stitchingDescription>
<d4p1:watch12Length>0</d4p1:watch12Length>
<d4p1:watch6Length>0</d4p1:watch6Length>
</strap>
</BasketItem>
</orderItems>
<posCode>String</posCode>
</CreateBasket>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CreateBasketResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Purchase.ServiceModel">
<purchaseOrderId>0</purchaseOrderId>
<validationResults>
<BasketItemResponse>
<articleCode>String</articleCode>
<deliveryDate>0001-01-01T00:00:00</deliveryDate>
<errors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</errors>
<line>0</line>
<oldArticleCode>String</oldArticleCode>
<quantity>0</quantity>
<strap xmlns:d4p1="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Purchase.ServiceModel.SharedModels">
<d4p1:buckleTypeCode>String</d4p1:buckleTypeCode>
<d4p1:buckleTypeDescription>String</d4p1:buckleTypeDescription>
<d4p1:buckleWidth>String</d4p1:buckleWidth>
<d4p1:colorCode>String</d4p1:colorCode>
<d4p1:colorDescription>String</d4p1:colorDescription>
<d4p1:edgeCode>String</d4p1:edgeCode>
<d4p1:edgeDescription>String</d4p1:edgeDescription>
<d4p1:isStrapVipOrder>false</d4p1:isStrapVipOrder>
<d4p1:liningCode>String</d4p1:liningCode>
<d4p1:liningDescription>String</d4p1:liningDescription>
<d4p1:materialCode>String</d4p1:materialCode>
<d4p1:materialDescription>String</d4p1:materialDescription>
<d4p1:nuancierCode>String</d4p1:nuancierCode>
<d4p1:paddingCode>String</d4p1:paddingCode>
<d4p1:paddingDescription>String</d4p1:paddingDescription>
<d4p1:speakingArticleCode>String</d4p1:speakingArticleCode>
<d4p1:specialtyCode>String</d4p1:specialtyCode>
<d4p1:specialtyDescription>String</d4p1:specialtyDescription>
<d4p1:stitchingCode>String</d4p1:stitchingCode>
<d4p1:stitchingDescription>String</d4p1:stitchingDescription>
<d4p1:watch12Length>0</d4p1:watch12Length>
<d4p1:watch6Length>0</d4p1:watch6Length>
</strap>
<warnings xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</warnings>
</BasketItemResponse>
</validationResults>
</CreateBasketResponse>