Exported Services
OFBiz services that are exposed via REST interface with export attribute set to true
Wrapper Service For Adding Category Products
application/json
In Schema for service: addCategoryProducts request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/addCategoryProducts HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 97
{
"fromDate": "2025-08-28",
"productCategoryId": "text",
"productId": [
"text"
],
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Service for indexing data to Solr
application/json
In Schema for service: addDataToSearchIndex request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/addDataToSearchIndex HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"updateHandler": "text",
"data": [
"text"
],
"coreName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Bulk Add Facility To FacilityGroup
application/json
In Schema for service: addFacilitiesToGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/addFacilitiesToGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"payload": {}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Add Facility To FacilityGroup
application/json
In Schema for service: addFacilityToGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/addFacilityToGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 110
{
"fromDate": "2025-08-28",
"facilityId": "text",
"sequenceNum": 1,
"facilityGroupId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create a FacilityParty record
application/json
In Schema for service: addPartyToFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/addPartyToFacility HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"fromDate": "2025-08-28",
"roleTypeId": "text",
"facilityId": "text",
"partyId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
application/json
In Schema for service: addPartyUserPermission request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/addPartyUserPermission HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"userLoginId": "text",
"groupIds": [
"text"
]
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"userLoginId": "text"
}
}
application/json
In Schema for service: addProductToFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/addProductToFacility HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 301
{
"allowPickup": "text",
"reorderPoint": 1,
"facilityId": "text",
"productId": "text",
"salesVelocity": 1,
"allowBrokering": "text",
"reorderQuantity": 1,
"inventoryItemId": "text",
"lastInventoryCount": 1,
"computedLastInventoryCount": 1,
"minimumStock": 1,
"requirementMethodEnumId": "text",
"maximumStock": 1,
"daysToShip": 1
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"productId": "text"
}
}
application/json
In Schema for service: addSecurityGroupToUserLogin request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/addSecurityGroupToUserLogin HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"securityGroupId": "text",
"partyIdTo": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Add a SecurityPermission to a SecurityGroup
application/json
In Schema for service: addSecurityPermissionToSecurityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/addSecurityPermissionToSecurityGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 88
{
"fromDate": "2025-08-28",
"permissionId": "text",
"groupId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create Shipment, ShipmentRouteSegment, ShipmentPackageRouteSeg and ShipmentPackage without items
Create Shipment, ShipmentRouteSegment, ShipmentPackageRouteSeg and ShipmentPackage without items
application/json
In Schema for service: addShipmentPackage request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/addShipmentPackage HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 204
{
"carrierPartyId": "text",
"boxLength": "text",
"dimensionUomId": "text",
"boxNumber": "text",
"boxHeight": "text",
"boxWidth": "text",
"picklistBinId": "text",
"shipmentBoxTypeId": "text",
"shipmentMethodTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipmentRouteSegmentId": "text",
"shipmentId": "text",
"shipmentPackageSeqId": "text"
}
}
Add a UserLogin to a SecurityGroup
application/json
In Schema for service: addUserLoginToSecurityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/addUserLoginToSecurityGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"fromDate": "2025-08-28",
"userLoginId": "text",
"groupId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
application/json
In Schema for service: allocateOrderItemToFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/allocateOrderItemToFacility HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 340
{
"orderItemSeqId": "text",
"clearAutoCancelDate": true,
"comments": "text",
"facilityId": "text",
"suggestedShipMethodTypeId": "text",
"orderId": "text",
"autoCancelDate": "2025-08-28",
"routingRuleId": "text",
"toShipGroupSeqId": "text",
"routingGroupId": "text",
"routingRule": "text",
"orderRoutingId": "text",
"changeReasonEnumId": "text",
"routingRunId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"allocatedShipGroupSeqId": "text"
}
}
Append an item to an existing order
application/json
In Schema for service: appendOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/appendOrderItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 496
{
"amount": 1,
"itemAttributesMap": {},
"quantity": 1,
"productId": "text",
"orderId": "text",
"overridePrice": "text",
"autoCancelDate": "2025-08-28",
"offInvoicePrice": 1,
"disableResetGrandTotal": true,
"quantityUomId": "text",
"shipAmount": 1,
"shipGroupSeqId": "text",
"surveyResponses": [
"text"
],
"unitListPrice": 1,
"changeComments": "text",
"calcTax": true,
"discountMode": "text",
"itemDesiredDeliveryDate": "2025-08-28",
"reasonEnumId": "text",
"discountValue": 1,
"orderItemTypeId": "text",
"basePrice": 1,
"prodCatalogId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderItemSeqId": "text",
"orderId": "text"
}
}
Change status of sales order to approved after validating certain checks which must be performed before approving order
Change status of sales order to approved after validating certain checks which must be performed before approving order
application/json
In Schema for service: approveSalesOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/approveSalesOrder HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"orderId": "text",
"confirmApprove": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"oldStatusId": "text",
"orderStatusId": "text",
"statusId": "text",
"orderId": "text"
}
}
Adjust Shopify inventory level.
application/json
In Schema for service: bulkAdjustInventoryLevelOnShopify request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/bulkAdjustInventoryLevelOnShopify HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"adjustInventoryList": [
"text"
],
"shopifyConfigId": "text",
"facilityId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Mark transfer order as Approved in bulk
application/json
In Schema for service: bulkApproveTransferOrders request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/bulkApproveTransferOrders HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"bufferTime": 1,
"orderIds": [
"text"
]
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Mark all orders items as picked in bulk
application/json
In Schema for service: bulkPackStoreFulfillmentOrders request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/bulkPackStoreFulfillmentOrders HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"shipmentIds": [
"text"
]
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipmentIds": [
"text"
]
}
}
Route all in progress orders to rebrokering
application/json
In Schema for service: bulkRejectStoreInProgressOrders request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/bulkRejectStoreInProgressOrders HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"facilityId": "text",
"reasonId": "text",
"productStoreId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Route all outstanding orders to rebrokering
application/json
In Schema for service: bulkRejectStoreOutstandingOrders request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/bulkRejectStoreOutstandingOrders HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"facilityId": "text",
"reasonId": "text",
"productStoreId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Mark shipments as Shipped in bulk
application/json
In Schema for service: bulkShipOrders request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/bulkShipOrders HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"shipmentId": [
"text"
]
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create a calendar and save calendar week details
application/json
In Schema for service: calendarDataSetup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/calendarDataSetup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 401
{
"sundayCapacity": "text",
"thursdayCapacity": "text",
"wednesdayStartTime": "text",
"wednesdayCapacity": "text",
"tuesdayStartTime": "text",
"fridayStartTime": "text",
"description": "text",
"saturdayCapacity": "text",
"mondayCapacity": "text",
"mondayStartTime": "text",
"calendarId": "text",
"saturdayStartTime": "text",
"thursdayStartTime": "text",
"sundayStartTime": "text",
"fridayCapacity": "text",
"tuesdayCapacity": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"calendarId": "text"
}
}
Cancel an Order Item Quantity
application/json
In Schema for service: cancelOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/cancelOrderItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 140
{
"orderItemSeqId": "text",
"itemReasonMap": {},
"orderId": "text",
"itemCommentMap": {},
"itemQtyMap": {},
"shipGroupSeqId": "text",
"cancelQuantity": 1
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Cancel Order Item Quantity for order
application/json
In Schema for service: cancelOrderItems request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/cancelOrderItems HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"itemReasonMap": {},
"orderId": "text",
"cancelableItemMap": {},
"shipGrpItemQtyMap": {}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
checking whether fulfillment started for the order, if its not then order would be cancelled
application/json
In Schema for service: cancelSalesOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/cancelSalesOrder HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"changeReason": "text",
"orderId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Cancels a schedule job
application/json
In Schema for service: cancelScheduledJob request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/cancelScheduledJob HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"jobId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"statusId": "text",
"cancelDateTime": "2025-08-28"
}
}
Change the status of an existing order item. If no orderItemSeqId is specified, the status of all order items will be changed.
Change the status of an existing order item. If no orderItemSeqId is specified, the status of all order items will be changed.
application/json
In Schema for service: changeOrderItemStatus request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/changeOrderItemStatus HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 162
{
"orderItemSeqId": "text",
"changeReason": "text",
"statusId": "text",
"orderId": "text",
"statusDateTime": "2025-08-28",
"fromStatusId": "text",
"changeReasonEnumId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Change the status of an existing order
application/json
In Schema for service: changeOrderStatus request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/changeOrderStatus HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"setItemStatus": "text",
"changeReason": "text",
"statusId": "text",
"orderId": "text",
"changeReasonEnumId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"oldStatusId": "text",
"orderStatusId": "text",
"grandTotal": 1,
"orderTypeId": "text",
"needsInventoryIssuance": "text"
}
}
Check if fulfillment started for item and then reject it
application/json
In Schema for service: checkAndRejectOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/checkAndRejectOrderItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 146
{
"orderItemSeqId": "text",
"excludeOrderFacilityDuration": "text",
"orderId": "text",
"rejectionComments": "text",
"rejectionReason": "text",
"notify": true
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
This service will check the list of attributes on the passed order and approve it if all the passed attributes are present
This service will check the list of attributes on the passed order and approve it if all the passed attributes are present
application/json
In Schema for service: checkAttributesAndApproveOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/checkAttributesAndApproveOrder HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"orderId": "text",
"attributes": {}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderId": "text"
}
}
Clears all values from all Entity Engine caches. By default does not distribute.
application/json
In Schema for service: clearAllEntityCaches request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/clearAllEntityCaches HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"distribute": true
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Clear Cache Line with a condition; By default does not distribute.
application/json
In Schema for service: clearCacheLineByCondition request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/clearCacheLineByCondition HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"entityName": "text",
"distribute": true
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Clear Cache Line with a dummyPK (GenericEntity); clears that all cache entry and depending on whether the dummyPK is a primaryKey or not this clears the by primary key cache or the specified entry in the by and cache. By default does not distribute.
Clear Cache Line with a dummyPK (GenericEntity); clears that all cache entry and depending on whether the dummyPK is a primaryKey or not this clears the by primary key cache or the specified entry in the by and cache. By default does not distribute.
application/json
In Schema for service: clearCacheLineByDummyPK request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/clearCacheLineByDummyPK HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"distribute": true
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Clear Cache Line with a primaryKey (GenericPK); clears the all and by primary key caches. By default does not distribute.
Clear Cache Line with a primaryKey (GenericPK); clears the all and by primary key caches. By default does not distribute.
application/json
In Schema for service: clearCacheLineByPrimaryKey request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/clearCacheLineByPrimaryKey HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"distribute": true,
"primaryKey": {}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Clear Cache Line with a value (GenericValue); this is the preferred method since the all, by primary key and by and caches will be cleared. By default does not distribute.
Clear Cache Line with a value (GenericValue); this is the preferred method since the all, by primary key and by and caches will be cleared. By default does not distribute.
application/json
In Schema for service: clearCacheLineByValue request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/clearCacheLineByValue HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"distribute": true
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create a new Carrier Shipment Box Type Record
application/json
In Schema for service: createCarrierShipmentBoxType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createCarrierShipmentBoxType HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 123
{
"packagingTypeCode": "text",
"oversizeCode": "text",
"partyId": "text",
"shipmentBoxTypeId": "text",
"pickupContainerCode": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Creates A CarrierShipmentMethod
application/json
In Schema for service: createCarrierShipmentMethod request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createCarrierShipmentMethod HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 132
{
"sequenceNumber": 1,
"roleTypeId": "text",
"deliveryDays": 1,
"partyId": "text",
"carrierServiceCode": "text",
"shipmentMethodTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
application/json
In Schema for service: createCommercePartyRelationshipFrom request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createCommercePartyRelationshipFrom HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 138
{
"roleTypeIdTo": "text",
"partyRelationshipTypeId": "text",
"partyIdFrom": "text",
"statusId": "text",
"partyIdTo": "text",
"roleTypeIdFrom": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"partyId": "text"
}
}
Create a Communication Event with permission check
application/json
In Schema for service: createCommunicationEvent request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createCommunicationEvent HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 787
{
"workEffortId": "text",
"note": "text",
"partyIdFrom": "text",
"orderId": "text",
"ccString": "text",
"subject": "text",
"contactMechTypeId": "text",
"communicationEventTypeId": "text",
"content": "text",
"contentMimeTypeId": "text",
"datetimeStarted": "2025-08-28",
"returnId": "text",
"contactListId": "text",
"action": "text",
"custRequestId": "text",
"contactMechIdFrom": "text",
"reasonEnumId": "text",
"roleTypeIdTo": "text",
"productId": "text",
"entryDate": "2025-08-28",
"parentCommEventId": "text",
"systemMessageRemoteId": "text",
"datetimeEnded": "2025-08-28",
"externalId": "text",
"messageId": "text",
"origCommEventId": "text",
"roleTypeIdFrom": "text",
"contactMechIdTo": "text",
"headerString": "text",
"statusId": "text",
"communicationEventId": "text",
"bccString": "text",
"toString": "text",
"partyIdTo": "text",
"fromString": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"communicationEventId": "text"
}
}
Create a Communication Event Order
application/json
In Schema for service: createCommunicationEventOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createCommunicationEventOrder HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"orderId": "text",
"communicationEventId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create a DataManagerConfig
application/json
In Schema for service: createDataManagerConfig request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createDataManagerConfig HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 381
{
"importPath": "text",
"exportServiceScreenLocation": "text",
"exportServiceScreenName": "text",
"importServiceName": "text",
"fileNamePattern": "text",
"multiThreading": "text",
"description": "text",
"priority": 1,
"exportPath": "text",
"exportContentId": "text",
"notifyOnFailure": "text",
"delimiter": "text",
"configId": "text",
"exportServiceName": "text",
"scriptTitle": "text",
"executionModeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"configId": "text"
}
}
Create a DataManagerMapping
application/json
In Schema for service: createDataManagerMapping request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createDataManagerMapping HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 154
{
"fromDate": "2025-08-28",
"mappingPrefName": "text",
"mappingPrefTypeEnumId": "text",
"mappingPrefId": "text",
"mappingPrefValue": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"mappingPrefId": "text"
}
}
Create a Enumeration
application/json
In Schema for service: createEnumeration request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createEnumeration HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 165
{
"enumTypeId": "text",
"enumId": "text",
"sequenceNum": 1,
"enumCode": "text",
"primaryEnumerationGroupId": "text",
"description": "text",
"enumName": "text",
"sequenceId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"enumId": "text"
}
}
Create enumeration group member
application/json
In Schema for service: createEnumerationGroupMember request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createEnumerationGroupMember HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"fromDate": "2025-08-28",
"enumerationId": "text",
"sequenceNum": 1,
"enumerationGroupId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Service for create excluded order facility record for all order items
application/json
In Schema for service: createExcludedOrderFacilityForOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createExcludedOrderFacilityForOrder HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 101
{
"externalOrderFacilityId": "text",
"orderId": "text",
"externalOrderId": "text",
"orderFacilityId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create a Facility
application/json
In Schema for service: createFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createFacility HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 571
{
"facilityId": "text",
"defaultInventoryItemTypeId": "text",
"parentFacilityId": "text",
"postalCode": "text",
"externalId": "text",
"description": "text",
"defaultWeightUomId": "text",
"primaryFacilityGroupId": "text",
"openedDate": "2025-08-28",
"ownerPartyId": "text",
"facilityTimeZone": "text",
"facilitySize": 1,
"closedDate": "2025-08-28",
"facilitySizeUomId": "text",
"maximumOrderLimit": 1,
"closeTime": "text",
"defaultDaysToShip": 1,
"facilityTypeId": "text",
"defaultDimensionUomId": "text",
"productStoreId": "text",
"facilityName": "text",
"openTime": "text",
"geoPointId": "text",
"oldSquareFootage": 1
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"facilityId": "text"
}
}
Create a FacilityCalendar
application/json
In Schema for service: createFacilityCalendar request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createFacilityCalendar HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 121
{
"fromDate": "2025-08-28",
"facilityId": "text",
"calendarId": "text",
"facilityCalendarTypeId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create an Email Address
application/json
In Schema for service: createFacilityEmailAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createFacilityEmailAddress HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 252
{
"fromDate": "2025-08-28",
"emailAddress": "text",
"extension": "text",
"comments": "text",
"facilityId": "text",
"infoString": "text",
"contactMechPurposeTypeId": "text",
"externalId": "text",
"contactMechTypeId": "text",
"contactMechId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}
Create a Facility Group
application/json
In Schema for service: createFacilityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createFacilityGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"primaryParentGroupId": "text",
"facilityGroupTypeId": "text",
"facilityGroupId": "text",
"description": "text",
"facilityGroupName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"facilityGroupId": "text"
}
}
Create a FacilityIdentification
application/json
In Schema for service: createFacilityIdentification request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createFacilityIdentification HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"fromDate": "2025-08-28",
"facilityId": "text",
"idValue": "text",
"facilityIdenTypeId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create a Facility Location
application/json
In Schema for service: createFacilityLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createFacilityLocation HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 222
{
"nextCountDate": "text",
"lastCountDate": "text",
"facilityId": "text",
"areaId": "text",
"positionId": "text",
"isLocked": "text",
"levelId": "text",
"sectionId": "text",
"geoPointId": "text",
"locationTypeEnumId": "text",
"aisleId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"locationSeqId": "text"
}
}
Create a Postal Address
application/json
In Schema for service: createFacilityPostalAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createFacilityPostalAddress HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 601
{
"houseNumberExt": "text",
"extension": "text",
"city": "text",
"latitude": "text",
"postalCodeGeoId": "text",
"postalCode": "text",
"houseNumber": 1,
"postalCodeExt": "text",
"contactMechId": "text",
"attnName": "text",
"countyGeoId": "text",
"toName": "text",
"paymentMethodId": "text",
"cityGeoId": "text",
"longitude": "text",
"countryGeoId": "text",
"comments": "text",
"facilityId": "text",
"address2": "text",
"address1": "text",
"encodedAddressKey": "text",
"thruDate": "2025-08-28",
"fromDate": "2025-08-28",
"contactMechPurposeTypeId": "text",
"directions": "text",
"municipalityGeoId": "text",
"stateProvinceGeoId": "text",
"geoPointId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}
Create a Telecommunications Number
application/json
In Schema for service: createFacilityTelecomNumber request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createFacilityTelecomNumber HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 245
{
"fromDate": "2025-08-28",
"askForName": "text",
"areaCode": "text",
"extension": "text",
"comments": "text",
"facilityId": "text",
"contactMechPurposeTypeId": "text",
"countryCode": "text",
"contactNumber": "text",
"contactMechId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}
Creates the fulfillment log
application/json
In Schema for service: createGcFulFillmentRecord request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createGcFulFillmentRecord HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 237
{
"referenceNum": "text",
"orderItemSeqId": "text",
"amount": 1,
"authCode": "text",
"orderId": "text",
"merchantId": "text",
"pinNumber": "text",
"typeEnumId": "text",
"surveyResponseId": "text",
"partyId": "text",
"cardNumber": "text",
"responseCode": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create Shopify Return in HC
application/json
In Schema for service: createIncomingShipment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createIncomingShipment HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"payload": {}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipmentId": "text"
}
}
Creates a New User Login and Set it's default Organization by creating User Preference entity record.
Creates a New User Login and Set it's default Organization by creating User Preference entity record.
application/json
In Schema for service: createNewUserLoginAndSetUserPreference request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createNewUserLoginAndSetUserPreference HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 290
{
"userLoginId": "text",
"userPrefGroupTypeId": "text",
"passwordHint": "text",
"userPrefValue": "text",
"currentPasswordVerify": "text",
"externalAuthId": "text",
"requirePasswordChange": "text",
"userPrefTypeId": "text",
"partyId": "text",
"userPrefLoginId": "text",
"enabled": "text",
"currentPassword": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"currentCompany": {},
"userPrefValue": "text"
}
}
Service for creating the index for a single OISGIR.
application/json
In Schema for service: createOISGIRIndex request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createOISGIRIndex HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 129
{
"inventoryItemId": "text",
"orderItemSeqId": "text",
"orderId": "text",
"shipmentId": "text",
"tenantId": "text",
"shipGroupSeqId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Service to create order appeasement
application/json
In Schema for service: createOrderAppeasement request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createOrderAppeasement HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"orderId": "text",
"appeasementAmount": 1,
"itemAmountMap": {}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"returnId": "text"
}
}
Create an OrderAttribute record
application/json
In Schema for service: createOrderAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createOrderAttribute HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"orderId": "text",
"attrDescription": "text",
"attrValue": "text",
"attrName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create Order Indexes
application/json
In Schema for service: createOrderIndex request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createOrderIndex HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 60
{
"orderItemSeqId": "text",
"orderId": "text",
"tenantId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create Order Item Attribute
application/json
In Schema for service: createOrderItemAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createOrderItemAttribute HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"orderItemSeqId": "text",
"orderId": "text",
"attrDescription": "text",
"attrValue": "text",
"attrName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create a PartyGroup
application/json
In Schema for service: createPartyGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createPartyGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 331
{
"pdfLogoImageUrl": "text",
"comments": "text",
"externalId": "text",
"description": "text",
"tickerSymbol": "text",
"logoImageUrl": "text",
"partyTypeId": "text",
"groupName": "text",
"groupNameLocal": "text",
"statusId": "text",
"numEmployees": 1,
"preferredCurrencyUomId": "text",
"ranking": 1,
"partyId": "text",
"annualRevenue": 1,
"officeSiteName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"partyId": "text"
}
}
Create a Postal Address
application/json
In Schema for service: createPostalAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createPostalAddress HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 427
{
"countryGeoId": "text",
"houseNumberExt": "text",
"city": "text",
"address2": "text",
"address1": "text",
"latitude": 1,
"postalCodeGeoId": "text",
"postalCode": "text",
"encodedAddressKey": "text",
"houseNumber": 1,
"postalCodeExt": "text",
"contactMechId": "text",
"attnName": "text",
"countyGeoId": "text",
"directions": "text",
"toName": "text",
"cityGeoId": "text",
"municipalityGeoId": "text",
"stateProvinceGeoId": "text",
"geoPointId": "text",
"longitude": 1
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}
Create an ProductFacilityLocation
application/json
In Schema for service: createProductFacilityLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createProductFacilityLocation HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"facilityId": "text",
"productId": "text",
"moveQuantity": 1,
"minimumStock": 1,
"maximumStock": 1,
"locationSeqId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create Index for single product.
application/json
In Schema for service: createProductIndex request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createProductIndex HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"productId": "text",
"indexVariants": true,
"tenantId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create a ProductStoreFacility
application/json
In Schema for service: createProductStoreFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createProductStoreFacility HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"fromDate": "2025-08-28",
"facilityId": "text",
"sequenceNum": 1,
"productStoreId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create a ProductStoreFacilityGroup
application/json
In Schema for service: createProductStoreFacilityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createProductStoreFacilityGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 117
{
"fromDate": "2025-08-28",
"sequenceNumber": 1,
"facilityGroupId": "text",
"productStoreId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create ProductStoreRole
application/json
In Schema for service: createProductStoreRole request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createProductStoreRole HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 126
{
"fromDate": "2025-08-28",
"roleTypeId": "text",
"sequenceNum": 1,
"productStoreId": "text",
"partyId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create a ProductStoreSetting
application/json
In Schema for service: createProductStoreSetting request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createProductStoreSetting HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"settingValue": "text",
"productStoreId": "text",
"settingTypeEnumId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create a Product Store Shipment Method
application/json
In Schema for service: createProductStoreShipMeth request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createProductStoreShipMeth HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 734
{
"companyPartyId": "text",
"productStoreShipMethId": "text",
"allowancePercent": 1,
"shipmentCustomMethodId": "text",
"includeFeatureGroup": "text",
"minTotal": 1,
"minWeight": 1,
"requireCompanyAddr": "text",
"maxSize": 1,
"excludeGeoId": "text",
"isShippingWeightRequired": "text",
"shipmentGatewayConfigId": "text",
"minSize": 1,
"allowCompanyAddr": "text",
"productStoreId": "text",
"minimumPrice": 1,
"partyId": "text",
"shipmentMethodTypeId": "text",
"excludeFeatureGroup": "text",
"sequenceNumber": 1,
"roleTypeId": "text",
"allowUspsAddr": "text",
"maxWeight": 1,
"serviceName": "text",
"thruDate": "2025-08-28",
"fromDate": "2025-08-28",
"includeGeoId": "text",
"maxTotal": 1,
"requireUspsAddr": "text",
"configProps": "text",
"includeNoChargeItems": "text",
"isTrackingRequired": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"productStoreShipMethId": "text"
}
}
application/json
In Schema for service: createPurchaseShipment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createPurchaseShipment HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"facilityId": "text",
"orderId": "text",
"shipGroupSeqId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipmentId": "text"
}
}
Create Relationship record
application/json
In Schema for service: createRelationship request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createRelationship HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 426
{
"roleTypeIdTo": "text",
"partyIdFrom": "text",
"lastName": "text",
"extension": "text",
"phoneContactMechPurpose": "text",
"externalId": "text",
"roleTypeIdFrom": "text",
"thruDate": "2025-08-28",
"fromDate": "2025-08-28",
"partyRelationshipTypeId": "text",
"firstName": "text",
"partyTypeId": "text",
"emailAddress": "text",
"groupName": "text",
"statusId": "text",
"preferredCurrencyUomId": "text",
"emailContactMechPurpose": "text",
"contactNumber": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"partyId": "text"
}
}
Create return/sales return based on API input parameters
application/json
In Schema for service: createReturn request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createReturn HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1310
{
"payLoad": {
"externalId": "text",
"note": "text",
"returnPaymentPref": [
{
"orderId": "text",
"orderExternalId": "text",
"paymentMethodTypeId": "text",
"statusId": "text",
"manualRefNum": "text",
"parentRefNum": "text",
"maxAmount": 1,
"presentmentAmount": 1,
"presentmentCurrency": "text"
}
],
"tags": [],
"type": "text",
"createdDate": "text",
"returnDate": "text",
"customerId": "text",
"customerExternalId": "text",
"customerIdentificationType": "text",
"customerIdentificationValue": "text",
"companyId": "text",
"companyExternalId": "text",
"status": "text",
"currencyCode": "text",
"grandTotal": 1,
"returnIdentifications": [
{
"returnIdentificationTypeId": "text",
"returnIdentificationDesc": "text",
"idValue": "text"
}
],
"shipFrom": {
"postalAddress": {
"id": "text",
"externalId": "text"
}
},
"shipTo": {
"facilityId": "text"
},
"items": [
{
"id": "text",
"sku": "text",
"itemExternalId": "text",
"itemSeqId": "text",
"itemTypeId": "text",
"status": "text",
"orderId": "text",
"orderExternalId": "text",
"orderItemSeqId": "text",
"quantity": 1,
"reason": "text",
"returnType": "text",
"restockType": "text",
"price": 1,
"includeAdjustments": "text",
"itemAdjustments": [
{
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
],
"returnAdjustment": [
{
"orderId": "text",
"orderExternalId": "text",
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"payLoad": {
"externalId": "text",
"note": "text",
"returnPaymentPref": [
{
"orderId": "text",
"orderExternalId": "text",
"paymentMethodTypeId": "text",
"statusId": "text",
"manualRefNum": "text",
"parentRefNum": "text",
"maxAmount": 1,
"presentmentAmount": 1,
"presentmentCurrency": "text"
}
],
"tags": [],
"type": "text",
"createdDate": "text",
"returnDate": "text",
"customerId": "text",
"customerExternalId": "text",
"customerIdentificationType": "text",
"customerIdentificationValue": "text",
"companyId": "text",
"companyExternalId": "text",
"status": "text",
"currencyCode": "text",
"grandTotal": 1,
"returnIdentifications": [
{
"returnIdentificationTypeId": "text",
"returnIdentificationDesc": "text",
"idValue": "text"
}
],
"shipFrom": {
"postalAddress": {
"id": "text",
"externalId": "text"
}
},
"shipTo": {
"facilityId": "text"
},
"items": [
{
"id": "text",
"sku": "text",
"itemExternalId": "text",
"itemSeqId": "text",
"itemTypeId": "text",
"status": "text",
"orderId": "text",
"orderExternalId": "text",
"orderItemSeqId": "text",
"quantity": 1,
"reason": "text",
"returnType": "text",
"restockType": "text",
"price": 1,
"includeAdjustments": "text",
"itemAdjustments": [
{
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
],
"returnAdjustment": [
{
"orderId": "text",
"orderExternalId": "text",
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
}
}
Create a new role type
application/json
In Schema for service: createRoleType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createRoleType HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"roleTypeId": "text",
"parentTypeId": "text",
"description": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create Order Data based on API input parameters
application/json
In Schema for service: createSalesOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createSalesOrder HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 2196
{
"order": {
"externalId": "text",
"orderName": "text",
"locale": "text",
"tags": [],
"note": [],
"channel": "text",
"webSiteId": "text",
"customerId": "text",
"customerIdentificationType": "text",
"customerIdentificationValue": "text",
"customerExternalId": "text",
"priority": "text",
"orderDate": "text",
"entryDate": "text",
"expireDate": "text",
"statusId": "text",
"productStoreId": "text",
"currencyCode": "text",
"remainingSubTotal": 1,
"grandTotal": 1,
"autoApprove": "text",
"orderContacts": {
"email": {
"id": "text",
"externalId": "text"
}
},
"orderIdentifications": [
{
"orderIdentificationTypeId": "text",
"orderIdentificationDesc": "text",
"idValue": "text"
}
],
"orderAttributes": [
{
"attrName": "text",
"attrValue": "text",
"attrDescription": "text"
}
],
"orderContents": [
{
"orderItemSeqId": "text",
"contentId": "text",
"orderContentTypeId": "text",
"fromDate": "text",
"thruDate": "text"
}
],
"shipGroup": [
{
"facilityId": "text",
"orderFacilityId": "text",
"externalId": "text",
"maySplit": "text",
"shipBy": "text",
"shipAfter": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"trackingNumber": "text",
"shipTo": {
"postalAddress": {
"id": "text",
"externalId": "text",
"additionalPurpose": "text"
},
"email": {
"id": "text",
"externalId": "text"
},
"phoneNumber": {
"id": "text",
"externalId": "text"
}
},
"items": [
{
"itemSeqId": "text",
"productId": "text",
"itemExternalId": "text",
"sku": "text",
"status": "text",
"quantity": 1,
"unitListPrice": 1,
"unitPrice": 1,
"autoCancelDate": "text",
"itemAdjustments": [
{
"id": "text",
"type": "text",
"comments": "text",
"amount": 1,
"exemptAmount": 1,
"sourcePercentage": 1,
"setShipGroup": "text"
}
],
"orderItemAttributes": [
{
"attrName": "text",
"attrValue": "text",
"attrDescription": "text"
}
],
"orderItemAssociations": [
{
"toOrderId": "text",
"toOrderExternalId": "text",
"toOrderItemSeqId": "text",
"toShipGroupSeqId": "text",
"orderItemAssocTypeId": "text",
"quantity": 1
}
]
}
]
}
],
"orderAdjustments": [
{
"id": "text",
"type": "text",
"comments": "text",
"amount": 1,
"exemptAmount": 1,
"sourcePercentage": 1
}
],
"orderPaymentPref": [
{
"id": "text",
"paymentMethodTypeId": "text",
"paymentMode": "text",
"cardName": "text",
"code": "text",
"maxAmount": 1,
"statusId": "text"
}
],
"billTo": {
"postalAddress": {
"id": "text",
"externalId": "text"
},
"email": {
"id": "text",
"externalId": "text"
},
"phoneNumber": {
"id": "text",
"externalId": "text"
}
}
}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderId": "text"
}
}
Create Search Preference
application/json
In Schema for service: createSearchPreference request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createSearchPreference HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"searchPrefName": "text",
"isPublic": "text",
"searchPrefValue": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"searchPrefId": "text"
}
}
Create an SecurityGroup
application/json
In Schema for service: createSecurityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createSecurityGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"groupName": "text",
"groupId": "text",
"description": "text",
"groupTypeEnumId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create a SecurityPermission
application/json
In Schema for service: createSecurityPermission request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createSecurityPermission HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"permissionId": "text",
"description": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create a ShipmentBoxType record
application/json
In Schema for service: createShipmentBoxType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createShipmentBoxType HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 149
{
"boxLength": 1,
"boxWeight": 1,
"dimensionUomId": "text",
"weightUomId": "text",
"description": "text",
"boxHeight": 1,
"boxWidth": 1,
"shipmentBoxTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipmentBoxTypeId": "text"
}
}
Create ShipmentItem
application/json
In Schema for service: createShipmentItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createShipmentItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 181
{
"availableToPromise": 1,
"serialNumber": "text",
"quantity": 1,
"productId": "text",
"shipmentContentDescription": "text",
"shipmentId": "text",
"externalId": "text",
"shipmentItemSeqId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipmentItemSeqId": "text"
}
}
Creates A ShipmentMethodType
application/json
In Schema for service: createShipmentMethodType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createShipmentMethodType HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"parentTypeId": "text",
"sequenceNum": 1,
"description": "text",
"shipmentMethodTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Creates a ShipmentReceipt Record
application/json
In Schema for service: createShipmentReceipt request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createShipmentReceipt HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 415
{
"orderItemSeqId": "text",
"productId": "text",
"orderId": "text",
"quantityAccepted": 1,
"shipmentPackageSeqId": "text",
"quantityRejected": 1,
"shipmentItemSeqId": "text",
"inventoryItemDetailSeqId": "text",
"affectAccounting": true,
"rejectionId": "text",
"inventoryItemId": "text",
"receivedByUserLoginId": "text",
"shipmentId": "text",
"returnId": "text",
"returnItemSeqId": "text",
"datetimeReceived": "2025-08-28",
"itemDescription": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"receiptId": "text",
"affectAccounting": true
}
}
Import Shopify Orders
application/json
In Schema for service: createShopifyOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createShopifyOrder HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"shopifyConfigId": "text",
"payload": {}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"isFulfilled": "text",
"orderId": "text",
"autoApproveOrder": "text"
}
}
Creates a ShopifyProdLocActivation record
application/json
In Schema for service: createShopifyProdLocActivation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createShopifyProdLocActivation HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 89
{
"shopifyLocationId": "text",
"shopId": "text",
"shopifyProductId": "text",
"activated": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shopifyLocationId": "text",
"shopId": "text",
"shopifyProductId": "text"
}
}
Create return/sales return based on API input parameters
application/json
In Schema for service: createShopifyReturn request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createShopifyReturn HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1310
{
"payLoad": {
"externalId": "text",
"note": "text",
"returnPaymentPref": [
{
"orderId": "text",
"orderExternalId": "text",
"paymentMethodTypeId": "text",
"statusId": "text",
"manualRefNum": "text",
"parentRefNum": "text",
"maxAmount": 1,
"presentmentAmount": 1,
"presentmentCurrency": "text"
}
],
"tags": [],
"type": "text",
"createdDate": "text",
"returnDate": "text",
"customerId": "text",
"customerExternalId": "text",
"customerIdentificationType": "text",
"customerIdentificationValue": "text",
"companyId": "text",
"companyExternalId": "text",
"status": "text",
"currencyCode": "text",
"grandTotal": 1,
"returnIdentifications": [
{
"returnIdentificationTypeId": "text",
"returnIdentificationDesc": "text",
"idValue": "text"
}
],
"shipFrom": {
"postalAddress": {
"id": "text",
"externalId": "text"
}
},
"shipTo": {
"facilityId": "text"
},
"items": [
{
"id": "text",
"sku": "text",
"itemExternalId": "text",
"itemSeqId": "text",
"itemTypeId": "text",
"status": "text",
"orderId": "text",
"orderExternalId": "text",
"orderItemSeqId": "text",
"quantity": 1,
"reason": "text",
"returnType": "text",
"restockType": "text",
"price": 1,
"includeAdjustments": "text",
"itemAdjustments": [
{
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
],
"returnAdjustment": [
{
"orderId": "text",
"orderExternalId": "text",
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"payLoad": {
"externalId": "text",
"note": "text",
"returnPaymentPref": [
{
"orderId": "text",
"orderExternalId": "text",
"paymentMethodTypeId": "text",
"statusId": "text",
"manualRefNum": "text",
"parentRefNum": "text",
"maxAmount": 1,
"presentmentAmount": 1,
"presentmentCurrency": "text"
}
],
"tags": [],
"type": "text",
"createdDate": "text",
"returnDate": "text",
"customerId": "text",
"customerExternalId": "text",
"customerIdentificationType": "text",
"customerIdentificationValue": "text",
"companyId": "text",
"companyExternalId": "text",
"status": "text",
"currencyCode": "text",
"grandTotal": 1,
"returnIdentifications": [
{
"returnIdentificationTypeId": "text",
"returnIdentificationDesc": "text",
"idValue": "text"
}
],
"shipFrom": {
"postalAddress": {
"id": "text",
"externalId": "text"
}
},
"shipTo": {
"facilityId": "text"
},
"items": [
{
"id": "text",
"sku": "text",
"itemExternalId": "text",
"itemSeqId": "text",
"itemTypeId": "text",
"status": "text",
"orderId": "text",
"orderExternalId": "text",
"orderItemSeqId": "text",
"quantity": 1,
"reason": "text",
"returnType": "text",
"restockType": "text",
"price": 1,
"includeAdjustments": "text",
"itemAdjustments": [
{
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
],
"returnAdjustment": [
{
"orderId": "text",
"orderExternalId": "text",
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
}
}
Create a ShopifyShopCarrierShipment record
application/json
In Schema for service: createShopifyShopCarrierShipment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createShopifyShopCarrierShipment HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 102
{
"carrierPartyId": "text",
"shopifyShippingMethod": "text",
"shopId": "text",
"shipmentMethodTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shopifyShippingMethod": "text",
"shopId": "text"
}
}
Create a ShopifyShopLocation record
application/json
In Schema for service: createShopifyShopLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createShopifyShopLocation HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"facilityId": "text",
"shopifyLocationId": "text",
"shopId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"facilityId": "text",
"shopId": "text"
}
}
Create system property
application/json
In Schema for service: createSystemProperty request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createSystemProperty HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 103
{
"systemPropertyValue": "text",
"systemResourceId": "text",
"description": "text",
"systemPropertyId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"systemResourceId": "text",
"systemPropertyId": "text"
}
}
Create/Update Order Adjustment
application/json
In Schema for service: createUpdateOrderAdjustment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createUpdateOrderAdjustment HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 896
{
"customerReferenceId": "text",
"correspondingProductId": "text",
"orderId": "text",
"includeInShipping": "text",
"description": "text",
"exemptAmount": 1,
"productPromoId": "text",
"taxAuthPartyId": "text",
"lastModifiedByUserLogin": "text",
"oldPercentage": 1,
"primaryGeoId": "text",
"taxAuthGeoId": "text",
"originalAdjustmentId": "text",
"secondaryGeoId": "text",
"createdByUserLogin": "text",
"amountAlreadyIncluded": 1,
"orderAdjustmentId": "text",
"orderItemSeqId": "text",
"amount": 1,
"comments": "text",
"recurringAmount": 1,
"lastModifiedDate": "2025-08-28",
"sourceReferenceId": "text",
"isManual": "text",
"productPromoRuleId": "text",
"orderAdjustmentTypeId": "text",
"taxAuthorityRateSeqId": "text",
"productFeatureId": "text",
"oldAmountPerQuantity": 1,
"overrideGlAccountId": "text",
"shipGroupSeqId": "text",
"includeInTax": "text",
"createdDate": "2025-08-28",
"productPromoActionSeqId": "text",
"billingShipmentId": "text",
"sourcePercentage": 1
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create or update a OrderAttribute
application/json
In Schema for service: createUpdateOrderAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createUpdateOrderAttribute HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"orderId": "text",
"attrDescription": "text",
"attrValue": "text",
"attrName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create and Update email address
application/json
In Schema for service: createUpdatePartyEmailAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createUpdatePartyEmailAddress HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 97
{
"emailAddress": "text",
"contactMechPurposeTypeId": "text",
"partyId": "text",
"contactMechId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"emailAddress": "text",
"contactMechId": "text"
}
}
Create and Update telecom number
application/json
In Schema for service: createUpdatePartyTelecomNumber request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createUpdatePartyTelecomNumber HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 358
{
"askForName": "text",
"extension": "text",
"roleTypeId": "text",
"comments": "text",
"verified": "text",
"monthsWithContactMech": 1,
"contactMechId": "text",
"thruDate": "2025-08-28",
"fromDate": "2025-08-28",
"areaCode": "text",
"allowSolicitation": "text",
"yearsWithContactMech": 1,
"contactMechPurposeTypeId": "text",
"countryCode": "text",
"contactNumber": "text",
"partyId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}
Creates new shipping address and update existing address
application/json
In Schema for service: createUpdateShippingAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createUpdateShippingAddress HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 353
{
"setDefaultShipping": "text",
"shipToContactMechId": "text",
"shipToStateProvinceGeoId": "text",
"shipToCity": "text",
"keepAddressBook": "text",
"shipToPostalCode": "text",
"shipToAddress1": "text",
"billToContactMechId": "text",
"shipToAddress2": "text",
"shipToCountryGeoId": "text",
"shipToName": "text",
"productStoreId": "text",
"partyId": "text",
"shipToAttnName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}
Shop name eg. myshop is shop name for https://myshop.myshopify.com
application/json
In Schema for service: createUpdateShopifyShop request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createUpdateShopifyShop HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 235
{
"shopifyConfigId": "text",
"clientId": "text",
"shop": "text",
"processRefund": "text",
"shopifyConfigName": "text",
"shopId": "text",
"productStoreId": "text",
"oldSharedSecret": "text",
"accessToken": "text",
"sharedSecret": "text",
"webSiteId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shopId": "text"
}
}
Create User Search Preference
application/json
In Schema for service: createUserSearchPreference request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/createUserSearchPreference HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"fromDate": "2025-08-28",
"userSearchPrefTypeId": "text",
"searchPrefId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete an existing Carrier Shipment Box Type Record
application/json
In Schema for service: deleteCarrierShipmentBoxType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteCarrierShipmentBoxType HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"partyId": "text",
"shipmentBoxTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Deletes A CarrierShipmentMethod
application/json
In Schema for service: deleteCarrierShipmentMethod request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteCarrierShipmentMethod HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"roleTypeId": "text",
"partyId": "text",
"shipmentMethodTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete a DataManagerMapping
application/json
In Schema for service: deleteDataManagerMapping request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteDataManagerMapping HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"mappingPrefId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete a Enumeration
application/json
In Schema for service: deleteEnumeration request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteEnumeration HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"enumId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete enumeration group member
application/json
In Schema for service: deleteEnumerationGroupMember request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteEnumerationGroupMember HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 76
{
"fromDate": "2025-08-28",
"enumerationId": "text",
"enumerationGroupId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete a ExternalFulfillmentOrderItem record
application/json
In Schema for service: deleteExternalFulfillmentOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteExternalFulfillmentOrderItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"externalFulfillmentOrderItemId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete a Facility Group
application/json
In Schema for service: deleteFacilityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteFacilityGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"facilityGroupId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete a Facility Location
application/json
In Schema for service: deleteFacilityLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteFacilityLocation HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"facilityId": "text",
"locationSeqId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete an OrderAttribute record
application/json
In Schema for service: deleteOrderAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteOrderAttribute HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"orderId": "text",
"attrName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete Order Item Attribute
application/json
In Schema for service: deleteOrderItemAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteOrderItemAttribute HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 60
{
"orderItemSeqId": "text",
"orderId": "text",
"attrName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete a PartyContactMech
application/json
In Schema for service: deletePartyContactMech request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deletePartyContactMech HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"partyId": "text",
"contactMechId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete a Party Role (remove a Role from a Party). The logged in user must have PARTYMGR_DELETE or have
permission to change the role of this partyId
Delete a Party Role (remove a Role from a Party). The logged in user must have PARTYMGR_DELETE or have permission to change the role of this partyId
application/json
In Schema for service: deletePartyRole request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deletePartyRole HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"roleTypeId": "text",
"partyId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete a ProductStoreFacilityGroup
application/json
In Schema for service: deleteProductStoreFacilityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteProductStoreFacilityGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"fromDate": "2025-08-28",
"facilityGroupId": "text",
"productStoreId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete ShipmentItem
application/json
In Schema for service: deleteShipmentItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteShipmentItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"shipmentId": "text",
"shipmentItemSeqId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Deletes A ShipmentMethodType
application/json
In Schema for service: deleteShipmentMethodType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteShipmentMethodType HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"shipmentMethodTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete a ShopifyShopCarrierShipment record
application/json
In Schema for service: deleteShopifyShopCarrierShipment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteShopifyShopCarrierShipment HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 102
{
"carrierPartyId": "text",
"shopifyShippingMethod": "text",
"shopId": "text",
"shipmentMethodTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Delete a ShopifyShopLocation record
application/json
In Schema for service: deleteShopifyShopLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/deleteShopifyShopLocation HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"facilityId": "text",
"shopifyLocationId": "text",
"shopId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
application/json
In Schema for service: doRateShopping request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/doRateShopping HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"shipmentId": "text",
"forceRateShop": true,
"generateLabel": true
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"carrierPartyId": "text",
"shipmentRouteSegmentId": "text",
"billingWeight": 1,
"billingWeightUomId": "text",
"shipmentMethodTypeId": "text",
"actualCost": 1
}
}
Ensure that the party is in the specified role.
application/json
In Schema for service: ensurePartyRole request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/ensurePartyRole HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"roleTypeId": "text",
"partyId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Send a post request to run a DAG in airflow
application/json
In Schema for service: executeServiceFromAirflow request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/executeServiceFromAirflow HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"payload": {},
"dagId": "text",
"airflowPayload": {},
"serviceName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Expire a FacilityCalendar Record
application/json
In Schema for service: expireFacilityCalendar request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/expireFacilityCalendar HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 121
{
"fromDate": "2025-08-28",
"facilityId": "text",
"calendarId": "text",
"facilityCalendarTypeId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Finds productId(s) corresponding to a product reference, productId or a GoodIdentification idValue
Finds productId(s) corresponding to a product reference, productId or a GoodIdentification idValue
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/findProductById HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"productsList": [
"text"
]
}
}
Set hasLoggedOut to Y.
application/json
In Schema for service: forceLogout request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/forceLogout HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"userLoginId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Address Validation Request
application/json
In Schema for service: gatewayShipAddressValidationRequest request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/gatewayShipAddressValidationRequest HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 111
{
"carrierPartyId": "text",
"shipmentGatewayConfigId": "text",
"shipmentMethodTypeId": "text",
"contactMechId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Check for shopify order to approve
application/json
In Schema for service: generateCustomerOrderUpdateLink request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/generateCustomerOrderUpdateLink HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"orderId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"url": "text"
}
}
Service for generate manifest
application/json
In Schema for service: generateManifests request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/generateManifests HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 82
{
"carrierPartyId": "text",
"facilityId": "text",
"manifestGenerateServiceName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getCODOrderRemainingTotal HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"total": 1
}
}
Send a post request to run a DAG in airflow
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getDAGRunStatus HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Get facilityId by identification type ID
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getFacilityIdByType HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"facilityId": "text"
}
}
Returns the geoPoint for country postal code
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getGeoPointForPostalCode HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"cacheKey": "text",
"geoPoint": {}
}
}
Get Inventory Availability for a Product constrained by a facilityId
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getInventoryAvailableByFacility HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"quantityOnHandTotal": 1,
"accountingQuantityTotal": 1,
"availableToPromiseTotal": 1
}
}
Get Inventory Availability for a Product constrained by a facility and location
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getInventoryAvailableByLocation HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"quantityOnHandTotal": 1,
"accountingQuantityTotal": 1,
"availableToPromiseTotal": 1
}
}
Get orderId by order identification type ID
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getOrderIdByType HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderId": "text"
}
}
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getProductFutureAtp HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"futureAtp": 1
}
}
Get Inventory Availability for a Product
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getProductInventoryAvailable HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"quantityOnHandTotal": 1,
"accountingQuantityTotal": 1,
"availableToPromiseTotal": 1
}
}
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getProductOnlineAtp HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"onlineAtp": 1
}
}
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getServerTimeZone HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"serverTimeZone": "text"
}
}
Main method to get shipping label from Third Party Shipping Services
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getShippingLabel HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Get Shopify draft order.
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getShopifyDraftOrder HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"response": {}
}
}
Get Shopify Webhooks created from API
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getShopifyWebhooks HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"webhooks": [
"text"
]
}
}
Gets a single user preference.
If not found for the specific userLogin, find it for the _NA_ userlogin.
If the value is DEFAULT, find the value in general.properties file.
Gets a single user preference. If not found for the specific userLogin, find it for the NA userlogin. If the value is DEFAULT, find the value in general.properties file.
Service In Parameters in JSON
application/json
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
GET /rest/services/getUserPreference HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"userPrefMap": {}
}
}
This enhancement aims to streamline the data manager configuration process,
enabling the efficient creation of multiple data objects using a single JSON file.
The introduction of the `importJsonListData` service ensures flexibility and
ease of use.
This service will take the list of json data.
This enhancement aims to streamline the data manager configuration process, enabling the efficient creation of multiple data objects using a single JSON file. The introduction of the importJsonListData
service ensures flexibility and ease of use. This service will take the list of json data.
application/json
In Schema for service: importJsonListData request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/importJsonListData HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"dataList": [
"text"
]
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
application/json
In Schema for service: importProductFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/importProductFacility HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 271
{
"allowPickup": "text",
"productSku": "text",
"reorderPoint": "text",
"idType": "text",
"facilityId": "text",
"productId": "text",
"facilityExternalId": "text",
"salesVelocity": "text",
"allowBrokering": "text",
"reorderQuantity": "text",
"maximumStock": "text",
"facilityMinimumStock": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Service for fetching indexing instance details to Solr
application/json
In Schema for service: indexDeploymentData request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/indexDeploymentData HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"updateHandler": "text",
"coreName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Service for indexing instance details to Solr recieved from API call
application/json
In Schema for service: indexExternalDeploymentData request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/indexExternalDeploymentData HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"updateHandler": "text",
"deploymentData": {},
"coreName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Service for indexing webhook error details to Solr
application/json
In Schema for service: indexWebhookErrorMessage request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/indexWebhookErrorMessage HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 89
{
"payload": {},
"remoteUrl": "text",
"comment": "text",
"topicEnumId": "text",
"coreName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Inventory update service triggers on Shopify Inventory Level Update webhook
application/json
In Schema for service: inventoryLevelUpdateFromShopify request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/inventoryLevelUpdateFromShopify HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 78
{
"shopifyConfigId": "text",
"inventory_item_id": 1,
"available": 1,
"location_id": 1
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
application/json
In Schema for service: moveItemToParkingFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/moveItemToParkingFacility HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 138
{
"fromShipGroupSeqId": "text",
"orderItemSeqId": "text",
"comments": "text",
"orderId": "text",
"changeReasonEnumId": "text",
"toFacilityId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Check if fulfillment started for item and then reject it
application/json
In Schema for service: oldCheckAndRejectOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/oldCheckAndRejectOrderItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 146
{
"orderItemSeqId": "text",
"excludeOrderFacilityDuration": "text",
"orderId": "text",
"rejectionComments": "text",
"rejectionReason": "text",
"notify": true
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Reject Order Item
application/json
In Schema for service: oldRejectOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/oldRejectOrderItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"payload": {},
"rejectedComponents": [
"text"
]
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderItemSeqId": "text",
"orderId": "text",
"payload": {},
"rejectedItemsList": [
"text"
]
}
}
Reject Order Line Item
application/json
In Schema for service: oldRejectOrderItems request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/oldRejectOrderItems HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"payload": {}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderId": "text",
"payload": {},
"rejectedItemsList": [
"text"
]
}
}
To import order usign csv (Either posted by script or uploaded from browser)
application/json
In Schema for service: orderDataSetup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/orderDataSetup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1031
{
"shippingCity": "text",
"lastName": "text",
"externalPlacingFacilityId": "text",
"orderId": "text",
"orderTypeId": "text",
"originExternalFacilityId": "text",
"shippingPostalCode": "text",
"shippingAddress2": "text",
"externalFacilityId": "text",
"shippingAddress1": "text",
"shippingTax": "text",
"externalProductStoreId": "text",
"unitListPrice": "text",
"shippingCountry": "text",
"itemStatus": "text",
"salesChannelEnumCode": "text",
"customerId": "text",
"productStoreId": "text",
"shipmentMethodTypeId": "text",
"orderItemTypeId": "text",
"orderName": "text",
"unitPrice": "text",
"quantity": "text",
"idType": "text",
"facilityId": "text",
"productId": "text",
"shippingCharges": "text",
"grandTotal": "text",
"customerExternalId": "text",
"externalId": "text",
"idValue": "text",
"shippingPhone": "text",
"placingFacilityId": "text",
"orderIdentification": "text",
"itemTotalDiscount": "text",
"originFacilityId": "text",
"carrierPartyId": "text",
"firstName": "text",
"itemExternalId": "text",
"paymentMethod": "text",
"shippingState": "text",
"itemTax": "text",
"orderDate": "text",
"shippingEmail": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
The Facility Item Allocation Service is designed to efficiently manage and allocate items within an order to specific facilities.
This service is crucial for ensuring that items are moved to the appropriate ship group and that reservations are accurately performed.
Below are the key functionalities of this service:
- Item Allocation: Allocates items to a specified facility within an order.
- Add Auto Cancel Date: Set a specific date when an order item should be automatically canceled if not processed.
- Remove Auto Cancel Date: If an order item no longer requires an automatic cancellation, you can easily remove the set auto cancel date.
- Ship Group Management: Moves items to the appropriate ship group as per allocation.
- Item Reservation: Executes reservation of items as part of the allocation process.
- Error Handling: Throws an error if an item is found in a non-virtual facility or encounters any other error condition. Conversely, it returns a success response if an item is already allocated to the specified facility.
Input Parameters:
The service accepts the following input parameters for processing:
- orderId: The unique identifier of the order for which allocation is being performed.
- externalOrderId: An optional external ID associated with the order.
- facilityAllocation: A collection of objects detailing the allocation of items to specific facilities. Each object in this array includes:
- facilityId: Identifier of the facility to which items are being allocated.
- facilityExternalId: An optional external ID for the facility.
- items: A list of item objects, each comprising:
- orderItemSeqId: Sequence ID of the order item.
- autoCancelDate: An optional date when an order item should be automatically canceled if not processed.
- clearAutoCancelDate: Allows you to remove the auto cancel date set on an order item
- orderItemExternalId: An optional external ID for the order item.
- quantity: Number of units of the item to allocate.
Sample JSON Input:
json
```
{
"orderId": "105",
"externalOrderId": "",
"facilityAllocation": [
{
"facilityId": "1",
"items": [
{
"orderItemSeqId": "00101",
"quantity": 1
},
{
"orderItemSeqId": "00102",
"quantity": 1
}
]
},
{
"facilityId": "10",
"items": [
{
"orderItemSeqId": "00103",
"orderItemExternalId": "",
"quantity": 1
}
]
}
]
}
```
Service Operation:
Upon receiving the input parameters, the service will:
- Validate all input data for correctness and completeness.
- Check the current facility status of each item.
- Allocate items to the specified facilities as per the input.
- Perform necessary item reservations.
- Return a success response if an item is already allocated to the specified facility.
- In cases where an item is located in a virtual facility or if other error conditions arise, the service will throw an error.
This service ensures streamlined and error-free allocation of items to facilities, enhancing the efficiency of order processing and fulfillment.
The Facility Item Allocation Service is designed to efficiently manage and allocate items within an order to specific facilities. This service is crucial for ensuring that items are moved to the appropriate ship group and that reservations are accurately performed. Below are the key functionalities of this service:
- Item Allocation: Allocates items to a specified facility within an order.
- Add Auto Cancel Date: Set a specific date when an order item should be automatically canceled if not processed.
- Remove Auto Cancel Date: If an order item no longer requires an automatic cancellation, you can easily remove the set auto cancel date.
- Ship Group Management: Moves items to the appropriate ship group as per allocation.
- Item Reservation: Executes reservation of items as part of the allocation process.
- Error Handling: Throws an error if an item is found in a non-virtual facility or encounters any other error condition. Conversely, it returns a success response if an item is already allocated to the specified facility.
Input Parameters:
The service accepts the following input parameters for processing:
- orderId: The unique identifier of the order for which allocation is being performed.
- externalOrderId: An optional external ID associated with the order.
- facilityAllocation: A collection of objects detailing the allocation of items to specific facilities. Each object in this array includes:
- facilityId: Identifier of the facility to which items are being allocated.
- facilityExternalId: An optional external ID for the facility.
- items: A list of item objects, each comprising:
- orderItemSeqId: Sequence ID of the order item.
- autoCancelDate: An optional date when an order item should be automatically canceled if not processed.
- clearAutoCancelDate: Allows you to remove the auto cancel date set on an order item
- orderItemExternalId: An optional external ID for the order item.
- quantity: Number of units of the item to allocate.
Sample JSON Input:
json
```
{
"orderId": "105",
"externalOrderId": "",
"facilityAllocation": [
{
"facilityId": "1",
"items": [
{
"orderItemSeqId": "00101",
"quantity": 1
},
{
"orderItemSeqId": "00102",
"quantity": 1
}
]
},
{
"facilityId": "10",
"items": [
{
"orderItemSeqId": "00103",
"orderItemExternalId": "",
"quantity": 1
}
]
}
]
}
```
Service Operation:
Upon receiving the input parameters, the service will:
- Validate all input data for correctness and completeness.
- Check the current facility status of each item.
- Allocate items to the specified facilities as per the input.
- Perform necessary item reservations.
- Return a success response if an item is already allocated to the specified facility.
- In cases where an item is located in a virtual facility or if other error conditions arise, the service will throw an error.
This service ensures streamlined and error-free allocation of items to facilities, enhancing the efficiency of order processing and fulfillment.
application/json
In Schema for service: orderFulfillmentAllocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/orderFulfillmentAllocation HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"orderId": "text",
"externalOrderId": "text",
"facilityAllocation": [
"text"
]
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Mark picklist bin items as Picked
application/json
In Schema for service: packStoreFulfillmentOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/packStoreFulfillmentOrder HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"orderId": "text",
"picklistBinId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Imports picklist And Picklist Item
application/json
In Schema for service: picklistDataSetup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/picklistDataSetup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 280
{
"inventoryItemId": "text",
"orderItemSeqId": "text",
"picklistId": "text",
"quantity": "text",
"facilityId": "text",
"pickerIds": [
"text"
],
"picked": "text",
"orderId": "text",
"externalId": "text",
"shipGroupSeqId": "text",
"shipmentMethodTypeId": "text",
"itemStatusId": "text",
"binLocationNumber": 1
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"picklistId": "text",
"picklistBinId": "text"
}
}
Pull And Report Entity Sync Data
application/json
In Schema for service: pullAndReportEntitySyncData request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/pullAndReportEntitySyncData HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 243
{
"delegatorName": "text",
"entitySyncId": "text",
"toStoreUpdated": 1,
"toCreateInserted": 1,
"toCreateUpdated": 1,
"toCreateNotUpdated": 1,
"toRemoveAlreadyDeleted": 1,
"toStoreNotUpdated": 1,
"toRemoveDeleted": 1,
"toStoreInserted": 1,
"startDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"valuesToStore": [
"text"
],
"keysToRemove": [
"text"
],
"valuesToCreate": [
"text"
],
"startDate": "2025-08-28"
}
}
Service to reship completed order items
application/json
In Schema for service: reShipOrderItems request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/reShipOrderItems HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"orderItemSeqId": [
"text"
],
"orderId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"originalOrderId": "text",
"orderId": "text"
}
}
Recieve Incoming Shipment and push Inventory on Shopify
application/json
In Schema for service: receiveAndUpdateInventoryToShopify request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/receiveAndUpdateInventoryToShopify HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"shipmentId": "text",
"limit": 1,
"shopId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
This service is used to record inventory variance
application/json
In Schema for service: recordInventoryCount request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/recordInventoryCount HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 148
{
"reason": "text",
"comments": "text",
"quantity": "text",
"facilityId": "text",
"idType": "text",
"productId": "text",
"idValue": "text",
"locationSeqId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
application/json
In Schema for service: recordProductVariance request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/recordProductVariance HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 161
{
"orderItemSeqId": "text",
"varianceReasonId": "text",
"comments": "text",
"quantity": 1,
"facilityId": "text",
"productId": "text",
"orderId": "text",
"locationSeqId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Reject in progress shipment item.
application/json
In Schema for service: rejectFulfillmentReadyOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/rejectFulfillmentReadyOrderItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 175
{
"affectQOH": true,
"excludeOrderFacilityDuration": 1,
"facilityId": "text",
"rejectAllRelatedShipment": "text",
"rejectEntireShipment": "text",
"items": [
"text"
],
"defaultReason": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Reject Order Item
application/json
In Schema for service: rejectOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/rejectOrderItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"payload": {},
"rejectedComponents": [
"text"
]
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderItemSeqId": "text",
"orderId": "text",
"payload": {},
"rejectedItemsList": [
"text"
]
}
}
Reject Order Line Item
application/json
In Schema for service: rejectOrderItems request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/rejectOrderItems HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"payload": {}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderId": "text",
"payload": {},
"rejectedItemsList": [
"text"
]
}
}
Cancel reservations and if fulfillent started cancel shipment also.
application/json
In Schema for service: rejectTransferOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/rejectTransferOrderItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"orderItemSeqId": "text",
"orderId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Service to release Order Item from one facility to another
application/json
In Schema for service: releaseOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/releaseOrderItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 141
{
"orderItemSeqId": "text",
"routerUserLogin": "text",
"fromFacilityId": "text",
"orderId": "text",
"changeReasonEnumId": "text",
"toFacilityId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipGroupSeqId": "text"
}
}
Wrapper Service For Removing Category Products
application/json
In Schema for service: removeCategoryProducts request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/removeCategoryProducts HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 71
{
"fromDate": "2025-08-28",
"productCategoryId": "text",
"productId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Remove firebase client registration token
application/json
In Schema for service: removeClientRegistrationToken request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/removeClientRegistrationToken HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"applicationId": "text",
"deviceId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Remove Facility From FacilityGroup
application/json
In Schema for service: removeFacilityFromGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/removeFacilityFromGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"fromDate": "2025-08-28",
"facilityId": "text",
"facilityGroupId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Removing association of a Party from Facility
application/json
In Schema for service: removePartyFromFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/removePartyFromFacility HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"fromDate": "2025-08-28",
"roleTypeId": "text",
"facilityId": "text",
"partyId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
application/json
In Schema for service: removePartyUserPermission request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/removePartyUserPermission HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"userLoginId": "text",
"groupId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"userLoginId": "text"
}
}
Remove existing webhook on Shopify
application/json
In Schema for service: removeShopifyWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/removeShopifyWebhook HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"shopifyConfigId": "text",
"webhookId": 1
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Reset Password
application/json
In Schema for service: resetPassword request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/resetPassword HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 148
{
"userLoginId": "text",
"newPasswordVerify": "text",
"passwordHint": "text",
"newPassword": "text",
"requirePasswordChange": "text",
"currentPassword": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"updatedUserLogin": {
"lastUpdatedStamp": "2025-08-28",
"isExternal": "text",
"passwordHint": "text",
"createdTxStamp": "2025-08-28",
"createdStamp": "2025-08-28",
"externalAuthId": "text",
"lastUpdatedTxStamp": "2025-08-28",
"lastTimeZone": "text",
"enabled": "text",
"lastLocale": "text",
"currentPassword": "text",
"userLoginId": "text",
"isSystem": "text",
"disabledDateTime": "2025-08-28",
"disabledBy": "text",
"hasLoggedOut": "text",
"userLdapDn": "text",
"requirePasswordChange": "text",
"lastCurrencyUom": "text",
"partyId": "text"
}
}
}
Reset all pickers on picklist.
application/json
In Schema for service: resetPicker request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/resetPicker HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"picklistId": "text",
"pickerIds": [
"text"
]
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Send order Webhook message using Webhook Config.
application/json
In Schema for service: sendOrderWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/sendOrderWebhook HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"orderId": "text",
"topicEnumId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Send a pickup scheduled notification for all type of shipment.
application/json
In Schema for service: sendPickupScheduledNotification request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/sendPickupScheduledNotification HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"emailType": "text",
"shipmentId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Send a ready to pick up item notification for STOREPICKUP type
application/json
In Schema for service: sendReadyToPickupItemNotification request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/sendReadyToPickupItemNotification HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"emailType": "text",
"shipmentId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
This service will create/update preferred store(default facility) of a customer
application/json
In Schema for service: setCustomerDefaultStore request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/setCustomerDefaultStore HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 84
{
"facilityId": "text",
"customerId": "text",
"shopDomain": "text",
"shopifyShopId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Set/update Reason Id on Return Item
application/json
In Schema for service: setReasonIdOnReturnItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/setReasonIdOnReturnItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 122
{
"reason": "text",
"returnReasonId": "text",
"shopifyReturnId": "text",
"shopifyOrderLineItemId": "text",
"shopifyOrderId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Sets a single user preference.
application/json
In Schema for service: setUserPreference request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/setUserPreference HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 102
{
"userPrefGroupTypeId": "text",
"userPrefValue": "text",
"userPrefTypeId": "text",
"userPrefLoginId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Shop name eg. myshop is shop name for https://myshop.myshopify.com
application/json
In Schema for service: setupShopifyShop request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/setupShopifyShop HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 262
{
"accessScopeEnumId": "text",
"shopifyConfigId": "text",
"clientId": "text",
"shop": "text",
"processRefund": "text",
"shopifyConfigName": "text",
"shopId": "text",
"productStoreId": "text",
"oldSharedSecret": "text",
"accessToken": "text",
"sharedSecret": "text",
"webSiteId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shopifyConfigId": "text",
"shopId": "text"
}
}
Create association of store with a calendar
application/json
In Schema for service: storeCalendarAssocDataSetup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/storeCalendarAssocDataSetup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"calendarId": "text",
"thruDateStr": "text",
"fromDateStr": "text",
"storeId": "text",
"calendarTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Store firebase client registration token
application/json
In Schema for service: storeClientRegistrationToken request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/storeClientRegistrationToken HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 69
{
"registrationToken": "text",
"applicationId": "text",
"deviceId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Run Entity Sync
application/json
In Schema for service: storeEntitySyncData request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/storeEntitySyncData HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 121
{
"valuesToStore": [
"text"
],
"delegatorName": "text",
"entitySyncId": "text",
"keysToRemove": [
"text"
],
"valuesToCreate": [
"text"
]
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"toStoreUpdated": 1,
"toCreateInserted": 1,
"toCreateUpdated": 1,
"toCreateNotUpdated": 1,
"toRemoveAlreadyDeleted": 1,
"toStoreNotUpdated": 1,
"toRemoveDeleted": 1,
"toStoreInserted": 1
}
}
Subscribe order cancel webhook on Shopify
application/json
In Schema for service: subscribeCancelOrderShopifyWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/subscribeCancelOrderShopifyWebhook HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"endpoint": "text",
"shopifyConfigId": "text",
"topic": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"webhook": "text"
}
}
Subscribe order create webhook on Shopify
application/json
In Schema for service: subscribeCreateOrderShopifyWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/subscribeCreateOrderShopifyWebhook HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"endpoint": "text",
"shopifyConfigId": "text",
"topic": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"webhook": "text"
}
}
Subscribe file status update webhook on Shopify
application/json
In Schema for service: subscribeFileStatusUpdateWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/subscribeFileStatusUpdateWebhook HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"shopifyConfigId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Subscribe order paid webhook on Shopify
application/json
In Schema for service: subscribeOrderPaidWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/subscribeOrderPaidWebhook HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"shopifyConfigId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Subscribe order return webhook on Shopify
application/json
In Schema for service: subscribeReturnOrderShopifyWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/subscribeReturnOrderShopifyWebhook HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"endpoint": "text",
"shopifyConfigId": "text",
"topic": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"webhook": "text"
}
}
Subscribe webhook on Shopify
application/json
In Schema for service: subscribeShopifyWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/subscribeShopifyWebhook HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 75
{
"endpoint": "text",
"shopifyConfigId": "text",
"format": "text",
"topic": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"webhook": "text"
}
}
Subscribe Topic
application/json
In Schema for service: subscribeTopic request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/subscribeTopic HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"topicName": "text",
"applicationId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Test service
application/json
In Schema for service: testCommit request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/testCommit HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"message": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"resp": "text"
}
}
application/json
In Schema for service: testError request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/testError HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 2
{}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Test service
application/json
In Schema for service: testRollback request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/testRollback HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"message": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"resp": "text"
}
}
Test service
application/json
In Schema for service: testScv request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/testScv HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"defaultValue": 1,
"message": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"resp": "text"
}
}
Send a post request to run a DAG in airflow
application/json
In Schema for service: triggerDag request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/triggerDag HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"endpoint": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
This service unlinks return from the order, It won't delete the data from the entities.
application/json
In Schema for service: unlinkReturnFromOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/unlinkReturnFromOrder HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"returnId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Unlock order item in a bin
application/json
In Schema for service: unlockStoreFulfillmentOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/unlockStoreFulfillmentOrder HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"orderId": "text",
"picklistBinId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
unsubscribe webhook on Shopify
application/json
In Schema for service: unsubscribeShopifyWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/unsubscribeShopifyWebhook HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"shopifyConfigId": "text",
"topic": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Unsubscribe Topic
application/json
In Schema for service: unsubscribeTopic request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/unsubscribeTopic HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"topicName": "text",
"applicationId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Updating all the orderItems, if the orderItemSeqId not provided in context.
application/json
In Schema for service: updateAllOrderItems request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateAllOrderItems HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1413
{
"requestedDeliveryTime": "text",
"orderId": "text",
"isNewProduct": "text",
"returnTillDate": "2025-08-28",
"deploymentId": "text",
"cancelBackOrderDate": "2025-08-28",
"itemDescription": "text",
"selectedAmount": 1,
"unitPrice": 1,
"orderItemSeqId": "text",
"productId": "text",
"unitRecurringPrice": 1,
"autoCancelDate": "2025-08-28",
"isItemGroupPrimary": "text",
"productFeatureId": "text",
"overrideGlAccountId": "text",
"budgetId": "text",
"taxCode": "text",
"supplierProductId": "text",
"estimatedDeliveryDate": "2025-08-28",
"shipGroupSeqId": "text",
"quoteId": "text",
"requestedShipMethTypeId": "text",
"availableToPromise": 1,
"statusId": "text",
"syncStatusId": "text",
"requestedDeliveryDate": "text",
"estimatedShipDate": "2025-08-28",
"shoppingListItemSeqId": "text",
"subscriptionId": "text",
"salesOpportunityId": "text",
"dontCancelSetUserLogin": "text",
"promisedDatetime": "2025-08-28",
"isModifiedPrice": "text",
"isPromo": "text",
"shipBeforeDate": "2025-08-28",
"productCategoryId": "text",
"unitListPrice": 1,
"shoppingListId": "text",
"unitAverageCost": 1,
"orderItemTypeId": "text",
"dontCancelSetDate": "2025-08-28",
"comments": "text",
"quantity": 1,
"recurringFreqUomId": "text",
"orderItemGroupSeqId": "text",
"quoteItemSeqId": "text",
"fromInventoryItemId": "text",
"externalId": "text",
"budgetItemSeqId": "text",
"correspondingPoId": "text",
"cancelQuantity": 1,
"shipAfterDate": "2025-08-28",
"deliveryWindow": 1,
"shipmentId": "text",
"changeByUserLoginId": "text",
"prodCatalogId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Updates A CarrierShipmentMethod
application/json
In Schema for service: updateCarrierShipmentMethod request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateCarrierShipmentMethod HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 132
{
"sequenceNumber": 1,
"roleTypeId": "text",
"deliveryDays": 1,
"partyId": "text",
"carrierServiceCode": "text",
"shipmentMethodTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
update a DataManagerConfig
application/json
In Schema for service: updateDataManagerConfig request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateDataManagerConfig HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 381
{
"importPath": "text",
"exportServiceScreenLocation": "text",
"exportServiceScreenName": "text",
"importServiceName": "text",
"fileNamePattern": "text",
"multiThreading": "text",
"description": "text",
"priority": 1,
"exportPath": "text",
"exportContentId": "text",
"notifyOnFailure": "text",
"delimiter": "text",
"configId": "text",
"exportServiceName": "text",
"scriptTitle": "text",
"executionModeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"configId": "text"
}
}
Update a DataManagerMapping
application/json
In Schema for service: updateDataManagerMapping request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateDataManagerMapping HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 154
{
"fromDate": "2025-08-28",
"mappingPrefName": "text",
"mappingPrefTypeEnumId": "text",
"mappingPrefId": "text",
"mappingPrefValue": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a Enumeration
application/json
In Schema for service: updateEnumeration request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateEnumeration HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 165
{
"enumTypeId": "text",
"enumId": "text",
"sequenceNum": 1,
"enumCode": "text",
"primaryEnumerationGroupId": "text",
"description": "text",
"enumName": "text",
"sequenceId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update enumeration group member
application/json
In Schema for service: updateEnumerationGroupMember request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateEnumerationGroupMember HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"fromDate": "2025-08-28",
"enumerationId": "text",
"sequenceNum": 1,
"enumerationGroupId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Bulk Update Facility -> Group Member
application/json
In Schema for service: updateFacilitiesToGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateFacilitiesToGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"payload": {}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a Facility
application/json
In Schema for service: updateFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateFacility HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 571
{
"facilityId": "text",
"defaultInventoryItemTypeId": "text",
"parentFacilityId": "text",
"postalCode": "text",
"externalId": "text",
"description": "text",
"defaultWeightUomId": "text",
"primaryFacilityGroupId": "text",
"openedDate": "2025-08-28",
"ownerPartyId": "text",
"facilityTimeZone": "text",
"facilitySize": 1,
"closedDate": "2025-08-28",
"facilitySizeUomId": "text",
"maximumOrderLimit": 1,
"closeTime": "text",
"defaultDaysToShip": 1,
"facilityTypeId": "text",
"defaultDimensionUomId": "text",
"productStoreId": "text",
"facilityName": "text",
"openTime": "text",
"geoPointId": "text",
"oldSquareFootage": 1
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update an Email Address
application/json
In Schema for service: updateFacilityEmailAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateFacilityEmailAddress HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 151
{
"fromDate": "2025-08-28",
"emailAddress": "text",
"extension": "text",
"comments": "text",
"facilityId": "text",
"contactMechId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}
Update a Facility Group
application/json
In Schema for service: updateFacilityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateFacilityGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"primaryParentGroupId": "text",
"facilityGroupTypeId": "text",
"facilityGroupId": "text",
"description": "text",
"facilityGroupName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a FacilityIdentification
application/json
In Schema for service: updateFacilityIdentification request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateFacilityIdentification HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"fromDate": "2025-08-28",
"facilityId": "text",
"idValue": "text",
"facilityIdenTypeId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a Facility Location
application/json
In Schema for service: updateFacilityLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateFacilityLocation HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 245
{
"nextCountDate": "text",
"lastCountDate": "text",
"areaId": "text",
"facilityId": "text",
"positionId": "text",
"isLocked": "text",
"levelId": "text",
"sectionId": "text",
"geoPointId": "text",
"locationTypeEnumId": "text",
"aisleId": "text",
"locationSeqId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a Postal Address
application/json
In Schema for service: updateFacilityPostalAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateFacilityPostalAddress HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 542
{
"houseNumberExt": "text",
"extension": "text",
"city": "text",
"latitude": "text",
"postalCodeGeoId": "text",
"postalCode": "text",
"houseNumber": 1,
"postalCodeExt": "text",
"contactMechId": "text",
"attnName": "text",
"countyGeoId": "text",
"toName": "text",
"cityGeoId": "text",
"longitude": "text",
"countryGeoId": "text",
"comments": "text",
"facilityId": "text",
"address2": "text",
"address1": "text",
"encodedAddressKey": "text",
"thruDate": "2025-08-28",
"fromDate": "2025-08-28",
"directions": "text",
"municipalityGeoId": "text",
"stateProvinceGeoId": "text",
"geoPointId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}
Update a Telecommunications Number
application/json
In Schema for service: updateFacilityTelecomNumber request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateFacilityTelecomNumber HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 211
{
"fromDate": "2025-08-28",
"askForName": "text",
"areaCode": "text",
"extension": "text",
"comments": "text",
"facilityId": "text",
"countryCode": "text",
"contactNumber": "text",
"contactMechId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}
Update Facility -> Group Member
application/json
In Schema for service: updateFacilityToGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateFacilityToGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 110
{
"fromDate": "2025-08-28",
"facilityId": "text",
"sequenceNum": 1,
"facilityGroupId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Service to sync inventory from file provided by external systems
application/json
In Schema for service: updateInventoryByIdentification request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateInventoryByIdentification HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 173
{
"varianceReasonId": "text",
"comments": "text",
"idType": "text",
"facilityId": "text",
"idValue": "text",
"externalFacilityId": "text",
"locationSeqId": "text",
"availableDelta": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update JobSandbox record
application/json
In Schema for service: updateJobSandbox request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateJobSandbox HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 765
{
"recurrenceInfoId": "text",
"cancelDateTime": "2025-08-28",
"tempExprId": "text",
"authUserLoginId": "text",
"currentRetryCount": 1,
"runTimeEpoch": 1,
"lastModifiedByUserLogin": "text",
"loaderName": "text",
"shopId": "text",
"productStoreId": "text",
"runTime": "2025-08-28",
"createdByUserLogin": "text",
"jobName": "text",
"runThread": "text",
"runByInstanceId": "text",
"maxRecurrenceCount": 1,
"currentRecurrenceCount": 1,
"serviceName": "text",
"priority": 1,
"runtimeDataId": "text",
"finishDateTime": "2025-08-28",
"runAsUser": "text",
"maxRetry": 1,
"jobId": "text",
"createdDate": "2025-08-28",
"startDateTime": "2025-08-28",
"statusId": "text",
"previousJobId": "text",
"parentJobId": "text",
"jobResult": "text",
"poolId": "text",
"systemJobEnumId": "text",
"recurrenceTimeZone": "text",
"instanceOfProductId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Atomic updates OISGIR Solr document for rejected item.
application/json
In Schema for service: updateOISGIRIFulfillmentStatus request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateOISGIRIFulfillmentStatus HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 91
{
"inventoryItemId": "text",
"orderItemSeqId": "text",
"orderId": "text",
"shipGroupSeqId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
This service will update the Shipping Address of the order based on city/state (Any field present in PostalAddress) with mapping from CarrierGeoMapping entity
This service will update the Shipping Address of the order based on city/state (Any field present in PostalAddress) with mapping from CarrierGeoMapping entity
application/json
In Schema for service: updateOrderAddressAndAppendAttributes request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateOrderAddressAndAppendAttributes HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 108
{
"lookupField": "text",
"geoTypeId": "text",
"orderId": "text",
"attributesToAppend": {},
"fieldsToUpdate": [
"text"
]
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderId": "text"
}
}
Update an OrderAttribute record
application/json
In Schema for service: updateOrderAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateOrderAttribute HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"orderId": "text",
"attrDescription": "text",
"attrValue": "text",
"attrName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update Order Item
application/json
In Schema for service: updateOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateOrderItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1413
{
"requestedDeliveryTime": "text",
"orderId": "text",
"isNewProduct": "text",
"returnTillDate": "2025-08-28",
"deploymentId": "text",
"cancelBackOrderDate": "2025-08-28",
"itemDescription": "text",
"selectedAmount": 1,
"unitPrice": 1,
"orderItemSeqId": "text",
"productId": "text",
"unitRecurringPrice": 1,
"autoCancelDate": "2025-08-28",
"isItemGroupPrimary": "text",
"productFeatureId": "text",
"overrideGlAccountId": "text",
"budgetId": "text",
"taxCode": "text",
"supplierProductId": "text",
"estimatedDeliveryDate": "2025-08-28",
"shipGroupSeqId": "text",
"quoteId": "text",
"requestedShipMethTypeId": "text",
"availableToPromise": 1,
"statusId": "text",
"syncStatusId": "text",
"requestedDeliveryDate": "text",
"estimatedShipDate": "2025-08-28",
"shoppingListItemSeqId": "text",
"subscriptionId": "text",
"salesOpportunityId": "text",
"dontCancelSetUserLogin": "text",
"promisedDatetime": "2025-08-28",
"isModifiedPrice": "text",
"isPromo": "text",
"shipBeforeDate": "2025-08-28",
"productCategoryId": "text",
"unitListPrice": 1,
"shoppingListId": "text",
"unitAverageCost": 1,
"orderItemTypeId": "text",
"dontCancelSetDate": "2025-08-28",
"comments": "text",
"quantity": 1,
"recurringFreqUomId": "text",
"orderItemGroupSeqId": "text",
"quoteItemSeqId": "text",
"fromInventoryItemId": "text",
"externalId": "text",
"budgetItemSeqId": "text",
"correspondingPoId": "text",
"cancelQuantity": 1,
"shipAfterDate": "2025-08-28",
"deliveryWindow": 1,
"shipmentId": "text",
"changeByUserLoginId": "text",
"prodCatalogId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update Order Item Attribute
application/json
In Schema for service: updateOrderItemAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateOrderItemAttribute HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"orderItemSeqId": "text",
"orderId": "text",
"attrDescription": "text",
"attrValue": "text",
"attrName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Sync Order Items (Shopify --> HC)
application/json
In Schema for service: updateOrderItemFromShopify request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateOrderItemFromShopify HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"shopifyConfigId": "text",
"payload": {}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Updates OrderItemShipGroup. The shipmentMethod field is of the format ${shipmentMethodTypeId}@${carrierPartyId}
Updates OrderItemShipGroup. The shipmentMethod field is of the format ${shipmentMethodTypeId}@${carrierPartyId}
application/json
In Schema for service: updateOrderItemShipGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateOrderItemShipGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 641
{
"carrierService": "text",
"facilityId": "text",
"giftMessage": "text",
"orderId": "text",
"shippingInstructions": "text",
"shipByDate": "2025-08-28",
"maySplit": "text",
"estimatedDeliveryDate": "2025-08-28",
"shipGroupSeqId": "text",
"contactMechId": "text",
"vendorPartyId": "text",
"shipAfterDate": "2025-08-28",
"telecomContactMechId": "text",
"shipmentMethod": "text",
"carrierPartyId": "text",
"contactMechPurposeTypeId": "text",
"carrierRoleTypeId": "text",
"oldContactMechId": "text",
"estimatedShipDate": "2025-08-28",
"isGift": "text",
"supplierPartyId": "text",
"carrierAccountNumber": "text",
"trackingNumber": "text",
"shipmentMethodTypeId": "text",
"orderFacilityId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update OrderPayemntPreference
application/json
In Schema for service: updateOrderPaymentPreferenceV2 request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateOrderPaymentPreferenceV2 HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 757
{
"cardName": "text",
"orderId": "text",
"manualAuthCode": "text",
"presentmentAmount": 1,
"lastModifiedByUserLogin": "text",
"orderPaymentPreferenceId": "text",
"exchangeRate": 1,
"requestId": "text",
"presentmentCurrencyUom": "text",
"paymentMethodId": "text",
"overflowFlag": "text",
"maxAmount": 1,
"productPricePurposeId": "text",
"createdByUserLogin": "text",
"orderItemSeqId": "text",
"track2": "text",
"paymentMode": "text",
"lastModifiedDate": "2025-08-28",
"manualRefNum": "text",
"swipedFlag": "text",
"parentRefNum": "text",
"securityCode": "text",
"paymentMethodTypeId": "text",
"applicationIdentifier": "text",
"shipGroupSeqId": "text",
"processAttempt": 1,
"needsNsfRetry": "text",
"finAccountId": "text",
"createdDate": "2025-08-28",
"statusId": "text",
"billingPostalCode": "text",
"presentFlag": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a PartyGroup
application/json
In Schema for service: updatePartyGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updatePartyGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 331
{
"pdfLogoImageUrl": "text",
"comments": "text",
"externalId": "text",
"description": "text",
"tickerSymbol": "text",
"logoImageUrl": "text",
"partyTypeId": "text",
"groupName": "text",
"groupNameLocal": "text",
"statusId": "text",
"numEmployees": 1,
"preferredCurrencyUomId": "text",
"ranking": 1,
"partyId": "text",
"annualRevenue": 1,
"officeSiteName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a Relationship between two Parties;
if partyIdFrom is not specified the partyId of the current userLogin will be used;
if roleTypeIds are not specified they will default to "_NA_".
If a partyIdFrom is passed in, it will be used if the userLogin has PARTYMGR_REL_UPDATE permission.
Update a Relationship between two Parties; if partyIdFrom is not specified the partyId of the current userLogin will be used; if roleTypeIds are not specified they will default to "NA". If a partyIdFrom is passed in, it will be used if the userLogin has PARTYMGR_REL_UPDATE permission.
application/json
In Schema for service: updatePartyRelationship request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updatePartyRelationship HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 329
{
"roleTypeIdTo": "text",
"partyIdFrom": "text",
"comments": "text",
"positionTitle": "text",
"permissionsEnumId": "text",
"priorityTypeId": "text",
"roleTypeIdFrom": "text",
"thruDate": "2025-08-28",
"securityGroupId": "text",
"relationshipName": "text",
"fromDate": "2025-08-28",
"partyRelationshipTypeId": "text",
"statusId": "text",
"partyIdTo": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a Person
application/json
In Schema for service: updatePerson request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updatePerson HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 818
{
"yearsWithEmployer": 1,
"lastName": "text",
"occupation": "text",
"employmentStatusEnumId": "text",
"gender": "text",
"socialSecurityNumber": "text",
"description": "text",
"suffix": "text",
"mothersMaidenName": "text",
"existingCustomer": "text",
"middleNameLocal": "text",
"residenceStatusEnumId": "text",
"preferredCurrencyUomId": "text",
"nickname": "text",
"partyId": "text",
"height": 1,
"memberId": "text",
"passportNumber": "text",
"comments": "text",
"lastNameLocal": "text",
"monthsWithEmployer": 1,
"externalId": "text",
"weight": 1,
"birthDate": "text",
"otherLocal": "text",
"firstName": "text",
"anniversaryDate": "text",
"statusId": "text",
"cardId": "text",
"ranking": 1,
"passportExpireDate": "text",
"firstNameLocal": "text",
"middleName": "text",
"salutation": "text",
"personalTitle": "text",
"totalYearsWorkExperience": 1,
"deceasedDate": "text",
"maritalStatus": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a PostalAddress.
application/json
In Schema for service: updatePostalAddressContactMech request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updatePostalAddressContactMech HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 427
{
"countryGeoId": "text",
"houseNumberExt": "text",
"city": "text",
"address2": "text",
"address1": "text",
"latitude": 1,
"postalCodeGeoId": "text",
"postalCode": "text",
"encodedAddressKey": "text",
"houseNumber": 1,
"postalCodeExt": "text",
"contactMechId": "text",
"attnName": "text",
"countyGeoId": "text",
"directions": "text",
"toName": "text",
"cityGeoId": "text",
"municipalityGeoId": "text",
"stateProvinceGeoId": "text",
"geoPointId": "text",
"longitude": 1
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a Product Store
application/json
In Schema for service: updateProductStore request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateProductStore HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 2684
{
"requireCustomerRole": "text",
"viewCartOnAdd": "text",
"companyName": "text",
"headerDeclinedStatus": "text",
"requireInventory": "text",
"allowSplit": "text",
"autoApproveInvoice": "text",
"checkInventory": "text",
"addToCartRemoveIncompat": "text",
"enableAutoSuggestionList": "text",
"defaultSalesChannelEnumId": "text",
"autoApproveOrder": "text",
"allowPassword": "text",
"oldHeaderLogo": "text",
"showTaxIsExempt": "text",
"enablePreOrderAutoReleasing": "text",
"autoSaveCart": "text",
"inventoryFacilityId": "text",
"oldHeaderMiddleBackground": "text",
"headerApprovedStatus": "text",
"defaultTimeZoneString": "text",
"oldStyleSheet": "text",
"showCheckoutGiftOptions": "text",
"prorateTaxes": "text",
"itemDeclinedStatus": "text",
"manualAuthIsCapture": "text",
"storeDomain": "text",
"showOutOfStockProducts": "text",
"storeCreditAccountEnumId": "text",
"itemApprovedStatus": "text",
"allowComment": "text",
"splitPayPrefPerShpGrp": "text",
"storeCreditValidDays": 1,
"managedByLot": "text",
"authFraudMessage": "text",
"reqShipAddrForDigItems": "text",
"enableBrokering": "text",
"oneInventoryFacility": "text",
"autoSetFacility": "text",
"autoInvoiceDigitalItems": "text",
"orderNumberPrefix": "text",
"subtitle": "text",
"reserveOrderEnumId": "text",
"productIdentifierEnumId": "text",
"isDemoStore": "text",
"retryFailedAuths": "text",
"selectPaymentTypePerItem": "text",
"enableExternalPromotion": "text",
"balanceResOnOrderCreation": "text",
"explodeOrderItems": "text",
"autoApproveReviews": "text",
"usePrimaryEmailUsername": "text",
"termTypeId": "text",
"restockingFeePercentage": 1,
"headerCancelStatus": "text",
"title": "text",
"primaryStoreGroupId": "text",
"oldHeaderRightBackground": "text",
"enableDigProdUpload": "text",
"autoOrderCcTryOtherCards": "text",
"autoOrderCcTryLaterMax": 1,
"restockingFeeFixed": 1,
"digitalItemApprovedStatus": "text",
"reserveInventory": "text",
"storeName": "text",
"ecomThemeId": "text",
"productStoreId": "text",
"storeLogoImageUrl": "text",
"isImmediatelyFulfilled": "text",
"defaultPassword": "text",
"autoOrderCcTryExp": "text",
"itemCancelStatus": "text",
"authDeclinedMessage": "text",
"prodSearchExcludeVariants": "text",
"shipIfCaptureFails": "text",
"daysToReturn": 1,
"catalogUrlMountPoint": "text",
"showPricesWithVatTax": "text",
"externalId": "text",
"orderDecimalQuantity": "text",
"defaultCurrencyUomId": "text",
"prorateShipping": "text",
"digProdUploadCategoryId": "text",
"reqReturnInventoryReceive": "text",
"authErrorMessage": "text",
"setOwnerUponIssuance": "text",
"checkGcBalance": "text",
"addToCartReplaceUpsell": "text",
"autoOrderCcTryLaterNsf": "text",
"vatTaxAuthGeoId": "text",
"capturePmntsOnOrdApproval": "text",
"vatTaxAuthPartyId": "text",
"daysToCancelNonPay": 1,
"requirementMethodEnumId": "text",
"defaultLocaleString": "text",
"payToPartyId": "text",
"autoAcceptReturn": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a ProductStoreFacility
application/json
In Schema for service: updateProductStoreFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateProductStoreFacility HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"fromDate": "2025-08-28",
"facilityId": "text",
"sequenceNum": 1,
"productStoreId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a ProductStoreFacilityGroup
application/json
In Schema for service: updateProductStoreFacilityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateProductStoreFacilityGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 117
{
"fromDate": "2025-08-28",
"sequenceNumber": 1,
"facilityGroupId": "text",
"productStoreId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a Product Store Role
application/json
In Schema for service: updateProductStoreRole request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateProductStoreRole HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 126
{
"fromDate": "2025-08-28",
"roleTypeId": "text",
"sequenceNum": 1,
"productStoreId": "text",
"partyId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a ProductStoreSetting
application/json
In Schema for service: updateProductStoreSetting request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateProductStoreSetting HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"settingValue": "text",
"productStoreId": "text",
"settingTypeEnumId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a Product Store Shipment Method
application/json
In Schema for service: updateProductStoreShipMeth request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateProductStoreShipMeth HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 734
{
"companyPartyId": "text",
"productStoreShipMethId": "text",
"allowancePercent": 1,
"shipmentCustomMethodId": "text",
"includeFeatureGroup": "text",
"minTotal": 1,
"minWeight": 1,
"requireCompanyAddr": "text",
"maxSize": 1,
"excludeGeoId": "text",
"isShippingWeightRequired": "text",
"shipmentGatewayConfigId": "text",
"minSize": 1,
"allowCompanyAddr": "text",
"productStoreId": "text",
"minimumPrice": 1,
"partyId": "text",
"shipmentMethodTypeId": "text",
"excludeFeatureGroup": "text",
"sequenceNumber": 1,
"roleTypeId": "text",
"allowUspsAddr": "text",
"maxWeight": 1,
"serviceName": "text",
"thruDate": "2025-08-28",
"fromDate": "2025-08-28",
"includeGeoId": "text",
"maxTotal": 1,
"requireUspsAddr": "text",
"configProps": "text",
"includeNoChargeItems": "text",
"isTrackingRequired": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Create Order Data based on API input parameters
application/json
In Schema for service: updateSalesOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateSalesOrder HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1214
{
"order": {
"id": "text",
"externalId": "text",
"channel": "text",
"customerId": "text",
"customerExternalId": "text",
"priority": "text",
"orderDate": "text",
"entryDate": "text",
"expireDate": "text",
"statusId": "text",
"productStoreId": "text",
"currencyCode": "text",
"remainingSubTotal": 1,
"grandTotal": 1,
"shipGroup": [
{
"facilityId": "text",
"externalId": "text",
"maySplit": "text",
"shipBy": "text",
"shipAfter": "text",
"carrierPartyId": "text",
"trackingNumber": "text",
"shipTo": {
"postalAddress": {
"id": "text",
"externalId": "text"
},
"email": {
"id": "text",
"externalId": "text"
},
"phoneNumber": {
"id": "text",
"externalId": "text"
}
},
"items": [
{
"itemSeqId": "text",
"productId": "text",
"sku": "text",
"status": "text",
"quantity": 1,
"unitListPrice": 1,
"unitPrice": 1,
"itemAdjustments": [
{
"id": "text",
"type": "text",
"comments": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
]
}
],
"orderAdjustments": [
{
"id": "text",
"type": "text",
"comments": "text",
"amount": 1,
"sourcePercentage": 1
}
],
"orderPaymentPref": [
{
"id": "text",
"paymentMethodTypeId": "text",
"paymentMode": "text",
"cardName": "text",
"code": "text",
"maxAmount": 1,
"statusId": "text"
}
],
"billTo": {
"postalAddress": {
"id": "text",
"externalId": "text"
},
"email": {
"id": "text",
"externalId": "text"
},
"phoneNumber": {
"id": "text",
"externalId": "text"
}
}
}
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"order": {
"id": "text",
"externalId": "text",
"channel": "text",
"customerId": "text",
"customerExternalId": "text",
"priority": "text",
"orderDate": "text",
"entryDate": "text",
"expireDate": "text",
"statusId": "text",
"productStoreId": "text",
"currencyCode": "text",
"remainingSubTotal": 1,
"grandTotal": 1,
"shipGroup": [
{
"facilityId": "text",
"externalId": "text",
"maySplit": "text",
"shipBy": "text",
"shipAfter": "text",
"carrierPartyId": "text",
"trackingNumber": "text",
"shipTo": {
"postalAddress": {
"id": "text",
"externalId": "text"
},
"email": {
"id": "text",
"externalId": "text"
},
"phoneNumber": {
"id": "text",
"externalId": "text"
}
},
"items": [
{
"itemSeqId": "text",
"productId": "text",
"sku": "text",
"status": "text",
"quantity": 1,
"unitListPrice": 1,
"unitPrice": 1,
"itemAdjustments": [
{
"id": "text",
"type": "text",
"comments": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
]
}
],
"orderAdjustments": [
{
"id": "text",
"type": "text",
"comments": "text",
"amount": 1,
"sourcePercentage": 1
}
],
"orderPaymentPref": [
{
"id": "text",
"paymentMethodTypeId": "text",
"paymentMode": "text",
"cardName": "text",
"code": "text",
"maxAmount": 1,
"statusId": "text"
}
],
"billTo": {
"postalAddress": {
"id": "text",
"externalId": "text"
},
"email": {
"id": "text",
"externalId": "text"
},
"phoneNumber": {
"id": "text",
"externalId": "text"
}
}
}
}
}
Update Search Preference
application/json
In Schema for service: updateSearchPreference request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateSearchPreference HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"searchPrefName": "text",
"isPublic": "text",
"searchPrefValue": "text",
"searchPrefId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a SecurityGroup
application/json
In Schema for service: updateSecurityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateSecurityGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"groupName": "text",
"groupId": "text",
"description": "text",
"groupTypeEnumId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a SecurityPermission from a SecurityGroup
application/json
In Schema for service: updateSecurityPermissionToSecurityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateSecurityPermissionToSecurityGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 88
{
"fromDate": "2025-08-28",
"permissionId": "text",
"groupId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update Shipping Information on Order View
application/json
In Schema for service: updateShipGroupShipInfo request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateShipGroupShipInfo HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 115
{
"shipmentMethod": "text",
"orderId": "text",
"oldContactMechId": "text",
"shipGroupSeqId": "text",
"contactMechId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update Shipment
application/json
In Schema for service: updateShipment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateShipment HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 857
{
"statusDate": "2025-08-28",
"partyIdFrom": "text",
"latestCancelDate": "2025-08-28",
"estimatedReadyDate": "2025-08-28",
"additionalShippingCharge": 1,
"estimatedArrivalWorkEffId": "text",
"destinationTelecomNumberId": "text",
"estimatedShipCost": 1,
"shipmentMethodTypeId": "text",
"destinationFacilityId": "text",
"estimatedShipWorkEffId": "text",
"addtlShippingChargeDesc": "text",
"originContactMechId": "text",
"externalId": "text",
"primaryReturnId": "text",
"originFacilityId": "text",
"carrierPartyId": "text",
"currencyUomId": "text",
"destinationContactMechId": "text",
"statusId": "text",
"originTelecomNumberId": "text",
"shipmentId": "text",
"primaryOrderId": "text",
"estimatedShipDate": "2025-08-28",
"partyIdTo": "text",
"shipmentTypeId": "text",
"estimatedArrivalDate": "2025-08-28",
"picklistBinId": "text",
"primaryShipGroupSeqId": "text",
"handlingInstructions": "text",
"eventDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"oldStatusId": "text",
"oldPrimaryOrderId": "text",
"oldOriginFacilityId": "text",
"shipmentId": "text",
"shipmentTypeId": "text",
"picklistBinId": "text",
"shipmentMethodTypeId": "text",
"oldPrimaryShipGroupSeqId": "text",
"oldDestinationFacilityId": "text"
}
}
Update a ShipmentBoxType record
application/json
In Schema for service: updateShipmentBoxType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateShipmentBoxType HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 149
{
"boxLength": 1,
"boxWeight": 1,
"dimensionUomId": "text",
"weightUomId": "text",
"description": "text",
"boxHeight": 1,
"boxWidth": 1,
"shipmentBoxTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update ShipmentItem
application/json
In Schema for service: updateShipmentItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateShipmentItem HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 181
{
"availableToPromise": 1,
"serialNumber": "text",
"quantity": 1,
"productId": "text",
"shipmentContentDescription": "text",
"shipmentId": "text",
"externalId": "text",
"shipmentItemSeqId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Updates A ShipmentMethodType
application/json
In Schema for service: updateShipmentMethodType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateShipmentMethodType HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"parentTypeId": "text",
"sequenceNum": 1,
"description": "text",
"shipmentMethodTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update ShipmentPackageRouteSeg
application/json
In Schema for service: updateShipmentPackageRouteSeg request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateShipmentPackageRouteSeg HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 451
{
"packagePickupPrn": "text",
"packageServiceCost": 1,
"boxNumber": "text",
"trackingCode": "text",
"shipmentPackageSeqId": "text",
"packageOtherCost": 1,
"labelImageUrl": "text",
"shipmentRouteSegmentId": "text",
"packagePickupDate": "2025-08-28",
"internationalInvoiceUrl": "text",
"currencyUomId": "text",
"labelPrinted": "text",
"packageTransportCost": 1,
"shipmentId": "text",
"codAmount": 1,
"insuredAmount": 1,
"gatewayMessage": "text",
"gatewayStatus": "text",
"labelHtml": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update ShipmentRouteSegment
application/json
In Schema for service: updateShipmentRouteSegment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateShipmentRouteSegment HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1190
{
"actualOtherCost": 1,
"carrierDeliveryZone": "text",
"thirdPartyPostalCode": "text",
"destTelecomNumberId": "text",
"carrierRestrictionCodes": "text",
"trackingIdNumber": "text",
"deliveryId": "text",
"actualCarrierCode": "text",
"referenceNumber": "text",
"codCollectionAmount": 1,
"actualStartDate": "2025-08-28",
"carrierServiceStatusId": "text",
"trackingDigest": "text",
"shipmentMethodTypeId": "text",
"actualCost": 1,
"actualArrivalDate": "2025-08-28",
"carrierService": "text",
"actualServiceCost": 1,
"estimatedStartDate": "2025-08-28",
"originContactMechId": "text",
"isGenerateThirdPartyLabel": "text",
"codReturnLabelHtml": "text",
"actualTransportCost": 1,
"carrierRestrictionDesc": "text",
"billingWeightUomId": "text",
"homeDeliveryDate": "2025-08-28",
"originFacilityId": "text",
"carrierPartyId": "text",
"destFacilityId": "text",
"shipmentRouteSegmentId": "text",
"lastUpdatedDate": "2025-08-28",
"currencyUomId": "text",
"billingWeight": 1,
"thirdPartyCountryGeoCode": "text",
"originTelecomNumberId": "text",
"shipmentId": "text",
"isTrackingRequired": "text",
"thirdPartyAccountNumber": "text",
"homeDeliveryType": "text",
"estimatedArrivalDate": "2025-08-28",
"destContactMechId": "text",
"carrierAccountNumber": "text",
"updatedByUserLoginId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
This service create or update the party shipping address, updates shipping address of ShipGroup and its shipments and clears Online rates fetched for the shipment.
This service create or update the party shipping address, updates shipping address of ShipGroup and its shipments and clears Online rates fetched for the shipment.
application/json
In Schema for service: updateShippingInformationOfShipGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateShippingInformationOfShipGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 635
{
"houseNumberExt": "text",
"orderId": "text",
"city": "text",
"latitude": "text",
"postalCodeGeoId": "text",
"postalCode": "text",
"houseNumber": 1,
"isEdited": "text",
"postalCodeExt": "text",
"contactMechId": "text",
"shipmentMethod": "text",
"attnName": "text",
"countyGeoId": "text",
"toName": "text",
"cityGeoId": "text",
"partyId": "text",
"longitude": "text",
"countryGeoId": "text",
"keepLatitudeAndLongitude": "text",
"address2": "text",
"address1": "text",
"encodedAddressKey": "text",
"shipGroupSeqId": "text",
"contactMechPurposeTypeId": "text",
"directions": "text",
"municipalityGeoId": "text",
"stateProvinceGeoId": "text",
"carrierAccountNumber": "text",
"geoPointId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"newContactMechId": "text"
}
}
Update Shopify draft order.
application/json
In Schema for service: updateShopifyDraftOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateShopifyDraftOrder HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"shopifyConfigId": "text",
"payload": {},
"draftOrderId": 1
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Creates a ShopifyProdLocActivation record
application/json
In Schema for service: updateShopifyProdLocActivation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateShopifyProdLocActivation HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 89
{
"shopifyLocationId": "text",
"shopId": "text",
"shopifyProductId": "text",
"activated": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shopifyLocationId": "text",
"shopId": "text",
"shopifyProductId": "text"
}
}
Update a ShopifyShopCarrierShipment record
application/json
In Schema for service: updateShopifyShopCarrierShipment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateShopifyShopCarrierShipment HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 102
{
"carrierPartyId": "text",
"shopifyShippingMethod": "text",
"shopId": "text",
"shipmentMethodTypeId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a ShopifyShopLocation record
application/json
In Schema for service: updateShopifyShopLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateShopifyShopLocation HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"facilityId": "text",
"shopifyLocationId": "text",
"shopId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update system property
application/json
In Schema for service: updateSystemProperty request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateSystemProperty HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 103
{
"systemPropertyValue": "text",
"systemResourceId": "text",
"description": "text",
"systemPropertyId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
First disable all userLogins, then enable the requested one.
application/json
In Schema for service: updateUserLoginStatus request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateUserLoginStatus HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 190
{
"disabledDateTime": "2025-08-28",
"userLoginId": "text",
"successiveFailedLogins": 1,
"userLdapDn": "text",
"externalAuthId": "text",
"requirePasswordChange": "text",
"partyId": "text",
"enabled": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update a UserLogin to SecurityGroup Appl
application/json
In Schema for service: updateUserLoginToSecurityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateUserLoginToSecurityGroup HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"fromDate": "2025-08-28",
"userLoginId": "text",
"groupId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Update Search Preference
application/json
In Schema for service: updateUserSearchPreference request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/updateUserSearchPreference HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 122
{
"fromDate": "2025-08-28",
"userLoginId": "text",
"userSearchPrefTypeId": "text",
"searchPrefId": "text",
"thruDate": "2025-08-28"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Upload And Import File
application/json
In Schema for service: uploadAndImportFile request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/uploadAndImportFile HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 192
{
"scheduleNow": true,
"fileProcessingDelay": 1,
"_uploadedFile_contentType": "text",
"configId": "text",
"createdByJobId": "text",
"parameters": {},
"continueOnError": true,
"_uploadedFile_fileName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"uploadFileContentId": "text",
"configId": "text",
"filePath": "text"
}
}
application/json
In Schema for service: uploadPartyLogoImage request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/uploadPartyLogoImage HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 105
{
"contentUrl": "text",
"_uploadedFile_contentType": "text",
"partyId": "text",
"_uploadedFile_fileName": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"partyId": "text"
}
}
Main method to void shipping label from Third Party Shipping Services
application/json
In Schema for service: voidShipmentLabel request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/services/voidShipmentLabel HTTP/1.1
Host: 10.106.39.100
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"shipmentId": "text"
}
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}
Was this helpful?