POST api/putOrder
Put Order(s). Required fields: TemporaryOrderId, SalesPerson, ShippingOptionId, LocationId, PaymentStatusID, PaymentMethodID
Request Information
Allows multi-location processing, in case of using parent location token restrictByLocations parameter is strongly recommended with comma separated list of locations to select from or update in
URI Parameters
None.
Body Parameters
List of Orders.
Collection of OrderHeaderInfoName | Description | Type | Additional information |
---|---|---|---|
LocationId | integer |
None. |
|
OrderMobileID | integer |
None. |
|
TemporaryOrderId | globally unique identifier |
None. |
|
CustomerId | integer |
None. |
|
SubtotalExclTax | decimal number |
None. |
|
Taxes | decimal number |
None. |
|
Total | decimal number |
None. |
|
TipsValue | decimal number |
None. |
|
CurrencyCode | string |
None. |
|
CreatedOn | date |
None. |
|
SalesPersonID | integer |
None. |
|
RemainingBalance | decimal number |
None. |
|
CustomerBalance | decimal number |
None. |
|
RewordPoints | decimal number |
None. |
|
EarnedRewardPoints | decimal number |
None. |
|
Version | string |
None. |
|
ShippingDetailsData | OrderShippingDetailsInfo |
None. |
|
TransactionErrors | string |
None. |
|
ShippingOptionId | integer |
None. |
|
PaymentsSplitError | string |
None. |
|
CustomOrderNumber | string |
None. |
|
IsReturn | boolean |
None. |
|
Latitude | decimal number |
None. |
|
Longitude | decimal number |
None. |
|
IsPaymentsSplitted | boolean |
None. |
|
IsPaymentsSplitFinished | boolean |
None. |
|
CreditCardTokenId | integer |
None. |
|
PaymentsSplitNumber | integer |
None. |
|
NextPaymentDate | date |
None. |
|
PreviousOrderId | integer |
None. |
|
TaxRate | decimal number |
None. |
|
Discount | decimal number |
None. |
|
OrderSourceId | integer |
None. |
|
ShippingStatus | OrderShippingStatus |
None. |
|
Payments | Collection of OrderPaymentInfo |
None. |
|
Discounts | Collection of OrderDiscountInfo |
None. |
|
Items | Collection of OrderItemInfo |
None. |
|
Tips | Collection of OrderTipInfo |
None. |
|
EmployeeCommisions | Collection of OrderEmployeeCommisionInfo |
None. |
|
OrderTaxes | Collection of OrderTaxInfo |
None. |
|
OrderTaskItems | Collection of OrderTaskItemsInfo |
None. |
|
OrderBookings | Collection of OrderBookingInfo |
None. |
|
Nodes | string |
None. |
|
RecalculateRewards |
Determine if we need to recalculate EarnedRewardPoints, rewrite it, create logs for reward redeem and add, and also add rewards to customer balance |
boolean |
None. |
IsCustomerGuest | boolean |
None. |
|
IsImport |
Determine if it's external system real-time sync (false) or import (true) |
boolean |
None. |
IsPackageTransactionCreatedBefore | boolean |
None. |
|
CustomerToCreate | ApiCustomerInfo |
None. |
Request Formats
application/json, text/json
[ { "LocationId": 1, "OrderMobileID": 1, "TemporaryOrderId": "de3776bd-7176-4fc8-a461-a62e94e8ef8e", "CustomerId": 1, "SubtotalExclTax": 3.0, "Taxes": 4.0, "Total": 5.0, "TipsValue": 6.0, "CurrencyCode": "sample string 7", "CreatedOn": "2025-04-03T03:10:08.7340987-04:00", "SalesPersonID": 8, "RemainingBalance": 9.0, "CustomerBalance": 10.0, "RewordPoints": 11.0, "EarnedRewardPoints": 12.0, "Version": "sample string 13", "ShippingDetailsData": { "FirstName": "sample string 1", "LastName": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "Country": 1, "State": 1, "Zip": "sample string 6", "Phone": "sample string 7", "Email": "sample string 8", "Date": "2025-04-03T03:10:08.7340987-04:00", "ShippingMethod": "sample string 9", "TrackingNumbers": [ "sample string 1", "sample string 2" ], "BusinessName": "sample string 10", "DeliveryTypeId": 11 }, "TransactionErrors": "sample string 14", "ShippingOptionId": 15, "PaymentsSplitError": "sample string 16", "CustomOrderNumber": "sample string 17", "IsReturn": true, "Latitude": 1.1, "Longitude": 1.1, "IsPaymentsSplitted": true, "IsPaymentsSplitFinished": true, "CreditCardTokenId": 1, "PaymentsSplitNumber": 1, "NextPaymentDate": "2025-04-03T03:10:08.7340987-04:00", "PreviousOrderId": 1, "TaxRate": 1.1, "Discount": 20.0, "OrderSourceId": 1, "ShippingStatus": 0, "Payments": [ { "PaymentMethodID": 1, "AuthorizationTransactionID": "sample string 2", "AuthorizationTransactionCode": "sample string 3", "AuthorizationTransactionResult": "sample string 4", "CaptureTransactionID": "sample string 5", "CaptureTransactionResult": "sample string 6", "PaymentStatusID": 7, "PaymentAmount": 8.0, "SalesPersonID": 9, "OverPaymentAmount": 10.0, "CustomerSignature": "sample string 11", "ExternalTransactionData": "sample string 12", "CreatedOn": "2025-04-03T03:10:08.7340987-04:00", "CreditCardProviderID": 1, "CustomPaymentMethodID": 1 }, { "PaymentMethodID": 1, "AuthorizationTransactionID": "sample string 2", "AuthorizationTransactionCode": "sample string 3", "AuthorizationTransactionResult": "sample string 4", "CaptureTransactionID": "sample string 5", "CaptureTransactionResult": "sample string 6", "PaymentStatusID": 7, "PaymentAmount": 8.0, "SalesPersonID": 9, "OverPaymentAmount": 10.0, "CustomerSignature": "sample string 11", "ExternalTransactionData": "sample string 12", "CreatedOn": "2025-04-03T03:10:08.7340987-04:00", "CreditCardProviderID": 1, "CustomPaymentMethodID": 1 } ], "Discounts": [ { "DiscountID": 1, "Name": "sample string 1", "Code": "sample string 2", "Amount": 1.0, "Rate": 1.0, "UsePercentage": true, "OrderItemId": 1, "AssignmentType": 3, "ItemGuid": "70b37197-a60b-47fb-abd6-4047692fa2aa" }, { "DiscountID": 1, "Name": "sample string 1", "Code": "sample string 2", "Amount": 1.0, "Rate": 1.0, "UsePercentage": true, "OrderItemId": 1, "AssignmentType": 3, "ItemGuid": "70b37197-a60b-47fb-abd6-4047692fa2aa" } ], "Items": [ { "ProductID": 1, "Price": 2.0, "Quantity": 3.0, "ReturnToStock": true, "ExternalTransactionData": "sample string 5", "Discount": 6.0, "IndividualDiscount": 7.0, "AdditionalTaxes": [ { "Id": 1, "Amount": 2.0 }, { "Id": 1, "Amount": 2.0 } ], "Cost": 8.0, "Name": "sample string 9", "SKU": "sample string 10", "DiscountCode": "sample string 11", "CategoryName": "sample string 12", "ProductAttributes": "sample string 13", "CustomAttributes": { "SerialNumber": "sample string 1", "ContainsAttributeCombination": true }, "GiftCardId": 1, "StylistID": 1, "IsService": true, "IsMembership": true, "RevenueAccountCode": "sample string 15", "InventoryAccountCode": "sample string 16", "CogsAccountCode": "sample string 17", "ItemGuid": "9821d321-59d7-4bc2-abd7-ed953c973833", "IsPrepaidPackage": true, "IsPrepaidPackageRedeemption": true, "PackageRedemptionQty": 20, "PrepaidOrderPackageId": 1, "PrepaidTransactionId": 1 }, { "ProductID": 1, "Price": 2.0, "Quantity": 3.0, "ReturnToStock": true, "ExternalTransactionData": "sample string 5", "Discount": 6.0, "IndividualDiscount": 7.0, "AdditionalTaxes": [ { "Id": 1, "Amount": 2.0 }, { "Id": 1, "Amount": 2.0 } ], "Cost": 8.0, "Name": "sample string 9", "SKU": "sample string 10", "DiscountCode": "sample string 11", "CategoryName": "sample string 12", "ProductAttributes": "sample string 13", "CustomAttributes": { "SerialNumber": "sample string 1", "ContainsAttributeCombination": true }, "GiftCardId": 1, "StylistID": 1, "IsService": true, "IsMembership": true, "RevenueAccountCode": "sample string 15", "InventoryAccountCode": "sample string 16", "CogsAccountCode": "sample string 17", "ItemGuid": "9821d321-59d7-4bc2-abd7-ed953c973833", "IsPrepaidPackage": true, "IsPrepaidPackageRedeemption": true, "PackageRedemptionQty": 20, "PrepaidOrderPackageId": 1, "PrepaidTransactionId": 1 } ], "Tips": [ { "Amount": 1.0, "EmployeeId": 2 }, { "Amount": 1.0, "EmployeeId": 2 } ], "EmployeeCommisions": [ { "CommisionValue": 1.0, "IsServiceCommision": true, "EmployeeId": 3 }, { "CommisionValue": 1.0, "IsServiceCommision": true, "EmployeeId": 3 } ], "OrderTaxes": [ { "TaxID": 1, "Amount": 2.0, "Rate": 1.1, "Name": "sample string 3" }, { "TaxID": 1, "Amount": 2.0, "Rate": 1.1, "Name": "sample string 3" } ], "OrderTaskItems": [ { "TaskId": 1, "ServiceProviderId": 2, "FollowUpMethodId": 1, "IsCompleted": true, "CompletionDate": "2025-04-03T03:10:08.7340987-04:00", "CreatedDate": "2025-04-03T03:10:08.7340987-04:00", "ModifiedDate": "2025-04-03T03:10:08.7340987-04:00" }, { "TaskId": 1, "ServiceProviderId": 2, "FollowUpMethodId": 1, "IsCompleted": true, "CompletionDate": "2025-04-03T03:10:08.7340987-04:00", "CreatedDate": "2025-04-03T03:10:08.7340987-04:00", "ModifiedDate": "2025-04-03T03:10:08.7340987-04:00" } ], "OrderBookings": [ { "Header": { "MobileId": 1, "Data": "sample string 1" }, "StartDate": "2025-04-03T03:10:08.7340987-04:00", "EndDate": "2025-04-03T03:10:08.7340987-04:00", "Description": "sample string 3", "StatusID": 4, "OneServiceUID": "07f00253-bd65-4b1d-baac-cd939c94c434", "ReccuringId": "f2050ed1-e110-48b2-884b-07e7b4f2205f", "CreationDate": "2025-04-03T03:10:08.7340987-04:00", "SalesPersonID": 8, "MobileId": 1, "ProductServiceID": 1, "Price": 1.0, "CancelDates": "2025-04-03T03:10:08.7340987-04:00", "IsEmailReminderSent": true, "IsSMSReminderSent": true, "IsSimpleAppointment": true, "BookingColorID": 1, "BookingResourceId": 1, "ModifiedDT": "2025-04-03T03:10:08.7340987-04:00", "IsEmailReminderSentAfterXDay": true, "IsSendCancelationRemainder": true, "IsLastPart": true, "CustomerNoteId": 1 }, { "Header": { "MobileId": 1, "Data": "sample string 1" }, "StartDate": "2025-04-03T03:10:08.7340987-04:00", "EndDate": "2025-04-03T03:10:08.7340987-04:00", "Description": "sample string 3", "StatusID": 4, "OneServiceUID": "07f00253-bd65-4b1d-baac-cd939c94c434", "ReccuringId": "f2050ed1-e110-48b2-884b-07e7b4f2205f", "CreationDate": "2025-04-03T03:10:08.7340987-04:00", "SalesPersonID": 8, "MobileId": 1, "ProductServiceID": 1, "Price": 1.0, "CancelDates": "2025-04-03T03:10:08.7340987-04:00", "IsEmailReminderSent": true, "IsSMSReminderSent": true, "IsSimpleAppointment": true, "BookingColorID": 1, "BookingResourceId": 1, "ModifiedDT": "2025-04-03T03:10:08.7340987-04:00", "IsEmailReminderSentAfterXDay": true, "IsSendCancelationRemainder": true, "IsLastPart": true, "CustomerNoteId": 1 } ], "Nodes": "sample string 21", "RecalculateRewards": true, "IsCustomerGuest": true, "IsImport": true, "IsPackageTransactionCreatedBefore": true, "CustomerToCreate": { "LocationId": 1, "CustomerId": 2, "FirstName": "sample string 3", "LastName": "sample string 4", "Email": "sample string 5", "CellPhone": "sample string 6", "WorkPhone": "sample string 7", "Dob": "2025-04-03T03:10:08.7340987-04:00", "Gender": 1, "CustomerCode": "sample string 8", "Address": "sample string 9", "Address2": "sample string 10", "City": "sample string 11", "Zip": "sample string 12", "Country": "sample string 13", "State": "sample string 14", "Country2LetterIsoCode": "sample string 15", "Country3LetterIsoCode": "sample string 16", "StateCode": "sample string 17", "RewardPoints": 1.0, "NopExternalId": "sample string 18" } }, { "LocationId": 1, "OrderMobileID": 1, "TemporaryOrderId": "de3776bd-7176-4fc8-a461-a62e94e8ef8e", "CustomerId": 1, "SubtotalExclTax": 3.0, "Taxes": 4.0, "Total": 5.0, "TipsValue": 6.0, "CurrencyCode": "sample string 7", "CreatedOn": "2025-04-03T03:10:08.7340987-04:00", "SalesPersonID": 8, "RemainingBalance": 9.0, "CustomerBalance": 10.0, "RewordPoints": 11.0, "EarnedRewardPoints": 12.0, "Version": "sample string 13", "ShippingDetailsData": { "FirstName": "sample string 1", "LastName": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "Country": 1, "State": 1, "Zip": "sample string 6", "Phone": "sample string 7", "Email": "sample string 8", "Date": "2025-04-03T03:10:08.7340987-04:00", "ShippingMethod": "sample string 9", "TrackingNumbers": [ "sample string 1", "sample string 2" ], "BusinessName": "sample string 10", "DeliveryTypeId": 11 }, "TransactionErrors": "sample string 14", "ShippingOptionId": 15, "PaymentsSplitError": "sample string 16", "CustomOrderNumber": "sample string 17", "IsReturn": true, "Latitude": 1.1, "Longitude": 1.1, "IsPaymentsSplitted": true, "IsPaymentsSplitFinished": true, "CreditCardTokenId": 1, "PaymentsSplitNumber": 1, "NextPaymentDate": "2025-04-03T03:10:08.7340987-04:00", "PreviousOrderId": 1, "TaxRate": 1.1, "Discount": 20.0, "OrderSourceId": 1, "ShippingStatus": 0, "Payments": [ { "PaymentMethodID": 1, "AuthorizationTransactionID": "sample string 2", "AuthorizationTransactionCode": "sample string 3", "AuthorizationTransactionResult": "sample string 4", "CaptureTransactionID": "sample string 5", "CaptureTransactionResult": "sample string 6", "PaymentStatusID": 7, "PaymentAmount": 8.0, "SalesPersonID": 9, "OverPaymentAmount": 10.0, "CustomerSignature": "sample string 11", "ExternalTransactionData": "sample string 12", "CreatedOn": "2025-04-03T03:10:08.7340987-04:00", "CreditCardProviderID": 1, "CustomPaymentMethodID": 1 }, { "PaymentMethodID": 1, "AuthorizationTransactionID": "sample string 2", "AuthorizationTransactionCode": "sample string 3", "AuthorizationTransactionResult": "sample string 4", "CaptureTransactionID": "sample string 5", "CaptureTransactionResult": "sample string 6", "PaymentStatusID": 7, "PaymentAmount": 8.0, "SalesPersonID": 9, "OverPaymentAmount": 10.0, "CustomerSignature": "sample string 11", "ExternalTransactionData": "sample string 12", "CreatedOn": "2025-04-03T03:10:08.7340987-04:00", "CreditCardProviderID": 1, "CustomPaymentMethodID": 1 } ], "Discounts": [ { "DiscountID": 1, "Name": "sample string 1", "Code": "sample string 2", "Amount": 1.0, "Rate": 1.0, "UsePercentage": true, "OrderItemId": 1, "AssignmentType": 3, "ItemGuid": "70b37197-a60b-47fb-abd6-4047692fa2aa" }, { "DiscountID": 1, "Name": "sample string 1", "Code": "sample string 2", "Amount": 1.0, "Rate": 1.0, "UsePercentage": true, "OrderItemId": 1, "AssignmentType": 3, "ItemGuid": "70b37197-a60b-47fb-abd6-4047692fa2aa" } ], "Items": [ { "ProductID": 1, "Price": 2.0, "Quantity": 3.0, "ReturnToStock": true, "ExternalTransactionData": "sample string 5", "Discount": 6.0, "IndividualDiscount": 7.0, "AdditionalTaxes": [ { "Id": 1, "Amount": 2.0 }, { "Id": 1, "Amount": 2.0 } ], "Cost": 8.0, "Name": "sample string 9", "SKU": "sample string 10", "DiscountCode": "sample string 11", "CategoryName": "sample string 12", "ProductAttributes": "sample string 13", "CustomAttributes": { "SerialNumber": "sample string 1", "ContainsAttributeCombination": true }, "GiftCardId": 1, "StylistID": 1, "IsService": true, "IsMembership": true, "RevenueAccountCode": "sample string 15", "InventoryAccountCode": "sample string 16", "CogsAccountCode": "sample string 17", "ItemGuid": "9821d321-59d7-4bc2-abd7-ed953c973833", "IsPrepaidPackage": true, "IsPrepaidPackageRedeemption": true, "PackageRedemptionQty": 20, "PrepaidOrderPackageId": 1, "PrepaidTransactionId": 1 }, { "ProductID": 1, "Price": 2.0, "Quantity": 3.0, "ReturnToStock": true, "ExternalTransactionData": "sample string 5", "Discount": 6.0, "IndividualDiscount": 7.0, "AdditionalTaxes": [ { "Id": 1, "Amount": 2.0 }, { "Id": 1, "Amount": 2.0 } ], "Cost": 8.0, "Name": "sample string 9", "SKU": "sample string 10", "DiscountCode": "sample string 11", "CategoryName": "sample string 12", "ProductAttributes": "sample string 13", "CustomAttributes": { "SerialNumber": "sample string 1", "ContainsAttributeCombination": true }, "GiftCardId": 1, "StylistID": 1, "IsService": true, "IsMembership": true, "RevenueAccountCode": "sample string 15", "InventoryAccountCode": "sample string 16", "CogsAccountCode": "sample string 17", "ItemGuid": "9821d321-59d7-4bc2-abd7-ed953c973833", "IsPrepaidPackage": true, "IsPrepaidPackageRedeemption": true, "PackageRedemptionQty": 20, "PrepaidOrderPackageId": 1, "PrepaidTransactionId": 1 } ], "Tips": [ { "Amount": 1.0, "EmployeeId": 2 }, { "Amount": 1.0, "EmployeeId": 2 } ], "EmployeeCommisions": [ { "CommisionValue": 1.0, "IsServiceCommision": true, "EmployeeId": 3 }, { "CommisionValue": 1.0, "IsServiceCommision": true, "EmployeeId": 3 } ], "OrderTaxes": [ { "TaxID": 1, "Amount": 2.0, "Rate": 1.1, "Name": "sample string 3" }, { "TaxID": 1, "Amount": 2.0, "Rate": 1.1, "Name": "sample string 3" } ], "OrderTaskItems": [ { "TaskId": 1, "ServiceProviderId": 2, "FollowUpMethodId": 1, "IsCompleted": true, "CompletionDate": "2025-04-03T03:10:08.7340987-04:00", "CreatedDate": "2025-04-03T03:10:08.7340987-04:00", "ModifiedDate": "2025-04-03T03:10:08.7340987-04:00" }, { "TaskId": 1, "ServiceProviderId": 2, "FollowUpMethodId": 1, "IsCompleted": true, "CompletionDate": "2025-04-03T03:10:08.7340987-04:00", "CreatedDate": "2025-04-03T03:10:08.7340987-04:00", "ModifiedDate": "2025-04-03T03:10:08.7340987-04:00" } ], "OrderBookings": [ { "Header": { "MobileId": 1, "Data": "sample string 1" }, "StartDate": "2025-04-03T03:10:08.7340987-04:00", "EndDate": "2025-04-03T03:10:08.7340987-04:00", "Description": "sample string 3", "StatusID": 4, "OneServiceUID": "07f00253-bd65-4b1d-baac-cd939c94c434", "ReccuringId": "f2050ed1-e110-48b2-884b-07e7b4f2205f", "CreationDate": "2025-04-03T03:10:08.7340987-04:00", "SalesPersonID": 8, "MobileId": 1, "ProductServiceID": 1, "Price": 1.0, "CancelDates": "2025-04-03T03:10:08.7340987-04:00", "IsEmailReminderSent": true, "IsSMSReminderSent": true, "IsSimpleAppointment": true, "BookingColorID": 1, "BookingResourceId": 1, "ModifiedDT": "2025-04-03T03:10:08.7340987-04:00", "IsEmailReminderSentAfterXDay": true, "IsSendCancelationRemainder": true, "IsLastPart": true, "CustomerNoteId": 1 }, { "Header": { "MobileId": 1, "Data": "sample string 1" }, "StartDate": "2025-04-03T03:10:08.7340987-04:00", "EndDate": "2025-04-03T03:10:08.7340987-04:00", "Description": "sample string 3", "StatusID": 4, "OneServiceUID": "07f00253-bd65-4b1d-baac-cd939c94c434", "ReccuringId": "f2050ed1-e110-48b2-884b-07e7b4f2205f", "CreationDate": "2025-04-03T03:10:08.7340987-04:00", "SalesPersonID": 8, "MobileId": 1, "ProductServiceID": 1, "Price": 1.0, "CancelDates": "2025-04-03T03:10:08.7340987-04:00", "IsEmailReminderSent": true, "IsSMSReminderSent": true, "IsSimpleAppointment": true, "BookingColorID": 1, "BookingResourceId": 1, "ModifiedDT": "2025-04-03T03:10:08.7340987-04:00", "IsEmailReminderSentAfterXDay": true, "IsSendCancelationRemainder": true, "IsLastPart": true, "CustomerNoteId": 1 } ], "Nodes": "sample string 21", "RecalculateRewards": true, "IsCustomerGuest": true, "IsImport": true, "IsPackageTransactionCreatedBefore": true, "CustomerToCreate": { "LocationId": 1, "CustomerId": 2, "FirstName": "sample string 3", "LastName": "sample string 4", "Email": "sample string 5", "CellPhone": "sample string 6", "WorkPhone": "sample string 7", "Dob": "2025-04-03T03:10:08.7340987-04:00", "Gender": 1, "CustomerCode": "sample string 8", "Address": "sample string 9", "Address2": "sample string 10", "City": "sample string 11", "Zip": "sample string 12", "Country": "sample string 13", "State": "sample string 14", "Country2LetterIsoCode": "sample string 15", "Country3LetterIsoCode": "sample string 16", "StateCode": "sample string 17", "RewardPoints": 1.0, "NopExternalId": "sample string 18" } } ]
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
list of results in format: [companyId], [TemporaryOrderId], [isSuccess]. IsSuccess false if there was unexpected error
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |