Sync Order Updates With Persistence
1 min
PUT
https://api.upstartcommerce.com/v1/order/{orderId}/sync-order/{sequenceNo}
Path Parameters
- orderIdstring<uuid>requiredDescriptionFormatuuid
- sequenceNointeger<int32>requiredDescriptionFormatint32
Header Parameters
- x-upstart-tenantstringrequiredDescription
Body Parameters
- bodyOrderDatarequiredDescription
- currencystringrequired
- distanceUnitDistanceUnitsrequiredDescription
- itemsOrderItem[]
- catalogItemCatalogItemSummary
- idstringrequired
- siteIdsstring[]requiredDescription
- activationDatestring<date-time>DescriptionFormatdate-time
- archivedbooleanDescriptionDefaultfalse
- avgRatingnumber<float>ExampleDescriptionFormatfloat
- avgGroupRatingnumber<double>Formatdouble
- numGroupReviewsinteger
- productPopularitynumber<double>Formatdouble
- excludesClearanceItemsboolean
- brandNamestringExampleDescription
- deactivationDatestring<date-time>DescriptionFormatdate-time
- dynamicPropertiesobjectrequiredDescription
- hiddenbooleanrequiredDescriptionDefaultfalse
- ignoreInventorybooleanrequiredDescriptionDefaultfalse
- liveDatestring<date-time>DescriptionFormatdate-time
- manufacturerNamestringExampleDescription
- mediamap<string, MediaValue>Description
- modifiedDatestring<date-time>DescriptionFormatdate-time
- namestringrequiredExampleDescription
- numReviewsinteger<int32>ExampleDescriptionFormatint32
- offeredStandardWarrantyDrupalTermsAndConditions
- serviceQualificationServiceQualificationDescription
- eligibleProductIdsstring[]Description
- eligibleShippingMethodIdsstring[]Description
- productItemsSkuItemSummary[]
- relatedIdsstring[]requiredDescription
- seoSeo
- pageTitlestring
- descriptionstring
- metaKeywordsstring[]
- shippingMethodIdsstring[]requiredExample
[ "6A883710-0E0A-47ED-8DFE-7CCDBAC8F2C0", "B7E96644-DBCB-4608-B882-010DDCF9E70F" ]
Description - subVersioninteger
- tagsstring[]Example
[ "Men's", "Shirts", "Blue" ]
Description - taxCodestringExampleDescription
- typestring<product | protectionPlan | service | warranty | fee | bundle>requiredDescriptionAllowedproductprotectionPlanservicewarrantyfeebundle
- typeIdstring<uuid>requiredFormatuuid
- typeNamestringrequiredExampleDescription
- versioninteger<int32>requiredExampleDescriptionDefault0Formatint32
- catalogItemIdstringrequired
- catalogItemTypestring<bundle | product | protectionPlan | service | warranty | fee>requiredAllowedbundleproductprotectionPlanservicewarrantyfee
- idstring<uuid>Formatuuid
- pricingOrderItemPricingrequired
- basePriceBasePrice
- listPricenumberrequired
- pricenumberrequired
- typestringrequired
- zonestringrequired
- feePriceAdjustmentsFeePriceAdjustment[]required
- baseValuenumberrequired
- descriptionstring
- idstringrequired
- namestringrequired
- quantityinteger<int32>requiredFormatint32
- valuenumberrequired
- promotionPriceAdjustmentsPromotionPriceAdjustment[]requiredDescription
- descriptionstringDescription
- namestringDescription
- idstring<uuid>requiredDescriptionFormatuuid
- valuenumberrequiredDescription
- taxPriceAdjustmentTaxPriceAdjustment
- taxCodestringrequired
- valuenumber
- taxPriceAdjustmentTaxPriceAdjustment
- taxCodestringrequired
- valuenumber
- productItemSkuIdstringrequired
- promotionIdstring
- quantityinteger<int32>requiredFormatint32
- shipmentIdstring<uuid>Formatuuid
- quoteIdinteger
- targetItemIdsstring[]Description
- targetShipmentIdsstring[]DescriptionDefault
- statestring<Valid | Canceled>requiredAllowedValidCanceled
- locationIdstring
- timeZoneOffsetinteger<int32>Formatint32
- haulAwayRequestednumber
- couponsOrderCoupon[]
- idstringrequiredDescription
- appliedbooleanrequiredDescriptionDefaultfalse
- applyStatusstringDescription
- promotionIdstring<uuid>DescriptionFormatuuid
- returnPolicyQualificationsOrderReturnPolicyQualification[]
- idstring<uuid>requiredFormatuuid
- namestringrequired
- groupQualificationsOrderReturnPolicyGroupQualification[]required
- namestringrequiredDescription
- triggeringItemIdsstring[]requiredDescription
- qualifyingItemIdsstring[]requiredDescription
- qualifyingSubjectsReturnPolicySubject[]requiredDescription
- ReturnPolicyProduct
- idstringrequired
- ReturnPolicySku
- idstringrequired
- skuIdstringrequired
- qualificationResultOrderReturnPolicyQualificationResultrequired
- Qualified
- triggeredMessagestringrequired
- NotQualified
- triggeredMessagestringrequired
- unqualifiedMessagestringrequiredDescription
- shippingCoordinatesCoordinatesDescription
- latitudenumberrequiredMinimum-90Maximum90
- longitudenumberrequiredMinimum-180Maximum180
- shippingAddressAddressDescription
- street1stringrequired
- street2string
- citystringrequired
- countystring
- stateOrRegionstringrequired
- countrystringrequiredDescriptionMin Length2Max Length2
- postalCodestringrequired
- poBoxbooleanrequiredDefaultfalse
- nameName
- firststringrequiredExampleDescription
- laststringrequiredExampleDescription
- middleInitialstringExampleDescription
- salutationstringExampleDescription
- suffixstringExampleDescription
- businessNamestring
- phoneNumberstring
- billingAddressAddressDescription
- street1stringrequired
- street2string
- citystringrequired
- countystring
- stateOrRegionstringrequired
- countrystringrequiredDescriptionMin Length2Max Length2
- postalCodestringrequired
- poBoxbooleanrequiredDefaultfalse
- nameName
- firststringrequiredExampleDescription
- laststringrequiredExampleDescription
- middleInitialstringExampleDescription
- salutationstringExampleDescription
- suffixstringExampleDescription
- businessNamestring
- phoneNumberstring
- shipmentsOrderShipment[]
- idstring<uuid>Formatuuid
- stateShipmentStateEnumrequiredDescription
- shippingMethodIdstring<uuid>requiredFormatuuid
- shippingMethodNamestring
- trackingNumberstring
- trackingUrlstringExampleDescription
- labelDownloadmap<string, string>
- addressFromAddressDescription
- street1stringrequired
- street2string
- citystringrequired
- countystring
- stateOrRegionstringrequired
- countrystringrequiredDescriptionMin Length2Max Length2
- postalCodestringrequired
- poBoxbooleanrequiredDefaultfalse
- nameName
- firststringrequiredExampleDescription
- laststringrequiredExampleDescription
- middleInitialstringExampleDescription
- salutationstringExampleDescription
- suffixstringExampleDescription
- businessNamestring
- phoneNumberstring
- locationFromIdstring
- addressToAddressDescription
- street1stringrequired
- street2string
- citystringrequired
- countystring
- stateOrRegionstringrequired
- countrystringrequiredDescriptionMin Length2Max Length2
- postalCodestringrequired
- poBoxbooleanrequiredDefaultfalse
- nameName
- firststringrequiredExampleDescription
- laststringrequiredExampleDescription
- middleInitialstringExampleDescription
- salutationstringExampleDescription
- suffixstringExampleDescription
- businessNamestring
- phoneNumberstring
- locationToIdstring
- shippingToDistanceDistanceDescription
- valuenumber<double>requiredExampleDescriptionFormatdouble
- unitDistanceUnitsrequiredDescription
- rateShippingRate
- rateIdstringrequired
- carrierIdstringrequired
- pricingShippingRatePricingrequired
- shippingnumberrequired
- insurancenumber
- confirmationnumber
- othernumber
- feenumber
- packageTypestring
- deliveryDaysinteger<int32>Formatint32
- estimatedDeliveryDatestring<date-time>Formatdate-time
- carrierDeliveryDatesstringrequired
- shipDatestring<date-time>Formatdate-time
- serviceTypestringrequired
- serviceCodestringrequired
- carrierCodestringrequired
- packagesShippingPackage[]required
- dimensionsDimensionsDescription
- widthnumber<double>requiredExampleFormatdouble
- lengthnumber<double>requiredExampleFormatdouble
- heightnumber<double>requiredExampleFormatdouble
- unitstring<cm | m | in | mm>requiredAllowedcmminmm
- insuredValuenumber
- packageCodestring
- weightWeightrequiredDescription
- valuenumber<double>requiredFormatdoubleMinimum0
- unitstring<g | kg | lb>requiredDescriptionAllowedgkglb
- trackingNumberstring
- pricingOrderShipmentPricingrequired
- basePricenumber
- promotionPriceAdjustmentsPromotionPriceAdjustment[]requiredDescription
- descriptionstringDescription
- namestringDescription
- idstring<uuid>requiredDescriptionFormatuuid
- valuenumberrequiredDescription
- taxPriceAdjustmentTaxPriceAdjustment
- taxCodestringrequired
- valuenumber
- taxPriceAdjustmentTaxPriceAdjustment
- taxCodestringrequired
- valuenumber
- deliveredDatestring<date-time>Formatdate-time
- errorsErrorMessage[]Description
- codestringrequiredDescription
- detailstringDescription
- levelstring<ERROR | INFO | WARNING>requiredDescriptionAllowedERRORINFOWARNING
- messagestringDescription
- pickupHoursNormalHoursOfOperation[]
- HoursOfOperation
- isOpenbooleanrequired
- openstring
- closedstring
- object
- daystring<MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY>requiredDescriptionAllowedMONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY
- pricingOrderPricing
- promotionPriceAdjustmentsOrderPromotionPriceAdjustment[]required
- idstringrequiredDescription
- namestringDescription
- valuenumberrequiredExampleDescriptionMaximum (exclusive)
- descriptionstringExampleDescription
- itemIdsstring[]requiredDescription
- taxPriceAdjustmentTaxPriceAdjustment
- taxCodestringrequired
- valuenumber
- totalFeenumberDefault0
- totalItemOrderPromotionnumberDefault0
- totalItemsBasePricenumberDefault0
- totalItemsPricenumberDefault0
- totalPreTaxPricenumberDefault0
- totalPricenumberDefault0
- totalPromotionnumberDefault0
- totalShippingBasePricenumberDefault0
- totalShippingPricenumberDefault0
- totalShippingPromotionnumberDefault0
- totalTaxnumberDefault0
- paymentsOrderPayment[]
- execPaymentExecrequired
- idstring
- processedDatestring<date-time>Formatdate-time
- refundedDatestring<date-time>Formatdate-time
- statePaymentStatesEnumrequired
- transactionIdstring
- valuenumber
- taxOrderTax
- processedDatestring<date-time>Formatdate-time
- refundedDatestring<date-time>Formatdate-time
- stateTaxStatesEnumrequiredDescription
- transactionCodestring
- emailstring<email>Formatemail
- internalInvoiceIdstring
- timeZoneIdstring
Responses
200
- Order
- idstring<uuid>requiredFormatuuid
- siteIdsstring[]required
- customerIdstring<uuid>requiredFormatuuid
- anonymousbooleanrequired
- statestringrequired
- currencystringrequired
- distanceUnitDistanceUnitsrequiredDescription
- itemsOrderItem[]required
- catalogItemCatalogItemSummary
- idstringrequired
- siteIdsstring[]requiredDescription
- activationDatestring<date-time>DescriptionFormatdate-time
- archivedbooleanDescriptionDefaultfalse
- avgRatingnumber<float>ExampleDescriptionFormatfloat
- avgGroupRatingnumber<double>Formatdouble
- numGroupReviewsinteger
- productPopularitynumber<double>Formatdouble
- excludesClearanceItemsboolean
- brandNamestringExampleDescription
- deactivationDatestring<date-time>DescriptionFormatdate-time
- dynamicPropertiesobjectrequiredDescription
- hiddenbooleanrequiredDescriptionDefaultfalse
- ignoreInventorybooleanrequiredDescriptionDefaultfalse
- liveDatestring<date-time>DescriptionFormatdate-time
- manufacturerNamestringExampleDescription
- mediamap<string, MediaValue>Description
- modifiedDatestring<date-time>DescriptionFormatdate-time
- namestringrequiredExampleDescription
- numReviewsinteger<int32>ExampleDescriptionFormatint32
- offeredStandardWarrantyDrupalTermsAndConditions
- serviceQualificationServiceQualificationDescription
- eligibleProductIdsstring[]Description
- eligibleShippingMethodIdsstring[]Description
- productItemsSkuItemSummary[]
- relatedIdsstring[]requiredDescription
- seoSeo
- pageTitlestring
- descriptionstring
- metaKeywordsstring[]
- shippingMethodIdsstring[]requiredExample
[ "6A883710-0E0A-47ED-8DFE-7CCDBAC8F2C0", "B7E96644-DBCB-4608-B882-010DDCF9E70F" ]
Description - subVersioninteger
- tagsstring[]Example
[ "Men's", "Shirts", "Blue" ]
Description - taxCodestringExampleDescription
- typestring<product | protectionPlan | service | warranty | fee | bundle>requiredDescriptionAllowedproductprotectionPlanservicewarrantyfeebundle
- typeIdstring<uuid>requiredFormatuuid
- typeNamestringrequiredExampleDescription
- versioninteger<int32>requiredExampleDescriptionDefault0Formatint32
- catalogItemIdstringrequired
- catalogItemTypestring<bundle | product | protectionPlan | service | warranty | fee>requiredAllowedbundleproductprotectionPlanservicewarrantyfee
- idstring<uuid>Formatuuid
- pricingOrderItemPricingrequired
- basePriceBasePrice
- listPricenumberrequired
- pricenumberrequired
- typestringrequired
- zonestringrequired
- feePriceAdjustmentsFeePriceAdjustment[]required
- baseValuenumberrequired
- descriptionstring
- idstringrequired
- namestringrequired
- quantityinteger<int32>requiredFormatint32
- valuenumberrequired
- promotionPriceAdjustmentsPromotionPriceAdjustment[]requiredDescription
- descriptionstringDescription
- namestringDescription
- idstring<uuid>requiredDescriptionFormatuuid
- valuenumberrequiredDescription
- taxPriceAdjustmentTaxPriceAdjustment
- taxCodestringrequired
- valuenumber
- taxPriceAdjustmentTaxPriceAdjustment
- taxCodestringrequired
- valuenumber
- productItemSkuIdstringrequired
- promotionIdstring
- quantityinteger<int32>requiredFormatint32
- shipmentIdstring<uuid>Formatuuid
- quoteIdinteger
- targetItemIdsstring[]Description
- targetShipmentIdsstring[]DescriptionDefault
- statestring<Valid | Canceled>requiredAllowedValidCanceled
- locationIdstring
- timeZoneOffsetinteger<int32>Formatint32
- haulAwayRequestednumber
- couponsOrderCoupon[]required
- idstringrequiredDescription
- appliedbooleanrequiredDescriptionDefaultfalse
- applyStatusstringDescription
- promotionIdstring<uuid>DescriptionFormatuuid
- returnPolicyQualificationsOrderReturnPolicyQualification[]required
- idstring<uuid>requiredFormatuuid
- namestringrequired
- groupQualificationsOrderReturnPolicyGroupQualification[]required
- namestringrequiredDescription
- triggeringItemIdsstring[]requiredDescription
- qualifyingItemIdsstring[]requiredDescription
- qualifyingSubjectsReturnPolicySubject[]requiredDescription
- ReturnPolicyProduct
- idstringrequired
- ReturnPolicySku
- idstringrequired
- skuIdstringrequired
- qualificationResultOrderReturnPolicyQualificationResultrequired
- Qualified
- triggeredMessagestringrequired
- NotQualified
- triggeredMessagestringrequired
- unqualifiedMessagestringrequiredDescription
- shippingCoordinatesCoordinatesDescription
- latitudenumberrequiredMinimum-90Maximum90
- longitudenumberrequiredMinimum-180Maximum180
- shippingAddressAddressDescription
- street1stringrequired
- street2string
- citystringrequired
- countystring
- stateOrRegionstringrequired
- countrystringrequiredDescriptionMin Length2Max Length2
- postalCodestringrequired
- poBoxbooleanrequiredDefaultfalse
- nameName
- firststringrequiredExampleDescription
- laststringrequiredExampleDescription
- middleInitialstringExampleDescription
- salutationstringExampleDescription
- suffixstringExampleDescription
- businessNamestring
- phoneNumberstring
- billingAddressAddressDescription
- street1stringrequired
- street2string
- citystringrequired
- countystring
- stateOrRegionstringrequired
- countrystringrequiredDescriptionMin Length2Max Length2
- postalCodestringrequired
- poBoxbooleanrequiredDefaultfalse
- nameName
- firststringrequiredExampleDescription
- laststringrequiredExampleDescription
- middleInitialstringExampleDescription
- salutationstringExampleDescription
- suffixstringExampleDescription
- businessNamestring
- phoneNumberstring
- shipmentsOrderShipment[]required
- idstring<uuid>Formatuuid
- stateShipmentStateEnumrequiredDescription
- shippingMethodIdstring<uuid>requiredFormatuuid
- shippingMethodNamestring
- trackingNumberstring
- trackingUrlstringExampleDescription
- labelDownloadmap<string, string>
- addressFromAddressDescription
- street1stringrequired
- street2string
- citystringrequired
- countystring
- stateOrRegionstringrequired
- countrystringrequiredDescriptionMin Length2Max Length2
- postalCodestringrequired
- poBoxbooleanrequiredDefaultfalse
- nameName
- firststringrequiredExampleDescription
- laststringrequiredExampleDescription
- middleInitialstringExampleDescription
- salutationstringExampleDescription
- suffixstringExampleDescription
- businessNamestring
- phoneNumberstring
- locationFromIdstring
- addressToAddressDescription
- street1stringrequired
- street2string
- citystringrequired
- countystring
- stateOrRegionstringrequired
- countrystringrequiredDescriptionMin Length2Max Length2
- postalCodestringrequired
- poBoxbooleanrequiredDefaultfalse
- nameName
- firststringrequiredExampleDescription
- laststringrequiredExampleDescription
- middleInitialstringExampleDescription
- salutationstringExampleDescription
- suffixstringExampleDescription
- businessNamestring
- phoneNumberstring
- locationToIdstring
- shippingToDistanceDistanceDescription
- valuenumber<double>requiredExampleDescriptionFormatdouble
- unitDistanceUnitsrequiredDescription
- rateShippingRate
- rateIdstringrequired
- carrierIdstringrequired
- pricingShippingRatePricingrequired
- shippingnumberrequired
- insurancenumber
- confirmationnumber
- othernumber
- feenumber
- packageTypestring
- deliveryDaysinteger<int32>Formatint32
- estimatedDeliveryDatestring<date-time>Formatdate-time
- carrierDeliveryDatesstringrequired
- shipDatestring<date-time>Formatdate-time
- serviceTypestringrequired
- serviceCodestringrequired
- carrierCodestringrequired
- packagesShippingPackage[]required
- dimensionsDimensionsDescription
- widthnumber<double>requiredExampleFormatdouble
- lengthnumber<double>requiredExampleFormatdouble
- heightnumber<double>requiredExampleFormatdouble
- unitstring<cm | m | in | mm>requiredAllowedcmminmm
- insuredValuenumber
- packageCodestring
- weightWeightrequiredDescription
- valuenumber<double>requiredFormatdoubleMinimum0
- unitstring<g | kg | lb>requiredDescriptionAllowedgkglb
- trackingNumberstring
- pricingOrderShipmentPricingrequired
- basePricenumber
- promotionPriceAdjustmentsPromotionPriceAdjustment[]requiredDescription
- descriptionstringDescription
- namestringDescription
- idstring<uuid>requiredDescriptionFormatuuid
- valuenumberrequiredDescription
- taxPriceAdjustmentTaxPriceAdjustment
- taxCodestringrequired
- valuenumber
- taxPriceAdjustmentTaxPriceAdjustment
- taxCodestringrequired
- valuenumber
- deliveredDatestring<date-time>Formatdate-time
- errorsErrorMessage[]Description
- codestringrequiredDescription
- detailstringDescription
- levelstring<ERROR | INFO | WARNING>requiredDescriptionAllowedERRORINFOWARNING
- messagestringDescription
- pickupHoursNormalHoursOfOperation[]
- HoursOfOperation
- isOpenbooleanrequired
- openstring
- closedstring
- object
- daystring<MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY>requiredDescriptionAllowedMONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY
- pricingOrderPricingrequired
- promotionPriceAdjustmentsOrderPromotionPriceAdjustment[]required
- idstringrequiredDescription
- namestringDescription
- valuenumberrequiredExampleDescriptionMaximum (exclusive)
- descriptionstringExampleDescription
- itemIdsstring[]requiredExample
[ "E9A22EA5-253E-4764-8238-48AAEFE2E1D3" ]
Description - taxPriceAdjustmentTaxPriceAdjustment
- taxCodestringrequired
- valuenumber
- totalFeenumberDefault0
- totalItemOrderPromotionnumberDefault0
- totalItemsBasePricenumberDefault0
- totalItemsPricenumberDefault0
- totalPreTaxPricenumberDefault0
- totalPricenumberDefault0
- totalPromotionnumberDefault0
- totalShippingBasePricenumberDefault0
- totalShippingPricenumberDefault0
- totalShippingPromotionnumberDefault0
- totalTaxnumberDefault0
- paymentsOrderPayment[]required
- execPaymentExecrequired
- idstring
- processedDatestring<date-time>Formatdate-time
- refundedDatestring<date-time>Formatdate-time
- statePaymentStatesEnumrequired
- transactionIdstring
- valuenumber
- taxOrderTax
- processedDatestring<date-time>Formatdate-time
- refundedDatestring<date-time>Formatdate-time
- stateTaxStatesEnumrequiredDescription
- transactionCodestring
- emailstring<email>Formatemail
- orderDatestring<date-time>requiredFormatdate-time
- modifiedDatestring<date-time>Formatdate-time
- closeoutDatestring<date-time>Formatdate-time
- internalInvoiceIdstring
- timeZoneIdstring
400
- ValidationErrorResponse
- namestringrequired
- codestringrequired
- detailstring
401
- ErrorResponse
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring
404
- ErrorResponse
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring
curl
curl --request PUT \
--url https://api.upstartcommerce.com/v1/order/{orderId}/sync-order/{sequenceNo} \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-upstart-tenant: string' \
--data '{
"currency": "",
"distanceUnit": "",
"items": [
{
"catalogItem": {
"id": "",
"siteIds": [],
"dynamicProperties": "",
"hidden": false,
"ignoreInventory": false,
"name": "Green Flubber",
"relatedIds": [],
"shippingMethodIds": [],
"type": "",
"typeId": "",
"typeName": "Speaker",
"version": 0
},
"catalogItemId": "",
"catalogItemType": "",
"pricing": {
"basePrice": {
"listPrice": "",
"price": "",
"type": "",
"zone": ""
},
"feePriceAdjustments": [
{
"baseValue": "",
"id": "",
"name": "",
"quantity": "",
"value": ""
}
],
"promotionPriceAdjustments": [
{
"id": "",
"value": "",
"taxPriceAdjustment": {
"taxCode": ""
}
}
],
"taxPriceAdjustment": {
"taxCode": ""
}
},
"productItemSkuId": "",
"quantity": "",
"targetShipmentIds": [],
"state": ""
}
],
"coupons": [
{
"id": "",
"applied": false
}
],
"returnPolicyQualifications": [
{
"id": "",
"name": "",
"groupQualifications": [
{
"name": "",
"triggeringItemIds": [],
"qualifyingItemIds": [],
"qualifyingSubjects": {
"id": ""
},
"qualificationResult": {
"triggeredMessage": ""
}
}
]
}
],
"shippingCoordinates": {
"latitude": "",
"longitude": ""
},
"shippingAddress": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith"
}
},
"billingAddress": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith"
}
},
"shipments": [
{
"state": "",
"shippingMethodId": "",
"addressFrom": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith"
}
},
"addressTo": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith"
}
},
"shippingToDistance": {
"value": 157.75,
"unit": ""
},
"rate": {
"rateId": "",
"carrierId": "",
"pricing": {
"shipping": ""
},
"carrierDeliveryDates": "",
"serviceType": "",
"serviceCode": "",
"carrierCode": ""
},
"packages": [
{
"dimensions": {
"width": 18.5,
"length": 18.5,
"height": 18.5,
"unit": ""
},
"weight": {
"value": "",
"unit": ""
}
}
],
"pricing": {
"promotionPriceAdjustments": [
{
"id": "",
"value": "",
"taxPriceAdjustment": {
"taxCode": ""
}
}
],
"taxPriceAdjustment": {
"taxCode": ""
}
},
"errors": [
{
"code": "",
"level": ""
}
],
"pickupHours": {
"isOpen": "",
"day": ""
}
}
],
"pricing": {
"promotionPriceAdjustments": [
{
"id": "",
"value": -200,
"itemIds": [],
"taxPriceAdjustment": {
"taxCode": ""
}
}
]
},
"payments": [
{
"exec": "",
"state": ""
}
],
"tax": {
"state": ""
}
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");
var raw = JSON.stringify({
"currency": "",
"distanceUnit": "",
"items": [
{
"catalogItem": {
"id": "",
"siteIds": [],
"dynamicProperties": "",
"hidden": false,
"ignoreInventory": false,
"name": "Green Flubber",
"relatedIds": [],
"shippingMethodIds": [],
"type": "",
"typeId": "",
"typeName": "Speaker",
"version": 0
},
"catalogItemId": "",
"catalogItemType": "",
"pricing": {
"basePrice": {
"listPrice": "",
"price": "",
"type": "",
"zone": ""
},
"feePriceAdjustments": [
{
"baseValue": "",
"id": "",
"name": "",
"quantity": "",
"value": ""
}
],
"promotionPriceAdjustments": [
{
"id": "",
"value": "",
"taxPriceAdjustment": {
"taxCode": ""
}
}
],
"taxPriceAdjustment": {
"taxCode": ""
}
},
"productItemSkuId": "",
"quantity": "",
"targetShipmentIds": [],
"state": ""
}
],
"coupons": [
{
"id": "",
"applied": false
}
],
"returnPolicyQualifications": [
{
"id": "",
"name": "",
"groupQualifications": [
{
"name": "",
"triggeringItemIds": [],
"qualifyingItemIds": [],
"qualifyingSubjects": {
"id": ""
},
"qualificationResult": {
"triggeredMessage": ""
}
}
]
}
],
"shippingCoordinates": {
"latitude": "",
"longitude": ""
},
"shippingAddress": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith"
}
},
"billingAddress": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith"
}
},
"shipments": [
{
"state": "",
"shippingMethodId": "",
"addressFrom": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith"
}
},
"addressTo": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith"
}
},
"shippingToDistance": {
"value": 157.75,
"unit": ""
},
"rate": {
"rateId": "",
"carrierId": "",
"pricing": {
"shipping": ""
},
"carrierDeliveryDates": "",
"serviceType": "",
"serviceCode": "",
"carrierCode": ""
},
"packages": [
{
"dimensions": {
"width": 18.5,
"length": 18.5,
"height": 18.5,
"unit": ""
},
"weight": {
"value": "",
"unit": ""
}
}
],
"pricing": {
"promotionPriceAdjustments": [
{
"id": "",
"value": "",
"taxPriceAdjustment": {
"taxCode": ""
}
}
],
"taxPriceAdjustment": {
"taxCode": ""
}
},
"errors": [
{
"code": "",
"level": ""
}
],
"pickupHours": {
"isOpen": "",
"day": ""
}
}
],
"pricing": {
"promotionPriceAdjustments": [
{
"id": "",
"value": -200,
"itemIds": [],
"taxPriceAdjustment": {
"taxCode": ""
}
}
]
},
"payments": [
{
"exec": "",
"state": ""
}
],
"tax": {
"state": ""
}
});
var requestOptions = {
method: 'PUT',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.upstartcommerce.com/v1/order/{orderId}/sync-order/{sequenceNo}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.upstartcommerce.com/v1/order/{orderId}/sync-order/{sequenceNo}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Put.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
request.body = JSON.dump({
"currency": "",
"distanceUnit": "",
"items": [
{
"catalogItem": {
"id": "",
"siteIds": [],
"dynamicProperties": "",
"hidden": false,
"ignoreInventory": false,
"name": "Green Flubber",
"relatedIds": [],
"shippingMethodIds": [],
"type": "",
"typeId": "",
"typeName": "Speaker",
"version": 0
},
"catalogItemId": "",
"catalogItemType": "",
"pricing": {
"basePrice": {
"listPrice": "",
"price": "",
"type": "",
"zone": ""
},
"feePriceAdjustments": [
{
"baseValue": "",
"id": "",
"name": "",
"quantity": "",
"value": ""
}
],
"promotionPriceAdjustments": [
{
"id": "",
"value": "",
"taxPriceAdjustment": {
"taxCode": ""
}
}
],
"taxPriceAdjustment": {
"taxCode": ""
}
},
"productItemSkuId": "",
"quantity": "",
"targetShipmentIds": [],
"state": ""
}
],
"coupons": [
{
"id": "",
"applied": false
}
],
"returnPolicyQualifications": [
{
"id": "",
"name": "",
"groupQualifications": [
{
"name": "",
"triggeringItemIds": [],
"qualifyingItemIds": [],
"qualifyingSubjects": {
"id": ""
},
"qualificationResult": {
"triggeredMessage": ""
}
}
]
}
],
"shippingCoordinates": {
"latitude": "",
"longitude": ""
},
"shippingAddress": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith"
}
},
"billingAddress": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith"
}
},
"shipments": [
{
"state": "",
"shippingMethodId": "",
"addressFrom": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith"
}
},
"addressTo": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith"
}
},
"shippingToDistance": {
"value": 157.75,
"unit": ""
},
"rate": {
"rateId": "",
"carrierId": "",
"pricing": {
"shipping": ""
},
"carrierDeliveryDates": "",
"serviceType": "",
"serviceCode": "",
"carrierCode": ""
},
"packages": [
{
"dimensions": {
"width": 18.5,
"length": 18.5,
"height": 18.5,
"unit": ""
},
"weight": {
"value": "",
"unit": ""
}
}
],
"pricing": {
"promotionPriceAdjustments": [
{
"id": "",
"value": "",
"taxPriceAdjustment": {
"taxCode": ""
}
}
],
"taxPriceAdjustment": {
"taxCode": ""
}
},
"errors": [
{
"code": "",
"level": ""
}
],
"pickupHours": {
"isOpen": "",
"day": ""
}
}
],
"pricing": {
"promotionPriceAdjustments": [
{
"id": "",
"value": -200,
"itemIds": [],
"taxPriceAdjustment": {
"taxCode": ""
}
}
]
},
"payments": [
{
"exec": "",
"state": ""
}
],
"tax": {
"state": ""
}
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.upstartcommerce.com/v1/order/{orderId}/sync-order/{sequenceNo}"
payload = json.dumps({
"currency": "",
"distanceUnit": "",
"items": [
{
"catalogItem": {
"id": "",
"siteIds": [],
"dynamicProperties": "",
"hidden": False,
"ignoreInventory": False,
"name": "Green Flubber",
"relatedIds": [],
"shippingMethodIds": [],
"type": "",
"typeId": "",
"typeName": "Speaker",
"version": 0
},
"catalogItemId": "",
"catalogItemType": "",
"pricing": {
"basePrice": {
"listPrice": "",
"price": "",
"type": "",
"zone": ""
},
"feePriceAdjustments": [
{
"baseValue": "",
"id": "",
"name": "",
"quantity": "",
"value": ""
}
],
"promotionPriceAdjustments": [
{
"id": "",
"value": "",
"taxPriceAdjustment": {
"taxCode": ""
}
}
],
"taxPriceAdjustment": {
"taxCode": ""
}
},
"productItemSkuId": "",
"quantity": "",
"targetShipmentIds": [],
"state": ""
}
],
"coupons": [
{
"id": "",
"applied": False
}
],
"returnPolicyQualifications": [
{
"id": "",
"name": "",
"groupQualifications": [
{
"name": "",
"triggeringItemIds": [],
"qualifyingItemIds": [],
"qualifyingSubjects": {
"id": ""
},
"qualificationResult": {
"triggeredMessage": ""
}
}
]
}
],
"shippingCoordinates": {
"latitude": "",
"longitude": ""
},
"shippingAddress": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": False,
"name": {
"first": "John",
"last": "Smith"
}
},
"billingAddress": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": False,
"name": {
"first": "John",
"last": "Smith"
}
},
"shipments": [
{
"state": "",
"shippingMethodId": "",
"addressFrom": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": False,
"name": {
"first": "John",
"last": "Smith"
}
},
"addressTo": {
"street1": "",
"city": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": False,
"name": {
"first": "John",
"last": "Smith"
}
},
"shippingToDistance": {
"value": 157.75,
"unit": ""
},
"rate": {
"rateId": "",
"carrierId": "",
"pricing": {
"shipping": ""
},
"carrierDeliveryDates": "",
"serviceType": "",
"serviceCode": "",
"carrierCode": ""
},
"packages": [
{
"dimensions": {
"width": 18.5,
"length": 18.5,
"height": 18.5,
"unit": ""
},
"weight": {
"value": "",
"unit": ""
}
}
],
"pricing": {
"promotionPriceAdjustments": [
{
"id": "",
"value": "",
"taxPriceAdjustment": {
"taxCode": ""
}
}
],
"taxPriceAdjustment": {
"taxCode": ""
}
},
"errors": [
{
"code": "",
"level": ""
}
],
"pickupHours": {
"isOpen": "",
"day": ""
}
}
],
"pricing": {
"promotionPriceAdjustments": [
{
"id": "",
"value": -200,
"itemIds": [],
"taxPriceAdjustment": {
"taxCode": ""
}
}
]
},
"payments": [
{
"exec": "",
"state": ""
}
],
"tax": {
"state": ""
}
})
headers = {
'accept': 'application/json',
'content-type': 'application/json',
'x-upstart-tenant': 'string'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
200
// Success-order updated in persistence successfully.
{
"id": "",
"siteIds": [
""
],
"customerId": "",
"anonymous": false,
"state": "",
"currency": "",
"distanceUnit": "",
"items": [
{
"catalogItem": {
"id": "",
"siteIds": [
""
],
"activationDate": "",
"archived": false,
"avgRating": 4.62,
"avgGroupRating": "",
"numGroupReviews": 0,
"productPopularity": "",
"excludesClearanceItems": false,
"brandName": "Bob's Best Toy Line",
"deactivationDate": "",
"dynamicProperties": {},
"hidden": false,
"ignoreInventory": false,
"liveDate": "",
"manufacturerName": "Bob's chemical company.",
"media": "",
"modifiedDate": "",
"name": "Green Flubber",
"numReviews": 17,
"offeredStandardWarranty": {},
"serviceQualification": {
"eligibleProductIds": [
""
],
"eligibleShippingMethodIds": [
""
]
},
"productItems": [
""
],
"relatedIds": [
""
],
"seo": {
"pageTitle": "",
"description": "",
"metaKeywords": [
""
]
},
"shippingMethodIds": [
""
],
"subVersion": 0,
"tags": [
""
],
"taxCode": "P0000000",
"type": "",
"typeId": "",
"typeName": "Speaker",
"version": 5
},
"catalogItemId": "",
"catalogItemType": "",
"id": "",
"pricing": {
"basePrice": {
"listPrice": 0,
"price": 0,
"type": "",
"zone": ""
},
"feePriceAdjustments": [
{
"baseValue": 0,
"description": "",
"id": "",
"name": "",
"quantity": "",
"value": 0
}
],
"promotionPriceAdjustments": [
{
"description": "",
"name": "",
"id": "",
"value": 0,
"taxPriceAdjustment": {
"taxCode": "",
"value": 0
}
}
],
"taxPriceAdjustment": {
"taxCode": "",
"value": 0
}
},
"productItemSkuId": "",
"promotionId": "",
"quantity": "",
"shipmentId": "",
"quoteId": 0,
"targetItemIds": [
""
],
"targetShipmentIds": [
""
],
"state": ""
}
],
"locationId": "",
"timeZoneOffset": "",
"haulAwayRequested": 0,
"coupons": [
{
"id": "",
"applied": false,
"applyStatus": "",
"promotionId": ""
}
],
"returnPolicyQualifications": [
{
"id": "",
"name": "",
"groupQualifications": [
{
"name": "",
"triggeringItemIds": [
""
],
"qualifyingItemIds": [
""
],
"qualifyingSubjects": {},
"qualificationResult": {}
}
]
}
],
"shippingCoordinates": {
"latitude": 0,
"longitude": 0
},
"shippingAddress": {
"street1": "",
"street2": "",
"city": "",
"county": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith",
"middleInitial": "D.",
"salutation": "Capt.",
"suffix": "Sr."
},
"businessName": "",
"phoneNumber": ""
},
"billingAddress": {
"street1": "",
"street2": "",
"city": "",
"county": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith",
"middleInitial": "D.",
"salutation": "Capt.",
"suffix": "Sr."
},
"businessName": "",
"phoneNumber": ""
},
"shipments": [
{
"id": "",
"state": "",
"shippingMethodId": "",
"shippingMethodName": "",
"trackingNumber": "",
"trackingUrl": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=391274234820&cntry_code=us&locale=en_US",
"labelDownload": "",
"addressFrom": {
"street1": "",
"street2": "",
"city": "",
"county": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith",
"middleInitial": "D.",
"salutation": "Capt.",
"suffix": "Sr."
},
"businessName": "",
"phoneNumber": ""
},
"locationFromId": "",
"addressTo": {
"street1": "",
"street2": "",
"city": "",
"county": "",
"stateOrRegion": "",
"country": "",
"postalCode": "",
"poBox": false,
"name": {
"first": "John",
"last": "Smith",
"middleInitial": "D.",
"salutation": "Capt.",
"suffix": "Sr."
},
"businessName": "",
"phoneNumber": ""
},
"locationToId": "",
"shippingToDistance": {
"value": 157.75,
"unit": ""
},
"rate": {
"rateId": "",
"carrierId": "",
"pricing": {
"shipping": 0,
"insurance": 0,
"confirmation": 0,
"other": 0,
"fee": 0
},
"packageType": "",
"deliveryDays": "",
"estimatedDeliveryDate": "",
"carrierDeliveryDates": "",
"shipDate": "",
"serviceType": "",
"serviceCode": "",
"carrierCode": ""
},
"packages": [
{
"dimensions": {
"width": 18.5,
"length": 18.5,
"height": 18.5,
"unit": ""
},
"insuredValue": 0,
"packageCode": "",
"weight": {
"value": "",
"unit": ""
},
"trackingNumber": ""
}
],
"pricing": {
"basePrice": 0,
"promotionPriceAdjustments": [
{
"description": "",
"name": "",
"id": "",
"value": 0,
"taxPriceAdjustment": {
"taxCode": "",
"value": 0
}
}
],
"taxPriceAdjustment": {
"taxCode": "",
"value": 0
}
},
"deliveredDate": "",
"errors": [
{
"code": "",
"detail": "",
"level": "",
"message": ""
}
],
"pickupHours": {}
}
],
"pricing": {
"promotionPriceAdjustments": [
{
"id": "",
"name": "",
"value": -200,
"description": "Buy 1 flubber get 10 free",
"itemIds": [
"E9A22EA5-253E-4764-8238-48AAEFE2E1D3"
],
"taxPriceAdjustment": {
"taxCode": "",
"value": 0
}
}
],
"totalFee": 0,
"totalItemOrderPromotion": 0,
"totalItemsBasePrice": 0,
"totalItemsPrice": 0,
"totalPreTaxPrice": 0,
"totalPrice": 0,
"totalPromotion": 0,
"totalShippingBasePrice": 0,
"totalShippingPrice": 0,
"totalShippingPromotion": 0,
"totalTax": 0
},
"payments": [
{
"exec": {},
"id": "",
"processedDate": "",
"refundedDate": "",
"state": "",
"transactionId": "",
"value": 0
}
],
"tax": {
"processedDate": "",
"refundedDate": "",
"state": "",
"transactionCode": ""
},
"email": "",
"orderDate": "",
"modifiedDate": "",
"closeoutDate": "",
"internalInvoiceId": "",
"timeZoneId": ""
}400
// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
"name": "",
"code": "",
"detail": ""
}401
// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
"name": "",
"code": "",
"detail": "",
"reason": ""
}404
// The requested resource was not found in the NoChannel system.
{
"name": "",
"code": "",
"detail": "",
"reason": ""
}